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

package/CHANGELOG.md

@@ -1,5 +1,249 @@
 # @backstage/frontend-plugin-api
 
+## 0.7.0
+
+### Minor Changes
+
+- 72754db: **BREAKING**: All types of route refs are always considered optional by `useRouteRef`, which means the caller must always handle a potential `undefined` return value. Related to this change, the `optional` option from `createExternalRouteRef` has been removed, since it is no longer necessary.
+
+  This is released as an immediate breaking change as we expect the usage of the new route refs to be extremely low or zero, since plugins that support the new system will still use route refs and `useRouteRef` from `@backstage/core-plugin-api` in combination with `convertLegacyRouteRef` from `@backstage/core-compat-api`.
+
+### Patch Changes
+
+- 6f72c2b: Fixing issue with extension blueprints `inputs` merging.
+- 210d066: Added support for using the `params` in other properties of the `createExtensionBlueprint` options by providing a callback.
+- 9b356dc: Renamed `createPlugin` to `createFrontendPlugin`. The old symbol is still exported but deprecated.
+- a376559: Correct the `TConfig` type of data references to only contain config
+- 4e53ad6: Introduce a new way to encapsulate extension kinds that replaces the extension creator pattern with `createExtensionBlueprint`
+
+  This allows the creation of extension instances with the following pattern:
+
+  ```tsx
+  // create the extension blueprint which is used to create instances
+  const EntityCardBlueprint = createExtensionBlueprint({
+    kind: 'entity-card',
+    attachTo: { id: 'test', input: 'default' },
+    output: [coreExtensionData.reactElement],
+    factory(params: { text: string }) {
+      return [coreExtensionData.reactElement(<h1>{params.text}</h1>)];
+    },
+  });
+
+  // create an instance of the extension blueprint with params
+  const testExtension = EntityCardBlueprint.make({
+    name: 'foo',
+    params: {
+      text: 'Hello World',
+    },
+  });
+  ```
+
+- 9b89b82: The `ExtensionBoundary` now by default infers whether it's routable from whether it outputs a route path.
+- e493020: Deprecated `inputs` and `configSchema` options for `createComponentExtenion`, these will be removed in a future release
+- 7777b5f: Added a new `IconBundleBlueprint` that lets you create icon bundle extensions that can be installed in an App in order to override or add new app icons.
+
+  ```tsx
+  import { IconBundleBlueprint } from '@backstage/frontend-plugin-api';
+
+  const exampleIconBundle = IconBundleBlueprint.make({
+    name: 'example-bundle',
+    params: {
+      icons: {
+        user: MyOwnUserIcon,
+      },
+    },
+  });
+  ```
+
+- 99abb6b: Support overriding of plugin extensions using the new `plugin.withOverrides` method.
+
+  ```tsx
+  import homePlugin from '@backstage/plugin-home';
+
+  export default homePlugin.withOverrides({
+    extensions: [
+      homePage.getExtension('page:home').override({
+        *factory(originalFactory) {
+          yield* originalFactory();
+          yield coreExtensionData.reactElement(<h1>My custom home page</h1>);
+        },
+      }),
+    ],
+  });
+  ```
+
+- 813cac4: Add an `ExtensionBoundary.lazy` function to create properly wrapped lazy-loading enabled elements, suitable for use with `coreExtensionData.reactElement`. The page blueprint now automatically leverages this.
+- a65cfc8: Add support for accessing extensions definitions provided by a plugin via `plugin.getExtension(...)`. For this to work the extensions must be defined using the v2 format, typically using an extension blueprint.
+- 3be9aeb: Extensions have been changed to be declared with an array of inputs and outputs, rather than a map of named data refs. This change was made to reduce confusion around the role of the input and output names, as well as enable more powerful APIs for overriding extensions.
+
+  An extension that was previously declared like this:
+
+  ```tsx
+  const exampleExtension = createExtension({
+    name: 'example',
+    inputs: {
+      items: createExtensionInput({
+        element: coreExtensionData.reactElement,
+      }),
+    },
+    output: {
+      element: coreExtensionData.reactElement,
+    },
+    factory({ inputs }) {
+      return {
+        element: (
+          <div>
+            Example
+            {inputs.items.map(item => {
+              return <div>{item.output.element}</div>;
+            })}
+          </div>
+        ),
+      };
+    },
+  });
+  ```
+
+  Should be migrated to the following:
+
+  ```tsx
+  const exampleExtension = createExtension({
+    name: 'example',
+    inputs: {
+      items: createExtensionInput([coreExtensionData.reactElement]),
+    },
+    output: [coreExtensionData.reactElement],
+    factory({ inputs }) {
+      return [
+        coreExtensionData.reactElement(
+          <div>
+            Example
+            {inputs.items.map(item => {
+              return <div>{item.get(coreExtensionData.reactElement)}</div>;
+            })}
+          </div>,
+        ),
+      ];
+    },
+  });
+  ```
+
+- 34f1b2a: Support merging of `inputs` in extension blueprints, but stop merging `output`. In addition, the original factory in extension blueprints now returns a data container that both provides access to the returned data, but can also be forwarded as output.
+- 3fb421d: Added support to be able to define `zod` config schema in Blueprints, with built in schema merging from the Blueprint and the extension instances.
+- 2d21599: Added support for being able to override extension definitions.
+
+  ```tsx
+  const TestCard = EntityCardBlueprint.make({
+    ...
+  });
+
+  TestCard.override({
+    // override attachment points
+    attachTo: { id: 'something-else', input: 'overridden' },
+    // extend the config schema
+    config: {
+      schema: {
+        newConfig: z => z.string().optional(),
+      }
+    },
+    // override factory
+    *factory(originalFactory, { inputs, config }){
+      const originalOutput = originalFactory();
+
+      yield coreExentsionData.reactElement(
+        <Wrapping>
+          {originalOutput.get(coreExentsionData.reactElement)}
+        </Wrapping>
+      );
+    }
+  });
+
+  ```
+
+- 31bfc44: Extension data references can now be defined in a way that encapsulates the ID string in the type, in addition to the data type itself. The old way of creating extension data references is deprecated and will be removed in a future release.
+
+  For example, the following code:
+
+  ```ts
+  export const myExtension =
+    createExtensionDataRef<MyType>('my-plugin.my-data');
+  ```
+
+  Should be updated to the following:
+
+  ```ts
+  export const myExtension = createExtensionDataRef<MyType>().with({
+    id: 'my-plugin.my-data',
+  });
+  ```
+
+- 6349099: Added config input type to the extensions
+- Updated dependencies
+  - @backstage/core-components@0.14.10
+  - @backstage/core-plugin-api@1.9.3
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.8
+
+## 0.7.0-next.3
+
+### Patch Changes
+
+- 6f72c2b: Fixing issue with extension blueprints `inputs` merging.
+- 99abb6b: Support overriding of plugin extensions using the new `plugin.withOverrides` method.
+
+  ```tsx
+  import homePlugin from '@backstage/plugin-home';
+
+  export default homePlugin.withOverrides({
+    extensions: [
+      homePage.getExtension('page:home').override({
+        *factory(originalFactory) {
+          yield* originalFactory();
+          yield coreExtensionData.reactElement(<h1>My custom home page</h1>);
+        },
+      }),
+    ],
+  });
+  ```
+
+- a65cfc8: Add support for accessing extensions definitions provided by a plugin via `plugin.getExtension(...)`. For this to work the extensions must be defined using the v2 format, typically using an extension blueprint.
+- 34f1b2a: Support merging of `inputs` in extension blueprints, but stop merging `output`. In addition, the original factory in extension blueprints now returns a data container that both provides access to the returned data, but can also be forwarded as output.
+- 2d21599: Added support for being able to override extension definitions.
+
+  ```tsx
+  const TestCard = EntityCardBlueprint.make({
+    ...
+  });
+
+  TestCard.override({
+    // override attachment points
+    attachTo: { id: 'something-else', input: 'overridden' },
+    // extend the config schema
+    config: {
+      schema: {
+        newConfig: z => z.string().optional(),
+      }
+    },
+    // override factory
+    *factory(originalFactory, { inputs, config }){
+      const originalOutput = originalFactory();
+
+      yield coreExentsionData.reactElement(
+        <Wrapping>
+          {originalOutput.get(coreExentsionData.reactElement)}
+        </Wrapping>
+      );
+    }
+  });
+
+  ```
+
+- Updated dependencies
+  - @backstage/core-components@0.14.10-next.0
+  - @backstage/core-plugin-api@1.9.3
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.8
+
 ## 0.7.0-next.2
 
 ### Minor Changes

