From e059aea7b9b5a93616b35216cefadfb7f35e5c79 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Tue, 9 Nov 2021 09:36:42 +0100 Subject: [PATCH 1/2] core-plugin-api: Deprecate unused types Signed-off-by: Johan Haals --- .changeset/young-steaks-punch.md | 5 +++++ packages/core-plugin-api/src/apis/system/types.ts | 2 ++ 2 files changed, 7 insertions(+) create mode 100644 .changeset/young-steaks-punch.md diff --git a/.changeset/young-steaks-punch.md b/.changeset/young-steaks-punch.md new file mode 100644 index 0000000000..55997af565 --- /dev/null +++ b/.changeset/young-steaks-punch.md @@ -0,0 +1,5 @@ +--- +'@backstage/core-plugin-api': patch +--- + +Deprecate unused ApiRef types diff --git a/packages/core-plugin-api/src/apis/system/types.ts b/packages/core-plugin-api/src/apis/system/types.ts index d7801ea5c1..a449e83450 100644 --- a/packages/core-plugin-api/src/apis/system/types.ts +++ b/packages/core-plugin-api/src/apis/system/types.ts @@ -35,6 +35,7 @@ export type AnyApiRef = ApiRef; * Transforms ApiRef type into its inner API type. * * @public + * @deprecated unused type. */ export type ApiRefType = T extends ApiRef ? U : never; @@ -51,6 +52,7 @@ export type TypesToApiRefs = { [key in keyof T]: ApiRef }; * Reverse type transform of {@link TypesToApiRefs}. * * @public + * @deprecated unused type. */ export type ApiRefsToTypes }> = { [key in keyof T]: ApiRefType; From de527c6e33f1a7ddb9d12a3c280fdbf62c86c48e Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Tue, 9 Nov 2021 09:49:55 +0100 Subject: [PATCH 2/2] api report Signed-off-by: Johan Haals --- packages/core-plugin-api/api-report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.md index 3225c1a28f..acfc8d4a45 100644 --- a/packages/core-plugin-api/api-report.md +++ b/packages/core-plugin-api/api-report.md @@ -142,7 +142,7 @@ export type ApiRefConfig = { description?: string; }; -// @public +// @public @deprecated export type ApiRefsToTypes< T extends { [key in string]: ApiRef; @@ -151,7 +151,7 @@ export type ApiRefsToTypes< [key in keyof T]: ApiRefType; }; -// @public +// @public @deprecated export type ApiRefType = T extends ApiRef ? U : never; // @public