From 1e6410b7708162462ffd22d3788a1f1af77b4681 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Thu, 7 Aug 2025 17:26:16 +0200 Subject: [PATCH 1/2] frontend-plugin-api: stop exporting ResolveInputValueOverrides Signed-off-by: Patrik Oldsberg --- .changeset/fast-jars-push.md | 5 ++ packages/frontend-plugin-api/report.api.md | 67 ------------------- .../frontend-plugin-api/src/wiring/index.ts | 1 - .../src/wiring/resolveInputOverrides.ts | 2 +- 4 files changed, 6 insertions(+), 69 deletions(-) create mode 100644 .changeset/fast-jars-push.md diff --git a/.changeset/fast-jars-push.md b/.changeset/fast-jars-push.md new file mode 100644 index 0000000000..2073e008eb --- /dev/null +++ b/.changeset/fast-jars-push.md @@ -0,0 +1,5 @@ +--- +'@backstage/frontend-plugin-api': minor +--- + +**BREAKING**: The `ResolveInputValueOverrides` type is no longer exported. diff --git a/packages/frontend-plugin-api/report.api.md b/packages/frontend-plugin-api/report.api.md index ae32fd0f50..835f46f1f6 100644 --- a/packages/frontend-plugin-api/report.api.md +++ b/packages/frontend-plugin-api/report.api.md @@ -1660,73 +1660,6 @@ export type ResolvedExtensionInputs< : Expand | undefined>; }; -// @public (undocumented) -export type ResolveInputValueOverrides< - TInputs extends { - [inputName in string]: ExtensionInput< - ExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - } = { - [inputName in string]: ExtensionInput< - ExtensionDataRef, - { - optional: boolean; - singleton: boolean; - } - >; - }, -> = Expand< - { - [KName in keyof TInputs as TInputs[KName] extends ExtensionInput< - any, - { - optional: infer IOptional extends boolean; - singleton: boolean; - } - > - ? IOptional extends true - ? never - : KName - : never]: TInputs[KName] extends ExtensionInput< - infer IDataRefs, - { - optional: boolean; - singleton: infer ISingleton extends boolean; - } - > - ? ISingleton extends true - ? Iterable> - : Array>> - : never; - } & { - [KName in keyof TInputs as TInputs[KName] extends ExtensionInput< - any, - { - optional: infer IOptional extends boolean; - singleton: boolean; - } - > - ? IOptional extends true - ? KName - : never - : never]?: TInputs[KName] extends ExtensionInput< - infer IDataRefs, - { - optional: boolean; - singleton: infer ISingleton extends boolean; - } - > - ? ISingleton extends true - ? Iterable> - : Array>> - : never; - } ->; - // @public export type RouteFunc = ( ...[params]: TParams extends undefined diff --git a/packages/frontend-plugin-api/src/wiring/index.ts b/packages/frontend-plugin-api/src/wiring/index.ts index b2e65bee90..ec6f8c4ffa 100644 --- a/packages/frontend-plugin-api/src/wiring/index.ts +++ b/packages/frontend-plugin-api/src/wiring/index.ts @@ -69,4 +69,3 @@ export { createExtensionBlueprint, createExtensionBlueprintParams, } from './createExtensionBlueprint'; -export { type ResolveInputValueOverrides } from './resolveInputOverrides'; diff --git a/packages/frontend-plugin-api/src/wiring/resolveInputOverrides.ts b/packages/frontend-plugin-api/src/wiring/resolveInputOverrides.ts index 9a2d54db9c..73253fd84b 100644 --- a/packages/frontend-plugin-api/src/wiring/resolveInputOverrides.ts +++ b/packages/frontend-plugin-api/src/wiring/resolveInputOverrides.ts @@ -26,7 +26,7 @@ import { import { ExtensionInput } from './createExtensionInput'; import { ExtensionDataContainer } from './types'; -/** @public */ +/** @ignore */ export type ResolveInputValueOverrides< TInputs extends { [inputName in string]: ExtensionInput< From f433c72b5233b9fd02882299885b607ba374b97c Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Thu, 7 Aug 2025 17:28:19 +0200 Subject: [PATCH 2/2] frontend-plugin-api: rename to ResolvedInputValueOverrides Signed-off-by: Patrik Oldsberg --- packages/frontend-plugin-api/report.api.md | 4 ++-- packages/frontend-plugin-api/src/wiring/createExtension.ts | 4 ++-- .../src/wiring/createExtensionBlueprint.ts | 4 ++-- .../frontend-plugin-api/src/wiring/resolveInputOverrides.ts | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/frontend-plugin-api/report.api.md b/packages/frontend-plugin-api/report.api.md index 835f46f1f6..ec91a8fcf6 100644 --- a/packages/frontend-plugin-api/report.api.md +++ b/packages/frontend-plugin-api/report.api.md @@ -994,7 +994,7 @@ export interface ExtensionBlueprint< : T['params'], context?: { config?: T['config']; - inputs?: ResolveInputValueOverrides>; + inputs?: ResolvedInputValueOverrides>; }, ) => ExtensionDataContainer>, context: { @@ -1201,7 +1201,7 @@ export type ExtensionDefinition< context?: Expand< { config?: T['config']; - inputs?: ResolveInputValueOverrides>; + inputs?: ResolvedInputValueOverrides>; } & ([T['params']] extends [never] ? {} : { diff --git a/packages/frontend-plugin-api/src/wiring/createExtension.ts b/packages/frontend-plugin-api/src/wiring/createExtension.ts index 8a5cb9e8f2..de97f8084a 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtension.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtension.ts @@ -17,7 +17,7 @@ import { ApiHolder, AppNode } from '../apis'; import { Expand } from '@backstage/types'; import { - ResolveInputValueOverrides, + ResolvedInputValueOverrides, resolveInputOverrides, } from './resolveInputOverrides'; import { createExtensionDataContainer } from '@internal/frontend'; @@ -221,7 +221,7 @@ export type ExtensionDefinition< context?: Expand< { config?: T['config']; - inputs?: ResolveInputValueOverrides>; + inputs?: ResolvedInputValueOverrides>; } & ([T['params']] extends [never] ? {} : { diff --git a/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts b/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts index f94551755f..500cb75131 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts @@ -30,7 +30,7 @@ import { ExtensionInput } from './createExtensionInput'; import { ExtensionDataRef, ExtensionDataValue } from './createExtensionDataRef'; import { createExtensionDataContainer } from '@internal/frontend'; import { - ResolveInputValueOverrides, + ResolvedInputValueOverrides, resolveInputOverrides, } from './resolveInputOverrides'; import { ExtensionDataContainer } from './types'; @@ -286,7 +286,7 @@ export interface ExtensionBlueprint< : T['params'], context?: { config?: T['config']; - inputs?: ResolveInputValueOverrides>; + inputs?: ResolvedInputValueOverrides>; }, ) => ExtensionDataContainer>, context: { diff --git a/packages/frontend-plugin-api/src/wiring/resolveInputOverrides.ts b/packages/frontend-plugin-api/src/wiring/resolveInputOverrides.ts index 73253fd84b..8ffec893ee 100644 --- a/packages/frontend-plugin-api/src/wiring/resolveInputOverrides.ts +++ b/packages/frontend-plugin-api/src/wiring/resolveInputOverrides.ts @@ -27,7 +27,7 @@ import { ExtensionInput } from './createExtensionInput'; import { ExtensionDataContainer } from './types'; /** @ignore */ -export type ResolveInputValueOverrides< +export type ResolvedInputValueOverrides< TInputs extends { [inputName in string]: ExtensionInput< ExtensionDataRef, @@ -101,7 +101,7 @@ export function resolveInputOverrides( | ({ node: AppNode } & ExtensionDataContainer) | Array<{ node: AppNode } & ExtensionDataContainer>; }, - inputOverrides?: ResolveInputValueOverrides, + inputOverrides?: ResolvedInputValueOverrides, ) { if (!declaredInputs || !inputs || !inputOverrides) { return inputs;