@backstage/frontend-plugin-api 0.10.4-next.1 → 0.11.0-next.0

package/dist/index.esm.js

@@ -11,8 +11,8 @@ export { ApiBlueprint } from './blueprints/ApiBlueprint.esm.js';
 export { AppRootElementBlueprint } from './blueprints/AppRootElementBlueprint.esm.js';
 export { AppRootWrapperBlueprint } from './blueprints/AppRootWrapperBlueprint.esm.js';
 export { IconBundleBlueprint } from './blueprints/IconBundleBlueprint.esm.js';
+export { NavContentBlueprint } from './blueprints/NavContentBlueprint.esm.js';
 export { NavItemBlueprint } from './blueprints/NavItemBlueprint.esm.js';
-export { NavLogoBlueprint } from './blueprints/NavLogoBlueprint.esm.js';
 export { PageBlueprint } from './blueprints/PageBlueprint.esm.js';
 export { RouterBlueprint } from './blueprints/RouterBlueprint.esm.js';
 export { SignInPageBlueprint } from './blueprints/SignInPageBlueprint.esm.js';
@@ -36,5 +36,5 @@ export { createExtensionDataRef } from './wiring/createExtensionDataRef.esm.js';
 export { createFrontendPlugin } from './wiring/createFrontendPlugin.esm.js';
 export { createFrontendModule } from './wiring/createFrontendModule.esm.js';
 export { createFrontendFeatureLoader } from './wiring/createFrontendFeatureLoader.esm.js';
-export { createExtensionBlueprint } from './wiring/createExtensionBlueprint.esm.js';
+export { createExtensionBlueprint, createExtensionBlueprintParams } from './wiring/createExtensionBlueprint.esm.js';
 //# sourceMappingURL=index.esm.js.map

