Merge pull request #10162 from backstage/jhaals/remove-EntityName

catalog-model: Remove EntityName & getEntityName

.changeset/metal-beans-teach.md

@@ -0,0 +1,7 @@
+---
+'@backstage/catalog-model': minor
+---
+
+**BREAKING**: Removed `EntityName`, use `CompoundEntityRef` type instead.
+
+**BREAKING**: Removed `getEntityName`, use `getCompoundEntityRef` instead.

packages/catalog-model/api-report.md

@@ -175,9 +175,6 @@ export type EntityMeta = JsonObject & {
   links?: EntityLink[];
 };
 
-// @public @deprecated
-export type EntityName = CompoundEntityRef;
-
 // @public
 export const EntityPolicies: {
   allOf(policies: EntityPolicy[]): EntityPolicy;
@@ -226,9 +223,6 @@ export class FieldFormatEntityPolicy implements EntityPolicy {
 // @public
 export function getCompoundEntityRef(entity: Entity): CompoundEntityRef;
 
-// @public @deprecated
-export const getEntityName: typeof getCompoundEntityRef;
-
 // @public
 export function getEntitySourceLocation(entity: Entity): {
   type: string;

packages/catalog-model/src/entity/index.ts

@@ -35,7 +35,6 @@ export type {
 export * from './policies';
 export {
   getCompoundEntityRef,
-  getEntityName,
   parseEntityRef,
   stringifyEntityRef,
 } from './ref';

packages/catalog-model/src/entity/ref.ts

@@ -44,17 +44,6 @@ function parseRefString(ref: string): {
   return { kind, namespace, name };
 }
 
-/**
- * Extracts the kind, namespace and name that form the compound entity ref
- * triplet of the given entity.
- *
- * @public
- * @deprecated Use getCompoundEntityRef instead
- * @param entity - An entity
- * @returns The compound entity ref
- */
-export const getEntityName = getCompoundEntityRef;
-
 /**
  * Extracts the kind, namespace and name that form the compound entity ref
  * triplet of the given entity.

packages/catalog-model/src/index.ts

@@ -24,5 +24,5 @@ export * from './entity';
 export { EntityPolicies } from './EntityPolicies';
 export * from './kinds';
 export * from './location';
-export type { EntityName, CompoundEntityRef } from './types';
+export type { CompoundEntityRef } from './types';
 export * from './validation';

packages/catalog-model/src/types.ts

@@ -25,11 +25,3 @@ export type CompoundEntityRef = {
   namespace: string;
   name: string;
 };
-
-/**
- * A complete entity name, with the full kind-namespace-name triplet.
- *
- * @deprecated Use CompoundEntityRef instead
- * @public
- */
-export type EntityName = CompoundEntityRef;