package/dist/blueprints/ApiBlueprint.esm.js

@@ -0,0 +1,23 @@
+import '../wiring/coreExtensionData.esm.js';
+import 'zod';
+import 'zod-to-json-schema';
+import { createExtensionDataRef } from '../wiring/createExtensionDataRef.esm.js';
+import { createExtensionBlueprint } from '../wiring/createExtensionBlueprint.esm.js';
+
+const factoryDataRef = createExtensionDataRef().with({
+  id: "core.api.factory"
+});
+const ApiBlueprint = createExtensionBlueprint({
+  kind: "api",
+  attachTo: { id: "app", input: "apis" },
+  output: [factoryDataRef],
+  dataRefs: {
+    factory: factoryDataRef
+  },
+  *factory(params) {
+    yield factoryDataRef(params.factory);
+  }
+});
+
+export { ApiBlueprint };
+//# sourceMappingURL=ApiBlueprint.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiBlueprint.esm.js","sources":["../../src/blueprints/ApiBlueprint.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createExtensionBlueprint, createExtensionDataRef } from '../wiring';\nimport { AnyApiFactory } from '@backstage/core-plugin-api';\n\nconst factoryDataRef = createExtensionDataRef<AnyApiFactory>().with({\n  id: 'core.api.factory',\n});\n\n/**\n * Creates utility API extensions.\n *\n * @public\n */\nexport const ApiBlueprint = createExtensionBlueprint({\n  kind: 'api',\n  attachTo: { id: 'app', input: 'apis' },\n  output: [factoryDataRef],\n  dataRefs: {\n    factory: factoryDataRef,\n  },\n  *factory(params: { factory: AnyApiFactory }) {\n    yield factoryDataRef(params.factory);\n  },\n});\n"],"names":[],"mappings":";;;;;;AAmBA,MAAM,cAAA,GAAiB,sBAAsC,EAAA,CAAE,IAAK,CAAA;AAAA,EAClE,EAAI,EAAA,kBAAA;AACN,CAAC,CAAA,CAAA;AAOM,MAAM,eAAe,wBAAyB,CAAA;AAAA,EACnD,IAAM,EAAA,KAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,KAAA,EAAO,OAAO,MAAO,EAAA;AAAA,EACrC,MAAA,EAAQ,CAAC,cAAc,CAAA;AAAA,EACvB,QAAU,EAAA;AAAA,IACR,OAAS,EAAA,cAAA;AAAA,GACX;AAAA,EACA,CAAC,QAAQ,MAAoC,EAAA;AAC3C,IAAM,MAAA,cAAA,CAAe,OAAO,OAAO,CAAA,CAAA;AAAA,GACrC;AACF,CAAC;;;;"}

package/dist/blueprints/AppRootElementBlueprint.esm.js

@@ -0,0 +1,18 @@
+import { coreExtensionData } from '../wiring/coreExtensionData.esm.js';
+import 'zod';
+import 'zod-to-json-schema';
+import { createExtensionBlueprint } from '../wiring/createExtensionBlueprint.esm.js';
+
+const AppRootElementBlueprint = createExtensionBlueprint({
+  kind: "app-root-element",
+  attachTo: { id: "app/root", input: "elements" },
+  output: [coreExtensionData.reactElement],
+  *factory(params) {
+    yield coreExtensionData.reactElement(
+      typeof params.element === "function" ? params.element() : params.element
+    );
+  }
+});
+
+export { AppRootElementBlueprint };
+//# sourceMappingURL=AppRootElementBlueprint.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AppRootElementBlueprint.esm.js","sources":["../../src/blueprints/AppRootElementBlueprint.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 { coreExtensionData, createExtensionBlueprint } from '../wiring';\n\n/**\n * Creates extensions that render a React element at the app root, outside of\n * the app layout. This is useful for example for shared popups and similar.\n *\n * @public\n */\nexport const AppRootElementBlueprint = createExtensionBlueprint({\n  kind: 'app-root-element',\n  attachTo: { id: 'app/root', input: 'elements' },\n  output: [coreExtensionData.reactElement],\n  *factory(params: { element: JSX.Element | (() => JSX.Element) }) {\n    yield coreExtensionData.reactElement(\n      typeof params.element === 'function' ? params.element() : params.element,\n    );\n  },\n});\n"],"names":[],"mappings":";;;;;AAwBO,MAAM,0BAA0B,wBAAyB,CAAA;AAAA,EAC9D,IAAM,EAAA,kBAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,UAAA,EAAY,OAAO,UAAW,EAAA;AAAA,EAC9C,MAAA,EAAQ,CAAC,iBAAA,CAAkB,YAAY,CAAA;AAAA,EACvC,CAAC,QAAQ,MAAwD,EAAA;AAC/D,IAAA,MAAM,iBAAkB,CAAA,YAAA;AAAA,MACtB,OAAO,MAAO,CAAA,OAAA,KAAY,aAAa,MAAO,CAAA,OAAA,KAAY,MAAO,CAAA,OAAA;AAAA,KACnE,CAAA;AAAA,GACF;AACF,CAAC;;;;"}

