@backstage/core-compat-api 0.3.7-next.1 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,86 @@
 # @backstage/core-compat-api
 
+## 0.4.0
+
+### Minor Changes
+
+- 8250ffe: **BREAKING**: Dropped support for the removed opaque `@backstage/ExtensionOverrides` and `@backstage/BackstagePlugin` types.
+
+### Patch Changes
+
+- cbe6177: Improved route path normalization when converting existing route elements in `converLegacyApp`, for example handling trailing `/*` in paths.
+- d34e0e5: Added a new `convertLegacyAppOptions` helper that converts many of the options passed to `createApp` in the old frontend system to a module with app overrides for the new system. The supported options are `apis`, `icons`, `plugins`, `components`, and `themes`.
+
+  For example, given the following options for the old `createApp`:
+
+  ```ts
+  import { createApp } from '@backstage/app-deafults';
+
+  const app = createApp({
+    apis,
+    plugins,
+    icons: {
+      custom: MyIcon,
+    },
+    components: {
+      SignInPage: MySignInPage,
+    },
+    themes: [myTheme],
+  });
+  ```
+
+  They can be converted to the new system like this:
+
+  ```ts
+  import { createApp } from '@backstage/frontend-deafults';
+  import { convertLegacyAppOptions } from '@backstage/core-compat-api';
+
+  const app = createApp({
+    features: [
+      convertLegacyAppOptions({
+        apis,
+        plugins,
+        icons: {
+          custom: MyIcon,
+        },
+        components: {
+          SignInPage: MySignInPage,
+        },
+        themes: [myTheme],
+      }),
+    ],
+  });
+  ```
+
+- e7fab55: Added the `entityPage` option to `convertLegacyApp`, which you can read more about in the [app migration docs](https://backstage.io/docs/frontend-system/building-apps/migrating#entity-pages).
+- 18faf65: The `convertLegacyApp` has received the following changes:
+
+  - `null` routes will now be ignored.
+  - Converted routes no longer need to belong to a plugin, falling back to a `converted-orphan-routes` plugin instead.
+  - The generate layout override extension is now properly attached to the `app/root` extension.
+  - Converted root elements are now automatically wrapped with `compatWrapper`.
+
+- Updated dependencies
+  - @backstage/core-plugin-api@1.10.5
+  - @backstage/frontend-plugin-api@0.10.0
+  - @backstage/plugin-catalog-react@1.16.0
+  - @backstage/version-bridge@1.0.11
+
+## 0.4.0-next.2
+
+### Minor Changes
+
+- 8250ffe: **BREAKING**: Dropped support for the removed opaque `@backstage/ExtensionOverrides` and `@backstage/BackstagePlugin` types.
+
+### Patch Changes
+
+- e7fab55: Added the `entityPage` option to `convertLegacyApp`, which you can read more about in the [app migration docs](https://backstage.io/docs/frontend-system/building-apps/migrating#entity-pages).
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.10.0-next.2
+  - @backstage/plugin-catalog-react@1.16.0-next.2
+  - @backstage/core-plugin-api@1.10.4
+  - @backstage/version-bridge@1.0.11
+
 ## 0.3.7-next.1
 
 ### Patch Changes

package/dist/collectEntityPageContents.esm.js

@@ -0,0 +1,164 @@
+import { getComponentData } from '@backstage/core-plugin-api';
+import React from 'react';
+import { EntityCardBlueprint, EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';
+import { normalizeRoutePath } from './normalizeRoutePath.esm.js';
+
+const ENTITY_SWITCH_KEY = "core.backstage.entitySwitch";
+const ENTITY_ROUTE_KEY = "plugin.catalog.entityLayoutRoute";
+function allFilters(...ifs) {
+  const filtered = ifs.filter(Boolean);
+  if (!filtered.length) {
+    return void 0;
+  }
+  if (filtered.length === 1) {
+    return filtered[0];
+  }
+  return (entity, ctx) => filtered.every((ifFunc) => ifFunc(entity, ctx));
+}
+function anyFilters(...ifs) {
+  const filtered = ifs.filter(Boolean);
+  if (!filtered.length) {
+    return void 0;
+  }
+  if (filtered.length === 1) {
+    return filtered[0];
+  }
+  return (entity, ctx) => filtered.some((ifFunc) => ifFunc(entity, ctx));
+}
+function invertFilter(ifFunc) {
+  if (!ifFunc) {
+    return () => true;
+  }
+  return (entity, ctx) => !ifFunc(entity, ctx);
+}
+function collectEntityPageContents(entityPageElement, context) {
+  let cardCounter = 1;
+  let routeCounter = 1;
+  function traverse(element, parentFilter) {
+    if (!React.isValidElement(element)) {
+      return;
+    }
+    const pageNode = maybeParseEntityPageNode(element);
+    if (pageNode) {
+      if (pageNode.type === "route") {
+        const mergedIf = allFilters(parentFilter, pageNode.if);
+        if (pageNode.path === "/") {
+          context.discoverExtension(
+            EntityCardBlueprint.makeWithOverrides({
+              name: `discovered-${cardCounter++}`,
+              factory(originalFactory, { apis }) {
+                return originalFactory({
+                  type: "content",
+                  filter: mergedIf && ((entity) => mergedIf(entity, { apis })),
+                  loader: () => Promise.resolve(pageNode.children)
+                });
+              }
+            })
+          );
+        } else {
+          const name = `discovered-${routeCounter++}`;
+          context.discoverExtension(
+            EntityContentBlueprint.makeWithOverrides({
+              name,
+              factory(originalFactory, { apis }) {
+                return originalFactory({
+                  defaultPath: normalizeRoutePath(pageNode.path),
+                  defaultTitle: pageNode.title,
+                  filter: mergedIf && ((entity) => mergedIf(entity, { apis })),
+                  loader: () => Promise.resolve(pageNode.children)
+                });
+              }
+            }),
+            getComponentData(
+              pageNode.children,
+              "core.plugin"
+            )
+          );
+        }
+      }
+      if (pageNode.type === "switch") {
+        if (pageNode.renderMultipleMatches === "all") {
+          for (const entityCase of pageNode.cases) {
+            traverse(
+              entityCase.children,
+              allFilters(parentFilter, entityCase.if)
+            );
+          }
+        } else {
+          let previousIf = () => false;
+          for (const entityCase of pageNode.cases) {
+            const didNotMatchEarlier = invertFilter(previousIf);
+            traverse(
+              entityCase.children,
+              allFilters(parentFilter, entityCase.if, didNotMatchEarlier)
+            );
+            previousIf = anyFilters(previousIf, entityCase.if);
+          }
+        }
+      }
+      return;
+    }
+    React.Children.forEach(
+      element.props?.children,
+      (child) => {
+        traverse(child, parentFilter);
+      }
+    );
+  }
+  traverse(entityPageElement);
+}
+function wrapAsyncEntityFilter(asyncFilter) {
+  if (!asyncFilter) {
+    return asyncFilter;
+  }
+  let loggedError = false;
+  return (entity, ctx) => {
+    const result = asyncFilter(entity, ctx);
+    if (result && typeof result === "object" && "then" in result) {
+      if (!loggedError) {
+        console.error(
+          `collectEntityPageContents does not support async entity filters, skipping filter ${asyncFilter}`
+        );
+        loggedError = true;
+      }
+      return false;
+    }
+    return result;
+  };
+}
+function maybeParseEntityPageNode(element) {
+  if (getComponentData(element, ENTITY_ROUTE_KEY)) {
+    const props = element.props;
+    return {
+      type: "route",
+      path: props.path,
+      title: props.title,
+      if: props.if,
+      children: props.children
+    };
+  }
+  const parentProps = element.props;
+  const children = React.Children.toArray(parentProps?.children);
+  if (!children.length) {
+    return void 0;
+  }
+  const cases = [];
+  for (const child of children) {
+    if (!getComponentData(child, ENTITY_SWITCH_KEY)) {
+      return void 0;
+    }
+    const props = child.props;
+    cases.push({
+      if: wrapAsyncEntityFilter(props.if),
+      children: props.children
+    });
+  }
+  return {
+    type: "switch",
+    cases,
+    renderMultipleMatches: parentProps?.renderMultipleMatches ?? "first"
+  };
+}
+
+export { collectEntityPageContents };
+//# sourceMappingURL=collectEntityPageContents.esm.js.map

package/dist/collectEntityPageContents.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectEntityPageContents.esm.js","sources":["../src/collectEntityPageContents.ts"],"sourcesContent":["/*\n * Copyright 2025 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  getComponentData,\n  BackstagePlugin as LegacyBackstagePlugin,\n} from '@backstage/core-plugin-api';\nimport { ExtensionDefinition } from '@backstage/frontend-plugin-api';\nimport React from 'react';\nimport {\n  EntityCardBlueprint,\n  EntityContentBlueprint,\n} from '@backstage/plugin-catalog-react/alpha';\nimport { normalizeRoutePath } from './normalizeRoutePath';\n\nconst ENTITY_SWITCH_KEY = 'core.backstage.entitySwitch';\nconst ENTITY_ROUTE_KEY = 'plugin.catalog.entityLayoutRoute';\n\n// Placeholder to make sure internal types here are consitent\ntype Entity = { apiVersion: string; kind: string };\n\ntype EntityFilter = (entity: Entity, ctx: { apis: ApiHolder }) => boolean;\ntype AsyncEntityFilter = (\n  entity: Entity,\n  context: { apis: ApiHolder },\n) => boolean | Promise<boolean>;\n\nfunction allFilters(\n  ...ifs: (EntityFilter | undefined)[]\n): EntityFilter | undefined {\n  const filtered = ifs.filter(Boolean) as EntityFilter[];\n  if (!filtered.length) {\n    return undefined;\n  }\n  if (filtered.length === 1) {\n    return filtered[0];\n  }\n  return (entity, ctx) => filtered.every(ifFunc => ifFunc(entity, ctx));\n}\n\nfunction anyFilters(\n  ...ifs: (EntityFilter | undefined)[]\n): EntityFilter | undefined {\n  const filtered = ifs.filter(Boolean) as EntityFilter[];\n  if (!filtered.length) {\n    return undefined;\n  }\n  if (filtered.length === 1) {\n    return filtered[0];\n  }\n  return (entity, ctx) => filtered.some(ifFunc => ifFunc(entity, ctx));\n}\n\nfunction invertFilter(ifFunc?: EntityFilter): EntityFilter {\n  if (!ifFunc) {\n    return () => true;\n  }\n  return (entity, ctx) => !ifFunc(entity, ctx);\n}\n\nexport function collectEntityPageContents(\n  entityPageElement: React.JSX.Element,\n  context: {\n    discoverExtension(\n      extension: ExtensionDefinition,\n      plugin?: LegacyBackstagePlugin,\n    ): void;\n  },\n) {\n  let cardCounter = 1;\n  let routeCounter = 1;\n\n  function traverse(element: React.ReactNode, parentFilter?: EntityFilter) {\n    if (!React.isValidElement(element)) {\n      return;\n    }\n\n    const pageNode = maybeParseEntityPageNode(element);\n    if (pageNode) {\n      if (pageNode.type === 'route') {\n        const mergedIf = allFilters(parentFilter, pageNode.if);\n\n        if (pageNode.path === '/') {\n          context.discoverExtension(\n            EntityCardBlueprint.makeWithOverrides({\n              name: `discovered-${cardCounter++}`,\n              factory(originalFactory, { apis }) {\n                return originalFactory({\n                  type: 'content',\n                  filter: mergedIf && (entity => mergedIf(entity, { apis })),\n                  loader: () => Promise.resolve(pageNode.children),\n                });\n              },\n            }),\n          );\n        } else {\n          const name = `discovered-${routeCounter++}`;\n\n          context.discoverExtension(\n            EntityContentBlueprint.makeWithOverrides({\n              name,\n              factory(originalFactory, { apis }) {\n                return originalFactory({\n                  defaultPath: normalizeRoutePath(pageNode.path),\n                  defaultTitle: pageNode.title,\n                  filter: mergedIf && (entity => mergedIf(entity, { apis })),\n                  loader: () => Promise.resolve(pageNode.children),\n                });\n              },\n            }),\n            getComponentData<LegacyBackstagePlugin>(\n              pageNode.children,\n              'core.plugin',\n            ),\n          );\n        }\n      }\n      if (pageNode.type === 'switch') {\n        if (pageNode.renderMultipleMatches === 'all') {\n          for (const entityCase of pageNode.cases) {\n            traverse(\n              entityCase.children,\n              allFilters(parentFilter, entityCase.if),\n            );\n          }\n        } else {\n          let previousIf: EntityFilter = () => false;\n          for (const entityCase of pageNode.cases) {\n            const didNotMatchEarlier = invertFilter(previousIf);\n            traverse(\n              entityCase.children,\n              allFilters(parentFilter, entityCase.if, didNotMatchEarlier),\n            );\n            previousIf = anyFilters(previousIf, entityCase.if)!;\n          }\n        }\n      }\n      return;\n    }\n\n    React.Children.forEach(\n      (element.props as { children?: React.ReactNode })?.children,\n      child => {\n        traverse(child, parentFilter);\n      },\n    );\n  }\n\n  traverse(entityPageElement);\n}\n\ntype EntityRoute = {\n  type: 'route';\n  path: string;\n  title: string;\n  if?: EntityFilter;\n  children: JSX.Element;\n};\n\ntype EntitySwitchCase = {\n  if?: EntityFilter;\n  children: React.ReactNode;\n};\n\ntype EntitySwitch = {\n  type: 'switch';\n  cases: EntitySwitchCase[];\n  renderMultipleMatches: 'first' | 'all';\n};\n\nfunction wrapAsyncEntityFilter(\n  asyncFilter?: AsyncEntityFilter,\n): EntityFilter | undefined {\n  if (!asyncFilter) {\n    return asyncFilter;\n  }\n  let loggedError = false;\n  return (entity, ctx) => {\n    const result = asyncFilter(entity, ctx);\n    if (result && typeof result === 'object' && 'then' in result) {\n      if (!loggedError) {\n        // eslint-disable-next-line no-console\n        console.error(\n          `collectEntityPageContents does not support async entity filters, skipping filter ${asyncFilter}`,\n        );\n        loggedError = true;\n      }\n      return false;\n    }\n    return result;\n  };\n}\n\nfunction maybeParseEntityPageNode(\n  element: React.JSX.Element,\n): EntityRoute | EntitySwitch | undefined {\n  if (getComponentData(element, ENTITY_ROUTE_KEY)) {\n    const props = element.props as EntityRoute;\n    return {\n      type: 'route',\n      path: props.path,\n      title: props.title,\n      if: props.if,\n      children: props.children,\n    };\n  }\n\n  const parentProps = element.props as {\n    children?: React.ReactNode;\n    renderMultipleMatches?: 'first' | 'all';\n  };\n\n  const children = React.Children.toArray(parentProps?.children);\n  if (!children.length) {\n    return undefined;\n  }\n\n  const cases = [];\n  for (const child of children) {\n    if (!getComponentData(child, ENTITY_SWITCH_KEY)) {\n      return undefined;\n    }\n    const props = (child as { props: EntitySwitchCase }).props;\n\n    cases.push({\n      if: wrapAsyncEntityFilter(props.if),\n      children: props.children,\n    });\n  }\n  return {\n    type: 'switch',\n    cases,\n    renderMultipleMatches: parentProps?.renderMultipleMatches ?? 'first',\n  };\n}\n"],"names":[],"mappings":";;;;;AA6BA,MAAM,iBAAoB,GAAA,6BAAA;AAC1B,MAAM,gBAAmB,GAAA,kCAAA;AAWzB,SAAS,cACJ,GACuB,EAAA;AAC1B,EAAM,MAAA,QAAA,GAAW,GAAI,CAAA,MAAA,CAAO,OAAO,CAAA;AACnC,EAAI,IAAA,CAAC,SAAS,MAAQ,EAAA;AACpB,IAAO,OAAA,KAAA,CAAA;AAAA;AAET,EAAI,IAAA,QAAA,CAAS,WAAW,CAAG,EAAA;AACzB,IAAA,OAAO,SAAS,CAAC,CAAA;AAAA;AAEnB,EAAO,OAAA,CAAC,QAAQ,GAAQ,KAAA,QAAA,CAAS,MAAM,CAAU,MAAA,KAAA,MAAA,CAAO,MAAQ,EAAA,GAAG,CAAC,CAAA;AACtE;AAEA,SAAS,cACJ,GACuB,EAAA;AAC1B,EAAM,MAAA,QAAA,GAAW,GAAI,CAAA,MAAA,CAAO,OAAO,CAAA;AACnC,EAAI,IAAA,CAAC,SAAS,MAAQ,EAAA;AACpB,IAAO,OAAA,KAAA,CAAA;AAAA;AAET,EAAI,IAAA,QAAA,CAAS,WAAW,CAAG,EAAA;AACzB,IAAA,OAAO,SAAS,CAAC,CAAA;AAAA;AAEnB,EAAO,OAAA,CAAC,QAAQ,GAAQ,KAAA,QAAA,CAAS,KAAK,CAAU,MAAA,KAAA,MAAA,CAAO,MAAQ,EAAA,GAAG,CAAC,CAAA;AACrE;AAEA,SAAS,aAAa,MAAqC,EAAA;AACzD,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAA,OAAO,MAAM,IAAA;AAAA;AAEf,EAAA,OAAO,CAAC,MAAQ,EAAA,GAAA,KAAQ,CAAC,MAAA,CAAO,QAAQ,GAAG,CAAA;AAC7C;AAEgB,SAAA,yBAAA,CACd,mBACA,OAMA,EAAA;AACA,EAAA,IAAI,WAAc,GAAA,CAAA;AAClB,EAAA,IAAI,YAAe,GAAA,CAAA;AAEnB,EAAS,SAAA,QAAA,CAAS,SAA0B,YAA6B,EAAA;AACvE,IAAA,IAAI,CAAC,KAAA,CAAM,cAAe,CAAA,OAAO,CAAG,EAAA;AAClC,MAAA;AAAA;AAGF,IAAM,MAAA,QAAA,GAAW,yBAAyB,OAAO,CAAA;AACjD,IAAA,IAAI,QAAU,EAAA;AACZ,MAAI,IAAA,QAAA,CAAS,SAAS,OAAS,EAAA;AAC7B,QAAA,MAAM,QAAW,GAAA,UAAA,CAAW,YAAc,EAAA,QAAA,CAAS,EAAE,CAAA;AAErD,QAAI,IAAA,QAAA,CAAS,SAAS,GAAK,EAAA;AACzB,UAAQ,OAAA,CAAA,iBAAA;AAAA,YACN,oBAAoB,iBAAkB,CAAA;AAAA,cACpC,IAAA,EAAM,cAAc,WAAa,EAAA,CAAA,CAAA;AAAA,cACjC,OAAQ,CAAA,eAAA,EAAiB,EAAE,IAAA,EAAQ,EAAA;AACjC,gBAAA,OAAO,eAAgB,CAAA;AAAA,kBACrB,IAAM,EAAA,SAAA;AAAA,kBACN,QAAQ,QAAa,KAAA,CAAA,MAAA,KAAU,SAAS,MAAQ,EAAA,EAAE,MAAM,CAAA,CAAA;AAAA,kBACxD,MAAQ,EAAA,MAAM,OAAQ,CAAA,OAAA,CAAQ,SAAS,QAAQ;AAAA,iBAChD,CAAA;AAAA;AACH,aACD;AAAA,WACH;AAAA,SACK,MAAA;AACL,UAAM,MAAA,IAAA,GAAO,cAAc,YAAc,EAAA,CAAA,CAAA;AAEzC,UAAQ,OAAA,CAAA,iBAAA;AAAA,YACN,uBAAuB,iBAAkB,CAAA;AAAA,cACvC,IAAA;AAAA,cACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,IAAA,EAAQ,EAAA;AACjC,gBAAA,OAAO,eAAgB,CAAA;AAAA,kBACrB,WAAA,EAAa,kBAAmB,CAAA,QAAA,CAAS,IAAI,CAAA;AAAA,kBAC7C,cAAc,QAAS,CAAA,KAAA;AAAA,kBACvB,QAAQ,QAAa,KAAA,CAAA,MAAA,KAAU,SAAS,MAAQ,EAAA,EAAE,MAAM,CAAA,CAAA;AAAA,kBACxD,MAAQ,EAAA,MAAM,OAAQ,CAAA,OAAA,CAAQ,SAAS,QAAQ;AAAA,iBAChD,CAAA;AAAA;AACH,aACD,CAAA;AAAA,YACD,gBAAA;AAAA,cACE,QAAS,CAAA,QAAA;AAAA,cACT;AAAA;AACF,WACF;AAAA;AACF;AAEF,MAAI,IAAA,QAAA,CAAS,SAAS,QAAU,EAAA;AAC9B,QAAI,IAAA,QAAA,CAAS,0BAA0B,KAAO,EAAA;AAC5C,UAAW,KAAA,MAAA,UAAA,IAAc,SAAS,KAAO,EAAA;AACvC,YAAA,QAAA;AAAA,cACE,UAAW,CAAA,QAAA;AAAA,cACX,UAAA,CAAW,YAAc,EAAA,UAAA,CAAW,EAAE;AAAA,aACxC;AAAA;AACF,SACK,MAAA;AACL,UAAA,IAAI,aAA2B,MAAM,KAAA;AACrC,UAAW,KAAA,MAAA,UAAA,IAAc,SAAS,KAAO,EAAA;AACvC,YAAM,MAAA,kBAAA,GAAqB,aAAa,UAAU,CAAA;AAClD,YAAA,QAAA;AAAA,cACE,UAAW,CAAA,QAAA;AAAA,cACX,UAAW,CAAA,YAAA,EAAc,UAAW,CAAA,EAAA,EAAI,kBAAkB;AAAA,aAC5D;AACA,YAAa,UAAA,GAAA,UAAA,CAAW,UAAY,EAAA,UAAA,CAAW,EAAE,CAAA;AAAA;AACnD;AACF;AAEF,MAAA;AAAA;AAGF,IAAA,KAAA,CAAM,QAAS,CAAA,OAAA;AAAA,MACZ,QAAQ,KAA0C,EAAA,QAAA;AAAA,MACnD,CAAS,KAAA,KAAA;AACP,QAAA,QAAA,CAAS,OAAO,YAAY,CAAA;AAAA;AAC9B,KACF;AAAA;AAGF,EAAA,QAAA,CAAS,iBAAiB,CAAA;AAC5B;AAqBA,SAAS,sBACP,WAC0B,EAAA;AAC1B,EAAA,IAAI,CAAC,WAAa,EAAA;AAChB,IAAO,OAAA,WAAA;AAAA;AAET,EAAA,IAAI,WAAc,GAAA,KAAA;AAClB,EAAO,OAAA,CAAC,QAAQ,GAAQ,KAAA;AACtB,IAAM,MAAA,MAAA,GAAS,WAAY,CAAA,MAAA,EAAQ,GAAG,CAAA;AACtC,IAAA,IAAI,MAAU,IAAA,OAAO,MAAW,KAAA,QAAA,IAAY,UAAU,MAAQ,EAAA;AAC5D,MAAA,IAAI,CAAC,WAAa,EAAA;AAEhB,QAAQ,OAAA,CAAA,KAAA;AAAA,UACN,oFAAoF,WAAW,CAAA;AAAA,SACjG;AACA,QAAc,WAAA,GAAA,IAAA;AAAA;AAEhB,MAAO,OAAA,KAAA;AAAA;AAET,IAAO,OAAA,MAAA;AAAA,GACT;AACF;AAEA,SAAS,yBACP,OACwC,EAAA;AACxC,EAAI,IAAA,gBAAA,CAAiB,OAAS,EAAA,gBAAgB,CAAG,EAAA;AAC/C,IAAA,MAAM,QAAQ,OAAQ,CAAA,KAAA;AACtB,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,OAAA;AAAA,MACN,MAAM,KAAM,CAAA,IAAA;AAAA,MACZ,OAAO,KAAM,CAAA,KAAA;AAAA,MACb,IAAI,KAAM,CAAA,EAAA;AAAA,MACV,UAAU,KAAM,CAAA;AAAA,KAClB;AAAA;AAGF,EAAA,MAAM,cAAc,OAAQ,CAAA,KAAA;AAK5B,EAAA,MAAM,QAAW,GAAA,KAAA,CAAM,QAAS,CAAA,OAAA,CAAQ,aAAa,QAAQ,CAAA;AAC7D,EAAI,IAAA,CAAC,SAAS,MAAQ,EAAA;AACpB,IAAO,OAAA,KAAA,CAAA;AAAA;AAGT,EAAA,MAAM,QAAQ,EAAC;AACf,EAAA,KAAA,MAAW,SAAS,QAAU,EAAA;AAC5B,IAAA,IAAI,CAAC,gBAAA,CAAiB,KAAO,EAAA,iBAAiB,CAAG,EAAA;AAC/C,MAAO,OAAA,KAAA,CAAA;AAAA;AAET,IAAA,MAAM,QAAS,KAAsC,CAAA,KAAA;AAErD,IAAA,KAAA,CAAM,IAAK,CAAA;AAAA,MACT,EAAA,EAAI,qBAAsB,CAAA,KAAA,CAAM,EAAE,CAAA;AAAA,MAClC,UAAU,KAAM,CAAA;AAAA,KACjB,CAAA;AAAA;AAEH,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,QAAA;AAAA,IACN,KAAA;AAAA,IACA,qBAAA,EAAuB,aAAa,qBAAyB,IAAA;AAAA,GAC/D;AACF;;;;"}

package/dist/collectLegacyRoutes.esm.js

@@ -1,9 +1,11 @@
 import { createPlugin, getComponentData } from '@backstage/core-plugin-api';
-import { PageBlueprint, createExtensionInput, coreExtensionData, createFrontendPlugin, ApiBlueprint, createExtension } from '@backstage/frontend-plugin-api';
+import { PageBlueprint, createExtensionInput, coreExtensionData, createFrontendModule, createFrontendPlugin, ApiBlueprint, createExtension } from '@backstage/frontend-plugin-api';
 import React, { Children, isValidElement } from 'react';
 import { Route, Routes } from 'react-router-dom';
 import { convertLegacyRouteRef, convertLegacyRouteRefs } from './convertLegacyRouteRef.esm.js';
 import { compatWrapper } from './compatWrapper/compatWrapper.esm.js';
+import { collectEntityPageContents } from './collectEntityPageContents.esm.js';
+import { normalizeRoutePath } from './normalizeRoutePath.esm.js';
 
 function makeRoutingShimExtension(options) {
   const { name, parentExtensionId, routePath, routeRef } = options;
@@ -67,7 +69,8 @@ function visitRouteChildren(options) {
     });
   });
 }
-function collectLegacyRoutes(flatRoutesElement) {
+function collectLegacyRoutes(flatRoutesElement, entityPage) {
+  const output = new Array();
   const pluginExtensions = /* @__PURE__ */ new Map();
   const getUniqueName = /* @__PURE__ */ (() => {
     let currentIndex = 1;
@@ -124,7 +127,7 @@ function collectLegacyRoutes(flatRoutesElement) {
           },
           factory(originalFactory, { inputs: _inputs }) {
             return originalFactory({
-              defaultPath: path[0] === "/" ? path.slice(1) : path,
+              defaultPath: normalizeRoutePath(path),
               routeRef: routeRef ? convertLegacyRouteRef(routeRef) : void 0,
               loader: async () => compatWrapper(
                 route.props.children ? /* @__PURE__ */ React.createElement(Routes, null, /* @__PURE__ */ React.createElement(Route, { path: "*", element: routeElement }, /* @__PURE__ */ React.createElement(Route, { path: "*", element: route.props.children }))) : routeElement
@@ -145,23 +148,58 @@ function collectLegacyRoutes(flatRoutesElement) {
       });
     }
   );
-  return Array.from(pluginExtensions).map(
-    ([plugin, extensions]) => createFrontendPlugin({
-      id: plugin.getId(),
-      extensions: [
-        ...extensions,
-        ...Array.from(plugin.getApis()).map(
-          (factory) => ApiBlueprint.make({
-            name: factory.api.id,
-            params: { factory }
-          })
-        )
-      ],
-      routes: convertLegacyRouteRefs(plugin.routes ?? {}),
-      externalRoutes: convertLegacyRouteRefs(plugin.externalRoutes ?? {})
-    })
-  );
+  if (entityPage) {
+    collectEntityPageContents(entityPage, {
+      discoverExtension(extension, plugin) {
+        if (!plugin || plugin.getId() === "catalog") {
+          getPluginExtensions(orphanRoutesPlugin).push(extension);
+        } else {
+          getPluginExtensions(plugin).push(extension);
+        }
+      }
+    });
+    const extensions = new Array();
+    visitRouteChildren({
+      children: entityPage,
+      parentExtensionId: `page:catalog/entity`,
+      context: {
+        pluginId: "catalog",
+        extensions,
+        getUniqueName,
+        discoverPlugin(plugin) {
+          if (plugin.getId() !== "catalog") {
+            getPluginExtensions(plugin);
+          }
+        }
+      }
+    });
+    output.push(
+      createFrontendModule({
+        pluginId: "catalog",
+        extensions
+      })
+    );
+  }
+  for (const [plugin, extensions] of pluginExtensions) {
+    output.push(
+      createFrontendPlugin({
+        id: plugin.getId(),
+        extensions: [
+          ...extensions,
+          ...Array.from(plugin.getApis()).map(
+            (factory) => ApiBlueprint.make({
+              name: factory.api.id,
+              params: { factory }
+            })
+          )
+        ],
+        routes: convertLegacyRouteRefs(plugin.routes ?? {}),
+        externalRoutes: convertLegacyRouteRefs(plugin.externalRoutes ?? {})
+      })
+    );
+  }
+  return output;
 }
 
-export { collectLegacyRoutes };
+export { collectLegacyRoutes, visitRouteChildren };
 //# sourceMappingURL=collectLegacyRoutes.esm.js.map

package/dist/collectLegacyRoutes.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"collectLegacyRoutes.esm.js","sources":["../src/collectLegacyRoutes.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 {\n  AnyRouteRefParams,\n  BackstagePlugin as LegacyBackstagePlugin,\n  RouteRef,\n  createPlugin,\n  getComponentData,\n} from '@backstage/core-plugin-api';\nimport {\n  FrontendPlugin,\n  ExtensionDefinition,\n  coreExtensionData,\n  createExtension,\n  createExtensionInput,\n  createFrontendPlugin,\n  ApiBlueprint,\n  PageBlueprint,\n} from '@backstage/frontend-plugin-api';\nimport React, { Children, ReactNode, isValidElement } from 'react';\nimport { Route, Routes } from 'react-router-dom';\nimport {\n  convertLegacyRouteRef,\n  convertLegacyRouteRefs,\n} from './convertLegacyRouteRef';\nimport { compatWrapper } from './compatWrapper';\n\n/*\n\n# Legacy interoperability\n\nUse-cases (prioritized):\n 1. Slowly migrate over an existing app to DI, piece by piece\n 2. Use a legacy plugin in a new DI app\n 3. Use DI in an existing legacy app\n\nStarting point: use-case #1\n\nPotential solutions:\n 1. Codemods (we're not considering this for now)\n 2. Legacy apps are migrated bottom-up, i.e. keep legacy root, replace pages with DI\n 3. Legacy apps are migrated top-down i.e. switch out base to DI, legacy adapter allows for usage of existing app structure\n\nChosen path: #3\n\nExisting tasks:\n  - Adopters can migrate their existing app gradually (~4)\n    - Example-app uses legacy base with DI adapters\n    - Create an API that lets you inject DI into existing apps - working assumption is that this is enough\n  - Adopters can use legacy plugins in DI through adapters (~8)\n    - App-next uses DI base with legacy adapters\n    - Create a legacy adapter that is able to take an existing extension tree\n\n*/\n\n// Creates a shim extension whose purpose is to build up the tree (anchored at\n// the root page) of paths/routeRefs so that the app can bind them properly.\nfunction makeRoutingShimExtension(options: {\n  name: string;\n  parentExtensionId: string;\n  routePath?: string;\n  routeRef?: RouteRef;\n}) {\n  const { name, parentExtensionId, routePath, routeRef } = options;\n  return createExtension({\n    kind: 'routing-shim',\n    name,\n    attachTo: { id: parentExtensionId, input: 'childRoutingShims' },\n    inputs: {\n      childRoutingShims: createExtensionInput([\n        coreExtensionData.routePath.optional(),\n        coreExtensionData.routeRef.optional(),\n      ]),\n    },\n    output: [\n      coreExtensionData.routePath.optional(),\n      coreExtensionData.routeRef.optional(),\n    ],\n    *factory() {\n      if (routePath !== undefined) {\n        yield coreExtensionData.routePath(routePath);\n      }\n\n      if (routeRef) {\n        yield coreExtensionData.routeRef(convertLegacyRouteRef(routeRef));\n      }\n    },\n  });\n}\n\nfunction visitRouteChildren(options: {\n  children: ReactNode;\n  parentExtensionId: string;\n  context: {\n    pluginId: string;\n    extensions: ExtensionDefinition[];\n    getUniqueName: () => string;\n    discoverPlugin: (plugin: LegacyBackstagePlugin) => void;\n  };\n}): void {\n  const { children, parentExtensionId, context } = options;\n  const { pluginId, extensions, getUniqueName, discoverPlugin } = context;\n\n  Children.forEach(children, node => {\n    if (!isValidElement(node)) {\n      return;\n    }\n\n    const plugin = getComponentData<LegacyBackstagePlugin>(node, 'core.plugin');\n    const routeRef = getComponentData<RouteRef<AnyRouteRefParams>>(\n      node,\n      'core.mountPoint',\n    );\n    const routePath: string | undefined = node.props?.path;\n\n    if (plugin) {\n      // We just mark the plugin as discovered, but don't change the context\n      discoverPlugin(plugin);\n    }\n\n    let nextParentExtensionId = parentExtensionId;\n    if (routeRef || routePath) {\n      const nextParentExtensionName = getUniqueName();\n      nextParentExtensionId = `routing-shim:${pluginId}/${nextParentExtensionName}`;\n      extensions.push(\n        makeRoutingShimExtension({\n          name: nextParentExtensionName,\n          parentExtensionId,\n          routePath,\n          routeRef,\n        }),\n      );\n    }\n\n    visitRouteChildren({\n      children: node.props.children,\n      parentExtensionId: nextParentExtensionId,\n      context,\n    });\n  });\n}\n\n/** @internal */\nexport function collectLegacyRoutes(\n  flatRoutesElement: JSX.Element,\n): FrontendPlugin[] {\n  const pluginExtensions = new Map<\n    LegacyBackstagePlugin,\n    ExtensionDefinition[]\n  >();\n\n  const getUniqueName = (() => {\n    let currentIndex = 1;\n    return () => String(currentIndex++);\n  })();\n\n  // Placeholder plugin for any routes that don't belong to a plugin\n  const orphanRoutesPlugin = createPlugin({ id: 'converted-orphan-routes' });\n\n  const getPluginExtensions = (plugin: LegacyBackstagePlugin) => {\n    let extensions = pluginExtensions.get(plugin);\n    if (!extensions) {\n      extensions = [];\n      pluginExtensions.set(plugin, extensions);\n    }\n    return extensions;\n  };\n\n  React.Children.forEach(\n    flatRoutesElement.props.children,\n    (route: ReactNode) => {\n      if (route === null) {\n        return;\n      }\n      // TODO(freben): Handle feature flag and permissions framework wrapper elements\n      if (!React.isValidElement(route)) {\n        throw new Error(\n          `Invalid element inside FlatRoutes, expected Route but found element of type ${typeof route}.`,\n        );\n      }\n      if (route.type !== Route) {\n        throw new Error(\n          `Invalid element inside FlatRoutes, expected Route but found ${route.type}.`,\n        );\n      }\n      const routeElement = route.props.element;\n      const path: string | undefined = route.props.path;\n      const plugin =\n        getComponentData<LegacyBackstagePlugin>(routeElement, 'core.plugin') ??\n        orphanRoutesPlugin;\n      const routeRef = getComponentData<RouteRef>(\n        routeElement,\n        'core.mountPoint',\n      );\n      if (path === undefined) {\n        throw new Error(\n          `Route element inside FlatRoutes had no path prop value given`,\n        );\n      }\n\n      const extensions = getPluginExtensions(plugin);\n      const pageExtensionName = extensions.length ? getUniqueName() : undefined;\n      const pageExtensionId = `page:${plugin.getId()}${\n        pageExtensionName ? `/${pageExtensionName}` : pageExtensionName\n      }`;\n\n      extensions.push(\n        PageBlueprint.makeWithOverrides({\n          name: pageExtensionName,\n          inputs: {\n            childRoutingShims: createExtensionInput([\n              coreExtensionData.routePath.optional(),\n              coreExtensionData.routeRef.optional(),\n            ]),\n          },\n          factory(originalFactory, { inputs: _inputs }) {\n            // todo(blam): why do we not use the inputs here?\n            return originalFactory({\n              defaultPath: path[0] === '/' ? path.slice(1) : path,\n              routeRef: routeRef ? convertLegacyRouteRef(routeRef) : undefined,\n              loader: async () =>\n                compatWrapper(\n                  route.props.children ? (\n                    <Routes>\n                      <Route path=\"*\" element={routeElement}>\n                        <Route path=\"*\" element={route.props.children} />\n                      </Route>\n                    </Routes>\n                  ) : (\n                    routeElement\n                  ),\n                ),\n            });\n          },\n        }),\n      );\n\n      visitRouteChildren({\n        children: route.props.children,\n        parentExtensionId: pageExtensionId,\n        context: {\n          pluginId: plugin.getId(),\n          extensions,\n          getUniqueName,\n          discoverPlugin: getPluginExtensions,\n        },\n      });\n    },\n  );\n\n  return Array.from(pluginExtensions).map(([plugin, extensions]) =>\n    createFrontendPlugin({\n      id: plugin.getId(),\n      extensions: [\n        ...extensions,\n        ...Array.from(plugin.getApis()).map(factory =>\n          ApiBlueprint.make({\n            name: factory.api.id,\n            params: { factory },\n          }),\n        ),\n      ],\n      routes: convertLegacyRouteRefs(plugin.routes ?? {}),\n      externalRoutes: convertLegacyRouteRefs(plugin.externalRoutes ?? {}),\n    }),\n  );\n}\n"],"names":[],"mappings":";;;;;;;AAuEA,SAAS,yBAAyB,OAK/B,EAAA;AACD,EAAA,MAAM,EAAE,IAAA,EAAM,iBAAmB,EAAA,SAAA,EAAW,UAAa,GAAA,OAAA;AACzD,EAAA,OAAO,eAAgB,CAAA;AAAA,IACrB,IAAM,EAAA,cAAA;AAAA,IACN,IAAA;AAAA,IACA,QAAU,EAAA,EAAE,EAAI,EAAA,iBAAA,EAAmB,OAAO,mBAAoB,EAAA;AAAA,IAC9D,MAAQ,EAAA;AAAA,MACN,mBAAmB,oBAAqB,CAAA;AAAA,QACtC,iBAAA,CAAkB,UAAU,QAAS,EAAA;AAAA,QACrC,iBAAA,CAAkB,SAAS,QAAS;AAAA,OACrC;AAAA,KACH;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,iBAAA,CAAkB,UAAU,QAAS,EAAA;AAAA,MACrC,iBAAA,CAAkB,SAAS,QAAS;AAAA,KACtC;AAAA,IACA,CAAC,OAAU,GAAA;AACT,MAAA,IAAI,cAAc,KAAW,CAAA,EAAA;AAC3B,QAAM,MAAA,iBAAA,CAAkB,UAAU,SAAS,CAAA;AAAA;AAG7C,MAAA,IAAI,QAAU,EAAA;AACZ,QAAA,MAAM,iBAAkB,CAAA,QAAA,CAAS,qBAAsB,CAAA,QAAQ,CAAC,CAAA;AAAA;AAClE;AACF,GACD,CAAA;AACH;AAEA,SAAS,mBAAmB,OASnB,EAAA;AACP,EAAA,MAAM,EAAE,QAAA,EAAU,iBAAmB,EAAA,OAAA,EAAY,GAAA,OAAA;AACjD,EAAA,MAAM,EAAE,QAAA,EAAU,UAAY,EAAA,aAAA,EAAe,gBAAmB,GAAA,OAAA;AAEhE,EAAS,QAAA,CAAA,OAAA,CAAQ,UAAU,CAAQ,IAAA,KAAA;AACjC,IAAI,IAAA,CAAC,cAAe,CAAA,IAAI,CAAG,EAAA;AACzB,MAAA;AAAA;AAGF,IAAM,MAAA,MAAA,GAAS,gBAAwC,CAAA,IAAA,EAAM,aAAa,CAAA;AAC1E,IAAA,MAAM,QAAW,GAAA,gBAAA;AAAA,MACf,IAAA;AAAA,MACA;AAAA,KACF;AACA,IAAM,MAAA,SAAA,GAAgC,KAAK,KAAO,EAAA,IAAA;AAElD,IAAA,IAAI,MAAQ,EAAA;AAEV,MAAA,cAAA,CAAe,MAAM,CAAA;AAAA;AAGvB,IAAA,IAAI,qBAAwB,GAAA,iBAAA;AAC5B,IAAA,IAAI,YAAY,SAAW,EAAA;AACzB,MAAA,MAAM,0BAA0B,aAAc,EAAA;AAC9C,MAAwB,qBAAA,GAAA,CAAA,aAAA,EAAgB,QAAQ,CAAA,CAAA,EAAI,uBAAuB,CAAA,CAAA;AAC3E,MAAW,UAAA,CAAA,IAAA;AAAA,QACT,wBAAyB,CAAA;AAAA,UACvB,IAAM,EAAA,uBAAA;AAAA,UACN,iBAAA;AAAA,UACA,SAAA;AAAA,UACA;AAAA,SACD;AAAA,OACH;AAAA;AAGF,IAAmB,kBAAA,CAAA;AAAA,MACjB,QAAA,EAAU,KAAK,KAAM,CAAA,QAAA;AAAA,MACrB,iBAAmB,EAAA,qBAAA;AAAA,MACnB;AAAA,KACD,CAAA;AAAA,GACF,CAAA;AACH;AAGO,SAAS,oBACd,iBACkB,EAAA;AAClB,EAAM,MAAA,gBAAA,uBAAuB,GAG3B,EAAA;AAEF,EAAA,MAAM,gCAAuB,CAAA,MAAA;AAC3B,IAAA,IAAI,YAAe,GAAA,CAAA;AACnB,IAAO,OAAA,MAAM,OAAO,YAAc,EAAA,CAAA;AAAA,GACjC,GAAA;AAGH,EAAA,MAAM,kBAAqB,GAAA,YAAA,CAAa,EAAE,EAAA,EAAI,2BAA2B,CAAA;AAEzE,EAAM,MAAA,mBAAA,GAAsB,CAAC,MAAkC,KAAA;AAC7D,IAAI,IAAA,UAAA,GAAa,gBAAiB,CAAA,GAAA,CAAI,MAAM,CAAA;AAC5C,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAA,UAAA,GAAa,EAAC;AACd,MAAiB,gBAAA,CAAA,GAAA,CAAI,QAAQ,UAAU,CAAA;AAAA;AAEzC,IAAO,OAAA,UAAA;AAAA,GACT;AAEA,EAAA,KAAA,CAAM,QAAS,CAAA,OAAA;AAAA,IACb,kBAAkB,KAAM,CAAA,QAAA;AAAA,IACxB,CAAC,KAAqB,KAAA;AACpB,MAAA,IAAI,UAAU,IAAM,EAAA;AAClB,QAAA;AAAA;AAGF,MAAA,IAAI,CAAC,KAAA,CAAM,cAAe,CAAA,KAAK,CAAG,EAAA;AAChC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,4EAAA,EAA+E,OAAO,KAAK,CAAA,CAAA;AAAA,SAC7F;AAAA;AAEF,MAAI,IAAA,KAAA,CAAM,SAAS,KAAO,EAAA;AACxB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,4DAAA,EAA+D,MAAM,IAAI,CAAA,CAAA;AAAA,SAC3E;AAAA;AAEF,MAAM,MAAA,YAAA,GAAe,MAAM,KAAM,CAAA,OAAA;AACjC,MAAM,MAAA,IAAA,GAA2B,MAAM,KAAM,CAAA,IAAA;AAC7C,MAAA,MAAM,MACJ,GAAA,gBAAA,CAAwC,YAAc,EAAA,aAAa,CACnE,IAAA,kBAAA;AACF,MAAA,MAAM,QAAW,GAAA,gBAAA;AAAA,QACf,YAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,IAAI,SAAS,KAAW,CAAA,EAAA;AACtB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,4DAAA;AAAA,SACF;AAAA;AAGF,MAAM,MAAA,UAAA,GAAa,oBAAoB,MAAM,CAAA;AAC7C,MAAA,MAAM,iBAAoB,GAAA,UAAA,CAAW,MAAS,GAAA,aAAA,EAAkB,GAAA,KAAA,CAAA;AAChE,MAAM,MAAA,eAAA,GAAkB,CAAQ,KAAA,EAAA,MAAA,CAAO,KAAM,EAAC,GAC5C,iBAAoB,GAAA,CAAA,CAAA,EAAI,iBAAiB,CAAA,CAAA,GAAK,iBAChD,CAAA,CAAA;AAEA,MAAW,UAAA,CAAA,IAAA;AAAA,QACT,cAAc,iBAAkB,CAAA;AAAA,UAC9B,IAAM,EAAA,iBAAA;AAAA,UACN,MAAQ,EAAA;AAAA,YACN,mBAAmB,oBAAqB,CAAA;AAAA,cACtC,iBAAA,CAAkB,UAAU,QAAS,EAAA;AAAA,cACrC,iBAAA,CAAkB,SAAS,QAAS;AAAA,aACrC;AAAA,WACH;AAAA,UACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAQ,SAAW,EAAA;AAE5C,YAAA,OAAO,eAAgB,CAAA;AAAA,cACrB,WAAA,EAAa,KAAK,CAAC,CAAA,KAAM,MAAM,IAAK,CAAA,KAAA,CAAM,CAAC,CAAI,GAAA,IAAA;AAAA,cAC/C,QAAU,EAAA,QAAA,GAAW,qBAAsB,CAAA,QAAQ,CAAI,GAAA,KAAA,CAAA;AAAA,cACvD,QAAQ,YACN,aAAA;AAAA,gBACE,KAAA,CAAM,MAAM,QACV,mBAAA,KAAA,CAAA,aAAA,CAAC,8BACE,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAM,MAAK,GAAI,EAAA,OAAA,EAAS,gCACtB,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAM,MAAK,GAAI,EAAA,OAAA,EAAS,MAAM,KAAM,CAAA,QAAA,EAAU,CACjD,CACF,CAEA,GAAA;AAAA;AAEJ,aACH,CAAA;AAAA;AACH,SACD;AAAA,OACH;AAEA,MAAmB,kBAAA,CAAA;AAAA,QACjB,QAAA,EAAU,MAAM,KAAM,CAAA,QAAA;AAAA,QACtB,iBAAmB,EAAA,eAAA;AAAA,QACnB,OAAS,EAAA;AAAA,UACP,QAAA,EAAU,OAAO,KAAM,EAAA;AAAA,UACvB,UAAA;AAAA,UACA,aAAA;AAAA,UACA,cAAgB,EAAA;AAAA;AAClB,OACD,CAAA;AAAA;AACH,GACF;AAEA,EAAO,OAAA,KAAA,CAAM,IAAK,CAAA,gBAAgB,CAAE,CAAA,GAAA;AAAA,IAAI,CAAC,CAAC,MAAQ,EAAA,UAAU,MAC1D,oBAAqB,CAAA;AAAA,MACnB,EAAA,EAAI,OAAO,KAAM,EAAA;AAAA,MACjB,UAAY,EAAA;AAAA,QACV,GAAG,UAAA;AAAA,QACH,GAAG,KAAM,CAAA,IAAA,CAAK,MAAO,CAAA,OAAA,EAAS,CAAE,CAAA,GAAA;AAAA,UAAI,CAAA,OAAA,KAClC,aAAa,IAAK,CAAA;AAAA,YAChB,IAAA,EAAM,QAAQ,GAAI,CAAA,EAAA;AAAA,YAClB,MAAA,EAAQ,EAAE,OAAQ;AAAA,WACnB;AAAA;AACH,OACF;AAAA,MACA,MAAQ,EAAA,sBAAA,CAAuB,MAAO,CAAA,MAAA,IAAU,EAAE,CAAA;AAAA,MAClD,cAAgB,EAAA,sBAAA,CAAuB,MAAO,CAAA,cAAA,IAAkB,EAAE;AAAA,KACnE;AAAA,GACH;AACF;;;;"}
+{"version":3,"file":"collectLegacyRoutes.esm.js","sources":["../src/collectLegacyRoutes.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 {\n  AnyRouteRefParams,\n  BackstagePlugin as LegacyBackstagePlugin,\n  RouteRef,\n  createPlugin,\n  getComponentData,\n} from '@backstage/core-plugin-api';\nimport {\n  FrontendPlugin,\n  ExtensionDefinition,\n  coreExtensionData,\n  createExtension,\n  createExtensionInput,\n  createFrontendPlugin,\n  ApiBlueprint,\n  PageBlueprint,\n  FrontendModule,\n  createFrontendModule,\n} from '@backstage/frontend-plugin-api';\nimport React, { Children, ReactNode, isValidElement } from 'react';\nimport { Route, Routes } from 'react-router-dom';\nimport {\n  convertLegacyRouteRef,\n  convertLegacyRouteRefs,\n} from './convertLegacyRouteRef';\nimport { compatWrapper } from './compatWrapper';\nimport { collectEntityPageContents } from './collectEntityPageContents';\nimport { normalizeRoutePath } from './normalizeRoutePath';\n\n/*\n\n# Legacy interoperability\n\nUse-cases (prioritized):\n 1. Slowly migrate over an existing app to DI, piece by piece\n 2. Use a legacy plugin in a new DI app\n 3. Use DI in an existing legacy app\n\nStarting point: use-case #1\n\nPotential solutions:\n 1. Codemods (we're not considering this for now)\n 2. Legacy apps are migrated bottom-up, i.e. keep legacy root, replace pages with DI\n 3. Legacy apps are migrated top-down i.e. switch out base to DI, legacy adapter allows for usage of existing app structure\n\nChosen path: #3\n\nExisting tasks:\n  - Adopters can migrate their existing app gradually (~4)\n    - Example-app uses legacy base with DI adapters\n    - Create an API that lets you inject DI into existing apps - working assumption is that this is enough\n  - Adopters can use legacy plugins in DI through adapters (~8)\n    - App-next uses DI base with legacy adapters\n    - Create a legacy adapter that is able to take an existing extension tree\n\n*/\n\n// Creates a shim extension whose purpose is to build up the tree (anchored at\n// the root page) of paths/routeRefs so that the app can bind them properly.\nfunction makeRoutingShimExtension(options: {\n  name: string;\n  parentExtensionId: string;\n  routePath?: string;\n  routeRef?: RouteRef;\n}) {\n  const { name, parentExtensionId, routePath, routeRef } = options;\n  return createExtension({\n    kind: 'routing-shim',\n    name,\n    attachTo: { id: parentExtensionId, input: 'childRoutingShims' },\n    inputs: {\n      childRoutingShims: createExtensionInput([\n        coreExtensionData.routePath.optional(),\n        coreExtensionData.routeRef.optional(),\n      ]),\n    },\n    output: [\n      coreExtensionData.routePath.optional(),\n      coreExtensionData.routeRef.optional(),\n    ],\n    *factory() {\n      if (routePath !== undefined) {\n        yield coreExtensionData.routePath(routePath);\n      }\n\n      if (routeRef) {\n        yield coreExtensionData.routeRef(convertLegacyRouteRef(routeRef));\n      }\n    },\n  });\n}\n\nexport function visitRouteChildren(options: {\n  children: ReactNode;\n  parentExtensionId: string;\n  context: {\n    pluginId: string;\n    extensions: ExtensionDefinition[];\n    getUniqueName: () => string;\n    discoverPlugin: (plugin: LegacyBackstagePlugin) => void;\n  };\n}): void {\n  const { children, parentExtensionId, context } = options;\n  const { pluginId, extensions, getUniqueName, discoverPlugin } = context;\n\n  Children.forEach(children, node => {\n    if (!isValidElement(node)) {\n      return;\n    }\n\n    const plugin = getComponentData<LegacyBackstagePlugin>(node, 'core.plugin');\n    const routeRef = getComponentData<RouteRef<AnyRouteRefParams>>(\n      node,\n      'core.mountPoint',\n    );\n    const routePath: string | undefined = node.props?.path;\n\n    if (plugin) {\n      // We just mark the plugin as discovered, but don't change the context\n      discoverPlugin(plugin);\n    }\n\n    let nextParentExtensionId = parentExtensionId;\n    if (routeRef || routePath) {\n      const nextParentExtensionName = getUniqueName();\n      nextParentExtensionId = `routing-shim:${pluginId}/${nextParentExtensionName}`;\n      extensions.push(\n        makeRoutingShimExtension({\n          name: nextParentExtensionName,\n          parentExtensionId,\n          routePath,\n          routeRef,\n        }),\n      );\n    }\n\n    visitRouteChildren({\n      children: node.props.children,\n      parentExtensionId: nextParentExtensionId,\n      context,\n    });\n  });\n}\n\n/** @internal */\nexport function collectLegacyRoutes(\n  flatRoutesElement: JSX.Element,\n  entityPage?: JSX.Element,\n): (FrontendPlugin | FrontendModule)[] {\n  const output = new Array<FrontendPlugin | FrontendModule>();\n\n  const pluginExtensions = new Map<\n    LegacyBackstagePlugin,\n    ExtensionDefinition[]\n  >();\n\n  const getUniqueName = (() => {\n    let currentIndex = 1;\n    return () => String(currentIndex++);\n  })();\n\n  // Placeholder plugin for any routes that don't belong to a plugin\n  const orphanRoutesPlugin = createPlugin({ id: 'converted-orphan-routes' });\n\n  const getPluginExtensions = (plugin: LegacyBackstagePlugin) => {\n    let extensions = pluginExtensions.get(plugin);\n    if (!extensions) {\n      extensions = [];\n      pluginExtensions.set(plugin, extensions);\n    }\n    return extensions;\n  };\n\n  React.Children.forEach(\n    flatRoutesElement.props.children,\n    (route: ReactNode) => {\n      if (route === null) {\n        return;\n      }\n      // TODO(freben): Handle feature flag and permissions framework wrapper elements\n      if (!React.isValidElement(route)) {\n        throw new Error(\n          `Invalid element inside FlatRoutes, expected Route but found element of type ${typeof route}.`,\n        );\n      }\n      if (route.type !== Route) {\n        throw new Error(\n          `Invalid element inside FlatRoutes, expected Route but found ${route.type}.`,\n        );\n      }\n      const routeElement = route.props.element;\n      const path: string | undefined = route.props.path;\n      const plugin =\n        getComponentData<LegacyBackstagePlugin>(routeElement, 'core.plugin') ??\n        orphanRoutesPlugin;\n      const routeRef = getComponentData<RouteRef>(\n        routeElement,\n        'core.mountPoint',\n      );\n      if (path === undefined) {\n        throw new Error(\n          `Route element inside FlatRoutes had no path prop value given`,\n        );\n      }\n\n      const extensions = getPluginExtensions(plugin);\n      const pageExtensionName = extensions.length ? getUniqueName() : undefined;\n      const pageExtensionId = `page:${plugin.getId()}${\n        pageExtensionName ? `/${pageExtensionName}` : pageExtensionName\n      }`;\n\n      extensions.push(\n        PageBlueprint.makeWithOverrides({\n          name: pageExtensionName,\n          inputs: {\n            childRoutingShims: createExtensionInput([\n              coreExtensionData.routePath.optional(),\n              coreExtensionData.routeRef.optional(),\n            ]),\n          },\n          factory(originalFactory, { inputs: _inputs }) {\n            // todo(blam): why do we not use the inputs here?\n            return originalFactory({\n              defaultPath: normalizeRoutePath(path),\n              routeRef: routeRef ? convertLegacyRouteRef(routeRef) : undefined,\n              loader: async () =>\n                compatWrapper(\n                  route.props.children ? (\n                    <Routes>\n                      <Route path=\"*\" element={routeElement}>\n                        <Route path=\"*\" element={route.props.children} />\n                      </Route>\n                    </Routes>\n                  ) : (\n                    routeElement\n                  ),\n                ),\n            });\n          },\n        }),\n      );\n\n      visitRouteChildren({\n        children: route.props.children,\n        parentExtensionId: pageExtensionId,\n        context: {\n          pluginId: plugin.getId(),\n          extensions,\n          getUniqueName,\n          discoverPlugin: getPluginExtensions,\n        },\n      });\n    },\n  );\n\n  if (entityPage) {\n    collectEntityPageContents(entityPage, {\n      discoverExtension(extension, plugin) {\n        if (!plugin || plugin.getId() === 'catalog') {\n          getPluginExtensions(orphanRoutesPlugin).push(extension);\n        } else {\n          getPluginExtensions(plugin).push(extension);\n        }\n      },\n    });\n\n    const extensions = new Array<ExtensionDefinition>();\n    visitRouteChildren({\n      children: entityPage,\n      parentExtensionId: `page:catalog/entity`,\n      context: {\n        pluginId: 'catalog',\n        extensions,\n        getUniqueName,\n        discoverPlugin(plugin) {\n          if (plugin.getId() !== 'catalog') {\n            getPluginExtensions(plugin);\n          }\n        },\n      },\n    });\n\n    output.push(\n      createFrontendModule({\n        pluginId: 'catalog',\n        extensions,\n      }),\n    );\n  }\n\n  for (const [plugin, extensions] of pluginExtensions) {\n    output.push(\n      createFrontendPlugin({\n        id: plugin.getId(),\n        extensions: [\n          ...extensions,\n          ...Array.from(plugin.getApis()).map(factory =>\n            ApiBlueprint.make({\n              name: factory.api.id,\n              params: { factory },\n            }),\n          ),\n        ],\n        routes: convertLegacyRouteRefs(plugin.routes ?? {}),\n        externalRoutes: convertLegacyRouteRefs(plugin.externalRoutes ?? {}),\n      }),\n    );\n  }\n\n  return output;\n}\n"],"names":[],"mappings":";;;;;;;;;AA2EA,SAAS,yBAAyB,OAK/B,EAAA;AACD,EAAA,MAAM,EAAE,IAAA,EAAM,iBAAmB,EAAA,SAAA,EAAW,UAAa,GAAA,OAAA;AACzD,EAAA,OAAO,eAAgB,CAAA;AAAA,IACrB,IAAM,EAAA,cAAA;AAAA,IACN,IAAA;AAAA,IACA,QAAU,EAAA,EAAE,EAAI,EAAA,iBAAA,EAAmB,OAAO,mBAAoB,EAAA;AAAA,IAC9D,MAAQ,EAAA;AAAA,MACN,mBAAmB,oBAAqB,CAAA;AAAA,QACtC,iBAAA,CAAkB,UAAU,QAAS,EAAA;AAAA,QACrC,iBAAA,CAAkB,SAAS,QAAS;AAAA,OACrC;AAAA,KACH;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,iBAAA,CAAkB,UAAU,QAAS,EAAA;AAAA,MACrC,iBAAA,CAAkB,SAAS,QAAS;AAAA,KACtC;AAAA,IACA,CAAC,OAAU,GAAA;AACT,MAAA,IAAI,cAAc,KAAW,CAAA,EAAA;AAC3B,QAAM,MAAA,iBAAA,CAAkB,UAAU,SAAS,CAAA;AAAA;AAG7C,MAAA,IAAI,QAAU,EAAA;AACZ,QAAA,MAAM,iBAAkB,CAAA,QAAA,CAAS,qBAAsB,CAAA,QAAQ,CAAC,CAAA;AAAA;AAClE;AACF,GACD,CAAA;AACH;AAEO,SAAS,mBAAmB,OAS1B,EAAA;AACP,EAAA,MAAM,EAAE,QAAA,EAAU,iBAAmB,EAAA,OAAA,EAAY,GAAA,OAAA;AACjD,EAAA,MAAM,EAAE,QAAA,EAAU,UAAY,EAAA,aAAA,EAAe,gBAAmB,GAAA,OAAA;AAEhE,EAAS,QAAA,CAAA,OAAA,CAAQ,UAAU,CAAQ,IAAA,KAAA;AACjC,IAAI,IAAA,CAAC,cAAe,CAAA,IAAI,CAAG,EAAA;AACzB,MAAA;AAAA;AAGF,IAAM,MAAA,MAAA,GAAS,gBAAwC,CAAA,IAAA,EAAM,aAAa,CAAA;AAC1E,IAAA,MAAM,QAAW,GAAA,gBAAA;AAAA,MACf,IAAA;AAAA,MACA;AAAA,KACF;AACA,IAAM,MAAA,SAAA,GAAgC,KAAK,KAAO,EAAA,IAAA;AAElD,IAAA,IAAI,MAAQ,EAAA;AAEV,MAAA,cAAA,CAAe,MAAM,CAAA;AAAA;AAGvB,IAAA,IAAI,qBAAwB,GAAA,iBAAA;AAC5B,IAAA,IAAI,YAAY,SAAW,EAAA;AACzB,MAAA,MAAM,0BAA0B,aAAc,EAAA;AAC9C,MAAwB,qBAAA,GAAA,CAAA,aAAA,EAAgB,QAAQ,CAAA,CAAA,EAAI,uBAAuB,CAAA,CAAA;AAC3E,MAAW,UAAA,CAAA,IAAA;AAAA,QACT,wBAAyB,CAAA;AAAA,UACvB,IAAM,EAAA,uBAAA;AAAA,UACN,iBAAA;AAAA,UACA,SAAA;AAAA,UACA;AAAA,SACD;AAAA,OACH;AAAA;AAGF,IAAmB,kBAAA,CAAA;AAAA,MACjB,QAAA,EAAU,KAAK,KAAM,CAAA,QAAA;AAAA,MACrB,iBAAmB,EAAA,qBAAA;AAAA,MACnB;AAAA,KACD,CAAA;AAAA,GACF,CAAA;AACH;AAGgB,SAAA,mBAAA,CACd,mBACA,UACqC,EAAA;AACrC,EAAM,MAAA,MAAA,GAAS,IAAI,KAAuC,EAAA;AAE1D,EAAM,MAAA,gBAAA,uBAAuB,GAG3B,EAAA;AAEF,EAAA,MAAM,gCAAuB,CAAA,MAAA;AAC3B,IAAA,IAAI,YAAe,GAAA,CAAA;AACnB,IAAO,OAAA,MAAM,OAAO,YAAc,EAAA,CAAA;AAAA,GACjC,GAAA;AAGH,EAAA,MAAM,kBAAqB,GAAA,YAAA,CAAa,EAAE,EAAA,EAAI,2BAA2B,CAAA;AAEzE,EAAM,MAAA,mBAAA,GAAsB,CAAC,MAAkC,KAAA;AAC7D,IAAI,IAAA,UAAA,GAAa,gBAAiB,CAAA,GAAA,CAAI,MAAM,CAAA;AAC5C,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAA,UAAA,GAAa,EAAC;AACd,MAAiB,gBAAA,CAAA,GAAA,CAAI,QAAQ,UAAU,CAAA;AAAA;AAEzC,IAAO,OAAA,UAAA;AAAA,GACT;AAEA,EAAA,KAAA,CAAM,QAAS,CAAA,OAAA;AAAA,IACb,kBAAkB,KAAM,CAAA,QAAA;AAAA,IACxB,CAAC,KAAqB,KAAA;AACpB,MAAA,IAAI,UAAU,IAAM,EAAA;AAClB,QAAA;AAAA;AAGF,MAAA,IAAI,CAAC,KAAA,CAAM,cAAe,CAAA,KAAK,CAAG,EAAA;AAChC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,4EAAA,EAA+E,OAAO,KAAK,CAAA,CAAA;AAAA,SAC7F;AAAA;AAEF,MAAI,IAAA,KAAA,CAAM,SAAS,KAAO,EAAA;AACxB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,4DAAA,EAA+D,MAAM,IAAI,CAAA,CAAA;AAAA,SAC3E;AAAA;AAEF,MAAM,MAAA,YAAA,GAAe,MAAM,KAAM,CAAA,OAAA;AACjC,MAAM,MAAA,IAAA,GAA2B,MAAM,KAAM,CAAA,IAAA;AAC7C,MAAA,MAAM,MACJ,GAAA,gBAAA,CAAwC,YAAc,EAAA,aAAa,CACnE,IAAA,kBAAA;AACF,MAAA,MAAM,QAAW,GAAA,gBAAA;AAAA,QACf,YAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,IAAI,SAAS,KAAW,CAAA,EAAA;AACtB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,4DAAA;AAAA,SACF;AAAA;AAGF,MAAM,MAAA,UAAA,GAAa,oBAAoB,MAAM,CAAA;AAC7C,MAAA,MAAM,iBAAoB,GAAA,UAAA,CAAW,MAAS,GAAA,aAAA,EAAkB,GAAA,KAAA,CAAA;AAChE,MAAM,MAAA,eAAA,GAAkB,CAAQ,KAAA,EAAA,MAAA,CAAO,KAAM,EAAC,GAC5C,iBAAoB,GAAA,CAAA,CAAA,EAAI,iBAAiB,CAAA,CAAA,GAAK,iBAChD,CAAA,CAAA;AAEA,MAAW,UAAA,CAAA,IAAA;AAAA,QACT,cAAc,iBAAkB,CAAA;AAAA,UAC9B,IAAM,EAAA,iBAAA;AAAA,UACN,MAAQ,EAAA;AAAA,YACN,mBAAmB,oBAAqB,CAAA;AAAA,cACtC,iBAAA,CAAkB,UAAU,QAAS,EAAA;AAAA,cACrC,iBAAA,CAAkB,SAAS,QAAS;AAAA,aACrC;AAAA,WACH;AAAA,UACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAQ,SAAW,EAAA;AAE5C,YAAA,OAAO,eAAgB,CAAA;AAAA,cACrB,WAAA,EAAa,mBAAmB,IAAI,CAAA;AAAA,cACpC,QAAU,EAAA,QAAA,GAAW,qBAAsB,CAAA,QAAQ,CAAI,GAAA,KAAA,CAAA;AAAA,cACvD,QAAQ,YACN,aAAA;AAAA,gBACE,KAAA,CAAM,MAAM,QACV,mBAAA,KAAA,CAAA,aAAA,CAAC,8BACE,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAM,MAAK,GAAI,EAAA,OAAA,EAAS,gCACtB,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAM,MAAK,GAAI,EAAA,OAAA,EAAS,MAAM,KAAM,CAAA,QAAA,EAAU,CACjD,CACF,CAEA,GAAA;AAAA;AAEJ,aACH,CAAA;AAAA;AACH,SACD;AAAA,OACH;AAEA,MAAmB,kBAAA,CAAA;AAAA,QACjB,QAAA,EAAU,MAAM,KAAM,CAAA,QAAA;AAAA,QACtB,iBAAmB,EAAA,eAAA;AAAA,QACnB,OAAS,EAAA;AAAA,UACP,QAAA,EAAU,OAAO,KAAM,EAAA;AAAA,UACvB,UAAA;AAAA,UACA,aAAA;AAAA,UACA,cAAgB,EAAA;AAAA;AAClB,OACD,CAAA;AAAA;AACH,GACF;AAEA,EAAA,IAAI,UAAY,EAAA;AACd,IAAA,yBAAA,CAA0B,UAAY,EAAA;AAAA,MACpC,iBAAA,CAAkB,WAAW,MAAQ,EAAA;AACnC,QAAA,IAAI,CAAC,MAAA,IAAU,MAAO,CAAA,KAAA,OAAY,SAAW,EAAA;AAC3C,UAAoB,mBAAA,CAAA,kBAAkB,CAAE,CAAA,IAAA,CAAK,SAAS,CAAA;AAAA,SACjD,MAAA;AACL,UAAoB,mBAAA,CAAA,MAAM,CAAE,CAAA,IAAA,CAAK,SAAS,CAAA;AAAA;AAC5C;AACF,KACD,CAAA;AAED,IAAM,MAAA,UAAA,GAAa,IAAI,KAA2B,EAAA;AAClD,IAAmB,kBAAA,CAAA;AAAA,MACjB,QAAU,EAAA,UAAA;AAAA,MACV,iBAAmB,EAAA,CAAA,mBAAA,CAAA;AAAA,MACnB,OAAS,EAAA;AAAA,QACP,QAAU,EAAA,SAAA;AAAA,QACV,UAAA;AAAA,QACA,aAAA;AAAA,QACA,eAAe,MAAQ,EAAA;AACrB,UAAI,IAAA,MAAA,CAAO,KAAM,EAAA,KAAM,SAAW,EAAA;AAChC,YAAA,mBAAA,CAAoB,MAAM,CAAA;AAAA;AAC5B;AACF;AACF,KACD,CAAA;AAED,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,oBAAqB,CAAA;AAAA,QACnB,QAAU,EAAA,SAAA;AAAA,QACV;AAAA,OACD;AAAA,KACH;AAAA;AAGF,EAAA,KAAA,MAAW,CAAC,MAAA,EAAQ,UAAU,CAAA,IAAK,gBAAkB,EAAA;AACnD,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,oBAAqB,CAAA;AAAA,QACnB,EAAA,EAAI,OAAO,KAAM,EAAA;AAAA,QACjB,UAAY,EAAA;AAAA,UACV,GAAG,UAAA;AAAA,UACH,GAAG,KAAM,CAAA,IAAA,CAAK,MAAO,CAAA,OAAA,EAAS,CAAE,CAAA,GAAA;AAAA,YAAI,CAAA,OAAA,KAClC,aAAa,IAAK,CAAA;AAAA,cAChB,IAAA,EAAM,QAAQ,GAAI,CAAA,EAAA;AAAA,cAClB,MAAA,EAAQ,EAAE,OAAQ;AAAA,aACnB;AAAA;AACH,SACF;AAAA,QACA,MAAQ,EAAA,sBAAA,CAAuB,MAAO,CAAA,MAAA,IAAU,EAAE,CAAA;AAAA,QAClD,cAAgB,EAAA,sBAAA,CAAuB,MAAO,CAAA,cAAA,IAAkB,EAAE;AAAA,OACnE;AAAA,KACH;AAAA;AAGF,EAAO,OAAA,MAAA;AACT;;;;"}

package/dist/convertLegacyApp.esm.js

@@ -18,9 +18,9 @@ function selectChildren(rootNode, selector, strictError) {
     return selectChildren(node.props.children, selector);
   });
 }
-function convertLegacyApp(rootElement) {
+function convertLegacyApp(rootElement, options = {}) {
   if (getComponentData(rootElement, "core.type") === "FlatRoutes") {
-    return collectLegacyRoutes(rootElement);
+    return collectLegacyRoutes(rootElement, options?.entityPage);
   }
   const appRouterEls = selectChildren(
     rootElement,
@@ -84,7 +84,7 @@ function convertLegacyApp(rootElement) {
     factory: () => [],
     disabled: true
   });
-  const collectedRoutes = collectLegacyRoutes(routesEl);
+  const collectedRoutes = collectLegacyRoutes(routesEl, options?.entityPage);
   return [
     ...collectedRoutes,
     createFrontendModule({

package/dist/convertLegacyApp.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"convertLegacyApp.esm.js","sources":["../src/convertLegacyApp.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 React, {\n  Children,\n  Fragment,\n  ReactElement,\n  ReactNode,\n  isValidElement,\n} from 'react';\nimport {\n  FrontendModule,\n  FrontendPlugin,\n  coreExtensionData,\n  createExtension,\n  ExtensionOverrides,\n  createExtensionInput,\n  createFrontendModule,\n} from '@backstage/frontend-plugin-api';\nimport { getComponentData } from '@backstage/core-plugin-api';\nimport { collectLegacyRoutes } from './collectLegacyRoutes';\nimport { compatWrapper } from './compatWrapper';\n\nfunction selectChildren(\n  rootNode: ReactNode,\n  selector?: (element: ReactElement<{ children?: ReactNode }>) => boolean,\n  strictError?: string,\n): Array<ReactElement<{ children?: ReactNode }>> {\n  return Children.toArray(rootNode).flatMap(node => {\n    if (!isValidElement<{ children?: ReactNode }>(node)) {\n      return [];\n    }\n\n    if (node.type === Fragment) {\n      return selectChildren(node.props.children, selector, strictError);\n    }\n\n    if (selector === undefined || selector(node)) {\n      return [node];\n    }\n\n    if (strictError) {\n      throw new Error(strictError);\n    }\n\n    return selectChildren(node.props.children, selector, strictError);\n  });\n}\n\n/** @public */\nexport function convertLegacyApp(\n  rootElement: React.JSX.Element,\n): (FrontendPlugin | FrontendModule | ExtensionOverrides)[] {\n  if (getComponentData(rootElement, 'core.type') === 'FlatRoutes') {\n    return collectLegacyRoutes(rootElement);\n  }\n\n  const appRouterEls = selectChildren(\n    rootElement,\n    el => getComponentData(el, 'core.type') === 'AppRouter',\n  );\n  if (appRouterEls.length !== 1) {\n    throw new Error(\n      \"Failed to convert legacy app, AppRouter element could not been found. Make sure it's at the top level of the App element tree\",\n    );\n  }\n\n  const rootEls = selectChildren(\n    appRouterEls[0].props.children,\n    el =>\n      Boolean(el.props.children) &&\n      selectChildren(\n        el.props.children,\n        innerEl => getComponentData(innerEl, 'core.type') === 'FlatRoutes',\n      ).length === 1,\n  );\n  if (rootEls.length !== 1) {\n    throw new Error(\n      \"Failed to convert legacy app, Root element containing FlatRoutes could not been found. Make sure it's within the AppRouter element of the App element tree\",\n    );\n  }\n  const [rootEl] = rootEls;\n\n  const routesEls = selectChildren(\n    rootEls[0].props.children,\n    el => getComponentData(el, 'core.type') === 'FlatRoutes',\n  );\n  if (routesEls.length !== 1) {\n    throw new Error(\n      'Unexpectedly failed to find FlatRoutes in app element tree',\n    );\n  }\n  const [routesEl] = routesEls;\n\n  const CoreLayoutOverride = createExtension({\n    name: 'layout',\n    attachTo: { id: 'app/root', input: 'children' },\n    inputs: {\n      content: createExtensionInput([coreExtensionData.reactElement], {\n        singleton: true,\n      }),\n    },\n    output: [coreExtensionData.reactElement],\n    factory({ inputs }) {\n      // Clone the root element, this replaces the FlatRoutes declared in the app with out content input\n      return [\n        coreExtensionData.reactElement(\n          compatWrapper(\n            React.cloneElement(\n              rootEl,\n              undefined,\n              inputs.content.get(coreExtensionData.reactElement),\n            ),\n          ),\n        ),\n      ];\n    },\n  });\n  const CoreNavOverride = createExtension({\n    name: 'nav',\n    attachTo: { id: 'app/layout', input: 'nav' },\n    output: [],\n    factory: () => [],\n    disabled: true,\n  });\n\n  const collectedRoutes = collectLegacyRoutes(routesEl);\n\n  return [\n    ...collectedRoutes,\n    createFrontendModule({\n      pluginId: 'app',\n      extensions: [CoreLayoutOverride, CoreNavOverride],\n    }),\n  ];\n}\n"],"names":[],"mappings":";;;;;;AAoCA,SAAS,cAAA,CACP,QACA,EAAA,QAAA,EACA,WAC+C,EAAA;AAC/C,EAAA,OAAO,QAAS,CAAA,OAAA,CAAQ,QAAQ,CAAA,CAAE,QAAQ,CAAQ,IAAA,KAAA;AAChD,IAAI,IAAA,CAAC,cAAyC,CAAA,IAAI,CAAG,EAAA;AACnD,MAAA,OAAO,EAAC;AAAA;AAGV,IAAI,IAAA,IAAA,CAAK,SAAS,QAAU,EAAA;AAC1B,MAAA,OAAO,cAAe,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,EAAU,QAAqB,CAAA;AAAA;AAGlE,IAAA,IAAI,QAAa,KAAA,KAAA,CAAA,IAAa,QAAS,CAAA,IAAI,CAAG,EAAA;AAC5C,MAAA,OAAO,CAAC,IAAI,CAAA;AAAA;AAOd,IAAA,OAAO,cAAe,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,EAAU,QAAqB,CAAA;AAAA,GACjE,CAAA;AACH;AAGO,SAAS,iBACd,WAC0D,EAAA;AAC1D,EAAA,IAAI,gBAAiB,CAAA,WAAA,EAAa,WAAW,CAAA,KAAM,YAAc,EAAA;AAC/D,IAAA,OAAO,oBAAoB,WAAW,CAAA;AAAA;AAGxC,EAAA,MAAM,YAAe,GAAA,cAAA;AAAA,IACnB,WAAA;AAAA,IACA,CAAM,EAAA,KAAA,gBAAA,CAAiB,EAAI,EAAA,WAAW,CAAM,KAAA;AAAA,GAC9C;AACA,EAAI,IAAA,YAAA,CAAa,WAAW,CAAG,EAAA;AAC7B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AAGF,EAAA,MAAM,OAAU,GAAA,cAAA;AAAA,IACd,YAAA,CAAa,CAAC,CAAA,CAAE,KAAM,CAAA,QAAA;AAAA,IACtB,CACE,EAAA,KAAA,OAAA,CAAQ,EAAG,CAAA,KAAA,CAAM,QAAQ,CACzB,IAAA,cAAA;AAAA,MACE,GAAG,KAAM,CAAA,QAAA;AAAA,MACT,CAAW,OAAA,KAAA,gBAAA,CAAiB,OAAS,EAAA,WAAW,CAAM,KAAA;AAAA,MACtD,MAAW,KAAA;AAAA,GACjB;AACA,EAAI,IAAA,OAAA,CAAQ,WAAW,CAAG,EAAA;AACxB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AAEF,EAAM,MAAA,CAAC,MAAM,CAAI,GAAA,OAAA;AAEjB,EAAA,MAAM,SAAY,GAAA,cAAA;AAAA,IAChB,OAAA,CAAQ,CAAC,CAAA,CAAE,KAAM,CAAA,QAAA;AAAA,IACjB,CAAM,EAAA,KAAA,gBAAA,CAAiB,EAAI,EAAA,WAAW,CAAM,KAAA;AAAA,GAC9C;AACA,EAAI,IAAA,SAAA,CAAU,WAAW,CAAG,EAAA;AAC1B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AAEF,EAAM,MAAA,CAAC,QAAQ,CAAI,GAAA,SAAA;AAEnB,EAAA,MAAM,qBAAqB,eAAgB,CAAA;AAAA,IACzC,IAAM,EAAA,QAAA;AAAA,IACN,QAAU,EAAA,EAAE,EAAI,EAAA,UAAA,EAAY,OAAO,UAAW,EAAA;AAAA,IAC9C,MAAQ,EAAA;AAAA,MACN,OAAS,EAAA,oBAAA,CAAqB,CAAC,iBAAA,CAAkB,YAAY,CAAG,EAAA;AAAA,QAC9D,SAAW,EAAA;AAAA,OACZ;AAAA,KACH;AAAA,IACA,MAAA,EAAQ,CAAC,iBAAA,CAAkB,YAAY,CAAA;AAAA,IACvC,OAAA,CAAQ,EAAE,MAAA,EAAU,EAAA;AAElB,MAAO,OAAA;AAAA,QACL,iBAAkB,CAAA,YAAA;AAAA,UAChB,aAAA;AAAA,YACE,KAAM,CAAA,YAAA;AAAA,cACJ,MAAA;AAAA,cACA,KAAA,CAAA;AAAA,cACA,MAAO,CAAA,OAAA,CAAQ,GAAI,CAAA,iBAAA,CAAkB,YAAY;AAAA;AACnD;AACF;AACF,OACF;AAAA;AACF,GACD,CAAA;AACD,EAAA,MAAM,kBAAkB,eAAgB,CAAA;AAAA,IACtC,IAAM,EAAA,KAAA;AAAA,IACN,QAAU,EAAA,EAAE,EAAI,EAAA,YAAA,EAAc,OAAO,KAAM,EAAA;AAAA,IAC3C,QAAQ,EAAC;AAAA,IACT,OAAA,EAAS,MAAM,EAAC;AAAA,IAChB,QAAU,EAAA;AAAA,GACX,CAAA;AAED,EAAM,MAAA,eAAA,GAAkB,oBAAoB,QAAQ,CAAA;AAEpD,EAAO,OAAA;AAAA,IACL,GAAG,eAAA;AAAA,IACH,oBAAqB,CAAA;AAAA,MACnB,QAAU,EAAA,KAAA;AAAA,MACV,UAAA,EAAY,CAAC,kBAAA,EAAoB,eAAe;AAAA,KACjD;AAAA,GACH;AACF;;;;"}
+{"version":3,"file":"convertLegacyApp.esm.js","sources":["../src/convertLegacyApp.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 React, {\n  Children,\n  Fragment,\n  ReactElement,\n  ReactNode,\n  isValidElement,\n} from 'react';\nimport {\n  FrontendModule,\n  FrontendPlugin,\n  coreExtensionData,\n  createExtension,\n  createExtensionInput,\n  createFrontendModule,\n} from '@backstage/frontend-plugin-api';\nimport { getComponentData } from '@backstage/core-plugin-api';\nimport { collectLegacyRoutes } from './collectLegacyRoutes';\nimport { compatWrapper } from './compatWrapper';\n\nfunction selectChildren(\n  rootNode: ReactNode,\n  selector?: (element: ReactElement<{ children?: ReactNode }>) => boolean,\n  strictError?: string,\n): Array<ReactElement<{ children?: ReactNode }>> {\n  return Children.toArray(rootNode).flatMap(node => {\n    if (!isValidElement<{ children?: ReactNode }>(node)) {\n      return [];\n    }\n\n    if (node.type === Fragment) {\n      return selectChildren(node.props.children, selector, strictError);\n    }\n\n    if (selector === undefined || selector(node)) {\n      return [node];\n    }\n\n    if (strictError) {\n      throw new Error(strictError);\n    }\n\n    return selectChildren(node.props.children, selector, strictError);\n  });\n}\n\n/** @public */\nexport interface ConvertLegacyAppOptions {\n  /**\n   * By providing an entity page element here it will be split up and converted\n   * into individual extensions for the catalog plugin in the new frontend\n   * system.\n   *\n   * In order to use this option the entity page and other catalog extensions\n   * must be removed from the legacy app, and the catalog plugin for the new\n   * frontend system must be installed instead.\n   *\n   * In order for this conversion to work the entity page must be a plain React\n   * element tree without any component wrapping anywhere between the root\n   * element and the `EntityLayout.Route` elements.\n   *\n   * When enabling this conversion you are likely to encounter duplicate entity\n   * page content provided both via the old structure and the new plugins. Any\n   * duplicate content needs to be removed from the old structure.\n   */\n  entityPage?: React.JSX.Element;\n}\n\n/** @public */\nexport function convertLegacyApp(\n  rootElement: React.JSX.Element,\n  options: ConvertLegacyAppOptions = {},\n): (FrontendPlugin | FrontendModule)[] {\n  if (getComponentData(rootElement, 'core.type') === 'FlatRoutes') {\n    return collectLegacyRoutes(rootElement, options?.entityPage);\n  }\n\n  const appRouterEls = selectChildren(\n    rootElement,\n    el => getComponentData(el, 'core.type') === 'AppRouter',\n  );\n  if (appRouterEls.length !== 1) {\n    throw new Error(\n      \"Failed to convert legacy app, AppRouter element could not been found. Make sure it's at the top level of the App element tree\",\n    );\n  }\n\n  const rootEls = selectChildren(\n    appRouterEls[0].props.children,\n    el =>\n      Boolean(el.props.children) &&\n      selectChildren(\n        el.props.children,\n        innerEl => getComponentData(innerEl, 'core.type') === 'FlatRoutes',\n      ).length === 1,\n  );\n  if (rootEls.length !== 1) {\n    throw new Error(\n      \"Failed to convert legacy app, Root element containing FlatRoutes could not been found. Make sure it's within the AppRouter element of the App element tree\",\n    );\n  }\n  const [rootEl] = rootEls;\n\n  const routesEls = selectChildren(\n    rootEls[0].props.children,\n    el => getComponentData(el, 'core.type') === 'FlatRoutes',\n  );\n  if (routesEls.length !== 1) {\n    throw new Error(\n      'Unexpectedly failed to find FlatRoutes in app element tree',\n    );\n  }\n  const [routesEl] = routesEls;\n\n  const CoreLayoutOverride = createExtension({\n    name: 'layout',\n    attachTo: { id: 'app/root', input: 'children' },\n    inputs: {\n      content: createExtensionInput([coreExtensionData.reactElement], {\n        singleton: true,\n      }),\n    },\n    output: [coreExtensionData.reactElement],\n    factory({ inputs }) {\n      // Clone the root element, this replaces the FlatRoutes declared in the app with out content input\n      return [\n        coreExtensionData.reactElement(\n          compatWrapper(\n            React.cloneElement(\n              rootEl,\n              undefined,\n              inputs.content.get(coreExtensionData.reactElement),\n            ),\n          ),\n        ),\n      ];\n    },\n  });\n  const CoreNavOverride = createExtension({\n    name: 'nav',\n    attachTo: { id: 'app/layout', input: 'nav' },\n    output: [],\n    factory: () => [],\n    disabled: true,\n  });\n\n  const collectedRoutes = collectLegacyRoutes(routesEl, options?.entityPage);\n\n  return [\n    ...collectedRoutes,\n    createFrontendModule({\n      pluginId: 'app',\n      extensions: [CoreLayoutOverride, CoreNavOverride],\n    }),\n  ];\n}\n"],"names":[],"mappings":";;;;;;AAmCA,SAAS,cAAA,CACP,QACA,EAAA,QAAA,EACA,WAC+C,EAAA;AAC/C,EAAA,OAAO,QAAS,CAAA,OAAA,CAAQ,QAAQ,CAAA,CAAE,QAAQ,CAAQ,IAAA,KAAA;AAChD,IAAI,IAAA,CAAC,cAAyC,CAAA,IAAI,CAAG,EAAA;AACnD,MAAA,OAAO,EAAC;AAAA;AAGV,IAAI,IAAA,IAAA,CAAK,SAAS,QAAU,EAAA;AAC1B,MAAA,OAAO,cAAe,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,EAAU,QAAqB,CAAA;AAAA;AAGlE,IAAA,IAAI,QAAa,KAAA,KAAA,CAAA,IAAa,QAAS,CAAA,IAAI,CAAG,EAAA;AAC5C,MAAA,OAAO,CAAC,IAAI,CAAA;AAAA;AAOd,IAAA,OAAO,cAAe,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,EAAU,QAAqB,CAAA;AAAA,GACjE,CAAA;AACH;AAyBO,SAAS,gBACd,CAAA,WAAA,EACA,OAAmC,GAAA,EACE,EAAA;AACrC,EAAA,IAAI,gBAAiB,CAAA,WAAA,EAAa,WAAW,CAAA,KAAM,YAAc,EAAA;AAC/D,IAAO,OAAA,mBAAA,CAAoB,WAAa,EAAA,OAAA,EAAS,UAAU,CAAA;AAAA;AAG7D,EAAA,MAAM,YAAe,GAAA,cAAA;AAAA,IACnB,WAAA;AAAA,IACA,CAAM,EAAA,KAAA,gBAAA,CAAiB,EAAI,EAAA,WAAW,CAAM,KAAA;AAAA,GAC9C;AACA,EAAI,IAAA,YAAA,CAAa,WAAW,CAAG,EAAA;AAC7B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AAGF,EAAA,MAAM,OAAU,GAAA,cAAA;AAAA,IACd,YAAA,CAAa,CAAC,CAAA,CAAE,KAAM,CAAA,QAAA;AAAA,IACtB,CACE,EAAA,KAAA,OAAA,CAAQ,EAAG,CAAA,KAAA,CAAM,QAAQ,CACzB,IAAA,cAAA;AAAA,MACE,GAAG,KAAM,CAAA,QAAA;AAAA,MACT,CAAW,OAAA,KAAA,gBAAA,CAAiB,OAAS,EAAA,WAAW,CAAM,KAAA;AAAA,MACtD,MAAW,KAAA;AAAA,GACjB;AACA,EAAI,IAAA,OAAA,CAAQ,WAAW,CAAG,EAAA;AACxB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AAEF,EAAM,MAAA,CAAC,MAAM,CAAI,GAAA,OAAA;AAEjB,EAAA,MAAM,SAAY,GAAA,cAAA;AAAA,IAChB,OAAA,CAAQ,CAAC,CAAA,CAAE,KAAM,CAAA,QAAA;AAAA,IACjB,CAAM,EAAA,KAAA,gBAAA,CAAiB,EAAI,EAAA,WAAW,CAAM,KAAA;AAAA,GAC9C;AACA,EAAI,IAAA,SAAA,CAAU,WAAW,CAAG,EAAA;AAC1B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA;AAEF,EAAM,MAAA,CAAC,QAAQ,CAAI,GAAA,SAAA;AAEnB,EAAA,MAAM,qBAAqB,eAAgB,CAAA;AAAA,IACzC,IAAM,EAAA,QAAA;AAAA,IACN,QAAU,EAAA,EAAE,EAAI,EAAA,UAAA,EAAY,OAAO,UAAW,EAAA;AAAA,IAC9C,MAAQ,EAAA;AAAA,MACN,OAAS,EAAA,oBAAA,CAAqB,CAAC,iBAAA,CAAkB,YAAY,CAAG,EAAA;AAAA,QAC9D,SAAW,EAAA;AAAA,OACZ;AAAA,KACH;AAAA,IACA,MAAA,EAAQ,CAAC,iBAAA,CAAkB,YAAY,CAAA;AAAA,IACvC,OAAA,CAAQ,EAAE,MAAA,EAAU,EAAA;AAElB,MAAO,OAAA;AAAA,QACL,iBAAkB,CAAA,YAAA;AAAA,UAChB,aAAA;AAAA,YACE,KAAM,CAAA,YAAA;AAAA,cACJ,MAAA;AAAA,cACA,KAAA,CAAA;AAAA,cACA,MAAO,CAAA,OAAA,CAAQ,GAAI,CAAA,iBAAA,CAAkB,YAAY;AAAA;AACnD;AACF;AACF,OACF;AAAA;AACF,GACD,CAAA;AACD,EAAA,MAAM,kBAAkB,eAAgB,CAAA;AAAA,IACtC,IAAM,EAAA,KAAA;AAAA,IACN,QAAU,EAAA,EAAE,EAAI,EAAA,YAAA,EAAc,OAAO,KAAM,EAAA;AAAA,IAC3C,QAAQ,EAAC;AAAA,IACT,OAAA,EAAS,MAAM,EAAC;AAAA,IAChB,QAAU,EAAA;AAAA,GACX,CAAA;AAED,EAAA,MAAM,eAAkB,GAAA,mBAAA,CAAoB,QAAU,EAAA,OAAA,EAAS,UAAU,CAAA;AAEzE,EAAO,OAAA;AAAA,IACL,GAAG,eAAA;AAAA,IACH,oBAAqB,CAAA;AAAA,MACnB,QAAU,EAAA,KAAA;AAAA,MACV,UAAA,EAAY,CAAC,kBAAA,EAAoB,eAAe;AAAA,KACjD;AAAA,GACH;AACF;;;;"}

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import React, { ReactNode, ComponentType } from 'react';
 import { AnalyticsApi, AnalyticsEvent, AnyApiFactory, IconComponent, BackstagePlugin, AppComponents, AppTheme, FeatureFlag, RouteRef, SubRouteRef, ExternalRouteRef, AnyRouteRefParams } from '@backstage/core-plugin-api';
-import { AnalyticsApi as AnalyticsApi$1, AnalyticsEvent as AnalyticsEvent$1, FrontendPlugin, FrontendModule, ExtensionOverrides, ExtensionDefinition, RouteRef as RouteRef$1, SubRouteRef as SubRouteRef$1, ExternalRouteRef as ExternalRouteRef$1 } from '@backstage/frontend-plugin-api';
+import { AnalyticsApi as AnalyticsApi$1, AnalyticsEvent as AnalyticsEvent$1, FrontendPlugin, FrontendModule, ExtensionDefinition, RouteRef as RouteRef$1, SubRouteRef as SubRouteRef$1, ExternalRouteRef as ExternalRouteRef$1 } from '@backstage/frontend-plugin-api';
 
 /**
  * Wraps a React element in a bidirectional compatibility provider, allow APIs
@@ -64,7 +64,28 @@ declare class NoOpAnalyticsApi implements AnalyticsApi, AnalyticsApi$1 {
 }
 
 /** @public */
-declare function convertLegacyApp(rootElement: React.JSX.Element): (FrontendPlugin | FrontendModule | ExtensionOverrides)[];
+interface ConvertLegacyAppOptions {
+    /**
+     * By providing an entity page element here it will be split up and converted
+     * into individual extensions for the catalog plugin in the new frontend
+     * system.
+     *
+     * In order to use this option the entity page and other catalog extensions
+     * must be removed from the legacy app, and the catalog plugin for the new
+     * frontend system must be installed instead.
+     *
+     * In order for this conversion to work the entity page must be a plain React
+     * element tree without any component wrapping anywhere between the root
+     * element and the `EntityLayout.Route` elements.
+     *
+     * When enabling this conversion you are likely to encounter duplicate entity
+     * page content provided both via the old structure and the new plugins. Any
+     * duplicate content needs to be removed from the old structure.
+     */
+    entityPage?: React.JSX.Element;
+}
+/** @public */
+declare function convertLegacyApp(rootElement: React.JSX.Element, options?: ConvertLegacyAppOptions): (FrontendPlugin | FrontendModule)[];
 
 /**
  * @public
@@ -163,4 +184,4 @@ declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: S
  */
 declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: ExternalRouteRef$1<TParams>): ExternalRouteRef<TParams, true>;
 
-export { MultipleAnalyticsApi, NoOpAnalyticsApi, type ToNewRouteRef, compatWrapper, convertLegacyApp, convertLegacyAppOptions, convertLegacyPageExtension, convertLegacyPlugin, convertLegacyRouteRef, convertLegacyRouteRefs };
+export { type ConvertLegacyAppOptions, MultipleAnalyticsApi, NoOpAnalyticsApi, type ToNewRouteRef, compatWrapper, convertLegacyApp, convertLegacyAppOptions, convertLegacyPageExtension, convertLegacyPlugin, convertLegacyRouteRef, convertLegacyRouteRefs };

package/dist/normalizeRoutePath.esm.js

@@ -0,0 +1,16 @@
+function normalizeRoutePath(path) {
+  let normalized = path;
+  while (normalized.endsWith("/") || normalized.endsWith("*")) {
+    normalized = normalized.slice(0, -1);
+  }
+  while (normalized.startsWith("/")) {
+    normalized = normalized.slice(1);
+  }
+  if (!normalized) {
+    return "/";
+  }
+  return `/${normalized}`;
+}
+
+export { normalizeRoutePath };
+//# sourceMappingURL=normalizeRoutePath.esm.js.map

package/dist/normalizeRoutePath.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalizeRoutePath.esm.js","sources":["../src/normalizeRoutePath.ts"],"sourcesContent":["/*\n * Copyright 2025 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\n/**\n * Normalizes the path to make sure it always starts with a single '/' and do not end with '/' or '*' unless empty\n */\nexport function normalizeRoutePath(path: string) {\n  let normalized = path;\n  while (normalized.endsWith('/') || normalized.endsWith('*')) {\n    normalized = normalized.slice(0, -1);\n  }\n  while (normalized.startsWith('/')) {\n    normalized = normalized.slice(1);\n  }\n  if (!normalized) {\n    return '/';\n  }\n  return `/${normalized}`;\n}\n"],"names":[],"mappings":"AAmBO,SAAS,mBAAmB,IAAc,EAAA;AAC/C,EAAA,IAAI,UAAa,GAAA,IAAA;AACjB,EAAA,OAAO,WAAW,QAAS,CAAA,GAAG,KAAK,UAAW,CAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AAC3D,IAAa,UAAA,GAAA,UAAA,CAAW,KAAM,CAAA,CAAA,EAAG,CAAE,CAAA,CAAA;AAAA;AAErC,EAAO,OAAA,UAAA,CAAW,UAAW,CAAA,GAAG,CAAG,EAAA;AACjC,IAAa,UAAA,GAAA,UAAA,CAAW,MAAM,CAAC,CAAA;AAAA;AAEjC,EAAA,IAAI,CAAC,UAAY,EAAA;AACf,IAAO,OAAA,GAAA;AAAA;AAET,EAAA,OAAO,IAAI,UAAU,CAAA,CAAA;AACvB;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/core-compat-api",
-  "version": "0.3.7-next.1",
+  "version": "0.4.0",
   "backstage": {
     "role": "web-library"
   },
@@ -31,21 +31,22 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-plugin-api": "1.10.4",
-    "@backstage/frontend-plugin-api": "0.9.6-next.1",
-    "@backstage/version-bridge": "1.0.11",
+    "@backstage/core-plugin-api": "^1.10.5",
+    "@backstage/frontend-plugin-api": "^0.10.0",
+    "@backstage/plugin-catalog-react": "^1.16.0",
+    "@backstage/version-bridge": "^1.0.11",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@backstage-community/plugin-puppetdb": "^0.1.18",
     "@backstage-community/plugin-stackstorm": "^0.1.16",
-    "@backstage/cli": "0.30.1-next.0",
-    "@backstage/core-app-api": "1.15.5",
-    "@backstage/frontend-app-api": "0.10.6-next.1",
-    "@backstage/frontend-test-utils": "0.2.7-next.1",
-    "@backstage/plugin-catalog": "1.28.0-next.1",
-    "@backstage/test-utils": "1.7.5",
-    "@backstage/types": "1.2.1",
+    "@backstage/cli": "^0.31.0",
+    "@backstage/core-app-api": "^1.16.0",
+    "@backstage/frontend-app-api": "^0.11.0",
+    "@backstage/frontend-test-utils": "^0.3.0",
+    "@backstage/plugin-catalog": "^1.28.0",
+    "@backstage/test-utils": "^1.7.6",
+    "@backstage/types": "^1.2.1",
     "@oriflame/backstage-plugin-score-card": "^0.9.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
@@ -66,12 +67,5 @@
       "optional": true
     }
   },
-  "typesVersions": {
-    "*": {
-      "index": [
-        "dist/index.d.ts"
-      ]
-    }
-  },
   "module": "./dist/index.esm.js"
 }