@backstage/frontend-plugin-api 0.12.2-next.1 → 0.12.2-next.2

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @backstage/frontend-plugin-api
 
+## 0.12.2-next.2
+
+### Patch Changes
+
+- 7c6a66d: Added support for plugin-relative `attachTo` declarations for extension definitions. This allows for the creation of extension and extension blueprints that attach to other extensions of a particular `kind` in the same plugin, rather than needing to provide the exact extension ID. This is particularly useful when wanting to provide extension blueprints with a built-in hierarchy where the extensions created from one blueprint attach to extensions created from the other blueprint, for example:
+
+  ```ts
+  // kind: 'tabbed-page'
+  const parentPage = TabbedPageBlueprint.make({
+    params: {....}
+  })
+  // attachTo: { kind: 'tabbed-page', input: 'tabs' }
+  const child1 = TabContentBlueprint.make({
+    name: 'tab1',
+    params: {....}
+  })
+  ```
+
+- Updated dependencies
+  - @backstage/core-components@0.18.3-next.2
+
 ## 0.12.2-next.1
 
 ### Patch Changes

package/dist/apis/definitions/AppTreeApi.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppTreeApi.esm.js","sources":["../../../src/apis/definitions/AppTreeApi.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 { createApiRef } from '@backstage/core-plugin-api';\nimport {\n  FrontendPlugin,\n  Extension,\n  ExtensionDataRef,\n  ExtensionAttachToSpec,\n} from '../../wiring';\n\n/**\n * The specification for this {@link AppNode} in the {@link AppTree}.\n *\n * @public\n * @remarks\n *\n * The specifications for a collection of app nodes is all the information needed\n * to build the tree and instantiate the nodes.\n */\nexport interface AppNodeSpec {\n  readonly id: string;\n  readonly attachTo: ExtensionAttachToSpec;\n  readonly extension: Extension<unknown, unknown>;\n  readonly disabled: boolean;\n  readonly config?: unknown;\n  readonly plugin: FrontendPlugin;\n}\n\n/**\n * The connections from this {@link AppNode} to other nodes.\n *\n * @public\n * @remarks\n *\n * The app node edges are resolved based on the app node specs, regardless of whether\n * adjacent nodes are disabled or not. If no parent attachment is present or\n */\nexport interface AppNodeEdges {\n  readonly attachedTo?: { node: AppNode; input: string };\n  readonly attachments: ReadonlyMap<string, AppNode[]>;\n}\n\n/**\n * The instance of this {@link AppNode} in the {@link AppTree}.\n *\n * @public\n * @remarks\n *\n * The app node instance is created when the `factory` function of an extension is called.\n * Instances will only be present for nodes in the app that are connected to the root\n * node and not disabled\n */\nexport interface AppNodeInstance {\n  /** Returns a sequence of all extension data refs that were output by this instance */\n  getDataRefs(): Iterable<ExtensionDataRef<unknown>>;\n  /** Get the output data for a single extension data ref */\n  getData<T>(ref: ExtensionDataRef<T>): T | undefined;\n}\n\n/**\n * A node in the {@link AppTree}.\n *\n * @public\n */\nexport interface AppNode {\n  /** The specification for how this node should be instantiated */\n  readonly spec: AppNodeSpec;\n  /** The edges from this node to other nodes in the app tree */\n  readonly edges: AppNodeEdges;\n  /** The instance of this node, if it was instantiated */\n  readonly instance?: AppNodeInstance;\n}\n\n/**\n * The app tree containing all {@link AppNode}s of the app.\n *\n * @public\n */\nexport interface AppTree {\n  /** The root node of the app */\n  readonly root: AppNode;\n  /** A map of all nodes in the app by ID, including orphaned or disabled nodes */\n  readonly nodes: ReadonlyMap<string /* id */, AppNode>;\n  /** A sequence of all nodes with a parent that is not reachable from the app root node */\n  readonly orphans: Iterable<AppNode>;\n}\n\n/**\n * The API for interacting with the {@link AppTree}.\n *\n * @public\n */\nexport interface AppTreeApi {\n  /**\n   * Get the {@link AppTree} for the app.\n   */\n  getTree(): { tree: AppTree };\n\n  /**\n   * Get all nodes in the app that are mounted at a given route path.\n   */\n  getNodesByRoutePath(routePath: string): { nodes: AppNode[] };\n}\n\n/**\n * The `ApiRef` of {@link AppTreeApi}.\n *\n * @public\n */\nexport const appTreeApiRef = createApiRef<AppTreeApi>({ id: 'core.app-tree' });\n"],"names":[],"mappings":";;AA2HO,MAAM,aAAA,GAAgB,YAAA,CAAyB,EAAE,EAAA,EAAI,iBAAiB;;;;"}
+{"version":3,"file":"AppTreeApi.esm.js","sources":["../../../src/apis/definitions/AppTreeApi.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 { createApiRef } from '@backstage/core-plugin-api';\nimport { FrontendPlugin, Extension, ExtensionDataRef } from '../../wiring';\nimport { ExtensionAttachTo } from '../../wiring/resolveExtensionDefinition';\n\n/**\n * The specification for this {@link AppNode} in the {@link AppTree}.\n *\n * @public\n * @remarks\n *\n * The specifications for a collection of app nodes is all the information needed\n * to build the tree and instantiate the nodes.\n */\nexport interface AppNodeSpec {\n  readonly id: string;\n  readonly attachTo: ExtensionAttachTo;\n  readonly extension: Extension<unknown, unknown>;\n  readonly disabled: boolean;\n  readonly config?: unknown;\n  readonly plugin: FrontendPlugin;\n}\n\n/**\n * The connections from this {@link AppNode} to other nodes.\n *\n * @public\n * @remarks\n *\n * The app node edges are resolved based on the app node specs, regardless of whether\n * adjacent nodes are disabled or not. If no parent attachment is present or\n */\nexport interface AppNodeEdges {\n  readonly attachedTo?: { node: AppNode; input: string };\n  readonly attachments: ReadonlyMap<string, AppNode[]>;\n}\n\n/**\n * The instance of this {@link AppNode} in the {@link AppTree}.\n *\n * @public\n * @remarks\n *\n * The app node instance is created when the `factory` function of an extension is called.\n * Instances will only be present for nodes in the app that are connected to the root\n * node and not disabled\n */\nexport interface AppNodeInstance {\n  /** Returns a sequence of all extension data refs that were output by this instance */\n  getDataRefs(): Iterable<ExtensionDataRef<unknown>>;\n  /** Get the output data for a single extension data ref */\n  getData<T>(ref: ExtensionDataRef<T>): T | undefined;\n}\n\n/**\n * A node in the {@link AppTree}.\n *\n * @public\n */\nexport interface AppNode {\n  /** The specification for how this node should be instantiated */\n  readonly spec: AppNodeSpec;\n  /** The edges from this node to other nodes in the app tree */\n  readonly edges: AppNodeEdges;\n  /** The instance of this node, if it was instantiated */\n  readonly instance?: AppNodeInstance;\n}\n\n/**\n * The app tree containing all {@link AppNode}s of the app.\n *\n * @public\n */\nexport interface AppTree {\n  /** The root node of the app */\n  readonly root: AppNode;\n  /** A map of all nodes in the app by ID, including orphaned or disabled nodes */\n  readonly nodes: ReadonlyMap<string /* id */, AppNode>;\n  /** A sequence of all nodes with a parent that is not reachable from the app root node */\n  readonly orphans: Iterable<AppNode>;\n}\n\n/**\n * The API for interacting with the {@link AppTree}.\n *\n * @public\n */\nexport interface AppTreeApi {\n  /**\n   * Get the {@link AppTree} for the app.\n   */\n  getTree(): { tree: AppTree };\n\n  /**\n   * Get all nodes in the app that are mounted at a given route path.\n   */\n  getNodesByRoutePath(routePath: string): { nodes: AppNode[] };\n}\n\n/**\n * The `ApiRef` of {@link AppTreeApi}.\n *\n * @public\n */\nexport const appTreeApiRef = createApiRef<AppTreeApi>({ id: 'core.app-tree' });\n"],"names":[],"mappings":";;AAuHO,MAAM,aAAA,GAAgB,YAAA,CAAyB,EAAE,EAAA,EAAI,iBAAiB;;;;"}

package/dist/components/createSwappableComponent.esm.js

@@ -9,6 +9,7 @@ import '../apis/definitions/AnalyticsApi.esm.js';
 import { lazy } from 'react';
 import { OpaqueSwappableComponentRef } from '../frontend-internal/src/wiring/InternalSwappableComponentRef.esm.js';
 import '../frontend-internal/src/wiring/InternalExtensionDefinition.esm.js';
+import '../frontend-internal/src/wiring/InternalExtensionInput.esm.js';
 import '../frontend-internal/src/wiring/InternalFrontendPlugin.esm.js';
 
 const useComponentRefApi = () => {

package/dist/components/createSwappableComponent.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"createSwappableComponent.esm.js","sources":["../../src/components/createSwappableComponent.tsx"],"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 { OpaqueSwappableComponentRef } from '@internal/frontend';\nimport { swappableComponentsApiRef, useApi } from '../apis';\nimport { lazy } from 'react';\n\n/** @public */\nexport type SwappableComponentRef<\n  TInnerComponentProps extends {} = {},\n  TExternalComponentProps extends {} = TInnerComponentProps,\n> = {\n  id: string;\n  TProps: TInnerComponentProps;\n  TExternalProps: TExternalComponentProps;\n  $$type: '@backstage/SwappableComponentRef';\n};\n\n/**\n * Options for creating an SwappableComponent.\n *\n * @public\n */\nexport type CreateSwappableComponentOptions<\n  TInnerComponentProps extends {},\n  TExternalComponentProps extends {} = TInnerComponentProps,\n> = {\n  id: string;\n  loader?:\n    | (() => (props: TInnerComponentProps) => JSX.Element | null)\n    | (() => Promise<(props: TInnerComponentProps) => JSX.Element | null>);\n  transformProps?: (props: TExternalComponentProps) => TInnerComponentProps;\n};\n\nconst useComponentRefApi = () => {\n  try {\n    return useApi(swappableComponentsApiRef);\n  } catch (e) {\n    return undefined;\n  }\n};\n\n/**\n * Creates a SwappableComponent that can be used to render the component, optionally overridden by the app.\n *\n * @public\n */\nexport function createSwappableComponent<\n  TInnerComponentProps extends {},\n  TExternalComponentProps extends {} = TInnerComponentProps,\n>(\n  options: CreateSwappableComponentOptions<\n    TInnerComponentProps,\n    TExternalComponentProps\n  >,\n): {\n  (props: TExternalComponentProps): JSX.Element | null;\n  ref: SwappableComponentRef<TInnerComponentProps, TExternalComponentProps>;\n} {\n  const FallbackComponent = (p: JSX.IntrinsicAttributes) => (\n    <div data-testid={options.id} {...p} />\n  );\n\n  const ref = OpaqueSwappableComponentRef.createInstance('v1', {\n    id: options.id,\n    TProps: null as unknown as TInnerComponentProps,\n    TExternalProps: null as unknown as TExternalComponentProps,\n    toString() {\n      return `SwappableComponentRef{id=${options.id}}`;\n    },\n    defaultComponent: lazy(async () => {\n      const Component = (await options.loader?.()) ?? FallbackComponent;\n      return { default: Component };\n    }) as (typeof OpaqueSwappableComponentRef.TInternal)['defaultComponent'],\n    transformProps:\n      options.transformProps as (typeof OpaqueSwappableComponentRef.TInternal)['transformProps'],\n  });\n\n  const ComponentRefImpl = (props: TExternalComponentProps) => {\n    const api = useComponentRefApi();\n\n    if (!api) {\n      const internalRef = OpaqueSwappableComponentRef.toInternal(ref);\n      const Component = internalRef.defaultComponent;\n      const innerProps = internalRef.transformProps?.(props) ?? props;\n      return <Component {...innerProps} />;\n    }\n\n    const Component = api.getComponent<any>(ref);\n    return <Component {...props} />;\n  };\n\n  Object.assign(ComponentRefImpl, { ref });\n\n  return ComponentRefImpl as {\n    (props: TExternalComponentProps): JSX.Element | null;\n    ref: SwappableComponentRef<TInnerComponentProps, TExternalComponentProps>;\n  };\n}\n"],"names":["Component"],"mappings":";;;;;;;;;;;;;AA+CA,MAAM,qBAAqB,MAAM;AAC/B,EAAA,IAAI;AACF,IAAA,OAAO,OAAO,yBAAyB,CAAA;AAAA,EACzC,SAAS,CAAA,EAAG;AACV,IAAA,OAAO,MAAA;AAAA,EACT;AACF,CAAA;AAOO,SAAS,yBAId,OAAA,EAOA;AACA,EAAA,MAAM,iBAAA,GAAoB,CAAC,CAAA,qBACzB,GAAA,CAAC,SAAI,aAAA,EAAa,OAAA,CAAQ,EAAA,EAAK,GAAG,CAAA,EAAG,CAAA;AAGvC,EAAA,MAAM,GAAA,GAAM,2BAAA,CAA4B,cAAA,CAAe,IAAA,EAAM;AAAA,IAC3D,IAAI,OAAA,CAAQ,EAAA;AAAA,IACZ,MAAA,EAAQ,IAAA;AAAA,IACR,cAAA,EAAgB,IAAA;AAAA,IAChB,QAAA,GAAW;AACT,MAAA,OAAO,CAAA,yBAAA,EAA4B,QAAQ,EAAE,CAAA,CAAA,CAAA;AAAA,IAC/C,CAAA;AAAA,IACA,gBAAA,EAAkB,KAAK,YAAY;AACjC,MAAA,MAAM,SAAA,GAAa,MAAM,OAAA,CAAQ,MAAA,IAAS,IAAM,iBAAA;AAChD,MAAA,OAAO,EAAE,SAAS,SAAA,EAAU;AAAA,IAC9B,CAAC,CAAA;AAAA,IACD,gBACE,OAAA,CAAQ;AAAA,GACX,CAAA;AAED,EAAA,MAAM,gBAAA,GAAmB,CAAC,KAAA,KAAmC;AAC3D,IAAA,MAAM,MAAM,kBAAA,EAAmB;AAE/B,IAAA,IAAI,CAAC,GAAA,EAAK;AACR,MAAA,MAAM,WAAA,GAAc,2BAAA,CAA4B,UAAA,CAAW,GAAG,CAAA;AAC9D,MAAA,MAAMA,aAAY,WAAA,CAAY,gBAAA;AAC9B,MAAA,MAAM,UAAA,GAAa,WAAA,CAAY,cAAA,GAAiB,KAAK,CAAA,IAAK,KAAA;AAC1D,MAAA,uBAAO,GAAA,CAACA,UAAAA,EAAA,EAAW,GAAG,UAAA,EAAY,CAAA;AAAA,IACpC;AAEA,IAAA,MAAM,SAAA,GAAY,GAAA,CAAI,YAAA,CAAkB,GAAG,CAAA;AAC3C,IAAA,uBAAO,GAAA,CAAC,SAAA,EAAA,EAAW,GAAG,KAAA,EAAO,CAAA;AAAA,EAC/B,CAAA;AAEA,EAAA,MAAA,CAAO,MAAA,CAAO,gBAAA,EAAkB,EAAE,GAAA,EAAK,CAAA;AAEvC,EAAA,OAAO,gBAAA;AAIT;;;;"}
+{"version":3,"file":"createSwappableComponent.esm.js","sources":["../../src/components/createSwappableComponent.tsx"],"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 { OpaqueSwappableComponentRef } from '@internal/frontend';\nimport { swappableComponentsApiRef, useApi } from '../apis';\nimport { lazy } from 'react';\n\n/** @public */\nexport type SwappableComponentRef<\n  TInnerComponentProps extends {} = {},\n  TExternalComponentProps extends {} = TInnerComponentProps,\n> = {\n  id: string;\n  TProps: TInnerComponentProps;\n  TExternalProps: TExternalComponentProps;\n  $$type: '@backstage/SwappableComponentRef';\n};\n\n/**\n * Options for creating an SwappableComponent.\n *\n * @public\n */\nexport type CreateSwappableComponentOptions<\n  TInnerComponentProps extends {},\n  TExternalComponentProps extends {} = TInnerComponentProps,\n> = {\n  id: string;\n  loader?:\n    | (() => (props: TInnerComponentProps) => JSX.Element | null)\n    | (() => Promise<(props: TInnerComponentProps) => JSX.Element | null>);\n  transformProps?: (props: TExternalComponentProps) => TInnerComponentProps;\n};\n\nconst useComponentRefApi = () => {\n  try {\n    return useApi(swappableComponentsApiRef);\n  } catch (e) {\n    return undefined;\n  }\n};\n\n/**\n * Creates a SwappableComponent that can be used to render the component, optionally overridden by the app.\n *\n * @public\n */\nexport function createSwappableComponent<\n  TInnerComponentProps extends {},\n  TExternalComponentProps extends {} = TInnerComponentProps,\n>(\n  options: CreateSwappableComponentOptions<\n    TInnerComponentProps,\n    TExternalComponentProps\n  >,\n): {\n  (props: TExternalComponentProps): JSX.Element | null;\n  ref: SwappableComponentRef<TInnerComponentProps, TExternalComponentProps>;\n} {\n  const FallbackComponent = (p: JSX.IntrinsicAttributes) => (\n    <div data-testid={options.id} {...p} />\n  );\n\n  const ref = OpaqueSwappableComponentRef.createInstance('v1', {\n    id: options.id,\n    TProps: null as unknown as TInnerComponentProps,\n    TExternalProps: null as unknown as TExternalComponentProps,\n    toString() {\n      return `SwappableComponentRef{id=${options.id}}`;\n    },\n    defaultComponent: lazy(async () => {\n      const Component = (await options.loader?.()) ?? FallbackComponent;\n      return { default: Component };\n    }) as (typeof OpaqueSwappableComponentRef.TInternal)['defaultComponent'],\n    transformProps:\n      options.transformProps as (typeof OpaqueSwappableComponentRef.TInternal)['transformProps'],\n  });\n\n  const ComponentRefImpl = (props: TExternalComponentProps) => {\n    const api = useComponentRefApi();\n\n    if (!api) {\n      const internalRef = OpaqueSwappableComponentRef.toInternal(ref);\n      const Component = internalRef.defaultComponent;\n      const innerProps = internalRef.transformProps?.(props) ?? props;\n      return <Component {...innerProps} />;\n    }\n\n    const Component = api.getComponent<any>(ref);\n    return <Component {...props} />;\n  };\n\n  Object.assign(ComponentRefImpl, { ref });\n\n  return ComponentRefImpl as {\n    (props: TExternalComponentProps): JSX.Element | null;\n    ref: SwappableComponentRef<TInnerComponentProps, TExternalComponentProps>;\n  };\n}\n"],"names":["Component"],"mappings":";;;;;;;;;;;;;;AA+CA,MAAM,qBAAqB,MAAM;AAC/B,EAAA,IAAI;AACF,IAAA,OAAO,OAAO,yBAAyB,CAAA;AAAA,EACzC,SAAS,CAAA,EAAG;AACV,IAAA,OAAO,MAAA;AAAA,EACT;AACF,CAAA;AAOO,SAAS,yBAId,OAAA,EAOA;AACA,EAAA,MAAM,iBAAA,GAAoB,CAAC,CAAA,qBACzB,GAAA,CAAC,SAAI,aAAA,EAAa,OAAA,CAAQ,EAAA,EAAK,GAAG,CAAA,EAAG,CAAA;AAGvC,EAAA,MAAM,GAAA,GAAM,2BAAA,CAA4B,cAAA,CAAe,IAAA,EAAM;AAAA,IAC3D,IAAI,OAAA,CAAQ,EAAA;AAAA,IACZ,MAAA,EAAQ,IAAA;AAAA,IACR,cAAA,EAAgB,IAAA;AAAA,IAChB,QAAA,GAAW;AACT,MAAA,OAAO,CAAA,yBAAA,EAA4B,QAAQ,EAAE,CAAA,CAAA,CAAA;AAAA,IAC/C,CAAA;AAAA,IACA,gBAAA,EAAkB,KAAK,YAAY;AACjC,MAAA,MAAM,SAAA,GAAa,MAAM,OAAA,CAAQ,MAAA,IAAS,IAAM,iBAAA;AAChD,MAAA,OAAO,EAAE,SAAS,SAAA,EAAU;AAAA,IAC9B,CAAC,CAAA;AAAA,IACD,gBACE,OAAA,CAAQ;AAAA,GACX,CAAA;AAED,EAAA,MAAM,gBAAA,GAAmB,CAAC,KAAA,KAAmC;AAC3D,IAAA,MAAM,MAAM,kBAAA,EAAmB;AAE/B,IAAA,IAAI,CAAC,GAAA,EAAK;AACR,MAAA,MAAM,WAAA,GAAc,2BAAA,CAA4B,UAAA,CAAW,GAAG,CAAA;AAC9D,MAAA,MAAMA,aAAY,WAAA,CAAY,gBAAA;AAC9B,MAAA,MAAM,UAAA,GAAa,WAAA,CAAY,cAAA,GAAiB,KAAK,CAAA,IAAK,KAAA;AAC1D,MAAA,uBAAO,GAAA,CAACA,UAAAA,EAAA,EAAW,GAAG,UAAA,EAAY,CAAA;AAAA,IACpC;AAEA,IAAA,MAAM,SAAA,GAAY,GAAA,CAAI,YAAA,CAAkB,GAAG,CAAA;AAC3C,IAAA,uBAAO,GAAA,CAAC,SAAA,EAAA,EAAW,GAAG,KAAA,EAAO,CAAA;AAAA,EAC/B,CAAA;AAEA,EAAA,MAAA,CAAO,MAAA,CAAO,gBAAA,EAAkB,EAAE,GAAA,EAAK,CAAA;AAEvC,EAAA,OAAO,gBAAA;AAIT;;;;"}