package/dist/blueprints/AppRootWrapperBlueprint.esm.js

@@ -0,0 +1,25 @@
+import React from 'react';
+import '../wiring/coreExtensionData.esm.js';
+import 'zod';
+import 'zod-to-json-schema';
+import { createExtensionDataRef } from '../wiring/createExtensionDataRef.esm.js';
+import { createExtensionBlueprint } from '../wiring/createExtensionBlueprint.esm.js';
+
+const componentDataRef = createExtensionDataRef().with({ id: "app.root.wrapper" });
+const AppRootWrapperBlueprint = createExtensionBlueprint({
+  kind: "app-root-wrapper",
+  attachTo: { id: "app/root", input: "wrappers" },
+  output: [componentDataRef],
+  dataRefs: {
+    component: componentDataRef
+  },
+  *factory(params) {
+    const Component = (props) => {
+      return /* @__PURE__ */ React.createElement(params.Component, null, props.children);
+    };
+    yield componentDataRef(Component);
+  }
+});
+
+export { AppRootWrapperBlueprint };
+//# sourceMappingURL=AppRootWrapperBlueprint.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AppRootWrapperBlueprint.esm.js","sources":["../../src/blueprints/AppRootWrapperBlueprint.tsx"],"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 React from 'react';\nimport { ComponentType, PropsWithChildren } from 'react';\nimport { createExtensionBlueprint, createExtensionDataRef } from '../wiring';\n\nconst componentDataRef = createExtensionDataRef<\n  ComponentType<PropsWithChildren<{}>>\n>().with({ id: 'app.root.wrapper' });\n\n/**\n * Creates a extensions that render a React wrapper at the app root, enclosing\n * the app layout. This is useful for example for adding global React contexts\n * and similar.\n *\n * @public\n */\nexport const AppRootWrapperBlueprint = createExtensionBlueprint({\n  kind: 'app-root-wrapper',\n  attachTo: { id: 'app/root', input: 'wrappers' },\n  output: [componentDataRef],\n  dataRefs: {\n    component: componentDataRef,\n  },\n  *factory(params: { Component: ComponentType<PropsWithChildren<{}>> }) {\n    // todo(blam): not sure that this wrapping is even necessary anymore.\n    const Component = (props: PropsWithChildren<{}>) => {\n      return <params.Component>{props.children}</params.Component>;\n    };\n\n    yield componentDataRef(Component);\n  },\n});\n"],"names":[],"mappings":";;;;;;;AAoBA,MAAM,mBAAmB,sBAEvB,EAAA,CAAE,KAAK,EAAE,EAAA,EAAI,oBAAoB,CAAA,CAAA;AAS5B,MAAM,0BAA0B,wBAAyB,CAAA;AAAA,EAC9D,IAAM,EAAA,kBAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,UAAA,EAAY,OAAO,UAAW,EAAA;AAAA,EAC9C,MAAA,EAAQ,CAAC,gBAAgB,CAAA;AAAA,EACzB,QAAU,EAAA;AAAA,IACR,SAAW,EAAA,gBAAA;AAAA,GACb;AAAA,EACA,CAAC,QAAQ,MAA6D,EAAA;AAEpE,IAAM,MAAA,SAAA,GAAY,CAAC,KAAiC,KAAA;AAClD,MAAA,uBAAQ,KAAA,CAAA,aAAA,CAAA,MAAA,CAAO,SAAP,EAAA,IAAA,EAAkB,MAAM,QAAS,CAAA,CAAA;AAAA,KAC3C,CAAA;AAEA,IAAA,MAAM,iBAAiB,SAAS,CAAA,CAAA;AAAA,GAClC;AACF,CAAC;;;;"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"IconBundleBlueprint.esm.js","sources":["../../src/blueprints/IconBundleBlueprint.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 { IconComponent } from '../icons';\nimport { createExtensionBlueprint, createExtensionDataRef } from '../wiring';\n\nconst iconsDataRef = createExtensionDataRef<{\n  [key in string]: IconComponent;\n}>().with({ id: 'core.icons' });\n\n/** @public */\nexport const IconBundleBlueprint = createExtensionBlueprint({\n  kind: 'icon-bundle',\n  namespace: 'app',\n  attachTo: { id: 'app', input: 'icons' },\n  output: [iconsDataRef],\n  config: {\n    schema: {\n      icons: z => z.string().default('blob'),\n      test: z => z.string(),\n    },\n  },\n  factory: (params: { icons: { [key in string]: IconComponent } }) => [\n    iconsDataRef(params.icons),\n  ],\n  dataRefs: {\n    icons: iconsDataRef,\n  },\n});\n"],"names":[],"mappings":";;;;;;AAmBA,MAAM,eAAe,sBAElB,EAAA,CAAE,KAAK,EAAE,EAAA,EAAI,cAAc,CAAA,CAAA;AAGvB,MAAM,sBAAsB,wBAAyB,CAAA;AAAA,EAC1D,IAAM,EAAA,aAAA;AAAA,EACN,SAAW,EAAA,KAAA;AAAA,EACX,QAAU,EAAA,EAAE,EAAI,EAAA,KAAA,EAAO,OAAO,OAAQ,EAAA;AAAA,EACtC,MAAA,EAAQ,CAAC,YAAY,CAAA;AAAA,EACrB,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,OAAO,CAAK,CAAA,KAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,MAAM,CAAA;AAAA,MACrC,IAAA,EAAM,CAAK,CAAA,KAAA,CAAA,CAAE,MAAO,EAAA;AAAA,KACtB;AAAA,GACF;AAAA,EACA,OAAA,EAAS,CAAC,MAA0D,KAAA;AAAA,IAClE,YAAA,CAAa,OAAO,KAAK,CAAA;AAAA,GAC3B;AAAA,EACA,QAAU,EAAA;AAAA,IACR,KAAO,EAAA,YAAA;AAAA,GACT;AACF,CAAC;;;;"}

package/dist/blueprints/NavItemBlueprint.esm.js

