paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 29 Packages Projects Releases Wiki Activity

frontend-plugin-api: rename ExtensionBlueprintParamDefiner to ExtensionBlueprintDefineParams

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2025-08-01 13:44:09 +02:00
parent 147482b700
commit fa34a4cd5e
4 changed files with 52 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/frontend-plugin-api/report.api.md
+20 -20
View File
@@ -505,7 +505,7 @@ export function createExtension<
// @public
export function createExtensionBlueprint<
TParams extends object | ExtensionBlueprintParamsDefiner,
TParams extends object | ExtensionBlueprintDefineParams,
UOutput extends ExtensionDataRef,
TInputs extends {
[inputName in string]: ExtensionInput<
@@ -557,7 +557,7 @@ export function createExtensionBlueprint<
// @public (undocumented)
export type CreateExtensionBlueprintOptions<
TKind extends string,
TParams extends object | ExtensionBlueprintParamsDefiner,
TParams extends object | ExtensionBlueprintDefineParams,
UOutput extends ExtensionDataRef,
TInputs extends {
[inputName in string]: ExtensionInput<
@@ -584,11 +584,11 @@ export type CreateExtensionBlueprintOptions<
config?: {
schema: TConfigSchema;
};
defineParams?: TParams extends ExtensionBlueprintParamsDefiner
defineParams?: TParams extends ExtensionBlueprintDefineParams
? TParams
: 'The defineParams option must be a function if provided, see the docs for details';
factory(
params: TParams extends ExtensionBlueprintParamsDefiner
params: TParams extends ExtensionBlueprintDefineParams
? ReturnType<TParams>['T']
: TParams,
context: {
@@ -912,9 +912,9 @@ export interface ExtensionBlueprint<
name?: TName;
attachTo?: ExtensionAttachToSpec;
disabled?: boolean;
params: TParamsInput extends ExtensionBlueprintParamsDefiner
params: TParamsInput extends ExtensionBlueprintDefineParams
? TParamsInput
: T['params'] extends ExtensionBlueprintParamsDefiner
: T['params'] extends ExtensionBlueprintDefineParams
? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `<blueprint>.make({ params: defineParams => defineParams(<params>) })`'
: T['params'];
}): ExtensionDefinition<{
@@ -961,9 +961,9 @@ export interface ExtensionBlueprint<
originalFactory: <
TParamsInput extends AnyParamsInput_2<NonNullable<T['params']>>,
>(
params: TParamsInput extends ExtensionBlueprintParamsDefiner
params: TParamsInput extends ExtensionBlueprintDefineParams
? TParamsInput
: T['params'] extends ExtensionBlueprintParamsDefiner
: T['params'] extends ExtensionBlueprintDefineParams
? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(defineParams => defineParams(<params>))`'
: T['params'],
context?: {
@@ -1015,10 +1015,16 @@ export interface ExtensionBlueprint<
}>;
}
// @public
export type ExtensionBlueprintDefineParams<
TParams extends object = object,
TInput = any,
> = (params: TInput) => ExtensionBlueprintParams<TParams>;
// @public (undocumented)
export type ExtensionBlueprintParameters = {
kind: string;
params?: object | ExtensionBlueprintParamsDefiner;
params?: object | ExtensionBlueprintDefineParams;
configInput?: {
[K in string]: any;
};
@@ -1046,12 +1052,6 @@ export type ExtensionBlueprintParams<T extends object = object> = {
T: T;
};
// @public
export type ExtensionBlueprintParamsDefiner<
TParams extends object = object,
TInput = any,
> = (params: TInput) => ExtensionBlueprintParams<TParams>;
// @public (undocumented)
export function ExtensionBoundary(props: ExtensionBoundaryProps): JSX_2.Element;
@@ -1179,9 +1179,9 @@ export type ExtensionDefinition<
} & ([T['params']] extends [never]
? {}
: {
params?: TFactoryParamsReturn extends ExtensionBlueprintParamsDefiner
params?: TFactoryParamsReturn extends ExtensionBlueprintDefineParams
? TFactoryParamsReturn
: T['params'] extends ExtensionBlueprintParamsDefiner
: T['params'] extends ExtensionBlueprintDefineParams
? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(defineParams => defineParams(<params>))`'
: Partial<T['params']>;
})
@@ -1201,9 +1201,9 @@ export type ExtensionDefinition<
} & ([T['params']] extends [never]
? {}
: {
params?: TParamsInput extends ExtensionBlueprintParamsDefiner
params?: TParamsInput extends ExtensionBlueprintDefineParams
? TParamsInput
: T['params'] extends ExtensionBlueprintParamsDefiner
: T['params'] extends ExtensionBlueprintDefineParams
? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(defineParams => defineParams(<params>))`'
: Partial<T['params']>;
})
@@ -1255,7 +1255,7 @@ export type ExtensionDefinitionParameters = {
}
>;
};
params?: object | ExtensionBlueprintParamsDefiner;
params?: object | ExtensionBlueprintDefineParams;
};
// @public (undocumented)
packages/frontend-plugin-api/src/wiring/createExtension.ts
+10 -10
View File
@@ -27,7 +27,7 @@ import { z } from 'zod';
import { createSchemaFromZod } from '../schema/createSchemaFromZod';
import { OpaqueExtensionDefinition } from '@internal/frontend';
import { ExtensionDataContainer } from './types';
import { ExtensionBlueprintParamsDefiner } from './createExtensionBlueprint';
import { ExtensionBlueprintDefineParams } from './createExtensionBlueprint';
/**
* This symbol is used to pass parameter overrides from the extension override to the blueprint factory
@@ -159,7 +159,7 @@ export type ExtensionDefinitionParameters = {
{ optional: boolean; singleton: boolean }
>;
};
params?: object | ExtensionBlueprintParamsDefiner;
params?: object | ExtensionBlueprintDefineParams;
};
/**
@@ -167,14 +167,14 @@ export type ExtensionDefinitionParameters = {
* It can't be exported because it breaks API reports.
* @ignore
*/
type AnyParamsInput<TParams extends object | ExtensionBlueprintParamsDefiner> =
TParams extends ExtensionBlueprintParamsDefiner<infer IParams>
type AnyParamsInput<TParams extends object | ExtensionBlueprintDefineParams> =
TParams extends ExtensionBlueprintDefineParams<infer IParams>
? IParams | ((define: TParams) => ReturnType<TParams>)
:
| TParams
| ((
define: ExtensionBlueprintParamsDefiner<TParams, TParams>,
) => ReturnType<ExtensionBlueprintParamsDefiner<TParams, TParams>>);
define: ExtensionBlueprintDefineParams<TParams, TParams>,
) => ReturnType<ExtensionBlueprintDefineParams<TParams, TParams>>);
/** @public */
export type ExtensionDefinition<
@@ -225,9 +225,9 @@ export type ExtensionDefinition<
} & ([T['params']] extends [never]
? {}
: {
params?: TFactoryParamsReturn extends ExtensionBlueprintParamsDefiner
params?: TFactoryParamsReturn extends ExtensionBlueprintDefineParams
? TFactoryParamsReturn
: T['params'] extends ExtensionBlueprintParamsDefiner
: T['params'] extends ExtensionBlueprintDefineParams
? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(defineParams => defineParams(<params>))`'
: Partial<T['params']>;
})
@@ -247,9 +247,9 @@ export type ExtensionDefinition<
} & ([T['params']] extends [never]
? {}
: {
params?: TParamsInput extends ExtensionBlueprintParamsDefiner
params?: TParamsInput extends ExtensionBlueprintDefineParams
? TParamsInput
: T['params'] extends ExtensionBlueprintParamsDefiner
: T['params'] extends ExtensionBlueprintDefineParams
? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(defineParams => defineParams(<params>))`'
: Partial<T['params']>;
})
packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts
+21 -23
View File
@@ -50,7 +50,7 @@ import { ExtensionDataContainer } from './types';
*
* @public
*/
export type ExtensionBlueprintParamsDefiner<
export type ExtensionBlueprintDefineParams<
TParams extends object = object,
TInput = any,
> = (params: TInput) => ExtensionBlueprintParams<TParams>;
@@ -100,7 +100,7 @@ export function createExtensionBlueprintParams<T extends object = object>(
*/
export type CreateExtensionBlueprintOptions<
TKind extends string,
TParams extends object | ExtensionBlueprintParamsDefiner,
TParams extends object | ExtensionBlueprintDefineParams,
UOutput extends ExtensionDataRef,
TInputs extends {
[inputName in string]: ExtensionInput<
@@ -158,11 +158,11 @@ export type CreateExtensionBlueprintOptions<
* });
* ```
*/
defineParams?: TParams extends ExtensionBlueprintParamsDefiner
defineParams?: TParams extends ExtensionBlueprintDefineParams
? TParams
: 'The defineParams option must be a function if provided, see the docs for details';
factory(
params: TParams extends ExtensionBlueprintParamsDefiner
params: TParams extends ExtensionBlueprintDefineParams
? ReturnType<TParams>['T']
: TParams,
context: {
@@ -181,7 +181,7 @@ export type CreateExtensionBlueprintOptions<
/** @public */
export type ExtensionBlueprintParameters = {
kind: string;
params?: object | ExtensionBlueprintParamsDefiner;
params?: object | ExtensionBlueprintDefineParams;
configInput?: { [K in string]: any };
config?: { [K in string]: any };
output?: ExtensionDataRef;
@@ -195,7 +195,7 @@ export type ExtensionBlueprintParameters = {
};
/** @ignore */
type ParamsFactory<TDefiner extends ExtensionBlueprintParamsDefiner> = (
type ParamsFactory<TDefiner extends ExtensionBlueprintDefineParams> = (
defineParams: TDefiner,
) => ReturnType<TDefiner>;
@@ -205,12 +205,10 @@ type ParamsFactory<TDefiner extends ExtensionBlueprintParamsDefiner> = (
*
* @ignore
*/
type AnyParamsInput<TParams extends object | ExtensionBlueprintParamsDefiner> =
TParams extends ExtensionBlueprintParamsDefiner<infer IParams>
type AnyParamsInput<TParams extends object | ExtensionBlueprintDefineParams> =
TParams extends ExtensionBlueprintDefineParams<infer IParams>
? IParams | ParamsFactory<TParams>
:
| TParams
| ParamsFactory<ExtensionBlueprintParamsDefiner<TParams, TParams>>;
: TParams | ParamsFactory<ExtensionBlueprintDefineParams<TParams, TParams>>;
/**
* @public
@@ -228,9 +226,9 @@ export interface ExtensionBlueprint<
name?: TName;
attachTo?: ExtensionAttachToSpec;
disabled?: boolean;
params: TParamsInput extends ExtensionBlueprintParamsDefiner
params: TParamsInput extends ExtensionBlueprintDefineParams
? TParamsInput
: T['params'] extends ExtensionBlueprintParamsDefiner
: T['params'] extends ExtensionBlueprintDefineParams
? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `<blueprint>.make({ params: defineParams => defineParams(<params>) })`'
: T['params'];
}): ExtensionDefinition<{
@@ -281,9 +279,9 @@ export interface ExtensionBlueprint<
originalFactory: <
TParamsInput extends AnyParamsInput<NonNullable<T['params']>>,
>(
params: TParamsInput extends ExtensionBlueprintParamsDefiner
params: TParamsInput extends ExtensionBlueprintDefineParams
? TParamsInput
: T['params'] extends ExtensionBlueprintParamsDefiner
: T['params'] extends ExtensionBlueprintDefineParams
? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(defineParams => defineParams(<params>))`'
: T['params'],
context?: {
@@ -337,12 +335,12 @@ export interface ExtensionBlueprint<
function unwrapParamsFactory<TParams extends object>(
// Allow `Function` because `typeof <object> === 'function'` allows it, but in practice this should always be a param factory
params: ParamsFactory<ExtensionBlueprintParamsDefiner> | Function,
defineParams: ExtensionBlueprintParamsDefiner,
params: ParamsFactory<ExtensionBlueprintDefineParams> | Function,
defineParams: ExtensionBlueprintDefineParams,
kind: string,
): TParams {
const paramDefinition = (
params as ParamsFactory<ExtensionBlueprintParamsDefiner>
params as ParamsFactory<ExtensionBlueprintDefineParams>
)(defineParams);
try {
return OpaqueBlueprintParams.toInternal(paramDefinition).params as TParams;
@@ -354,14 +352,14 @@ function unwrapParamsFactory<TParams extends object>(
}
function unwrapParams<TParams extends object>(
params: object | ParamsFactory<ExtensionBlueprintParamsDefiner> | string,
params: object | ParamsFactory<ExtensionBlueprintDefineParams> | string,
ctx: { node: AppNode; [ctxParamsSymbol]?: any },
defineParams: ExtensionBlueprintParamsDefiner | undefined,
defineParams: ExtensionBlueprintDefineParams | undefined,
kind: string,
): TParams {
const overrideParams = ctx[ctxParamsSymbol] as
| object
| ParamsFactory<ExtensionBlueprintParamsDefiner>
| ParamsFactory<ExtensionBlueprintDefineParams>
| undefined;
if (defineParams) {
@@ -412,7 +410,7 @@ function unwrapParams<TParams extends object>(
* @public
*/
export function createExtensionBlueprint<
TParams extends object | ExtensionBlueprintParamsDefiner,
TParams extends object | ExtensionBlueprintDefineParams,
UOutput extends ExtensionDataRef,
TInputs extends {
[inputName in string]: ExtensionInput<
@@ -452,7 +450,7 @@ export function createExtensionBlueprint<
dataRefs: TDataRefs;
}> {
const defineParams = options.defineParams as
| ExtensionBlueprintParamsDefiner
| ExtensionBlueprintDefineParams
| undefined;
return {
packages/frontend-plugin-api/src/wiring/index.ts
+1 -1
View File
@@ -67,7 +67,7 @@ export {
type ExtensionBlueprint,
type ExtensionBlueprintParameters,
type ExtensionBlueprintParams,
type ExtensionBlueprintParamsDefiner,
type ExtensionBlueprintDefineParams,
createExtensionBlueprint,
createExtensionBlueprintParams,
} from './createExtensionBlueprint';