package/dist/frontend-internal/src/wiring/InternalExtensionDefinition.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"InternalExtensionDefinition.esm.js","sources":["../../../../../frontend-internal/src/wiring/InternalExtensionDefinition.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 {\n  ApiHolder,\n  AppNode,\n  ExtensionAttachToSpec,\n  ExtensionDataValue,\n  ExtensionDataRef,\n  ExtensionDefinition,\n  ExtensionDefinitionParameters,\n  ExtensionInput,\n  PortableSchema,\n  ResolvedExtensionInputs,\n} from '@backstage/frontend-plugin-api';\nimport { OpaqueType } from '@internal/opaque';\n\nexport const OpaqueExtensionDefinition = OpaqueType.create<{\n  public: ExtensionDefinition<ExtensionDefinitionParameters>;\n  versions:\n    | {\n        readonly version: 'v1';\n        readonly kind?: string;\n        readonly namespace?: string;\n        readonly name?: string;\n        readonly attachTo: ExtensionAttachToSpec;\n        readonly disabled: boolean;\n        readonly configSchema?: PortableSchema<any, any>;\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          node: AppNode;\n          apis: ApiHolder;\n          config: object;\n          inputs: {\n            [inputName in string]: unknown;\n          };\n        }): {\n          [inputName in string]: unknown;\n        };\n      }\n    | {\n        readonly version: 'v2';\n        readonly kind?: string;\n        readonly namespace?: string;\n        readonly name?: string;\n        readonly attachTo: ExtensionAttachToSpec;\n        readonly disabled: boolean;\n        readonly configSchema?: PortableSchema<any, any>;\n        readonly inputs: { [inputName in string]: ExtensionInput };\n        readonly output: Array<ExtensionDataRef>;\n        factory(context: {\n          node: AppNode;\n          apis: ApiHolder;\n          config: object;\n          inputs: ResolvedExtensionInputs<{\n            [inputName in string]: ExtensionInput;\n          }>;\n        }): Iterable<ExtensionDataValue<any, any>>;\n      };\n}>({\n  type: '@backstage/ExtensionDefinition',\n  versions: ['v1', 'v2'],\n});\n"],"names":[],"mappings":";;AA8BO,MAAM,yBAAA,GAA4B,WAAW,MAAA,CAqDjD;AAAA,EACD,IAAA,EAAM,gCAAA;AAAA,EACN,QAAA,EAAU,CAAC,IAAA,EAAM,IAAI;AACvB,CAAC;;;;"}
+{"version":3,"file":"InternalExtensionDefinition.esm.js","sources":["../../../../../frontend-internal/src/wiring/InternalExtensionDefinition.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 {\n  ApiHolder,\n  AppNode,\n  ExtensionDefinitionAttachTo,\n  ExtensionDataValue,\n  ExtensionDataRef,\n  ExtensionDefinition,\n  ExtensionDefinitionParameters,\n  ExtensionInput,\n  PortableSchema,\n  ResolvedExtensionInputs,\n} from '@backstage/frontend-plugin-api';\nimport { OpaqueType } from '@internal/opaque';\n\nexport const OpaqueExtensionDefinition = OpaqueType.create<{\n  public: ExtensionDefinition<ExtensionDefinitionParameters>;\n  versions:\n    | {\n        readonly version: 'v1';\n        readonly kind?: string;\n        readonly namespace?: string;\n        readonly name?: string;\n        readonly attachTo: ExtensionDefinitionAttachTo;\n        readonly disabled: boolean;\n        readonly configSchema?: PortableSchema<any, any>;\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          node: AppNode;\n          apis: ApiHolder;\n          config: object;\n          inputs: {\n            [inputName in string]: unknown;\n          };\n        }): {\n          [inputName in string]: unknown;\n        };\n      }\n    | {\n        readonly version: 'v2';\n        readonly kind?: string;\n        readonly namespace?: string;\n        readonly name?: string;\n        readonly attachTo: ExtensionDefinitionAttachTo;\n        readonly disabled: boolean;\n        readonly configSchema?: PortableSchema<any, any>;\n        readonly inputs: { [inputName in string]: ExtensionInput };\n        readonly output: Array<ExtensionDataRef>;\n        factory(context: {\n          node: AppNode;\n          apis: ApiHolder;\n          config: object;\n          inputs: ResolvedExtensionInputs<{\n            [inputName in string]: ExtensionInput;\n          }>;\n        }): Iterable<ExtensionDataValue<any, any>>;\n      };\n}>({\n  type: '@backstage/ExtensionDefinition',\n  versions: ['v1', 'v2'],\n});\n"],"names":[],"mappings":";;AA8BO,MAAM,yBAAA,GAA4B,WAAW,MAAA,CAqDjD;AAAA,EACD,IAAA,EAAM,gCAAA;AAAA,EACN,QAAA,EAAU,CAAC,IAAA,EAAM,IAAI;AACvB,CAAC;;;;"}

package/dist/frontend-internal/src/wiring/InternalExtensionInput.esm.js

@@ -0,0 +1,9 @@
+import { OpaqueType } from '../../../opaque-internal/src/OpaqueType.esm.js';
+
+const OpaqueExtensionInput = OpaqueType.create({
+  type: "@backstage/ExtensionInput",
+  versions: [void 0]
+});
+
+export { OpaqueExtensionInput };
+//# sourceMappingURL=InternalExtensionInput.esm.js.map

package/dist/frontend-internal/src/wiring/InternalExtensionInput.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternalExtensionInput.esm.js","sources":["../../../../../frontend-internal/src/wiring/InternalExtensionInput.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 { ExtensionInput } from '@backstage/frontend-plugin-api';\nimport { OpaqueType } from '@internal/opaque';\n\nexport type ExtensionInputContext = {\n  input: string;\n  kind?: string;\n  name?: string;\n};\n\nexport const OpaqueExtensionInput = OpaqueType.create<{\n  public: ExtensionInput;\n  versions: {\n    readonly version: undefined;\n    readonly context?: ExtensionInputContext;\n    withContext(context: ExtensionInputContext): ExtensionInput;\n  };\n}>({\n  type: '@backstage/ExtensionInput',\n  versions: [undefined],\n});\n"],"names":[],"mappings":";;AAyBO,MAAM,oBAAA,GAAuB,WAAW,MAAA,CAO5C;AAAA,EACD,IAAA,EAAM,2BAAA;AAAA,EACN,QAAA,EAAU,CAAC,MAAS;AACtB,CAAC;;;;"}

package/dist/index.d.ts

