From a04dbc22d7003dd3024273bb26da5f53530cd189 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 14 Mar 2022 10:00:20 +0100 Subject: [PATCH] catalog-model: Remove EntityName & getEntityName Signed-off-by: Johan Haals --- .changeset/metal-beans-teach.md | 7 +++++++ packages/catalog-model/api-report.md | 6 ------ packages/catalog-model/src/entity/index.ts | 1 - packages/catalog-model/src/entity/ref.ts | 11 ----------- packages/catalog-model/src/index.ts | 2 +- packages/catalog-model/src/types.ts | 8 -------- 6 files changed, 8 insertions(+), 27 deletions(-) create mode 100644 .changeset/metal-beans-teach.md diff --git a/.changeset/metal-beans-teach.md b/.changeset/metal-beans-teach.md new file mode 100644 index 0000000000..f3971a2f29 --- /dev/null +++ b/.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. diff --git a/packages/catalog-model/api-report.md b/packages/catalog-model/api-report.md index eb0e4ad7f0..618c1f7b69 100644 --- a/packages/catalog-model/api-report.md +++ b/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; diff --git a/packages/catalog-model/src/entity/index.ts b/packages/catalog-model/src/entity/index.ts index f46f53945f..45ee673167 100644 --- a/packages/catalog-model/src/entity/index.ts +++ b/packages/catalog-model/src/entity/index.ts @@ -35,7 +35,6 @@ export type { export * from './policies'; export { getCompoundEntityRef, - getEntityName, parseEntityRef, stringifyEntityRef, } from './ref'; diff --git a/packages/catalog-model/src/entity/ref.ts b/packages/catalog-model/src/entity/ref.ts index cfe979423f..e52a2e7fb0 100644 --- a/packages/catalog-model/src/entity/ref.ts +++ b/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. diff --git a/packages/catalog-model/src/index.ts b/packages/catalog-model/src/index.ts index b5ccfed149..eec3d91468 100644 --- a/packages/catalog-model/src/index.ts +++ b/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'; diff --git a/packages/catalog-model/src/types.ts b/packages/catalog-model/src/types.ts index 7b3f23c64f..a66f34cc4d 100644 --- a/packages/catalog-model/src/types.ts +++ b/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;