@@ -0,0 +1,34 @@
+import '../wiring/coreExtensionData.esm.js';
+import 'zod';
+import 'zod-to-json-schema';
+import { createExtensionDataRef } from '../wiring/createExtensionDataRef.esm.js';
+import { createExtensionBlueprint } from '../wiring/createExtensionBlueprint.esm.js';
+
+const targetDataRef = createExtensionDataRef().with({ id: "core.nav-item.target" });
+const NavItemBlueprint = createExtensionBlueprint({
+  kind: "nav-item",
+  attachTo: { id: "app/nav", input: "items" },
+  output: [targetDataRef],
+  dataRefs: {
+    target: targetDataRef
+  },
+  factory: ({
+    icon,
+    routeRef,
+    title
+  }, { config }) => [
+    targetDataRef({
+      title: config.title ?? title,
+      icon,
+      routeRef
+    })
+  ],
+  config: {
+    schema: {
+      title: (z) => z.string().optional()
+    }
+  }
+});
+
+export { NavItemBlueprint };
+//# sourceMappingURL=NavItemBlueprint.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NavItemBlueprint.esm.js","sources":["../../src/blueprints/NavItemBlueprint.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 { IconComponent } from '@backstage/core-plugin-api';\nimport { RouteRef } from '../routing';\nimport { createExtensionBlueprint, createExtensionDataRef } from '../wiring';\n\n// TODO(Rugvip): Should this be broken apart into separate refs? title/icon/routeRef\nconst targetDataRef = createExtensionDataRef<{\n  title: string;\n  icon: IconComponent;\n  routeRef: RouteRef<undefined>;\n}>().with({ id: 'core.nav-item.target' });\n\n/**\n * Creates extensions that make up the items of the nav bar.\n *\n * @public\n */\nexport const NavItemBlueprint = createExtensionBlueprint({\n  kind: 'nav-item',\n  attachTo: { id: 'app/nav', input: 'items' },\n  output: [targetDataRef],\n  dataRefs: {\n    target: targetDataRef,\n  },\n  factory: (\n    {\n      icon,\n      routeRef,\n      title,\n    }: {\n      title: string;\n      icon: IconComponent;\n      routeRef: RouteRef<undefined>;\n    },\n    { config },\n  ) => [\n    targetDataRef({\n      title: config.title ?? title,\n      icon,\n      routeRef,\n    }),\n  ],\n  config: {\n    schema: {\n      title: z => z.string().optional(),\n    },\n  },\n});\n"],"names":[],"mappings":";;;;;;AAqBA,MAAM,gBAAgB,sBAInB,EAAA,CAAE,KAAK,EAAE,EAAA,EAAI,wBAAwB,CAAA,CAAA;AAOjC,MAAM,mBAAmB,wBAAyB,CAAA;AAAA,EACvD,IAAM,EAAA,UAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,SAAA,EAAW,OAAO,OAAQ,EAAA;AAAA,EAC1C,MAAA,EAAQ,CAAC,aAAa,CAAA;AAAA,EACtB,QAAU,EAAA;AAAA,IACR,MAAQ,EAAA,aAAA;AAAA,GACV;AAAA,EACA,SAAS,CACP;AAAA,IACE,IAAA;AAAA,IACA,QAAA;AAAA,IACA,KAAA;AAAA,GACF,EAKA,EAAE,MAAA,EACC,KAAA;AAAA,IACH,aAAc,CAAA;AAAA,MACZ,KAAA,EAAO,OAAO,KAAS,IAAA,KAAA;AAAA,MACvB,IAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA,CAAA,CAAA,KAAK,CAAE,CAAA,MAAA,GAAS,QAAS,EAAA;AAAA,KAClC;AAAA,GACF;AACF,CAAC;;;;"}

package/dist/blueprints/NavLogoBlueprint.esm.js

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

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

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

package/dist/blueprints/PageBlueprint.esm.js

@@ -0,0 +1,34 @@
+import { coreExtensionData } from '../wiring/coreExtensionData.esm.js';
+import 'zod';
+import 'zod-to-json-schema';
+import { createExtensionBlueprint } from '../wiring/createExtensionBlueprint.esm.js';
+import { ExtensionBoundary } from '../components/ExtensionBoundary.esm.js';
+
+const PageBlueprint = createExtensionBlueprint({
+  kind: "page",
+  attachTo: { id: "app/routes", input: "routes" },
+  output: [
+    coreExtensionData.routePath,
+    coreExtensionData.reactElement,
+    coreExtensionData.routeRef.optional()
+  ],
+  config: {
+    schema: {
+      path: (z) => z.string().optional()
+    }
+  },
+  *factory({
+    defaultPath,
+    loader,
+    routeRef
+  }, { config, node }) {
+    yield coreExtensionData.routePath(config.path ?? defaultPath);
+    yield coreExtensionData.reactElement(ExtensionBoundary.lazy(node, loader));
+    if (routeRef) {
+      yield coreExtensionData.routeRef(routeRef);
+    }
+  }
+});
+
+export { PageBlueprint };
+//# sourceMappingURL=PageBlueprint.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PageBlueprint.esm.js","sources":["../../src/blueprints/PageBlueprint.tsx"],"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 { RouteRef } from '../routing';\nimport { coreExtensionData, createExtensionBlueprint } from '../wiring';\nimport { ExtensionBoundary } from '../components';\n\n/**\n * Createx extensions that are routable React page components.\n *\n * @public\n */\nexport const PageBlueprint = createExtensionBlueprint({\n  kind: 'page',\n  attachTo: { id: 'app/routes', input: 'routes' },\n  output: [\n    coreExtensionData.routePath,\n    coreExtensionData.reactElement,\n    coreExtensionData.routeRef.optional(),\n  ],\n  config: {\n    schema: {\n      path: z => z.string().optional(),\n    },\n  },\n  *factory(\n    {\n      defaultPath,\n      loader,\n      routeRef,\n    }: {\n      defaultPath: string;\n      loader: () => Promise<JSX.Element>;\n      routeRef?: RouteRef;\n    },\n    { config, node },\n  ) {\n    yield coreExtensionData.routePath(config.path ?? defaultPath);\n    yield coreExtensionData.reactElement(ExtensionBoundary.lazy(node, loader));\n    if (routeRef) {\n      yield coreExtensionData.routeRef(routeRef);\n    }\n  },\n});\n"],"names":[],"mappings":";;;;;;AAyBO,MAAM,gBAAgB,wBAAyB,CAAA;AAAA,EACpD,IAAM,EAAA,MAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,YAAA,EAAc,OAAO,QAAS,EAAA;AAAA,EAC9C,MAAQ,EAAA;AAAA,IACN,iBAAkB,CAAA,SAAA;AAAA,IAClB,iBAAkB,CAAA,YAAA;AAAA,IAClB,iBAAA,CAAkB,SAAS,QAAS,EAAA;AAAA,GACtC;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,IAAM,EAAA,CAAA,CAAA,KAAK,CAAE,CAAA,MAAA,GAAS,QAAS,EAAA;AAAA,KACjC;AAAA,GACF;AAAA,EACA,CAAC,OACC,CAAA;AAAA,IACE,WAAA;AAAA,IACA,MAAA;AAAA,IACA,QAAA;AAAA,GAMF,EAAA,EAAE,MAAQ,EAAA,IAAA,EACV,EAAA;AACA,IAAA,MAAM,iBAAkB,CAAA,SAAA,CAAU,MAAO,CAAA,IAAA,IAAQ,WAAW,CAAA,CAAA;AAC5D,IAAA,MAAM,kBAAkB,YAAa,CAAA,iBAAA,CAAkB,IAAK,CAAA,IAAA,EAAM,MAAM,CAAC,CAAA,CAAA;AACzE,IAAA,IAAI,QAAU,EAAA;AACZ,MAAM,MAAA,iBAAA,CAAkB,SAAS,QAAQ,CAAA,CAAA;AAAA,KAC3C;AAAA,GACF;AACF,CAAC;;;;"}

