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/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 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;