@backstage/frontend-plugin-api 0.16.0-next.2 → 0.16.0

package/dist/wiring/createExtensionBlueprint.esm.js

@@ -1,5 +1,7 @@
 import { createExtension, ctxParamsSymbol } from './createExtension.esm.js';
 import { resolveInputOverrides } from './resolveInputOverrides.esm.js';
+import { warnConfigSchemaPropDeprecation } from '../schema/createPortableSchema.esm.js';
+import { describeParentCallSite } from '../routing/describeParentCallSite.esm.js';
 import { OpaqueType } from '../opaque-internal/src/OpaqueType.esm.js';
 import { createExtensionDataContainer } from '../frontend-internal/src/wiring/createExtensionDataContainer.esm.js';
 import '../frontend-internal/src/wiring/InternalExtensionDefinition.esm.js';
@@ -71,6 +73,7 @@ function createExtensionBlueprint(options) {
         inputs: options.inputs,
         output: options.output,
         config: options.config,
+        configSchema: options.configSchema,
         factory: (ctx) => options.factory(
           unwrapParams(args.params, ctx, defineParams, options.kind),
           ctx
@@ -78,6 +81,9 @@ function createExtensionBlueprint(options) {
       });
     },
     makeWithOverrides(args) {
+      if (args.config?.schema) {
+        warnConfigSchemaPropDeprecation(describeParentCallSite());
+      }
       return createExtension({
         kind: options.kind,
         name: args.name,
@@ -86,12 +92,16 @@ function createExtensionBlueprint(options) {
         if: args.if ?? options.if,
         inputs: { ...args.inputs, ...options.inputs },
         output: args.output ?? options.output,
-        config: options.config || args.config ? {
+        config: options.config?.schema || args.config?.schema ? {
           schema: {
             ...options.config?.schema,
             ...args.config?.schema
           }
         } : void 0,
+        configSchema: options.configSchema || args.configSchema ? {
+          ...options.configSchema,
+          ...args.configSchema
+        } : void 0,
         factory: (ctx) => {
           const { node, config, inputs, apis } = ctx;
           return args.factory(

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 { OpaqueType } from '@internal/opaque';\nimport {\n  ExtensionDefinitionAttachTo,\n  OverridableExtensionDefinition,\n  ResolvedExtensionInputs,\n  VerifyExtensionFactoryOutput,\n  createExtension,\n  ctxParamsSymbol,\n  VerifyExtensionAttachTo,\n} from './createExtension';\nimport type { z } from 'zod/v3';\nimport { ExtensionInput } from './createExtensionInput';\nimport { ExtensionDataRef, ExtensionDataValue } from './createExtensionDataRef';\nimport { createExtensionDataContainer } from '@internal/frontend';\nimport {\n  ResolvedInputValueOverrides,\n  resolveInputOverrides,\n} from './resolveInputOverrides';\nimport { ExtensionDataContainer } from './types';\nimport { PageBlueprint } from '../blueprints/PageBlueprint';\nimport { FilterPredicate } from '@backstage/filter-predicates';\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 ExtensionBlueprintDefineParams<\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  TParams extends object | ExtensionBlueprintDefineParams,\n  UOutput extends ExtensionDataRef,\n  TInputs extends { [inputName in string]: ExtensionInput },\n  TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  TDataRefs extends { [name in string]: ExtensionDataRef },\n  UParentInputs extends ExtensionDataRef,\n> = {\n  kind: TKind;\n  attachTo: ExtensionDefinitionAttachTo<UParentInputs> &\n    VerifyExtensionAttachTo<UOutput, UParentInputs>;\n  disabled?: boolean;\n  if?: FilterPredicate;\n  inputs?: TInputs;\n  output: Array<UOutput>;\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: defineParams => defineParams({\n   *     component: ...,\n   *     fetcher: ...,\n   *   }),\n   * });\n   * ```\n   */\n  defineParams?: TParams extends ExtensionBlueprintDefineParams\n    ? TParams\n    : 'The defineParams option must be a function if provided, see the docs for details';\n  factory(\n    params: TParams extends ExtensionBlueprintDefineParams\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  params?: object | ExtensionBlueprintDefineParams;\n  configInput?: { [K in string]: any };\n  config?: { [K in string]: any };\n  output?: ExtensionDataRef;\n  inputs?: { [KName in string]: ExtensionInput };\n  dataRefs?: { [name in string]: ExtensionDataRef };\n};\n\n/** @ignore */\ntype ParamsFactory<TDefiner extends ExtensionBlueprintDefineParams> = (\n  defineParams: 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 | ExtensionBlueprintDefineParams> =\n  TParams extends ExtensionBlueprintDefineParams<infer IParams>\n    ? IParams | ParamsFactory<TParams>\n    : TParams | ParamsFactory<ExtensionBlueprintDefineParams<TParams, TParams>>;\n\n/**\n * @public\n */\nexport interface ExtensionBlueprint<\n  T extends ExtensionBlueprintParameters = ExtensionBlueprintParameters,\n> {\n  dataRefs: T['dataRefs'];\n\n  make<\n    TName extends string | undefined,\n    TParamsInput extends AnyParamsInput<NonNullable<T['params']>>,\n    UParentInputs extends ExtensionDataRef,\n  >(args: {\n    name?: TName;\n    attachTo?: ExtensionDefinitionAttachTo<UParentInputs> &\n      VerifyExtensionAttachTo<NonNullable<T['output']>, UParentInputs>;\n    disabled?: boolean;\n    if?: FilterPredicate;\n    params: TParamsInput extends ExtensionBlueprintDefineParams\n      ? TParamsInput\n      : T['params'] extends ExtensionBlueprintDefineParams\n      ? '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>) })`'\n      : T['params'];\n  }): OverridableExtensionDefinition<{\n    kind: T['kind'];\n    name: string | undefined extends TName ? undefined : TName;\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    TName 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 ExtensionDataRef,\n    UParentInputs extends ExtensionDataRef,\n    TExtraInputs extends { [inputName in string]: ExtensionInput } = {},\n  >(args: {\n    name?: TName;\n    attachTo?: ExtensionDefinitionAttachTo<UParentInputs> &\n      VerifyExtensionAttachTo<\n        ExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UParentInputs\n      >;\n    disabled?: boolean;\n    if?: FilterPredicate;\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 ExtensionBlueprintDefineParams\n          ? TParamsInput\n          : T['params'] extends ExtensionBlueprintDefineParams\n          ? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(defineParams => defineParams(<params>))`'\n          : T['params'],\n        context?: {\n          config?: T['config'];\n          inputs?: ResolvedInputValueOverrides<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        ExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UFactoryOutput\n      >;\n  }): OverridableExtensionDefinition<{\n    config: Expand<\n      (string extends keyof TExtensionConfigSchema\n        ? {}\n        : {\n            [key in keyof TExtensionConfigSchema]: z.infer<\n              ReturnType<TExtensionConfigSchema[key]>\n            >;\n          }) &\n        T['config']\n    >;\n    configInput: Expand<\n      (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    >;\n    output: ExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: Expand<T['inputs'] & TExtraInputs>;\n    kind: T['kind'];\n    name: string | undefined extends TName ? undefined : TName;\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<ExtensionBlueprintDefineParams> | Function,\n  defineParams: ExtensionBlueprintDefineParams,\n  kind: string,\n): TParams {\n  const paramDefinition = (\n    params as ParamsFactory<ExtensionBlueprintDefineParams>\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<ExtensionBlueprintDefineParams> | string,\n  ctx: { node: AppNode; [ctxParamsSymbol]?: any },\n  defineParams: ExtensionBlueprintDefineParams | undefined,\n  kind: string,\n): TParams {\n  const overrideParams = ctx[ctxParamsSymbol] as\n    | object\n    | ParamsFactory<ExtensionBlueprintDefineParams>\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 * Creates a new extension blueprint that encapsulates the creation of\n * extensions of particular kinds.\n *\n * @remarks\n *\n * For details on how blueprints work, see the\n * {@link https://backstage.io/docs/frontend-system/architecture/extension-blueprints | documentation for extension blueprints}\n * in the frontend system documentation.\n *\n * Extension blueprints make it much easier for users to create new extensions\n * for your plugin. Rather than letting them use {@link createExtension}\n * directly, you can define a set of parameters and default factory for your\n * blueprint, removing a lot of the boilerplate and complexity that is otherwise\n * needed to create an extension.\n *\n * Each blueprint has its own `kind` that helps identify and group the\n * extensions that have been created with it. For example the\n * {@link PageBlueprint} has the kind `'page'`, and extensions created with it\n * will be given the ID `'page:<plugin-id>[/<name>]'`. Blueprints should always\n * be exported as `<PascalCaseKind>Blueprint`.\n *\n * When creating a blueprint the type of the parameters are inferred from the\n * `factory` function that you provide. The exception to that is when you need\n * your blueprint to include inferred type parameters, in which case you need to\n * use the `defineParams` option. See the documentation for the `defineParams`\n * option for more details on how that works.\n *\n * @example\n * ```tsx\n * // In your plugin library\n * export const GreetingBlueprint = createExtensionBlueprint({\n *   kind: 'greeting',\n *   attachTo: { id: 'example', input: 'greetings' },\n *   output: [coreExtensionData.reactElement],\n *   factory(params: { greeting: string }) {\n *     return [coreExtensionData.reactElement(<h1>{params.greeting}</h1>)];\n *   },\n * });\n *\n * // Someone using your blueprint in their plugin\n * const exampleGreeting = GreetingBlueprint.make({\n *   params: {\n *     greeting: 'Hello, world!',\n *   },\n * });\n * ```\n * @public\n */\nexport function createExtensionBlueprint<\n  TParams extends object | ExtensionBlueprintDefineParams,\n  UOutput extends ExtensionDataRef,\n  TInputs extends { [inputName in string]: ExtensionInput },\n  TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  TKind extends string,\n  UParentInputs extends ExtensionDataRef,\n  TDataRefs extends { [name in string]: ExtensionDataRef } = never,\n>(\n  options: CreateExtensionBlueprintOptions<\n    TKind,\n    TParams,\n    UOutput,\n    TInputs,\n    TConfigSchema,\n    UFactoryOutput,\n    TDataRefs,\n    UParentInputs\n  >,\n): ExtensionBlueprint<{\n  kind: TKind;\n  params: TParams;\n  // This inference and remapping back to ExtensionDataRef eliminates any occurrences ConfigurationExtensionDataRef\n  output: UOutput extends ExtensionDataRef<\n    infer IData,\n    infer IId,\n    infer IConfig\n  >\n    ? ExtensionDataRef<IData, IId, IConfig>\n    : never;\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    | ExtensionBlueprintDefineParams\n    | undefined;\n\n  return {\n    dataRefs: options.dataRefs,\n    make(args) {\n      return createExtension({\n        kind: options.kind,\n        name: args.name,\n        attachTo: (args.attachTo ??\n          options.attachTo) as ExtensionDefinitionAttachTo,\n        disabled: args.disabled ?? options.disabled,\n        if: args.if ?? options.if,\n        inputs: options.inputs,\n        output: options.output as ExtensionDataRef[],\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 OverridableExtensionDefinition;\n    },\n    makeWithOverrides(args) {\n      return createExtension({\n        kind: options.kind,\n        name: args.name,\n        attachTo: (args.attachTo ??\n          options.attachTo) as ExtensionDefinitionAttachTo,\n        disabled: args.disabled ?? options.disabled,\n        if: args.if ?? options.if,\n        inputs: { ...args.inputs, ...options.inputs },\n        output: (args.output ?? options.output) as ExtensionDataRef[],\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<\n                UOutput extends ExtensionDataRef<\n                  infer IData,\n                  infer IId,\n                  infer IConfig\n                >\n                  ? ExtensionDataRef<IData, IId, IConfig>\n                  : never\n              >(\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                'original blueprint factory',\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 OverridableExtensionDefinition;\n    },\n  } as ExtensionBlueprint<{\n    kind: TKind;\n    params: TParams;\n    output: any;\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,MAAA,CAMtC;AAAA,EACD,IAAA,EAAM,4BAAA;AAAA,EACN,QAAA,EAAU,CAAC,IAAI;AACjB,CAAC,CAAA;AAWM,SAAS,+BACd,MAAA,EAC6B;AAC7B,EAAA,OAAO,sBAAsB,cAAA,CAAe,IAAA,EAAM,EAAE,CAAA,EAAG,IAAA,EAAa,QAAQ,CAAA;AAC9E;AAkPA,SAAS,mBAAA,CAEP,MAAA,EACA,YAAA,EACA,IAAA,EACS;AACT,EAAA,MAAM,eAAA,GACJ,OACA,YAAY,CAAA;AACd,EAAA,IAAI;AACF,IAAA,OAAO,qBAAA,CAAsB,UAAA,CAAW,eAAe,CAAA,CAAE,MAAA;AAAA,EAC3D,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAAA,2CAAA,EAA8C,IAAI,CAAA,6GAAA,EAAgH,CAAA,CAAE,OAAO,CAAA;AAAA,KAC7K;AAAA,EACF;AACF;AAEA,SAAS,YAAA,CACP,MAAA,EACA,GAAA,EACA,YAAA,EACA,IAAA,EACS;AACT,EAAA,MAAM,cAAA,GAAiB,IAAI,eAAe,CAAA;AAK1C,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,IAAI,cAAA,EAAgB;AAClB,MAAA,IAAI,OAAO,mBAAmB,UAAA,EAAY;AACxC,QAAA,MAAM,IAAI,SAAA;AAAA,UACR,sDAAsD,IAAI,CAAA,oHAAA;AAAA,SAC5D;AAAA,MACF;AACA,MAAA,OAAO,mBAAA,CAAoB,cAAA,EAAgB,YAAA,EAAc,IAAI,CAAA;AAAA,IAC/D;AAEA,IAAA,IAAI,OAAO,WAAW,UAAA,EAAY;AAChC,MAAA,MAAM,IAAI,SAAA;AAAA,QACR,8CAA8C,IAAI,CAAA,gHAAA;AAAA,OACpD;AAAA,IACF;AACA,IAAA,OAAO,mBAAA,CAAoB,MAAA,EAAQ,YAAA,EAAc,IAAI,CAAA;AAAA,EACvD;AAEA,EAAA,MAAM,IAAA,GACJ,OAAO,MAAA,KAAW,UAAA,GACd,mBAAA;AAAA,IACE,MAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA,GACF,GACC,MAAA;AACP,EAAA,MAAM,SAAA,GACJ,OAAO,cAAA,KAAmB,UAAA,GACtB,mBAAA;AAAA,IACE,cAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA,GACF,GACC,cAAA;AAEP,EAAA,OAAO;AAAA,IACL,GAAG,IAAA;AAAA,IACH,GAAG;AAAA,GACL;AACF;AAmDO,SAAS,yBAUd,OAAA,EAiCC;AACD,EAAA,MAAM,eAAe,OAAA,CAAQ,YAAA;AAI7B,EAAA,OAAO;AAAA,IACL,UAAU,OAAA,CAAQ,QAAA;AAAA,IAClB,KAAK,IAAA,EAAM;AACT,MAAA,OAAO,eAAA,CAAgB;AAAA,QACrB,MAAM,OAAA,CAAQ,IAAA;AAAA,QACd,MAAM,IAAA,CAAK,IAAA;AAAA,QACX,QAAA,EAAW,IAAA,CAAK,QAAA,IACd,OAAA,CAAQ,QAAA;AAAA,QACV,QAAA,EAAU,IAAA,CAAK,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QACnC,EAAA,EAAI,IAAA,CAAK,EAAA,IAAM,OAAA,CAAQ,EAAA;AAAA,QACvB,QAAQ,OAAA,CAAQ,MAAA;AAAA,QAChB,QAAQ,OAAA,CAAQ,MAAA;AAAA,QAChB,QAAQ,OAAA,CAAQ,MAAA;AAAA,QAChB,OAAA,EAAS,SACP,OAAA,CAAQ,OAAA;AAAA,UACN,aAAa,IAAA,CAAK,MAAA,EAAQ,GAAA,EAAK,YAAA,EAAc,QAAQ,IAAI,CAAA;AAAA,UACzD;AAAA;AACF,OACH,CAAA;AAAA,IACH,CAAA;AAAA,IACA,kBAAkB,IAAA,EAAM;AACtB,MAAA,OAAO,eAAA,CAAgB;AAAA,QACrB,MAAM,OAAA,CAAQ,IAAA;AAAA,QACd,MAAM,IAAA,CAAK,IAAA;AAAA,QACX,QAAA,EAAW,IAAA,CAAK,QAAA,IACd,OAAA,CAAQ,QAAA;AAAA,QACV,QAAA,EAAU,IAAA,CAAK,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QACnC,EAAA,EAAI,IAAA,CAAK,EAAA,IAAM,OAAA,CAAQ,EAAA;AAAA,QACvB,QAAQ,EAAE,GAAG,KAAK,MAAA,EAAQ,GAAG,QAAQ,MAAA,EAAO;AAAA,QAC5C,MAAA,EAAS,IAAA,CAAK,MAAA,IAAU,OAAA,CAAQ,MAAA;AAAA,QAChC,MAAA,EACE,OAAA,CAAQ,MAAA,IAAU,IAAA,CAAK,MAAA,GACnB;AAAA,UACE,MAAA,EAAQ;AAAA,YACN,GAAG,QAAQ,MAAA,EAAQ,MAAA;AAAA,YACnB,GAAG,KAAK,MAAA,EAAQ;AAAA;AAClB,SACF,GACA,MAAA;AAAA,QACN,SAAS,CAAA,GAAA,KAAO;AACd,UAAA,MAAM,EAAE,IAAA,EAAM,MAAA,EAAQ,MAAA,EAAQ,MAAK,GAAI,GAAA;AACvC,UAAA,OAAO,IAAA,CAAK,OAAA;AAAA,YACV,CAAC,aAAa,YAAA,KAAiB;AAC7B,cAAA,OAAO,4BAAA;AAAA,gBASL,OAAA,CAAQ,OAAA;AAAA,kBACN,YAAA,CAAa,WAAA,EAAa,GAAA,EAAK,YAAA,EAAc,QAAQ,IAAI,CAAA;AAAA,kBACzD;AAAA,oBACE,IAAA;AAAA,oBACA,IAAA;AAAA,oBACA,MAAA,EAAS,cAAc,MAAA,IAAU,MAAA;AAAA,oBACjC,MAAA,EAAQ,qBAAA;AAAA,sBACN,OAAA,CAAQ,MAAA;AAAA,sBACR,MAAA;AAAA,sBACA,YAAA,EAAc;AAAA;AAChB;AACF,iBACF;AAAA,gBACA,4BAAA;AAAA,gBACA,OAAA,CAAQ;AAAA,eACV;AAAA,YACF,CAAA;AAAA,YACA;AAAA,cACE,IAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA;AAAA,cACA;AAAA;AACF,WACF;AAAA,QACF;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACF;AAmBF;;;;"}
+{"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  ExtensionDefinitionAttachTo,\n  OverridableExtensionDefinition,\n  ResolvedExtensionInputs,\n  VerifyExtensionFactoryOutput,\n  createExtension,\n  ctxParamsSymbol,\n  VerifyExtensionAttachTo,\n} from './createExtension';\nimport type { z } from 'zod/v3';\nimport { ExtensionInput } from './createExtensionInput';\nimport { type StandardSchemaV1 } from '@standard-schema/spec';\nimport { ExtensionDataRef, ExtensionDataValue } from './createExtensionDataRef';\nimport { createExtensionDataContainer } from '@internal/frontend';\nimport {\n  ResolvedInputValueOverrides,\n  resolveInputOverrides,\n} from './resolveInputOverrides';\nimport { ExtensionDataContainer } from './types';\nimport { PageBlueprint } from '../blueprints/PageBlueprint';\nimport { FilterPredicate } from '@backstage/filter-predicates';\nimport { warnConfigSchemaPropDeprecation } from '../schema/createPortableSchema';\nimport { describeParentCallSite } from '../routing/describeParentCallSite';\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 ExtensionBlueprintDefineParams<\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  TParams extends object | ExtensionBlueprintDefineParams,\n  UOutput extends ExtensionDataRef,\n  TInputs extends { [inputName in string]: ExtensionInput },\n  TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  TDataRefs extends { [name in string]: ExtensionDataRef },\n  UParentInputs extends ExtensionDataRef,\n  TNewConfigSchema extends { [key in string]: StandardSchemaV1 } = {},\n> = {\n  kind: TKind;\n  attachTo: ExtensionDefinitionAttachTo<UParentInputs> &\n    VerifyExtensionAttachTo<UOutput, UParentInputs>;\n  disabled?: boolean;\n  if?: FilterPredicate;\n  inputs?: TInputs;\n  output: Array<UOutput>;\n  configSchema?: TNewConfigSchema;\n  /**\n   * @deprecated Use {@link CreateExtensionBlueprintOptions.configSchema} instead.\n   */\n  config?: {\n    /**\n     * @deprecated Use {@link CreateExtensionBlueprintOptions.configSchema} instead.\n     */\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: defineParams => defineParams({\n   *     component: ...,\n   *     fetcher: ...,\n   *   }),\n   * });\n   * ```\n   */\n  defineParams?: TParams extends ExtensionBlueprintDefineParams\n    ? TParams\n    : 'The defineParams option must be a function if provided, see the docs for details';\n  factory(\n    params: TParams extends ExtensionBlueprintDefineParams\n      ? ReturnType<TParams>['T']\n      : TParams,\n    context: {\n      node: AppNode;\n      apis: ApiHolder;\n      config: {\n        [key in keyof TNewConfigSchema]: StandardSchemaV1.InferOutput<\n          TNewConfigSchema[key]\n        >;\n      } & {\n        [key in keyof TConfigSchema]: z.infer<\n          ReturnType<((...args: any[]) => any) & TConfigSchema[key]>\n        >;\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  params?: object | ExtensionBlueprintDefineParams;\n  configInput?: { [K in string]: any };\n  config?: { [K in string]: any };\n  output?: ExtensionDataRef;\n  inputs?: { [KName in string]: ExtensionInput };\n  dataRefs?: { [name in string]: ExtensionDataRef };\n};\n\n/** @ignore */\ntype ParamsFactory<TDefiner extends ExtensionBlueprintDefineParams> = (\n  defineParams: 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 | ExtensionBlueprintDefineParams> =\n  TParams extends ExtensionBlueprintDefineParams<infer IParams>\n    ? IParams | ParamsFactory<TParams>\n    : TParams | ParamsFactory<ExtensionBlueprintDefineParams<TParams, TParams>>;\n\n/**\n * @public\n */\nexport interface ExtensionBlueprint<\n  T extends ExtensionBlueprintParameters = ExtensionBlueprintParameters,\n> {\n  dataRefs: T['dataRefs'];\n\n  make<\n    TName extends string | undefined,\n    TParamsInput extends AnyParamsInput<NonNullable<T['params']>>,\n    UParentInputs extends ExtensionDataRef,\n  >(args: {\n    name?: TName;\n    attachTo?: ExtensionDefinitionAttachTo<UParentInputs> &\n      VerifyExtensionAttachTo<NonNullable<T['output']>, UParentInputs>;\n    disabled?: boolean;\n    if?: FilterPredicate;\n    params: TParamsInput extends ExtensionBlueprintDefineParams\n      ? TParamsInput\n      : T['params'] extends ExtensionBlueprintDefineParams\n      ? '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>) })`'\n      : T['params'];\n  }): OverridableExtensionDefinition<{\n    kind: T['kind'];\n    name: string | undefined extends TName ? undefined : TName;\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    TName extends string | undefined,\n    UFactoryOutput extends ExtensionDataValue<any, any>,\n    UNewOutput extends ExtensionDataRef,\n    UParentInputs extends ExtensionDataRef,\n    TExtraInputs extends { [inputName in string]: ExtensionInput } = {},\n    TNewExtensionConfigSchema extends {\n      [key in string]: StandardSchemaV1;\n    } = {},\n  >(args: {\n    name?: TName;\n    attachTo?: ExtensionDefinitionAttachTo<UParentInputs> &\n      VerifyExtensionAttachTo<\n        ExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UParentInputs\n      >;\n    disabled?: boolean;\n    if?: FilterPredicate;\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?: never;\n    configSchema?: TNewExtensionConfigSchema & {\n      [KName in keyof T['config']]?: `Error: Config key '${KName &\n        string}' is already defined in parent schema`;\n    };\n    factory(\n      originalFactory: <\n        TParamsInput extends AnyParamsInput<NonNullable<T['params']>>,\n      >(\n        params: TParamsInput extends ExtensionBlueprintDefineParams\n          ? TParamsInput\n          : T['params'] extends ExtensionBlueprintDefineParams\n          ? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(defineParams => defineParams(<params>))`'\n          : T['params'],\n        context?: {\n          config?: T['config'];\n          inputs?: ResolvedInputValueOverrides<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 TNewExtensionConfigSchema]: StandardSchemaV1.InferOutput<\n            TNewExtensionConfigSchema[key]\n          >;\n        };\n        inputs: Expand<ResolvedExtensionInputs<T['inputs'] & TExtraInputs>>;\n      },\n    ): Iterable<UFactoryOutput> &\n      VerifyExtensionFactoryOutput<\n        ExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UFactoryOutput\n      >;\n  }): OverridableExtensionDefinition<{\n    config: Expand<\n      {\n        [key in keyof TNewExtensionConfigSchema]: StandardSchemaV1.InferOutput<\n          TNewExtensionConfigSchema[key]\n        >;\n      } & T['config']\n    >;\n    configInput: Expand<\n      {\n        [key in keyof TNewExtensionConfigSchema]?: StandardSchemaV1.InferInput<\n          TNewExtensionConfigSchema[key]\n        >;\n      } & T['configInput']\n    >;\n    output: ExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: Expand<T['inputs'] & TExtraInputs>;\n    kind: T['kind'];\n    name: string | undefined extends TName ? undefined : TName;\n    params: T['params'];\n  }>;\n\n  /**\n   * @deprecated Use the `configSchema` option instead of `config.schema`.\n   */\n  makeWithOverrides<\n    TName 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 ExtensionDataRef,\n    UParentInputs extends ExtensionDataRef,\n    TExtraInputs extends { [inputName in string]: ExtensionInput } = {},\n  >(args: {\n    name?: TName;\n    attachTo?: ExtensionDefinitionAttachTo<UParentInputs> &\n      VerifyExtensionAttachTo<\n        ExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UParentInputs\n      >;\n    disabled?: boolean;\n    if?: FilterPredicate;\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    configSchema?: never;\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 ExtensionBlueprintDefineParams\n          ? TParamsInput\n          : T['params'] extends ExtensionBlueprintDefineParams\n          ? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `originalFactory(defineParams => defineParams(<params>))`'\n          : T['params'],\n        context?: {\n          config?: T['config'];\n          inputs?: ResolvedInputValueOverrides<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<((...args: any[]) => any) & TExtensionConfigSchema[key]>\n          >;\n        };\n        inputs: Expand<ResolvedExtensionInputs<T['inputs'] & TExtraInputs>>;\n      },\n    ): Iterable<UFactoryOutput> &\n      VerifyExtensionFactoryOutput<\n        ExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UFactoryOutput\n      >;\n  }): OverridableExtensionDefinition<{\n    config: Expand<\n      (string extends keyof TExtensionConfigSchema\n        ? {}\n        : {\n            [key in keyof TExtensionConfigSchema]: z.infer<\n              ReturnType<\n                ((...args: any[]) => any) & TExtensionConfigSchema[key]\n              >\n            >;\n          }) &\n        T['config']\n    >;\n    configInput: Expand<\n      (string extends keyof TExtensionConfigSchema\n        ? {}\n        : z.input<\n            z.ZodObject<{\n              [key in keyof TExtensionConfigSchema]: ReturnType<\n                ((...args: any[]) => any) & TExtensionConfigSchema[key]\n              >;\n            }>\n          >) &\n        T['configInput']\n    >;\n    output: ExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: Expand<T['inputs'] & TExtraInputs>;\n    kind: T['kind'];\n    name: string | undefined extends TName ? undefined : TName;\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<ExtensionBlueprintDefineParams> | Function,\n  defineParams: ExtensionBlueprintDefineParams,\n  kind: string,\n): TParams {\n  const paramDefinition = (\n    params as ParamsFactory<ExtensionBlueprintDefineParams>\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<ExtensionBlueprintDefineParams> | string,\n  ctx: { node: AppNode; [ctxParamsSymbol]?: any },\n  defineParams: ExtensionBlueprintDefineParams | undefined,\n  kind: string,\n): TParams {\n  const overrideParams = ctx[ctxParamsSymbol] as\n    | object\n    | ParamsFactory<ExtensionBlueprintDefineParams>\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 * Creates a new extension blueprint that encapsulates the creation of\n * extensions of particular kinds.\n *\n * @remarks\n *\n * For details on how blueprints work, see the\n * {@link https://backstage.io/docs/frontend-system/architecture/extension-blueprints | documentation for extension blueprints}\n * in the frontend system documentation.\n *\n * Extension blueprints make it much easier for users to create new extensions\n * for your plugin. Rather than letting them use `createExtension`\n * directly, you can define a set of parameters and default factory for your\n * blueprint, removing a lot of the boilerplate and complexity that is otherwise\n * needed to create an extension.\n *\n * Each blueprint has its own `kind` that helps identify and group the\n * extensions that have been created with it. For example the\n * {@link PageBlueprint} has the kind `'page'`, and extensions created with it\n * will be given the ID `'page:<plugin-id>[/<name>]'`. Blueprints should always\n * be exported as `<PascalCaseKind>Blueprint`.\n *\n * When creating a blueprint the type of the parameters are inferred from the\n * `factory` function that you provide. The exception to that is when you need\n * your blueprint to include inferred type parameters, in which case you need to\n * use the `defineParams` option. See the documentation for the `defineParams`\n * option for more details on how that works.\n *\n * @example\n * ```tsx\n * // In your plugin library\n * export const GreetingBlueprint = createExtensionBlueprint({\n *   kind: 'greeting',\n *   attachTo: { id: 'example', input: 'greetings' },\n *   output: [coreExtensionData.reactElement],\n *   factory(params: { greeting: string }) {\n *     return [coreExtensionData.reactElement(<h1>{params.greeting}</h1>)];\n *   },\n * });\n *\n * // Someone using your blueprint in their plugin\n * const exampleGreeting = GreetingBlueprint.make({\n *   params: {\n *     greeting: 'Hello, world!',\n *   },\n * });\n * ```\n * @public\n */\nexport function createExtensionBlueprint<\n  TParams extends object | ExtensionBlueprintDefineParams,\n  UOutput extends ExtensionDataRef,\n  TInputs extends { [inputName in string]: ExtensionInput },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  TKind extends string,\n  UParentInputs extends ExtensionDataRef,\n  TDataRefs extends { [name in string]: ExtensionDataRef } = never,\n  TNewConfigSchema extends { [key in string]: StandardSchemaV1 } = {},\n>(\n  options: {\n    kind: TKind;\n    attachTo: ExtensionDefinitionAttachTo<UParentInputs> &\n      VerifyExtensionAttachTo<UOutput, UParentInputs>;\n    disabled?: boolean;\n    if?: FilterPredicate;\n    inputs?: TInputs;\n    output: Array<UOutput>;\n    config?: never;\n    configSchema?: TNewConfigSchema;\n    defineParams?: TParams extends ExtensionBlueprintDefineParams\n      ? TParams\n      : 'The defineParams option must be a function if provided, see the docs for details';\n    factory(\n      params: TParams extends ExtensionBlueprintDefineParams\n        ? ReturnType<TParams>['T']\n        : TParams,\n      context: {\n        node: AppNode;\n        apis: ApiHolder;\n        config: {\n          [key in keyof TNewConfigSchema]: StandardSchemaV1.InferOutput<\n            TNewConfigSchema[key]\n          >;\n        };\n        inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n      },\n    ): Iterable<UFactoryOutput>;\n    dataRefs?: TDataRefs;\n  } & VerifyExtensionFactoryOutput<UOutput, UFactoryOutput>,\n): ExtensionBlueprint<{\n  kind: TKind;\n  params: TParams;\n  output: UOutput extends ExtensionDataRef<\n    infer IData,\n    infer IId,\n    infer IConfig\n  >\n    ? ExtensionDataRef<IData, IId, IConfig>\n    : never;\n  inputs: string extends keyof TInputs ? {} : TInputs;\n  config: {\n    [key in keyof TNewConfigSchema]: StandardSchemaV1.InferOutput<\n      TNewConfigSchema[key]\n    >;\n  };\n  configInput: {\n    [key in keyof TNewConfigSchema]?: StandardSchemaV1.InferInput<\n      TNewConfigSchema[key]\n    >;\n  };\n  dataRefs: TDataRefs;\n}>;\n\n/**\n * @deprecated Use the top-level `configSchema` option instead of `config.schema`.\n * @public\n */\nexport function createExtensionBlueprint<\n  TParams extends object | ExtensionBlueprintDefineParams,\n  UOutput extends ExtensionDataRef,\n  TInputs extends { [inputName in string]: ExtensionInput },\n  TConfigSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  TKind extends string,\n  UParentInputs extends ExtensionDataRef,\n  TDataRefs extends { [name in string]: ExtensionDataRef } = never,\n>(\n  options: {\n    kind: TKind;\n    attachTo: ExtensionDefinitionAttachTo<UParentInputs> &\n      VerifyExtensionAttachTo<UOutput, UParentInputs>;\n    disabled?: boolean;\n    if?: FilterPredicate;\n    inputs?: TInputs;\n    output: Array<UOutput>;\n    configSchema?: never;\n    config?: {\n      schema: TConfigSchema;\n    };\n    defineParams?: TParams extends ExtensionBlueprintDefineParams\n      ? TParams\n      : 'The defineParams option must be a function if provided, see the docs for details';\n    factory(\n      params: TParams extends ExtensionBlueprintDefineParams\n        ? ReturnType<TParams>['T']\n        : TParams,\n      context: {\n        node: AppNode;\n        apis: ApiHolder;\n        config: {\n          [key in keyof TConfigSchema]: z.infer<\n            ReturnType<((...args: any[]) => any) & TConfigSchema[key]>\n          >;\n        };\n        inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n      },\n    ): Iterable<UFactoryOutput>;\n    dataRefs?: TDataRefs;\n  } & VerifyExtensionFactoryOutput<UOutput, UFactoryOutput>,\n): ExtensionBlueprint<{\n  kind: TKind;\n  params: TParams;\n  output: UOutput extends ExtensionDataRef<\n    infer IData,\n    infer IId,\n    infer IConfig\n  >\n    ? ExtensionDataRef<IData, IId, IConfig>\n    : never;\n  inputs: string extends keyof TInputs ? {} : TInputs;\n  config: string extends keyof TConfigSchema\n    ? {}\n    : {\n        [key in keyof TConfigSchema]: z.infer<\n          ReturnType<((...args: any[]) => any) & TConfigSchema[key]>\n        >;\n      };\n  configInput: string extends keyof TConfigSchema\n    ? {}\n    : z.input<\n        z.ZodObject<{\n          [key in keyof TConfigSchema]: ReturnType<\n            ((...args: any[]) => any) & TConfigSchema[key]\n          >;\n        }>\n      >;\n  dataRefs: TDataRefs;\n}>;\n\n/** @internal */\nexport function createExtensionBlueprint(options: any): any {\n  const defineParams = options.defineParams as\n    | ExtensionBlueprintDefineParams\n    | undefined;\n\n  return {\n    dataRefs: options.dataRefs,\n    make(args) {\n      return createExtension({\n        kind: options.kind,\n        name: args.name,\n        attachTo: (args.attachTo ??\n          options.attachTo) as ExtensionDefinitionAttachTo,\n        disabled: args.disabled ?? options.disabled,\n        if: args.if ?? options.if,\n        inputs: options.inputs,\n        output: options.output as ExtensionDataRef[],\n        config: options.config,\n        configSchema: options.configSchema as any,\n        factory: ctx =>\n          options.factory(\n            unwrapParams(args.params, ctx, defineParams, options.kind),\n            ctx as any,\n          ) as Iterable<ExtensionDataValue<any, any>>,\n      }) as OverridableExtensionDefinition;\n    },\n    makeWithOverrides(args: any) {\n      if (args.config?.schema) {\n        warnConfigSchemaPropDeprecation(describeParentCallSite());\n      }\n      return createExtension({\n        kind: options.kind,\n        name: args.name,\n        attachTo: (args.attachTo ??\n          options.attachTo) as ExtensionDefinitionAttachTo,\n        disabled: args.disabled ?? options.disabled,\n        if: args.if ?? options.if,\n        inputs: { ...args.inputs, ...options.inputs },\n        output: (args.output ?? options.output) as ExtensionDataRef[],\n        config:\n          options.config?.schema || args.config?.schema\n            ? {\n                schema: {\n                  ...options.config?.schema,\n                  ...args.config?.schema,\n                },\n              }\n            : undefined,\n        configSchema:\n          options.configSchema || args.configSchema\n            ? {\n                ...options.configSchema,\n                ...args.configSchema,\n              }\n            : (undefined as any),\n        factory: ctx => {\n          const { node, config, inputs, apis } = ctx;\n          return args.factory(\n            (innerParams: any, innerContext: any) => {\n              return createExtensionDataContainer<any>(\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                'original blueprint factory',\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 OverridableExtensionDefinition;\n    },\n  } as ExtensionBlueprint<any>;\n}\n"],"names":[],"mappings":";;;;;;;;;;;AA6EA,MAAM,qBAAA,GAAwB,WAAW,MAAA,CAMtC;AAAA,EACD,IAAA,EAAM,4BAAA;AAAA,EACN,QAAA,EAAU,CAAC,IAAI;AACjB,CAAC,CAAA;AAWM,SAAS,+BACd,MAAA,EAC6B;AAC7B,EAAA,OAAO,sBAAsB,cAAA,CAAe,IAAA,EAAM,EAAE,CAAA,EAAG,IAAA,EAAa,QAAQ,CAAA;AAC9E;AAyVA,SAAS,mBAAA,CAEP,MAAA,EACA,YAAA,EACA,IAAA,EACS;AACT,EAAA,MAAM,eAAA,GACJ,OACA,YAAY,CAAA;AACd,EAAA,IAAI;AACF,IAAA,OAAO,qBAAA,CAAsB,UAAA,CAAW,eAAe,CAAA,CAAE,MAAA;AAAA,EAC3D,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAAA,2CAAA,EAA8C,IAAI,CAAA,6GAAA,EAAgH,CAAA,CAAE,OAAO,CAAA;AAAA,KAC7K;AAAA,EACF;AACF;AAEA,SAAS,YAAA,CACP,MAAA,EACA,GAAA,EACA,YAAA,EACA,IAAA,EACS;AACT,EAAA,MAAM,cAAA,GAAiB,IAAI,eAAe,CAAA;AAK1C,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,IAAI,cAAA,EAAgB;AAClB,MAAA,IAAI,OAAO,mBAAmB,UAAA,EAAY;AACxC,QAAA,MAAM,IAAI,SAAA;AAAA,UACR,sDAAsD,IAAI,CAAA,oHAAA;AAAA,SAC5D;AAAA,MACF;AACA,MAAA,OAAO,mBAAA,CAAoB,cAAA,EAAgB,YAAA,EAAc,IAAI,CAAA;AAAA,IAC/D;AAEA,IAAA,IAAI,OAAO,WAAW,UAAA,EAAY;AAChC,MAAA,MAAM,IAAI,SAAA;AAAA,QACR,8CAA8C,IAAI,CAAA,gHAAA;AAAA,OACpD;AAAA,IACF;AACA,IAAA,OAAO,mBAAA,CAAoB,MAAA,EAAQ,YAAA,EAAc,IAAI,CAAA;AAAA,EACvD;AAEA,EAAA,MAAM,IAAA,GACJ,OAAO,MAAA,KAAW,UAAA,GACd,mBAAA;AAAA,IACE,MAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA,GACF,GACC,MAAA;AACP,EAAA,MAAM,SAAA,GACJ,OAAO,cAAA,KAAmB,UAAA,GACtB,mBAAA;AAAA,IACE,cAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA,GACF,GACC,cAAA;AAEP,EAAA,OAAO;AAAA,IACL,GAAG,IAAA;AAAA,IACH,GAAG;AAAA,GACL;AACF;AAgMO,SAAS,yBAAyB,OAAA,EAAmB;AAC1D,EAAA,MAAM,eAAe,OAAA,CAAQ,YAAA;AAI7B,EAAA,OAAO;AAAA,IACL,UAAU,OAAA,CAAQ,QAAA;AAAA,IAClB,KAAK,IAAA,EAAM;AACT,MAAA,OAAO,eAAA,CAAgB;AAAA,QACrB,MAAM,OAAA,CAAQ,IAAA;AAAA,QACd,MAAM,IAAA,CAAK,IAAA;AAAA,QACX,QAAA,EAAW,IAAA,CAAK,QAAA,IACd,OAAA,CAAQ,QAAA;AAAA,QACV,QAAA,EAAU,IAAA,CAAK,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QACnC,EAAA,EAAI,IAAA,CAAK,EAAA,IAAM,OAAA,CAAQ,EAAA;AAAA,QACvB,QAAQ,OAAA,CAAQ,MAAA;AAAA,QAChB,QAAQ,OAAA,CAAQ,MAAA;AAAA,QAChB,QAAQ,OAAA,CAAQ,MAAA;AAAA,QAChB,cAAc,OAAA,CAAQ,YAAA;AAAA,QACtB,OAAA,EAAS,SACP,OAAA,CAAQ,OAAA;AAAA,UACN,aAAa,IAAA,CAAK,MAAA,EAAQ,GAAA,EAAK,YAAA,EAAc,QAAQ,IAAI,CAAA;AAAA,UACzD;AAAA;AACF,OACH,CAAA;AAAA,IACH,CAAA;AAAA,IACA,kBAAkB,IAAA,EAAW;AAC3B,MAAA,IAAI,IAAA,CAAK,QAAQ,MAAA,EAAQ;AACvB,QAAA,+BAAA,CAAgC,wBAAwB,CAAA;AAAA,MAC1D;AACA,MAAA,OAAO,eAAA,CAAgB;AAAA,QACrB,MAAM,OAAA,CAAQ,IAAA;AAAA,QACd,MAAM,IAAA,CAAK,IAAA;AAAA,QACX,QAAA,EAAW,IAAA,CAAK,QAAA,IACd,OAAA,CAAQ,QAAA;AAAA,QACV,QAAA,EAAU,IAAA,CAAK,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QACnC,EAAA,EAAI,IAAA,CAAK,EAAA,IAAM,OAAA,CAAQ,EAAA;AAAA,QACvB,QAAQ,EAAE,GAAG,KAAK,MAAA,EAAQ,GAAG,QAAQ,MAAA,EAAO;AAAA,QAC5C,MAAA,EAAS,IAAA,CAAK,MAAA,IAAU,OAAA,CAAQ,MAAA;AAAA,QAChC,QACE,OAAA,CAAQ,MAAA,EAAQ,MAAA,IAAU,IAAA,CAAK,QAAQ,MAAA,GACnC;AAAA,UACE,MAAA,EAAQ;AAAA,YACN,GAAG,QAAQ,MAAA,EAAQ,MAAA;AAAA,YACnB,GAAG,KAAK,MAAA,EAAQ;AAAA;AAClB,SACF,GACA,MAAA;AAAA,QACN,YAAA,EACE,OAAA,CAAQ,YAAA,IAAgB,IAAA,CAAK,YAAA,GACzB;AAAA,UACE,GAAG,OAAA,CAAQ,YAAA;AAAA,UACX,GAAG,IAAA,CAAK;AAAA,SACV,GACC,MAAA;AAAA,QACP,SAAS,CAAA,GAAA,KAAO;AACd,UAAA,MAAM,EAAE,IAAA,EAAM,MAAA,EAAQ,MAAA,EAAQ,MAAK,GAAI,GAAA;AACvC,UAAA,OAAO,IAAA,CAAK,OAAA;AAAA,YACV,CAAC,aAAkB,YAAA,KAAsB;AACvC,cAAA,OAAO,4BAAA;AAAA,gBACL,OAAA,CAAQ,OAAA;AAAA,kBACN,YAAA,CAAa,WAAA,EAAa,GAAA,EAAK,YAAA,EAAc,QAAQ,IAAI,CAAA;AAAA,kBACzD;AAAA,oBACE,IAAA;AAAA,oBACA,IAAA;AAAA,oBACA,MAAA,EAAS,cAAc,MAAA,IAAU,MAAA;AAAA,oBACjC,MAAA,EAAQ,qBAAA;AAAA,sBACN,OAAA,CAAQ,MAAA;AAAA,sBACR,MAAA;AAAA,sBACA,YAAA,EAAc;AAAA;AAChB;AACF,iBACF;AAAA,gBACA,4BAAA;AAAA,gBACA,OAAA,CAAQ;AAAA,eACV;AAAA,YACF,CAAA;AAAA,YACA;AAAA,cACE,IAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA;AAAA,cACA;AAAA;AACF,WACF;AAAA,QACF;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACF;AACF;;;;"}

package/dist/wiring/createFrontendModule.esm.js

@@ -1,35 +1,11 @@
-import { resolveExtensionDefinition } from './resolveExtensionDefinition.esm.js';
-import { OpaqueExtensionDefinition } from '../frontend-internal/src/wiring/InternalExtensionDefinition.esm.js';
-import '../frontend-internal/src/wiring/InternalExtensionInput.esm.js';
-import '../frontend-internal/src/wiring/InternalFrontendPlugin.esm.js';
-import '../frontend-internal/src/wiring/InternalSwappableComponentRef.esm.js';
+import { resolveExtensionDefinitions } from './resolveExtensionDefinition.esm.js';
 
 function createFrontendModule(options) {
   const { pluginId } = options;
-  const extensions = new Array();
-  const extensionDefinitionsById = /* @__PURE__ */ new Map();
-  for (const def of options.extensions ?? []) {
-    const internal = OpaqueExtensionDefinition.toInternal(def);
-    const ext = resolveExtensionDefinition(def, { namespace: pluginId });
-    extensions.push(ext);
-    extensionDefinitionsById.set(ext.id, {
-      ...internal,
-      namespace: pluginId
-    });
-  }
-  if (extensions.length !== extensionDefinitionsById.size) {
-    const extensionIds = extensions.map((e) => e.id);
-    const duplicates = Array.from(
-      new Set(
-        extensionIds.filter((id, index) => extensionIds.indexOf(id) !== index)
-      )
-    );
-    throw new Error(
-      `Plugin '${pluginId}' provided duplicate extensions: ${duplicates.join(
-        ", "
-      )}`
-    );
-  }
+  const { extensions } = resolveExtensionDefinitions(options.extensions ?? [], {
+    namespace: pluginId,
+    featureType: "Module"
+  });
   return {
     $$type: "@backstage/FrontendModule",
     version: "v1",

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

@@ -1 +1 @@
-{"version":3,"file":"createFrontendModule.esm.js","sources":["../../src/wiring/createFrontendModule.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 { OpaqueExtensionDefinition } from '@internal/frontend';\nimport { ExtensionDefinition } from './createExtension';\nimport {\n  Extension,\n  resolveExtensionDefinition,\n} from './resolveExtensionDefinition';\nimport { FeatureFlagConfig } from './types';\nimport { FilterPredicate } from '@backstage/filter-predicates';\n\n/** @public */\nexport interface CreateFrontendModuleOptions<\n  TPluginId extends string,\n  TExtensions extends readonly ExtensionDefinition[],\n> {\n  pluginId: TPluginId;\n  extensions?: TExtensions;\n  featureFlags?: FeatureFlagConfig[];\n  if?: FilterPredicate;\n}\n\n/** @public */\nexport interface FrontendModule {\n  readonly $$type: '@backstage/FrontendModule';\n  readonly pluginId: string;\n}\n\n/** @internal */\nexport interface InternalFrontendModule extends FrontendModule {\n  readonly version: 'v1';\n  readonly extensions: Extension<unknown>[];\n  readonly featureFlags: FeatureFlagConfig[];\n  readonly if?: FilterPredicate;\n}\n\n/**\n * Creates a new module that can be installed in a Backstage app.\n *\n * @remarks\n *\n * Modules are used to add or override extensions for an existing plugin. If a\n * module provides an extension with the same ID as one provided by the plugin,\n * the extension provided by the module will always take precedence.\n *\n * Every module is created for a specific plugin by providing the\n * unique ID of the plugin that the module should be installed for. If that\n * plugin is not present in the app, the module will be ignored and have no\n * effect.\n *\n * For more information on how modules work, see the\n * {@link https://backstage.io/docs/frontend-system/architecture/extension-overrides#creating-a-frontend-module | documentation for modules}\n * in the frontend system documentation.\n *\n * It is recommended to name the module variable of the form `<pluginId>Module<ModuleName>`.\n *\n * @example\n *\n * ```tsx\n * import { createFrontendModule } from '@backstage/frontend-plugin-api';\n *\n * export const exampleModuleCustomPage = createFrontendModule({\n *   pluginId: 'example',\n *   extensions: [\n *     // Overrides the default page for the 'example' plugin\n *     PageBlueprint.make({\n *       path: '/example',\n *       loader: () => import('./CustomPage').then(m => <m.CustomPage />),\n *     }),\n *   ],\n * });\n * ```\n *\n * @public\n */\nexport function createFrontendModule<\n  TId extends string,\n  TExtensions extends readonly ExtensionDefinition[],\n>(options: CreateFrontendModuleOptions<TId, TExtensions>): FrontendModule {\n  const { pluginId } = options;\n\n  const extensions = new Array<Extension<any>>();\n  const extensionDefinitionsById = new Map<\n    string,\n    typeof OpaqueExtensionDefinition.TInternal\n  >();\n\n  for (const def of options.extensions ?? []) {\n    const internal = OpaqueExtensionDefinition.toInternal(def);\n    const ext = resolveExtensionDefinition(def, { namespace: pluginId });\n    extensions.push(ext);\n    extensionDefinitionsById.set(ext.id, {\n      ...internal,\n      namespace: pluginId,\n    });\n  }\n\n  if (extensions.length !== extensionDefinitionsById.size) {\n    const extensionIds = extensions.map(e => e.id);\n    const duplicates = Array.from(\n      new Set(\n        extensionIds.filter((id, index) => extensionIds.indexOf(id) !== index),\n      ),\n    );\n    // TODO(Rugvip): This could provide some more information about the kind + name of the extensions\n    throw new Error(\n      `Plugin '${pluginId}' provided duplicate extensions: ${duplicates.join(\n        ', ',\n      )}`,\n    );\n  }\n\n  return {\n    $$type: '@backstage/FrontendModule',\n    version: 'v1',\n    pluginId,\n    featureFlags: options.featureFlags ?? [],\n    if: options.if,\n    extensions,\n    toString() {\n      return `Module{pluginId=${pluginId}}`;\n    },\n  } as InternalFrontendModule;\n}\n\n/** @internal */\nexport function isInternalFrontendModule(opaque: {\n  $$type: string;\n}): opaque is InternalFrontendModule {\n  if (opaque.$$type === '@backstage/FrontendModule') {\n    // Make sure we throw if invalid\n    toInternalFrontendModule(opaque as FrontendModule);\n    return true;\n  }\n  return false;\n}\n\n/** @internal */\nexport function toInternalFrontendModule(\n  plugin: FrontendModule,\n): InternalFrontendModule {\n  const internal = plugin as InternalFrontendModule;\n  if (internal.$$type !== '@backstage/FrontendModule') {\n    throw new Error(`Invalid plugin instance, bad type '${internal.$$type}'`);\n  }\n  if (internal.version !== 'v1') {\n    throw new Error(\n      `Invalid plugin instance, bad version '${internal.version}'`,\n    );\n  }\n  return internal;\n}\n"],"names":[],"mappings":";;;;;;AAyFO,SAAS,qBAGd,OAAA,EAAwE;AACxE,EAAA,MAAM,EAAE,UAAS,GAAI,OAAA;AAErB,EAAA,MAAM,UAAA,GAAa,IAAI,KAAA,EAAsB;AAC7C,EAAA,MAAM,wBAAA,uBAA+B,GAAA,EAGnC;AAEF,EAAA,KAAA,MAAW,GAAA,IAAO,OAAA,CAAQ,UAAA,IAAc,EAAC,EAAG;AAC1C,IAAA,MAAM,QAAA,GAAW,yBAAA,CAA0B,UAAA,CAAW,GAAG,CAAA;AACzD,IAAA,MAAM,MAAM,0BAAA,CAA2B,GAAA,EAAK,EAAE,SAAA,EAAW,UAAU,CAAA;AACnE,IAAA,UAAA,CAAW,KAAK,GAAG,CAAA;AACnB,IAAA,wBAAA,CAAyB,GAAA,CAAI,IAAI,EAAA,EAAI;AAAA,MACnC,GAAG,QAAA;AAAA,MACH,SAAA,EAAW;AAAA,KACZ,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,UAAA,CAAW,MAAA,KAAW,wBAAA,CAAyB,IAAA,EAAM;AACvD,IAAA,MAAM,YAAA,GAAe,UAAA,CAAW,GAAA,CAAI,CAAA,CAAA,KAAK,EAAE,EAAE,CAAA;AAC7C,IAAA,MAAM,aAAa,KAAA,CAAM,IAAA;AAAA,MACvB,IAAI,GAAA;AAAA,QACF,YAAA,CAAa,OAAO,CAAC,EAAA,EAAI,UAAU,YAAA,CAAa,OAAA,CAAQ,EAAE,CAAA,KAAM,KAAK;AAAA;AACvE,KACF;AAEA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,QAAA,EAAW,QAAQ,CAAA,iCAAA,EAAoC,UAAA,CAAW,IAAA;AAAA,QAChE;AAAA,OACD,CAAA;AAAA,KACH;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,2BAAA;AAAA,IACR,OAAA,EAAS,IAAA;AAAA,IACT,QAAA;AAAA,IACA,YAAA,EAAc,OAAA,CAAQ,YAAA,IAAgB,EAAC;AAAA,IACvC,IAAI,OAAA,CAAQ,EAAA;AAAA,IACZ,UAAA;AAAA,IACA,QAAA,GAAW;AACT,MAAA,OAAO,mBAAmB,QAAQ,CAAA,CAAA,CAAA;AAAA,IACpC;AAAA,GACF;AACF;;;;"}
+{"version":3,"file":"createFrontendModule.esm.js","sources":["../../src/wiring/createFrontendModule.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 { ExtensionDefinition } from './createExtension';\nimport {\n  Extension,\n  resolveExtensionDefinitions,\n} from './resolveExtensionDefinition';\nimport { FeatureFlagConfig } from './types';\nimport { FilterPredicate } from '@backstage/filter-predicates';\n\n/** @public */\nexport interface CreateFrontendModuleOptions<\n  TPluginId extends string,\n  TExtensions extends readonly ExtensionDefinition[],\n> {\n  pluginId: TPluginId;\n  extensions?: TExtensions;\n  featureFlags?: FeatureFlagConfig[];\n  if?: FilterPredicate;\n}\n\n/** @public */\nexport interface FrontendModule {\n  readonly $$type: '@backstage/FrontendModule';\n  readonly pluginId: string;\n}\n\n/** @internal */\nexport interface InternalFrontendModule extends FrontendModule {\n  readonly version: 'v1';\n  readonly extensions: Extension<unknown>[];\n  readonly featureFlags: FeatureFlagConfig[];\n  readonly if?: FilterPredicate;\n}\n\n/**\n * Creates a new module that can be installed in a Backstage app.\n *\n * @remarks\n *\n * Modules are used to add or override extensions for an existing plugin. If a\n * module provides an extension with the same ID as one provided by the plugin,\n * the extension provided by the module will always take precedence.\n *\n * Every module is created for a specific plugin by providing the\n * unique ID of the plugin that the module should be installed for. If that\n * plugin is not present in the app, the module will be ignored and have no\n * effect.\n *\n * For more information on how modules work, see the\n * {@link https://backstage.io/docs/frontend-system/architecture/extension-overrides#creating-a-frontend-module | documentation for modules}\n * in the frontend system documentation.\n *\n * It is recommended to name the module variable of the form `<pluginId>Module<ModuleName>`.\n *\n * @example\n *\n * ```tsx\n * import { createFrontendModule } from '@backstage/frontend-plugin-api';\n *\n * export const exampleModuleCustomPage = createFrontendModule({\n *   pluginId: 'example',\n *   extensions: [\n *     // Overrides the default page for the 'example' plugin\n *     PageBlueprint.make({\n *       path: '/example',\n *       loader: () => import('./CustomPage').then(m => <m.CustomPage />),\n *     }),\n *   ],\n * });\n * ```\n *\n * @public\n */\nexport function createFrontendModule<\n  TId extends string,\n  TExtensions extends readonly ExtensionDefinition[],\n>(options: CreateFrontendModuleOptions<TId, TExtensions>): FrontendModule {\n  const { pluginId } = options;\n\n  const { extensions } = resolveExtensionDefinitions(options.extensions ?? [], {\n    namespace: pluginId,\n    featureType: 'Module',\n  });\n\n  return {\n    $$type: '@backstage/FrontendModule',\n    version: 'v1',\n    pluginId,\n    featureFlags: options.featureFlags ?? [],\n    if: options.if,\n    extensions,\n    toString() {\n      return `Module{pluginId=${pluginId}}`;\n    },\n  } as InternalFrontendModule;\n}\n\n/** @internal */\nexport function isInternalFrontendModule(opaque: {\n  $$type: string;\n}): opaque is InternalFrontendModule {\n  if (opaque.$$type === '@backstage/FrontendModule') {\n    // Make sure we throw if invalid\n    toInternalFrontendModule(opaque as FrontendModule);\n    return true;\n  }\n  return false;\n}\n\n/** @internal */\nexport function toInternalFrontendModule(\n  plugin: FrontendModule,\n): InternalFrontendModule {\n  const internal = plugin as InternalFrontendModule;\n  if (internal.$$type !== '@backstage/FrontendModule') {\n    throw new Error(`Invalid plugin instance, bad type '${internal.$$type}'`);\n  }\n  if (internal.version !== 'v1') {\n    throw new Error(\n      `Invalid plugin instance, bad version '${internal.version}'`,\n    );\n  }\n  return internal;\n}\n"],"names":[],"mappings":";;AAwFO,SAAS,qBAGd,OAAA,EAAwE;AACxE,EAAA,MAAM,EAAE,UAAS,GAAI,OAAA;AAErB,EAAA,MAAM,EAAE,UAAA,EAAW,GAAI,4BAA4B,OAAA,CAAQ,UAAA,IAAc,EAAC,EAAG;AAAA,IAC3E,SAAA,EAAW,QAAA;AAAA,IACX,WAAA,EAAa;AAAA,GACd,CAAA;AAED,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,2BAAA;AAAA,IACR,OAAA,EAAS,IAAA;AAAA,IACT,QAAA;AAAA,IACA,YAAA,EAAc,OAAA,CAAQ,YAAA,IAAgB,EAAC;AAAA,IACvC,IAAI,OAAA,CAAQ,EAAA;AAAA,IACZ,UAAA;AAAA,IACA,QAAA,GAAW;AACT,MAAA,OAAO,mBAAmB,QAAQ,CAAA,CAAA,CAAA;AAAA,IACpC;AAAA,GACF;AACF;;;;"}

package/dist/wiring/createFrontendPlugin.esm.js

@@ -1,8 +1,8 @@
-import { resolveExtensionDefinition } from './resolveExtensionDefinition.esm.js';
+import { resolveExtensionDefinitions, resolveExtensionDefinition } from './resolveExtensionDefinition.esm.js';
 import { ID_PATTERN } from './constants.esm.js';
-import { OpaqueExtensionDefinition } from '../frontend-internal/src/wiring/InternalExtensionDefinition.esm.js';
-import '../frontend-internal/src/wiring/InternalExtensionInput.esm.js';
 import { OpaqueFrontendPlugin } from '../frontend-internal/src/wiring/InternalFrontendPlugin.esm.js';
+import '../frontend-internal/src/wiring/InternalExtensionDefinition.esm.js';
+import '../frontend-internal/src/wiring/InternalExtensionInput.esm.js';
 import '../frontend-internal/src/wiring/InternalSwappableComponentRef.esm.js';
 
 function createFrontendPlugin(options) {
@@ -12,30 +12,13 @@ function createFrontendPlugin(options) {
       `WARNING: The pluginId '${pluginId}' will be invalid soon, please change it to match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`
     );
   }
-  const extensions = new Array();
-  const extensionDefinitionsById = /* @__PURE__ */ new Map();
-  for (const def of options.extensions ?? []) {
-    const internal = OpaqueExtensionDefinition.toInternal(def);
-    const ext = resolveExtensionDefinition(def, { namespace: pluginId });
-    extensions.push(ext);
-    extensionDefinitionsById.set(ext.id, {
-      ...internal,
-      namespace: pluginId
-    });
-  }
-  if (extensions.length !== extensionDefinitionsById.size) {
-    const extensionIds = extensions.map((e) => e.id);
-    const duplicates = Array.from(
-      new Set(
-        extensionIds.filter((id, index) => extensionIds.indexOf(id) !== index)
-      )
-    );
-    throw new Error(
-      `Plugin '${pluginId}' provided duplicate extensions: ${duplicates.join(
-        ", "
-      )}`
-    );
-  }
+  const { extensions, extensionDefinitionsById } = resolveExtensionDefinitions(
+    options.extensions ?? [],
+    {
+      namespace: pluginId,
+      featureType: "Plugin"
+    }
+  );
   return OpaqueFrontendPlugin.createInstance("v1", {
     pluginId,
     id: pluginId,

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

@@ -1 +1 @@
-{"version":3,"file":"createFrontendPlugin.esm.js","sources":["../../src/wiring/createFrontendPlugin.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 {\n  OpaqueExtensionDefinition,\n  OpaqueFrontendPlugin,\n} from '@internal/frontend';\nimport {\n  ExtensionDefinition,\n  OverridableExtensionDefinition,\n} from './createExtension';\nimport {\n  Extension,\n  resolveExtensionDefinition,\n} from './resolveExtensionDefinition';\nimport { FeatureFlagConfig } from './types';\nimport { MakeSortedExtensionsMap } from './MakeSortedExtensionsMap';\nimport { JsonObject } from '@backstage/types';\nimport { IconElement } from '../icons/types';\nimport { RouteRef, SubRouteRef, ExternalRouteRef } from '../routing';\nimport { ID_PATTERN } from './constants';\nimport { FilterPredicate } from '@backstage/filter-predicates';\n\n/**\n * Information about the plugin.\n *\n * @public\n * @remarks\n *\n * This interface is intended to be extended via [module\n * augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation)\n * in order to add fields that are specific to each project.\n *\n * For example, one might add a `slackChannel` field that is read from the\n * opaque manifest file.\n *\n * See the options for `createApp` for more information about how to\n * customize the parsing of manifest files.\n */\nexport interface FrontendPluginInfo {\n  /**\n   * The name of the package that implements the plugin.\n   */\n  packageName?: string;\n\n  /**\n   * The version of the plugin, typically the version of the package.json file.\n   */\n  version?: string;\n\n  /**\n   * As short description of the plugin, typically the description field in\n   * package.json.\n   */\n  description?: string;\n\n  /**\n   * The owner entity references of the plugin.\n   */\n  ownerEntityRefs?: string[];\n\n  /**\n   * Links related to the plugin.\n   */\n  links?: Array<{ title: string; url: string }>;\n}\n\n/**\n * Options for providing information for a plugin.\n *\n * @public\n */\nexport type FrontendPluginInfoOptions = {\n  /**\n   * A loader function for the package.json file for the plugin.\n   */\n  packageJson?: () => Promise<{ name: string } & JsonObject>;\n  /**\n   * A loader function for an opaque manifest file for the plugin.\n   */\n  manifest?: () => Promise<JsonObject>;\n};\n\n/**\n * A variant of the {@link FrontendPlugin} interface that can also be used to install overrides for the plugin.\n *\n * @public\n */\nexport interface OverridableFrontendPlugin<\n  TRoutes extends { [name in string]: RouteRef | SubRouteRef } = {\n    [name in string]: RouteRef | SubRouteRef;\n  },\n  TExternalRoutes extends { [name in string]: ExternalRouteRef } = {\n    [name in string]: ExternalRouteRef;\n  },\n  TExtensionMap extends { [id in string]: ExtensionDefinition } = {\n    [id in string]: ExtensionDefinition;\n  },\n> extends FrontendPlugin<TRoutes, TExternalRoutes> {\n  getExtension<TId extends keyof TExtensionMap>(\n    id: TId,\n  ): OverridableExtensionDefinition<TExtensionMap[TId]['T']>;\n  withOverrides(options: {\n    extensions?: Array<ExtensionDefinition>;\n\n    /**\n     * Overrides the shared condition that applies to all extensions in the plugin.\n     */\n    if?: FilterPredicate;\n\n    /**\n     * Overrides the display title of the plugin.\n     */\n    title?: string;\n\n    /**\n     * Overrides the display icon of the plugin.\n     */\n    icon?: IconElement;\n\n    /**\n     * Overrides the original info loaders of the plugin one by one.\n     */\n    info?: FrontendPluginInfoOptions;\n  }): OverridableFrontendPlugin<TRoutes, TExternalRoutes, TExtensionMap>;\n}\n\n/** @public */\nexport interface FrontendPlugin<\n  TRoutes extends { [name in string]: RouteRef | SubRouteRef } = {\n    [name in string]: RouteRef | SubRouteRef;\n  },\n  TExternalRoutes extends { [name in string]: ExternalRouteRef } = {\n    [name in string]: ExternalRouteRef;\n  },\n> {\n  readonly $$type: '@backstage/FrontendPlugin';\n  /**\n   * The plugin ID.\n   */\n  readonly pluginId: string;\n  /**\n   * Deprecated alias for `pluginId`.\n   *\n   * @deprecated Use `pluginId` instead.\n   */\n  readonly id: string;\n  /**\n   * The display title of the plugin, used in page headers and navigation.\n   * Falls back to the plugin ID if not provided.\n   */\n  readonly title?: string;\n  /**\n   * The display icon of the plugin, used in page headers and navigation.\n   */\n  readonly icon?: IconElement;\n  readonly routes: TRoutes;\n  readonly externalRoutes: TExternalRoutes;\n\n  /**\n   * Loads the plugin info.\n   */\n  info(): Promise<FrontendPluginInfo>;\n}\n\n/**\n * Options for {@link createFrontendPlugin}.\n *\n * @public\n */\nexport interface CreateFrontendPluginOptions<\n  TId extends string,\n  TRoutes extends { [name in string]: RouteRef | SubRouteRef },\n  TExternalRoutes extends { [name in string]: ExternalRouteRef },\n  TExtensions extends readonly ExtensionDefinition[],\n> {\n  pluginId: TId;\n  /**\n   * The display title of the plugin, used in page headers and navigation.\n   * Falls back to the plugin ID if not provided.\n   */\n  title?: string;\n  /**\n   * The display icon of the plugin, used in page headers and navigation.\n   */\n  icon?: IconElement;\n  routes?: TRoutes;\n  externalRoutes?: TExternalRoutes;\n  extensions?: TExtensions;\n  featureFlags?: FeatureFlagConfig[];\n  if?: FilterPredicate;\n  info?: FrontendPluginInfoOptions;\n}\n\n/**\n * @deprecated Use {@link CreateFrontendPluginOptions} instead.\n * @public\n */\nexport type PluginOptions<\n  TId extends string,\n  TRoutes extends { [name in string]: RouteRef | SubRouteRef },\n  TExternalRoutes extends { [name in string]: ExternalRouteRef },\n  TExtensions extends readonly ExtensionDefinition[],\n> = CreateFrontendPluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>;\n\n/**\n * Creates a new plugin that can be installed in a Backstage app.\n *\n * @remarks\n *\n * Every plugin is created with a unique ID and a set of extensions\n * that are installed as part of the plugin.\n *\n * For more information on how plugins work, see the\n * {@link https://backstage.io/docs/frontend-system/building-plugins/index | documentation for plugins}\n * in the frontend system documentation.\n *\n * @example\n *\n * ```tsx\n * import { createFrontendPlugin } from '@backstage/frontend-plugin-api';\n *\n * export const examplePlugin = createFrontendPlugin({\n *   pluginId: 'example',\n *   extensions: [\n *     PageBlueprint.make({\n *       path: '/example',\n *       loader: () => import('./ExamplePage').then(m => <m.ExamplePage />),\n *     }),\n *   ],\n * });\n * ```\n *\n * @public\n */\nexport function createFrontendPlugin<\n  TId extends string,\n  TExtensions extends readonly ExtensionDefinition[],\n  TRoutes extends { [name in string]: RouteRef | SubRouteRef } = {},\n  TExternalRoutes extends { [name in string]: ExternalRouteRef } = {},\n>(\n  options: CreateFrontendPluginOptions<\n    TId,\n    TRoutes,\n    TExternalRoutes,\n    TExtensions\n  >,\n): OverridableFrontendPlugin<\n  TRoutes,\n  TExternalRoutes,\n  MakeSortedExtensionsMap<TExtensions[number], TId>\n> {\n  const pluginId = options.pluginId;\n\n  if (!ID_PATTERN.test(pluginId)) {\n    // eslint-disable-next-line no-console\n    console.warn(\n      `WARNING: The pluginId '${pluginId}' will be invalid soon, please change it to match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,\n    );\n  }\n\n  const extensions = new Array<Extension<any>>();\n  const extensionDefinitionsById = new Map<\n    string,\n    typeof OpaqueExtensionDefinition.TInternal\n  >();\n\n  for (const def of options.extensions ?? []) {\n    const internal = OpaqueExtensionDefinition.toInternal(def);\n    const ext = resolveExtensionDefinition(def, { namespace: pluginId });\n    extensions.push(ext);\n    extensionDefinitionsById.set(ext.id, {\n      ...internal,\n      namespace: pluginId,\n    });\n  }\n\n  if (extensions.length !== extensionDefinitionsById.size) {\n    const extensionIds = extensions.map(e => e.id);\n    const duplicates = Array.from(\n      new Set(\n        extensionIds.filter((id, index) => extensionIds.indexOf(id) !== index),\n      ),\n    );\n    // TODO(Rugvip): This could provide some more information about the kind + name of the extensions\n    throw new Error(\n      `Plugin '${pluginId}' provided duplicate extensions: ${duplicates.join(\n        ', ',\n      )}`,\n    );\n  }\n\n  return OpaqueFrontendPlugin.createInstance('v1', {\n    pluginId,\n    id: pluginId,\n    title: options.title,\n    icon: options.icon,\n    routes: options.routes ?? ({} as TRoutes),\n    externalRoutes: options.externalRoutes ?? ({} as TExternalRoutes),\n    featureFlags: options.featureFlags ?? [],\n    if: options.if,\n    extensions: extensions,\n    infoOptions: options.info,\n\n    // This method is overridden when the plugin instance is installed in an app\n    async info() {\n      throw new Error(\n        `Attempted to load plugin info for plugin '${pluginId}', but the plugin instance is not installed in an app`,\n      );\n    },\n    getExtension(id) {\n      const ext = extensionDefinitionsById.get(id);\n      if (!ext) {\n        throw new Error(\n          `Attempted to get non-existent extension '${id}' from plugin '${pluginId}'`,\n        );\n      }\n      return ext;\n    },\n    toString() {\n      return `Plugin{id=${pluginId}}`;\n    },\n    withOverrides(overrides) {\n      let ifPredicate = options.if;\n      if ('if' in overrides) {\n        ifPredicate = overrides.if;\n      }\n      const overrideExtensions = overrides.extensions ?? [];\n      const overriddenExtensionIds = new Set(\n        overrideExtensions.map(\n          e => resolveExtensionDefinition(e, { namespace: pluginId }).id,\n        ),\n      );\n      const nonOverriddenExtensions = (options.extensions ?? []).filter(\n        e =>\n          !overriddenExtensionIds.has(\n            resolveExtensionDefinition(e, { namespace: pluginId }).id,\n          ),\n      );\n      return createFrontendPlugin({\n        ...options,\n        pluginId,\n        if: ifPredicate,\n        title: overrides.title ?? options.title,\n        icon: overrides.icon ?? options.icon,\n        extensions: [...nonOverriddenExtensions, ...overrideExtensions],\n        info: {\n          ...options.info,\n          ...overrides.info,\n        },\n      });\n    },\n  });\n}\n"],"names":[],"mappings":";;;;;;;AAwPO,SAAS,qBAMd,OAAA,EAUA;AACA,EAAA,MAAM,WAAW,OAAA,CAAQ,QAAA;AAEzB,EAAA,IAAI,CAAC,UAAA,CAAW,IAAA,CAAK,QAAQ,CAAA,EAAG;AAE9B,IAAA,OAAA,CAAQ,IAAA;AAAA,MACN,CAAA,uBAAA,EAA0B,QAAQ,CAAA,8DAAA,EAAiE,UAAU,CAAA,2DAAA;AAAA,KAC/G;AAAA,EACF;AAEA,EAAA,MAAM,UAAA,GAAa,IAAI,KAAA,EAAsB;AAC7C,EAAA,MAAM,wBAAA,uBAA+B,GAAA,EAGnC;AAEF,EAAA,KAAA,MAAW,GAAA,IAAO,OAAA,CAAQ,UAAA,IAAc,EAAC,EAAG;AAC1C,IAAA,MAAM,QAAA,GAAW,yBAAA,CAA0B,UAAA,CAAW,GAAG,CAAA;AACzD,IAAA,MAAM,MAAM,0BAAA,CAA2B,GAAA,EAAK,EAAE,SAAA,EAAW,UAAU,CAAA;AACnE,IAAA,UAAA,CAAW,KAAK,GAAG,CAAA;AACnB,IAAA,wBAAA,CAAyB,GAAA,CAAI,IAAI,EAAA,EAAI;AAAA,MACnC,GAAG,QAAA;AAAA,MACH,SAAA,EAAW;AAAA,KACZ,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,UAAA,CAAW,MAAA,KAAW,wBAAA,CAAyB,IAAA,EAAM;AACvD,IAAA,MAAM,YAAA,GAAe,UAAA,CAAW,GAAA,CAAI,CAAA,CAAA,KAAK,EAAE,EAAE,CAAA;AAC7C,IAAA,MAAM,aAAa,KAAA,CAAM,IAAA;AAAA,MACvB,IAAI,GAAA;AAAA,QACF,YAAA,CAAa,OAAO,CAAC,EAAA,EAAI,UAAU,YAAA,CAAa,OAAA,CAAQ,EAAE,CAAA,KAAM,KAAK;AAAA;AACvE,KACF;AAEA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,QAAA,EAAW,QAAQ,CAAA,iCAAA,EAAoC,UAAA,CAAW,IAAA;AAAA,QAChE;AAAA,OACD,CAAA;AAAA,KACH;AAAA,EACF;AAEA,EAAA,OAAO,oBAAA,CAAqB,eAAe,IAAA,EAAM;AAAA,IAC/C,QAAA;AAAA,IACA,EAAA,EAAI,QAAA;AAAA,IACJ,OAAO,OAAA,CAAQ,KAAA;AAAA,IACf,MAAM,OAAA,CAAQ,IAAA;AAAA,IACd,MAAA,EAAQ,OAAA,CAAQ,MAAA,IAAW,EAAC;AAAA,IAC5B,cAAA,EAAgB,OAAA,CAAQ,cAAA,IAAmB,EAAC;AAAA,IAC5C,YAAA,EAAc,OAAA,CAAQ,YAAA,IAAgB,EAAC;AAAA,IACvC,IAAI,OAAA,CAAQ,EAAA;AAAA,IACZ,UAAA;AAAA,IACA,aAAa,OAAA,CAAQ,IAAA;AAAA;AAAA,IAGrB,MAAM,IAAA,GAAO;AACX,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,6CAA6C,QAAQ,CAAA,qDAAA;AAAA,OACvD;AAAA,IACF,CAAA;AAAA,IACA,aAAa,EAAA,EAAI;AACf,MAAA,MAAM,GAAA,GAAM,wBAAA,CAAyB,GAAA,CAAI,EAAE,CAAA;AAC3C,MAAA,IAAI,CAAC,GAAA,EAAK;AACR,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,yCAAA,EAA4C,EAAE,CAAA,eAAA,EAAkB,QAAQ,CAAA,CAAA;AAAA,SAC1E;AAAA,MACF;AACA,MAAA,OAAO,GAAA;AAAA,IACT,CAAA;AAAA,IACA,QAAA,GAAW;AACT,MAAA,OAAO,aAAa,QAAQ,CAAA,CAAA,CAAA;AAAA,IAC9B,CAAA;AAAA,IACA,cAAc,SAAA,EAAW;AACvB,MAAA,IAAI,cAAc,OAAA,CAAQ,EAAA;AAC1B,MAAA,IAAI,QAAQ,SAAA,EAAW;AACrB,QAAA,WAAA,GAAc,SAAA,CAAU,EAAA;AAAA,MAC1B;AACA,MAAA,MAAM,kBAAA,GAAqB,SAAA,CAAU,UAAA,IAAc,EAAC;AACpD,MAAA,MAAM,yBAAyB,IAAI,GAAA;AAAA,QACjC,kBAAA,CAAmB,GAAA;AAAA,UACjB,OAAK,0BAAA,CAA2B,CAAA,EAAG,EAAE,SAAA,EAAW,QAAA,EAAU,CAAA,CAAE;AAAA;AAC9D,OACF;AACA,MAAA,MAAM,uBAAA,GAAA,CAA2B,OAAA,CAAQ,UAAA,IAAc,EAAC,EAAG,MAAA;AAAA,QACzD,CAAA,CAAA,KACE,CAAC,sBAAA,CAAuB,GAAA;AAAA,UACtB,2BAA2B,CAAA,EAAG,EAAE,SAAA,EAAW,QAAA,EAAU,CAAA,CAAE;AAAA;AACzD,OACJ;AACA,MAAA,OAAO,oBAAA,CAAqB;AAAA,QAC1B,GAAG,OAAA;AAAA,QACH,QAAA;AAAA,QACA,EAAA,EAAI,WAAA;AAAA,QACJ,KAAA,EAAO,SAAA,CAAU,KAAA,IAAS,OAAA,CAAQ,KAAA;AAAA,QAClC,IAAA,EAAM,SAAA,CAAU,IAAA,IAAQ,OAAA,CAAQ,IAAA;AAAA,QAChC,UAAA,EAAY,CAAC,GAAG,uBAAA,EAAyB,GAAG,kBAAkB,CAAA;AAAA,QAC9D,IAAA,EAAM;AAAA,UACJ,GAAG,OAAA,CAAQ,IAAA;AAAA,UACX,GAAG,SAAA,CAAU;AAAA;AACf,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"createFrontendPlugin.esm.js","sources":["../../src/wiring/createFrontendPlugin.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 { OpaqueFrontendPlugin } from '@internal/frontend';\nimport {\n  ExtensionDefinition,\n  OverridableExtensionDefinition,\n} from './createExtension';\nimport {\n  resolveExtensionDefinition,\n  resolveExtensionDefinitions,\n} from './resolveExtensionDefinition';\nimport { FeatureFlagConfig } from './types';\nimport { MakeSortedExtensionsMap } from './MakeSortedExtensionsMap';\nimport { JsonObject } from '@backstage/types';\nimport { IconElement } from '../icons/types';\nimport { RouteRef, SubRouteRef, ExternalRouteRef } from '../routing';\nimport { ID_PATTERN } from './constants';\nimport { FilterPredicate } from '@backstage/filter-predicates';\n\n/**\n * Information about the plugin.\n *\n * @public\n * @remarks\n *\n * This interface is intended to be extended via [module\n * augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation)\n * in order to add fields that are specific to each project.\n *\n * For example, one might add a `slackChannel` field that is read from the\n * opaque manifest file.\n *\n * See the options for `createApp` for more information about how to\n * customize the parsing of manifest files.\n */\nexport interface FrontendPluginInfo {\n  /**\n   * The name of the package that implements the plugin.\n   */\n  packageName?: string;\n\n  /**\n   * The version of the plugin, typically the version of the package.json file.\n   */\n  version?: string;\n\n  /**\n   * As short description of the plugin, typically the description field in\n   * package.json.\n   */\n  description?: string;\n\n  /**\n   * The owner entity references of the plugin.\n   */\n  ownerEntityRefs?: string[];\n\n  /**\n   * Links related to the plugin.\n   */\n  links?: Array<{ title: string; url: string }>;\n}\n\n/**\n * Options for providing information for a plugin.\n *\n * @public\n */\nexport type FrontendPluginInfoOptions = {\n  /**\n   * A loader function for the package.json file for the plugin.\n   */\n  packageJson?: () => Promise<{ name: string } & JsonObject>;\n  /**\n   * A loader function for an opaque manifest file for the plugin.\n   */\n  manifest?: () => Promise<JsonObject>;\n};\n\n/**\n * A variant of the {@link FrontendPlugin} interface that can also be used to install overrides for the plugin.\n *\n * @public\n */\nexport interface OverridableFrontendPlugin<\n  TRoutes extends { [name in string]: RouteRef | SubRouteRef } = {\n    [name in string]: RouteRef | SubRouteRef;\n  },\n  TExternalRoutes extends { [name in string]: ExternalRouteRef } = {\n    [name in string]: ExternalRouteRef;\n  },\n  TExtensionMap extends { [id in string]: ExtensionDefinition } = {\n    [id in string]: ExtensionDefinition;\n  },\n> extends FrontendPlugin<TRoutes, TExternalRoutes> {\n  getExtension<TId extends keyof TExtensionMap>(\n    id: TId,\n  ): OverridableExtensionDefinition<TExtensionMap[TId]['T']>;\n  withOverrides(options: {\n    extensions?: Array<ExtensionDefinition>;\n\n    /**\n     * Overrides the shared condition that applies to all extensions in the plugin.\n     */\n    if?: FilterPredicate;\n\n    /**\n     * Overrides the display title of the plugin.\n     */\n    title?: string;\n\n    /**\n     * Overrides the display icon of the plugin.\n     */\n    icon?: IconElement;\n\n    /**\n     * Overrides the original info loaders of the plugin one by one.\n     */\n    info?: FrontendPluginInfoOptions;\n  }): OverridableFrontendPlugin<TRoutes, TExternalRoutes, TExtensionMap>;\n}\n\n/** @public */\nexport interface FrontendPlugin<\n  TRoutes extends { [name in string]: RouteRef | SubRouteRef } = {\n    [name in string]: RouteRef | SubRouteRef;\n  },\n  TExternalRoutes extends { [name in string]: ExternalRouteRef } = {\n    [name in string]: ExternalRouteRef;\n  },\n> {\n  readonly $$type: '@backstage/FrontendPlugin';\n  /**\n   * The plugin ID.\n   */\n  readonly pluginId: string;\n  /**\n   * Deprecated alias for `pluginId`.\n   *\n   * @deprecated Use `pluginId` instead.\n   */\n  readonly id: string;\n  /**\n   * The display title of the plugin, used in page headers and navigation.\n   * Falls back to the plugin ID if not provided.\n   */\n  readonly title?: string;\n  /**\n   * The display icon of the plugin, used in page headers and navigation.\n   */\n  readonly icon?: IconElement;\n  readonly routes: TRoutes;\n  readonly externalRoutes: TExternalRoutes;\n\n  /**\n   * Loads the plugin info.\n   */\n  info(): Promise<FrontendPluginInfo>;\n}\n\n/**\n * Options for {@link createFrontendPlugin}.\n *\n * @public\n */\nexport interface CreateFrontendPluginOptions<\n  TId extends string,\n  TRoutes extends { [name in string]: RouteRef | SubRouteRef },\n  TExternalRoutes extends { [name in string]: ExternalRouteRef },\n  TExtensions extends readonly ExtensionDefinition[],\n> {\n  pluginId: TId;\n  /**\n   * The display title of the plugin, used in page headers and navigation.\n   * Falls back to the plugin ID if not provided.\n   */\n  title?: string;\n  /**\n   * The display icon of the plugin, used in page headers and navigation.\n   */\n  icon?: IconElement;\n  routes?: TRoutes;\n  externalRoutes?: TExternalRoutes;\n  extensions?: TExtensions;\n  featureFlags?: FeatureFlagConfig[];\n  if?: FilterPredicate;\n  info?: FrontendPluginInfoOptions;\n}\n\n/**\n * @deprecated Use {@link CreateFrontendPluginOptions} instead.\n * @public\n */\nexport type PluginOptions<\n  TId extends string,\n  TRoutes extends { [name in string]: RouteRef | SubRouteRef },\n  TExternalRoutes extends { [name in string]: ExternalRouteRef },\n  TExtensions extends readonly ExtensionDefinition[],\n> = CreateFrontendPluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>;\n\n/**\n * Creates a new plugin that can be installed in a Backstage app.\n *\n * @remarks\n *\n * Every plugin is created with a unique ID and a set of extensions\n * that are installed as part of the plugin.\n *\n * For more information on how plugins work, see the\n * {@link https://backstage.io/docs/frontend-system/building-plugins/index | documentation for plugins}\n * in the frontend system documentation.\n *\n * @example\n *\n * ```tsx\n * import { createFrontendPlugin } from '@backstage/frontend-plugin-api';\n *\n * export const examplePlugin = createFrontendPlugin({\n *   pluginId: 'example',\n *   extensions: [\n *     PageBlueprint.make({\n *       path: '/example',\n *       loader: () => import('./ExamplePage').then(m => <m.ExamplePage />),\n *     }),\n *   ],\n * });\n * ```\n *\n * @public\n */\nexport function createFrontendPlugin<\n  TId extends string,\n  TExtensions extends readonly ExtensionDefinition[],\n  TRoutes extends { [name in string]: RouteRef | SubRouteRef } = {},\n  TExternalRoutes extends { [name in string]: ExternalRouteRef } = {},\n>(\n  options: CreateFrontendPluginOptions<\n    TId,\n    TRoutes,\n    TExternalRoutes,\n    TExtensions\n  >,\n): OverridableFrontendPlugin<\n  TRoutes,\n  TExternalRoutes,\n  MakeSortedExtensionsMap<TExtensions[number], TId>\n> {\n  const pluginId = options.pluginId;\n\n  if (!ID_PATTERN.test(pluginId)) {\n    // eslint-disable-next-line no-console\n    console.warn(\n      `WARNING: The pluginId '${pluginId}' will be invalid soon, please change it to match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,\n    );\n  }\n\n  const { extensions, extensionDefinitionsById } = resolveExtensionDefinitions(\n    options.extensions ?? [],\n    {\n      namespace: pluginId,\n      featureType: 'Plugin',\n    },\n  );\n\n  return OpaqueFrontendPlugin.createInstance('v1', {\n    pluginId,\n    id: pluginId,\n    title: options.title,\n    icon: options.icon,\n    routes: options.routes ?? ({} as TRoutes),\n    externalRoutes: options.externalRoutes ?? ({} as TExternalRoutes),\n    featureFlags: options.featureFlags ?? [],\n    if: options.if,\n    extensions: extensions,\n    infoOptions: options.info,\n\n    // This method is overridden when the plugin instance is installed in an app\n    async info() {\n      throw new Error(\n        `Attempted to load plugin info for plugin '${pluginId}', but the plugin instance is not installed in an app`,\n      );\n    },\n    getExtension(id) {\n      const ext = extensionDefinitionsById.get(id);\n      if (!ext) {\n        throw new Error(\n          `Attempted to get non-existent extension '${id}' from plugin '${pluginId}'`,\n        );\n      }\n      return ext;\n    },\n    toString() {\n      return `Plugin{id=${pluginId}}`;\n    },\n    withOverrides(overrides) {\n      let ifPredicate = options.if;\n      if ('if' in overrides) {\n        ifPredicate = overrides.if;\n      }\n      const overrideExtensions = overrides.extensions ?? [];\n      const overriddenExtensionIds = new Set(\n        overrideExtensions.map(\n          e => resolveExtensionDefinition(e, { namespace: pluginId }).id,\n        ),\n      );\n      const nonOverriddenExtensions = (options.extensions ?? []).filter(\n        e =>\n          !overriddenExtensionIds.has(\n            resolveExtensionDefinition(e, { namespace: pluginId }).id,\n          ),\n      );\n      return createFrontendPlugin({\n        ...options,\n        pluginId,\n        if: ifPredicate,\n        title: overrides.title ?? options.title,\n        icon: overrides.icon ?? options.icon,\n        extensions: [...nonOverriddenExtensions, ...overrideExtensions],\n        info: {\n          ...options.info,\n          ...overrides.info,\n        },\n      });\n    },\n  });\n}\n"],"names":[],"mappings":";;;;;;;AAqPO,SAAS,qBAMd,OAAA,EAUA;AACA,EAAA,MAAM,WAAW,OAAA,CAAQ,QAAA;AAEzB,EAAA,IAAI,CAAC,UAAA,CAAW,IAAA,CAAK,QAAQ,CAAA,EAAG;AAE9B,IAAA,OAAA,CAAQ,IAAA;AAAA,MACN,CAAA,uBAAA,EAA0B,QAAQ,CAAA,8DAAA,EAAiE,UAAU,CAAA,2DAAA;AAAA,KAC/G;AAAA,EACF;AAEA,EAAA,MAAM,EAAE,UAAA,EAAY,wBAAA,EAAyB,GAAI,2BAAA;AAAA,IAC/C,OAAA,CAAQ,cAAc,EAAC;AAAA,IACvB;AAAA,MACE,SAAA,EAAW,QAAA;AAAA,MACX,WAAA,EAAa;AAAA;AACf,GACF;AAEA,EAAA,OAAO,oBAAA,CAAqB,eAAe,IAAA,EAAM;AAAA,IAC/C,QAAA;AAAA,IACA,EAAA,EAAI,QAAA;AAAA,IACJ,OAAO,OAAA,CAAQ,KAAA;AAAA,IACf,MAAM,OAAA,CAAQ,IAAA;AAAA,IACd,MAAA,EAAQ,OAAA,CAAQ,MAAA,IAAW,EAAC;AAAA,IAC5B,cAAA,EAAgB,OAAA,CAAQ,cAAA,IAAmB,EAAC;AAAA,IAC5C,YAAA,EAAc,OAAA,CAAQ,YAAA,IAAgB,EAAC;AAAA,IACvC,IAAI,OAAA,CAAQ,EAAA;AAAA,IACZ,UAAA;AAAA,IACA,aAAa,OAAA,CAAQ,IAAA;AAAA;AAAA,IAGrB,MAAM,IAAA,GAAO;AACX,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,6CAA6C,QAAQ,CAAA,qDAAA;AAAA,OACvD;AAAA,IACF,CAAA;AAAA,IACA,aAAa,EAAA,EAAI;AACf,MAAA,MAAM,GAAA,GAAM,wBAAA,CAAyB,GAAA,CAAI,EAAE,CAAA;AAC3C,MAAA,IAAI,CAAC,GAAA,EAAK;AACR,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,yCAAA,EAA4C,EAAE,CAAA,eAAA,EAAkB,QAAQ,CAAA,CAAA;AAAA,SAC1E;AAAA,MACF;AACA,MAAA,OAAO,GAAA;AAAA,IACT,CAAA;AAAA,IACA,QAAA,GAAW;AACT,MAAA,OAAO,aAAa,QAAQ,CAAA,CAAA,CAAA;AAAA,IAC9B,CAAA;AAAA,IACA,cAAc,SAAA,EAAW;AACvB,MAAA,IAAI,cAAc,OAAA,CAAQ,EAAA;AAC1B,MAAA,IAAI,QAAQ,SAAA,EAAW;AACrB,QAAA,WAAA,GAAc,SAAA,CAAU,EAAA;AAAA,MAC1B;AACA,MAAA,MAAM,kBAAA,GAAqB,SAAA,CAAU,UAAA,IAAc,EAAC;AACpD,MAAA,MAAM,yBAAyB,IAAI,GAAA;AAAA,QACjC,kBAAA,CAAmB,GAAA;AAAA,UACjB,OAAK,0BAAA,CAA2B,CAAA,EAAG,EAAE,SAAA,EAAW,QAAA,EAAU,CAAA,CAAE;AAAA;AAC9D,OACF;AACA,MAAA,MAAM,uBAAA,GAAA,CAA2B,OAAA,CAAQ,UAAA,IAAc,EAAC,EAAG,MAAA;AAAA,QACzD,CAAA,CAAA,KACE,CAAC,sBAAA,CAAuB,GAAA;AAAA,UACtB,2BAA2B,CAAA,EAAG,EAAE,SAAA,EAAW,QAAA,EAAU,CAAA,CAAE;AAAA;AACzD,OACJ;AACA,MAAA,OAAO,oBAAA,CAAqB;AAAA,QAC1B,GAAG,OAAA;AAAA,QACH,QAAA;AAAA,QACA,EAAA,EAAI,WAAA;AAAA,QACJ,KAAA,EAAO,SAAA,CAAU,KAAA,IAAS,OAAA,CAAQ,KAAA;AAAA,QAClC,IAAA,EAAM,SAAA,CAAU,IAAA,IAAQ,OAAA,CAAQ,IAAA;AAAA,QAChC,UAAA,EAAY,CAAC,GAAG,uBAAA,EAAyB,GAAG,kBAAkB,CAAA;AAAA,QAC9D,IAAA,EAAM;AAAA,UACJ,GAAG,OAAA,CAAQ,IAAA;AAAA,UACX,GAAG,SAAA,CAAU;AAAA;AACf,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/wiring/resolveExtensionDefinition.esm.js

@@ -46,6 +46,33 @@ function resolveAttachTo(attachTo, namespace) {
   }
   return resolveSpec(attachTo);
 }
+function resolveExtensionDefinitions(definitions, context) {
+  const extensions = new Array();
+  const extensionDefinitionsById = /* @__PURE__ */ new Map();
+  for (const def of definitions) {
+    const internal = OpaqueExtensionDefinition.toInternal(def);
+    const ext = resolveExtensionDefinition(def, {
+      namespace: context.namespace
+    });
+    extensions.push(ext);
+    extensionDefinitionsById.set(ext.id, {
+      ...internal,
+      namespace: context.namespace
+    });
+  }
+  if (extensions.length !== extensionDefinitionsById.size) {
+    const extensionIds = extensions.map((e) => e.id);
+    const duplicates = Array.from(
+      new Set(
+        extensionIds.filter((id, index) => extensionIds.indexOf(id) !== index)
+      )
+    );
+    throw new Error(
+      `${context.featureType} '${context.namespace}' provided duplicate extensions: ${duplicates.join(", ")}`
+    );
+  }
+  return { extensions, extensionDefinitionsById };
+}
 function resolveExtensionDefinition(definition, context) {
   const internalDefinition = OpaqueExtensionDefinition.toInternal(definition);
   const {
@@ -70,5 +97,5 @@ function resolveExtensionDefinition(definition, context) {
   };
 }
 
-export { resolveExtensionDefinition };
+export { resolveExtensionDefinition, resolveExtensionDefinitions };
 //# sourceMappingURL=resolveExtensionDefinition.esm.js.map

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  ExtensionDefinitionAttachTo,\n  ExtensionDefinition,\n  ExtensionDefinitionParameters,\n  ResolvedExtensionInputs,\n} from './createExtension';\nimport { PortableSchema } from '../schema';\nimport { ExtensionInput } from './createExtensionInput';\nimport { ExtensionDataRef, ExtensionDataValue } from './createExtensionDataRef';\nimport {\n  OpaqueExtensionDefinition,\n  OpaqueExtensionInput,\n} from '@internal/frontend';\nimport { FilterPredicate } from '@backstage/filter-predicates';\n\n/** @public */\nexport type ExtensionAttachTo = { id: string; input: string };\n\n/** @public */\nexport interface Extension<TConfig, TConfigInput = TConfig> {\n  $$type: '@backstage/Extension';\n  readonly id: string;\n  readonly attachTo: ExtensionAttachTo;\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]: ExtensionDataRef;\n            };\n            config: { optional: boolean; singleton: boolean };\n          };\n        };\n        readonly output: {\n          [name in string]: ExtensionDataRef;\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 if?: FilterPredicate;\n        readonly inputs: { [inputName in string]: ExtensionInput };\n        readonly output: Array<ExtensionDataRef>;\n        factory(options: {\n          apis: ApiHolder;\n          node: AppNode;\n          config: TConfig;\n          inputs: ResolvedExtensionInputs<{\n            [inputName in string]: ExtensionInput;\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\nfunction resolveExtensionId(\n  kind?: string,\n  namespace?: string,\n  name?: string,\n): string {\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  return kind ? `${kind}:${namePart}` : namePart;\n}\n\nfunction resolveAttachTo(\n  attachTo: ExtensionDefinitionAttachTo | ExtensionDefinitionAttachTo[],\n  namespace?: string,\n): ExtensionAttachTo | ExtensionAttachTo[] {\n  const resolveSpec = (\n    spec: ExtensionDefinitionAttachTo,\n  ): { id: string; input: string } => {\n    if (OpaqueExtensionInput.isType(spec)) {\n      const { context } = OpaqueExtensionInput.toInternal(spec);\n      if (!context) {\n        throw new Error(\n          'Invalid input object without a parent extension used as attachment point',\n        );\n      }\n      return {\n        id: resolveExtensionId(context.kind, namespace, context.name),\n        input: context.input,\n      };\n    }\n    if ('relative' in spec && spec.relative) {\n      return {\n        id: resolveExtensionId(\n          spec.relative.kind,\n          namespace,\n          spec.relative.name,\n        ),\n        input: spec.input,\n      };\n    }\n    if ('id' in spec) {\n      return { id: spec.id, input: spec.input };\n    }\n    throw new Error('Invalid attachment point specification');\n  };\n\n  if (Array.isArray(attachTo)) {\n    return attachTo.map(resolveSpec);\n  }\n\n  return resolveSpec(attachTo);\n}\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\n  const {\n    name,\n    kind,\n    namespace: internalNamespace,\n    override: _skip2,\n    attachTo,\n    ...rest\n  } = internalDefinition;\n\n  const namespace = internalNamespace ?? context?.namespace;\n  const id = resolveExtensionId(kind, namespace, name);\n\n  return {\n    ...rest,\n    attachTo: resolveAttachTo(attachTo, namespace) as ExtensionAttachTo,\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":";;;;;AAgIA,SAAS,kBAAA,CACP,IAAA,EACA,SAAA,EACA,IAAA,EACQ;AACR,EAAA,MAAM,QAAA,GACJ,QAAQ,SAAA,GAAY,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,KAAK,SAAA,IAAa,IAAA;AAC5D,EAAA,IAAI,CAAC,QAAA,EAAU;AACb,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,oGAAA,EAAuG,IAAI,CAAA,WAAA,EAAc,SAAS,SAAS,IAAI,CAAA;AAAA,KACjJ;AAAA,EACF;AAEA,EAAA,OAAO,IAAA,GAAO,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,QAAQ,CAAA,CAAA,GAAK,QAAA;AACxC;AAEA,SAAS,eAAA,CACP,UACA,SAAA,EACyC;AACzC,EAAA,MAAM,WAAA,GAAc,CAClB,IAAA,KACkC;AAClC,IAAA,IAAI,oBAAA,CAAqB,MAAA,CAAO,IAAI,CAAA,EAAG;AACrC,MAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,oBAAA,CAAqB,WAAW,IAAI,CAAA;AACxD,MAAA,IAAI,CAAC,OAAA,EAAS;AACZ,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AACA,MAAA,OAAO;AAAA,QACL,IAAI,kBAAA,CAAmB,OAAA,CAAQ,IAAA,EAAM,SAAA,EAAW,QAAQ,IAAI,CAAA;AAAA,QAC5D,OAAO,OAAA,CAAQ;AAAA,OACjB;AAAA,IACF;AACA,IAAA,IAAI,UAAA,IAAc,IAAA,IAAQ,IAAA,CAAK,QAAA,EAAU;AACvC,MAAA,OAAO;AAAA,QACL,EAAA,EAAI,kBAAA;AAAA,UACF,KAAK,QAAA,CAAS,IAAA;AAAA,UACd,SAAA;AAAA,UACA,KAAK,QAAA,CAAS;AAAA,SAChB;AAAA,QACA,OAAO,IAAA,CAAK;AAAA,OACd;AAAA,IACF;AACA,IAAA,IAAI,QAAQ,IAAA,EAAM;AAChB,MAAA,OAAO,EAAE,EAAA,EAAI,IAAA,CAAK,EAAA,EAAI,KAAA,EAAO,KAAK,KAAA,EAAM;AAAA,IAC1C;AACA,IAAA,MAAM,IAAI,MAAM,wCAAwC,CAAA;AAAA,EAC1D,CAAA;AAEA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,QAAQ,CAAA,EAAG;AAC3B,IAAA,OAAO,QAAA,CAAS,IAAI,WAAW,CAAA;AAAA,EACjC;AAEA,EAAA,OAAO,YAAY,QAAQ,CAAA;AAC7B;AAGO,SAAS,0BAAA,CAGd,YACA,OAAA,EAC0C;AAC1C,EAAA,MAAM,kBAAA,GAAqB,yBAAA,CAA0B,UAAA,CAAW,UAAU,CAAA;AAE1E,EAAA,MAAM;AAAA,IACJ,IAAA;AAAA,IACA,IAAA;AAAA,IACA,SAAA,EAAW,iBAAA;AAAA,IACX,QAAA,EAAU,MAAA;AAAA,IACV,QAAA;AAAA,IACA,GAAG;AAAA,GACL,GAAI,kBAAA;AAEJ,EAAA,MAAM,SAAA,GAAY,qBAAqB,OAAA,EAAS,SAAA;AAChD,EAAA,MAAM,EAAA,GAAK,kBAAA,CAAmB,IAAA,EAAM,SAAA,EAAW,IAAI,CAAA;AAEnD,EAAA,OAAO;AAAA,IACL,GAAG,IAAA;AAAA,IACH,QAAA,EAAU,eAAA,CAAgB,QAAA,EAAU,SAAS,CAAA;AAAA,IAC7C,MAAA,EAAQ,sBAAA;AAAA,IACR,SAAS,kBAAA,CAAmB,OAAA;AAAA,IAC5B,EAAA;AAAA,IACA,QAAA,GAAW;AACT,MAAA,OAAO,gBAAgB,EAAE,CAAA,CAAA,CAAA;AAAA,IAC3B;AAAA,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  ExtensionDefinitionAttachTo,\n  ExtensionDefinition,\n  ExtensionDefinitionParameters,\n  ResolvedExtensionInputs,\n} from './createExtension';\nimport { PortableSchema } from '../schema';\nimport { ExtensionInput } from './createExtensionInput';\nimport { ExtensionDataRef, ExtensionDataValue } from './createExtensionDataRef';\nimport {\n  OpaqueExtensionDefinition,\n  OpaqueExtensionInput,\n} from '@internal/frontend';\nimport { FilterPredicate } from '@backstage/filter-predicates';\n\n/** @public */\nexport type ExtensionAttachTo = { id: string; input: string };\n\n/** @public */\nexport interface Extension<TConfig, TConfigInput = TConfig> {\n  $$type: '@backstage/Extension';\n  readonly id: string;\n  readonly attachTo: ExtensionAttachTo;\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]: ExtensionDataRef;\n            };\n            config: { optional: boolean; singleton: boolean };\n          };\n        };\n        readonly output: {\n          [name in string]: ExtensionDataRef;\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 if?: FilterPredicate;\n        readonly inputs: { [inputName in string]: ExtensionInput };\n        readonly output: Array<ExtensionDataRef>;\n        factory(options: {\n          apis: ApiHolder;\n          node: AppNode;\n          config: TConfig;\n          inputs: ResolvedExtensionInputs<{\n            [inputName in string]: ExtensionInput;\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\nfunction resolveExtensionId(\n  kind?: string,\n  namespace?: string,\n  name?: string,\n): string {\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  return kind ? `${kind}:${namePart}` : namePart;\n}\n\nfunction resolveAttachTo(\n  attachTo: ExtensionDefinitionAttachTo | ExtensionDefinitionAttachTo[],\n  namespace?: string,\n): ExtensionAttachTo | ExtensionAttachTo[] {\n  const resolveSpec = (\n    spec: ExtensionDefinitionAttachTo,\n  ): { id: string; input: string } => {\n    if (OpaqueExtensionInput.isType(spec)) {\n      const { context } = OpaqueExtensionInput.toInternal(spec);\n      if (!context) {\n        throw new Error(\n          'Invalid input object without a parent extension used as attachment point',\n        );\n      }\n      return {\n        id: resolveExtensionId(context.kind, namespace, context.name),\n        input: context.input,\n      };\n    }\n    if ('relative' in spec && spec.relative) {\n      return {\n        id: resolveExtensionId(\n          spec.relative.kind,\n          namespace,\n          spec.relative.name,\n        ),\n        input: spec.input,\n      };\n    }\n    if ('id' in spec) {\n      return { id: spec.id, input: spec.input };\n    }\n    throw new Error('Invalid attachment point specification');\n  };\n\n  if (Array.isArray(attachTo)) {\n    return attachTo.map(resolveSpec);\n  }\n\n  return resolveSpec(attachTo);\n}\n\n/**\n * Resolves a list of extension definitions into extensions, returning both the\n * resolved extensions and a map of extension definitions keyed by resolved ID.\n * Throws if any two definitions resolve to the same ID.\n *\n * @internal\n */\nexport function resolveExtensionDefinitions(\n  definitions: Iterable<ExtensionDefinition>,\n  context: { namespace: string; featureType: string },\n): {\n  extensions: Extension<any>[];\n  extensionDefinitionsById: Map<\n    string,\n    typeof OpaqueExtensionDefinition.TInternal\n  >;\n} {\n  const extensions = new Array<Extension<any>>();\n  const extensionDefinitionsById = new Map<\n    string,\n    typeof OpaqueExtensionDefinition.TInternal\n  >();\n\n  for (const def of definitions) {\n    const internal = OpaqueExtensionDefinition.toInternal(def);\n    const ext = resolveExtensionDefinition(def, {\n      namespace: context.namespace,\n    });\n    extensions.push(ext);\n    extensionDefinitionsById.set(ext.id, {\n      ...internal,\n      namespace: context.namespace,\n    });\n  }\n\n  if (extensions.length !== extensionDefinitionsById.size) {\n    const extensionIds = extensions.map(e => e.id);\n    const duplicates = Array.from(\n      new Set(\n        extensionIds.filter((id, index) => extensionIds.indexOf(id) !== index),\n      ),\n    );\n    throw new Error(\n      `${context.featureType} '${\n        context.namespace\n      }' provided duplicate extensions: ${duplicates.join(', ')}`,\n    );\n  }\n\n  return { extensions, extensionDefinitionsById };\n}\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\n  const {\n    name,\n    kind,\n    namespace: internalNamespace,\n    override: _skip2,\n    attachTo,\n    ...rest\n  } = internalDefinition;\n\n  const namespace = internalNamespace ?? context?.namespace;\n  const id = resolveExtensionId(kind, namespace, name);\n\n  return {\n    ...rest,\n    attachTo: resolveAttachTo(attachTo, namespace) as ExtensionAttachTo,\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":";;;;;AAgIA,SAAS,kBAAA,CACP,IAAA,EACA,SAAA,EACA,IAAA,EACQ;AACR,EAAA,MAAM,QAAA,GACJ,QAAQ,SAAA,GAAY,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,KAAK,SAAA,IAAa,IAAA;AAC5D,EAAA,IAAI,CAAC,QAAA,EAAU;AACb,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,oGAAA,EAAuG,IAAI,CAAA,WAAA,EAAc,SAAS,SAAS,IAAI,CAAA;AAAA,KACjJ;AAAA,EACF;AAEA,EAAA,OAAO,IAAA,GAAO,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,QAAQ,CAAA,CAAA,GAAK,QAAA;AACxC;AAEA,SAAS,eAAA,CACP,UACA,SAAA,EACyC;AACzC,EAAA,MAAM,WAAA,GAAc,CAClB,IAAA,KACkC;AAClC,IAAA,IAAI,oBAAA,CAAqB,MAAA,CAAO,IAAI,CAAA,EAAG;AACrC,MAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,oBAAA,CAAqB,WAAW,IAAI,CAAA;AACxD,MAAA,IAAI,CAAC,OAAA,EAAS;AACZ,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AACA,MAAA,OAAO;AAAA,QACL,IAAI,kBAAA,CAAmB,OAAA,CAAQ,IAAA,EAAM,SAAA,EAAW,QAAQ,IAAI,CAAA;AAAA,QAC5D,OAAO,OAAA,CAAQ;AAAA,OACjB;AAAA,IACF;AACA,IAAA,IAAI,UAAA,IAAc,IAAA,IAAQ,IAAA,CAAK,QAAA,EAAU;AACvC,MAAA,OAAO;AAAA,QACL,EAAA,EAAI,kBAAA;AAAA,UACF,KAAK,QAAA,CAAS,IAAA;AAAA,UACd,SAAA;AAAA,UACA,KAAK,QAAA,CAAS;AAAA,SAChB;AAAA,QACA,OAAO,IAAA,CAAK;AAAA,OACd;AAAA,IACF;AACA,IAAA,IAAI,QAAQ,IAAA,EAAM;AAChB,MAAA,OAAO,EAAE,EAAA,EAAI,IAAA,CAAK,EAAA,EAAI,KAAA,EAAO,KAAK,KAAA,EAAM;AAAA,IAC1C;AACA,IAAA,MAAM,IAAI,MAAM,wCAAwC,CAAA;AAAA,EAC1D,CAAA;AAEA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,QAAQ,CAAA,EAAG;AAC3B,IAAA,OAAO,QAAA,CAAS,IAAI,WAAW,CAAA;AAAA,EACjC;AAEA,EAAA,OAAO,YAAY,QAAQ,CAAA;AAC7B;AASO,SAAS,2BAAA,CACd,aACA,OAAA,EAOA;AACA,EAAA,MAAM,UAAA,GAAa,IAAI,KAAA,EAAsB;AAC7C,EAAA,MAAM,wBAAA,uBAA+B,GAAA,EAGnC;AAEF,EAAA,KAAA,MAAW,OAAO,WAAA,EAAa;AAC7B,IAAA,MAAM,QAAA,GAAW,yBAAA,CAA0B,UAAA,CAAW,GAAG,CAAA;AACzD,IAAA,MAAM,GAAA,GAAM,2BAA2B,GAAA,EAAK;AAAA,MAC1C,WAAW,OAAA,CAAQ;AAAA,KACpB,CAAA;AACD,IAAA,UAAA,CAAW,KAAK,GAAG,CAAA;AACnB,IAAA,wBAAA,CAAyB,GAAA,CAAI,IAAI,EAAA,EAAI;AAAA,MACnC,GAAG,QAAA;AAAA,MACH,WAAW,OAAA,CAAQ;AAAA,KACpB,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,UAAA,CAAW,MAAA,KAAW,wBAAA,CAAyB,IAAA,EAAM;AACvD,IAAA,MAAM,YAAA,GAAe,UAAA,CAAW,GAAA,CAAI,CAAA,CAAA,KAAK,EAAE,EAAE,CAAA;AAC7C,IAAA,MAAM,aAAa,KAAA,CAAM,IAAA;AAAA,MACvB,IAAI,GAAA;AAAA,QACF,YAAA,CAAa,OAAO,CAAC,EAAA,EAAI,UAAU,YAAA,CAAa,OAAA,CAAQ,EAAE,CAAA,KAAM,KAAK;AAAA;AACvE,KACF;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,EAAG,OAAA,CAAQ,WAAW,CAAA,EAAA,EACpB,OAAA,CAAQ,SACV,CAAA,iCAAA,EAAoC,UAAA,CAAW,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,KAC3D;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,YAAY,wBAAA,EAAyB;AAChD;AAGO,SAAS,0BAAA,CAGd,YACA,OAAA,EAC0C;AAC1C,EAAA,MAAM,kBAAA,GAAqB,yBAAA,CAA0B,UAAA,CAAW,UAAU,CAAA;AAE1E,EAAA,MAAM;AAAA,IACJ,IAAA;AAAA,IACA,IAAA;AAAA,IACA,SAAA,EAAW,iBAAA;AAAA,IACX,QAAA,EAAU,MAAA;AAAA,IACV,QAAA;AAAA,IACA,GAAG;AAAA,GACL,GAAI,kBAAA;AAEJ,EAAA,MAAM,SAAA,GAAY,qBAAqB,OAAA,EAAS,SAAA;AAChD,EAAA,MAAM,EAAA,GAAK,kBAAA,CAAmB,IAAA,EAAM,SAAA,EAAW,IAAI,CAAA;AAEnD,EAAA,OAAO;AAAA,IACL,GAAG,IAAA;AAAA,IACH,QAAA,EAAU,eAAA,CAAgB,QAAA,EAAU,SAAS,CAAA;AAAA,IAC7C,MAAA,EAAQ,sBAAA;AAAA,IACR,SAAS,kBAAA,CAAmB,OAAA;AAAA,IAC5B,EAAA;AAAA,IACA,QAAA,GAAW;AACT,MAAA,OAAO,gBAAgB,EAAE,CAAA,CAAA,CAAA;AAAA,IAC3B;AAAA,GACF;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/frontend-plugin-api",
-  "version": "0.16.0-next.2",
+  "version": "0.16.0",
   "backstage": {
     "role": "web-library"
   },
@@ -52,19 +52,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/errors": "1.3.0-next.0",
-    "@backstage/filter-predicates": "0.1.2-next.0",
-    "@backstage/types": "1.2.2",
-    "@backstage/version-bridge": "1.0.12",
+    "@backstage/errors": "^1.3.0",
+    "@backstage/filter-predicates": "^0.1.2",
+    "@backstage/types": "^1.2.2",
+    "@backstage/version-bridge": "^1.0.12",
+    "@standard-schema/spec": "^1.1.0",
     "zod": "^3.25.76 || ^4.0.0",
     "zod-to-json-schema": "^3.25.1"
   },
   "devDependencies": {
-    "@backstage/cli": "0.36.1-next.2",
-    "@backstage/config": "1.3.7-next.0",
-    "@backstage/frontend-app-api": "0.16.2-next.2",
-    "@backstage/frontend-test-utils": "0.5.2-next.2",
-    "@backstage/test-utils": "1.7.17-next.2",
+    "@backstage/cli": "^0.36.1",
+    "@backstage/config": "^1.3.7",
+    "@backstage/frontend-app-api": "^0.16.2",
+    "@backstage/frontend-test-utils": "^0.5.2",
+    "@backstage/test-utils": "^1.7.17",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
     "@types/react": "^18.0.0",

package/dist/schema/createSchemaFromZod.esm.js

@@ -1,34 +0,0 @@
-import { z } from 'zod/v3';
-import zodToJsonSchema from 'zod-to-json-schema';
-
-function createSchemaFromZod(schemaCreator) {
-  const schema = schemaCreator(z);
-  return {
-    // TODO: Types allow z.array etc here but it will break stuff
-    parse: (input) => {
-      const result = schema.safeParse(input);
-      if (result.success) {
-        return result.data;
-      }
-      throw new Error(result.error.issues.map(formatIssue).join("; "));
-    },
-    // TODO: Verify why we are not compatible with the latest zodToJsonSchema.
-    schema: zodToJsonSchema(schema)
-  };
-}
-function formatIssue(issue) {
-  if (issue.code === "invalid_union") {
-    return formatIssue(issue.unionErrors[0].issues[0]);
-  }
-  let message = issue.message;
-  if (message === "Required") {
-    message = `Missing required value`;
-  }
-  if (issue.path.length) {
-    message += ` at '${issue.path.join(".")}'`;
-  }
-  return message;
-}
-
-export { createSchemaFromZod };
-//# sourceMappingURL=createSchemaFromZod.esm.js.map

package/dist/schema/createSchemaFromZod.esm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createSchemaFromZod.esm.js","sources":["../../src/schema/createSchemaFromZod.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 { JsonObject } from '@backstage/types';\nimport { z, type ZodIssue, type ZodType } from 'zod/v3';\nimport zodToJsonSchema from 'zod-to-json-schema';\nimport { PortableSchema } from './types';\n\n/**\n * @internal\n */\nexport function createSchemaFromZod<TSchema extends ZodType>(\n  schemaCreator: (zImpl: typeof z) => TSchema,\n): PortableSchema<z.output<TSchema>, z.input<TSchema>> {\n  const schema = schemaCreator(z);\n  return {\n    // TODO: Types allow z.array etc here but it will break stuff\n    parse: input => {\n      const result = schema.safeParse(input);\n      if (result.success) {\n        return result.data;\n      }\n\n      throw new Error(result.error.issues.map(formatIssue).join('; '));\n    },\n    // TODO: Verify why we are not compatible with the latest zodToJsonSchema.\n    schema: zodToJsonSchema(schema) as JsonObject,\n  };\n}\n\nfunction formatIssue(issue: ZodIssue): string {\n  if (issue.code === 'invalid_union') {\n    return formatIssue(issue.unionErrors[0].issues[0]);\n  }\n  let message = issue.message;\n  if (message === 'Required') {\n    message = `Missing required value`;\n  }\n  if (issue.path.length) {\n    message += ` at '${issue.path.join('.')}'`;\n  }\n  return message;\n}\n"],"names":[],"mappings":";;;AAwBO,SAAS,oBACd,aAAA,EACqD;AACrD,EAAA,MAAM,MAAA,GAAS,cAAc,CAAC,CAAA;AAC9B,EAAA,OAAO;AAAA;AAAA,IAEL,OAAO,CAAA,KAAA,KAAS;AACd,MAAA,MAAM,MAAA,GAAS,MAAA,CAAO,SAAA,CAAU,KAAK,CAAA;AACrC,MAAA,IAAI,OAAO,OAAA,EAAS;AAClB,QAAA,OAAO,MAAA,CAAO,IAAA;AAAA,MAChB;AAEA,MAAA,MAAM,IAAI,KAAA,CAAM,MAAA,CAAO,KAAA,CAAM,MAAA,CAAO,IAAI,WAAW,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,IACjE,CAAA;AAAA;AAAA,IAEA,MAAA,EAAQ,gBAAgB,MAAM;AAAA,GAChC;AACF;AAEA,SAAS,YAAY,KAAA,EAAyB;AAC5C,EAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,IAAA,OAAO,YAAY,KAAA,CAAM,WAAA,CAAY,CAAC,CAAA,CAAE,MAAA,CAAO,CAAC,CAAC,CAAA;AAAA,EACnD;AACA,EAAA,IAAI,UAAU,KAAA,CAAM,OAAA;AACpB,EAAA,IAAI,YAAY,UAAA,EAAY;AAC1B,IAAA,OAAA,GAAU,CAAA,sBAAA,CAAA;AAAA,EACZ;AACA,EAAA,IAAI,KAAA,CAAM,KAAK,MAAA,EAAQ;AACrB,IAAA,OAAA,IAAW,CAAA,KAAA,EAAQ,KAAA,CAAM,IAAA,CAAK,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA,CAAA;AAAA,EACzC;AACA,EAAA,OAAO,OAAA;AACT;;;;"}