package/dist/blueprints/RouterBlueprint.esm.js

@@ -0,0 +1,21 @@
+import '../wiring/coreExtensionData.esm.js';
+import 'zod';
+import 'zod-to-json-schema';
+import { createExtensionDataRef } from '../wiring/createExtensionDataRef.esm.js';
+import { createExtensionBlueprint } from '../wiring/createExtensionBlueprint.esm.js';
+
+const componentDataRef = createExtensionDataRef().with({ id: "app.router.wrapper" });
+const RouterBlueprint = createExtensionBlueprint({
+  kind: "app-router-component",
+  attachTo: { id: "app/root", input: "router" },
+  output: [componentDataRef],
+  dataRefs: {
+    component: componentDataRef
+  },
+  *factory({ Component }) {
+    yield componentDataRef(Component);
+  }
+});
+
+export { RouterBlueprint };
+//# sourceMappingURL=RouterBlueprint.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RouterBlueprint.esm.js","sources":["../../src/blueprints/RouterBlueprint.tsx"],"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 { ComponentType, PropsWithChildren } from 'react';\nimport { createExtensionBlueprint, createExtensionDataRef } from '../wiring';\n\nconst componentDataRef = createExtensionDataRef<\n  ComponentType<PropsWithChildren<{}>>\n>().with({ id: 'app.router.wrapper' });\n\n/** @public */\nexport const RouterBlueprint = createExtensionBlueprint({\n  kind: 'app-router-component',\n  attachTo: { id: 'app/root', input: 'router' },\n  output: [componentDataRef],\n  dataRefs: {\n    component: componentDataRef,\n  },\n  *factory({ Component }: { Component: ComponentType<PropsWithChildren<{}>> }) {\n    yield componentDataRef(Component);\n  },\n});\n"],"names":[],"mappings":";;;;;;AAmBA,MAAM,mBAAmB,sBAEvB,EAAA,CAAE,KAAK,EAAE,EAAA,EAAI,sBAAsB,CAAA,CAAA;AAG9B,MAAM,kBAAkB,wBAAyB,CAAA;AAAA,EACtD,IAAM,EAAA,sBAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,UAAA,EAAY,OAAO,QAAS,EAAA;AAAA,EAC5C,MAAA,EAAQ,CAAC,gBAAgB,CAAA;AAAA,EACzB,QAAU,EAAA;AAAA,IACR,SAAW,EAAA,gBAAA;AAAA,GACb;AAAA,EACA,CAAC,OAAA,CAAQ,EAAE,SAAA,EAAkE,EAAA;AAC3E,IAAA,MAAM,iBAAiB,SAAS,CAAA,CAAA;AAAA,GAClC;AACF,CAAC;;;;"}

package/dist/blueprints/SignInPageBlueprint.esm.js

@@ -0,0 +1,28 @@
+import React, { lazy } from 'react';
+import '../wiring/coreExtensionData.esm.js';
+import 'zod';
+import 'zod-to-json-schema';
+import { createExtensionDataRef } from '../wiring/createExtensionDataRef.esm.js';
+import { createExtensionBlueprint } from '../wiring/createExtensionBlueprint.esm.js';
+import { ExtensionBoundary } from '../components/ExtensionBoundary.esm.js';
+
+const componentDataRef = createExtensionDataRef().with({ id: "core.sign-in-page.component" });
+const SignInPageBlueprint = createExtensionBlueprint({
+  kind: "sign-in-page",
+  attachTo: { id: "app/root", input: "signInPage" },
+  output: [componentDataRef],
+  dataRefs: {
+    component: componentDataRef
+  },
+  *factory({
+    loader
+  }, { node }) {
+    const ExtensionComponent = lazy(
+      () => loader().then((component) => ({ default: component }))
+    );
+    yield componentDataRef((props) => /* @__PURE__ */ React.createElement(ExtensionBoundary, { node, routable: true }, /* @__PURE__ */ React.createElement(ExtensionComponent, { ...props })));
+  }
+});
+
+export { SignInPageBlueprint };
+//# sourceMappingURL=SignInPageBlueprint.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SignInPageBlueprint.esm.js","sources":["../../src/blueprints/SignInPageBlueprint.tsx"],"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 React, { ComponentType, lazy } from 'react';\nimport { createExtensionBlueprint, createExtensionDataRef } from '../wiring';\nimport { SignInPageProps } from '@backstage/core-plugin-api';\nimport { ExtensionBoundary } from '../components';\n\nconst componentDataRef = createExtensionDataRef<\n  ComponentType<SignInPageProps>\n>().with({ id: 'core.sign-in-page.component' });\n\n/**\n * Creates an extension that replaces the sign in page.\n *\n * @public\n */\nexport const SignInPageBlueprint = createExtensionBlueprint({\n  kind: 'sign-in-page',\n  attachTo: { id: 'app/root', input: 'signInPage' },\n  output: [componentDataRef],\n  dataRefs: {\n    component: componentDataRef,\n  },\n  *factory(\n    {\n      loader,\n    }: {\n      loader: () => Promise<ComponentType<SignInPageProps>>;\n    },\n    { node },\n  ) {\n    const ExtensionComponent = lazy(() =>\n      loader().then(component => ({ default: component })),\n    );\n\n    yield componentDataRef(props => (\n      <ExtensionBoundary node={node} routable>\n        <ExtensionComponent {...props} />\n      </ExtensionBoundary>\n    ));\n  },\n});\n"],"names":[],"mappings":";;;;;;;;AAqBA,MAAM,mBAAmB,sBAEvB,EAAA,CAAE,KAAK,EAAE,EAAA,EAAI,+BAA+B,CAAA,CAAA;AAOvC,MAAM,sBAAsB,wBAAyB,CAAA;AAAA,EAC1D,IAAM,EAAA,cAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,UAAA,EAAY,OAAO,YAAa,EAAA;AAAA,EAChD,MAAA,EAAQ,CAAC,gBAAgB,CAAA;AAAA,EACzB,QAAU,EAAA;AAAA,IACR,SAAW,EAAA,gBAAA;AAAA,GACb;AAAA,EACA,CAAC,OACC,CAAA;AAAA,IACE,MAAA;AAAA,GACF,EAGA,EAAE,IAAA,EACF,EAAA;AACA,IAAA,MAAM,kBAAqB,GAAA,IAAA;AAAA,MAAK,MAC9B,QAAS,CAAA,IAAA,CAAK,gBAAc,EAAE,OAAA,EAAS,WAAY,CAAA,CAAA;AAAA,KACrD,CAAA;AAEA,IAAA,MAAM,gBAAiB,CAAA,CAAA,KAAA,qBACpB,KAAA,CAAA,aAAA,CAAA,iBAAA,EAAA,EAAkB,IAAY,EAAA,QAAA,EAAQ,IACrC,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,kBAAoB,EAAA,EAAA,GAAG,KAAO,EAAA,CACjC,CACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/blueprints/ThemeBlueprint.esm.js

