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 5e841aeeee..fc35999ca0 100644 --- a/packages/frontend-plugin-api/report.api.md +++ b/packages/frontend-plugin-api/report.api.md @@ -941,7 +941,7 @@ export interface ExtensionBlueprint< : T['params'], context?: { config?: T['config']; - inputs?: ResolveInputValueOverrides>; + inputs?: ResolvedInputValueOverrides>; }, ) => ExtensionDataContainer>, context: { @@ -1148,7 +1148,7 @@ export type ExtensionDefinition< context?: Expand< { config?: T['config']; - inputs?: ResolveInputValueOverrides>; + inputs?: ResolvedInputValueOverrides>; } & ([T['params']] extends [never] ? {} : { @@ -1627,73 +1627,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/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 fd9fb3b9f5..da7e6a8f02 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'; @@ -285,7 +285,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/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..8ffec893ee 100644 --- a/packages/frontend-plugin-api/src/wiring/resolveInputOverrides.ts +++ b/packages/frontend-plugin-api/src/wiring/resolveInputOverrides.ts @@ -26,8 +26,8 @@ import { import { ExtensionInput } from './createExtensionInput'; import { ExtensionDataContainer } from './types'; -/** @public */ -export type ResolveInputValueOverrides< +/** @ignore */ +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;