@@ -140,10 +140,10 @@ interface ExtensionInput<UExtensionData extends ExtensionDataRef<unknown, string
     singleton: boolean;
     optional: boolean;
 }> {
-    $$type: '@backstage/ExtensionInput';
-    extensionData: Array<UExtensionData>;
-    config: TConfig;
-    replaces?: Array<{
+    readonly $$type: '@backstage/ExtensionInput';
+    readonly extensionData: Array<UExtensionData>;
+    readonly config: TConfig;
+    readonly replaces?: Array<{
         id: string;
         input: string;
     }>;
@@ -245,6 +245,19 @@ type PortableSchema<TOutput, TInput = TOutput> = {
     schema: JsonObject;
 };
 
+/** @public */
+type ExtensionAttachTo = {
+    id: string;
+    input: string;
+} | Array<{
+    id: string;
+    input: string;
+}>;
+/**
+ * @deprecated Use {@link ExtensionAttachTo} instead.
+ * @public
+ */
+type ExtensionAttachToSpec = ExtensionAttachTo;
 /** @public */
 interface Extension<TConfig, TConfigInput = TConfig> {
     $$type: '@backstage/Extension';
@@ -649,9 +662,9 @@ type CreateExtensionBlueprintOptions<TKind extends string, TParams extends objec
     [key in string]: (zImpl: typeof z) => z.ZodType;
 }, UFactoryOutput extends ExtensionDataValue<any, any>, TDataRefs extends {
     [name in string]: ExtensionDataRef;
-}> = {
+}, UParentInputs extends ExtensionDataRef> = {
     kind: TKind;
-    attachTo: ExtensionAttachToSpec;
+    attachTo: ExtensionDefinitionAttachTo<UParentInputs> & VerifyExtensionAttachTo<UOutput, UParentInputs>;
     disabled?: boolean;
     inputs?: TInputs;
     output: Array<UOutput>;
@@ -739,9 +752,9 @@ type AnyParamsInput$1<TParams extends object | ExtensionBlueprintDefineParams> =
  */
 interface ExtensionBlueprint<T extends ExtensionBlueprintParameters = ExtensionBlueprintParameters> {
     dataRefs: T['dataRefs'];
-    make<TName extends string | undefined, TParamsInput extends AnyParamsInput$1<NonNullable<T['params']>>>(args: {
+    make<TName extends string | undefined, TParamsInput extends AnyParamsInput$1<NonNullable<T['params']>>, UParentInputs extends ExtensionDataRef>(args: {
         name?: TName;
-        attachTo?: ExtensionAttachToSpec;
+        attachTo?: ExtensionDefinitionAttachTo<UParentInputs> & VerifyExtensionAttachTo<NonNullable<T['output']>, UParentInputs>;
         disabled?: boolean;
         params: TParamsInput extends ExtensionBlueprintDefineParams ? TParamsInput : T['params'] extends ExtensionBlueprintDefineParams ? 'Error: This blueprint uses advanced parameter types and requires you to pass parameters as using the following callback syntax: `<blueprint>.make({ params: defineParams => defineParams(<params>) })`' : T['params'];
     }): ExtensionDefinition<{
@@ -763,9 +776,9 @@ interface ExtensionBlueprint<T extends ExtensionBlueprintParameters = ExtensionB
         [key in string]: (zImpl: typeof z) => z.ZodType;
     }, UFactoryOutput extends ExtensionDataValue<any, any>, UNewOutput extends ExtensionDataRef, TExtraInputs extends {
         [inputName in string]: ExtensionInput;
-    }>(args: {
+    }, UParentInputs extends ExtensionDataRef>(args: {
         name?: TName;
-        attachTo?: ExtensionAttachToSpec;
+        attachTo?: ExtensionDefinitionAttachTo<UParentInputs> & VerifyExtensionAttachTo<ExtensionDataRef extends UNewOutput ? NonNullable<T['output']> : UNewOutput, UParentInputs>;
         disabled?: boolean;
         inputs?: TExtraInputs & {
             [KName in keyof T['inputs']]?: `Error: Input '${KName & string}' is already defined in parent definition`;
@@ -854,9 +867,9 @@ declare function createExtensionBlueprint<TParams extends object | ExtensionBlue
     [inputName in string]: ExtensionInput;
 }, TConfigSchema extends {
     [key in string]: (zImpl: typeof z) => z.ZodType;
-}, UFactoryOutput extends ExtensionDataValue<any, any>, TKind extends string, TDataRefs extends {
+}, UFactoryOutput extends ExtensionDataValue<any, any>, TKind extends string, UParentInputs extends ExtensionDataRef, TDataRefs extends {
     [name in string]: ExtensionDataRef;
-} = never>(options: CreateExtensionBlueprintOptions<TKind, TParams, UOutput, TInputs, TConfigSchema, UFactoryOutput, TDataRefs>): ExtensionBlueprint<{
+} = never>(options: CreateExtensionBlueprintOptions<TKind, TParams, UOutput, TInputs, TConfigSchema, UFactoryOutput, TDataRefs, UParentInputs>): ExtensionBlueprint<{
     kind: TKind;
     params: TParams;
     output: UOutput extends ExtensionDataRef<infer IData, infer IId, infer IConfig> ? ExtensionDataRef<IData, IId, IConfig> : never;
@@ -891,24 +904,77 @@ type PopUnion<U> = ToIntersection<U extends any ? () => U : never> extends () =>
 /** @ignore */
 type JoinStringUnion<U, TDiv extends string = ', ', TResult extends string = ''> = PopUnion<U> extends [infer IRest extends string, infer INext extends string] ? TResult extends '' ? JoinStringUnion<IRest, TDiv, INext> : JoinStringUnion<IRest, TDiv, `${TResult}${TDiv}${INext}`> : TResult;
 /** @ignore */
-type VerifyExtensionFactoryOutput<UDeclaredOutput extends ExtensionDataRef, UFactoryOutput extends ExtensionDataValue<any, any>> = (UDeclaredOutput extends any ? UDeclaredOutput['config']['optional'] extends true ? never : UDeclaredOutput['id'] : never) extends infer IRequiredOutputIds ? [IRequiredOutputIds] extends [UFactoryOutput['id']] ? [UFactoryOutput['id']] extends [UDeclaredOutput['id']] ? {} : `Error: The extension factory has undeclared output(s): ${JoinStringUnion<Exclude<UFactoryOutput['id'], UDeclaredOutput['id']>>}` : `Error: The extension factory is missing the following output(s): ${JoinStringUnion<Exclude<IRequiredOutputIds, UFactoryOutput['id']>>}` : never;
-/** @public */
-type ExtensionAttachToSpec = {
+type RequiredExtensionIds<UExtensionData extends ExtensionDataRef> = UExtensionData extends any ? UExtensionData['config']['optional'] extends true ? never : UExtensionData['id'] : never;
+/** @ignore */
+type VerifyExtensionFactoryOutput<UDeclaredOutput extends ExtensionDataRef, UFactoryOutput extends ExtensionDataValue<any, any>> = [RequiredExtensionIds<UDeclaredOutput>] extends [UFactoryOutput['id']] ? [UFactoryOutput['id']] extends [UDeclaredOutput['id']] ? {} : `Error: The extension factory has undeclared output(s): ${JoinStringUnion<Exclude<UFactoryOutput['id'], UDeclaredOutput['id']>>}` : `Error: The extension factory is missing the following output(s): ${JoinStringUnion<Exclude<RequiredExtensionIds<UDeclaredOutput>, UFactoryOutput['id']>>}`;
+/** @ignore */
+type VerifyExtensionAttachTo<UOutput extends ExtensionDataRef, UParentInput extends ExtensionDataRef> = ExtensionDataRef extends UParentInput ? {} : [RequiredExtensionIds<UParentInput>] extends [RequiredExtensionIds<UOutput>] ? {} : `Error: This parent extension input requires the following extension data, but it is not declared as guaranteed output of this extension: ${JoinStringUnion<Exclude<RequiredExtensionIds<UParentInput>, RequiredExtensionIds<UOutput>>>}`;
+/**
+ * Specifies where an extension should attach in the extension tree.
+ *
+ * @remarks
+ *
+ * A standard attachment point declaration will specify the ID of the parent extension, as well as the name of the input to attach to.
+ *
+ * There are three more advanced forms that are available for more complex use-cases:
+ *
+ * 1. Relative attachment points: using the `relative` property instead of `id`, the attachment point is resolved relative to the current plugin.
+ * 2. Extension input references: using a reference in code to another extension's input in the same plugin. These references are always relative.
+ * 3. Array of attachment points: an array of attachment points can be used to clone and attach to multiple extensions at once.
+ *
+ * @example
+ * ```ts
+ * // Attach to a specific extension by full ID
+ * { id: 'app/routes', input: 'routes' }
+ *
+ * // Attach to an extension in the same plugin by kind
+ * { relative: { kind: 'page' }, input: 'actions' }
+ *
+ * // Attach to a specific input of another extension
+ * const page = ParentBlueprint.make({ ... });
+ * const child = ChildBlueprint.make({ attachTo: page.inputs.children });
+ *
+ * // Attach to multiple parents at once
+ * [
+ *   { id: 'page/home', input: 'widgets' },
+ *   { relative: { kind: 'page' }, input: 'widgets' },
+ * ]
+ * ```
+ *
+ * @public
+ */
+type ExtensionDefinitionAttachTo<UParentInputs extends ExtensionDataRef = ExtensionDataRef> = {
     id: string;
     input: string;
-} | Array<{
+    relative?: never;
+} | {
+    relative: {
+        kind?: string;
+        name?: string;
+    };
+    input: string;
+    id?: never;
+} | ExtensionInput<UParentInputs> | Array<{
     id: string;
     input: string;
-}>;
+    relative?: never;
+} | {
+    relative: {
+        kind?: string;
+        name?: string;
+    };
+    input: string;
+    id?: never;
+} | ExtensionInput<UParentInputs>>;
 /** @public */
 type CreateExtensionOptions<TKind extends string | undefined, TName extends string | undefined, UOutput extends ExtensionDataRef, TInputs extends {
     [inputName in string]: ExtensionInput;
 }, TConfigSchema extends {
     [key: string]: (zImpl: typeof z) => z.ZodType;
-}, UFactoryOutput extends ExtensionDataValue<any, any>> = {
+}, UFactoryOutput extends ExtensionDataValue<any, any>, UParentInputs extends ExtensionDataRef> = {
     kind?: TKind;
     name?: TName;
-    attachTo: ExtensionAttachToSpec;
+    attachTo: ExtensionDefinitionAttachTo<UParentInputs> & VerifyExtensionAttachTo<UOutput, UParentInputs>;
     disabled?: boolean;
     inputs?: TInputs;
     output: Array<UOutput>;
@@ -950,12 +1016,18 @@ type AnyParamsInput<TParams extends object | ExtensionBlueprintDefineParams> = T
 type ExtensionDefinition<T extends ExtensionDefinitionParameters = ExtensionDefinitionParameters> = {
     $$type: '@backstage/ExtensionDefinition';
     readonly T: T;
+    /**
+     * References to the inputs of this extension, which can be used to attach child extensions.
+     */
+    readonly inputs: {
+        [K in keyof T['inputs']]: ExtensionInput<T['inputs'][K] extends ExtensionInput<infer IData> ? IData : never>;
+    };
     override<TExtensionConfigSchema extends {
         [key in string]: (zImpl: typeof z) => z.ZodType;
     }, UFactoryOutput extends ExtensionDataValue<any, any>, UNewOutput extends ExtensionDataRef, TExtraInputs extends {
         [inputName in string]: ExtensionInput;
-    }, TParamsInput extends AnyParamsInput<NonNullable<T['params']>>>(args: Expand<{
-        attachTo?: ExtensionAttachToSpec;
+    }, TParamsInput extends AnyParamsInput<NonNullable<T['params']>>, UParentInputs extends ExtensionDataRef>(args: Expand<{
+        attachTo?: ExtensionDefinitionAttachTo<UParentInputs> & VerifyExtensionAttachTo<ExtensionDataRef extends UNewOutput ? NonNullable<T['output']> : UNewOutput, UParentInputs>;
         disabled?: boolean;
         inputs?: TExtraInputs & {
             [KName in keyof T['inputs']]?: `Error: Input '${KName & string}' is already defined in parent definition`;
@@ -1033,7 +1105,7 @@ declare function createExtension<UOutput extends ExtensionDataRef, TInputs exten
     [inputName in string]: ExtensionInput;
 }, TConfigSchema extends {
     [key: string]: (zImpl: typeof z) => z.ZodType;
-}, UFactoryOutput extends ExtensionDataValue<any, any>, const TKind extends string | undefined = undefined, const TName extends string | undefined = undefined>(options: CreateExtensionOptions<TKind, TName, UOutput, TInputs, TConfigSchema, UFactoryOutput>): ExtensionDefinition<{
+}, UFactoryOutput extends ExtensionDataValue<any, any>, const TKind extends string | undefined = undefined, const TName extends string | undefined = undefined, UParentInputs extends ExtensionDataRef = ExtensionDataRef>(options: CreateExtensionOptions<TKind, TName, UOutput, TInputs, TConfigSchema, UFactoryOutput, UParentInputs>): ExtensionDefinition<{
     config: string extends keyof TConfigSchema ? {} : {
         [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;
     };
@@ -1077,7 +1149,7 @@ declare function createFrontendFeatureLoader(options: CreateFrontendFeatureLoade
  */
 interface AppNodeSpec {
     readonly id: string;
-    readonly attachTo: ExtensionAttachToSpec;
+    readonly attachTo: ExtensionAttachTo;
     readonly extension: Extension<unknown, unknown>;
     readonly disabled: boolean;
     readonly config?: unknown;
@@ -1944,4 +2016,4 @@ declare const SwappableComponentBlueprint: ExtensionBlueprint<{
     };
 }>;
 
-export { type AnalyticsApi, AnalyticsContext, type AnalyticsContextValue, type AnalyticsEvent, type AnalyticsEventAttributes, type AnalyticsImplementation, AnalyticsImplementationBlueprint, type AnalyticsImplementationFactory, type AnalyticsTracker, type AnyExtensionDataRef, type AnyRouteRefParams, ApiBlueprint, type AppNode, type AppNodeEdges, type AppNodeInstance, type AppNodeSpec, AppRootElementBlueprint, AppRootWrapperBlueprint, type AppTree, type AppTreeApi, type ConfigurableExtensionDataRef, type CreateExtensionBlueprintOptions, type CreateExtensionOptions, type CreateFrontendFeatureLoaderOptions, type CreateFrontendModuleOptions, type CreateSwappableComponentOptions, type DialogApi, type DialogApiDialog, ErrorDisplay, type ErrorDisplayProps, type Extension, type ExtensionAttachToSpec, type ExtensionBlueprint, type ExtensionBlueprintDefineParams, type ExtensionBlueprintParameters, type ExtensionBlueprintParams, ExtensionBoundary, type ExtensionBoundaryProps, type ExtensionDataContainer, type ExtensionDataRef, type ExtensionDataRefToValue, type ExtensionDataValue, type ExtensionDefinition, type ExtensionDefinitionParameters, type ExtensionFactoryMiddleware, type ExtensionInput, type ExternalRouteRef, type FeatureFlagConfig, type FrontendFeature, type FrontendFeatureLoader, type FrontendModule, type FrontendPlugin, type FrontendPluginInfo, type FrontendPluginInfoOptions, IconBundleBlueprint, type IconComponent, type IconsApi, NavContentBlueprint, type NavContentComponent, type NavContentComponentProps, NavItemBlueprint, NotFoundErrorPage, type NotFoundErrorPageProps, type OverridableFrontendPlugin, PageBlueprint, type PluginOptions, type PortableSchema, Progress, type ProgressProps, type ResolvedExtensionInput, type ResolvedExtensionInputs, type RouteFunc, type RouteRef, type RouteResolutionApi, RouterBlueprint, SignInPageBlueprint, type SubRouteRef, SwappableComponentBlueprint, type SwappableComponentRef, type SwappableComponentsApi, ThemeBlueprint, TranslationBlueprint, analyticsApiRef, appTreeApiRef, coreExtensionData, createExtension, createExtensionBlueprint, createExtensionBlueprintParams, createExtensionDataRef, createExtensionInput, createExternalRouteRef, createFrontendFeatureLoader, createFrontendModule, createFrontendPlugin, createRouteRef, createSubRouteRef, createSwappableComponent, dialogApiRef, iconsApiRef, routeResolutionApiRef, swappableComponentsApiRef, useAnalytics, useAppNode, useRouteRef, useRouteRefParams };
+export { type AnalyticsApi, AnalyticsContext, type AnalyticsContextValue, type AnalyticsEvent, type AnalyticsEventAttributes, type AnalyticsImplementation, AnalyticsImplementationBlueprint, type AnalyticsImplementationFactory, type AnalyticsTracker, type AnyExtensionDataRef, type AnyRouteRefParams, ApiBlueprint, type AppNode, type AppNodeEdges, type AppNodeInstance, type AppNodeSpec, AppRootElementBlueprint, AppRootWrapperBlueprint, type AppTree, type AppTreeApi, type ConfigurableExtensionDataRef, type CreateExtensionBlueprintOptions, type CreateExtensionOptions, type CreateFrontendFeatureLoaderOptions, type CreateFrontendModuleOptions, type CreateSwappableComponentOptions, type DialogApi, type DialogApiDialog, ErrorDisplay, type ErrorDisplayProps, type Extension, type ExtensionAttachTo, type ExtensionAttachToSpec, type ExtensionBlueprint, type ExtensionBlueprintDefineParams, type ExtensionBlueprintParameters, type ExtensionBlueprintParams, ExtensionBoundary, type ExtensionBoundaryProps, type ExtensionDataContainer, type ExtensionDataRef, type ExtensionDataRefToValue, type ExtensionDataValue, type ExtensionDefinition, type ExtensionDefinitionAttachTo, type ExtensionDefinitionParameters, type ExtensionFactoryMiddleware, type ExtensionInput, type ExternalRouteRef, type FeatureFlagConfig, type FrontendFeature, type FrontendFeatureLoader, type FrontendModule, type FrontendPlugin, type FrontendPluginInfo, type FrontendPluginInfoOptions, IconBundleBlueprint, type IconComponent, type IconsApi, NavContentBlueprint, type NavContentComponent, type NavContentComponentProps, NavItemBlueprint, NotFoundErrorPage, type NotFoundErrorPageProps, type OverridableFrontendPlugin, PageBlueprint, type PluginOptions, type PortableSchema, Progress, type ProgressProps, type ResolvedExtensionInput, type ResolvedExtensionInputs, type RouteFunc, type RouteRef, type RouteResolutionApi, RouterBlueprint, SignInPageBlueprint, type SubRouteRef, SwappableComponentBlueprint, type SwappableComponentRef, type SwappableComponentsApi, ThemeBlueprint, TranslationBlueprint, analyticsApiRef, appTreeApiRef, coreExtensionData, createExtension, createExtensionBlueprint, createExtensionBlueprintParams, createExtensionDataRef, createExtensionInput, createExternalRouteRef, createFrontendFeatureLoader, createFrontendModule, createFrontendPlugin, createRouteRef, createSubRouteRef, createSwappableComponent, dialogApiRef, iconsApiRef, routeResolutionApiRef, swappableComponentsApiRef, useAnalytics, useAppNode, useRouteRef, useRouteRefParams };

package/dist/wiring/createExtension.esm.js

@@ -2,10 +2,26 @@ import { resolveInputOverrides } from './resolveInputOverrides.esm.js';
 import { createSchemaFromZod } from '../schema/createSchemaFromZod.esm.js';
 import { OpaqueExtensionDefinition } from '../frontend-internal/src/wiring/InternalExtensionDefinition.esm.js';
 import { createExtensionDataContainer } from '../frontend-internal/src/wiring/createExtensionDataContainer.esm.js';
-import '../frontend-internal/src/wiring/InternalSwappableComponentRef.esm.js';
+import { OpaqueExtensionInput } from '../frontend-internal/src/wiring/InternalExtensionInput.esm.js';
 import '../frontend-internal/src/wiring/InternalFrontendPlugin.esm.js';
+import '../frontend-internal/src/wiring/InternalSwappableComponentRef.esm.js';
 
 const ctxParamsSymbol = Symbol("params");
+function bindInputs(inputs, kind, name) {
+  if (!inputs) {
+    return {};
+  }
+  return Object.fromEntries(
+    Object.entries(inputs).map(([inputName, input]) => [
+      inputName,
+      OpaqueExtensionInput.toInternal(input).withContext({
+        kind,
+        name,
+        input: inputName
+      })
+    ])
+  );
+}
 function createExtension(options) {
   const schemaDeclaration = options.config?.schema;
   const configSchema = schemaDeclaration && createSchemaFromZod(
@@ -21,7 +37,7 @@ function createExtension(options) {
     name: options.name,
     attachTo: options.attachTo,
     disabled: options.disabled ?? false,
-    inputs: options.inputs ?? {},
+    inputs: bindInputs(options.inputs, options.kind, options.name),
     output: options.output,
     configSchema,
     factory: options.factory,
@@ -33,9 +49,38 @@ function createExtension(options) {
       if (options.name) {
         parts.push(`name=${options.name}`);
       }
-      parts.push(
-        `attachTo=${[options.attachTo].flat().map((a) => `${a.id}@${a.input}`).join("+")}`
-      );
+      const attachTo = [options.attachTo].flat().map((aAny) => {
+        const a = aAny;
+        if (OpaqueExtensionInput.isType(a)) {
+          const { context } = OpaqueExtensionInput.toInternal(a);
+          if (!context) {
+            return "<detached-input>";
+          }
+          let id = "<plugin>";
+          if (context?.kind) {
+            id = `${context?.kind}:${id}`;
+          }
+          if (context?.name) {
+            id = `${id}/${context?.name}`;
+          }
+          return `${id}@${context.input}`;
+        }
+        if ("relative" in a && a.relative) {
+          let id = "<plugin>";
+          if (a.relative.kind) {
+            id = `${a.relative.kind}:${id}`;
+          }
+          if (a.relative.name) {
+            id = `${id}/${a.relative.name}`;
+          }
+          return `${id}@${a.input}`;
+        }
+        if ("id" in a) {
+          return `${a.id}@${a.input}`;
+        }
+        throw new Error("Invalid attachment point specification");
+      }).join("+");
+      parts.push(`attachTo=${attachTo}`);
       return `ExtensionDefinition{${parts.join(",")}}`;
     },
     override(overrideOptions) {
@@ -59,7 +104,14 @@ function createExtension(options) {
         name: options.name,
         attachTo: overrideOptions.attachTo ?? options.attachTo,
         disabled: overrideOptions.disabled ?? options.disabled,
-        inputs: { ...overrideOptions.inputs, ...options.inputs },
+        inputs: bindInputs(
+          {
+            ...options.inputs ?? {},
+            ...overrideOptions.inputs ?? {}
+          },
+          options.kind,
+          options.name
+        ),
         output: overrideOptions.output ?? options.output,
         config: options.config || overrideOptions.config ? {
           schema: {

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

@@ -1 +1 @@
-{"version":3,"file":"createExtension.esm.js","sources":["../../src/wiring/createExtension.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiHolder, AppNode } from '../apis';\nimport { Expand } from '@backstage/types';\nimport {\n  ResolvedInputValueOverrides,\n  resolveInputOverrides,\n} from './resolveInputOverrides';\nimport { createExtensionDataContainer } from '@internal/frontend';\nimport { ExtensionDataRef, ExtensionDataValue } from './createExtensionDataRef';\nimport { ExtensionInput } from './createExtensionInput';\nimport { z } from 'zod';\nimport { createSchemaFromZod } from '../schema/createSchemaFromZod';\nimport { OpaqueExtensionDefinition } from '@internal/frontend';\nimport { ExtensionDataContainer } from './types';\nimport {\n  ExtensionBlueprint,\n  ExtensionBlueprintDefineParams,\n} from './createExtensionBlueprint';\nimport { FrontendPlugin } from './createFrontendPlugin';\nimport { FrontendModule } from './createFrontendModule';\n\n/**\n * This symbol is used to pass parameter overrides from the extension override to the blueprint factory\n * @internal\n */\nexport const ctxParamsSymbol = Symbol('params');\n\n/**\n * Convert a single extension input into a matching resolved input.\n * @public\n */\nexport type ResolvedExtensionInput<TExtensionInput extends ExtensionInput> =\n  TExtensionInput['extensionData'] extends Array<ExtensionDataRef>\n    ? {\n        node: AppNode;\n      } & ExtensionDataContainer<TExtensionInput['extensionData'][number]>\n    : never;\n\n/**\n * Converts an extension input map into a matching collection of resolved inputs.\n * @public\n */\nexport type ResolvedExtensionInputs<\n  TInputs extends {\n    [name in string]: ExtensionInput;\n  },\n> = {\n  [InputName in keyof TInputs]: false extends TInputs[InputName]['config']['singleton']\n    ? Array<Expand<ResolvedExtensionInput<TInputs[InputName]>>>\n    : false extends TInputs[InputName]['config']['optional']\n    ? Expand<ResolvedExtensionInput<TInputs[InputName]>>\n    : Expand<ResolvedExtensionInput<TInputs[InputName]> | undefined>;\n};\n\ntype ToIntersection<U> = (U extends any ? (k: U) => void : never) extends (\n  k: infer I,\n) => void\n  ? I\n  : never;\n\ntype PopUnion<U> = ToIntersection<\n  U extends any ? () => U : never\n> extends () => infer R\n  ? [rest: Exclude<U, R>, next: R]\n  : undefined;\n\n/** @ignore */\ntype JoinStringUnion<\n  U,\n  TDiv extends string = ', ',\n  TResult extends string = '',\n> = PopUnion<U> extends [infer IRest extends string, infer INext extends string]\n  ? TResult extends ''\n    ? JoinStringUnion<IRest, TDiv, INext>\n    : JoinStringUnion<IRest, TDiv, `${TResult}${TDiv}${INext}`>\n  : TResult;\n\n/** @ignore */\nexport type VerifyExtensionFactoryOutput<\n  UDeclaredOutput extends ExtensionDataRef,\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n> = (\n  UDeclaredOutput extends any\n    ? UDeclaredOutput['config']['optional'] extends true\n      ? never\n      : UDeclaredOutput['id']\n    : never\n) extends infer IRequiredOutputIds\n  ? [IRequiredOutputIds] extends [UFactoryOutput['id']]\n    ? [UFactoryOutput['id']] extends [UDeclaredOutput['id']]\n      ? {}\n      : `Error: The extension factory has undeclared output(s): ${JoinStringUnion<\n          Exclude<UFactoryOutput['id'], UDeclaredOutput['id']>\n        >}`\n    : `Error: The extension factory is missing the following output(s): ${JoinStringUnion<\n        Exclude<IRequiredOutputIds, UFactoryOutput['id']>\n      >}`\n  : never;\n\n/** @public */\nexport type ExtensionAttachToSpec =\n  | { id: string; input: string }\n  | Array<{ id: string; input: string }>;\n\n/** @public */\nexport type CreateExtensionOptions<\n  TKind extends string | undefined,\n  TName extends string | undefined,\n  UOutput extends ExtensionDataRef,\n  TInputs extends { [inputName in string]: ExtensionInput },\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n> = {\n  kind?: TKind;\n  name?: TName;\n  attachTo: ExtensionAttachToSpec;\n  disabled?: boolean;\n  inputs?: TInputs;\n  output: Array<UOutput>;\n  config?: {\n    schema: TConfigSchema;\n  };\n  factory(context: {\n    node: AppNode;\n    apis: ApiHolder;\n    config: {\n      [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n    };\n    inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n  }): Iterable<UFactoryOutput>;\n} & VerifyExtensionFactoryOutput<UOutput, UFactoryOutput>;\n\n/** @public */\nexport type ExtensionDefinitionParameters = {\n  kind?: string;\n  name?: string;\n  configInput?: { [K in string]: any };\n  config?: { [K in string]: any };\n  output?: ExtensionDataRef;\n  inputs?: { [KName in string]: ExtensionInput };\n  params?: object | ExtensionBlueprintDefineParams;\n};\n\n/**\n * Same as the one in `createExtensionBlueprint`, but with `ParamsFactory` inlined.\n * It can't be exported because it breaks API reports.\n * @ignore\n */\ntype AnyParamsInput<TParams extends object | ExtensionBlueprintDefineParams> =\n  TParams extends ExtensionBlueprintDefineParams<infer IParams>\n    ? IParams | ((define: TParams) => ReturnType<TParams>)\n    :\n        | TParams\n        | ((\n            define: ExtensionBlueprintDefineParams<TParams, TParams>,\n          ) => ReturnType<ExtensionBlueprintDefineParams<TParams, TParams>>);\n\n/** @public */\nexport type ExtensionDefinition<\n  T extends ExtensionDefinitionParameters = ExtensionDefinitionParameters,\n> = {\n  $$type: '@backstage/ExtensionDefinition';\n  readonly T: T;\n\n  override<\n    TExtensionConfigSchema extends {\n      [key in string]: (zImpl: typeof z) => z.ZodType;\n    },\n    UFactoryOutput extends ExtensionDataValue<any, any>,\n    UNewOutput extends ExtensionDataRef,\n    TExtraInputs extends { [inputName in string]: ExtensionInput },\n    TParamsInput extends AnyParamsInput<NonNullable<T['params']>>,\n  >(\n    args: Expand<\n      {\n        attachTo?: ExtensionAttachToSpec;\n        disabled?: boolean;\n        inputs?: TExtraInputs & {\n          [KName in keyof T['inputs']]?: `Error: Input '${KName &\n            string}' is already defined in parent definition`;\n        };\n        output?: Array<UNewOutput>;\n        config?: {\n          schema: TExtensionConfigSchema & {\n            [KName in keyof T['config']]?: `Error: Config key '${KName &\n              string}' is already defined in parent schema`;\n          };\n        };\n        factory?(\n          originalFactory: <\n            TFactoryParamsReturn extends AnyParamsInput<\n              NonNullable<T['params']>\n            >,\n          >(\n            context?: Expand<\n              {\n                config?: T['config'];\n                inputs?: ResolvedInputValueOverrides<NonNullable<T['inputs']>>;\n              } & ([T['params']] extends [never]\n                ? {}\n                : {\n                    params?: TFactoryParamsReturn extends ExtensionBlueprintDefineParams\n                      ? TFactoryParamsReturn\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                      : Partial<T['params']>;\n                  })\n            >,\n          ) => ExtensionDataContainer<NonNullable<T['output']>>,\n          context: {\n            node: AppNode;\n            apis: ApiHolder;\n            config: T['config'] & {\n              [key in keyof TExtensionConfigSchema]: z.infer<\n                ReturnType<TExtensionConfigSchema[key]>\n              >;\n            };\n            inputs: Expand<ResolvedExtensionInputs<T['inputs'] & TExtraInputs>>;\n          },\n        ): Iterable<UFactoryOutput>;\n      } & ([T['params']] extends [never]\n        ? {}\n        : {\n            params?: TParamsInput extends 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              : Partial<T['params']>;\n          })\n    > &\n      VerifyExtensionFactoryOutput<\n        ExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UFactoryOutput\n      >,\n  ): ExtensionDefinition<{\n    kind: T['kind'];\n    name: T['name'];\n    output: ExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: T['inputs'] & TExtraInputs;\n    config: T['config'] & {\n      [key in keyof TExtensionConfigSchema]: z.infer<\n        ReturnType<TExtensionConfigSchema[key]>\n      >;\n    };\n    configInput: T['configInput'] &\n      z.input<\n        z.ZodObject<{\n          [key in keyof TExtensionConfigSchema]: ReturnType<\n            TExtensionConfigSchema[key]\n          >;\n        }>\n      >;\n  }>;\n};\n\n/**\n * Creates a new extension definition for installation in a Backstage app.\n *\n * @remarks\n *\n * This is a low-level function for creation of extensions with arbitrary inputs\n * and outputs and is typically only intended to be used for advanced overrides\n * or framework-level extensions. For most extension creation needs, it is\n * recommended to use existing {@link ExtensionBlueprint}s instead. You can find\n * blueprints both in the `@backstage/frontend-plugin-api` package as well as\n * other plugin libraries. There is also a list of\n * {@link https://backstage.io/docs/frontend-system/building-plugins/common-extension-blueprints | commonly used blueprints}\n * in the frontend system documentation.\n *\n * Extension definitions that are created with this function can be installed in\n * a Backstage app via a {@link FrontendPlugin} or {@link FrontendModule}.\n *\n * For more details on how extensions work, see the\n * {@link https://backstage.io/docs/frontend-system/architecture/extensions | documentation for extensions}.\n *\n * @example\n *\n * ```ts\n * const myExtension = createExtension({\n *   name: 'example',\n *   attachTo: { id: 'app', input: 'root' },\n *   output: [coreExtensionData.reactElement],\n *   factory() {\n *     return [coreExtensionData.reactElement(<h1>Hello, world!</h1>)];\n *   },\n * });\n * ```\n *\n * @public\n */\nexport function createExtension<\n  UOutput extends ExtensionDataRef,\n  TInputs extends { [inputName in string]: ExtensionInput },\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  const TKind extends string | undefined = undefined,\n  const TName extends string | undefined = undefined,\n>(\n  options: CreateExtensionOptions<\n    TKind,\n    TName,\n    UOutput,\n    TInputs,\n    TConfigSchema,\n    UFactoryOutput\n  >,\n): ExtensionDefinition<{\n  config: string extends keyof TConfigSchema\n    ? {}\n    : {\n        [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n      };\n  configInput: string extends keyof TConfigSchema\n    ? {}\n    : z.input<\n        z.ZodObject<{\n          [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n        }>\n      >;\n  // 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: TInputs;\n  params: never;\n  kind: string | undefined extends TKind ? undefined : TKind;\n  name: string | undefined extends TName ? undefined : TName;\n}> {\n  const schemaDeclaration = options.config?.schema;\n  const configSchema =\n    schemaDeclaration &&\n    createSchemaFromZod(innerZ =>\n      innerZ.object(\n        Object.fromEntries(\n          Object.entries(schemaDeclaration).map(([k, v]) => [k, v(innerZ)]),\n        ),\n      ),\n    );\n\n  return OpaqueExtensionDefinition.createInstance('v2', {\n    T: undefined as unknown as {\n      config: string extends keyof TConfigSchema\n        ? {}\n        : {\n            [key in keyof TConfigSchema]: z.infer<\n              ReturnType<TConfigSchema[key]>\n            >;\n          };\n      configInput: string extends keyof TConfigSchema\n        ? {}\n        : z.input<\n            z.ZodObject<{\n              [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n            }>\n          >;\n      output: UOutput;\n      inputs: TInputs;\n      kind: string | undefined extends TKind ? undefined : TKind;\n      name: string | undefined extends TName ? undefined : TName;\n    },\n    kind: options.kind,\n    name: options.name,\n    attachTo: options.attachTo,\n    disabled: options.disabled ?? false,\n    inputs: options.inputs ?? {},\n    output: options.output,\n    configSchema,\n    factory: options.factory,\n    toString() {\n      const parts: string[] = [];\n      if (options.kind) {\n        parts.push(`kind=${options.kind}`);\n      }\n      if (options.name) {\n        parts.push(`name=${options.name}`);\n      }\n      parts.push(\n        `attachTo=${[options.attachTo]\n          .flat()\n          .map(a => `${a.id}@${a.input}`)\n          .join('+')}`,\n      );\n      return `ExtensionDefinition{${parts.join(',')}}`;\n    },\n    override(overrideOptions) {\n      if (!Array.isArray(options.output)) {\n        throw new Error(\n          'Cannot override an extension that is not declared using the new format with outputs as an array',\n        );\n      }\n\n      // TODO(Rugvip): Making this a type check would be optimal, but it seems\n      //               like it's tricky to add that and still have the type\n      //               inference work correctly for the factory output.\n      if (overrideOptions.output && !overrideOptions.factory) {\n        throw new Error(\n          'Refused to override output without also overriding factory',\n        );\n      }\n      // TODO(Rugvip): Similar to above, would be nice to error during type checking, but don't want to complicate the types too much\n      if (overrideOptions.params && overrideOptions.factory) {\n        throw new Error(\n          'Refused to override params and factory at the same time',\n        );\n      }\n\n      return createExtension({\n        kind: options.kind,\n        name: options.name,\n        attachTo: overrideOptions.attachTo ?? options.attachTo,\n        disabled: overrideOptions.disabled ?? options.disabled,\n        inputs: { ...overrideOptions.inputs, ...options.inputs },\n        output: (overrideOptions.output ??\n          options.output) as ExtensionDataRef[],\n        config:\n          options.config || overrideOptions.config\n            ? {\n                schema: {\n                  ...options.config?.schema,\n                  ...overrideOptions.config?.schema,\n                },\n              }\n            : undefined,\n        factory: ({ node, apis, config, inputs }) => {\n          if (!overrideOptions.factory) {\n            return options.factory({\n              node,\n              apis,\n              config: config as any,\n              inputs: inputs as any,\n              [ctxParamsSymbol as any]: overrideOptions.params,\n            });\n          }\n          const parentResult = overrideOptions.factory(\n            (innerContext): ExtensionDataContainer<UOutput> => {\n              return createExtensionDataContainer<UOutput>(\n                options.factory({\n                  node,\n                  apis,\n                  config: (innerContext?.config ?? config) as any,\n                  inputs: resolveInputOverrides(\n                    options.inputs,\n                    inputs,\n                    innerContext?.inputs,\n                  ) as any,\n                  [ctxParamsSymbol as any]: innerContext?.params,\n                }) as Iterable<any>,\n                'original extension factory',\n                options.output,\n              );\n            },\n            {\n              node,\n              apis,\n              config: config as any,\n              inputs: inputs as any,\n            },\n          );\n\n          if (\n            typeof parentResult !== 'object' ||\n            !parentResult?.[Symbol.iterator]\n          ) {\n            throw new Error(\n              'extension factory override did not provide an iterable object',\n            );\n          }\n\n          const deduplicatedResult = new Map<\n            string,\n            ExtensionDataValue<any, any>\n          >();\n          for (const item of parentResult) {\n            deduplicatedResult.set(item.id, item);\n          }\n\n          return deduplicatedResult.values();\n        },\n      }) as ExtensionDefinition<any>;\n    },\n  });\n}\n"],"names":[],"mappings":";;;;;;;AAwCO,MAAM,eAAA,GAAkB,OAAO,QAAQ;AA2QvC,SAAS,gBAQd,OAAA,EAiCC;AACD,EAAA,MAAM,iBAAA,GAAoB,QAAQ,MAAA,EAAQ,MAAA;AAC1C,EAAA,MAAM,eACJ,iBAAA,IACA,mBAAA;AAAA,IAAoB,YAClB,MAAA,CAAO,MAAA;AAAA,MACL,MAAA,CAAO,WAAA;AAAA,QACL,MAAA,CAAO,OAAA,CAAQ,iBAAiB,CAAA,CAAE,IAAI,CAAC,CAAC,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA,EAAG,CAAA,CAAE,MAAM,CAAC,CAAC;AAAA;AAClE;AACF,GACF;AAEF,EAAA,OAAO,yBAAA,CAA0B,eAAe,IAAA,EAAM;AAAA,IACpD,CAAA,EAAG,MAAA;AAAA,IAoBH,MAAM,OAAA,CAAQ,IAAA;AAAA,IACd,MAAM,OAAA,CAAQ,IAAA;AAAA,IACd,UAAU,OAAA,CAAQ,QAAA;AAAA,IAClB,QAAA,EAAU,QAAQ,QAAA,IAAY,KAAA;AAAA,IAC9B,MAAA,EAAQ,OAAA,CAAQ,MAAA,IAAU,EAAC;AAAA,IAC3B,QAAQ,OAAA,CAAQ,MAAA;AAAA,IAChB,YAAA;AAAA,IACA,SAAS,OAAA,CAAQ,OAAA;AAAA,IACjB,QAAA,GAAW;AACT,MAAA,MAAM,QAAkB,EAAC;AACzB,MAAA,IAAI,QAAQ,IAAA,EAAM;AAChB,QAAA,KAAA,CAAM,IAAA,CAAK,CAAA,KAAA,EAAQ,OAAA,CAAQ,IAAI,CAAA,CAAE,CAAA;AAAA,MACnC;AACA,MAAA,IAAI,QAAQ,IAAA,EAAM;AAChB,QAAA,KAAA,CAAM,IAAA,CAAK,CAAA,KAAA,EAAQ,OAAA,CAAQ,IAAI,CAAA,CAAE,CAAA;AAAA,MACnC;AACA,MAAA,KAAA,CAAM,IAAA;AAAA,QACJ,YAAY,CAAC,OAAA,CAAQ,QAAQ,CAAA,CAC1B,IAAA,GACA,GAAA,CAAI,CAAA,CAAA,KAAK,GAAG,CAAA,CAAE,EAAE,IAAI,CAAA,CAAE,KAAK,EAAE,CAAA,CAC7B,IAAA,CAAK,GAAG,CAAC,CAAA;AAAA,OACd;AACA,MAAA,OAAO,CAAA,oBAAA,EAAuB,KAAA,CAAM,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA,CAAA;AAAA,IAC/C,CAAA;AAAA,IACA,SAAS,eAAA,EAAiB;AACxB,MAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ,MAAM,CAAA,EAAG;AAClC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAKA,MAAA,IAAI,eAAA,CAAgB,MAAA,IAAU,CAAC,eAAA,CAAgB,OAAA,EAAS;AACtD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAEA,MAAA,IAAI,eAAA,CAAgB,MAAA,IAAU,eAAA,CAAgB,OAAA,EAAS;AACrD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAEA,MAAA,OAAO,eAAA,CAAgB;AAAA,QACrB,MAAM,OAAA,CAAQ,IAAA;AAAA,QACd,MAAM,OAAA,CAAQ,IAAA;AAAA,QACd,QAAA,EAAU,eAAA,CAAgB,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QAC9C,QAAA,EAAU,eAAA,CAAgB,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QAC9C,QAAQ,EAAE,GAAG,gBAAgB,MAAA,EAAQ,GAAG,QAAQ,MAAA,EAAO;AAAA,QACvD,MAAA,EAAS,eAAA,CAAgB,MAAA,IACvB,OAAA,CAAQ,MAAA;AAAA,QACV,MAAA,EACE,OAAA,CAAQ,MAAA,IAAU,eAAA,CAAgB,MAAA,GAC9B;AAAA,UACE,MAAA,EAAQ;AAAA,YACN,GAAG,QAAQ,MAAA,EAAQ,MAAA;AAAA,YACnB,GAAG,gBAAgB,MAAA,EAAQ;AAAA;AAC7B,SACF,GACA,MAAA;AAAA,QACN,SAAS,CAAC,EAAE,MAAM,IAAA,EAAM,MAAA,EAAQ,QAAO,KAAM;AAC3C,UAAA,IAAI,CAAC,gBAAgB,OAAA,EAAS;AAC5B,YAAA,OAAO,QAAQ,OAAA,CAAQ;AAAA,cACrB,IAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA;AAAA,cACA,MAAA;AAAA,cACA,CAAC,eAAsB,GAAG,eAAA,CAAgB;AAAA,aAC3C,CAAA;AAAA,UACH;AACA,UAAA,MAAM,eAAe,eAAA,CAAgB,OAAA;AAAA,YACnC,CAAC,YAAA,KAAkD;AACjD,cAAA,OAAO,4BAAA;AAAA,gBACL,QAAQ,OAAA,CAAQ;AAAA,kBACd,IAAA;AAAA,kBACA,IAAA;AAAA,kBACA,MAAA,EAAS,cAAc,MAAA,IAAU,MAAA;AAAA,kBACjC,MAAA,EAAQ,qBAAA;AAAA,oBACN,OAAA,CAAQ,MAAA;AAAA,oBACR,MAAA;AAAA,oBACA,YAAA,EAAc;AAAA,mBAChB;AAAA,kBACA,CAAC,eAAsB,GAAG,YAAA,EAAc;AAAA,iBACzC,CAAA;AAAA,gBACD,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;AAEA,UAAA,IACE,OAAO,YAAA,KAAiB,QAAA,IACxB,CAAC,YAAA,GAAe,MAAA,CAAO,QAAQ,CAAA,EAC/B;AACA,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA,UACF;AAEA,UAAA,MAAM,kBAAA,uBAAyB,GAAA,EAG7B;AACF,UAAA,KAAA,MAAW,QAAQ,YAAA,EAAc;AAC/B,YAAA,kBAAA,CAAmB,GAAA,CAAI,IAAA,CAAK,EAAA,EAAI,IAAI,CAAA;AAAA,UACtC;AAEA,UAAA,OAAO,mBAAmB,MAAA,EAAO;AAAA,QACnC;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"createExtension.esm.js","sources":["../../src/wiring/createExtension.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiHolder, AppNode } from '../apis';\nimport { Expand } from '@backstage/types';\nimport {\n  ResolvedInputValueOverrides,\n  resolveInputOverrides,\n} from './resolveInputOverrides';\nimport {\n  createExtensionDataContainer,\n  OpaqueExtensionInput,\n} from '@internal/frontend';\nimport { ExtensionDataRef, ExtensionDataValue } from './createExtensionDataRef';\nimport { ExtensionInput } from './createExtensionInput';\nimport { z } from 'zod';\nimport { createSchemaFromZod } from '../schema/createSchemaFromZod';\nimport { OpaqueExtensionDefinition } from '@internal/frontend';\nimport { ExtensionDataContainer } from './types';\nimport {\n  ExtensionBlueprint,\n  ExtensionBlueprintDefineParams,\n} from './createExtensionBlueprint';\nimport { FrontendPlugin } from './createFrontendPlugin';\nimport { FrontendModule } from './createFrontendModule';\n\n/**\n * This symbol is used to pass parameter overrides from the extension override to the blueprint factory\n * @internal\n */\nexport const ctxParamsSymbol = Symbol('params');\n\n/**\n * Convert a single extension input into a matching resolved input.\n * @public\n */\nexport type ResolvedExtensionInput<TExtensionInput extends ExtensionInput> =\n  TExtensionInput['extensionData'] extends Array<ExtensionDataRef>\n    ? {\n        node: AppNode;\n      } & ExtensionDataContainer<TExtensionInput['extensionData'][number]>\n    : never;\n\n/**\n * Converts an extension input map into a matching collection of resolved inputs.\n * @public\n */\nexport type ResolvedExtensionInputs<\n  TInputs extends {\n    [name in string]: ExtensionInput;\n  },\n> = {\n  [InputName in keyof TInputs]: false extends TInputs[InputName]['config']['singleton']\n    ? Array<Expand<ResolvedExtensionInput<TInputs[InputName]>>>\n    : false extends TInputs[InputName]['config']['optional']\n    ? Expand<ResolvedExtensionInput<TInputs[InputName]>>\n    : Expand<ResolvedExtensionInput<TInputs[InputName]> | undefined>;\n};\n\ntype ToIntersection<U> = (U extends any ? (k: U) => void : never) extends (\n  k: infer I,\n) => void\n  ? I\n  : never;\n\ntype PopUnion<U> = ToIntersection<\n  U extends any ? () => U : never\n> extends () => infer R\n  ? [rest: Exclude<U, R>, next: R]\n  : undefined;\n\n/** @ignore */\ntype JoinStringUnion<\n  U,\n  TDiv extends string = ', ',\n  TResult extends string = '',\n> = PopUnion<U> extends [infer IRest extends string, infer INext extends string]\n  ? TResult extends ''\n    ? JoinStringUnion<IRest, TDiv, INext>\n    : JoinStringUnion<IRest, TDiv, `${TResult}${TDiv}${INext}`>\n  : TResult;\n\n/** @ignore */\nexport type RequiredExtensionIds<UExtensionData extends ExtensionDataRef> =\n  UExtensionData extends any\n    ? UExtensionData['config']['optional'] extends true\n      ? never\n      : UExtensionData['id']\n    : never;\n\n/** @ignore */\nexport type VerifyExtensionFactoryOutput<\n  UDeclaredOutput extends ExtensionDataRef,\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n> = [RequiredExtensionIds<UDeclaredOutput>] extends [UFactoryOutput['id']]\n  ? [UFactoryOutput['id']] extends [UDeclaredOutput['id']]\n    ? {}\n    : `Error: The extension factory has undeclared output(s): ${JoinStringUnion<\n        Exclude<UFactoryOutput['id'], UDeclaredOutput['id']>\n      >}`\n  : `Error: The extension factory is missing the following output(s): ${JoinStringUnion<\n      Exclude<RequiredExtensionIds<UDeclaredOutput>, UFactoryOutput['id']>\n    >}`;\n\n/** @ignore */\nexport type VerifyExtensionAttachTo<\n  UOutput extends ExtensionDataRef,\n  UParentInput extends ExtensionDataRef,\n> = ExtensionDataRef extends UParentInput\n  ? {}\n  : [RequiredExtensionIds<UParentInput>] extends [RequiredExtensionIds<UOutput>]\n  ? {}\n  : `Error: This parent extension input requires the following extension data, but it is not declared as guaranteed output of this extension: ${JoinStringUnion<\n      Exclude<RequiredExtensionIds<UParentInput>, RequiredExtensionIds<UOutput>>\n    >}`;\n\n/**\n * Specifies where an extension should attach in the extension tree.\n *\n * @remarks\n *\n * A standard attachment point declaration will specify the ID of the parent extension, as well as the name of the input to attach to.\n *\n * There are three more advanced forms that are available for more complex use-cases:\n *\n * 1. Relative attachment points: using the `relative` property instead of `id`, the attachment point is resolved relative to the current plugin.\n * 2. Extension input references: using a reference in code to another extension's input in the same plugin. These references are always relative.\n * 3. Array of attachment points: an array of attachment points can be used to clone and attach to multiple extensions at once.\n *\n * @example\n * ```ts\n * // Attach to a specific extension by full ID\n * { id: 'app/routes', input: 'routes' }\n *\n * // Attach to an extension in the same plugin by kind\n * { relative: { kind: 'page' }, input: 'actions' }\n *\n * // Attach to a specific input of another extension\n * const page = ParentBlueprint.make({ ... });\n * const child = ChildBlueprint.make({ attachTo: page.inputs.children });\n *\n * // Attach to multiple parents at once\n * [\n *   { id: 'page/home', input: 'widgets' },\n *   { relative: { kind: 'page' }, input: 'widgets' },\n * ]\n * ```\n *\n * @public\n */\nexport type ExtensionDefinitionAttachTo<\n  UParentInputs extends ExtensionDataRef = ExtensionDataRef,\n> =\n  | { id: string; input: string; relative?: never }\n  | { relative: { kind?: string; name?: string }; input: string; id?: never }\n  | ExtensionInput<UParentInputs>\n  | Array<\n      | { id: string; input: string; relative?: never }\n      | {\n          relative: { kind?: string; name?: string };\n          input: string;\n          id?: never;\n        }\n      | ExtensionInput<UParentInputs>\n    >;\n\n/** @public */\nexport type CreateExtensionOptions<\n  TKind extends string | undefined,\n  TName extends string | undefined,\n  UOutput extends ExtensionDataRef,\n  TInputs extends { [inputName in string]: ExtensionInput },\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  UParentInputs extends ExtensionDataRef,\n> = {\n  kind?: TKind;\n  name?: TName;\n  attachTo: ExtensionDefinitionAttachTo<UParentInputs> &\n    VerifyExtensionAttachTo<UOutput, UParentInputs>;\n  disabled?: boolean;\n  inputs?: TInputs;\n  output: Array<UOutput>;\n  config?: {\n    schema: TConfigSchema;\n  };\n  factory(context: {\n    node: AppNode;\n    apis: ApiHolder;\n    config: {\n      [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n    };\n    inputs: Expand<ResolvedExtensionInputs<TInputs>>;\n  }): Iterable<UFactoryOutput>;\n} & VerifyExtensionFactoryOutput<UOutput, UFactoryOutput>;\n\n/** @public */\nexport type ExtensionDefinitionParameters = {\n  kind?: string;\n  name?: string;\n  configInput?: { [K in string]: any };\n  config?: { [K in string]: any };\n  output?: ExtensionDataRef;\n  inputs?: { [KName in string]: ExtensionInput };\n  params?: object | ExtensionBlueprintDefineParams;\n};\n\n/**\n * Same as the one in `createExtensionBlueprint`, but with `ParamsFactory` inlined.\n * It can't be exported because it breaks API reports.\n * @ignore\n */\ntype AnyParamsInput<TParams extends object | ExtensionBlueprintDefineParams> =\n  TParams extends ExtensionBlueprintDefineParams<infer IParams>\n    ? IParams | ((define: TParams) => ReturnType<TParams>)\n    :\n        | TParams\n        | ((\n            define: ExtensionBlueprintDefineParams<TParams, TParams>,\n          ) => ReturnType<ExtensionBlueprintDefineParams<TParams, TParams>>);\n\n/** @public */\nexport type ExtensionDefinition<\n  T extends ExtensionDefinitionParameters = ExtensionDefinitionParameters,\n> = {\n  $$type: '@backstage/ExtensionDefinition';\n  readonly T: T;\n\n  /**\n   * References to the inputs of this extension, which can be used to attach child extensions.\n   */\n  readonly inputs: {\n    [K in keyof T['inputs']]: ExtensionInput<\n      T['inputs'][K] extends ExtensionInput<infer IData> ? IData : never\n    >;\n  };\n\n  override<\n    TExtensionConfigSchema extends {\n      [key in string]: (zImpl: typeof z) => z.ZodType;\n    },\n    UFactoryOutput extends ExtensionDataValue<any, any>,\n    UNewOutput extends ExtensionDataRef,\n    TExtraInputs extends { [inputName in string]: ExtensionInput },\n    TParamsInput extends AnyParamsInput<NonNullable<T['params']>>,\n    UParentInputs extends ExtensionDataRef,\n  >(\n    args: Expand<\n      {\n        attachTo?: ExtensionDefinitionAttachTo<UParentInputs> &\n          VerifyExtensionAttachTo<\n            ExtensionDataRef extends UNewOutput\n              ? NonNullable<T['output']>\n              : UNewOutput,\n            UParentInputs\n          >;\n        disabled?: boolean;\n        inputs?: TExtraInputs & {\n          [KName in keyof T['inputs']]?: `Error: Input '${KName &\n            string}' is already defined in parent definition`;\n        };\n        output?: Array<UNewOutput>;\n        config?: {\n          schema: TExtensionConfigSchema & {\n            [KName in keyof T['config']]?: `Error: Config key '${KName &\n              string}' is already defined in parent schema`;\n          };\n        };\n        factory?(\n          originalFactory: <\n            TFactoryParamsReturn extends AnyParamsInput<\n              NonNullable<T['params']>\n            >,\n          >(\n            context?: Expand<\n              {\n                config?: T['config'];\n                inputs?: ResolvedInputValueOverrides<NonNullable<T['inputs']>>;\n              } & ([T['params']] extends [never]\n                ? {}\n                : {\n                    params?: TFactoryParamsReturn extends ExtensionBlueprintDefineParams\n                      ? TFactoryParamsReturn\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                      : Partial<T['params']>;\n                  })\n            >,\n          ) => ExtensionDataContainer<NonNullable<T['output']>>,\n          context: {\n            node: AppNode;\n            apis: ApiHolder;\n            config: T['config'] & {\n              [key in keyof TExtensionConfigSchema]: z.infer<\n                ReturnType<TExtensionConfigSchema[key]>\n              >;\n            };\n            inputs: Expand<ResolvedExtensionInputs<T['inputs'] & TExtraInputs>>;\n          },\n        ): Iterable<UFactoryOutput>;\n      } & ([T['params']] extends [never]\n        ? {}\n        : {\n            params?: TParamsInput extends 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              : Partial<T['params']>;\n          })\n    > &\n      VerifyExtensionFactoryOutput<\n        ExtensionDataRef extends UNewOutput\n          ? NonNullable<T['output']>\n          : UNewOutput,\n        UFactoryOutput\n      >,\n  ): ExtensionDefinition<{\n    kind: T['kind'];\n    name: T['name'];\n    output: ExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: T['inputs'] & TExtraInputs;\n    config: T['config'] & {\n      [key in keyof TExtensionConfigSchema]: z.infer<\n        ReturnType<TExtensionConfigSchema[key]>\n      >;\n    };\n    configInput: T['configInput'] &\n      z.input<\n        z.ZodObject<{\n          [key in keyof TExtensionConfigSchema]: ReturnType<\n            TExtensionConfigSchema[key]\n          >;\n        }>\n      >;\n  }>;\n};\n\n/**\n * @internal\n */\nfunction bindInputs(\n  inputs: { [inputName in string]: ExtensionInput } | undefined,\n  kind?: string,\n  name?: string,\n) {\n  if (!inputs) {\n    return {};\n  }\n\n  return Object.fromEntries(\n    Object.entries(inputs).map(([inputName, input]) => [\n      inputName,\n      OpaqueExtensionInput.toInternal(input).withContext({\n        kind,\n        name,\n        input: inputName,\n      }),\n    ]),\n  );\n}\n\n/**\n * Creates a new extension definition for installation in a Backstage app.\n *\n * @remarks\n *\n * This is a low-level function for creation of extensions with arbitrary inputs\n * and outputs and is typically only intended to be used for advanced overrides\n * or framework-level extensions. For most extension creation needs, it is\n * recommended to use existing {@link ExtensionBlueprint}s instead. You can find\n * blueprints both in the `@backstage/frontend-plugin-api` package as well as\n * other plugin libraries. There is also a list of\n * {@link https://backstage.io/docs/frontend-system/building-plugins/common-extension-blueprints | commonly used blueprints}\n * in the frontend system documentation.\n *\n * Extension definitions that are created with this function can be installed in\n * a Backstage app via a {@link FrontendPlugin} or {@link FrontendModule}.\n *\n * For more details on how extensions work, see the\n * {@link https://backstage.io/docs/frontend-system/architecture/extensions | documentation for extensions}.\n *\n * @example\n *\n * ```ts\n * const myExtension = createExtension({\n *   name: 'example',\n *   attachTo: { id: 'app', input: 'root' },\n *   output: [coreExtensionData.reactElement],\n *   factory() {\n *     return [coreExtensionData.reactElement(<h1>Hello, world!</h1>)];\n *   },\n * });\n * ```\n *\n * @public\n */\nexport function createExtension<\n  UOutput extends ExtensionDataRef,\n  TInputs extends { [inputName in string]: ExtensionInput },\n  TConfigSchema extends { [key: string]: (zImpl: typeof z) => z.ZodType },\n  UFactoryOutput extends ExtensionDataValue<any, any>,\n  const TKind extends string | undefined = undefined,\n  const TName extends string | undefined = undefined,\n  UParentInputs extends ExtensionDataRef = ExtensionDataRef,\n>(\n  options: CreateExtensionOptions<\n    TKind,\n    TName,\n    UOutput,\n    TInputs,\n    TConfigSchema,\n    UFactoryOutput,\n    UParentInputs\n  >,\n): ExtensionDefinition<{\n  config: string extends keyof TConfigSchema\n    ? {}\n    : {\n        [key in keyof TConfigSchema]: z.infer<ReturnType<TConfigSchema[key]>>;\n      };\n  configInput: string extends keyof TConfigSchema\n    ? {}\n    : z.input<\n        z.ZodObject<{\n          [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n        }>\n      >;\n  // 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: TInputs;\n  params: never;\n  kind: string | undefined extends TKind ? undefined : TKind;\n  name: string | undefined extends TName ? undefined : TName;\n}> {\n  const schemaDeclaration = options.config?.schema;\n  const configSchema =\n    schemaDeclaration &&\n    createSchemaFromZod(innerZ =>\n      innerZ.object(\n        Object.fromEntries(\n          Object.entries(schemaDeclaration).map(([k, v]) => [k, v(innerZ)]),\n        ),\n      ),\n    );\n\n  return OpaqueExtensionDefinition.createInstance('v2', {\n    T: undefined as unknown as {\n      config: string extends keyof TConfigSchema\n        ? {}\n        : {\n            [key in keyof TConfigSchema]: z.infer<\n              ReturnType<TConfigSchema[key]>\n            >;\n          };\n      configInput: string extends keyof TConfigSchema\n        ? {}\n        : z.input<\n            z.ZodObject<{\n              [key in keyof TConfigSchema]: ReturnType<TConfigSchema[key]>;\n            }>\n          >;\n      output: UOutput;\n      inputs: TInputs;\n      kind: string | undefined extends TKind ? undefined : TKind;\n      name: string | undefined extends TName ? undefined : TName;\n    },\n    kind: options.kind,\n    name: options.name,\n    attachTo: options.attachTo,\n    disabled: options.disabled ?? false,\n    inputs: bindInputs(options.inputs, options.kind, options.name),\n    output: options.output,\n    configSchema,\n    factory: options.factory,\n    toString() {\n      const parts: string[] = [];\n      if (options.kind) {\n        parts.push(`kind=${options.kind}`);\n      }\n      if (options.name) {\n        parts.push(`name=${options.name}`);\n      }\n      const attachTo = [options.attachTo]\n        .flat()\n        .map(aAny => {\n          const a = aAny as ExtensionDefinitionAttachTo;\n          if (OpaqueExtensionInput.isType(a)) {\n            const { context } = OpaqueExtensionInput.toInternal(a);\n            if (!context) {\n              return '<detached-input>';\n            }\n            let id = '<plugin>';\n            if (context?.kind) {\n              id = `${context?.kind}:${id}`;\n            }\n            if (context?.name) {\n              id = `${id}/${context?.name}`;\n            }\n            return `${id}@${context.input}`;\n          }\n          if ('relative' in a && a.relative) {\n            let id = '<plugin>';\n            if (a.relative.kind) {\n              id = `${a.relative.kind}:${id}`;\n            }\n            if (a.relative.name) {\n              id = `${id}/${a.relative.name}`;\n            }\n            return `${id}@${a.input}`;\n          }\n          if ('id' in a) {\n            return `${a.id}@${a.input}`;\n          }\n          throw new Error('Invalid attachment point specification');\n        })\n        .join('+');\n      parts.push(`attachTo=${attachTo}`);\n      return `ExtensionDefinition{${parts.join(',')}}`;\n    },\n    override(overrideOptions) {\n      if (!Array.isArray(options.output)) {\n        throw new Error(\n          'Cannot override an extension that is not declared using the new format with outputs as an array',\n        );\n      }\n\n      // TODO(Rugvip): Making this a type check would be optimal, but it seems\n      //               like it's tricky to add that and still have the type\n      //               inference work correctly for the factory output.\n      if (overrideOptions.output && !overrideOptions.factory) {\n        throw new Error(\n          'Refused to override output without also overriding factory',\n        );\n      }\n      // TODO(Rugvip): Similar to above, would be nice to error during type checking, but don't want to complicate the types too much\n      if (overrideOptions.params && overrideOptions.factory) {\n        throw new Error(\n          'Refused to override params and factory at the same time',\n        );\n      }\n\n      return createExtension({\n        kind: options.kind,\n        name: options.name,\n        attachTo: (overrideOptions.attachTo ??\n          options.attachTo) as ExtensionDefinitionAttachTo,\n        disabled: overrideOptions.disabled ?? options.disabled,\n        inputs: bindInputs(\n          {\n            ...(options.inputs ?? {}),\n            ...(overrideOptions.inputs ?? {}),\n          },\n          options.kind,\n          options.name,\n        ),\n        output: (overrideOptions.output ??\n          options.output) as ExtensionDataRef[],\n        config:\n          options.config || overrideOptions.config\n            ? {\n                schema: {\n                  ...options.config?.schema,\n                  ...overrideOptions.config?.schema,\n                },\n              }\n            : undefined,\n        factory: ({ node, apis, config, inputs }) => {\n          if (!overrideOptions.factory) {\n            return options.factory({\n              node,\n              apis,\n              config: config as any,\n              inputs: inputs as any,\n              [ctxParamsSymbol as any]: overrideOptions.params,\n            });\n          }\n          const parentResult = overrideOptions.factory(\n            (innerContext): ExtensionDataContainer<UOutput> => {\n              return createExtensionDataContainer<UOutput>(\n                options.factory({\n                  node,\n                  apis,\n                  config: (innerContext?.config ?? config) as any,\n                  inputs: resolveInputOverrides(\n                    options.inputs,\n                    inputs,\n                    innerContext?.inputs,\n                  ) as any,\n                  [ctxParamsSymbol as any]: innerContext?.params,\n                }) as Iterable<any>,\n                'original extension factory',\n                options.output,\n              );\n            },\n            {\n              node,\n              apis,\n              config: config as any,\n              inputs: inputs as any,\n            },\n          );\n\n          if (\n            typeof parentResult !== 'object' ||\n            !parentResult?.[Symbol.iterator]\n          ) {\n            throw new Error(\n              'extension factory override did not provide an iterable object',\n            );\n          }\n\n          const deduplicatedResult = new Map<\n            string,\n            ExtensionDataValue<any, any>\n          >();\n          for (const item of parentResult) {\n            deduplicatedResult.set(item.id, item);\n          }\n\n          return deduplicatedResult.values();\n        },\n      }) as ExtensionDefinition<any>;\n    },\n  });\n}\n"],"names":[],"mappings":";;;;;;;;AA2CO,MAAM,eAAA,GAAkB,OAAO,QAAQ;AAsT9C,SAAS,UAAA,CACP,MAAA,EACA,IAAA,EACA,IAAA,EACA;AACA,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,EAAC;AAAA,EACV;AAEA,EAAA,OAAO,MAAA,CAAO,WAAA;AAAA,IACZ,MAAA,CAAO,QAAQ,MAAM,CAAA,CAAE,IAAI,CAAC,CAAC,SAAA,EAAW,KAAK,CAAA,KAAM;AAAA,MACjD,SAAA;AAAA,MACA,oBAAA,CAAqB,UAAA,CAAW,KAAK,CAAA,CAAE,WAAA,CAAY;AAAA,QACjD,IAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA,EAAO;AAAA,OACR;AAAA,KACF;AAAA,GACH;AACF;AAqCO,SAAS,gBASd,OAAA,EAkCC;AACD,EAAA,MAAM,iBAAA,GAAoB,QAAQ,MAAA,EAAQ,MAAA;AAC1C,EAAA,MAAM,eACJ,iBAAA,IACA,mBAAA;AAAA,IAAoB,YAClB,MAAA,CAAO,MAAA;AAAA,MACL,MAAA,CAAO,WAAA;AAAA,QACL,MAAA,CAAO,OAAA,CAAQ,iBAAiB,CAAA,CAAE,IAAI,CAAC,CAAC,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA,EAAG,CAAA,CAAE,MAAM,CAAC,CAAC;AAAA;AAClE;AACF,GACF;AAEF,EAAA,OAAO,yBAAA,CAA0B,eAAe,IAAA,EAAM;AAAA,IACpD,CAAA,EAAG,MAAA;AAAA,IAoBH,MAAM,OAAA,CAAQ,IAAA;AAAA,IACd,MAAM,OAAA,CAAQ,IAAA;AAAA,IACd,UAAU,OAAA,CAAQ,QAAA;AAAA,IAClB,QAAA,EAAU,QAAQ,QAAA,IAAY,KAAA;AAAA,IAC9B,QAAQ,UAAA,CAAW,OAAA,CAAQ,QAAQ,OAAA,CAAQ,IAAA,EAAM,QAAQ,IAAI,CAAA;AAAA,IAC7D,QAAQ,OAAA,CAAQ,MAAA;AAAA,IAChB,YAAA;AAAA,IACA,SAAS,OAAA,CAAQ,OAAA;AAAA,IACjB,QAAA,GAAW;AACT,MAAA,MAAM,QAAkB,EAAC;AACzB,MAAA,IAAI,QAAQ,IAAA,EAAM;AAChB,QAAA,KAAA,CAAM,IAAA,CAAK,CAAA,KAAA,EAAQ,OAAA,CAAQ,IAAI,CAAA,CAAE,CAAA;AAAA,MACnC;AACA,MAAA,IAAI,QAAQ,IAAA,EAAM;AAChB,QAAA,KAAA,CAAM,IAAA,CAAK,CAAA,KAAA,EAAQ,OAAA,CAAQ,IAAI,CAAA,CAAE,CAAA;AAAA,MACnC;AACA,MAAA,MAAM,QAAA,GAAW,CAAC,OAAA,CAAQ,QAAQ,EAC/B,IAAA,EAAK,CACL,IAAI,CAAA,IAAA,KAAQ;AACX,QAAA,MAAM,CAAA,GAAI,IAAA;AACV,QAAA,IAAI,oBAAA,CAAqB,MAAA,CAAO,CAAC,CAAA,EAAG;AAClC,UAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,oBAAA,CAAqB,WAAW,CAAC,CAAA;AACrD,UAAA,IAAI,CAAC,OAAA,EAAS;AACZ,YAAA,OAAO,kBAAA;AAAA,UACT;AACA,UAAA,IAAI,EAAA,GAAK,UAAA;AACT,UAAA,IAAI,SAAS,IAAA,EAAM;AACjB,YAAA,EAAA,GAAK,CAAA,EAAG,OAAA,EAAS,IAAI,CAAA,CAAA,EAAI,EAAE,CAAA,CAAA;AAAA,UAC7B;AACA,UAAA,IAAI,SAAS,IAAA,EAAM;AACjB,YAAA,EAAA,GAAK,CAAA,EAAG,EAAE,CAAA,CAAA,EAAI,OAAA,EAAS,IAAI,CAAA,CAAA;AAAA,UAC7B;AACA,UAAA,OAAO,CAAA,EAAG,EAAE,CAAA,CAAA,EAAI,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,QAC/B;AACA,QAAA,IAAI,UAAA,IAAc,CAAA,IAAK,CAAA,CAAE,QAAA,EAAU;AACjC,UAAA,IAAI,EAAA,GAAK,UAAA;AACT,UAAA,IAAI,CAAA,CAAE,SAAS,IAAA,EAAM;AACnB,YAAA,EAAA,GAAK,CAAA,EAAG,CAAA,CAAE,QAAA,CAAS,IAAI,IAAI,EAAE,CAAA,CAAA;AAAA,UAC/B;AACA,UAAA,IAAI,CAAA,CAAE,SAAS,IAAA,EAAM;AACnB,YAAA,EAAA,GAAK,CAAA,EAAG,EAAE,CAAA,CAAA,EAAI,CAAA,CAAE,SAAS,IAAI,CAAA,CAAA;AAAA,UAC/B;AACA,UAAA,OAAO,CAAA,EAAG,EAAE,CAAA,CAAA,EAAI,CAAA,CAAE,KAAK,CAAA,CAAA;AAAA,QACzB;AACA,QAAA,IAAI,QAAQ,CAAA,EAAG;AACb,UAAA,OAAO,CAAA,EAAG,CAAA,CAAE,EAAE,CAAA,CAAA,EAAI,EAAE,KAAK,CAAA,CAAA;AAAA,QAC3B;AACA,QAAA,MAAM,IAAI,MAAM,wCAAwC,CAAA;AAAA,MAC1D,CAAC,CAAA,CACA,IAAA,CAAK,GAAG,CAAA;AACX,MAAA,KAAA,CAAM,IAAA,CAAK,CAAA,SAAA,EAAY,QAAQ,CAAA,CAAE,CAAA;AACjC,MAAA,OAAO,CAAA,oBAAA,EAAuB,KAAA,CAAM,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA,CAAA;AAAA,IAC/C,CAAA;AAAA,IACA,SAAS,eAAA,EAAiB;AACxB,MAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ,MAAM,CAAA,EAAG;AAClC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAKA,MAAA,IAAI,eAAA,CAAgB,MAAA,IAAU,CAAC,eAAA,CAAgB,OAAA,EAAS;AACtD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAEA,MAAA,IAAI,eAAA,CAAgB,MAAA,IAAU,eAAA,CAAgB,OAAA,EAAS;AACrD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAEA,MAAA,OAAO,eAAA,CAAgB;AAAA,QACrB,MAAM,OAAA,CAAQ,IAAA;AAAA,QACd,MAAM,OAAA,CAAQ,IAAA;AAAA,QACd,QAAA,EAAW,eAAA,CAAgB,QAAA,IACzB,OAAA,CAAQ,QAAA;AAAA,QACV,QAAA,EAAU,eAAA,CAAgB,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QAC9C,MAAA,EAAQ,UAAA;AAAA,UACN;AAAA,YACE,GAAI,OAAA,CAAQ,MAAA,IAAU,EAAC;AAAA,YACvB,GAAI,eAAA,CAAgB,MAAA,IAAU;AAAC,WACjC;AAAA,UACA,OAAA,CAAQ,IAAA;AAAA,UACR,OAAA,CAAQ;AAAA,SACV;AAAA,QACA,MAAA,EAAS,eAAA,CAAgB,MAAA,IACvB,OAAA,CAAQ,MAAA;AAAA,QACV,MAAA,EACE,OAAA,CAAQ,MAAA,IAAU,eAAA,CAAgB,MAAA,GAC9B;AAAA,UACE,MAAA,EAAQ;AAAA,YACN,GAAG,QAAQ,MAAA,EAAQ,MAAA;AAAA,YACnB,GAAG,gBAAgB,MAAA,EAAQ;AAAA;AAC7B,SACF,GACA,MAAA;AAAA,QACN,SAAS,CAAC,EAAE,MAAM,IAAA,EAAM,MAAA,EAAQ,QAAO,KAAM;AAC3C,UAAA,IAAI,CAAC,gBAAgB,OAAA,EAAS;AAC5B,YAAA,OAAO,QAAQ,OAAA,CAAQ;AAAA,cACrB,IAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA;AAAA,cACA,MAAA;AAAA,cACA,CAAC,eAAsB,GAAG,eAAA,CAAgB;AAAA,aAC3C,CAAA;AAAA,UACH;AACA,UAAA,MAAM,eAAe,eAAA,CAAgB,OAAA;AAAA,YACnC,CAAC,YAAA,KAAkD;AACjD,cAAA,OAAO,4BAAA;AAAA,gBACL,QAAQ,OAAA,CAAQ;AAAA,kBACd,IAAA;AAAA,kBACA,IAAA;AAAA,kBACA,MAAA,EAAS,cAAc,MAAA,IAAU,MAAA;AAAA,kBACjC,MAAA,EAAQ,qBAAA;AAAA,oBACN,OAAA,CAAQ,MAAA;AAAA,oBACR,MAAA;AAAA,oBACA,YAAA,EAAc;AAAA,mBAChB;AAAA,kBACA,CAAC,eAAsB,GAAG,YAAA,EAAc;AAAA,iBACzC,CAAA;AAAA,gBACD,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;AAEA,UAAA,IACE,OAAO,YAAA,KAAiB,QAAA,IACxB,CAAC,YAAA,GAAe,MAAA,CAAO,QAAQ,CAAA,EAC/B;AACA,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA,UACF;AAEA,UAAA,MAAM,kBAAA,uBAAyB,GAAA,EAG7B;AACF,UAAA,KAAA,MAAW,QAAQ,YAAA,EAAc;AAC/B,YAAA,kBAAA,CAAmB,GAAA,CAAI,IAAA,CAAK,EAAA,EAAI,IAAI,CAAA;AAAA,UACtC;AAEA,UAAA,OAAO,mBAAmB,MAAA,EAAO;AAAA,QACnC;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH;;;;"}

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  ExtensionAttachToSpec,\n  ExtensionDefinition,\n  ResolvedExtensionInputs,\n  VerifyExtensionFactoryOutput,\n  createExtension,\n  ctxParamsSymbol,\n} from './createExtension';\nimport { z } from 'zod';\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';\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> = {\n  kind: TKind;\n  attachTo: ExtensionAttachToSpec;\n  disabled?: boolean;\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  >(args: {\n    name?: TName;\n    attachTo?: ExtensionAttachToSpec;\n    disabled?: boolean;\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  }): ExtensionDefinition<{\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    TExtraInputs extends { [inputName in string]: ExtensionInput },\n  >(args: {\n    name?: TName;\n    attachTo?: ExtensionAttachToSpec;\n    disabled?: boolean;\n    inputs?: TExtraInputs & {\n      [KName in keyof T['inputs']]?: `Error: Input '${KName &\n        string}' is already defined in parent definition`;\n    };\n    output?: Array<UNewOutput>;\n    config?: {\n      schema: TExtensionConfigSchema & {\n        [KName in keyof T['config']]?: `Error: Config key '${KName &\n          string}' is already defined in parent schema`;\n      };\n    };\n    factory(\n      originalFactory: <\n        TParamsInput extends AnyParamsInput<NonNullable<T['params']>>,\n      >(\n        params: TParamsInput extends 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  }): ExtensionDefinition<{\n    config: (string extends keyof TExtensionConfigSchema\n      ? {}\n      : {\n          [key in keyof TExtensionConfigSchema]: z.infer<\n            ReturnType<TExtensionConfigSchema[key]>\n          >;\n        }) &\n      T['config'];\n    configInput: (string extends keyof TExtensionConfigSchema\n      ? {}\n      : z.input<\n          z.ZodObject<{\n            [key in keyof TExtensionConfigSchema]: ReturnType<\n              TExtensionConfigSchema[key]\n            >;\n          }>\n        >) &\n      T['configInput'];\n    output: ExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: 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  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  >,\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 ?? options.attachTo,\n        disabled: args.disabled ?? options.disabled,\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 ExtensionDefinition;\n    },\n    makeWithOverrides(args) {\n      return createExtension({\n        kind: options.kind,\n        name: args.name,\n        attachTo: args.attachTo ?? options.attachTo,\n        disabled: args.disabled ?? options.disabled,\n        inputs: { ...args.inputs, ...options.inputs },\n        output: (args.output ?? options.output) as 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 ExtensionDefinition;\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":";;;;;AAwEA,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;AAgOA,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,yBASd,OAAA,EAgCC;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,EAAU,IAAA,CAAK,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QACnC,QAAA,EAAU,IAAA,CAAK,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QACnC,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,EAAU,IAAA,CAAK,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QACnC,QAAA,EAAU,IAAA,CAAK,QAAA,IAAY,OAAA,CAAQ,QAAA;AAAA,QACnC,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  ExtensionDefinition,\n  ResolvedExtensionInputs,\n  VerifyExtensionFactoryOutput,\n  createExtension,\n  ctxParamsSymbol,\n  VerifyExtensionAttachTo,\n} from './createExtension';\nimport { z } from 'zod';\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';\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  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    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  }): ExtensionDefinition<{\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    TExtraInputs extends { [inputName in string]: ExtensionInput },\n    UParentInputs extends ExtensionDataRef,\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    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  }): ExtensionDefinition<{\n    config: (string extends keyof TExtensionConfigSchema\n      ? {}\n      : {\n          [key in keyof TExtensionConfigSchema]: z.infer<\n            ReturnType<TExtensionConfigSchema[key]>\n          >;\n        }) &\n      T['config'];\n    configInput: (string extends keyof TExtensionConfigSchema\n      ? {}\n      : z.input<\n          z.ZodObject<{\n            [key in keyof TExtensionConfigSchema]: ReturnType<\n              TExtensionConfigSchema[key]\n            >;\n          }>\n        >) &\n      T['configInput'];\n    output: ExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;\n    inputs: 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        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 ExtensionDefinition;\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        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 ExtensionDefinition;\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":";;;;;AAyEA,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;AA2OA,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,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,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;;;;"}

package/dist/wiring/createExtensionInput.esm.js

@@ -1,3 +1,5 @@
+import { OpaqueExtensionInput } from '../frontend-internal/src/wiring/InternalExtensionInput.esm.js';
+
 function createExtensionInput(extensionData, config) {
   if (process.env.NODE_ENV !== "production") {
     if (Array.isArray(extensionData)) {
@@ -19,8 +21,7 @@ function createExtensionInput(extensionData, config) {
       }
     }
   }
-  return {
-    $$type: "@backstage/ExtensionInput",
+  const baseOptions = {
     extensionData,
     config: {
       singleton: Boolean(config?.singleton),
@@ -28,6 +29,14 @@ function createExtensionInput(extensionData, config) {
     },
     replaces: config?.replaces
   };
+  function createInstance(parent) {
+    return OpaqueExtensionInput.createInstance(void 0, {
+      ...baseOptions,
+      context: parent,
+      withContext: createInstance
+    });
+  }
+  return createInstance();
 }
 
 export { createExtensionInput };

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

@@ -1 +1 @@
-{"version":3,"file":"createExtensionInput.esm.js","sources":["../../src/wiring/createExtensionInput.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 { ExtensionDataRef } from './createExtensionDataRef';\n\n/** @public */\nexport interface ExtensionInput<\n  UExtensionData extends ExtensionDataRef<\n    unknown,\n    string,\n    { optional?: true }\n  > = ExtensionDataRef,\n  TConfig extends { singleton: boolean; optional: boolean } = {\n    singleton: boolean;\n    optional: boolean;\n  },\n> {\n  $$type: '@backstage/ExtensionInput';\n  extensionData: Array<UExtensionData>;\n  config: TConfig;\n  replaces?: Array<{ id: string; input: string }>;\n}\n\n/** @public */\nexport function createExtensionInput<\n  UExtensionData extends ExtensionDataRef<unknown, string, { optional?: true }>,\n  TConfig extends { singleton?: boolean; optional?: boolean },\n>(\n  extensionData: Array<UExtensionData>,\n  config?: TConfig & { replaces?: Array<{ id: string; input: string }> },\n): ExtensionInput<\n  UExtensionData,\n  {\n    singleton: TConfig['singleton'] extends true ? true : false;\n    optional: TConfig['optional'] extends true ? true : false;\n  }\n> {\n  if (process.env.NODE_ENV !== 'production') {\n    if (Array.isArray(extensionData)) {\n      const seen = new Set();\n      const duplicates = [];\n      for (const dataRef of extensionData) {\n        if (seen.has(dataRef.id)) {\n          duplicates.push(dataRef.id);\n        } else {\n          seen.add(dataRef.id);\n        }\n      }\n      if (duplicates.length > 0) {\n        throw new Error(\n          `ExtensionInput may not have duplicate data refs: '${duplicates.join(\n            \"', '\",\n          )}'`,\n        );\n      }\n    }\n  }\n  return {\n    $$type: '@backstage/ExtensionInput',\n    extensionData,\n    config: {\n      singleton: Boolean(config?.singleton) as TConfig['singleton'] extends true\n        ? true\n        : false,\n      optional: Boolean(config?.optional) as TConfig['optional'] extends true\n        ? true\n        : false,\n    },\n    replaces: config?.replaces,\n  } as ExtensionInput<\n    UExtensionData,\n    {\n      singleton: TConfig['singleton'] extends true ? true : false;\n      optional: TConfig['optional'] extends true ? true : false;\n    }\n  >;\n}\n"],"names":[],"mappings":"AAqCO,SAAS,oBAAA,CAId,eACA,MAAA,EAOA;AACA,EAAA,IAAI,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,YAAA,EAAc;AACzC,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,aAAa,CAAA,EAAG;AAChC,MAAA,MAAM,IAAA,uBAAW,GAAA,EAAI;AACrB,MAAA,MAAM,aAAa,EAAC;AACpB,MAAA,KAAA,MAAW,WAAW,aAAA,EAAe;AACnC,QAAA,IAAI,IAAA,CAAK,GAAA,CAAI,OAAA,CAAQ,EAAE,CAAA,EAAG;AACxB,UAAA,UAAA,CAAW,IAAA,CAAK,QAAQ,EAAE,CAAA;AAAA,QAC5B,CAAA,MAAO;AACL,UAAA,IAAA,CAAK,GAAA,CAAI,QAAQ,EAAE,CAAA;AAAA,QACrB;AAAA,MACF;AACA,MAAA,IAAI,UAAA,CAAW,SAAS,CAAA,EAAG;AACzB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,qDAAqD,UAAA,CAAW,IAAA;AAAA,YAC9D;AAAA,WACD,CAAA,CAAA;AAAA,SACH;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,2BAAA;AAAA,IACR,aAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,SAAA,EAAW,OAAA,CAAQ,MAAA,EAAQ,SAAS,CAAA;AAAA,MAGpC,QAAA,EAAU,OAAA,CAAQ,MAAA,EAAQ,QAAQ;AAAA,KAGpC;AAAA,IACA,UAAU,MAAA,EAAQ;AAAA,GACpB;AAOF;;;;"}
+{"version":3,"file":"createExtensionInput.esm.js","sources":["../../src/wiring/createExtensionInput.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  ExtensionInputContext,\n  OpaqueExtensionInput,\n} from '@internal/frontend';\nimport { ExtensionDataRef } from './createExtensionDataRef';\n\n/** @public */\nexport interface ExtensionInput<\n  UExtensionData extends ExtensionDataRef<\n    unknown,\n    string,\n    { optional?: true }\n  > = ExtensionDataRef,\n  TConfig extends { singleton: boolean; optional: boolean } = {\n    singleton: boolean;\n    optional: boolean;\n  },\n> {\n  readonly $$type: '@backstage/ExtensionInput';\n  readonly extensionData: Array<UExtensionData>;\n  readonly config: TConfig;\n  readonly replaces?: Array<{ id: string; input: string }>;\n}\n\n/** @public */\nexport function createExtensionInput<\n  UExtensionData extends ExtensionDataRef<unknown, string, { optional?: true }>,\n  TConfig extends { singleton?: boolean; optional?: boolean },\n>(\n  extensionData: Array<UExtensionData>,\n  config?: TConfig & { replaces?: Array<{ id: string; input: string }> },\n): ExtensionInput<\n  UExtensionData,\n  {\n    singleton: TConfig['singleton'] extends true ? true : false;\n    optional: TConfig['optional'] extends true ? true : false;\n  }\n> {\n  if (process.env.NODE_ENV !== 'production') {\n    if (Array.isArray(extensionData)) {\n      const seen = new Set();\n      const duplicates = [];\n      for (const dataRef of extensionData) {\n        if (seen.has(dataRef.id)) {\n          duplicates.push(dataRef.id);\n        } else {\n          seen.add(dataRef.id);\n        }\n      }\n      if (duplicates.length > 0) {\n        throw new Error(\n          `ExtensionInput may not have duplicate data refs: '${duplicates.join(\n            \"', '\",\n          )}'`,\n        );\n      }\n    }\n  }\n  const baseOptions = {\n    extensionData,\n    config: {\n      singleton: Boolean(config?.singleton) as TConfig['singleton'] extends true\n        ? true\n        : false,\n      optional: Boolean(config?.optional) as TConfig['optional'] extends true\n        ? true\n        : false,\n    },\n    replaces: config?.replaces,\n  };\n\n  function createInstance(parent?: ExtensionInputContext): ExtensionInput<\n    UExtensionData,\n    {\n      singleton: TConfig['singleton'] extends true ? true : false;\n      optional: TConfig['optional'] extends true ? true : false;\n    }\n  > {\n    return OpaqueExtensionInput.createInstance(undefined, {\n      ...baseOptions,\n      context: parent,\n      withContext: createInstance,\n    });\n  }\n\n  return createInstance();\n}\n"],"names":[],"mappings":";;AAyCO,SAAS,oBAAA,CAId,eACA,MAAA,EAOA;AACA,EAAA,IAAI,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,YAAA,EAAc;AACzC,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,aAAa,CAAA,EAAG;AAChC,MAAA,MAAM,IAAA,uBAAW,GAAA,EAAI;AACrB,MAAA,MAAM,aAAa,EAAC;AACpB,MAAA,KAAA,MAAW,WAAW,aAAA,EAAe;AACnC,QAAA,IAAI,IAAA,CAAK,GAAA,CAAI,OAAA,CAAQ,EAAE,CAAA,EAAG;AACxB,UAAA,UAAA,CAAW,IAAA,CAAK,QAAQ,EAAE,CAAA;AAAA,QAC5B,CAAA,MAAO;AACL,UAAA,IAAA,CAAK,GAAA,CAAI,QAAQ,EAAE,CAAA;AAAA,QACrB;AAAA,MACF;AACA,MAAA,IAAI,UAAA,CAAW,SAAS,CAAA,EAAG;AACzB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,qDAAqD,UAAA,CAAW,IAAA;AAAA,YAC9D;AAAA,WACD,CAAA,CAAA;AAAA,SACH;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,EAAA,MAAM,WAAA,GAAc;AAAA,IAClB,aAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,SAAA,EAAW,OAAA,CAAQ,MAAA,EAAQ,SAAS,CAAA;AAAA,MAGpC,QAAA,EAAU,OAAA,CAAQ,MAAA,EAAQ,QAAQ;AAAA,KAGpC;AAAA,IACA,UAAU,MAAA,EAAQ;AAAA,GACpB;AAEA,EAAA,SAAS,eAAe,MAAA,EAMtB;AACA,IAAA,OAAO,oBAAA,CAAqB,eAAe,MAAA,EAAW;AAAA,MACpD,GAAG,WAAA;AAAA,MACH,OAAA,EAAS,MAAA;AAAA,MACT,WAAA,EAAa;AAAA,KACd,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,cAAA,EAAe;AACxB;;;;"}

package/dist/wiring/createFrontendPlugin.esm.js

@@ -1,7 +1,8 @@
 import { resolveExtensionDefinition } from './resolveExtensionDefinition.esm.js';
 import { OpaqueFrontendPlugin } from '../frontend-internal/src/wiring/InternalFrontendPlugin.esm.js';
-import '../frontend-internal/src/wiring/InternalSwappableComponentRef.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/InternalSwappableComponentRef.esm.js';
 
 function createFrontendPlugin(options) {
   const pluginId = options.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 { ExtensionDefinition } from './createExtension';\nimport {\n  Extension,\n  resolveExtensionDefinition,\n} from './resolveExtensionDefinition';\nimport { FeatureFlagConfig } from './types';\nimport { MakeSortedExtensionsMap } from './MakeSortedExtensionsMap';\nimport { JsonObject } from '@backstage/types';\nimport { RouteRef, SubRouteRef, ExternalRouteRef } from '../routing';\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>(id: TId): TExtensionMap[TId];\n  withOverrides(options: {\n    extensions: Array<ExtensionDefinition>;\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  readonly id: string;\n  readonly routes: TRoutes;\n  readonly externalRoutes: TExternalRoutes;\n\n  /**\n   * Loads the plugin info.\n   */\n  info(): Promise<FrontendPluginInfo>;\n}\n\n/** @public */\nexport interface 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> {\n  pluginId: TId;\n  routes?: TRoutes;\n  externalRoutes?: TExternalRoutes;\n  extensions?: TExtensions;\n  featureFlags?: FeatureFlagConfig[];\n  info?: FrontendPluginInfoOptions;\n}\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: PluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>,\n): OverridableFrontendPlugin<\n  TRoutes,\n  TExternalRoutes,\n  MakeSortedExtensionsMap<TExtensions[number], TId>\n> {\n  const pluginId = options.pluginId;\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    id: pluginId,\n    routes: options.routes ?? ({} as TRoutes),\n    externalRoutes: options.externalRoutes ?? ({} as TExternalRoutes),\n    featureFlags: options.featureFlags ?? [],\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      const overriddenExtensionIds = new Set(\n        overrides.extensions.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        extensions: [...nonOverriddenExtensions, ...overrides.extensions],\n        info: {\n          ...options.info,\n          ...overrides.info,\n        },\n      });\n    },\n  });\n}\n"],"names":[],"mappings":";;;;;AAsLO,SAAS,qBAMd,OAAA,EAKA;AACA,EAAA,MAAM,WAAW,OAAA,CAAQ,QAAA;AAEzB,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,EAAA,EAAI,QAAA;AAAA,IACJ,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,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,MAAM,yBAAyB,IAAI,GAAA;AAAA,QACjC,UAAU,UAAA,CAAW,GAAA;AAAA,UACnB,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,YAAY,CAAC,GAAG,uBAAA,EAAyB,GAAG,UAAU,UAAU,CAAA;AAAA,QAChE,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 {\n  OpaqueExtensionDefinition,\n  OpaqueFrontendPlugin,\n} from '@internal/frontend';\nimport { ExtensionDefinition } from './createExtension';\nimport {\n  Extension,\n  resolveExtensionDefinition,\n} from './resolveExtensionDefinition';\nimport { FeatureFlagConfig } from './types';\nimport { MakeSortedExtensionsMap } from './MakeSortedExtensionsMap';\nimport { JsonObject } from '@backstage/types';\nimport { RouteRef, SubRouteRef, ExternalRouteRef } from '../routing';\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>(id: TId): TExtensionMap[TId];\n  withOverrides(options: {\n    extensions: Array<ExtensionDefinition>;\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  readonly id: string;\n  readonly routes: TRoutes;\n  readonly externalRoutes: TExternalRoutes;\n\n  /**\n   * Loads the plugin info.\n   */\n  info(): Promise<FrontendPluginInfo>;\n}\n\n/** @public */\nexport interface 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> {\n  pluginId: TId;\n  routes?: TRoutes;\n  externalRoutes?: TExternalRoutes;\n  extensions?: TExtensions;\n  featureFlags?: FeatureFlagConfig[];\n  info?: FrontendPluginInfoOptions;\n}\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: PluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>,\n): OverridableFrontendPlugin<\n  TRoutes,\n  TExternalRoutes,\n  MakeSortedExtensionsMap<TExtensions[number], TId>\n> {\n  const pluginId = options.pluginId;\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    id: pluginId,\n    routes: options.routes ?? ({} as TRoutes),\n    externalRoutes: options.externalRoutes ?? ({} as TExternalRoutes),\n    featureFlags: options.featureFlags ?? [],\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      const overriddenExtensionIds = new Set(\n        overrides.extensions.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        extensions: [...nonOverriddenExtensions, ...overrides.extensions],\n        info: {\n          ...options.info,\n          ...overrides.info,\n        },\n      });\n    },\n  });\n}\n"],"names":[],"mappings":";;;;;;AAsLO,SAAS,qBAMd,OAAA,EAKA;AACA,EAAA,MAAM,WAAW,OAAA,CAAQ,QAAA;AAEzB,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,EAAA,EAAI,QAAA;AAAA,IACJ,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,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,MAAM,yBAAyB,IAAI,GAAA;AAAA,QACjC,UAAU,UAAA,CAAW,GAAA;AAAA,UACnB,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,YAAY,CAAC,GAAG,uBAAA,EAAyB,GAAG,UAAU,UAAU,CAAA;AAAA,QAChE,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

@@ -1,24 +1,64 @@
 import { OpaqueExtensionDefinition } from '../frontend-internal/src/wiring/InternalExtensionDefinition.esm.js';
+import { OpaqueExtensionInput } from '../frontend-internal/src/wiring/InternalExtensionInput.esm.js';
 
+function resolveExtensionId(kind, namespace, name) {
+  const namePart = name && namespace ? `${namespace}/${name}` : namespace || name;
+  if (!namePart) {
+    throw new Error(
+      `Extension must declare an explicit namespace or name as it could not be resolved from context, kind=${kind} namespace=${namespace} name=${name}`
+    );
+  }
+  return kind ? `${kind}:${namePart}` : namePart;
+}
+function resolveAttachTo(attachTo, namespace) {
+  const resolveSpec = (spec) => {
+    if (OpaqueExtensionInput.isType(spec)) {
+      const { context } = OpaqueExtensionInput.toInternal(spec);
+      if (!context) {
+        throw new Error(
+          "Invalid input object without a parent extension used as attachment point"
+        );
+      }
+      return {
+        id: resolveExtensionId(context.kind, namespace, context.name),
+        input: context.input
+      };
+    }
+    if ("relative" in spec && spec.relative) {
+      return {
+        id: resolveExtensionId(
+          spec.relative.kind,
+          namespace,
+          spec.relative.name
+        ),
+        input: spec.input
+      };
+    }
+    if ("id" in spec) {
+      return { id: spec.id, input: spec.input };
+    }
+    throw new Error("Invalid attachment point specification");
+  };
+  if (Array.isArray(attachTo)) {
+    return attachTo.map(resolveSpec);
+  }
+  return resolveSpec(attachTo);
+}
 function resolveExtensionDefinition(definition, context) {
   const internalDefinition = OpaqueExtensionDefinition.toInternal(definition);
   const {
     name,
     kind,
-    namespace: _skip1,
+    namespace: internalNamespace,
     override: _skip2,
+    attachTo,
     ...rest
   } = internalDefinition;
-  const namespace = internalDefinition.namespace ?? context?.namespace;
-  const namePart = name && namespace ? `${namespace}/${name}` : namespace || name;
-  if (!namePart) {
-    throw new Error(
-      `Extension must declare an explicit namespace or name as it could not be resolved from context, kind=${kind} namespace=${namespace} name=${name}`
-    );
-  }
-  const id = kind ? `${kind}:${namePart}` : namePart;
+  const namespace = internalNamespace ?? context?.namespace;
+  const id = resolveExtensionId(kind, namespace, name);
   return {
     ...rest,
+    attachTo: resolveAttachTo(attachTo, namespace),
     $$type: "@backstage/Extension",
     version: internalDefinition.version,
     id,

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

@@ -1 +1 @@
-{"version":3,"file":"resolveExtensionDefinition.esm.js","sources":["../../src/wiring/resolveExtensionDefinition.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiHolder, AppNode } from '../apis';\nimport {\n  ExtensionAttachToSpec,\n  ExtensionDefinition,\n  ExtensionDefinitionParameters,\n  ResolvedExtensionInputs,\n} from './createExtension';\nimport { PortableSchema } from '../schema';\nimport { ExtensionInput } from './createExtensionInput';\nimport { ExtensionDataRef, ExtensionDataValue } from './createExtensionDataRef';\nimport { OpaqueExtensionDefinition } from '@internal/frontend';\n\n/** @public */\nexport interface Extension<TConfig, TConfigInput = TConfig> {\n  $$type: '@backstage/Extension';\n  readonly id: string;\n  readonly attachTo: ExtensionAttachToSpec;\n  readonly disabled: boolean;\n  readonly configSchema?: PortableSchema<TConfig, TConfigInput>;\n}\n\n/** @internal */\nexport type InternalExtension<TConfig, TConfigInput> = Extension<\n  TConfig,\n  TConfigInput\n> &\n  (\n    | {\n        readonly version: 'v1';\n        readonly inputs: {\n          [inputName in string]: {\n            $$type: '@backstage/ExtensionInput';\n            extensionData: {\n              [name in string]: 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 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\n/** @internal */\nexport function resolveExtensionDefinition<\n  T extends ExtensionDefinitionParameters,\n>(\n  definition: ExtensionDefinition<T>,\n  context?: { namespace?: string },\n): Extension<T['config'], T['configInput']> {\n  const internalDefinition = OpaqueExtensionDefinition.toInternal(definition);\n  const {\n    name,\n    kind,\n    namespace: _skip1,\n    override: _skip2,\n    ...rest\n  } = internalDefinition;\n\n  const namespace = internalDefinition.namespace ?? context?.namespace;\n\n  const namePart =\n    name && namespace ? `${namespace}/${name}` : namespace || name;\n  if (!namePart) {\n    throw new Error(\n      `Extension must declare an explicit namespace or name as it could not be resolved from context, kind=${kind} namespace=${namespace} name=${name}`,\n    );\n  }\n\n  const id = kind ? `${kind}:${namePart}` : namePart;\n\n  return {\n    ...rest,\n    $$type: '@backstage/Extension',\n    version: internalDefinition.version,\n    id,\n    toString() {\n      return `Extension{id=${id}}`;\n    },\n  } as InternalExtension<T['config'], T['configInput']> & Object;\n}\n"],"names":[],"mappings":";;AAyHO,SAAS,0BAAA,CAGd,YACA,OAAA,EAC0C;AAC1C,EAAA,MAAM,kBAAA,GAAqB,yBAAA,CAA0B,UAAA,CAAW,UAAU,CAAA;AAC1E,EAAA,MAAM;AAAA,IACJ,IAAA;AAAA,IACA,IAAA;AAAA,IACA,SAAA,EAAW,MAAA;AAAA,IACX,QAAA,EAAU,MAAA;AAAA,IACV,GAAG;AAAA,GACL,GAAI,kBAAA;AAEJ,EAAA,MAAM,SAAA,GAAY,kBAAA,CAAmB,SAAA,IAAa,OAAA,EAAS,SAAA;AAE3D,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,MAAM,KAAK,IAAA,GAAO,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,QAAQ,CAAA,CAAA,GAAK,QAAA;AAE1C,EAAA,OAAO;AAAA,IACL,GAAG,IAAA;AAAA,IACH,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';\n\n/** @public */\nexport type ExtensionAttachTo =\n  | { id: string; input: string }\n  | Array<{ id: string; input: string }>;\n\n/**\n * @deprecated Use {@link ExtensionAttachTo} instead.\n * @public\n */\nexport type ExtensionAttachToSpec = ExtensionAttachTo;\n\n/** @public */\nexport interface Extension<TConfig, TConfigInput = TConfig> {\n  $$type: '@backstage/Extension';\n  readonly id: string;\n  readonly attachTo: ExtensionAttachToSpec;\n  readonly disabled: boolean;\n  readonly configSchema?: PortableSchema<TConfig, TConfigInput>;\n}\n\n/** @internal */\nexport type InternalExtension<TConfig, TConfigInput> = Extension<\n  TConfig,\n  TConfigInput\n> &\n  (\n    | {\n        readonly version: 'v1';\n        readonly inputs: {\n          [inputName in string]: {\n            $$type: '@backstage/ExtensionInput';\n            extensionData: {\n              [name in string]: 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 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,\n  namespace?: string,\n): ExtensionAttachToSpec {\n  const resolveSpec = (\n    spec: Exclude<ExtensionDefinitionAttachTo, Array<any>>,\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),\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":";;;AAsIA,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,EACuB;AACvB,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;;;;"}

package/dist/wiring/resolveInputOverrides.esm.js

@@ -1,7 +1,8 @@
 import { createExtensionDataContainer } from '../frontend-internal/src/wiring/createExtensionDataContainer.esm.js';
-import '../frontend-internal/src/wiring/InternalSwappableComponentRef.esm.js';
 import '../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';
 
 function expectArray(value) {
   return value;

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

@@ -1 +1 @@
-{"version":3,"file":"resolveInputOverrides.esm.js","sources":["../../src/wiring/resolveInputOverrides.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 { AppNode } from '../apis';\nimport { Expand } from '@backstage/types';\nimport { ResolvedExtensionInput } from './createExtension';\nimport { createExtensionDataContainer } from '@internal/frontend';\nimport {\n  ExtensionDataRefToValue,\n  ExtensionDataValue,\n} from './createExtensionDataRef';\nimport { ExtensionInput } from './createExtensionInput';\nimport { ExtensionDataContainer } from './types';\n\n/** @ignore */\nexport type ResolvedInputValueOverrides<\n  TInputs extends { [inputName in string]: ExtensionInput } = {\n    [inputName in string]: ExtensionInput;\n  },\n> = Expand<\n  {\n    [KName in keyof TInputs as TInputs[KName] extends ExtensionInput<\n      any,\n      {\n        optional: infer IOptional extends boolean;\n        singleton: boolean;\n      }\n    >\n      ? IOptional extends true\n        ? never\n        : KName\n      : never]: TInputs[KName] extends ExtensionInput<\n      infer IDataRefs,\n      { optional: boolean; singleton: infer ISingleton extends boolean }\n    >\n      ? ISingleton extends true\n        ? Iterable<ExtensionDataRefToValue<IDataRefs>>\n        : Array<Iterable<ExtensionDataRefToValue<IDataRefs>>>\n      : never;\n  } & {\n    [KName in keyof TInputs as TInputs[KName] extends ExtensionInput<\n      any,\n      {\n        optional: infer IOptional extends boolean;\n        singleton: boolean;\n      }\n    >\n      ? IOptional extends true\n        ? KName\n        : never\n      : never]?: TInputs[KName] extends ExtensionInput<\n      infer IDataRefs,\n      { optional: boolean; singleton: infer ISingleton extends boolean }\n    >\n      ? ISingleton extends true\n        ? Iterable<ExtensionDataRefToValue<IDataRefs>>\n        : Array<Iterable<ExtensionDataRefToValue<IDataRefs>>>\n      : never;\n  }\n>;\n\nfunction expectArray<T>(value: T | T[]): T[] {\n  return value as T[];\n}\nfunction expectItem<T>(value: T | T[]): T {\n  return value as T;\n}\n\n/** @internal */\nexport function resolveInputOverrides(\n  declaredInputs?: { [inputName in string]: ExtensionInput },\n  inputs?: {\n    [KName in string]?:\n      | ({ node: AppNode } & ExtensionDataContainer<any>)\n      | Array<{ node: AppNode } & ExtensionDataContainer<any>>;\n  },\n  inputOverrides?: ResolvedInputValueOverrides,\n) {\n  if (!declaredInputs || !inputs || !inputOverrides) {\n    return inputs;\n  }\n\n  const newInputs: typeof inputs = {};\n  for (const name in declaredInputs) {\n    if (!Object.hasOwn(declaredInputs, name)) {\n      continue;\n    }\n    const declaredInput = declaredInputs[name];\n    const providedData = inputOverrides[name];\n    if (declaredInput.config.singleton) {\n      const originalInput = expectItem(inputs[name]);\n      if (providedData) {\n        const providedContainer = createExtensionDataContainer(\n          providedData as Iterable<ExtensionDataValue<any, any>>,\n          'extension input override',\n          declaredInput.extensionData,\n        );\n        if (!originalInput) {\n          throw new Error(\n            `attempted to override data of input '${name}' but it is not present in the original inputs`,\n          );\n        }\n        newInputs[name] = Object.assign(providedContainer, {\n          node: (originalInput as ResolvedExtensionInput<any>).node,\n        }) as any;\n      }\n    } else {\n      const originalInput = expectArray(inputs[name]);\n      if (!Array.isArray(providedData)) {\n        throw new Error(\n          `override data provided for input '${name}' must be an array`,\n        );\n      }\n\n      // Regular inputs can be overridden in two different ways:\n      // 1) Forward a subset of the original inputs in a new order\n      // 2) Provide new data for each original input\n\n      // First check if all inputs are being removed\n      if (providedData.length === 0) {\n        newInputs[name] = [];\n      } else {\n        // Check how many of the provided data items have a node property, i.e. is a forwarded input\n        const withNodesCount = providedData.filter(d => 'node' in d).length;\n        if (withNodesCount === 0) {\n          if (originalInput.length !== providedData.length) {\n            throw new Error(\n              `override data provided for input '${name}' must match the length of the original inputs`,\n            );\n          }\n          newInputs[name] = providedData.map((data, i) => {\n            const providedContainer = createExtensionDataContainer(\n              data as Iterable<ExtensionDataValue<any, any>>,\n              'extension input override',\n              declaredInput.extensionData,\n            );\n            return Object.assign(providedContainer, {\n              node: (originalInput[i] as ResolvedExtensionInput<any>).node,\n            }) as any;\n          });\n        } else if (withNodesCount === providedData.length) {\n          newInputs[name] = providedData as any;\n        } else {\n          throw new Error(\n            `override data for input '${name}' may not mix forwarded inputs with data overrides`,\n          );\n        }\n      }\n    }\n  }\n  return newInputs;\n}\n"],"names":[],"mappings":";;;;;AA0EA,SAAS,YAAe,KAAA,EAAqB;AAC3C,EAAA,OAAO,KAAA;AACT;AACA,SAAS,WAAc,KAAA,EAAmB;AACxC,EAAA,OAAO,KAAA;AACT;AAGO,SAAS,qBAAA,CACd,cAAA,EACA,MAAA,EAKA,cAAA,EACA;AACA,EAAA,IAAI,CAAC,cAAA,IAAkB,CAAC,MAAA,IAAU,CAAC,cAAA,EAAgB;AACjD,IAAA,OAAO,MAAA;AAAA,EACT;AAEA,EAAA,MAAM,YAA2B,EAAC;AAClC,EAAA,KAAA,MAAW,QAAQ,cAAA,EAAgB;AACjC,IAAA,IAAI,CAAC,MAAA,CAAO,MAAA,CAAO,cAAA,EAAgB,IAAI,CAAA,EAAG;AACxC,MAAA;AAAA,IACF;AACA,IAAA,MAAM,aAAA,GAAgB,eAAe,IAAI,CAAA;AACzC,IAAA,MAAM,YAAA,GAAe,eAAe,IAAI,CAAA;AACxC,IAAA,IAAI,aAAA,CAAc,OAAO,SAAA,EAAW;AAClC,MAAA,MAAM,aAAA,GAAgB,UAAA,CAAW,MAAA,CAAO,IAAI,CAAC,CAAA;AAC7C,MAAA,IAAI,YAAA,EAAc;AAChB,QAAA,MAAM,iBAAA,GAAoB,4BAAA;AAAA,UACxB,YAAA;AAAA,UACA,0BAAA;AAAA,UACA,aAAA,CAAc;AAAA,SAChB;AACA,QAAA,IAAI,CAAC,aAAA,EAAe;AAClB,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,wCAAwC,IAAI,CAAA,8CAAA;AAAA,WAC9C;AAAA,QACF;AACA,QAAA,SAAA,CAAU,IAAI,CAAA,GAAI,MAAA,CAAO,MAAA,CAAO,iBAAA,EAAmB;AAAA,UACjD,MAAO,aAAA,CAA8C;AAAA,SACtD,CAAA;AAAA,MACH;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAM,aAAA,GAAgB,WAAA,CAAY,MAAA,CAAO,IAAI,CAAC,CAAA;AAC9C,MAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,YAAY,CAAA,EAAG;AAChC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,qCAAqC,IAAI,CAAA,kBAAA;AAAA,SAC3C;AAAA,MACF;AAOA,MAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,QAAA,SAAA,CAAU,IAAI,IAAI,EAAC;AAAA,MACrB,CAAA,MAAO;AAEL,QAAA,MAAM,iBAAiB,YAAA,CAAa,MAAA,CAAO,CAAA,CAAA,KAAK,MAAA,IAAU,CAAC,CAAA,CAAE,MAAA;AAC7D,QAAA,IAAI,mBAAmB,CAAA,EAAG;AACxB,UAAA,IAAI,aAAA,CAAc,MAAA,KAAW,YAAA,CAAa,MAAA,EAAQ;AAChD,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,qCAAqC,IAAI,CAAA,8CAAA;AAAA,aAC3C;AAAA,UACF;AACA,UAAA,SAAA,CAAU,IAAI,CAAA,GAAI,YAAA,CAAa,GAAA,CAAI,CAAC,MAAM,CAAA,KAAM;AAC9C,YAAA,MAAM,iBAAA,GAAoB,4BAAA;AAAA,cACxB,IAAA;AAAA,cACA,0BAAA;AAAA,cACA,aAAA,CAAc;AAAA,aAChB;AACA,YAAA,OAAO,MAAA,CAAO,OAAO,iBAAA,EAAmB;AAAA,cACtC,IAAA,EAAO,aAAA,CAAc,CAAC,CAAA,CAAkC;AAAA,aACzD,CAAA;AAAA,UACH,CAAC,CAAA;AAAA,QACH,CAAA,MAAA,IAAW,cAAA,KAAmB,YAAA,CAAa,MAAA,EAAQ;AACjD,UAAA,SAAA,CAAU,IAAI,CAAA,GAAI,YAAA;AAAA,QACpB,CAAA,MAAO;AACL,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,4BAA4B,IAAI,CAAA,kDAAA;AAAA,WAClC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,SAAA;AACT;;;;"}
+{"version":3,"file":"resolveInputOverrides.esm.js","sources":["../../src/wiring/resolveInputOverrides.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 { AppNode } from '../apis';\nimport { Expand } from '@backstage/types';\nimport { ResolvedExtensionInput } from './createExtension';\nimport { createExtensionDataContainer } from '@internal/frontend';\nimport {\n  ExtensionDataRefToValue,\n  ExtensionDataValue,\n} from './createExtensionDataRef';\nimport { ExtensionInput } from './createExtensionInput';\nimport { ExtensionDataContainer } from './types';\n\n/** @ignore */\nexport type ResolvedInputValueOverrides<\n  TInputs extends { [inputName in string]: ExtensionInput } = {\n    [inputName in string]: ExtensionInput;\n  },\n> = Expand<\n  {\n    [KName in keyof TInputs as TInputs[KName] extends ExtensionInput<\n      any,\n      {\n        optional: infer IOptional extends boolean;\n        singleton: boolean;\n      }\n    >\n      ? IOptional extends true\n        ? never\n        : KName\n      : never]: TInputs[KName] extends ExtensionInput<\n      infer IDataRefs,\n      { optional: boolean; singleton: infer ISingleton extends boolean }\n    >\n      ? ISingleton extends true\n        ? Iterable<ExtensionDataRefToValue<IDataRefs>>\n        : Array<Iterable<ExtensionDataRefToValue<IDataRefs>>>\n      : never;\n  } & {\n    [KName in keyof TInputs as TInputs[KName] extends ExtensionInput<\n      any,\n      {\n        optional: infer IOptional extends boolean;\n        singleton: boolean;\n      }\n    >\n      ? IOptional extends true\n        ? KName\n        : never\n      : never]?: TInputs[KName] extends ExtensionInput<\n      infer IDataRefs,\n      { optional: boolean; singleton: infer ISingleton extends boolean }\n    >\n      ? ISingleton extends true\n        ? Iterable<ExtensionDataRefToValue<IDataRefs>>\n        : Array<Iterable<ExtensionDataRefToValue<IDataRefs>>>\n      : never;\n  }\n>;\n\nfunction expectArray<T>(value: T | T[]): T[] {\n  return value as T[];\n}\nfunction expectItem<T>(value: T | T[]): T {\n  return value as T;\n}\n\n/** @internal */\nexport function resolveInputOverrides(\n  declaredInputs?: { [inputName in string]: ExtensionInput },\n  inputs?: {\n    [KName in string]?:\n      | ({ node: AppNode } & ExtensionDataContainer<any>)\n      | Array<{ node: AppNode } & ExtensionDataContainer<any>>;\n  },\n  inputOverrides?: ResolvedInputValueOverrides,\n) {\n  if (!declaredInputs || !inputs || !inputOverrides) {\n    return inputs;\n  }\n\n  const newInputs: typeof inputs = {};\n  for (const name in declaredInputs) {\n    if (!Object.hasOwn(declaredInputs, name)) {\n      continue;\n    }\n    const declaredInput = declaredInputs[name];\n    const providedData = inputOverrides[name];\n    if (declaredInput.config.singleton) {\n      const originalInput = expectItem(inputs[name]);\n      if (providedData) {\n        const providedContainer = createExtensionDataContainer(\n          providedData as Iterable<ExtensionDataValue<any, any>>,\n          'extension input override',\n          declaredInput.extensionData,\n        );\n        if (!originalInput) {\n          throw new Error(\n            `attempted to override data of input '${name}' but it is not present in the original inputs`,\n          );\n        }\n        newInputs[name] = Object.assign(providedContainer, {\n          node: (originalInput as ResolvedExtensionInput<any>).node,\n        }) as any;\n      }\n    } else {\n      const originalInput = expectArray(inputs[name]);\n      if (!Array.isArray(providedData)) {\n        throw new Error(\n          `override data provided for input '${name}' must be an array`,\n        );\n      }\n\n      // Regular inputs can be overridden in two different ways:\n      // 1) Forward a subset of the original inputs in a new order\n      // 2) Provide new data for each original input\n\n      // First check if all inputs are being removed\n      if (providedData.length === 0) {\n        newInputs[name] = [];\n      } else {\n        // Check how many of the provided data items have a node property, i.e. is a forwarded input\n        const withNodesCount = providedData.filter(d => 'node' in d).length;\n        if (withNodesCount === 0) {\n          if (originalInput.length !== providedData.length) {\n            throw new Error(\n              `override data provided for input '${name}' must match the length of the original inputs`,\n            );\n          }\n          newInputs[name] = providedData.map((data, i) => {\n            const providedContainer = createExtensionDataContainer(\n              data as Iterable<ExtensionDataValue<any, any>>,\n              'extension input override',\n              declaredInput.extensionData,\n            );\n            return Object.assign(providedContainer, {\n              node: (originalInput[i] as ResolvedExtensionInput<any>).node,\n            }) as any;\n          });\n        } else if (withNodesCount === providedData.length) {\n          newInputs[name] = providedData as any;\n        } else {\n          throw new Error(\n            `override data for input '${name}' may not mix forwarded inputs with data overrides`,\n          );\n        }\n      }\n    }\n  }\n  return newInputs;\n}\n"],"names":[],"mappings":";;;;;;AA0EA,SAAS,YAAe,KAAA,EAAqB;AAC3C,EAAA,OAAO,KAAA;AACT;AACA,SAAS,WAAc,KAAA,EAAmB;AACxC,EAAA,OAAO,KAAA;AACT;AAGO,SAAS,qBAAA,CACd,cAAA,EACA,MAAA,EAKA,cAAA,EACA;AACA,EAAA,IAAI,CAAC,cAAA,IAAkB,CAAC,MAAA,IAAU,CAAC,cAAA,EAAgB;AACjD,IAAA,OAAO,MAAA;AAAA,EACT;AAEA,EAAA,MAAM,YAA2B,EAAC;AAClC,EAAA,KAAA,MAAW,QAAQ,cAAA,EAAgB;AACjC,IAAA,IAAI,CAAC,MAAA,CAAO,MAAA,CAAO,cAAA,EAAgB,IAAI,CAAA,EAAG;AACxC,MAAA;AAAA,IACF;AACA,IAAA,MAAM,aAAA,GAAgB,eAAe,IAAI,CAAA;AACzC,IAAA,MAAM,YAAA,GAAe,eAAe,IAAI,CAAA;AACxC,IAAA,IAAI,aAAA,CAAc,OAAO,SAAA,EAAW;AAClC,MAAA,MAAM,aAAA,GAAgB,UAAA,CAAW,MAAA,CAAO,IAAI,CAAC,CAAA;AAC7C,MAAA,IAAI,YAAA,EAAc;AAChB,QAAA,MAAM,iBAAA,GAAoB,4BAAA;AAAA,UACxB,YAAA;AAAA,UACA,0BAAA;AAAA,UACA,aAAA,CAAc;AAAA,SAChB;AACA,QAAA,IAAI,CAAC,aAAA,EAAe;AAClB,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,wCAAwC,IAAI,CAAA,8CAAA;AAAA,WAC9C;AAAA,QACF;AACA,QAAA,SAAA,CAAU,IAAI,CAAA,GAAI,MAAA,CAAO,MAAA,CAAO,iBAAA,EAAmB;AAAA,UACjD,MAAO,aAAA,CAA8C;AAAA,SACtD,CAAA;AAAA,MACH;AAAA,IACF,CAAA,MAAO;AACL,MAAA,MAAM,aAAA,GAAgB,WAAA,CAAY,MAAA,CAAO,IAAI,CAAC,CAAA;AAC9C,MAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,YAAY,CAAA,EAAG;AAChC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,qCAAqC,IAAI,CAAA,kBAAA;AAAA,SAC3C;AAAA,MACF;AAOA,MAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,QAAA,SAAA,CAAU,IAAI,IAAI,EAAC;AAAA,MACrB,CAAA,MAAO;AAEL,QAAA,MAAM,iBAAiB,YAAA,CAAa,MAAA,CAAO,CAAA,CAAA,KAAK,MAAA,IAAU,CAAC,CAAA,CAAE,MAAA;AAC7D,QAAA,IAAI,mBAAmB,CAAA,EAAG;AACxB,UAAA,IAAI,aAAA,CAAc,MAAA,KAAW,YAAA,CAAa,MAAA,EAAQ;AAChD,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,qCAAqC,IAAI,CAAA,8CAAA;AAAA,aAC3C;AAAA,UACF;AACA,UAAA,SAAA,CAAU,IAAI,CAAA,GAAI,YAAA,CAAa,GAAA,CAAI,CAAC,MAAM,CAAA,KAAM;AAC9C,YAAA,MAAM,iBAAA,GAAoB,4BAAA;AAAA,cACxB,IAAA;AAAA,cACA,0BAAA;AAAA,cACA,aAAA,CAAc;AAAA,aAChB;AACA,YAAA,OAAO,MAAA,CAAO,OAAO,iBAAA,EAAmB;AAAA,cACtC,IAAA,EAAO,aAAA,CAAc,CAAC,CAAA,CAAkC;AAAA,aACzD,CAAA;AAAA,UACH,CAAC,CAAA;AAAA,QACH,CAAA,MAAA,IAAW,cAAA,KAAmB,YAAA,CAAa,MAAA,EAAQ;AACjD,UAAA,SAAA,CAAU,IAAI,CAAA,GAAI,YAAA;AAAA,QACpB,CAAA,MAAO;AACL,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,4BAA4B,IAAI,CAAA,kDAAA;AAAA,WAClC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,SAAA;AACT;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/frontend-plugin-api",
-  "version": "0.12.2-next.1",
+  "version": "0.12.2-next.2",
   "backstage": {
     "role": "web-library"
   },
@@ -31,7 +31,7 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-components": "0.18.3-next.1",
+    "@backstage/core-components": "0.18.3-next.2",
     "@backstage/core-plugin-api": "1.11.2-next.1",
     "@backstage/types": "1.2.2",
     "@backstage/version-bridge": "1.0.11",