@@ -0,0 +1,22 @@
+import '../wiring/coreExtensionData.esm.js';
+import 'zod';
+import 'zod-to-json-schema';
+import { createExtensionDataRef } from '../wiring/createExtensionDataRef.esm.js';
+import { createExtensionBlueprint } from '../wiring/createExtensionBlueprint.esm.js';
+
+const themeDataRef = createExtensionDataRef().with({
+  id: "core.theme.theme"
+});
+const ThemeBlueprint = createExtensionBlueprint({
+  kind: "theme",
+  namespace: "app",
+  attachTo: { id: "app", input: "themes" },
+  output: [themeDataRef],
+  dataRefs: {
+    theme: themeDataRef
+  },
+  factory: ({ theme }) => [themeDataRef(theme)]
+});
+
+export { ThemeBlueprint };
+//# sourceMappingURL=ThemeBlueprint.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ThemeBlueprint.esm.js","sources":["../../src/blueprints/ThemeBlueprint.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 { AppTheme } from '@backstage/core-plugin-api';\nimport { createExtensionBlueprint, createExtensionDataRef } from '../wiring';\n\nconst themeDataRef = createExtensionDataRef<AppTheme>().with({\n  id: 'core.theme.theme',\n});\n\n/**\n * Creates an extension that adds/replaces an app theme.\n *\n * @public\n */\nexport const ThemeBlueprint = createExtensionBlueprint({\n  kind: 'theme',\n  namespace: 'app',\n  attachTo: { id: 'app', input: 'themes' },\n  output: [themeDataRef],\n  dataRefs: {\n    theme: themeDataRef,\n  },\n  factory: ({ theme }: { theme: AppTheme }) => [themeDataRef(theme)],\n});\n"],"names":[],"mappings":";;;;;;AAmBA,MAAM,YAAA,GAAe,sBAAiC,EAAA,CAAE,IAAK,CAAA;AAAA,EAC3D,EAAI,EAAA,kBAAA;AACN,CAAC,CAAA,CAAA;AAOM,MAAM,iBAAiB,wBAAyB,CAAA;AAAA,EACrD,IAAM,EAAA,OAAA;AAAA,EACN,SAAW,EAAA,KAAA;AAAA,EACX,QAAU,EAAA,EAAE,EAAI,EAAA,KAAA,EAAO,OAAO,QAAS,EAAA;AAAA,EACvC,MAAA,EAAQ,CAAC,YAAY,CAAA;AAAA,EACrB,QAAU,EAAA;AAAA,IACR,KAAO,EAAA,YAAA;AAAA,GACT;AAAA,EACA,OAAA,EAAS,CAAC,EAAE,KAAA,OAAiC,CAAC,YAAA,CAAa,KAAK,CAAC,CAAA;AACnE,CAAC;;;;"}

package/dist/blueprints/TranslationBlueprint.esm.js

@@ -0,0 +1,21 @@
+import '../wiring/coreExtensionData.esm.js';
+import 'zod';
+import 'zod-to-json-schema';
+import { createExtensionDataRef } from '../wiring/createExtensionDataRef.esm.js';
+import { createExtensionBlueprint } from '../wiring/createExtensionBlueprint.esm.js';
+
+const translationDataRef = createExtensionDataRef().with({ id: "core.translation.translation" });
+const TranslationBlueprint = createExtensionBlueprint({
+  kind: "translation",
+  attachTo: { id: "app", input: "translations" },
+  output: [translationDataRef],
+  dataRefs: {
+    translation: translationDataRef
+  },
+  factory: ({
+    resource
+  }) => [translationDataRef(resource)]
+});
+
+export { TranslationBlueprint };
+//# sourceMappingURL=TranslationBlueprint.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TranslationBlueprint.esm.js","sources":["../../src/blueprints/TranslationBlueprint.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createExtensionBlueprint, createExtensionDataRef } from '../wiring';\nimport { TranslationMessages, TranslationResource } from '../translation';\n\nconst translationDataRef = createExtensionDataRef<\n  TranslationResource | TranslationMessages\n>().with({ id: 'core.translation.translation' });\n\n/**\n * Creates an extension that adds translations to your app.\n *\n * @public\n */\nexport const TranslationBlueprint = createExtensionBlueprint({\n  kind: 'translation',\n  attachTo: { id: 'app', input: 'translations' },\n  output: [translationDataRef],\n  dataRefs: {\n    translation: translationDataRef,\n  },\n  factory: ({\n    resource,\n  }: {\n    resource: TranslationResource | TranslationMessages;\n  }) => [translationDataRef(resource)],\n});\n"],"names":[],"mappings":";;;;;;AAmBA,MAAM,qBAAqB,sBAEzB,EAAA,CAAE,KAAK,EAAE,EAAA,EAAI,gCAAgC,CAAA,CAAA;AAOxC,MAAM,uBAAuB,wBAAyB,CAAA;AAAA,EAC3D,IAAM,EAAA,aAAA;AAAA,EACN,QAAU,EAAA,EAAE,EAAI,EAAA,KAAA,EAAO,OAAO,cAAe,EAAA;AAAA,EAC7C,MAAA,EAAQ,CAAC,kBAAkB,CAAA;AAAA,EAC3B,QAAU,EAAA;AAAA,IACR,WAAa,EAAA,kBAAA;AAAA,GACf;AAAA,EACA,SAAS,CAAC;AAAA,IACR,QAAA;AAAA,GAGI,KAAA,CAAC,kBAAmB,CAAA,QAAQ,CAAC,CAAA;AACrC,CAAC;;;;"}

package/dist/components/ExtensionBoundary.esm.js

@@ -1,4 +1,4 @@
-import React, { Suspense, useEffect } from 'react';
+import React, { Suspense, lazy, useEffect } from 'react';
 import { AnalyticsContext, useAnalytics } from '@backstage/core-plugin-api';
 import { ErrorBoundary } from './ErrorBoundary.esm.js';
 import { routableExtensionRenderedEvent } from '../core-plugin-api/src/analytics/Tracker.esm.js';