package/dist/wiring/createExtension.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"createExtension.esm.js","sources":["../../src/wiring/createExtension.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiHolder, AppNode } from '../apis';\nimport { Expand } from '@backstage/types';\nimport {\n  ResolveInputValueOverrides,\n  resolveInputOverrides,\n} from './resolveInputOverrides';\nimport { createExtensionDataContainer } from '@internal/frontend';\nimport {\n  AnyExtensionDataRef,\n  ExtensionDataValue,\n} from './createExtensionDataRef';\nimport { ExtensionInput } from './createExtensionInput';\nimport { z } from 'zod';\nimport { createSchemaFromZod } from '../schema/createSchemaFromZod';\nimport { OpaqueExtensionDefinition } from '@internal/frontend';\nimport { ExtensionDataContainer } from './types';\n\n/**\n * This symbol is used to pass parameter overrides from the extension override to the blueprint factory\n * @internal\n */\nexport const ctxParamsSymbol = Symbol('params');\n\n/**\n * Convert a single extension input into a matching resolved input.\n * @public\n */\nexport type ResolvedExtensionInput<\n  TExtensionInput extends ExtensionInput<any, any>,\n> = TExtensionInput['extensionData'] extends Array<AnyExtensionDataRef>\n  ? {\n      node: AppNode;\n    } & ExtensionDataContainer<TExtensionInput['extensionData'][number]>\n  : never;\n\n/**\n * Converts an extension input map into a matching collection of resolved inputs.\n * @public\n */\nexport type ResolvedExtensionInputs<\n  TInputs extends {\n    [name in string]: ExtensionInput<any, any>;\n  },\n> = {\n  [InputName in keyof TInputs]: false extends TInputs[InputName]['config']['singleton']\n    ? Array<Expand<ResolvedExtensionInput<TInputs[InputName]>>>\n    : false extends TInputs[InputName]['config']['optional']\n    ? Expand<ResolvedExtensionInput<TInputs[InputName]>>\n    : Expand<ResolvedExtensionInput<TInputs[InputName]> | undefined>;\n};\n\ntype ToIntersection<U> = (U extends any ? (k: U) => void : never) extends (\n  k: infer I,\n) => void\n  ? I\n  : never;\n\ntype PopUnion<U> = ToIntersection<\n  U extends any ? () => U : never\n> extends () => infer R\n  ? [rest: Exclude<U, R>, next: R]\n  : undefined;\n\n/** @ignore */\ntype JoinStringUnion<\n  U,\n  TDiv extends string = ', ',\n  TResult extends string = '',\n> = PopUnion<U> extends [infer IRest extends string, infer INext extends string]\n  ? TResult extends ''\n    ? JoinStringUnion<IRest, TDiv, INext>\n    : JoinStringUnion<IRest, TDiv, `${TResult}${TDiv}${INext}`>\n  : TResult;\n\n/** @ignore */\nexport type VerifyExtensionFactoryOutput<\n  UDeclaredOutput extends AnyExtensionDataRef,\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n> = (\n  UDeclaredOutput extends any\n    ? UDeclaredOutput['config']['optional'] extends true\n      ? never\n      : UDeclaredOutput['id']\n    : never\n) extends infer IRequiredOutputIds\n  ? [IRequiredOutputIds] extends [UFactoryOutput['id']]\n    ? [UFactoryOutput['id']] extends [UDeclaredOutput['id']]\n      ? {}\n      : `Error: The extension factory has undeclared output(s): ${JoinStringUnion<\n          Exclude<UFactoryOutput['id'], UDeclaredOutput['id']>\n        >}`\n    : `Error: The extension factory is missing the following output(s): ${JoinStringUnion<\n        Exclude<IRequiredOutputIds, UFactoryOutput['id']>\n      >}`\n  : never;\n\n/** @public */\nexport type ExtensionAttachToSpec =\n  | { id: string; input: string }\n  | Array<{ id: string; input: string }>;\n\n/** @public */\nexport type CreateExtensionOptions<\n  TKind extends string | undefined,\n  TName extends string | undefined,\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n> = {\n  kind?: TKind;\n  name?: TName;\n  attachTo: ExtensionAttachToSpec;\n  disabled?: boolean;\n  inputs?: TInputs;\n  output: Array<UOutput>;\n  config?: {\n    schema: TConfigSchema;\n  };\n  factory(context: {\n    node: AppNode;\n    apis: ApiHolder;\n    config: {\n      [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n    };\n    inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n  }): Iterable<UFactoryOutput>;\n} & VerifyExtensionFactoryOutput<UOutput, UFactoryOutput>;\n\n/** @public */\nexport type ExtensionDefinitionParameters = {\n  kind?: string;\n  name?: string;\n  configInput?: { [K in string]: any };\n  config?: { [K in string]: any };\n  output?: AnyExtensionDataRef;\n  inputs?: {\n    [KName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  };\n  params?: object;\n};\n\n/** @public */\nexport type ExtensionDefinition<\n  T extends ExtensionDefinitionParameters = ExtensionDefinitionParameters,\n> = {\n  $$type: '@backstage/ExtensionDefinition';\n  readonly T: T;\n\n  override<\n    TExtensionConfigSchema extends {\n      [key in string]: (zImpl: typeof z) => z.ZodType;\n    },\n    UFactoryOutput extends ExtensionDataValue<any, any>,\n    UNewOutput extends AnyExtensionDataRef,\n    TExtraInputs extends {\n      [inputName in string]: ExtensionInput<\n        AnyExtensionDataRef,\n        { optional: boolean; singleton: boolean }\n      >;\n    },\n  >(\n    args: Expand<\n      {\n        attachTo?: ExtensionAttachToSpec;\n        disabled?: boolean;\n        inputs?: TExtraInputs & {\n          [KName in keyof T['inputs']]?: `Error: Input '${KName &\n            string}' is already defined in parent definition`;\n        };\n        output?: Array<UNewOutput>;\n        config?: {\n          schema: TExtensionConfigSchema & {\n            [KName in keyof T['config']]?: `Error: Config key '${KName &\n              string}' is already defined in parent schema`;\n          };\n        };\n        factory?(\n          originalFactory: (\n            context?: Expand<\n              {\n                config?: T['config'];\n                inputs?: ResolveInputValueOverrides<NonNullable<T['inputs']>>;\n              } & ([T['params']] extends [never]\n                ? {}\n                : { params?: Partial<T['params']> })\n            >,\n          ) => ExtensionDataContainer<NonNullable<T['output']>>,\n          context: {\n            node: AppNode;\n            apis: ApiHolder;\n            config: T['config'] & {\n              [key in keyof TExtensionConfigSchema]: z.infer<\n                ReturnType<TExtensionConfigSchema[key]>\n              >;\n            };\n            inputs: Expand<ResolvedExtensionInputs<T['inputs'] & TExtraInputs>>;\n          },\n        ): Iterable<UFactoryOutput>;\n      } & ([T['params']] extends [never]\n        ? {}\n        : { params?: Partial<T['params']> })\n    > &\n      VerifyExtensionFactoryOutput<\n        AnyExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UFactoryOutput\n      >,\n  ): ExtensionDefinition<{\n    kind: T['kind'];\n    name: T['name'];\n    output: AnyExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: T['inputs'] & TExtraInputs;\n    config: T['config'] & {\n      [key in keyof TExtensionConfigSchema]: z.infer<\n        ReturnType<TExtensionConfigSchema[key]>\n      >;\n    };\n    configInput: T['configInput'] &\n      z.input<\n        z.ZodObject<{\n          [key in keyof TExtensionConfigSchema]: ReturnType<\n            TExtensionConfigSchema[key]\n          >;\n        }>\n      >;\n  }>;\n};\n\n/** @public */\nexport function createExtension<\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  const TKind extends string | undefined = undefined,\n  const TName extends string | undefined = undefined,\n>(\n  options: CreateExtensionOptions<\n    TKind,\n    TName,\n    UOutput,\n    TInputs,\n    TConfigSchema,\n    UFactoryOutput\n  >,\n): ExtensionDefinition<{\n  config: string extends keyof TConfigSchema\n    ? {}\n    : {\n        [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n      };\n  configInput: string extends keyof TConfigSchema\n    ? {}\n    : z.input<\n        z.ZodObject<{\n          [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n        }>\n      >;\n  output: UOutput;\n  inputs: TInputs;\n  params: never;\n  kind: string | undefined extends TKind ? undefined : TKind;\n  name: string | undefined extends TName ? undefined : TName;\n}> {\n  const schemaDeclaration = options.config?.schema;\n  const configSchema =\n    schemaDeclaration &&\n    createSchemaFromZod(innerZ =>\n      innerZ.object(\n        Object.fromEntries(\n          Object.entries(schemaDeclaration).map(([k, v]) => [k, v(innerZ)]),\n        ),\n      ),\n    );\n\n  return OpaqueExtensionDefinition.createInstance('v2', {\n    T: undefined as unknown as {\n      config: string extends keyof TConfigSchema\n        ? {}\n        : {\n            [key in keyof TConfigSchema]: z.infer<\n              ReturnType<TConfigSchema[key]>\n            >;\n          };\n      configInput: string extends keyof TConfigSchema\n        ? {}\n        : z.input<\n            z.ZodObject<{\n              [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n            }>\n          >;\n      output: UOutput;\n      inputs: TInputs;\n      kind: string | undefined extends TKind ? undefined : TKind;\n      name: string | undefined extends TName ? undefined : TName;\n    },\n    kind: options.kind,\n    name: options.name,\n    attachTo: options.attachTo,\n    disabled: options.disabled ?? false,\n    inputs: options.inputs ?? {},\n    output: options.output,\n    configSchema,\n    factory: options.factory,\n    toString() {\n      const parts: string[] = [];\n      if (options.kind) {\n        parts.push(`kind=${options.kind}`);\n      }\n      if (options.name) {\n        parts.push(`name=${options.name}`);\n      }\n      parts.push(\n        `attachTo=${[options.attachTo]\n          .flat()\n          .map(a => `${a.id}@${a.input}`)\n          .join('+')}`,\n      );\n      return `ExtensionDefinition{${parts.join(',')}}`;\n    },\n    override(overrideOptions) {\n      if (!Array.isArray(options.output)) {\n        throw new Error(\n          'Cannot override an extension that is not declared using the new format with outputs as an array',\n        );\n      }\n\n      // TODO(Rugvip): Making this a type check would be optimal, but it seems\n      //               like it's tricky to add that and still have the type\n      //               inference work correctly for the factory output.\n      if (overrideOptions.output && !overrideOptions.factory) {\n        throw new Error(\n          'Refused to override output without also overriding factory',\n        );\n      }\n      // TODO(Rugvip): Similar to above, would be nice to error during type checking, but don't want to complicate the types too much\n      if (overrideOptions.params && overrideOptions.factory) {\n        throw new Error(\n          'Refused to override params and factory at the same time',\n        );\n      }\n\n      return createExtension({\n        kind: options.kind,\n        name: options.name,\n        attachTo: overrideOptions.attachTo ?? options.attachTo,\n        disabled: overrideOptions.disabled ?? options.disabled,\n        inputs: { ...overrideOptions.inputs, ...options.inputs },\n        output: (overrideOptions.output ??\n          options.output) as AnyExtensionDataRef[],\n        config:\n          options.config || overrideOptions.config\n            ? {\n                schema: {\n                  ...options.config?.schema,\n                  ...overrideOptions.config?.schema,\n                },\n              }\n            : undefined,\n        factory: ({ node, apis, config, inputs }) => {\n          if (!overrideOptions.factory) {\n            return options.factory({\n              node,\n              apis,\n              config: config as any,\n              inputs: inputs as any,\n              [ctxParamsSymbol as any]: overrideOptions.params,\n            });\n          }\n          const parentResult = overrideOptions.factory(\n            (innerContext): ExtensionDataContainer<UOutput> => {\n              return createExtensionDataContainer<UOutput>(\n                options.factory({\n                  node,\n                  apis,\n                  config: (innerContext?.config ?? config) as any,\n                  inputs: resolveInputOverrides(\n                    options.inputs,\n                    inputs,\n                    innerContext?.inputs,\n                  ) as any,\n                  [ctxParamsSymbol as any]: innerContext?.params,\n                }) as Iterable<any>,\n                options.output,\n              );\n            },\n            {\n              node,\n              apis,\n              config: config as any,\n              inputs: inputs as any,\n            },\n          );\n\n          const deduplicatedResult = new Map<\n            string,\n            ExtensionDataValue<any, any>\n          >();\n          for (const item of parentResult) {\n            deduplicatedResult.set(item.id, item);\n          }\n\n          return deduplicatedResult.values();\n        },\n      }) as ExtensionDefinition<any>;\n    },\n  });\n}\n"],"names":[],"mappings":";;;;;;AAqCa,MAAA,eAAA,GAAkB,OAAO,QAAQ;AA0NvC,SAAS,gBAad,OA0BC,EAAA;AACD,EAAM,MAAA,iBAAA,GAAoB,QAAQ,MAAQ,EAAA,MAAA;AAC1C,EAAA,MAAM,eACJ,iBACA,IAAA,mBAAA;AAAA,IAAoB,YAClB,MAAO,CAAA,MAAA;AAAA,MACL,MAAO,CAAA,WAAA;AAAA,QACL,MAAO,CAAA,OAAA,CAAQ,iBAAiB,CAAA,CAAE,IAAI,CAAC,CAAC,CAAG,EAAA,CAAC,MAAM,CAAC,CAAA,EAAG,CAAE,CAAA,MAAM,CAAC,CAAC;AAAA;AAClE;AACF,GACF;AAEF,EAAO,OAAA,yBAAA,CAA0B,eAAe,IAAM,EAAA;AAAA,IACpD,CAAG,EAAA,KAAA,CAAA;AAAA,IAoBH,MAAM,OAAQ,CAAA,IAAA;AAAA,IACd,MAAM,OAAQ,CAAA,IAAA;AAAA,IACd,UAAU,OAAQ,CAAA,QAAA;AAAA,IAClB,QAAA,EAAU,QAAQ,QAAY,IAAA,KAAA;AAAA,IAC9B,MAAA,EAAQ,OAAQ,CAAA,MAAA,IAAU,EAAC;AAAA,IAC3B,QAAQ,OAAQ,CAAA,MAAA;AAAA,IAChB,YAAA;AAAA,IACA,SAAS,OAAQ,CAAA,OAAA;AAAA,IACjB,QAAW,GAAA;AACT,MAAA,MAAM,QAAkB,EAAC;AACzB,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAA,KAAA,CAAM,IAAK,CAAA,CAAA,KAAA,EAAQ,OAAQ,CAAA,IAAI,CAAE,CAAA,CAAA;AAAA;AAEnC,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAA,KAAA,CAAM,IAAK,CAAA,CAAA,KAAA,EAAQ,OAAQ,CAAA,IAAI,CAAE,CAAA,CAAA;AAAA;AAEnC,MAAM,KAAA,CAAA,IAAA;AAAA,QACJ,YAAY,CAAC,OAAA,CAAQ,QAAQ,CAC1B,CAAA,IAAA,GACA,GAAI,CAAA,CAAA,CAAA,KAAK,GAAG,CAAE,CAAA,EAAE,IAAI,CAAE,CAAA,KAAK,EAAE,CAC7B,CAAA,IAAA,CAAK,GAAG,CAAC,CAAA;AAAA,OACd;AACA,MAAA,OAAO,CAAuB,oBAAA,EAAA,KAAA,CAAM,IAAK,CAAA,GAAG,CAAC,CAAA,CAAA,CAAA;AAAA,KAC/C;AAAA,IACA,SAAS,eAAiB,EAAA;AACxB,MAAA,IAAI,CAAC,KAAA,CAAM,OAAQ,CAAA,OAAA,CAAQ,MAAM,CAAG,EAAA;AAClC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA;AAMF,MAAA,IAAI,eAAgB,CAAA,MAAA,IAAU,CAAC,eAAA,CAAgB,OAAS,EAAA;AACtD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA;AAGF,MAAI,IAAA,eAAA,CAAgB,MAAU,IAAA,eAAA,CAAgB,OAAS,EAAA;AACrD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA;AAGF,MAAA,OAAO,eAAgB,CAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,QAAA,EAAU,eAAgB,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QAC9C,QAAA,EAAU,eAAgB,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QAC9C,QAAQ,EAAE,GAAG,gBAAgB,MAAQ,EAAA,GAAG,QAAQ,MAAO,EAAA;AAAA,QACvD,MAAA,EAAS,eAAgB,CAAA,MAAA,IACvB,OAAQ,CAAA,MAAA;AAAA,QACV,MACE,EAAA,OAAA,CAAQ,MAAU,IAAA,eAAA,CAAgB,MAC9B,GAAA;AAAA,UACE,MAAQ,EAAA;AAAA,YACN,GAAG,QAAQ,MAAQ,EAAA,MAAA;AAAA,YACnB,GAAG,gBAAgB,MAAQ,EAAA;AAAA;AAC7B,SAEF,GAAA,KAAA,CAAA;AAAA,QACN,SAAS,CAAC,EAAE,MAAM,IAAM,EAAA,MAAA,EAAQ,QAAa,KAAA;AAC3C,UAAI,IAAA,CAAC,gBAAgB,OAAS,EAAA;AAC5B,YAAA,OAAO,QAAQ,OAAQ,CAAA;AAAA,cACrB,IAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA;AAAA,cACA,MAAA;AAAA,cACA,CAAC,eAAsB,GAAG,eAAgB,CAAA;AAAA,aAC3C,CAAA;AAAA;AAEH,UAAA,MAAM,eAAe,eAAgB,CAAA,OAAA;AAAA,YACnC,CAAC,YAAkD,KAAA;AACjD,cAAO,OAAA,4BAAA;AAAA,gBACL,QAAQ,OAAQ,CAAA;AAAA,kBACd,IAAA;AAAA,kBACA,IAAA;AAAA,kBACA,MAAA,EAAS,cAAc,MAAU,IAAA,MAAA;AAAA,kBACjC,MAAQ,EAAA,qBAAA;AAAA,oBACN,OAAQ,CAAA,MAAA;AAAA,oBACR,MAAA;AAAA,oBACA,YAAc,EAAA;AAAA,mBAChB;AAAA,kBACA,CAAC,eAAsB,GAAG,YAAc,EAAA;AAAA,iBACzC,CAAA;AAAA,gBACD,OAAQ,CAAA;AAAA,eACV;AAAA,aACF;AAAA,YACA;AAAA,cACE,IAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA;AAAA,cACA;AAAA;AACF,WACF;AAEA,UAAM,MAAA,kBAAA,uBAAyB,GAG7B,EAAA;AACF,UAAA,KAAA,MAAW,QAAQ,YAAc,EAAA;AAC/B,YAAmB,kBAAA,CAAA,GAAA,CAAI,IAAK,CAAA,EAAA,EAAI,IAAI,CAAA;AAAA;AAGtC,UAAA,OAAO,mBAAmB,MAAO,EAAA;AAAA;AACnC,OACD,CAAA;AAAA;AACH,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"createExtension.esm.js","sources":["../../src/wiring/createExtension.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiHolder, AppNode } from '../apis';\nimport { Expand } from '@backstage/types';\nimport {\n  ResolveInputValueOverrides,\n  resolveInputOverrides,\n} from './resolveInputOverrides';\nimport { createExtensionDataContainer } from '@internal/frontend';\nimport {\n  AnyExtensionDataRef,\n  ExtensionDataValue,\n} from './createExtensionDataRef';\nimport { ExtensionInput } from './createExtensionInput';\nimport { z } from 'zod';\nimport { createSchemaFromZod } from '../schema/createSchemaFromZod';\nimport { OpaqueExtensionDefinition } from '@internal/frontend';\nimport { ExtensionDataContainer } from './types';\nimport { ExtensionBlueprintParamsDefiner } from './createExtensionBlueprint';\n\n/**\n * This symbol is used to pass parameter overrides from the extension override to the blueprint factory\n * @internal\n */\nexport const ctxParamsSymbol = Symbol('params');\n\n/**\n * Convert a single extension input into a matching resolved input.\n * @public\n */\nexport type ResolvedExtensionInput<\n  TExtensionInput extends ExtensionInput<any, any>,\n> = TExtensionInput['extensionData'] extends Array<AnyExtensionDataRef>\n  ? {\n      node: AppNode;\n    } & ExtensionDataContainer<TExtensionInput['extensionData'][number]>\n  : never;\n\n/**\n * Converts an extension input map into a matching collection of resolved inputs.\n * @public\n */\nexport type ResolvedExtensionInputs<\n  TInputs extends {\n    [name in string]: ExtensionInput<any, any>;\n  },\n> = {\n  [InputName in keyof TInputs]: false extends TInputs[InputName]['config']['singleton']\n    ? Array<Expand<ResolvedExtensionInput<TInputs[InputName]>>>\n    : false extends TInputs[InputName]['config']['optional']\n    ? Expand<ResolvedExtensionInput<TInputs[InputName]>>\n    : Expand<ResolvedExtensionInput<TInputs[InputName]> | undefined>;\n};\n\ntype ToIntersection<U> = (U extends any ? (k: U) => void : never) extends (\n  k: infer I,\n) => void\n  ? I\n  : never;\n\ntype PopUnion<U> = ToIntersection<\n  U extends any ? () => U : never\n> extends () => infer R\n  ? [rest: Exclude<U, R>, next: R]\n  : undefined;\n\n/** @ignore */\ntype JoinStringUnion<\n  U,\n  TDiv extends string = ', ',\n  TResult extends string = '',\n> = PopUnion<U> extends [infer IRest extends string, infer INext extends string]\n  ? TResult extends ''\n    ? JoinStringUnion<IRest, TDiv, INext>\n    : JoinStringUnion<IRest, TDiv, `${TResult}${TDiv}${INext}`>\n  : TResult;\n\n/** @ignore */\nexport type VerifyExtensionFactoryOutput<\n  UDeclaredOutput extends AnyExtensionDataRef,\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n> = (\n  UDeclaredOutput extends any\n    ? UDeclaredOutput['config']['optional'] extends true\n      ? never\n      : UDeclaredOutput['id']\n    : never\n) extends infer IRequiredOutputIds\n  ? [IRequiredOutputIds] extends [UFactoryOutput['id']]\n    ? [UFactoryOutput['id']] extends [UDeclaredOutput['id']]\n      ? {}\n      : `Error: The extension factory has undeclared output(s): ${JoinStringUnion<\n          Exclude<UFactoryOutput['id'], UDeclaredOutput['id']>\n        >}`\n    : `Error: The extension factory is missing the following output(s): ${JoinStringUnion<\n        Exclude<IRequiredOutputIds, UFactoryOutput['id']>\n      >}`\n  : never;\n\n/** @public */\nexport type ExtensionAttachToSpec =\n  | { id: string; input: string }\n  | Array<{ id: string; input: string }>;\n\n/** @public */\nexport type CreateExtensionOptions<\n  TKind extends string | undefined,\n  TName extends string | undefined,\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n> = {\n  kind?: TKind;\n  name?: TName;\n  attachTo: ExtensionAttachToSpec;\n  disabled?: boolean;\n  inputs?: TInputs;\n  output: Array<UOutput>;\n  config?: {\n    schema: TConfigSchema;\n  };\n  factory(context: {\n    node: AppNode;\n    apis: ApiHolder;\n    config: {\n      [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n    };\n    inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n  }): Iterable<UFactoryOutput>;\n} & VerifyExtensionFactoryOutput<UOutput, UFactoryOutput>;\n\n/** @public */\nexport type ExtensionDefinitionParameters = {\n  kind?: string;\n  name?: string;\n  configInput?: { [K in string]: any };\n  config?: { [K in string]: any };\n  output?: AnyExtensionDataRef;\n  inputs?: {\n    [KName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  };\n  params?: object | ExtensionBlueprintParamsDefiner;\n};\n\n/**\n * Same as the one in `createExtensionBlueprint`, but with `ParamsFactory` inlined.\n * It can't be exported because it breaks API reports.\n * @ignore\n */\ntype AnyParamsInput<TParams extends object | ExtensionBlueprintParamsDefiner> =\n  TParams extends ExtensionBlueprintParamsDefiner<infer IParams>\n    ? IParams | ((define: TParams) => ReturnType<TParams>)\n    :\n        | TParams\n        | ((\n            define: ExtensionBlueprintParamsDefiner<TParams, TParams>,\n          ) => ReturnType<ExtensionBlueprintParamsDefiner<TParams, TParams>>);\n\n/** @public */\nexport type ExtensionDefinition<\n  T extends ExtensionDefinitionParameters = ExtensionDefinitionParameters,\n> = {\n  $$type: '@backstage/ExtensionDefinition';\n  readonly T: T;\n\n  override<\n    TExtensionConfigSchema extends {\n      [key in string]: (zImpl: typeof z) => z.ZodType;\n    },\n    UFactoryOutput extends ExtensionDataValue<any, any>,\n    UNewOutput extends AnyExtensionDataRef,\n    TExtraInputs extends {\n      [inputName in string]: ExtensionInput<\n        AnyExtensionDataRef,\n        { optional: boolean; singleton: boolean }\n      >;\n    },\n    TParamsInput extends AnyParamsInput<NonNullable<T['params']>>,\n  >(\n    args: Expand<\n      {\n        attachTo?: ExtensionAttachToSpec;\n        disabled?: boolean;\n        inputs?: TExtraInputs & {\n          [KName in keyof T['inputs']]?: `Error: Input '${KName &\n            string}' is already defined in parent definition`;\n        };\n        output?: Array<UNewOutput>;\n        config?: {\n          schema: TExtensionConfigSchema & {\n            [KName in keyof T['config']]?: `Error: Config key '${KName &\n              string}' is already defined in parent schema`;\n          };\n        };\n        factory?(\n          originalFactory: <\n            TFactoryParamsReturn extends AnyParamsInput<\n              NonNullable<T['params']>\n            >,\n          >(\n            context?: Expand<\n              {\n                config?: T['config'];\n                inputs?: ResolveInputValueOverrides<NonNullable<T['inputs']>>;\n              } & ([T['params']] extends [never]\n                ? {}\n                : {\n                    params?: TFactoryParamsReturn extends ExtensionBlueprintParamsDefiner\n                      ? TFactoryParamsReturn\n                      : T['params'] extends ExtensionBlueprintParamsDefiner\n                      ? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(define => define(<params>))`'\n                      : Partial<T['params']>;\n                  })\n            >,\n          ) => ExtensionDataContainer<NonNullable<T['output']>>,\n          context: {\n            node: AppNode;\n            apis: ApiHolder;\n            config: T['config'] & {\n              [key in keyof TExtensionConfigSchema]: z.infer<\n                ReturnType<TExtensionConfigSchema[key]>\n              >;\n            };\n            inputs: Expand<ResolvedExtensionInputs<T['inputs'] & TExtraInputs>>;\n          },\n        ): Iterable<UFactoryOutput>;\n      } & ([T['params']] extends [never]\n        ? {}\n        : {\n            params?: TParamsInput extends ExtensionBlueprintParamsDefiner\n              ? TParamsInput\n              : T['params'] extends ExtensionBlueprintParamsDefiner\n              ? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(define => define(<params>))`'\n              : Partial<T['params']>;\n          })\n    > &\n      VerifyExtensionFactoryOutput<\n        AnyExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UFactoryOutput\n      >,\n  ): ExtensionDefinition<{\n    kind: T['kind'];\n    name: T['name'];\n    output: AnyExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: T['inputs'] & TExtraInputs;\n    config: T['config'] & {\n      [key in keyof TExtensionConfigSchema]: z.infer<\n        ReturnType<TExtensionConfigSchema[key]>\n      >;\n    };\n    configInput: T['configInput'] &\n      z.input<\n        z.ZodObject<{\n          [key in keyof TExtensionConfigSchema]: ReturnType<\n            TExtensionConfigSchema[key]\n          >;\n        }>\n      >;\n  }>;\n};\n\n/** @public */\nexport function createExtension<\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  const TKind extends string | undefined = undefined,\n  const TName extends string | undefined = undefined,\n>(\n  options: CreateExtensionOptions<\n    TKind,\n    TName,\n    UOutput,\n    TInputs,\n    TConfigSchema,\n    UFactoryOutput\n  >,\n): ExtensionDefinition<{\n  config: string extends keyof TConfigSchema\n    ? {}\n    : {\n        [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n      };\n  configInput: string extends keyof TConfigSchema\n    ? {}\n    : z.input<\n        z.ZodObject<{\n          [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n        }>\n      >;\n  output: UOutput;\n  inputs: TInputs;\n  params: never;\n  kind: string | undefined extends TKind ? undefined : TKind;\n  name: string | undefined extends TName ? undefined : TName;\n}> {\n  const schemaDeclaration = options.config?.schema;\n  const configSchema =\n    schemaDeclaration &&\n    createSchemaFromZod(innerZ =>\n      innerZ.object(\n        Object.fromEntries(\n          Object.entries(schemaDeclaration).map(([k, v]) => [k, v(innerZ)]),\n        ),\n      ),\n    );\n\n  return OpaqueExtensionDefinition.createInstance('v2', {\n    T: undefined as unknown as {\n      config: string extends keyof TConfigSchema\n        ? {}\n        : {\n            [key in keyof TConfigSchema]: z.infer<\n              ReturnType<TConfigSchema[key]>\n            >;\n          };\n      configInput: string extends keyof TConfigSchema\n        ? {}\n        : z.input<\n            z.ZodObject<{\n              [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n            }>\n          >;\n      output: UOutput;\n      inputs: TInputs;\n      kind: string | undefined extends TKind ? undefined : TKind;\n      name: string | undefined extends TName ? undefined : TName;\n    },\n    kind: options.kind,\n    name: options.name,\n    attachTo: options.attachTo,\n    disabled: options.disabled ?? false,\n    inputs: options.inputs ?? {},\n    output: options.output,\n    configSchema,\n    factory: options.factory,\n    toString() {\n      const parts: string[] = [];\n      if (options.kind) {\n        parts.push(`kind=${options.kind}`);\n      }\n      if (options.name) {\n        parts.push(`name=${options.name}`);\n      }\n      parts.push(\n        `attachTo=${[options.attachTo]\n          .flat()\n          .map(a => `${a.id}@${a.input}`)\n          .join('+')}`,\n      );\n      return `ExtensionDefinition{${parts.join(',')}}`;\n    },\n    override(overrideOptions) {\n      if (!Array.isArray(options.output)) {\n        throw new Error(\n          'Cannot override an extension that is not declared using the new format with outputs as an array',\n        );\n      }\n\n      // TODO(Rugvip): Making this a type check would be optimal, but it seems\n      //               like it's tricky to add that and still have the type\n      //               inference work correctly for the factory output.\n      if (overrideOptions.output && !overrideOptions.factory) {\n        throw new Error(\n          'Refused to override output without also overriding factory',\n        );\n      }\n      // TODO(Rugvip): Similar to above, would be nice to error during type checking, but don't want to complicate the types too much\n      if (overrideOptions.params && overrideOptions.factory) {\n        throw new Error(\n          'Refused to override params and factory at the same time',\n        );\n      }\n\n      return createExtension({\n        kind: options.kind,\n        name: options.name,\n        attachTo: overrideOptions.attachTo ?? options.attachTo,\n        disabled: overrideOptions.disabled ?? options.disabled,\n        inputs: { ...overrideOptions.inputs, ...options.inputs },\n        output: (overrideOptions.output ??\n          options.output) as AnyExtensionDataRef[],\n        config:\n          options.config || overrideOptions.config\n            ? {\n                schema: {\n                  ...options.config?.schema,\n                  ...overrideOptions.config?.schema,\n                },\n              }\n            : undefined,\n        factory: ({ node, apis, config, inputs }) => {\n          if (!overrideOptions.factory) {\n            return options.factory({\n              node,\n              apis,\n              config: config as any,\n              inputs: inputs as any,\n              [ctxParamsSymbol as any]: overrideOptions.params,\n            });\n          }\n          const parentResult = overrideOptions.factory(\n            (innerContext): ExtensionDataContainer<UOutput> => {\n              return createExtensionDataContainer<UOutput>(\n                options.factory({\n                  node,\n                  apis,\n                  config: (innerContext?.config ?? config) as any,\n                  inputs: resolveInputOverrides(\n                    options.inputs,\n                    inputs,\n                    innerContext?.inputs,\n                  ) as any,\n                  [ctxParamsSymbol as any]: innerContext?.params,\n                }) as Iterable<any>,\n                options.output,\n              );\n            },\n            {\n              node,\n              apis,\n              config: config as any,\n              inputs: inputs as any,\n            },\n          );\n\n          const deduplicatedResult = new Map<\n            string,\n            ExtensionDataValue<any, any>\n          >();\n          for (const item of parentResult) {\n            deduplicatedResult.set(item.id, item);\n          }\n\n          return deduplicatedResult.values();\n        },\n      }) as ExtensionDefinition<any>;\n    },\n  });\n}\n"],"names":[],"mappings":";;;;;;AAsCa,MAAA,eAAA,GAAkB,OAAO,QAAQ;AAyPvC,SAAS,gBAad,OA0BC,EAAA;AACD,EAAM,MAAA,iBAAA,GAAoB,QAAQ,MAAQ,EAAA,MAAA;AAC1C,EAAA,MAAM,eACJ,iBACA,IAAA,mBAAA;AAAA,IAAoB,YAClB,MAAO,CAAA,MAAA;AAAA,MACL,MAAO,CAAA,WAAA;AAAA,QACL,MAAO,CAAA,OAAA,CAAQ,iBAAiB,CAAA,CAAE,IAAI,CAAC,CAAC,CAAG,EAAA,CAAC,MAAM,CAAC,CAAA,EAAG,CAAE,CAAA,MAAM,CAAC,CAAC;AAAA;AAClE;AACF,GACF;AAEF,EAAO,OAAA,yBAAA,CAA0B,eAAe,IAAM,EAAA;AAAA,IACpD,CAAG,EAAA,KAAA,CAAA;AAAA,IAoBH,MAAM,OAAQ,CAAA,IAAA;AAAA,IACd,MAAM,OAAQ,CAAA,IAAA;AAAA,IACd,UAAU,OAAQ,CAAA,QAAA;AAAA,IAClB,QAAA,EAAU,QAAQ,QAAY,IAAA,KAAA;AAAA,IAC9B,MAAA,EAAQ,OAAQ,CAAA,MAAA,IAAU,EAAC;AAAA,IAC3B,QAAQ,OAAQ,CAAA,MAAA;AAAA,IAChB,YAAA;AAAA,IACA,SAAS,OAAQ,CAAA,OAAA;AAAA,IACjB,QAAW,GAAA;AACT,MAAA,MAAM,QAAkB,EAAC;AACzB,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAA,KAAA,CAAM,IAAK,CAAA,CAAA,KAAA,EAAQ,OAAQ,CAAA,IAAI,CAAE,CAAA,CAAA;AAAA;AAEnC,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAA,KAAA,CAAM,IAAK,CAAA,CAAA,KAAA,EAAQ,OAAQ,CAAA,IAAI,CAAE,CAAA,CAAA;AAAA;AAEnC,MAAM,KAAA,CAAA,IAAA;AAAA,QACJ,YAAY,CAAC,OAAA,CAAQ,QAAQ,CAC1B,CAAA,IAAA,GACA,GAAI,CAAA,CAAA,CAAA,KAAK,GAAG,CAAE,CAAA,EAAE,IAAI,CAAE,CAAA,KAAK,EAAE,CAC7B,CAAA,IAAA,CAAK,GAAG,CAAC,CAAA;AAAA,OACd;AACA,MAAA,OAAO,CAAuB,oBAAA,EAAA,KAAA,CAAM,IAAK,CAAA,GAAG,CAAC,CAAA,CAAA,CAAA;AAAA,KAC/C;AAAA,IACA,SAAS,eAAiB,EAAA;AACxB,MAAA,IAAI,CAAC,KAAA,CAAM,OAAQ,CAAA,OAAA,CAAQ,MAAM,CAAG,EAAA;AAClC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA;AAMF,MAAA,IAAI,eAAgB,CAAA,MAAA,IAAU,CAAC,eAAA,CAAgB,OAAS,EAAA;AACtD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA;AAGF,MAAI,IAAA,eAAA,CAAgB,MAAU,IAAA,eAAA,CAAgB,OAAS,EAAA;AACrD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA;AAGF,MAAA,OAAO,eAAgB,CAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,QAAA,EAAU,eAAgB,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QAC9C,QAAA,EAAU,eAAgB,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QAC9C,QAAQ,EAAE,GAAG,gBAAgB,MAAQ,EAAA,GAAG,QAAQ,MAAO,EAAA;AAAA,QACvD,MAAA,EAAS,eAAgB,CAAA,MAAA,IACvB,OAAQ,CAAA,MAAA;AAAA,QACV,MACE,EAAA,OAAA,CAAQ,MAAU,IAAA,eAAA,CAAgB,MAC9B,GAAA;AAAA,UACE,MAAQ,EAAA;AAAA,YACN,GAAG,QAAQ,MAAQ,EAAA,MAAA;AAAA,YACnB,GAAG,gBAAgB,MAAQ,EAAA;AAAA;AAC7B,SAEF,GAAA,KAAA,CAAA;AAAA,QACN,SAAS,CAAC,EAAE,MAAM,IAAM,EAAA,MAAA,EAAQ,QAAa,KAAA;AAC3C,UAAI,IAAA,CAAC,gBAAgB,OAAS,EAAA;AAC5B,YAAA,OAAO,QAAQ,OAAQ,CAAA;AAAA,cACrB,IAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA;AAAA,cACA,MAAA;AAAA,cACA,CAAC,eAAsB,GAAG,eAAgB,CAAA;AAAA,aAC3C,CAAA;AAAA;AAEH,UAAA,MAAM,eAAe,eAAgB,CAAA,OAAA;AAAA,YACnC,CAAC,YAAkD,KAAA;AACjD,cAAO,OAAA,4BAAA;AAAA,gBACL,QAAQ,OAAQ,CAAA;AAAA,kBACd,IAAA;AAAA,kBACA,IAAA;AAAA,kBACA,MAAA,EAAS,cAAc,MAAU,IAAA,MAAA;AAAA,kBACjC,MAAQ,EAAA,qBAAA;AAAA,oBACN,OAAQ,CAAA,MAAA;AAAA,oBACR,MAAA;AAAA,oBACA,YAAc,EAAA;AAAA,mBAChB;AAAA,kBACA,CAAC,eAAsB,GAAG,YAAc,EAAA;AAAA,iBACzC,CAAA;AAAA,gBACD,OAAQ,CAAA;AAAA,eACV;AAAA,aACF;AAAA,YACA;AAAA,cACE,IAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA;AAAA,cACA;AAAA;AACF,WACF;AAEA,UAAM,MAAA,kBAAA,uBAAyB,GAG7B,EAAA;AACF,UAAA,KAAA,MAAW,QAAQ,YAAc,EAAA;AAC/B,YAAmB,kBAAA,CAAA,GAAA,CAAI,IAAK,CAAA,EAAA,EAAI,IAAI,CAAA;AAAA;AAGtC,UAAA,OAAO,mBAAmB,MAAO,EAAA;AAAA;AACnC,OACD,CAAA;AAAA;AACH,GACD,CAAA;AACH;;;;"}

package/dist/wiring/createExtensionBlueprint.esm.js

@@ -1,8 +1,60 @@
 import { createExtension, ctxParamsSymbol } from './createExtension.esm.js';
 import { resolveInputOverrides } from './resolveInputOverrides.esm.js';
+import { OpaqueType } from '../opaque-internal/src/OpaqueType.esm.js';
 import { createExtensionDataContainer } from '../frontend-internal/src/wiring/createExtensionDataContainer.esm.js';
 
+const OpaqueBlueprintParams = OpaqueType.create({
+  type: "@backstage/BlueprintParams",
+  versions: ["v1"]
+});
+function createExtensionBlueprintParams(params) {
+  return OpaqueBlueprintParams.createInstance("v1", { T: null, params });
+}
+function unwrapParamsFactory(params, defineParams, kind) {
+  const paramDefinition = params(defineParams);
+  try {
+    return OpaqueBlueprintParams.toInternal(paramDefinition).params;
+  } catch (e) {
+    throw new TypeError(
+      `Invalid invocation of blueprint with kind '${kind}', the parameter definition callback function did not return a valid parameter definition object; Caused by: ${e.message}`
+    );
+  }
+}
+function unwrapParams(params, ctx, defineParams, kind) {
+  const overrideParams = ctx[ctxParamsSymbol];
+  if (defineParams) {
+    if (overrideParams) {
+      if (typeof overrideParams !== "function") {
+        throw new TypeError(
+          `Invalid extension override of blueprint with kind '${kind}', the override params were passed as a plain object, but this blueprint requires them to be passed in callback form`
+        );
+      }
+      return unwrapParamsFactory(overrideParams, defineParams, kind);
+    }
+    if (typeof params !== "function") {
+      throw new TypeError(
+        `Invalid invocation of blueprint with kind '${kind}', the parameters where passed as a plain object, but this blueprint requires them to be passed in callback form`
+      );
+    }
+    return unwrapParamsFactory(params, defineParams, kind);
+  }
+  const base = typeof params === "function" ? unwrapParamsFactory(
+    params,
+    createExtensionBlueprintParams,
+    kind
+  ) : params;
+  const overrides = typeof overrideParams === "function" ? unwrapParamsFactory(
+    overrideParams,
+    createExtensionBlueprintParams,
+    kind
+  ) : overrideParams;
+  return {
+    ...base,
+    ...overrides
+  };
+}
 function createExtensionBlueprint(options) {
+  const defineParams = options.defineParams;
   return {
     dataRefs: options.dataRefs,
     make(args) {
@@ -15,7 +67,7 @@ function createExtensionBlueprint(options) {
         output: options.output,
         config: options.config,
         factory: (ctx) => options.factory(
-          { ...args.params, ...ctx[ctxParamsSymbol] },
+          unwrapParams(args.params, ctx, defineParams, options.kind),
           ctx
         )
       });
@@ -40,7 +92,7 @@ function createExtensionBlueprint(options) {
             (innerParams, innerContext) => {
               return createExtensionDataContainer(
                 options.factory(
-                  { ...innerParams, ...ctx[ctxParamsSymbol] },
+                  unwrapParams(innerParams, ctx, defineParams, options.kind),
                   {
                     apis,
                     node,
@@ -68,5 +120,5 @@ function createExtensionBlueprint(options) {
   };
 }
 
-export { createExtensionBlueprint };
+export { createExtensionBlueprint, createExtensionBlueprintParams };
 //# sourceMappingURL=createExtensionBlueprint.esm.js.map

package/dist/wiring/createExtensionBlueprint.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"createExtensionBlueprint.esm.js","sources":["../../src/wiring/createExtensionBlueprint.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiHolder, AppNode } from '../apis';\nimport { Expand } from '@backstage/types';\nimport {\n  ExtensionAttachToSpec,\n  ExtensionDefinition,\n  ResolvedExtensionInputs,\n  VerifyExtensionFactoryOutput,\n  createExtension,\n  ctxParamsSymbol,\n} from './createExtension';\nimport { z } from 'zod';\nimport { ExtensionInput } from './createExtensionInput';\nimport {\n  AnyExtensionDataRef,\n  ExtensionDataValue,\n} from './createExtensionDataRef';\nimport { createExtensionDataContainer } from '@internal/frontend';\nimport {\n  ResolveInputValueOverrides,\n  resolveInputOverrides,\n} from './resolveInputOverrides';\nimport { ExtensionDataContainer } from './types';\n\n/**\n * @public\n */\nexport type CreateExtensionBlueprintOptions<\n  TKind extends string,\n  TName extends string | undefined,\n  TParams,\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  TDataRefs extends { [name in string]: AnyExtensionDataRef },\n> = {\n  kind: TKind;\n  attachTo: ExtensionAttachToSpec;\n  disabled?: boolean;\n  inputs?: TInputs;\n  output: Array<UOutput>;\n  name?: TName;\n  config?: {\n    schema: TConfigSchema;\n  };\n  factory(\n    params: TParams,\n    context: {\n      node: AppNode;\n      apis: ApiHolder;\n      config: {\n        [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n      };\n      inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n    },\n  ): Iterable<UFactoryOutput>;\n\n  dataRefs?: TDataRefs;\n} & VerifyExtensionFactoryOutput<UOutput, UFactoryOutput>;\n\n/** @public */\nexport type ExtensionBlueprintParameters = {\n  kind: string;\n  name?: string;\n  params?: object;\n  configInput?: { [K in string]: any };\n  config?: { [K in string]: any };\n  output?: AnyExtensionDataRef;\n  inputs?: {\n    [KName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  };\n  dataRefs?: { [name in string]: AnyExtensionDataRef };\n};\n\n/**\n * @public\n */\nexport interface ExtensionBlueprint<\n  T extends ExtensionBlueprintParameters = ExtensionBlueprintParameters,\n> {\n  dataRefs: T['dataRefs'];\n\n  make<TNewName extends string | undefined>(args: {\n    name?: TNewName;\n    attachTo?: ExtensionAttachToSpec;\n    disabled?: boolean;\n    params: T['params'];\n  }): ExtensionDefinition<{\n    kind: T['kind'];\n    name: string | undefined extends TNewName ? T['name'] : TNewName;\n    config: T['config'];\n    configInput: T['configInput'];\n    output: T['output'];\n    inputs: T['inputs'];\n    params: T['params'];\n  }>;\n\n  /**\n   * Creates a new extension from the blueprint.\n   *\n   * You must either pass `params` directly, or define a `factory` that can\n   * optionally call the original factory with the same params.\n   */\n  makeWithOverrides<\n    TNewName extends string | undefined,\n    TExtensionConfigSchema extends {\n      [key in string]: (zImpl: typeof z) => z.ZodType;\n    },\n    UFactoryOutput extends ExtensionDataValue<any, any>,\n    UNewOutput extends AnyExtensionDataRef,\n    TExtraInputs extends {\n      [inputName in string]: ExtensionInput<\n        AnyExtensionDataRef,\n        { optional: boolean; singleton: boolean }\n      >;\n    },\n  >(args: {\n    name?: TNewName;\n    attachTo?: ExtensionAttachToSpec;\n    disabled?: boolean;\n    inputs?: TExtraInputs & {\n      [KName in keyof T['inputs']]?: `Error: Input '${KName &\n        string}' is already defined in parent definition`;\n    };\n    output?: Array<UNewOutput>;\n    config?: {\n      schema: TExtensionConfigSchema & {\n        [KName in keyof T['config']]?: `Error: Config key '${KName &\n          string}' is already defined in parent schema`;\n      };\n    };\n    factory(\n      originalFactory: (\n        params: T['params'],\n        context?: {\n          config?: T['config'];\n          inputs?: ResolveInputValueOverrides<NonNullable<T['inputs']>>;\n        },\n      ) => ExtensionDataContainer<NonNullable<T['output']>>,\n      context: {\n        node: AppNode;\n        apis: ApiHolder;\n        config: T['config'] & {\n          [key in keyof TExtensionConfigSchema]: z.infer<\n            ReturnType<TExtensionConfigSchema[key]>\n          >;\n        };\n        inputs: Expand<ResolvedExtensionInputs<T['inputs'] & TExtraInputs>>;\n      },\n    ): Iterable<UFactoryOutput> &\n      VerifyExtensionFactoryOutput<\n        AnyExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UFactoryOutput\n      >;\n  }): ExtensionDefinition<{\n    config: (string extends keyof TExtensionConfigSchema\n      ? {}\n      : {\n          [key in keyof TExtensionConfigSchema]: z.infer<\n            ReturnType<TExtensionConfigSchema[key]>\n          >;\n        }) &\n      T['config'];\n    configInput: (string extends keyof TExtensionConfigSchema\n      ? {}\n      : z.input<\n          z.ZodObject<{\n            [key in keyof TExtensionConfigSchema]: ReturnType<\n              TExtensionConfigSchema[key]\n            >;\n          }>\n        >) &\n      T['configInput'];\n    output: AnyExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: T['inputs'] & TExtraInputs;\n    kind: T['kind'];\n    name: string | undefined extends TNewName ? T['name'] : TNewName;\n    params: T['params'];\n  }>;\n}\n\n/**\n * A simpler replacement for wrapping up `createExtension` inside a kind or type. This allows for a cleaner API for creating\n * types and instances of those types.\n *\n * @public\n */\nexport function createExtensionBlueprint<\n  TParams extends object,\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  TKind extends string,\n  TName extends string | undefined = undefined,\n  TDataRefs extends { [name in string]: AnyExtensionDataRef } = never,\n>(\n  options: CreateExtensionBlueprintOptions<\n    TKind,\n    TName,\n    TParams,\n    UOutput,\n    TInputs,\n    TConfigSchema,\n    UFactoryOutput,\n    TDataRefs\n  >,\n): ExtensionBlueprint<{\n  kind: TKind;\n  name: TName;\n  params: TParams;\n  output: UOutput;\n  inputs: string extends keyof TInputs ? {} : TInputs;\n  config: string extends keyof TConfigSchema\n    ? {}\n    : { [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>> };\n  configInput: string extends keyof TConfigSchema\n    ? {}\n    : z.input<\n        z.ZodObject<{\n          [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n        }>\n      >;\n  dataRefs: TDataRefs;\n}> {\n  return {\n    dataRefs: options.dataRefs,\n    make(args) {\n      return createExtension({\n        kind: options.kind,\n        name: args.name ?? options.name,\n        attachTo: args.attachTo ?? options.attachTo,\n        disabled: args.disabled ?? options.disabled,\n        inputs: options.inputs,\n        output: options.output as AnyExtensionDataRef[],\n        config: options.config,\n        factory: ctx =>\n          options.factory(\n            { ...args.params, ...(ctx as any)[ctxParamsSymbol] },\n            ctx,\n          ) as Iterable<ExtensionDataValue<any, any>>,\n      }) as ExtensionDefinition;\n    },\n    makeWithOverrides(args) {\n      return createExtension({\n        kind: options.kind,\n        name: args.name ?? options.name,\n        attachTo: args.attachTo ?? options.attachTo,\n        disabled: args.disabled ?? options.disabled,\n        inputs: { ...args.inputs, ...options.inputs },\n        output: (args.output ?? options.output) as AnyExtensionDataRef[],\n        config:\n          options.config || args.config\n            ? {\n                schema: {\n                  ...options.config?.schema,\n                  ...args.config?.schema,\n                },\n              }\n            : undefined,\n        factory: ctx => {\n          const { node, config, inputs, apis } = ctx;\n          return args.factory(\n            (innerParams, innerContext) => {\n              return createExtensionDataContainer<UOutput>(\n                options.factory(\n                  { ...innerParams, ...(ctx as any)[ctxParamsSymbol] },\n                  {\n                    apis,\n                    node,\n                    config: (innerContext?.config ?? config) as any,\n                    inputs: resolveInputOverrides(\n                      options.inputs,\n                      inputs,\n                      innerContext?.inputs,\n                    ) as any,\n                  },\n                ) as Iterable<any>,\n                options.output,\n              );\n            },\n            {\n              apis,\n              node,\n              config: config as any,\n              inputs: inputs as any,\n            },\n          ) as Iterable<ExtensionDataValue<any, any>>;\n        },\n      }) as ExtensionDefinition;\n    },\n  } as ExtensionBlueprint<{\n    kind: TKind;\n    name: TName;\n    params: TParams;\n    output: UOutput;\n    inputs: string extends keyof TInputs ? {} : TInputs;\n    config: string extends keyof TConfigSchema\n      ? {}\n      : {\n          [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n        };\n    configInput: string extends keyof TConfigSchema\n      ? {}\n      : z.input<\n          z.ZodObject<{\n            [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n          }>\n        >;\n    dataRefs: TDataRefs;\n  }>;\n}\n"],"names":[],"mappings":";;;;AAqNO,SAAS,yBAed,OA2BC,EAAA;AACD,EAAO,OAAA;AAAA,IACL,UAAU,OAAQ,CAAA,QAAA;AAAA,IAClB,KAAK,IAAM,EAAA;AACT,MAAA,OAAO,eAAgB,CAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,IAAA,EAAM,IAAK,CAAA,IAAA,IAAQ,OAAQ,CAAA,IAAA;AAAA,QAC3B,QAAA,EAAU,IAAK,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QACnC,QAAA,EAAU,IAAK,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QACnC,QAAQ,OAAQ,CAAA,MAAA;AAAA,QAChB,QAAQ,OAAQ,CAAA,MAAA;AAAA,QAChB,QAAQ,OAAQ,CAAA,MAAA;AAAA,QAChB,OAAA,EAAS,SACP,OAAQ,CAAA,OAAA;AAAA,UACN,EAAE,GAAG,IAAA,CAAK,QAAQ,GAAI,GAAA,CAAY,eAAe,CAAE,EAAA;AAAA,UACnD;AAAA;AACF,OACH,CAAA;AAAA,KACH;AAAA,IACA,kBAAkB,IAAM,EAAA;AACtB,MAAA,OAAO,eAAgB,CAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,IAAA,EAAM,IAAK,CAAA,IAAA,IAAQ,OAAQ,CAAA,IAAA;AAAA,QAC3B,QAAA,EAAU,IAAK,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QACnC,QAAA,EAAU,IAAK,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QACnC,QAAQ,EAAE,GAAG,KAAK,MAAQ,EAAA,GAAG,QAAQ,MAAO,EAAA;AAAA,QAC5C,MAAA,EAAS,IAAK,CAAA,MAAA,IAAU,OAAQ,CAAA,MAAA;AAAA,QAChC,MACE,EAAA,OAAA,CAAQ,MAAU,IAAA,IAAA,CAAK,MACnB,GAAA;AAAA,UACE,MAAQ,EAAA;AAAA,YACN,GAAG,QAAQ,MAAQ,EAAA,MAAA;AAAA,YACnB,GAAG,KAAK,MAAQ,EAAA;AAAA;AAClB,SAEF,GAAA,KAAA,CAAA;AAAA,QACN,SAAS,CAAO,GAAA,KAAA;AACd,UAAA,MAAM,EAAE,IAAA,EAAM,MAAQ,EAAA,MAAA,EAAQ,MAAS,GAAA,GAAA;AACvC,UAAA,OAAO,IAAK,CAAA,OAAA;AAAA,YACV,CAAC,aAAa,YAAiB,KAAA;AAC7B,cAAO,OAAA,4BAAA;AAAA,gBACL,OAAQ,CAAA,OAAA;AAAA,kBACN,EAAE,GAAG,WAAA,EAAa,GAAI,GAAA,CAAY,eAAe,CAAE,EAAA;AAAA,kBACnD;AAAA,oBACE,IAAA;AAAA,oBACA,IAAA;AAAA,oBACA,MAAA,EAAS,cAAc,MAAU,IAAA,MAAA;AAAA,oBACjC,MAAQ,EAAA,qBAAA;AAAA,sBACN,OAAQ,CAAA,MAAA;AAAA,sBACR,MAAA;AAAA,sBACA,YAAc,EAAA;AAAA;AAChB;AACF,iBACF;AAAA,gBACA,OAAQ,CAAA;AAAA,eACV;AAAA,aACF;AAAA,YACA;AAAA,cACE,IAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA;AAAA,cACA;AAAA;AACF,WACF;AAAA;AACF,OACD,CAAA;AAAA;AACH,GACF;AAoBF;;;;"}
+{"version":3,"file":"createExtensionBlueprint.esm.js","sources":["../../src/wiring/createExtensionBlueprint.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiHolder, AppNode } from '../apis';\nimport { Expand } from '@backstage/types';\nimport { OpaqueType } from '@internal/opaque';\nimport {\n  ExtensionAttachToSpec,\n  ExtensionDefinition,\n  ResolvedExtensionInputs,\n  VerifyExtensionFactoryOutput,\n  createExtension,\n  ctxParamsSymbol,\n} from './createExtension';\nimport { z } from 'zod';\nimport { ExtensionInput } from './createExtensionInput';\nimport {\n  AnyExtensionDataRef,\n  ExtensionDataValue,\n} from './createExtensionDataRef';\nimport { createExtensionDataContainer } from '@internal/frontend';\nimport {\n  ResolveInputValueOverrides,\n  resolveInputOverrides,\n} from './resolveInputOverrides';\nimport { ExtensionDataContainer } from './types';\n\n/**\n * A function used to define a parameter mapping function in order to facilitate\n * advanced parameter typing for extension blueprints.\n *\n * @remarks\n *\n * This function is primarily intended to enable the use of inferred type\n * parameters for blueprint params, but it can also be used to transoform the\n * params before they are handed ot the blueprint.\n *\n * The function must return an object created with\n * {@link createExtensionBlueprintParams}.\n *\n * @public\n */\nexport type ExtensionBlueprintParamsDefiner<\n  TParams extends object = object,\n  TInput = any,\n> = (params: TInput) => ExtensionBlueprintParams<TParams>;\n\n/**\n * An opaque type that represents a set of parameters to be passed to a blueprint.\n *\n * @remarks\n *\n * Created with {@link createExtensionBlueprintParams}.\n *\n * @public\n */\nexport type ExtensionBlueprintParams<T extends object = object> = {\n  $$type: '@backstage/BlueprintParams';\n  T: T;\n};\n\nconst OpaqueBlueprintParams = OpaqueType.create<{\n  public: ExtensionBlueprintParams;\n  versions: {\n    version: 'v1';\n    params: object;\n  };\n}>({\n  type: '@backstage/BlueprintParams',\n  versions: ['v1'],\n});\n\n/**\n * Wraps a plain blueprint parameter object in an opaque {@link ExtensionBlueprintParams} object.\n *\n * This is used in the definition of the `defineParams` option of {@link ExtensionBlueprint}.\n *\n * @public\n * @param params - The plain blueprint parameter object to wrap.\n * @returns The wrapped blueprint parameter object.\n */\nexport function createExtensionBlueprintParams<T extends object = object>(\n  params: T,\n): ExtensionBlueprintParams<T> {\n  return OpaqueBlueprintParams.createInstance('v1', { T: null as any, params });\n}\n\n/**\n * @public\n */\nexport type CreateExtensionBlueprintOptions<\n  TKind extends string,\n  TName extends string | undefined,\n  TParams extends object | ExtensionBlueprintParamsDefiner,\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  TDataRefs extends { [name in string]: AnyExtensionDataRef },\n> = {\n  kind: TKind;\n  attachTo: ExtensionAttachToSpec;\n  disabled?: boolean;\n  inputs?: TInputs;\n  output: Array<UOutput>;\n  name?: TName;\n  config?: {\n    schema: TConfigSchema;\n  };\n  /**\n   * This option is used to further refine the blueprint params. When this\n   * option is used, the blueprint will require params to be passed in callback\n   * form. This function can both transform the params before they are handed to\n   * the blueprint factory, but importantly it also allows you to define\n   * inferred type parameters for your blueprint params.\n   *\n   * @example\n   * Blueprint definition with inferred type parameters:\n   * ```ts\n   * const ExampleBlueprint = createExtensionBlueprint({\n   *   kind: 'example',\n   *   attachTo: { id: 'example', input: 'example' },\n   *   output: [exampleComponentDataRef, exampleFetcherDataRef],\n   *   defineParams<T>(params: {\n   *     component(props: ExampleProps<T>): JSX.Element | null\n   *     fetcher(options: FetchOptions): Promise<FetchResult<T>>\n   *   }) {\n   *     return createExtensionBlueprintParams(params);\n   *   },\n   *   *factory(params) {\n   *     yield exampleComponentDataRef(params.component)\n   *     yield exampleFetcherDataRef(params.fetcher)\n   *   },\n   * });\n   * ```\n   *\n   * @example\n   * Usage of the above example blueprint:\n   * ```ts\n   * const example = ExampleBlueprint.make({\n   *   params: define => define({\n   *     component: ...,\n   *     fetcher: ...,\n   *   }),\n   * });\n   * ```\n   */\n  defineParams?: TParams extends ExtensionBlueprintParamsDefiner\n    ? TParams\n    : 'The defineParams option must be a function if provided, see the docs for details';\n  factory(\n    params: TParams extends ExtensionBlueprintParamsDefiner\n      ? ReturnType<TParams>['T']\n      : TParams,\n    context: {\n      node: AppNode;\n      apis: ApiHolder;\n      config: {\n        [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n      };\n      inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n    },\n  ): Iterable<UFactoryOutput>;\n\n  dataRefs?: TDataRefs;\n} & VerifyExtensionFactoryOutput<UOutput, UFactoryOutput>;\n\n/** @public */\nexport type ExtensionBlueprintParameters = {\n  kind: string;\n  name?: string;\n  params?: object | ExtensionBlueprintParamsDefiner;\n  configInput?: { [K in string]: any };\n  config?: { [K in string]: any };\n  output?: AnyExtensionDataRef;\n  inputs?: {\n    [KName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  };\n  dataRefs?: { [name in string]: AnyExtensionDataRef };\n};\n\n/** @ignore */\ntype ParamsFactory<TDefiner extends ExtensionBlueprintParamsDefiner> = (\n  define: TDefiner,\n) => ReturnType<TDefiner>;\n\n/**\n * Represents any form of params input that can be passed to a blueprint.\n * This also includes the invalid form of passing a plain params object to a blueprint that uses a definition callback.\n *\n * @ignore\n */\ntype AnyParamsInput<TParams extends object | ExtensionBlueprintParamsDefiner> =\n  TParams extends ExtensionBlueprintParamsDefiner<infer IParams>\n    ? IParams | ParamsFactory<TParams>\n    :\n        | TParams\n        | ParamsFactory<ExtensionBlueprintParamsDefiner<TParams, TParams>>;\n\n/**\n * @public\n */\nexport interface ExtensionBlueprint<\n  // TParamsMapper extends (params: any) => object,\n  T extends ExtensionBlueprintParameters = ExtensionBlueprintParameters,\n> {\n  dataRefs: T['dataRefs'];\n\n  make<\n    TNewName extends string | undefined,\n    TParamsInput extends AnyParamsInput<NonNullable<T['params']>>,\n  >(args: {\n    name?: TNewName;\n    attachTo?: ExtensionAttachToSpec;\n    disabled?: boolean;\n    params: TParamsInput extends ExtensionBlueprintParamsDefiner\n      ? TParamsInput\n      : T['params'] extends ExtensionBlueprintParamsDefiner\n      ? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `<blueprint>.make({ params: define => define(<params>) })`'\n      : TParamsInput;\n  }): ExtensionDefinition<{\n    kind: T['kind'];\n    name: string | undefined extends TNewName ? T['name'] : TNewName;\n    config: T['config'];\n    configInput: T['configInput'];\n    output: T['output'];\n    inputs: T['inputs'];\n    params: T['params'];\n  }>;\n\n  /**\n   * Creates a new extension from the blueprint.\n   *\n   * You must either pass `params` directly, or define a `factory` that can\n   * optionally call the original factory with the same params.\n   */\n  makeWithOverrides<\n    TNewName extends string | undefined,\n    TExtensionConfigSchema extends {\n      [key in string]: (zImpl: typeof z) => z.ZodType;\n    },\n    UFactoryOutput extends ExtensionDataValue<any, any>,\n    UNewOutput extends AnyExtensionDataRef,\n    TExtraInputs extends {\n      [inputName in string]: ExtensionInput<\n        AnyExtensionDataRef,\n        { optional: boolean; singleton: boolean }\n      >;\n    },\n  >(args: {\n    name?: TNewName;\n    attachTo?: ExtensionAttachToSpec;\n    disabled?: boolean;\n    inputs?: TExtraInputs & {\n      [KName in keyof T['inputs']]?: `Error: Input '${KName &\n        string}' is already defined in parent definition`;\n    };\n    output?: Array<UNewOutput>;\n    config?: {\n      schema: TExtensionConfigSchema & {\n        [KName in keyof T['config']]?: `Error: Config key '${KName &\n          string}' is already defined in parent schema`;\n      };\n    };\n    factory(\n      originalFactory: <\n        TParamsInput extends AnyParamsInput<NonNullable<T['params']>>,\n      >(\n        params: TParamsInput extends ExtensionBlueprintParamsDefiner\n          ? TParamsInput\n          : T['params'] extends ExtensionBlueprintParamsDefiner\n          ? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(define => define(<params>))`'\n          : TParamsInput,\n        context?: {\n          config?: T['config'];\n          inputs?: ResolveInputValueOverrides<NonNullable<T['inputs']>>;\n        },\n      ) => ExtensionDataContainer<NonNullable<T['output']>>,\n      context: {\n        node: AppNode;\n        apis: ApiHolder;\n        config: T['config'] & {\n          [key in keyof TExtensionConfigSchema]: z.infer<\n            ReturnType<TExtensionConfigSchema[key]>\n          >;\n        };\n        inputs: Expand<ResolvedExtensionInputs<T['inputs'] & TExtraInputs>>;\n      },\n    ): Iterable<UFactoryOutput> &\n      VerifyExtensionFactoryOutput<\n        AnyExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UFactoryOutput\n      >;\n  }): ExtensionDefinition<{\n    config: (string extends keyof TExtensionConfigSchema\n      ? {}\n      : {\n          [key in keyof TExtensionConfigSchema]: z.infer<\n            ReturnType<TExtensionConfigSchema[key]>\n          >;\n        }) &\n      T['config'];\n    configInput: (string extends keyof TExtensionConfigSchema\n      ? {}\n      : z.input<\n          z.ZodObject<{\n            [key in keyof TExtensionConfigSchema]: ReturnType<\n              TExtensionConfigSchema[key]\n            >;\n          }>\n        >) &\n      T['configInput'];\n    output: AnyExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: T['inputs'] & TExtraInputs;\n    kind: T['kind'];\n    name: string | undefined extends TNewName ? T['name'] : TNewName;\n    params: T['params'];\n  }>;\n}\n\nfunction unwrapParamsFactory<TParams extends object>(\n  // Allow `Function` because `typeof <object> === 'function'` allows it, but in practice this should always be a param factory\n  params: ParamsFactory<ExtensionBlueprintParamsDefiner> | Function,\n  defineParams: ExtensionBlueprintParamsDefiner,\n  kind: string,\n): TParams {\n  const paramDefinition = (\n    params as ParamsFactory<ExtensionBlueprintParamsDefiner>\n  )(defineParams);\n  try {\n    return OpaqueBlueprintParams.toInternal(paramDefinition).params as TParams;\n  } catch (e) {\n    throw new TypeError(\n      `Invalid invocation of blueprint with kind '${kind}', the parameter definition callback function did not return a valid parameter definition object; Caused by: ${e.message}`,\n    );\n  }\n}\n\nfunction unwrapParams<TParams extends object>(\n  params: object | ParamsFactory<ExtensionBlueprintParamsDefiner> | string,\n  ctx: { node: AppNode; [ctxParamsSymbol]?: any },\n  defineParams: ExtensionBlueprintParamsDefiner | undefined,\n  kind: string,\n): TParams {\n  const overrideParams = ctx[ctxParamsSymbol] as\n    | object\n    | ParamsFactory<ExtensionBlueprintParamsDefiner>\n    | undefined;\n\n  if (defineParams) {\n    if (overrideParams) {\n      if (typeof overrideParams !== 'function') {\n        throw new TypeError(\n          `Invalid extension override of blueprint with kind '${kind}', the override params were passed as a plain object, but this blueprint requires them to be passed in callback form`,\n        );\n      }\n      return unwrapParamsFactory(overrideParams, defineParams, kind);\n    }\n\n    if (typeof params !== 'function') {\n      throw new TypeError(\n        `Invalid invocation of blueprint with kind '${kind}', the parameters where passed as a plain object, but this blueprint requires them to be passed in callback form`,\n      );\n    }\n    return unwrapParamsFactory(params, defineParams, kind);\n  }\n\n  const base =\n    typeof params === 'function'\n      ? unwrapParamsFactory<TParams>(\n          params,\n          createExtensionBlueprintParams,\n          kind,\n        )\n      : (params as TParams);\n  const overrides =\n    typeof overrideParams === 'function'\n      ? unwrapParamsFactory<TParams>(\n          overrideParams,\n          createExtensionBlueprintParams,\n          kind,\n        )\n      : (overrideParams as Partial<TParams>);\n\n  return {\n    ...base,\n    ...overrides,\n  };\n}\n\n/**\n * A simpler replacement for wrapping up `createExtension` inside a kind or type. This allows for a cleaner API for creating\n * types and instances of those types.\n *\n * @public\n */\nexport function createExtensionBlueprint<\n  TParams extends object | ExtensionBlueprintParamsDefiner,\n  UOutput extends AnyExtensionDataRef,\n  TInputs extends {\n    [inputName in string]: ExtensionInput<\n      AnyExtensionDataRef,\n      { optional: boolean; singleton: boolean }\n    >;\n  },\n  TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  TKind extends string,\n  TName extends string | undefined = undefined,\n  TDataRefs extends { [name in string]: AnyExtensionDataRef } = never,\n>(\n  options: CreateExtensionBlueprintOptions<\n    TKind,\n    TName,\n    TParams,\n    UOutput,\n    TInputs,\n    TConfigSchema,\n    UFactoryOutput,\n    TDataRefs\n  >,\n): ExtensionBlueprint<{\n  kind: TKind;\n  name: TName;\n  params: TParams;\n  output: UOutput;\n  inputs: string extends keyof TInputs ? {} : TInputs;\n  config: string extends keyof TConfigSchema\n    ? {}\n    : { [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>> };\n  configInput: string extends keyof TConfigSchema\n    ? {}\n    : z.input<\n        z.ZodObject<{\n          [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n        }>\n      >;\n  dataRefs: TDataRefs;\n}> {\n  const defineParams = options.defineParams as\n    | ExtensionBlueprintParamsDefiner\n    | undefined;\n\n  return {\n    dataRefs: options.dataRefs,\n    make(args) {\n      return createExtension({\n        kind: options.kind,\n        name: args.name ?? options.name,\n        attachTo: args.attachTo ?? options.attachTo,\n        disabled: args.disabled ?? options.disabled,\n        inputs: options.inputs,\n        output: options.output as AnyExtensionDataRef[],\n        config: options.config,\n        factory: ctx =>\n          options.factory(\n            unwrapParams(args.params, ctx, defineParams, options.kind),\n            ctx,\n          ) as Iterable<ExtensionDataValue<any, any>>,\n      }) as ExtensionDefinition;\n    },\n    makeWithOverrides(args) {\n      return createExtension({\n        kind: options.kind,\n        name: args.name ?? options.name,\n        attachTo: args.attachTo ?? options.attachTo,\n        disabled: args.disabled ?? options.disabled,\n        inputs: { ...args.inputs, ...options.inputs },\n        output: (args.output ?? options.output) as AnyExtensionDataRef[],\n        config:\n          options.config || args.config\n            ? {\n                schema: {\n                  ...options.config?.schema,\n                  ...args.config?.schema,\n                },\n              }\n            : undefined,\n        factory: ctx => {\n          const { node, config, inputs, apis } = ctx;\n          return args.factory(\n            (innerParams, innerContext) => {\n              return createExtensionDataContainer<UOutput>(\n                options.factory(\n                  unwrapParams(innerParams, ctx, defineParams, options.kind),\n                  {\n                    apis,\n                    node,\n                    config: (innerContext?.config ?? config) as any,\n                    inputs: resolveInputOverrides(\n                      options.inputs,\n                      inputs,\n                      innerContext?.inputs,\n                    ) as any,\n                  },\n                ) as Iterable<any>,\n                options.output,\n              );\n            },\n            {\n              apis,\n              node,\n              config: config as any,\n              inputs: inputs as any,\n            },\n          ) as Iterable<ExtensionDataValue<any, any>>;\n        },\n      }) as ExtensionDefinition;\n    },\n  } as ExtensionBlueprint<{\n    kind: TKind;\n    name: TName;\n    params: TParams;\n    output: UOutput;\n    inputs: string extends keyof TInputs ? {} : TInputs;\n    config: string extends keyof TConfigSchema\n      ? {}\n      : {\n          [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n        };\n    configInput: string extends keyof TConfigSchema\n      ? {}\n      : z.input<\n          z.ZodObject<{\n            [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n          }>\n        >;\n    dataRefs: TDataRefs;\n  }>;\n}\n"],"names":[],"mappings":";;;;;AA0EA,MAAM,qBAAA,GAAwB,WAAW,MAMtC,CAAA;AAAA,EACD,IAAM,EAAA,4BAAA;AAAA,EACN,QAAA,EAAU,CAAC,IAAI;AACjB,CAAC,CAAA;AAWM,SAAS,+BACd,MAC6B,EAAA;AAC7B,EAAA,OAAO,sBAAsB,cAAe,CAAA,IAAA,EAAM,EAAE,CAAG,EAAA,IAAA,EAAa,QAAQ,CAAA;AAC9E;AAqPA,SAAS,mBAAA,CAEP,MACA,EAAA,YAAA,EACA,IACS,EAAA;AACT,EAAM,MAAA,eAAA,GACJ,OACA,YAAY,CAAA;AACd,EAAI,IAAA;AACF,IAAO,OAAA,qBAAA,CAAsB,UAAW,CAAA,eAAe,CAAE,CAAA,MAAA;AAAA,WAClD,CAAG,EAAA;AACV,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAA8C,2CAAA,EAAA,IAAI,CAAgH,6GAAA,EAAA,CAAA,CAAE,OAAO,CAAA;AAAA,KAC7K;AAAA;AAEJ;AAEA,SAAS,YACP,CAAA,MAAA,EACA,GACA,EAAA,YAAA,EACA,IACS,EAAA;AACT,EAAM,MAAA,cAAA,GAAiB,IAAI,eAAe,CAAA;AAK1C,EAAA,IAAI,YAAc,EAAA;AAChB,IAAA,IAAI,cAAgB,EAAA;AAClB,MAAI,IAAA,OAAO,mBAAmB,UAAY,EAAA;AACxC,QAAA,MAAM,IAAI,SAAA;AAAA,UACR,sDAAsD,IAAI,CAAA,oHAAA;AAAA,SAC5D;AAAA;AAEF,MAAO,OAAA,mBAAA,CAAoB,cAAgB,EAAA,YAAA,EAAc,IAAI,CAAA;AAAA;AAG/D,IAAI,IAAA,OAAO,WAAW,UAAY,EAAA;AAChC,MAAA,MAAM,IAAI,SAAA;AAAA,QACR,8CAA8C,IAAI,CAAA,gHAAA;AAAA,OACpD;AAAA;AAEF,IAAO,OAAA,mBAAA,CAAoB,MAAQ,EAAA,YAAA,EAAc,IAAI,CAAA;AAAA;AAGvD,EAAM,MAAA,IAAA,GACJ,OAAO,MAAA,KAAW,UACd,GAAA,mBAAA;AAAA,IACE,MAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA,GAED,GAAA,MAAA;AACP,EAAM,MAAA,SAAA,GACJ,OAAO,cAAA,KAAmB,UACtB,GAAA,mBAAA;AAAA,IACE,cAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA,GAED,GAAA,cAAA;AAEP,EAAO,OAAA;AAAA,IACL,GAAG,IAAA;AAAA,IACH,GAAG;AAAA,GACL;AACF;AAQO,SAAS,yBAed,OA2BC,EAAA;AACD,EAAA,MAAM,eAAe,OAAQ,CAAA,YAAA;AAI7B,EAAO,OAAA;AAAA,IACL,UAAU,OAAQ,CAAA,QAAA;AAAA,IAClB,KAAK,IAAM,EAAA;AACT,MAAA,OAAO,eAAgB,CAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,IAAA,EAAM,IAAK,CAAA,IAAA,IAAQ,OAAQ,CAAA,IAAA;AAAA,QAC3B,QAAA,EAAU,IAAK,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QACnC,QAAA,EAAU,IAAK,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QACnC,QAAQ,OAAQ,CAAA,MAAA;AAAA,QAChB,QAAQ,OAAQ,CAAA,MAAA;AAAA,QAChB,QAAQ,OAAQ,CAAA,MAAA;AAAA,QAChB,OAAA,EAAS,SACP,OAAQ,CAAA,OAAA;AAAA,UACN,aAAa,IAAK,CAAA,MAAA,EAAQ,GAAK,EAAA,YAAA,EAAc,QAAQ,IAAI,CAAA;AAAA,UACzD;AAAA;AACF,OACH,CAAA;AAAA,KACH;AAAA,IACA,kBAAkB,IAAM,EAAA;AACtB,MAAA,OAAO,eAAgB,CAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,IAAA,EAAM,IAAK,CAAA,IAAA,IAAQ,OAAQ,CAAA,IAAA;AAAA,QAC3B,QAAA,EAAU,IAAK,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QACnC,QAAA,EAAU,IAAK,CAAA,QAAA,IAAY,OAAQ,CAAA,QAAA;AAAA,QACnC,QAAQ,EAAE,GAAG,KAAK,MAAQ,EAAA,GAAG,QAAQ,MAAO,EAAA;AAAA,QAC5C,MAAA,EAAS,IAAK,CAAA,MAAA,IAAU,OAAQ,CAAA,MAAA;AAAA,QAChC,MACE,EAAA,OAAA,CAAQ,MAAU,IAAA,IAAA,CAAK,MACnB,GAAA;AAAA,UACE,MAAQ,EAAA;AAAA,YACN,GAAG,QAAQ,MAAQ,EAAA,MAAA;AAAA,YACnB,GAAG,KAAK,MAAQ,EAAA;AAAA;AAClB,SAEF,GAAA,KAAA,CAAA;AAAA,QACN,SAAS,CAAO,GAAA,KAAA;AACd,UAAA,MAAM,EAAE,IAAA,EAAM,MAAQ,EAAA,MAAA,EAAQ,MAAS,GAAA,GAAA;AACvC,UAAA,OAAO,IAAK,CAAA,OAAA;AAAA,YACV,CAAC,aAAa,YAAiB,KAAA;AAC7B,cAAO,OAAA,4BAAA;AAAA,gBACL,OAAQ,CAAA,OAAA;AAAA,kBACN,YAAa,CAAA,WAAA,EAAa,GAAK,EAAA,YAAA,EAAc,QAAQ,IAAI,CAAA;AAAA,kBACzD;AAAA,oBACE,IAAA;AAAA,oBACA,IAAA;AAAA,oBACA,MAAA,EAAS,cAAc,MAAU,IAAA,MAAA;AAAA,oBACjC,MAAQ,EAAA,qBAAA;AAAA,sBACN,OAAQ,CAAA,MAAA;AAAA,sBACR,MAAA;AAAA,sBACA,YAAc,EAAA;AAAA;AAChB;AACF,iBACF;AAAA,gBACA,OAAQ,CAAA;AAAA,eACV;AAAA,aACF;AAAA,YACA;AAAA,cACE,IAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA;AAAA,cACA;AAAA;AACF,WACF;AAAA;AACF,OACD,CAAA;AAAA;AACH,GACF;AAoBF;;;;"}

package/dist/wiring/resolveExtensionDefinition.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolveExtensionDefinition.esm.js","sources":["../../src/wiring/resolveExtensionDefinition.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiHolder, AppNode } from '../apis';\nimport {\n  ExtensionAttachToSpec,\n  ExtensionDefinition,\n  ExtensionDefinitionParameters,\n  ResolvedExtensionInputs,\n} from './createExtension';\nimport { PortableSchema } from '../schema';\nimport { ExtensionInput } from './createExtensionInput';\nimport {\n  AnyExtensionDataRef,\n  ExtensionDataValue,\n} from './createExtensionDataRef';\nimport { OpaqueExtensionDefinition } from '@internal/frontend';\n\n/** @public */\nexport interface Extension<TConfig, TConfigInput = TConfig> {\n  $$type: '@backstage/Extension';\n  readonly id: string;\n  readonly attachTo: ExtensionAttachToSpec;\n  readonly disabled: boolean;\n  readonly configSchema?: PortableSchema<TConfig, TConfigInput>;\n}\n\n/** @internal */\nexport type InternalExtension<TConfig, TConfigInput> = Extension<\n  TConfig,\n  TConfigInput\n> &\n  (\n    | {\n        readonly version: 'v1';\n        readonly inputs: {\n          [inputName in string]: {\n            $$type: '@backstage/ExtensionInput';\n            extensionData: {\n              [name in string]: AnyExtensionDataRef;\n            };\n            config: { optional: boolean; singleton: boolean };\n          };\n        };\n        readonly output: {\n          [name in string]: AnyExtensionDataRef;\n        };\n        factory(context: {\n          apis: ApiHolder;\n          node: AppNode;\n          config: TConfig;\n          inputs: {\n            [inputName in string]: unknown;\n          };\n        }): {\n          [inputName in string]: unknown;\n        };\n      }\n    | {\n        readonly version: 'v2';\n        readonly inputs: {\n          [inputName in string]: ExtensionInput<\n            AnyExtensionDataRef,\n            { optional: boolean; singleton: boolean }\n          >;\n        };\n        readonly output: Array<AnyExtensionDataRef>;\n        factory(options: {\n          apis: ApiHolder;\n          node: AppNode;\n          config: TConfig;\n          inputs: ResolvedExtensionInputs<{\n            [inputName in string]: ExtensionInput<\n              AnyExtensionDataRef,\n              { optional: boolean; singleton: boolean }\n            >;\n          }>;\n        }): Iterable<ExtensionDataValue<any, any>>;\n      }\n  );\n\n/** @internal */\nexport function toInternalExtension<TConfig, TConfigInput>(\n  overrides: Extension<TConfig, TConfigInput>,\n): InternalExtension<TConfig, TConfigInput> {\n  const internal = overrides as InternalExtension<TConfig, TConfigInput>;\n  if (internal.$$type !== '@backstage/Extension') {\n    throw new Error(\n      `Invalid extension instance, bad type '${internal.$$type}'`,\n    );\n  }\n  const version = internal.version;\n  if (version !== 'v1' && version !== 'v2') {\n    throw new Error(`Invalid extension instance, bad version '${version}'`);\n  }\n  return internal;\n}\n\n/** @ignore */\nexport type ResolveExtensionId<\n  TExtension extends ExtensionDefinition,\n  TNamespace extends string,\n> = TExtension extends ExtensionDefinition<{\n  kind: infer IKind extends string | undefined;\n  name: infer IName extends string | undefined;\n}>\n  ? [string] extends [IKind | IName]\n    ? never\n    : (\n        undefined extends IName ? TNamespace : `${TNamespace}/${IName}`\n      ) extends infer INamePart extends string\n    ? IKind extends string\n      ? `${IKind}:${INamePart}`\n      : INamePart\n    : never\n  : never;\n\n/** @internal */\nexport function resolveExtensionDefinition<\n  T extends ExtensionDefinitionParameters,\n>(\n  definition: ExtensionDefinition<T>,\n  context?: { namespace?: string },\n): Extension<T['config'], T['configInput']> {\n  const internalDefinition = OpaqueExtensionDefinition.toInternal(definition);\n  const {\n    name,\n    kind,\n    namespace: _skip1,\n    override: _skip2,\n    ...rest\n  } = internalDefinition;\n\n  const namespace = internalDefinition.namespace ?? context?.namespace;\n\n  const namePart =\n    name && namespace ? `${namespace}/${name}` : namespace || name;\n  if (!namePart) {\n    throw new Error(\n      `Extension must declare an explicit namespace or name as it could not be resolved from context, kind=${kind} namespace=${namespace} name=${name}`,\n    );\n  }\n\n  const id = kind ? `${kind}:${namePart}` : namePart;\n\n  return {\n    ...rest,\n    $$type: '@backstage/Extension',\n    version: internalDefinition.version,\n    id,\n    toString() {\n      return `Extension{id=${id}}`;\n    },\n  } as InternalExtension<T['config'], T['configInput']> & Object;\n}\n"],"names":[],"mappings":";;AAmIgB,SAAA,0BAAA,CAGd,YACA,OAC0C,EAAA;AAC1C,EAAM,MAAA,kBAAA,GAAqB,yBAA0B,CAAA,UAAA,CAAW,UAAU,CAAA;AAC1E,EAAM,MAAA;AAAA,IACJ,IAAA;AAAA,IACA,IAAA;AAAA,IACA,SAAW,EAAA,MAAA;AAAA,IACX,QAAU,EAAA,MAAA;AAAA,IACV,GAAG;AAAA,GACD,GAAA,kBAAA;AAEJ,EAAM,MAAA,SAAA,GAAY,kBAAmB,CAAA,SAAA,IAAa,OAAS,EAAA,SAAA;AAE3D,EAAM,MAAA,QAAA,GACJ,QAAQ,SAAY,GAAA,CAAA,EAAG,SAAS,CAAI,CAAA,EAAA,IAAI,KAAK,SAAa,IAAA,IAAA;AAC5D,EAAA,IAAI,CAAC,QAAU,EAAA;AACb,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAuG,oGAAA,EAAA,IAAI,CAAc,WAAA,EAAA,SAAS,SAAS,IAAI,CAAA;AAAA,KACjJ;AAAA;AAGF,EAAA,MAAM,KAAK,IAAO,GAAA,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,QAAQ,CAAK,CAAA,GAAA,QAAA;AAE1C,EAAO,OAAA;AAAA,IACL,GAAG,IAAA;AAAA,IACH,MAAQ,EAAA,sBAAA;AAAA,IACR,SAAS,kBAAmB,CAAA,OAAA;AAAA,IAC5B,EAAA;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,gBAAgB,EAAE,CAAA,CAAA,CAAA;AAAA;AAC3B,GACF;AACF;;;;"}
+{"version":3,"file":"resolveExtensionDefinition.esm.js","sources":["../../src/wiring/resolveExtensionDefinition.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiHolder, AppNode } from '../apis';\nimport {\n  ExtensionAttachToSpec,\n  ExtensionDefinition,\n  ExtensionDefinitionParameters,\n  ResolvedExtensionInputs,\n} from './createExtension';\nimport { PortableSchema } from '../schema';\nimport { ExtensionInput } from './createExtensionInput';\nimport {\n  AnyExtensionDataRef,\n  ExtensionDataValue,\n} from './createExtensionDataRef';\nimport { OpaqueExtensionDefinition } from '@internal/frontend';\n\n/** @public */\nexport interface Extension<TConfig, TConfigInput = TConfig> {\n  $$type: '@backstage/Extension';\n  readonly id: string;\n  readonly attachTo: ExtensionAttachToSpec;\n  readonly disabled: boolean;\n  readonly configSchema?: PortableSchema<TConfig, TConfigInput>;\n}\n\n/** @internal */\nexport type InternalExtension<TConfig, TConfigInput> = Extension<\n  TConfig,\n  TConfigInput\n> &\n  (\n    | {\n        readonly version: 'v1';\n        readonly inputs: {\n          [inputName in string]: {\n            $$type: '@backstage/ExtensionInput';\n            extensionData: {\n              [name in string]: AnyExtensionDataRef;\n            };\n            config: { optional: boolean; singleton: boolean };\n          };\n        };\n        readonly output: {\n          [name in string]: AnyExtensionDataRef;\n        };\n        factory(context: {\n          apis: ApiHolder;\n          node: AppNode;\n          config: TConfig;\n          inputs: {\n            [inputName in string]: unknown;\n          };\n        }): {\n          [inputName in string]: unknown;\n        };\n      }\n    | {\n        readonly version: 'v2';\n        readonly inputs: {\n          [inputName in string]: ExtensionInput<\n            AnyExtensionDataRef,\n            { optional: boolean; singleton: boolean }\n          >;\n        };\n        readonly output: Array<AnyExtensionDataRef>;\n        factory(options: {\n          apis: ApiHolder;\n          node: AppNode;\n          config: TConfig;\n          inputs: ResolvedExtensionInputs<{\n            [inputName in string]: ExtensionInput<\n              AnyExtensionDataRef,\n              { optional: boolean; singleton: boolean }\n            >;\n          }>;\n        }): Iterable<ExtensionDataValue<any, any>>;\n      }\n  );\n\n/** @internal */\nexport function toInternalExtension<TConfig, TConfigInput>(\n  overrides: Extension<TConfig, TConfigInput>,\n): InternalExtension<TConfig, TConfigInput> {\n  const internal = overrides as InternalExtension<TConfig, TConfigInput>;\n  if (internal.$$type !== '@backstage/Extension') {\n    throw new Error(\n      `Invalid extension instance, bad type '${internal.$$type}'`,\n    );\n  }\n  const version = internal.version;\n  if (version !== 'v1' && version !== 'v2') {\n    throw new Error(`Invalid extension instance, bad version '${version}'`);\n  }\n  return internal;\n}\n\n/** @ignore */\nexport type ResolveExtensionId<\n  TExtension extends ExtensionDefinition,\n  TNamespace extends string,\n> = TExtension extends ExtensionDefinition<{\n  kind: infer IKind extends string | undefined;\n  name: infer IName extends string | undefined;\n  params: any;\n}>\n  ? [string] extends [IKind | IName]\n    ? never\n    : (\n        undefined extends IName ? TNamespace : `${TNamespace}/${IName}`\n      ) extends infer INamePart extends string\n    ? IKind extends string\n      ? `${IKind}:${INamePart}`\n      : INamePart\n    : never\n  : never;\n\n/** @internal */\nexport function resolveExtensionDefinition<\n  T extends ExtensionDefinitionParameters,\n>(\n  definition: ExtensionDefinition<T>,\n  context?: { namespace?: string },\n): Extension<T['config'], T['configInput']> {\n  const internalDefinition = OpaqueExtensionDefinition.toInternal(definition);\n  const {\n    name,\n    kind,\n    namespace: _skip1,\n    override: _skip2,\n    ...rest\n  } = internalDefinition;\n\n  const namespace = internalDefinition.namespace ?? context?.namespace;\n\n  const namePart =\n    name && namespace ? `${namespace}/${name}` : namespace || name;\n  if (!namePart) {\n    throw new Error(\n      `Extension must declare an explicit namespace or name as it could not be resolved from context, kind=${kind} namespace=${namespace} name=${name}`,\n    );\n  }\n\n  const id = kind ? `${kind}:${namePart}` : namePart;\n\n  return {\n    ...rest,\n    $$type: '@backstage/Extension',\n    version: internalDefinition.version,\n    id,\n    toString() {\n      return `Extension{id=${id}}`;\n    },\n  } as InternalExtension<T['config'], T['configInput']> & Object;\n}\n"],"names":[],"mappings":";;AAoIgB,SAAA,0BAAA,CAGd,YACA,OAC0C,EAAA;AAC1C,EAAM,MAAA,kBAAA,GAAqB,yBAA0B,CAAA,UAAA,CAAW,UAAU,CAAA;AAC1E,EAAM,MAAA;AAAA,IACJ,IAAA;AAAA,IACA,IAAA;AAAA,IACA,SAAW,EAAA,MAAA;AAAA,IACX,QAAU,EAAA,MAAA;AAAA,IACV,GAAG;AAAA,GACD,GAAA,kBAAA;AAEJ,EAAM,MAAA,SAAA,GAAY,kBAAmB,CAAA,SAAA,IAAa,OAAS,EAAA,SAAA;AAE3D,EAAM,MAAA,QAAA,GACJ,QAAQ,SAAY,GAAA,CAAA,EAAG,SAAS,CAAI,CAAA,EAAA,IAAI,KAAK,SAAa,IAAA,IAAA;AAC5D,EAAA,IAAI,CAAC,QAAU,EAAA;AACb,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAuG,oGAAA,EAAA,IAAI,CAAc,WAAA,EAAA,SAAS,SAAS,IAAI,CAAA;AAAA,KACjJ;AAAA;AAGF,EAAA,MAAM,KAAK,IAAO,GAAA,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,QAAQ,CAAK,CAAA,GAAA,QAAA;AAE1C,EAAO,OAAA;AAAA,IACL,GAAG,IAAA;AAAA,IACH,MAAQ,EAAA,sBAAA;AAAA,IACR,SAAS,kBAAmB,CAAA,OAAA;AAAA,IAC5B,EAAA;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,gBAAgB,EAAE,CAAA,CAAA,CAAA;AAAA;AAC3B,GACF;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/frontend-plugin-api",
-  "version": "0.10.4-next.1",
+  "version": "0.11.0-next.0",
   "backstage": {
     "role": "web-library"
   },
@@ -31,8 +31,8 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-components": "0.17.4-next.1",
-    "@backstage/core-plugin-api": "1.10.9-next.0",
+    "@backstage/core-components": "0.17.5-next.0",
+    "@backstage/core-plugin-api": "1.10.9",
     "@backstage/types": "1.2.1",
     "@backstage/version-bridge": "1.0.11",
     "@material-ui/core": "^4.12.4",
@@ -41,10 +41,10 @@
     "zod-to-json-schema": "^3.21.4"
   },
   "devDependencies": {
-    "@backstage/cli": "0.33.1-next.1",
-    "@backstage/frontend-app-api": "0.11.4-next.1",
-    "@backstage/frontend-test-utils": "0.3.4-next.1",
-    "@backstage/test-utils": "1.7.10-next.1",
+    "@backstage/cli": "0.33.2-next.0",
+    "@backstage/frontend-app-api": "0.11.5-next.1",
+    "@backstage/frontend-test-utils": "0.3.5-next.1",
+    "@backstage/test-utils": "1.7.11-next.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
     "@types/react": "^18.0.0",

package/dist/blueprints/NavLogoBlueprint.esm.js

@@ -1,27 +0,0 @@
-import '../wiring/coreExtensionData.esm.js';
-import 'zod';
-import 'zod-to-json-schema';
-import { createExtensionDataRef } from '../wiring/createExtensionDataRef.esm.js';
-import { createExtensionBlueprint } from '../wiring/createExtensionBlueprint.esm.js';
-
-const logoElementsDataRef = createExtensionDataRef().with({ id: "core.nav-logo.logo-elements" });
-const NavLogoBlueprint = createExtensionBlueprint({
-  kind: "nav-logo",
-  attachTo: { id: "app/nav", input: "logos" },
-  output: [logoElementsDataRef],
-  dataRefs: {
-    logoElements: logoElementsDataRef
-  },
-  *factory({
-    logoIcon,
-    logoFull
-  }) {
-    yield logoElementsDataRef({
-      logoIcon,
-      logoFull
-    });
-  }
-});
-
-export { NavLogoBlueprint };
-//# sourceMappingURL=NavLogoBlueprint.esm.js.map

package/dist/blueprints/NavLogoBlueprint.esm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"NavLogoBlueprint.esm.js","sources":["../../src/blueprints/NavLogoBlueprint.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createExtensionBlueprint, createExtensionDataRef } from '../wiring';\n\nconst logoElementsDataRef = createExtensionDataRef<{\n  logoIcon?: JSX.Element;\n  logoFull?: JSX.Element;\n}>().with({ id: 'core.nav-logo.logo-elements' });\n\n/**\n * Creates an extension that replaces the logo in the nav bar with your own.\n *\n * @public\n */\nexport const NavLogoBlueprint = createExtensionBlueprint({\n  kind: 'nav-logo',\n  attachTo: { id: 'app/nav', input: 'logos' },\n  output: [logoElementsDataRef],\n  dataRefs: {\n    logoElements: logoElementsDataRef,\n  },\n  *factory({\n    logoIcon,\n    logoFull,\n  }: {\n    logoIcon: JSX.Element;\n    logoFull: JSX.Element;\n  }) {\n    yield logoElementsDataRef({\n      logoIcon,\n      logoFull,\n    });\n  },\n});\n"],"names":[],"mappings":";;;;;;AAkBA,MAAM,sBAAsB,sBAGzB,EAAA,CAAE,KAAK,EAAE,EAAA,EAAI,+BAA+B,CAAA;AAOxC,MAAM,mBAAmB,wBAAyB,CAAA;AAAA,EACvD,IAAM,EAAA,UAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,SAAA,EAAW,OAAO,OAAQ,EAAA;AAAA,EAC1C,MAAA,EAAQ,CAAC,mBAAmB,CAAA;AAAA,EAC5B,QAAU,EAAA;AAAA,IACR,YAAc,EAAA;AAAA,GAChB;AAAA,EACA,CAAC,OAAQ,CAAA;AAAA,IACP,QAAA;AAAA,IACA;AAAA,GAIC,EAAA;AACD,IAAA,MAAM,mBAAoB,CAAA;AAAA,MACxB,QAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}