@@ -35,6 +35,15 @@ function ExtensionBoundary(props) {
   };
   return /* @__PURE__ */ React.createElement(Suspense, { fallback: /* @__PURE__ */ React.createElement(Progress, null) }, /* @__PURE__ */ React.createElement(ErrorBoundary, { plugin, Fallback: fallback }, /* @__PURE__ */ React.createElement(AnalyticsContext, { attributes }, /* @__PURE__ */ React.createElement(RouteTracker, { disableTracking: !(routable ?? doesOutputRoutePath) }, children))));
 }
+((ExtensionBoundary2) => {
+  function lazy$1(appNode, lazyElement) {
+    const ExtensionComponent = lazy(
+      () => lazyElement().then((element) => ({ default: () => element }))
+    );
+    return /* @__PURE__ */ React.createElement(ExtensionBoundary2, { node: appNode }, /* @__PURE__ */ React.createElement(ExtensionComponent, null));
+  }
+  ExtensionBoundary2.lazy = lazy$1;
+})(ExtensionBoundary || (ExtensionBoundary = {}));
 
 export { ExtensionBoundary };
 //# sourceMappingURL=ExtensionBoundary.esm.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"ExtensionBoundary.esm.js","sources":["../../src/components/ExtensionBoundary.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 React, {\n  PropsWithChildren,\n  ReactNode,\n  Suspense,\n  useEffect,\n} from 'react';\nimport { AnalyticsContext, useAnalytics } from '@backstage/core-plugin-api';\nimport { ErrorBoundary } from './ErrorBoundary';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { routableExtensionRenderedEvent } from '../../../core-plugin-api/src/analytics/Tracker';\nimport { AppNode, useComponentRef } from '../apis';\nimport { coreComponentRefs } from './coreComponentRefs';\nimport { coreExtensionData } from '../wiring';\n\ntype RouteTrackerProps = PropsWithChildren<{\n  disableTracking?: boolean;\n}>;\n\nconst RouteTracker = (props: RouteTrackerProps) => {\n  const { disableTracking, children } = props;\n  const analytics = useAnalytics();\n\n  // This event, never exposed to end-users of the analytics API,\n  // helps inform which extension metadata gets associated with a\n  // navigation event when the route navigated to is a gathered\n  // mountpoint.\n  useEffect(() => {\n    if (disableTracking) return;\n    analytics.captureEvent(routableExtensionRenderedEvent, '');\n  }, [analytics, disableTracking]);\n\n  return <>{children}</>;\n};\n\n/** @public */\nexport interface ExtensionBoundaryProps {\n  node: AppNode;\n  /**\n   * This explicitly marks the extension as routable for the purpose of\n   * capturing analytics events. If not provided, the extension boundary will be\n   * marked as routable if it outputs a routePath.\n   */\n  routable?: boolean;\n  children: ReactNode;\n}\n\n/** @public */\nexport function ExtensionBoundary(props: ExtensionBoundaryProps) {\n  const { node, routable, children } = props;\n\n  const doesOutputRoutePath = Boolean(\n    node.instance?.getData(coreExtensionData.routePath),\n  );\n\n  const plugin = node.spec.source;\n  const Progress = useComponentRef(coreComponentRefs.progress);\n  const fallback = useComponentRef(coreComponentRefs.errorBoundaryFallback);\n\n  // Skipping \"routeRef\" attribute in the new system, the extension \"id\" should provide more insight\n  const attributes = {\n    extensionId: node.spec.id,\n    pluginId: node.spec.source?.id ?? 'app',\n  };\n\n  return (\n    <Suspense fallback={<Progress />}>\n      <ErrorBoundary plugin={plugin} Fallback={fallback}>\n        <AnalyticsContext attributes={attributes}>\n          <RouteTracker disableTracking={!(routable ?? doesOutputRoutePath)}>\n            {children}\n          </RouteTracker>\n        </AnalyticsContext>\n      </ErrorBoundary>\n    </Suspense>\n  );\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;AAkCA,MAAM,YAAA,GAAe,CAAC,KAA6B,KAAA;AACjD,EAAM,MAAA,EAAE,eAAiB,EAAA,QAAA,EAAa,GAAA,KAAA,CAAA;AACtC,EAAA,MAAM,YAAY,YAAa,EAAA,CAAA;AAM/B,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,eAAiB,EAAA,OAAA;AACrB,IAAU,SAAA,CAAA,YAAA,CAAa,gCAAgC,EAAE,CAAA,CAAA;AAAA,GACxD,EAAA,CAAC,SAAW,EAAA,eAAe,CAAC,CAAA,CAAA;AAE/B,EAAA,iEAAU,QAAS,CAAA,CAAA;AACrB,CAAA,CAAA;AAeO,SAAS,kBAAkB,KAA+B,EAAA;AAC/D,EAAA,MAAM,EAAE,IAAA,EAAM,QAAU,EAAA,QAAA,EAAa,GAAA,KAAA,CAAA;AAErC,EAAA,MAAM,mBAAsB,GAAA,OAAA;AAAA,IAC1B,IAAK,CAAA,QAAA,EAAU,OAAQ,CAAA,iBAAA,CAAkB,SAAS,CAAA;AAAA,GACpD,CAAA;AAEA,EAAM,MAAA,MAAA,GAAS,KAAK,IAAK,CAAA,MAAA,CAAA;AACzB,EAAM,MAAA,QAAA,GAAW,eAAgB,CAAA,iBAAA,CAAkB,QAAQ,CAAA,CAAA;AAC3D,EAAM,MAAA,QAAA,GAAW,eAAgB,CAAA,iBAAA,CAAkB,qBAAqB,CAAA,CAAA;AAGxE,EAAA,MAAM,UAAa,GAAA;AAAA,IACjB,WAAA,EAAa,KAAK,IAAK,CAAA,EAAA;AAAA,IACvB,QAAU,EAAA,IAAA,CAAK,IAAK,CAAA,MAAA,EAAQ,EAAM,IAAA,KAAA;AAAA,GACpC,CAAA;AAEA,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,YAAS,QAAU,kBAAA,KAAA,CAAA,aAAA,CAAC,cAAS,CAC5B,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,aAAc,EAAA,EAAA,MAAA,EAAgB,QAAU,EAAA,QAAA,EAAA,sCACtC,gBAAiB,EAAA,EAAA,UAAA,EAAA,kBACf,KAAA,CAAA,aAAA,CAAA,YAAA,EAAA,EAAa,eAAiB,EAAA,EAAE,YAAY,mBAC1C,CAAA,EAAA,EAAA,QACH,CACF,CACF,CACF,CAAA,CAAA;AAEJ;;;;"}
+{"version":3,"file":"ExtensionBoundary.esm.js","sources":["../../src/components/ExtensionBoundary.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 React, {\n  PropsWithChildren,\n  ReactNode,\n  Suspense,\n  useEffect,\n  lazy as reactLazy,\n} from 'react';\nimport { AnalyticsContext, useAnalytics } from '@backstage/core-plugin-api';\nimport { ErrorBoundary } from './ErrorBoundary';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { routableExtensionRenderedEvent } from '../../../core-plugin-api/src/analytics/Tracker';\nimport { AppNode, useComponentRef } from '../apis';\nimport { coreComponentRefs } from './coreComponentRefs';\nimport { coreExtensionData } from '../wiring';\n\ntype RouteTrackerProps = PropsWithChildren<{\n  disableTracking?: boolean;\n}>;\n\nconst RouteTracker = (props: RouteTrackerProps) => {\n  const { disableTracking, children } = props;\n  const analytics = useAnalytics();\n\n  // This event, never exposed to end-users of the analytics API,\n  // helps inform which extension metadata gets associated with a\n  // navigation event when the route navigated to is a gathered\n  // mountpoint.\n  useEffect(() => {\n    if (disableTracking) return;\n    analytics.captureEvent(routableExtensionRenderedEvent, '');\n  }, [analytics, disableTracking]);\n\n  return <>{children}</>;\n};\n\n/** @public */\nexport interface ExtensionBoundaryProps {\n  node: AppNode;\n  /**\n   * This explicitly marks the extension as routable for the purpose of\n   * capturing analytics events. If not provided, the extension boundary will be\n   * marked as routable if it outputs a routePath.\n   */\n  routable?: boolean;\n  children: ReactNode;\n}\n\n/** @public */\nexport function ExtensionBoundary(props: ExtensionBoundaryProps) {\n  const { node, routable, children } = props;\n\n  const doesOutputRoutePath = Boolean(\n    node.instance?.getData(coreExtensionData.routePath),\n  );\n\n  const plugin = node.spec.source;\n  const Progress = useComponentRef(coreComponentRefs.progress);\n  const fallback = useComponentRef(coreComponentRefs.errorBoundaryFallback);\n\n  // Skipping \"routeRef\" attribute in the new system, the extension \"id\" should provide more insight\n  const attributes = {\n    extensionId: node.spec.id,\n    pluginId: node.spec.source?.id ?? 'app',\n  };\n\n  return (\n    <Suspense fallback={<Progress />}>\n      <ErrorBoundary plugin={plugin} Fallback={fallback}>\n        <AnalyticsContext attributes={attributes}>\n          <RouteTracker disableTracking={!(routable ?? doesOutputRoutePath)}>\n            {children}\n          </RouteTracker>\n        </AnalyticsContext>\n      </ErrorBoundary>\n    </Suspense>\n  );\n}\n\n/** @public */\nexport namespace ExtensionBoundary {\n  export function lazy(\n    appNode: AppNode,\n    lazyElement: () => Promise<JSX.Element>,\n  ): JSX.Element {\n    const ExtensionComponent = reactLazy(() =>\n      lazyElement().then(element => ({ default: () => element })),\n    );\n    return (\n      <ExtensionBoundary node={appNode}>\n        <ExtensionComponent />\n      </ExtensionBoundary>\n    );\n  }\n}\n"],"names":["ExtensionBoundary","lazy","reactLazy"],"mappings":";;;;;;;;;;;;;;AAmCA,MAAM,YAAA,GAAe,CAAC,KAA6B,KAAA;AACjD,EAAM,MAAA,EAAE,eAAiB,EAAA,QAAA,EAAa,GAAA,KAAA,CAAA;AACtC,EAAA,MAAM,YAAY,YAAa,EAAA,CAAA;AAM/B,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,eAAiB,EAAA,OAAA;AACrB,IAAU,SAAA,CAAA,YAAA,CAAa,gCAAgC,EAAE,CAAA,CAAA;AAAA,GACxD,EAAA,CAAC,SAAW,EAAA,eAAe,CAAC,CAAA,CAAA;AAE/B,EAAA,iEAAU,QAAS,CAAA,CAAA;AACrB,CAAA,CAAA;AAeO,SAAS,kBAAkB,KAA+B,EAAA;AAC/D,EAAA,MAAM,EAAE,IAAA,EAAM,QAAU,EAAA,QAAA,EAAa,GAAA,KAAA,CAAA;AAErC,EAAA,MAAM,mBAAsB,GAAA,OAAA;AAAA,IAC1B,IAAK,CAAA,QAAA,EAAU,OAAQ,CAAA,iBAAA,CAAkB,SAAS,CAAA;AAAA,GACpD,CAAA;AAEA,EAAM,MAAA,MAAA,GAAS,KAAK,IAAK,CAAA,MAAA,CAAA;AACzB,EAAM,MAAA,QAAA,GAAW,eAAgB,CAAA,iBAAA,CAAkB,QAAQ,CAAA,CAAA;AAC3D,EAAM,MAAA,QAAA,GAAW,eAAgB,CAAA,iBAAA,CAAkB,qBAAqB,CAAA,CAAA;AAGxE,EAAA,MAAM,UAAa,GAAA;AAAA,IACjB,WAAA,EAAa,KAAK,IAAK,CAAA,EAAA;AAAA,IACvB,QAAU,EAAA,IAAA,CAAK,IAAK,CAAA,MAAA,EAAQ,EAAM,IAAA,KAAA;AAAA,GACpC,CAAA;AAEA,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,YAAS,QAAU,kBAAA,KAAA,CAAA,aAAA,CAAC,cAAS,CAC5B,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,aAAc,EAAA,EAAA,MAAA,EAAgB,QAAU,EAAA,QAAA,EAAA,sCACtC,gBAAiB,EAAA,EAAA,UAAA,EAAA,kBACf,KAAA,CAAA,aAAA,CAAA,YAAA,EAAA,EAAa,eAAiB,EAAA,EAAE,YAAY,mBAC1C,CAAA,EAAA,EAAA,QACH,CACF,CACF,CACF,CAAA,CAAA;AAEJ,CAAA;AAAA,CAGO,CAAUA,kBAAV,KAAA;AACE,EAAS,SAAAC,MAAA,CACd,SACA,WACa,EAAA;AACb,IAAA,MAAM,kBAAqB,GAAAC,IAAA;AAAA,MAAU,MACnC,aAAc,CAAA,IAAA,CAAK,cAAY,EAAE,OAAA,EAAS,MAAM,OAAA,EAAU,CAAA,CAAA;AAAA,KAC5D,CAAA;AACA,IAAA,2CACGF,kBAAA,EAAA,EAAkB,MAAM,OACvB,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,wBAAmB,CACtB,CAAA,CAAA;AAAA,GAEJ;AAZO,EAAAA,kBAAS,CAAA,IAAA,GAAAC,MAAA,CAAA;AAAA,CADD,EAAA,iBAAA,KAAA,iBAAA,GAAA,EAAA,CAAA,CAAA;;;;"}