@backstage/core-compat-api 0.2.8-next.1 → 0.2.8-next.3

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @backstage/core-compat-api
 
+## 0.2.8-next.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.7.0-next.3
+  - @backstage/core-plugin-api@1.9.3
+  - @backstage/version-bridge@1.0.8
+
+## 0.2.8-next.2
+
+### Patch Changes
+
+- 72754db: Updated usage of `useRouteRef`, which can now always return `undefined`.
+- 16cf96c: Both `compatWrapper` and `convertLegacyRouteRef` now support converting from the new system to the old.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.7.0-next.2
+  - @backstage/core-plugin-api@1.9.3
+  - @backstage/version-bridge@1.0.8
+
 ## 0.2.8-next.1
 
 ### Patch Changes

package/dist/compatWrapper/BackwardsCompatProvider.esm.js

@@ -128,5 +128,5 @@ function BackwardsCompatProvider(props) {
   return /* @__PURE__ */ React.createElement(LegacyRoutingProvider, null, /* @__PURE__ */ React.createElement(LegacyAppContextProvider, null, props.children));
 }
 
-export { BackwardsCompatProvider };
+export { BackwardsCompatProvider, toLegacyPlugin };
 //# sourceMappingURL=BackwardsCompatProvider.esm.js.map

package/dist/compatWrapper/BackwardsCompatProvider.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackwardsCompatProvider.esm.js","sources":["../../src/compatWrapper/BackwardsCompatProvider.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, { useMemo } from 'react';\nimport { ReactNode } from 'react';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { AppContextProvider } from '../../../core-app-api/src/app/AppContext';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { RouteResolver } from '../../../core-plugin-api/src/routing/useRouteRef';\nimport {\n  createPlugin as createNewPlugin,\n  BackstagePlugin as NewBackstagePlugin,\n  appTreeApiRef,\n  componentsApiRef,\n  coreComponentRefs,\n  iconsApiRef,\n  useApi,\n  routeResolutionApiRef,\n} from '@backstage/frontend-plugin-api';\nimport {\n  AppComponents,\n  IconComponent,\n  BackstagePlugin as LegacyBackstagePlugin,\n  RouteRef,\n} from '@backstage/core-plugin-api';\nimport {\n  VersionedValue,\n  createVersionedContext,\n  createVersionedValueMap,\n  getOrCreateGlobalSingleton,\n} from '@backstage/version-bridge';\nimport { convertLegacyRouteRef } from '../convertLegacyRouteRef';\n\n// Make sure that we only convert each new plugin instance to its legacy equivalent once\nconst legacyPluginStore = getOrCreateGlobalSingleton(\n  'legacy-plugin-compatibility-store',\n  () => new WeakMap<NewBackstagePlugin, LegacyBackstagePlugin>(),\n);\n\nfunction toLegacyPlugin(plugin: NewBackstagePlugin): LegacyBackstagePlugin {\n  let legacy = legacyPluginStore.get(plugin);\n  if (legacy) {\n    return legacy;\n  }\n\n  const errorMsg = 'Not implemented in legacy plugin compatibility layer';\n  const notImplemented = () => {\n    throw new Error(errorMsg);\n  };\n\n  legacy = {\n    getId(): string {\n      return plugin.id;\n    },\n    get routes() {\n      return {};\n    },\n    get externalRoutes() {\n      return {};\n    },\n    getApis: notImplemented,\n    getFeatureFlags: notImplemented,\n    provide: notImplemented,\n  };\n\n  legacyPluginStore.set(plugin, legacy);\n  return legacy;\n}\n\n// TODO: Currently a very naive implementation, may need some more work\nfunction toNewPlugin(plugin: LegacyBackstagePlugin): NewBackstagePlugin {\n  return createNewPlugin({\n    id: plugin.getId(),\n  });\n}\n\n// Recreates the old AppContext APIs using the various new APIs that replaced it\nfunction LegacyAppContextProvider(props: { children: ReactNode }) {\n  const appTreeApi = useApi(appTreeApiRef);\n  const componentsApi = useApi(componentsApiRef);\n  const iconsApi = useApi(iconsApiRef);\n\n  const appContext = useMemo(() => {\n    const { tree } = appTreeApi.getTree();\n\n    let gatheredPlugins: LegacyBackstagePlugin[] | undefined = undefined;\n\n    const ErrorBoundaryFallback = componentsApi.getComponent(\n      coreComponentRefs.errorBoundaryFallback,\n    );\n    const ErrorBoundaryFallbackWrapper: AppComponents['ErrorBoundaryFallback'] =\n      ({ plugin, ...rest }) => (\n        <ErrorBoundaryFallback\n          {...rest}\n          plugin={plugin && toNewPlugin(plugin)}\n        />\n      );\n\n    return {\n      getPlugins(): LegacyBackstagePlugin[] {\n        if (gatheredPlugins) {\n          return gatheredPlugins;\n        }\n\n        const pluginSet = new Set<LegacyBackstagePlugin>();\n        for (const node of tree.nodes.values()) {\n          const plugin = node.spec.source;\n          if (plugin) {\n            pluginSet.add(toLegacyPlugin(plugin));\n          }\n        }\n        gatheredPlugins = Array.from(pluginSet);\n\n        return gatheredPlugins;\n      },\n\n      getSystemIcon(key: string): IconComponent | undefined {\n        return iconsApi.getIcon(key);\n      },\n\n      getSystemIcons(): Record<string, IconComponent> {\n        return Object.fromEntries(\n          iconsApi.listIconKeys().map(key => [key, iconsApi.getIcon(key)!]),\n        );\n      },\n\n      getComponents(): AppComponents {\n        return {\n          NotFoundErrorPage: componentsApi.getComponent(\n            coreComponentRefs.notFoundErrorPage,\n          ),\n          BootErrorPage() {\n            throw new Error(\n              'The BootErrorPage app component should not be accessed by plugins',\n            );\n          },\n          Progress: componentsApi.getComponent(coreComponentRefs.progress),\n          Router() {\n            throw new Error(\n              'The Router app component should not be accessed by plugins',\n            );\n          },\n          ErrorBoundaryFallback: ErrorBoundaryFallbackWrapper,\n        };\n      },\n    };\n  }, [appTreeApi, componentsApi, iconsApi]);\n\n  return (\n    <AppContextProvider appContext={appContext}>\n      {props.children}\n    </AppContextProvider>\n  );\n}\n\nconst RoutingContext = createVersionedContext<{ 1: RouteResolver }>(\n  'routing-context',\n);\n\nfunction LegacyRoutingProvider(props: { children: ReactNode }) {\n  const routeResolutionApi = useApi(routeResolutionApiRef);\n\n  const value = useMemo<VersionedValue<{ 1: RouteResolver }>>(() => {\n    return createVersionedValueMap({\n      1: {\n        resolve(anyRouteRef, location) {\n          const sourcePath =\n            typeof location === 'string' ? location : location.pathname ?? '';\n\n          return routeResolutionApi.resolve(\n            // This removes the requirement to use convertLegacyRouteRef inside plugins, but\n            // they still need to converted when passed to the plugin instance\n            convertLegacyRouteRef(anyRouteRef as RouteRef),\n            { sourcePath },\n          );\n        },\n      },\n    });\n  }, [routeResolutionApi]);\n\n  return (\n    <RoutingContext.Provider value={value}>\n      {props.children}\n    </RoutingContext.Provider>\n  );\n}\n\nexport function BackwardsCompatProvider(props: { children: ReactNode }) {\n  return (\n    <LegacyRoutingProvider>\n      <LegacyAppContextProvider>{props.children}</LegacyAppContextProvider>\n    </LegacyRoutingProvider>\n  );\n}\n"],"names":["createNewPlugin"],"mappings":";;;;;;AA+CA,MAAM,iBAAoB,GAAA,0BAAA;AAAA,EACxB,mCAAA;AAAA,EACA,0BAAU,OAAmD,EAAA;AAC/D,CAAA,CAAA;AAEA,SAAS,eAAe,MAAmD,EAAA;AACzE,EAAI,IAAA,MAAA,GAAS,iBAAkB,CAAA,GAAA,CAAI,MAAM,CAAA,CAAA;AACzC,EAAA,IAAI,MAAQ,EAAA;AACV,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAEA,EAAA,MAAM,QAAW,GAAA,sDAAA,CAAA;AACjB,EAAA,MAAM,iBAAiB,MAAM;AAC3B,IAAM,MAAA,IAAI,MAAM,QAAQ,CAAA,CAAA;AAAA,GAC1B,CAAA;AAEA,EAAS,MAAA,GAAA;AAAA,IACP,KAAgB,GAAA;AACd,MAAA,OAAO,MAAO,CAAA,EAAA,CAAA;AAAA,KAChB;AAAA,IACA,IAAI,MAAS,GAAA;AACX,MAAA,OAAO,EAAC,CAAA;AAAA,KACV;AAAA,IACA,IAAI,cAAiB,GAAA;AACnB,MAAA,OAAO,EAAC,CAAA;AAAA,KACV;AAAA,IACA,OAAS,EAAA,cAAA;AAAA,IACT,eAAiB,EAAA,cAAA;AAAA,IACjB,OAAS,EAAA,cAAA;AAAA,GACX,CAAA;AAEA,EAAkB,iBAAA,CAAA,GAAA,CAAI,QAAQ,MAAM,CAAA,CAAA;AACpC,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AAGA,SAAS,YAAY,MAAmD,EAAA;AACtE,EAAA,OAAOA,YAAgB,CAAA;AAAA,IACrB,EAAA,EAAI,OAAO,KAAM,EAAA;AAAA,GAClB,CAAA,CAAA;AACH,CAAA;AAGA,SAAS,yBAAyB,KAAgC,EAAA;AAChE,EAAM,MAAA,UAAA,GAAa,OAAO,aAAa,CAAA,CAAA;AACvC,EAAM,MAAA,aAAA,GAAgB,OAAO,gBAAgB,CAAA,CAAA;AAC7C,EAAM,MAAA,QAAA,GAAW,OAAO,WAAW,CAAA,CAAA;AAEnC,EAAM,MAAA,UAAA,GAAa,QAAQ,MAAM;AAC/B,IAAA,MAAM,EAAE,IAAA,EAAS,GAAA,UAAA,CAAW,OAAQ,EAAA,CAAA;AAEpC,IAAA,IAAI,eAAuD,GAAA,KAAA,CAAA,CAAA;AAE3D,IAAA,MAAM,wBAAwB,aAAc,CAAA,YAAA;AAAA,MAC1C,iBAAkB,CAAA,qBAAA;AAAA,KACpB,CAAA;AACA,IAAA,MAAM,+BACJ,CAAC,EAAE,MAAQ,EAAA,GAAG,MACZ,qBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,qBAAA;AAAA,MAAA;AAAA,QACE,GAAG,IAAA;AAAA,QACJ,MAAA,EAAQ,MAAU,IAAA,WAAA,CAAY,MAAM,CAAA;AAAA,OAAA;AAAA,KACtC,CAAA;AAGJ,IAAO,OAAA;AAAA,MACL,UAAsC,GAAA;AACpC,QAAA,IAAI,eAAiB,EAAA;AACnB,UAAO,OAAA,eAAA,CAAA;AAAA,SACT;AAEA,QAAM,MAAA,SAAA,uBAAgB,GAA2B,EAAA,CAAA;AACjD,QAAA,KAAA,MAAW,IAAQ,IAAA,IAAA,CAAK,KAAM,CAAA,MAAA,EAAU,EAAA;AACtC,UAAM,MAAA,MAAA,GAAS,KAAK,IAAK,CAAA,MAAA,CAAA;AACzB,UAAA,IAAI,MAAQ,EAAA;AACV,YAAU,SAAA,CAAA,GAAA,CAAI,cAAe,CAAA,MAAM,CAAC,CAAA,CAAA;AAAA,WACtC;AAAA,SACF;AACA,QAAkB,eAAA,GAAA,KAAA,CAAM,KAAK,SAAS,CAAA,CAAA;AAEtC,QAAO,OAAA,eAAA,CAAA;AAAA,OACT;AAAA,MAEA,cAAc,GAAwC,EAAA;AACpD,QAAO,OAAA,QAAA,CAAS,QAAQ,GAAG,CAAA,CAAA;AAAA,OAC7B;AAAA,MAEA,cAAgD,GAAA;AAC9C,QAAA,OAAO,MAAO,CAAA,WAAA;AAAA,UACZ,QAAA,CAAS,YAAa,EAAA,CAAE,GAAI,CAAA,CAAA,GAAA,KAAO,CAAC,GAAA,EAAK,QAAS,CAAA,OAAA,CAAQ,GAAG,CAAE,CAAC,CAAA;AAAA,SAClE,CAAA;AAAA,OACF;AAAA,MAEA,aAA+B,GAAA;AAC7B,QAAO,OAAA;AAAA,UACL,mBAAmB,aAAc,CAAA,YAAA;AAAA,YAC/B,iBAAkB,CAAA,iBAAA;AAAA,WACpB;AAAA,UACA,aAAgB,GAAA;AACd,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,mEAAA;AAAA,aACF,CAAA;AAAA,WACF;AAAA,UACA,QAAU,EAAA,aAAA,CAAc,YAAa,CAAA,iBAAA,CAAkB,QAAQ,CAAA;AAAA,UAC/D,MAAS,GAAA;AACP,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,4DAAA;AAAA,aACF,CAAA;AAAA,WACF;AAAA,UACA,qBAAuB,EAAA,4BAAA;AAAA,SACzB,CAAA;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACC,EAAA,CAAC,UAAY,EAAA,aAAA,EAAe,QAAQ,CAAC,CAAA,CAAA;AAExC,EAAA,uBACG,KAAA,CAAA,aAAA,CAAA,kBAAA,EAAA,EAAmB,UACjB,EAAA,EAAA,KAAA,CAAM,QACT,CAAA,CAAA;AAEJ,CAAA;AAEA,MAAM,cAAiB,GAAA,sBAAA;AAAA,EACrB,iBAAA;AACF,CAAA,CAAA;AAEA,SAAS,sBAAsB,KAAgC,EAAA;AAC7D,EAAM,MAAA,kBAAA,GAAqB,OAAO,qBAAqB,CAAA,CAAA;AAEvD,EAAM,MAAA,KAAA,GAAQ,QAA8C,MAAM;AAChE,IAAA,OAAO,uBAAwB,CAAA;AAAA,MAC7B,CAAG,EAAA;AAAA,QACD,OAAA,CAAQ,aAAa,QAAU,EAAA;AAC7B,UAAA,MAAM,aACJ,OAAO,QAAA,KAAa,QAAW,GAAA,QAAA,GAAW,SAAS,QAAY,IAAA,EAAA,CAAA;AAEjE,UAAA,OAAO,kBAAmB,CAAA,OAAA;AAAA;AAAA;AAAA,YAGxB,sBAAsB,WAAuB,CAAA;AAAA,YAC7C,EAAE,UAAW,EAAA;AAAA,WACf,CAAA;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH,EAAG,CAAC,kBAAkB,CAAC,CAAA,CAAA;AAEvB,EAAA,2CACG,cAAe,CAAA,QAAA,EAAf,EAAwB,KAAA,EAAA,EACtB,MAAM,QACT,CAAA,CAAA;AAEJ,CAAA;AAEO,SAAS,wBAAwB,KAAgC,EAAA;AACtE,EAAA,2CACG,qBACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,wBAA0B,EAAA,IAAA,EAAA,KAAA,CAAM,QAAS,CAC5C,CAAA,CAAA;AAEJ;;;;"}
+{"version":3,"file":"BackwardsCompatProvider.esm.js","sources":["../../src/compatWrapper/BackwardsCompatProvider.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, { useMemo } from 'react';\nimport { ReactNode } from 'react';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { AppContextProvider } from '../../../core-app-api/src/app/AppContext';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { RouteResolver } from '../../../core-plugin-api/src/routing/useRouteRef';\nimport {\n  createPlugin as createNewPlugin,\n  BackstagePlugin as NewBackstagePlugin,\n  appTreeApiRef,\n  componentsApiRef,\n  coreComponentRefs,\n  iconsApiRef,\n  useApi,\n  routeResolutionApiRef,\n} from '@backstage/frontend-plugin-api';\nimport {\n  AppComponents,\n  IconComponent,\n  BackstagePlugin as LegacyBackstagePlugin,\n  RouteRef,\n} from '@backstage/core-plugin-api';\nimport {\n  VersionedValue,\n  createVersionedContext,\n  createVersionedValueMap,\n  getOrCreateGlobalSingleton,\n} from '@backstage/version-bridge';\nimport { convertLegacyRouteRef } from '../convertLegacyRouteRef';\n\n// Make sure that we only convert each new plugin instance to its legacy equivalent once\nconst legacyPluginStore = getOrCreateGlobalSingleton(\n  'legacy-plugin-compatibility-store',\n  () => new WeakMap<NewBackstagePlugin, LegacyBackstagePlugin>(),\n);\n\nexport function toLegacyPlugin(\n  plugin: NewBackstagePlugin,\n): LegacyBackstagePlugin {\n  let legacy = legacyPluginStore.get(plugin);\n  if (legacy) {\n    return legacy;\n  }\n\n  const errorMsg = 'Not implemented in legacy plugin compatibility layer';\n  const notImplemented = () => {\n    throw new Error(errorMsg);\n  };\n\n  legacy = {\n    getId(): string {\n      return plugin.id;\n    },\n    get routes() {\n      return {};\n    },\n    get externalRoutes() {\n      return {};\n    },\n    getApis: notImplemented,\n    getFeatureFlags: notImplemented,\n    provide: notImplemented,\n  };\n\n  legacyPluginStore.set(plugin, legacy);\n  return legacy;\n}\n\n// TODO: Currently a very naive implementation, may need some more work\nfunction toNewPlugin(plugin: LegacyBackstagePlugin): NewBackstagePlugin {\n  return createNewPlugin({\n    id: plugin.getId(),\n  });\n}\n\n// Recreates the old AppContext APIs using the various new APIs that replaced it\nfunction LegacyAppContextProvider(props: { children: ReactNode }) {\n  const appTreeApi = useApi(appTreeApiRef);\n  const componentsApi = useApi(componentsApiRef);\n  const iconsApi = useApi(iconsApiRef);\n\n  const appContext = useMemo(() => {\n    const { tree } = appTreeApi.getTree();\n\n    let gatheredPlugins: LegacyBackstagePlugin[] | undefined = undefined;\n\n    const ErrorBoundaryFallback = componentsApi.getComponent(\n      coreComponentRefs.errorBoundaryFallback,\n    );\n    const ErrorBoundaryFallbackWrapper: AppComponents['ErrorBoundaryFallback'] =\n      ({ plugin, ...rest }) => (\n        <ErrorBoundaryFallback\n          {...rest}\n          plugin={plugin && toNewPlugin(plugin)}\n        />\n      );\n\n    return {\n      getPlugins(): LegacyBackstagePlugin[] {\n        if (gatheredPlugins) {\n          return gatheredPlugins;\n        }\n\n        const pluginSet = new Set<LegacyBackstagePlugin>();\n        for (const node of tree.nodes.values()) {\n          const plugin = node.spec.source;\n          if (plugin) {\n            pluginSet.add(toLegacyPlugin(plugin));\n          }\n        }\n        gatheredPlugins = Array.from(pluginSet);\n\n        return gatheredPlugins;\n      },\n\n      getSystemIcon(key: string): IconComponent | undefined {\n        return iconsApi.getIcon(key);\n      },\n\n      getSystemIcons(): Record<string, IconComponent> {\n        return Object.fromEntries(\n          iconsApi.listIconKeys().map(key => [key, iconsApi.getIcon(key)!]),\n        );\n      },\n\n      getComponents(): AppComponents {\n        return {\n          NotFoundErrorPage: componentsApi.getComponent(\n            coreComponentRefs.notFoundErrorPage,\n          ),\n          BootErrorPage() {\n            throw new Error(\n              'The BootErrorPage app component should not be accessed by plugins',\n            );\n          },\n          Progress: componentsApi.getComponent(coreComponentRefs.progress),\n          Router() {\n            throw new Error(\n              'The Router app component should not be accessed by plugins',\n            );\n          },\n          ErrorBoundaryFallback: ErrorBoundaryFallbackWrapper,\n        };\n      },\n    };\n  }, [appTreeApi, componentsApi, iconsApi]);\n\n  return (\n    <AppContextProvider appContext={appContext}>\n      {props.children}\n    </AppContextProvider>\n  );\n}\n\nconst RoutingContext = createVersionedContext<{ 1: RouteResolver }>(\n  'routing-context',\n);\n\nfunction LegacyRoutingProvider(props: { children: ReactNode }) {\n  const routeResolutionApi = useApi(routeResolutionApiRef);\n\n  const value = useMemo<VersionedValue<{ 1: RouteResolver }>>(() => {\n    return createVersionedValueMap({\n      1: {\n        resolve(anyRouteRef, location) {\n          const sourcePath =\n            typeof location === 'string' ? location : location.pathname ?? '';\n\n          return routeResolutionApi.resolve(\n            // This removes the requirement to use convertLegacyRouteRef inside plugins, but\n            // they still need to converted when passed to the plugin instance\n            convertLegacyRouteRef(anyRouteRef as RouteRef),\n            { sourcePath },\n          );\n        },\n      },\n    });\n  }, [routeResolutionApi]);\n\n  return (\n    <RoutingContext.Provider value={value}>\n      {props.children}\n    </RoutingContext.Provider>\n  );\n}\n\nexport function BackwardsCompatProvider(props: { children: ReactNode }) {\n  return (\n    <LegacyRoutingProvider>\n      <LegacyAppContextProvider>{props.children}</LegacyAppContextProvider>\n    </LegacyRoutingProvider>\n  );\n}\n"],"names":["createNewPlugin"],"mappings":";;;;;;AA+CA,MAAM,iBAAoB,GAAA,0BAAA;AAAA,EACxB,mCAAA;AAAA,EACA,0BAAU,OAAmD,EAAA;AAC/D,CAAA,CAAA;AAEO,SAAS,eACd,MACuB,EAAA;AACvB,EAAI,IAAA,MAAA,GAAS,iBAAkB,CAAA,GAAA,CAAI,MAAM,CAAA,CAAA;AACzC,EAAA,IAAI,MAAQ,EAAA;AACV,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAEA,EAAA,MAAM,QAAW,GAAA,sDAAA,CAAA;AACjB,EAAA,MAAM,iBAAiB,MAAM;AAC3B,IAAM,MAAA,IAAI,MAAM,QAAQ,CAAA,CAAA;AAAA,GAC1B,CAAA;AAEA,EAAS,MAAA,GAAA;AAAA,IACP,KAAgB,GAAA;AACd,MAAA,OAAO,MAAO,CAAA,EAAA,CAAA;AAAA,KAChB;AAAA,IACA,IAAI,MAAS,GAAA;AACX,MAAA,OAAO,EAAC,CAAA;AAAA,KACV;AAAA,IACA,IAAI,cAAiB,GAAA;AACnB,MAAA,OAAO,EAAC,CAAA;AAAA,KACV;AAAA,IACA,OAAS,EAAA,cAAA;AAAA,IACT,eAAiB,EAAA,cAAA;AAAA,IACjB,OAAS,EAAA,cAAA;AAAA,GACX,CAAA;AAEA,EAAkB,iBAAA,CAAA,GAAA,CAAI,QAAQ,MAAM,CAAA,CAAA;AACpC,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AAGA,SAAS,YAAY,MAAmD,EAAA;AACtE,EAAA,OAAOA,YAAgB,CAAA;AAAA,IACrB,EAAA,EAAI,OAAO,KAAM,EAAA;AAAA,GAClB,CAAA,CAAA;AACH,CAAA;AAGA,SAAS,yBAAyB,KAAgC,EAAA;AAChE,EAAM,MAAA,UAAA,GAAa,OAAO,aAAa,CAAA,CAAA;AACvC,EAAM,MAAA,aAAA,GAAgB,OAAO,gBAAgB,CAAA,CAAA;AAC7C,EAAM,MAAA,QAAA,GAAW,OAAO,WAAW,CAAA,CAAA;AAEnC,EAAM,MAAA,UAAA,GAAa,QAAQ,MAAM;AAC/B,IAAA,MAAM,EAAE,IAAA,EAAS,GAAA,UAAA,CAAW,OAAQ,EAAA,CAAA;AAEpC,IAAA,IAAI,eAAuD,GAAA,KAAA,CAAA,CAAA;AAE3D,IAAA,MAAM,wBAAwB,aAAc,CAAA,YAAA;AAAA,MAC1C,iBAAkB,CAAA,qBAAA;AAAA,KACpB,CAAA;AACA,IAAA,MAAM,+BACJ,CAAC,EAAE,MAAQ,EAAA,GAAG,MACZ,qBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,qBAAA;AAAA,MAAA;AAAA,QACE,GAAG,IAAA;AAAA,QACJ,MAAA,EAAQ,MAAU,IAAA,WAAA,CAAY,MAAM,CAAA;AAAA,OAAA;AAAA,KACtC,CAAA;AAGJ,IAAO,OAAA;AAAA,MACL,UAAsC,GAAA;AACpC,QAAA,IAAI,eAAiB,EAAA;AACnB,UAAO,OAAA,eAAA,CAAA;AAAA,SACT;AAEA,QAAM,MAAA,SAAA,uBAAgB,GAA2B,EAAA,CAAA;AACjD,QAAA,KAAA,MAAW,IAAQ,IAAA,IAAA,CAAK,KAAM,CAAA,MAAA,EAAU,EAAA;AACtC,UAAM,MAAA,MAAA,GAAS,KAAK,IAAK,CAAA,MAAA,CAAA;AACzB,UAAA,IAAI,MAAQ,EAAA;AACV,YAAU,SAAA,CAAA,GAAA,CAAI,cAAe,CAAA,MAAM,CAAC,CAAA,CAAA;AAAA,WACtC;AAAA,SACF;AACA,QAAkB,eAAA,GAAA,KAAA,CAAM,KAAK,SAAS,CAAA,CAAA;AAEtC,QAAO,OAAA,eAAA,CAAA;AAAA,OACT;AAAA,MAEA,cAAc,GAAwC,EAAA;AACpD,QAAO,OAAA,QAAA,CAAS,QAAQ,GAAG,CAAA,CAAA;AAAA,OAC7B;AAAA,MAEA,cAAgD,GAAA;AAC9C,QAAA,OAAO,MAAO,CAAA,WAAA;AAAA,UACZ,QAAA,CAAS,YAAa,EAAA,CAAE,GAAI,CAAA,CAAA,GAAA,KAAO,CAAC,GAAA,EAAK,QAAS,CAAA,OAAA,CAAQ,GAAG,CAAE,CAAC,CAAA;AAAA,SAClE,CAAA;AAAA,OACF;AAAA,MAEA,aAA+B,GAAA;AAC7B,QAAO,OAAA;AAAA,UACL,mBAAmB,aAAc,CAAA,YAAA;AAAA,YAC/B,iBAAkB,CAAA,iBAAA;AAAA,WACpB;AAAA,UACA,aAAgB,GAAA;AACd,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,mEAAA;AAAA,aACF,CAAA;AAAA,WACF;AAAA,UACA,QAAU,EAAA,aAAA,CAAc,YAAa,CAAA,iBAAA,CAAkB,QAAQ,CAAA;AAAA,UAC/D,MAAS,GAAA;AACP,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,4DAAA;AAAA,aACF,CAAA;AAAA,WACF;AAAA,UACA,qBAAuB,EAAA,4BAAA;AAAA,SACzB,CAAA;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACC,EAAA,CAAC,UAAY,EAAA,aAAA,EAAe,QAAQ,CAAC,CAAA,CAAA;AAExC,EAAA,uBACG,KAAA,CAAA,aAAA,CAAA,kBAAA,EAAA,EAAmB,UACjB,EAAA,EAAA,KAAA,CAAM,QACT,CAAA,CAAA;AAEJ,CAAA;AAEA,MAAM,cAAiB,GAAA,sBAAA;AAAA,EACrB,iBAAA;AACF,CAAA,CAAA;AAEA,SAAS,sBAAsB,KAAgC,EAAA;AAC7D,EAAM,MAAA,kBAAA,GAAqB,OAAO,qBAAqB,CAAA,CAAA;AAEvD,EAAM,MAAA,KAAA,GAAQ,QAA8C,MAAM;AAChE,IAAA,OAAO,uBAAwB,CAAA;AAAA,MAC7B,CAAG,EAAA;AAAA,QACD,OAAA,CAAQ,aAAa,QAAU,EAAA;AAC7B,UAAA,MAAM,aACJ,OAAO,QAAA,KAAa,QAAW,GAAA,QAAA,GAAW,SAAS,QAAY,IAAA,EAAA,CAAA;AAEjE,UAAA,OAAO,kBAAmB,CAAA,OAAA;AAAA;AAAA;AAAA,YAGxB,sBAAsB,WAAuB,CAAA;AAAA,YAC7C,EAAE,UAAW,EAAA;AAAA,WACf,CAAA;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH,EAAG,CAAC,kBAAkB,CAAC,CAAA,CAAA;AAEvB,EAAA,2CACG,cAAe,CAAA,QAAA,EAAf,EAAwB,KAAA,EAAA,EACtB,MAAM,QACT,CAAA,CAAA;AAEJ,CAAA;AAEO,SAAS,wBAAwB,KAAgC,EAAA;AACtE,EAAA,2CACG,qBACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,wBAA0B,EAAA,IAAA,EAAA,KAAA,CAAM,QAAS,CAC5C,CAAA,CAAA;AAEJ;;;;"}

package/dist/compatWrapper/ForwardsCompatProvider.esm.js

@@ -1,7 +1,103 @@
-import React from 'react';
+import { useApp } from '@backstage/core-plugin-api';
+import { componentsApiRef, iconsApiRef, routeResolutionApiRef, coreComponentRefs } from '@backstage/frontend-plugin-api';
+import React, { useMemo } from 'react';
+import { toLegacyPlugin } from './BackwardsCompatProvider.esm.js';
+import { ApiProvider } from '../core-app-api/src/apis/system/ApiProvider.esm.js';
+import { useVersionedContext } from '@backstage/version-bridge';
+import { convertLegacyRouteRef } from '../convertLegacyRouteRef.esm.js';
 
+class CompatComponentsApi {
+  #Progress;
+  #NotFoundErrorPage;
+  #ErrorBoundaryFallback;
+  constructor(app) {
+    const components = app.getComponents();
+    const ErrorBoundaryFallback = (props) => /* @__PURE__ */ React.createElement(
+      components.ErrorBoundaryFallback,
+      {
+        ...props,
+        plugin: props.plugin && toLegacyPlugin(props.plugin)
+      }
+    );
+    this.#Progress = components.Progress;
+    this.#NotFoundErrorPage = components.NotFoundErrorPage;
+    this.#ErrorBoundaryFallback = ErrorBoundaryFallback;
+  }
+  getComponent(ref) {
+    switch (ref.id) {
+      case coreComponentRefs.progress.id:
+        return this.#Progress;
+      case coreComponentRefs.notFoundErrorPage.id:
+        return this.#NotFoundErrorPage;
+      case coreComponentRefs.errorBoundaryFallback.id:
+        return this.#ErrorBoundaryFallback;
+      default:
+        throw new Error(
+          `No backwards compatible component is available for ref '${ref.id}'`
+        );
+    }
+  }
+}
+class CompatIconsApi {
+  #app;
+  constructor(app) {
+    this.#app = app;
+  }
+  getIcon(key) {
+    return this.#app.getSystemIcon(key);
+  }
+  listIconKeys() {
+    return Object.keys(this.#app.getSystemIcons());
+  }
+}
+class CompatRouteResolutionApi {
+  #routeResolver;
+  constructor(routeResolver) {
+    this.#routeResolver = routeResolver;
+  }
+  resolve(anyRouteRef, options) {
+    const legacyRef = convertLegacyRouteRef(anyRouteRef);
+    return this.#routeResolver.resolve(legacyRef, options?.sourcePath ?? "/");
+  }
+}
+class ForwardsCompatApis {
+  #componentsApi;
+  #iconsApi;
+  #routeResolutionApi;
+  constructor(app, routeResolver) {
+    this.#componentsApi = new CompatComponentsApi(app);
+    this.#iconsApi = new CompatIconsApi(app);
+    this.#routeResolutionApi = new CompatRouteResolutionApi(routeResolver);
+  }
+  get(ref) {
+    if (ref.id === componentsApiRef.id) {
+      return this.#componentsApi;
+    } else if (ref.id === iconsApiRef.id) {
+      return this.#iconsApi;
+    } else if (ref.id === routeResolutionApiRef.id) {
+      return this.#routeResolutionApi;
+    }
+    return void 0;
+  }
+}
+function NewAppApisProvider(props) {
+  const app = useApp();
+  const versionedRouteResolverContext = useVersionedContext("routing-context");
+  if (!versionedRouteResolverContext) {
+    throw new Error("Routing context is not available");
+  }
+  const routeResolver = versionedRouteResolverContext.atVersion(1);
+  if (!routeResolver) {
+    throw new Error("RoutingContext v1 not available");
+  }
+  const appFallbackApis = useMemo(
+    () => new ForwardsCompatApis(app, routeResolver),
+    [app, routeResolver]
+  );
+  return /* @__PURE__ */ React.createElement(ApiProvider, { apis: appFallbackApis }, props.children);
+}
 function ForwardsCompatProvider(props) {
-  return /* @__PURE__ */ React.createElement(React.Fragment, null, props.children);
+  return /* @__PURE__ */ React.createElement(NewAppApisProvider, null, props.children);
 }
 
 export { ForwardsCompatProvider };

package/dist/compatWrapper/ForwardsCompatProvider.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"ForwardsCompatProvider.esm.js","sources":["../../src/compatWrapper/ForwardsCompatProvider.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 from 'react';\nimport { ReactNode } from 'react';\n\nexport function ForwardsCompatProvider(props: { children: ReactNode }) {\n  // TODO(Rugvip): Implement\n  return <>{props.children}</>;\n}\n"],"names":[],"mappings":";;AAmBO,SAAS,uBAAuB,KAAgC,EAAA;AAErE,EAAO,uBAAA,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EAAG,MAAM,QAAS,CAAA,CAAA;AAC3B;;;;"}
+{"version":3,"file":"ForwardsCompatProvider.esm.js","sources":["../../src/compatWrapper/ForwardsCompatProvider.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  ApiHolder,\n  ApiRef,\n  AppContext,\n  useApp,\n} from '@backstage/core-plugin-api';\nimport {\n  AnyRouteRefParams,\n  ComponentRef,\n  ComponentsApi,\n  CoreErrorBoundaryFallbackProps,\n  CoreNotFoundErrorPageProps,\n  CoreProgressProps,\n  ExternalRouteRef,\n  IconComponent,\n  IconsApi,\n  RouteFunc,\n  RouteRef,\n  RouteResolutionApi,\n  RouteResolutionApiResolveOptions,\n  SubRouteRef,\n  componentsApiRef,\n  coreComponentRefs,\n  iconsApiRef,\n  routeResolutionApiRef,\n} from '@backstage/frontend-plugin-api';\nimport React, { ComponentType, useMemo } from 'react';\nimport { ReactNode } from 'react';\nimport { toLegacyPlugin } from './BackwardsCompatProvider';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { ApiProvider } from '../../../core-app-api/src/apis/system/ApiProvider';\nimport { useVersionedContext } from '@backstage/version-bridge';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { type RouteResolver } from '../../../core-plugin-api/src/routing/useRouteRef';\nimport { convertLegacyRouteRef } from '../convertLegacyRouteRef';\n\nclass CompatComponentsApi implements ComponentsApi {\n  readonly #Progress: ComponentType<CoreProgressProps>;\n  readonly #NotFoundErrorPage: ComponentType<CoreNotFoundErrorPageProps>;\n  readonly #ErrorBoundaryFallback: ComponentType<CoreErrorBoundaryFallbackProps>;\n\n  constructor(app: AppContext) {\n    const components = app.getComponents();\n    const ErrorBoundaryFallback = (props: CoreErrorBoundaryFallbackProps) => (\n      <components.ErrorBoundaryFallback\n        {...props}\n        plugin={props.plugin && toLegacyPlugin(props.plugin)}\n      />\n    );\n    this.#Progress = components.Progress;\n    this.#NotFoundErrorPage = components.NotFoundErrorPage;\n    this.#ErrorBoundaryFallback = ErrorBoundaryFallback;\n  }\n\n  getComponent<T extends {}>(ref: ComponentRef<T>): ComponentType<T> {\n    switch (ref.id) {\n      case coreComponentRefs.progress.id:\n        return this.#Progress as ComponentType<any>;\n      case coreComponentRefs.notFoundErrorPage.id:\n        return this.#NotFoundErrorPage as ComponentType<any>;\n      case coreComponentRefs.errorBoundaryFallback.id:\n        return this.#ErrorBoundaryFallback as ComponentType<any>;\n      default:\n        throw new Error(\n          `No backwards compatible component is available for ref '${ref.id}'`,\n        );\n    }\n  }\n}\n\nclass CompatIconsApi implements IconsApi {\n  readonly #app: AppContext;\n\n  constructor(app: AppContext) {\n    this.#app = app;\n  }\n\n  getIcon(key: string): IconComponent | undefined {\n    return this.#app.getSystemIcon(key);\n  }\n\n  listIconKeys(): string[] {\n    return Object.keys(this.#app.getSystemIcons());\n  }\n}\n\nclass CompatRouteResolutionApi implements RouteResolutionApi {\n  readonly #routeResolver: RouteResolver;\n\n  constructor(routeResolver: RouteResolver) {\n    this.#routeResolver = routeResolver;\n  }\n\n  resolve<TParams extends AnyRouteRefParams>(\n    anyRouteRef:\n      | RouteRef<TParams>\n      | SubRouteRef<TParams>\n      | ExternalRouteRef<TParams>,\n    options?: RouteResolutionApiResolveOptions | undefined,\n  ): RouteFunc<TParams> | undefined {\n    const legacyRef = convertLegacyRouteRef(anyRouteRef as RouteRef<TParams>);\n    return this.#routeResolver.resolve(legacyRef, options?.sourcePath ?? '/');\n  }\n}\n\nclass ForwardsCompatApis implements ApiHolder {\n  readonly #componentsApi: ComponentsApi;\n  readonly #iconsApi: IconsApi;\n  readonly #routeResolutionApi: RouteResolutionApi;\n\n  constructor(app: AppContext, routeResolver: RouteResolver) {\n    this.#componentsApi = new CompatComponentsApi(app);\n    this.#iconsApi = new CompatIconsApi(app);\n    this.#routeResolutionApi = new CompatRouteResolutionApi(routeResolver);\n  }\n\n  get<T>(ref: ApiRef<any>): T | undefined {\n    if (ref.id === componentsApiRef.id) {\n      return this.#componentsApi as T;\n    } else if (ref.id === iconsApiRef.id) {\n      return this.#iconsApi as T;\n    } else if (ref.id === routeResolutionApiRef.id) {\n      return this.#routeResolutionApi as T;\n    }\n    return undefined;\n  }\n}\n\nfunction NewAppApisProvider(props: { children: ReactNode }) {\n  const app = useApp();\n  const versionedRouteResolverContext = useVersionedContext<{\n    1: RouteResolver;\n  }>('routing-context');\n  if (!versionedRouteResolverContext) {\n    throw new Error('Routing context is not available');\n  }\n  const routeResolver = versionedRouteResolverContext.atVersion(1);\n  if (!routeResolver) {\n    throw new Error('RoutingContext v1 not available');\n  }\n\n  const appFallbackApis = useMemo(\n    () => new ForwardsCompatApis(app, routeResolver),\n    [app, routeResolver],\n  );\n\n  return <ApiProvider apis={appFallbackApis}>{props.children}</ApiProvider>;\n}\n\nexport function ForwardsCompatProvider(props: { children: ReactNode }) {\n  return <NewAppApisProvider>{props.children}</NewAppApisProvider>;\n}\n"],"names":[],"mappings":";;;;;;;;AAoDA,MAAM,mBAA6C,CAAA;AAAA,EACxC,SAAA,CAAA;AAAA,EACA,kBAAA,CAAA;AAAA,EACA,sBAAA,CAAA;AAAA,EAET,YAAY,GAAiB,EAAA;AAC3B,IAAM,MAAA,UAAA,GAAa,IAAI,aAAc,EAAA,CAAA;AACrC,IAAM,MAAA,qBAAA,GAAwB,CAAC,KAC7B,qBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,UAAW,CAAA,qBAAA;AAAA,MAAX;AAAA,QACE,GAAG,KAAA;AAAA,QACJ,MAAQ,EAAA,KAAA,CAAM,MAAU,IAAA,cAAA,CAAe,MAAM,MAAM,CAAA;AAAA,OAAA;AAAA,KACrD,CAAA;AAEF,IAAA,IAAA,CAAK,YAAY,UAAW,CAAA,QAAA,CAAA;AAC5B,IAAA,IAAA,CAAK,qBAAqB,UAAW,CAAA,iBAAA,CAAA;AACrC,IAAA,IAAA,CAAK,sBAAyB,GAAA,qBAAA,CAAA;AAAA,GAChC;AAAA,EAEA,aAA2B,GAAwC,EAAA;AACjE,IAAA,QAAQ,IAAI,EAAI;AAAA,MACd,KAAK,kBAAkB,QAAS,CAAA,EAAA;AAC9B,QAAA,OAAO,IAAK,CAAA,SAAA,CAAA;AAAA,MACd,KAAK,kBAAkB,iBAAkB,CAAA,EAAA;AACvC,QAAA,OAAO,IAAK,CAAA,kBAAA,CAAA;AAAA,MACd,KAAK,kBAAkB,qBAAsB,CAAA,EAAA;AAC3C,QAAA,OAAO,IAAK,CAAA,sBAAA,CAAA;AAAA,MACd;AACE,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,wDAAA,EAA2D,IAAI,EAAE,CAAA,CAAA,CAAA;AAAA,SACnE,CAAA;AAAA,KACJ;AAAA,GACF;AACF,CAAA;AAEA,MAAM,cAAmC,CAAA;AAAA,EAC9B,IAAA,CAAA;AAAA,EAET,YAAY,GAAiB,EAAA;AAC3B,IAAA,IAAA,CAAK,IAAO,GAAA,GAAA,CAAA;AAAA,GACd;AAAA,EAEA,QAAQ,GAAwC,EAAA;AAC9C,IAAO,OAAA,IAAA,CAAK,IAAK,CAAA,aAAA,CAAc,GAAG,CAAA,CAAA;AAAA,GACpC;AAAA,EAEA,YAAyB,GAAA;AACvB,IAAA,OAAO,MAAO,CAAA,IAAA,CAAK,IAAK,CAAA,IAAA,CAAK,gBAAgB,CAAA,CAAA;AAAA,GAC/C;AACF,CAAA;AAEA,MAAM,wBAAuD,CAAA;AAAA,EAClD,cAAA,CAAA;AAAA,EAET,YAAY,aAA8B,EAAA;AACxC,IAAA,IAAA,CAAK,cAAiB,GAAA,aAAA,CAAA;AAAA,GACxB;AAAA,EAEA,OAAA,CACE,aAIA,OACgC,EAAA;AAChC,IAAM,MAAA,SAAA,GAAY,sBAAsB,WAAgC,CAAA,CAAA;AACxE,IAAA,OAAO,KAAK,cAAe,CAAA,OAAA,CAAQ,SAAW,EAAA,OAAA,EAAS,cAAc,GAAG,CAAA,CAAA;AAAA,GAC1E;AACF,CAAA;AAEA,MAAM,kBAAwC,CAAA;AAAA,EACnC,cAAA,CAAA;AAAA,EACA,SAAA,CAAA;AAAA,EACA,mBAAA,CAAA;AAAA,EAET,WAAA,CAAY,KAAiB,aAA8B,EAAA;AACzD,IAAK,IAAA,CAAA,cAAA,GAAiB,IAAI,mBAAA,CAAoB,GAAG,CAAA,CAAA;AACjD,IAAK,IAAA,CAAA,SAAA,GAAY,IAAI,cAAA,CAAe,GAAG,CAAA,CAAA;AACvC,IAAK,IAAA,CAAA,mBAAA,GAAsB,IAAI,wBAAA,CAAyB,aAAa,CAAA,CAAA;AAAA,GACvE;AAAA,EAEA,IAAO,GAAiC,EAAA;AACtC,IAAI,IAAA,GAAA,CAAI,EAAO,KAAA,gBAAA,CAAiB,EAAI,EAAA;AAClC,MAAA,OAAO,IAAK,CAAA,cAAA,CAAA;AAAA,KACH,MAAA,IAAA,GAAA,CAAI,EAAO,KAAA,WAAA,CAAY,EAAI,EAAA;AACpC,MAAA,OAAO,IAAK,CAAA,SAAA,CAAA;AAAA,KACH,MAAA,IAAA,GAAA,CAAI,EAAO,KAAA,qBAAA,CAAsB,EAAI,EAAA;AAC9C,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAA;AAAA,KACd;AACA,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACT;AACF,CAAA;AAEA,SAAS,mBAAmB,KAAgC,EAAA;AAC1D,EAAA,MAAM,MAAM,MAAO,EAAA,CAAA;AACnB,EAAM,MAAA,6BAAA,GAAgC,oBAEnC,iBAAiB,CAAA,CAAA;AACpB,EAAA,IAAI,CAAC,6BAA+B,EAAA;AAClC,IAAM,MAAA,IAAI,MAAM,kCAAkC,CAAA,CAAA;AAAA,GACpD;AACA,EAAM,MAAA,aAAA,GAAgB,6BAA8B,CAAA,SAAA,CAAU,CAAC,CAAA,CAAA;AAC/D,EAAA,IAAI,CAAC,aAAe,EAAA;AAClB,IAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA,CAAA;AAAA,GACnD;AAEA,EAAA,MAAM,eAAkB,GAAA,OAAA;AAAA,IACtB,MAAM,IAAI,kBAAmB,CAAA,GAAA,EAAK,aAAa,CAAA;AAAA,IAC/C,CAAC,KAAK,aAAa,CAAA;AAAA,GACrB,CAAA;AAEA,EAAA,uBAAQ,KAAA,CAAA,aAAA,CAAA,WAAA,EAAA,EAAY,IAAM,EAAA,eAAA,EAAA,EAAkB,MAAM,QAAS,CAAA,CAAA;AAC7D,CAAA;AAEO,SAAS,uBAAuB,KAAgC,EAAA;AACrE,EAAO,uBAAA,KAAA,CAAA,aAAA,CAAC,kBAAoB,EAAA,IAAA,EAAA,KAAA,CAAM,QAAS,CAAA,CAAA;AAC7C;;;;"}

package/dist/convertLegacyRouteRef.esm.js

@@ -13,10 +13,49 @@ function convertLegacyRouteRefs(refs) {
   );
 }
 function convertLegacyRouteRef(ref) {
-  if ("$$type" in ref) {
+  const isNew = "$$type" in ref;
+  const oldType = ref[routeRefType];
+  if (isNew && oldType) {
     return ref;
   }
-  const type = ref[routeRefType];
+  if (isNew) {
+    return convertNewToOld(
+      ref
+    );
+  }
+  return convertOldToNew(ref, oldType);
+}
+function convertNewToOld(ref) {
+  if (ref.$$type === "@backstage/RouteRef") {
+    const newRef = toInternalRouteRef(ref);
+    return Object.assign(ref, {
+      [routeRefType]: "absolute",
+      params: newRef.getParams(),
+      title: newRef.getDescription()
+    });
+  }
+  if (ref.$$type === "@backstage/SubRouteRef") {
+    const newRef = toInternalSubRouteRef(ref);
+    return Object.assign(ref, {
+      [routeRefType]: "sub",
+      parent: convertLegacyRouteRef(newRef.getParent()),
+      params: newRef.getParams()
+    });
+  }
+  if (ref.$$type === "@backstage/ExternalRouteRef") {
+    const newRef = toInternalExternalRouteRef(ref);
+    return Object.assign(ref, {
+      [routeRefType]: "external",
+      optional: true,
+      params: newRef.getParams(),
+      defaultTarget: newRef.getDefaultTarget()
+    });
+  }
+  throw new Error(
+    `Failed to convert route ref, unknown type '${ref.$$type}'`
+  );
+}
+function convertOldToNew(ref, type) {
   if (type === "absolute") {
     const legacyRef = ref;
     const legacyRefStr = String(legacyRef);
@@ -76,7 +115,6 @@ function convertLegacyRouteRef(ref) {
     const newRef = toInternalExternalRouteRef(
       createExternalRouteRef({
         params: legacyRef.params,
-        optional: legacyRef.optional,
         defaultTarget: "getDefaultTarget" in legacyRef ? legacyRef.getDefaultTarget() : void 0
       })
     );
@@ -84,7 +122,6 @@ function convertLegacyRouteRef(ref) {
       $$type: "@backstage/ExternalRouteRef",
       version: "v1",
       T: newRef.T,
-      optional: newRef.optional,
       getParams() {
         return newRef.getParams();
       },

package/dist/convertLegacyRouteRef.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"convertLegacyRouteRef.esm.js","sources":["../src/convertLegacyRouteRef.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  RouteRef as LegacyRouteRef,\n  SubRouteRef as LegacySubRouteRef,\n  ExternalRouteRef as LegacyExternalRouteRef,\n  AnyRouteRefParams,\n} from '@backstage/core-plugin-api';\n\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { routeRefType } from '../../core-plugin-api/src/routing/types';\n\nimport {\n  RouteRef,\n  SubRouteRef,\n  ExternalRouteRef,\n  createRouteRef,\n  createSubRouteRef,\n  createExternalRouteRef,\n} from '@backstage/frontend-plugin-api';\n\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalRouteRef } from '../../frontend-plugin-api/src/routing/RouteRef';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalSubRouteRef } from '../../frontend-plugin-api/src/routing/SubRouteRef';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExternalRouteRef } from '../../frontend-plugin-api/src/routing/ExternalRouteRef';\n\n/**\n * Converts a legacy route ref type to the new system.\n *\n * @public\n */\nexport type ToNewRouteRef<\n  T extends LegacyRouteRef | LegacySubRouteRef | LegacyExternalRouteRef,\n> = T extends LegacyRouteRef<infer IParams>\n  ? RouteRef<IParams>\n  : T extends LegacySubRouteRef<infer IParams>\n  ? SubRouteRef<IParams>\n  : T extends LegacyExternalRouteRef<infer IParams, infer IOptional>\n  ? ExternalRouteRef<IParams, IOptional>\n  : never;\n\n/**\n * Converts a collection of legacy route refs to the new system.\n * This is particularly useful when defining plugin `routes` and `externalRoutes`.\n *\n * @public\n */\nexport function convertLegacyRouteRefs<\n  TRefs extends {\n    [name in string]:\n      | LegacyRouteRef\n      | LegacySubRouteRef\n      | LegacyExternalRouteRef;\n  },\n>(refs: TRefs): { [KName in keyof TRefs]: ToNewRouteRef<TRefs[KName]> } {\n  return Object.fromEntries(\n    Object.entries(refs).map(([name, ref]) => [\n      name,\n      convertLegacyRouteRef(ref as LegacyRouteRef),\n    ]),\n  ) as { [KName in keyof TRefs]: ToNewRouteRef<TRefs[KName]> };\n}\n\n/**\n * A temporary helper to convert a legacy route ref to the new system.\n *\n * @public\n * @remarks\n *\n * In the future the legacy createRouteRef will instead create refs compatible with both systems.\n */\nexport function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(\n  ref: LegacyRouteRef<TParams>,\n): RouteRef<TParams>;\n\n/**\n * A temporary helper to convert a legacy sub route ref to the new system.\n *\n * @public\n * @remarks\n *\n * In the future the legacy createSubRouteRef will instead create refs compatible with both systems.\n */\nexport function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(\n  ref: LegacySubRouteRef<TParams>,\n): SubRouteRef<TParams>;\n\n/**\n * A temporary helper to convert a legacy external route ref to the new system.\n *\n * @public\n * @remarks\n *\n * In the future the legacy createExternalRouteRef will instead create refs compatible with both systems.\n */\nexport function convertLegacyRouteRef<\n  TParams extends AnyRouteRefParams,\n  TOptional extends boolean,\n>(\n  ref: LegacyExternalRouteRef<TParams, TOptional>,\n): ExternalRouteRef<TParams, TOptional>;\n\nexport function convertLegacyRouteRef(\n  ref: LegacyRouteRef | LegacySubRouteRef | LegacyExternalRouteRef,\n): RouteRef | SubRouteRef | ExternalRouteRef {\n  // Ref has already been converted\n  if ('$$type' in ref) {\n    return ref as unknown as RouteRef | SubRouteRef | ExternalRouteRef;\n  }\n\n  const type = (ref as unknown as { [routeRefType]: unknown })[routeRefType];\n\n  if (type === 'absolute') {\n    const legacyRef = ref as LegacyRouteRef;\n    const legacyRefStr = String(legacyRef);\n    const newRef = toInternalRouteRef(\n      createRouteRef<{ [key in string]: string }>({\n        params: legacyRef.params as string[],\n      }),\n    );\n    return Object.assign(legacyRef, {\n      $$type: '@backstage/RouteRef' as const,\n      version: 'v1',\n      T: newRef.T,\n      getParams() {\n        return newRef.getParams();\n      },\n      getDescription() {\n        return legacyRefStr;\n      },\n      setId(id: string) {\n        newRef.setId(id);\n      },\n      toString() {\n        return legacyRefStr;\n      },\n    });\n  }\n  if (type === 'sub') {\n    const legacyRef = ref as LegacySubRouteRef;\n    const legacyRefStr = String(legacyRef);\n    const newRef = toInternalSubRouteRef(\n      createSubRouteRef({\n        path: legacyRef.path,\n        parent: convertLegacyRouteRef(legacyRef.parent),\n      }),\n    );\n    return Object.assign(legacyRef, {\n      $$type: '@backstage/SubRouteRef' as const,\n      version: 'v1',\n      T: newRef.T,\n      getParams() {\n        return newRef.getParams();\n      },\n      getParent() {\n        return newRef.getParent();\n      },\n      getDescription() {\n        return legacyRefStr;\n      },\n      toString() {\n        return legacyRefStr;\n      },\n    });\n  }\n  if (type === 'external') {\n    const legacyRef = ref as LegacyExternalRouteRef;\n    const legacyRefStr = String(legacyRef);\n    const newRef = toInternalExternalRouteRef(\n      createExternalRouteRef<{ [key in string]: string }>({\n        params: legacyRef.params as string[],\n        optional: legacyRef.optional,\n        defaultTarget:\n          'getDefaultTarget' in legacyRef\n            ? (legacyRef.getDefaultTarget as () => string | undefined)()\n            : undefined,\n      }),\n    );\n    return Object.assign(legacyRef, {\n      $$type: '@backstage/ExternalRouteRef' as const,\n      version: 'v1',\n      T: newRef.T,\n      optional: newRef.optional,\n      getParams() {\n        return newRef.getParams();\n      },\n      getDescription() {\n        return legacyRefStr;\n      },\n      // This might already be implemented in the legacy ref, but we override it just to be sure\n      getDefaultTarget() {\n        return newRef.getDefaultTarget();\n      },\n      setId(id: string) {\n        newRef.setId(id);\n      },\n      toString() {\n        return legacyRefStr;\n      },\n    });\n  }\n\n  throw new Error(`Failed to convert legacy route ref, unknown type '${type}'`);\n}\n"],"names":[],"mappings":";;;;;;AA+DO,SAAS,uBAOd,IAAsE,EAAA;AACtE,EAAA,OAAO,MAAO,CAAA,WAAA;AAAA,IACZ,MAAA,CAAO,QAAQ,IAAI,CAAA,CAAE,IAAI,CAAC,CAAC,IAAM,EAAA,GAAG,CAAM,KAAA;AAAA,MACxC,IAAA;AAAA,MACA,sBAAsB,GAAqB,CAAA;AAAA,KAC5C,CAAA;AAAA,GACH,CAAA;AACF,CAAA;AAyCO,SAAS,sBACd,GAC2C,EAAA;AAE3C,EAAA,IAAI,YAAY,GAAK,EAAA;AACnB,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AAEA,EAAM,MAAA,IAAA,GAAQ,IAA+C,YAAY,CAAA,CAAA;AAEzE,EAAA,IAAI,SAAS,UAAY,EAAA;AACvB,IAAA,MAAM,SAAY,GAAA,GAAA,CAAA;AAClB,IAAM,MAAA,YAAA,GAAe,OAAO,SAAS,CAAA,CAAA;AACrC,IAAA,MAAM,MAAS,GAAA,kBAAA;AAAA,MACb,cAA4C,CAAA;AAAA,QAC1C,QAAQ,SAAU,CAAA,MAAA;AAAA,OACnB,CAAA;AAAA,KACH,CAAA;AACA,IAAO,OAAA,MAAA,CAAO,OAAO,SAAW,EAAA;AAAA,MAC9B,MAAQ,EAAA,qBAAA;AAAA,MACR,OAAS,EAAA,IAAA;AAAA,MACT,GAAG,MAAO,CAAA,CAAA;AAAA,MACV,SAAY,GAAA;AACV,QAAA,OAAO,OAAO,SAAU,EAAA,CAAA;AAAA,OAC1B;AAAA,MACA,cAAiB,GAAA;AACf,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA,MACA,MAAM,EAAY,EAAA;AAChB,QAAA,MAAA,CAAO,MAAM,EAAE,CAAA,CAAA;AAAA,OACjB;AAAA,MACA,QAAW,GAAA;AACT,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACA,EAAA,IAAI,SAAS,KAAO,EAAA;AAClB,IAAA,MAAM,SAAY,GAAA,GAAA,CAAA;AAClB,IAAM,MAAA,YAAA,GAAe,OAAO,SAAS,CAAA,CAAA;AACrC,IAAA,MAAM,MAAS,GAAA,qBAAA;AAAA,MACb,iBAAkB,CAAA;AAAA,QAChB,MAAM,SAAU,CAAA,IAAA;AAAA,QAChB,MAAA,EAAQ,qBAAsB,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,OAC/C,CAAA;AAAA,KACH,CAAA;AACA,IAAO,OAAA,MAAA,CAAO,OAAO,SAAW,EAAA;AAAA,MAC9B,MAAQ,EAAA,wBAAA;AAAA,MACR,OAAS,EAAA,IAAA;AAAA,MACT,GAAG,MAAO,CAAA,CAAA;AAAA,MACV,SAAY,GAAA;AACV,QAAA,OAAO,OAAO,SAAU,EAAA,CAAA;AAAA,OAC1B;AAAA,MACA,SAAY,GAAA;AACV,QAAA,OAAO,OAAO,SAAU,EAAA,CAAA;AAAA,OAC1B;AAAA,MACA,cAAiB,GAAA;AACf,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA,MACA,QAAW,GAAA;AACT,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACA,EAAA,IAAI,SAAS,UAAY,EAAA;AACvB,IAAA,MAAM,SAAY,GAAA,GAAA,CAAA;AAClB,IAAM,MAAA,YAAA,GAAe,OAAO,SAAS,CAAA,CAAA;AACrC,IAAA,MAAM,MAAS,GAAA,0BAAA;AAAA,MACb,sBAAoD,CAAA;AAAA,QAClD,QAAQ,SAAU,CAAA,MAAA;AAAA,QAClB,UAAU,SAAU,CAAA,QAAA;AAAA,QACpB,aACE,EAAA,kBAAA,IAAsB,SACjB,GAAA,SAAA,CAAU,kBACX,GAAA,KAAA,CAAA;AAAA,OACP,CAAA;AAAA,KACH,CAAA;AACA,IAAO,OAAA,MAAA,CAAO,OAAO,SAAW,EAAA;AAAA,MAC9B,MAAQ,EAAA,6BAAA;AAAA,MACR,OAAS,EAAA,IAAA;AAAA,MACT,GAAG,MAAO,CAAA,CAAA;AAAA,MACV,UAAU,MAAO,CAAA,QAAA;AAAA,MACjB,SAAY,GAAA;AACV,QAAA,OAAO,OAAO,SAAU,EAAA,CAAA;AAAA,OAC1B;AAAA,MACA,cAAiB,GAAA;AACf,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA;AAAA,MAEA,gBAAmB,GAAA;AACjB,QAAA,OAAO,OAAO,gBAAiB,EAAA,CAAA;AAAA,OACjC;AAAA,MACA,MAAM,EAAY,EAAA;AAChB,QAAA,MAAA,CAAO,MAAM,EAAE,CAAA,CAAA;AAAA,OACjB;AAAA,MACA,QAAW,GAAA;AACT,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAEA,EAAA,MAAM,IAAI,KAAA,CAAM,CAAqD,kDAAA,EAAA,IAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAC9E;;;;"}
+{"version":3,"file":"convertLegacyRouteRef.esm.js","sources":["../src/convertLegacyRouteRef.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  RouteRef as LegacyRouteRef,\n  SubRouteRef as LegacySubRouteRef,\n  ExternalRouteRef as LegacyExternalRouteRef,\n  AnyRouteRefParams,\n} from '@backstage/core-plugin-api';\n\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { routeRefType } from '../../core-plugin-api/src/routing/types';\n\nimport {\n  RouteRef,\n  SubRouteRef,\n  ExternalRouteRef,\n  createRouteRef,\n  createSubRouteRef,\n  createExternalRouteRef,\n} from '@backstage/frontend-plugin-api';\n\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalRouteRef } from '../../frontend-plugin-api/src/routing/RouteRef';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalSubRouteRef } from '../../frontend-plugin-api/src/routing/SubRouteRef';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExternalRouteRef } from '../../frontend-plugin-api/src/routing/ExternalRouteRef';\n\n/**\n * Converts a legacy route ref type to the new system.\n *\n * @public\n */\nexport type ToNewRouteRef<\n  T extends LegacyRouteRef | LegacySubRouteRef | LegacyExternalRouteRef,\n> = T extends LegacyRouteRef<infer IParams>\n  ? RouteRef<IParams>\n  : T extends LegacySubRouteRef<infer IParams>\n  ? SubRouteRef<IParams>\n  : T extends LegacyExternalRouteRef<infer IParams>\n  ? ExternalRouteRef<IParams>\n  : never;\n\n/**\n * Converts a collection of legacy route refs to the new system.\n * This is particularly useful when defining plugin `routes` and `externalRoutes`.\n *\n * @public\n */\nexport function convertLegacyRouteRefs<\n  TRefs extends {\n    [name in string]:\n      | LegacyRouteRef\n      | LegacySubRouteRef\n      | LegacyExternalRouteRef;\n  },\n>(refs: TRefs): { [KName in keyof TRefs]: ToNewRouteRef<TRefs[KName]> } {\n  return Object.fromEntries(\n    Object.entries(refs).map(([name, ref]) => [\n      name,\n      convertLegacyRouteRef(ref as LegacyRouteRef),\n    ]),\n  ) as { [KName in keyof TRefs]: ToNewRouteRef<TRefs[KName]> };\n}\n\n/**\n * A temporary helper to convert a legacy route ref to the new system.\n *\n * @public\n * @remarks\n *\n * In the future the legacy createRouteRef will instead create refs compatible with both systems.\n */\nexport function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(\n  ref: LegacyRouteRef<TParams>,\n): RouteRef<TParams>;\n\n/**\n * A temporary helper to convert a legacy sub route ref to the new system.\n *\n * @public\n * @remarks\n *\n * In the future the legacy createSubRouteRef will instead create refs compatible with both systems.\n */\nexport function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(\n  ref: LegacySubRouteRef<TParams>,\n): SubRouteRef<TParams>;\n\n/**\n * A temporary helper to convert a legacy external route ref to the new system.\n *\n * @public\n * @remarks\n *\n * In the future the legacy createExternalRouteRef will instead create refs compatible with both systems.\n */\nexport function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(\n  ref: LegacyExternalRouteRef<TParams>,\n): ExternalRouteRef<TParams>;\n\n/**\n * A temporary helper to convert a new route ref to the legacy system.\n *\n * @public\n * @remarks\n *\n * In the future the legacy createRouteRef will instead create refs compatible with both systems.\n */\nexport function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(\n  ref: RouteRef<TParams>,\n): LegacyRouteRef<TParams>;\n\n/**\n * A temporary helper to convert a new sub route ref to the legacy system.\n *\n * @public\n * @remarks\n *\n * In the future the legacy createSubRouteRef will instead create refs compatible with both systems.\n */\nexport function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(\n  ref: SubRouteRef<TParams>,\n): LegacySubRouteRef<TParams>;\n\n/**\n * A temporary helper to convert a new external route ref to the legacy system.\n *\n * @public\n * @remarks\n *\n * In the future the legacy createExternalRouteRef will instead create refs compatible with both systems.\n */\nexport function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(\n  ref: ExternalRouteRef<TParams>,\n): LegacyExternalRouteRef<TParams, true>;\nexport function convertLegacyRouteRef(\n  ref:\n    | LegacyRouteRef\n    | LegacySubRouteRef\n    | LegacyExternalRouteRef\n    | RouteRef\n    | SubRouteRef\n    | ExternalRouteRef,\n):\n  | RouteRef\n  | SubRouteRef\n  | ExternalRouteRef\n  | LegacyRouteRef\n  | LegacySubRouteRef\n  | LegacyExternalRouteRef {\n  const isNew = '$$type' in ref;\n  const oldType = (ref as unknown as { [routeRefType]: unknown })[routeRefType];\n\n  // Ref has already been converted\n  if (isNew && oldType) {\n    return ref as any;\n  }\n\n  if (isNew) {\n    return convertNewToOld(\n      ref as unknown as RouteRef | SubRouteRef | ExternalRouteRef,\n    );\n  }\n\n  return convertOldToNew(ref, oldType);\n}\n\nfunction convertNewToOld(\n  ref: RouteRef | SubRouteRef | ExternalRouteRef,\n): LegacyRouteRef | LegacySubRouteRef | LegacyExternalRouteRef {\n  if (ref.$$type === '@backstage/RouteRef') {\n    const newRef = toInternalRouteRef(ref);\n    return Object.assign(ref, {\n      [routeRefType]: 'absolute',\n      params: newRef.getParams(),\n      title: newRef.getDescription(),\n    } as Omit<LegacyRouteRef, '$$routeRefType'>) as unknown as LegacyRouteRef;\n  }\n  if (ref.$$type === '@backstage/SubRouteRef') {\n    const newRef = toInternalSubRouteRef(ref);\n    return Object.assign(ref, {\n      [routeRefType]: 'sub',\n      parent: convertLegacyRouteRef(newRef.getParent()),\n      params: newRef.getParams(),\n    } as Omit<LegacySubRouteRef, '$$routeRefType' | 'path'>) as unknown as LegacySubRouteRef;\n  }\n  if (ref.$$type === '@backstage/ExternalRouteRef') {\n    const newRef = toInternalExternalRouteRef(ref);\n    return Object.assign(ref, {\n      [routeRefType]: 'external',\n      optional: true,\n      params: newRef.getParams(),\n      defaultTarget: newRef.getDefaultTarget(),\n    } as Omit<LegacyExternalRouteRef, '$$routeRefType' | 'optional'>) as unknown as LegacyExternalRouteRef;\n  }\n\n  throw new Error(\n    `Failed to convert route ref, unknown type '${(ref as any).$$type}'`,\n  );\n}\n\nfunction convertOldToNew(\n  ref: LegacyRouteRef | LegacySubRouteRef | LegacyExternalRouteRef,\n  type: unknown,\n): RouteRef | SubRouteRef | ExternalRouteRef {\n  if (type === 'absolute') {\n    const legacyRef = ref as LegacyRouteRef;\n    const legacyRefStr = String(legacyRef);\n    const newRef = toInternalRouteRef(\n      createRouteRef<{ [key in string]: string }>({\n        params: legacyRef.params as string[],\n      }),\n    );\n    return Object.assign(legacyRef, {\n      $$type: '@backstage/RouteRef' as const,\n      version: 'v1',\n      T: newRef.T,\n      getParams() {\n        return newRef.getParams();\n      },\n      getDescription() {\n        return legacyRefStr;\n      },\n      setId(id: string) {\n        newRef.setId(id);\n      },\n      toString() {\n        return legacyRefStr;\n      },\n    });\n  }\n  if (type === 'sub') {\n    const legacyRef = ref as LegacySubRouteRef;\n    const legacyRefStr = String(legacyRef);\n    const newRef = toInternalSubRouteRef(\n      createSubRouteRef({\n        path: legacyRef.path,\n        parent: convertLegacyRouteRef(legacyRef.parent),\n      }),\n    );\n    return Object.assign(legacyRef, {\n      $$type: '@backstage/SubRouteRef' as const,\n      version: 'v1',\n      T: newRef.T,\n      getParams() {\n        return newRef.getParams();\n      },\n      getParent() {\n        return newRef.getParent();\n      },\n      getDescription() {\n        return legacyRefStr;\n      },\n      toString() {\n        return legacyRefStr;\n      },\n    });\n  }\n  if (type === 'external') {\n    const legacyRef = ref as LegacyExternalRouteRef;\n    const legacyRefStr = String(legacyRef);\n    const newRef = toInternalExternalRouteRef(\n      createExternalRouteRef<{ [key in string]: string }>({\n        params: legacyRef.params as string[],\n        defaultTarget:\n          'getDefaultTarget' in legacyRef\n            ? (legacyRef.getDefaultTarget as () => string | undefined)()\n            : undefined,\n      }),\n    );\n    return Object.assign(legacyRef, {\n      $$type: '@backstage/ExternalRouteRef' as const,\n      version: 'v1',\n      T: newRef.T,\n      getParams() {\n        return newRef.getParams();\n      },\n      getDescription() {\n        return legacyRefStr;\n      },\n      // This might already be implemented in the legacy ref, but we override it just to be sure\n      getDefaultTarget() {\n        return newRef.getDefaultTarget();\n      },\n      setId(id: string) {\n        newRef.setId(id);\n      },\n      toString() {\n        return legacyRefStr;\n      },\n    });\n  }\n\n  throw new Error(`Failed to convert legacy route ref, unknown type '${type}'`);\n}\n"],"names":[],"mappings":";;;;;;AA+DO,SAAS,uBAOd,IAAsE,EAAA;AACtE,EAAA,OAAO,MAAO,CAAA,WAAA;AAAA,IACZ,MAAA,CAAO,QAAQ,IAAI,CAAA,CAAE,IAAI,CAAC,CAAC,IAAM,EAAA,GAAG,CAAM,KAAA;AAAA,MACxC,IAAA;AAAA,MACA,sBAAsB,GAAqB,CAAA;AAAA,KAC5C,CAAA;AAAA,GACH,CAAA;AACF,CAAA;AAyEO,SAAS,sBACd,GAayB,EAAA;AACzB,EAAA,MAAM,QAAQ,QAAY,IAAA,GAAA,CAAA;AAC1B,EAAM,MAAA,OAAA,GAAW,IAA+C,YAAY,CAAA,CAAA;AAG5E,EAAA,IAAI,SAAS,OAAS,EAAA;AACpB,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AAEA,EAAA,IAAI,KAAO,EAAA;AACT,IAAO,OAAA,eAAA;AAAA,MACL,GAAA;AAAA,KACF,CAAA;AAAA,GACF;AAEA,EAAO,OAAA,eAAA,CAAgB,KAAK,OAAO,CAAA,CAAA;AACrC,CAAA;AAEA,SAAS,gBACP,GAC6D,EAAA;AAC7D,EAAI,IAAA,GAAA,CAAI,WAAW,qBAAuB,EAAA;AACxC,IAAM,MAAA,MAAA,GAAS,mBAAmB,GAAG,CAAA,CAAA;AACrC,IAAO,OAAA,MAAA,CAAO,OAAO,GAAK,EAAA;AAAA,MACxB,CAAC,YAAY,GAAG,UAAA;AAAA,MAChB,MAAA,EAAQ,OAAO,SAAU,EAAA;AAAA,MACzB,KAAA,EAAO,OAAO,cAAe,EAAA;AAAA,KACY,CAAA,CAAA;AAAA,GAC7C;AACA,EAAI,IAAA,GAAA,CAAI,WAAW,wBAA0B,EAAA;AAC3C,IAAM,MAAA,MAAA,GAAS,sBAAsB,GAAG,CAAA,CAAA;AACxC,IAAO,OAAA,MAAA,CAAO,OAAO,GAAK,EAAA;AAAA,MACxB,CAAC,YAAY,GAAG,KAAA;AAAA,MAChB,MAAQ,EAAA,qBAAA,CAAsB,MAAO,CAAA,SAAA,EAAW,CAAA;AAAA,MAChD,MAAA,EAAQ,OAAO,SAAU,EAAA;AAAA,KAC4B,CAAA,CAAA;AAAA,GACzD;AACA,EAAI,IAAA,GAAA,CAAI,WAAW,6BAA+B,EAAA;AAChD,IAAM,MAAA,MAAA,GAAS,2BAA2B,GAAG,CAAA,CAAA;AAC7C,IAAO,OAAA,MAAA,CAAO,OAAO,GAAK,EAAA;AAAA,MACxB,CAAC,YAAY,GAAG,UAAA;AAAA,MAChB,QAAU,EAAA,IAAA;AAAA,MACV,MAAA,EAAQ,OAAO,SAAU,EAAA;AAAA,MACzB,aAAA,EAAe,OAAO,gBAAiB,EAAA;AAAA,KACuB,CAAA,CAAA;AAAA,GAClE;AAEA,EAAA,MAAM,IAAI,KAAA;AAAA,IACR,CAAA,2CAAA,EAA+C,IAAY,MAAM,CAAA,CAAA,CAAA;AAAA,GACnE,CAAA;AACF,CAAA;AAEA,SAAS,eAAA,CACP,KACA,IAC2C,EAAA;AAC3C,EAAA,IAAI,SAAS,UAAY,EAAA;AACvB,IAAA,MAAM,SAAY,GAAA,GAAA,CAAA;AAClB,IAAM,MAAA,YAAA,GAAe,OAAO,SAAS,CAAA,CAAA;AACrC,IAAA,MAAM,MAAS,GAAA,kBAAA;AAAA,MACb,cAA4C,CAAA;AAAA,QAC1C,QAAQ,SAAU,CAAA,MAAA;AAAA,OACnB,CAAA;AAAA,KACH,CAAA;AACA,IAAO,OAAA,MAAA,CAAO,OAAO,SAAW,EAAA;AAAA,MAC9B,MAAQ,EAAA,qBAAA;AAAA,MACR,OAAS,EAAA,IAAA;AAAA,MACT,GAAG,MAAO,CAAA,CAAA;AAAA,MACV,SAAY,GAAA;AACV,QAAA,OAAO,OAAO,SAAU,EAAA,CAAA;AAAA,OAC1B;AAAA,MACA,cAAiB,GAAA;AACf,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA,MACA,MAAM,EAAY,EAAA;AAChB,QAAA,MAAA,CAAO,MAAM,EAAE,CAAA,CAAA;AAAA,OACjB;AAAA,MACA,QAAW,GAAA;AACT,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACA,EAAA,IAAI,SAAS,KAAO,EAAA;AAClB,IAAA,MAAM,SAAY,GAAA,GAAA,CAAA;AAClB,IAAM,MAAA,YAAA,GAAe,OAAO,SAAS,CAAA,CAAA;AACrC,IAAA,MAAM,MAAS,GAAA,qBAAA;AAAA,MACb,iBAAkB,CAAA;AAAA,QAChB,MAAM,SAAU,CAAA,IAAA;AAAA,QAChB,MAAA,EAAQ,qBAAsB,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,OAC/C,CAAA;AAAA,KACH,CAAA;AACA,IAAO,OAAA,MAAA,CAAO,OAAO,SAAW,EAAA;AAAA,MAC9B,MAAQ,EAAA,wBAAA;AAAA,MACR,OAAS,EAAA,IAAA;AAAA,MACT,GAAG,MAAO,CAAA,CAAA;AAAA,MACV,SAAY,GAAA;AACV,QAAA,OAAO,OAAO,SAAU,EAAA,CAAA;AAAA,OAC1B;AAAA,MACA,SAAY,GAAA;AACV,QAAA,OAAO,OAAO,SAAU,EAAA,CAAA;AAAA,OAC1B;AAAA,MACA,cAAiB,GAAA;AACf,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA,MACA,QAAW,GAAA;AACT,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACA,EAAA,IAAI,SAAS,UAAY,EAAA;AACvB,IAAA,MAAM,SAAY,GAAA,GAAA,CAAA;AAClB,IAAM,MAAA,YAAA,GAAe,OAAO,SAAS,CAAA,CAAA;AACrC,IAAA,MAAM,MAAS,GAAA,0BAAA;AAAA,MACb,sBAAoD,CAAA;AAAA,QAClD,QAAQ,SAAU,CAAA,MAAA;AAAA,QAClB,aACE,EAAA,kBAAA,IAAsB,SACjB,GAAA,SAAA,CAAU,kBACX,GAAA,KAAA,CAAA;AAAA,OACP,CAAA;AAAA,KACH,CAAA;AACA,IAAO,OAAA,MAAA,CAAO,OAAO,SAAW,EAAA;AAAA,MAC9B,MAAQ,EAAA,6BAAA;AAAA,MACR,OAAS,EAAA,IAAA;AAAA,MACT,GAAG,MAAO,CAAA,CAAA;AAAA,MACV,SAAY,GAAA;AACV,QAAA,OAAO,OAAO,SAAU,EAAA,CAAA;AAAA,OAC1B;AAAA,MACA,cAAiB,GAAA;AACf,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA;AAAA,MAEA,gBAAmB,GAAA;AACjB,QAAA,OAAO,OAAO,gBAAiB,EAAA,CAAA;AAAA,OACjC;AAAA,MACA,MAAM,EAAY,EAAA;AAChB,QAAA,MAAA,CAAO,MAAM,EAAE,CAAA,CAAA;AAAA,OACjB;AAAA,MACA,QAAW,GAAA;AACT,QAAO,OAAA,YAAA,CAAA;AAAA,OACT;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAEA,EAAA,MAAM,IAAI,KAAA,CAAM,CAAqD,kDAAA,EAAA,IAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAC9E;;;;"}

package/dist/core-app-api/src/apis/system/ApiAggregator.esm.js

@@ -0,0 +1,18 @@
+class ApiAggregator {
+  holders;
+  constructor(...holders) {
+    this.holders = holders;
+  }
+  get(apiRef) {
+    for (const holder of this.holders) {
+      const api = holder.get(apiRef);
+      if (api) {
+        return api;
+      }
+    }
+    return void 0;
+  }
+}
+
+export { ApiAggregator };
+//# sourceMappingURL=ApiAggregator.esm.js.map

package/dist/core-app-api/src/apis/system/ApiAggregator.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiAggregator.esm.js","sources":["../../../../../../core-app-api/src/apis/system/ApiAggregator.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { ApiRef, ApiHolder } from '@backstage/core-plugin-api';\n\n/**\n * An ApiHolder that queries multiple other holders from for\n * an Api implementation, returning the first one encountered..\n */\nexport class ApiAggregator implements ApiHolder {\n  private readonly holders: ApiHolder[];\n\n  constructor(...holders: ApiHolder[]) {\n    this.holders = holders;\n  }\n\n  get<T>(apiRef: ApiRef<T>): T | undefined {\n    for (const holder of this.holders) {\n      const api = holder.get(apiRef);\n      if (api) {\n        return api;\n      }\n    }\n    return undefined;\n  }\n}\n"],"names":[],"mappings":"AAsBO,MAAM,aAAmC,CAAA;AAAA,EAC7B,OAAA,CAAA;AAAA,EAEjB,eAAe,OAAsB,EAAA;AACnC,IAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAA;AAAA,GACjB;AAAA,EAEA,IAAO,MAAkC,EAAA;AACvC,IAAW,KAAA,MAAA,MAAA,IAAU,KAAK,OAAS,EAAA;AACjC,MAAM,MAAA,GAAA,GAAM,MAAO,CAAA,GAAA,CAAI,MAAM,CAAA,CAAA;AAC7B,MAAA,IAAI,GAAK,EAAA;AACP,QAAO,OAAA,GAAA,CAAA;AAAA,OACT;AAAA,KACF;AACA,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACT;AACF;;;;"}

package/dist/core-app-api/src/apis/system/ApiProvider.esm.js

@@ -0,0 +1,25 @@
+import React, { useContext } from 'react';
+import PropTypes from 'prop-types';
+import { ApiAggregator } from './ApiAggregator.esm.js';
+import { createVersionedContext, createVersionedValueMap } from '@backstage/version-bridge';
+
+const ApiContext = createVersionedContext("api-context");
+const ApiProvider = (props) => {
+  const { apis, children } = props;
+  const parentHolder = useContext(ApiContext)?.atVersion(1);
+  const holder = parentHolder ? new ApiAggregator(apis, parentHolder) : apis;
+  return /* @__PURE__ */ React.createElement(
+    ApiContext.Provider,
+    {
+      value: createVersionedValueMap({ 1: holder }),
+      children
+    }
+  );
+};
+ApiProvider.propTypes = {
+  apis: PropTypes.shape({ get: PropTypes.func.isRequired }).isRequired,
+  children: PropTypes.node
+};
+
+export { ApiProvider };
+//# sourceMappingURL=ApiProvider.esm.js.map

package/dist/core-app-api/src/apis/system/ApiProvider.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiProvider.esm.js","sources":["../../../../../../core-app-api/src/apis/system/ApiProvider.tsx"],"sourcesContent":["/*\n * Copyright 2020 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, { useContext, ReactNode, PropsWithChildren } from 'react';\nimport PropTypes from 'prop-types';\nimport { ApiHolder } from '@backstage/core-plugin-api';\nimport { ApiAggregator } from './ApiAggregator';\nimport {\n  createVersionedValueMap,\n  createVersionedContext,\n} from '@backstage/version-bridge';\n\n/**\n * Prop types for the ApiProvider component.\n * @public\n */\nexport type ApiProviderProps = {\n  apis: ApiHolder;\n  children: ReactNode;\n};\n\nconst ApiContext = createVersionedContext<{ 1: ApiHolder }>('api-context');\n\n/**\n * Provides an {@link @backstage/core-plugin-api#ApiHolder} for consumption in\n * the React tree.\n *\n * @public\n */\nexport const ApiProvider = (props: PropsWithChildren<ApiProviderProps>) => {\n  const { apis, children } = props;\n  const parentHolder = useContext(ApiContext)?.atVersion(1);\n  const holder = parentHolder ? new ApiAggregator(apis, parentHolder) : apis;\n\n  return (\n    <ApiContext.Provider\n      value={createVersionedValueMap({ 1: holder })}\n      children={children}\n    />\n  );\n};\n\nApiProvider.propTypes = {\n  apis: PropTypes.shape({ get: PropTypes.func.isRequired }).isRequired,\n  children: PropTypes.node,\n};\n"],"names":[],"mappings":";;;;;AAkCA,MAAM,UAAA,GAAa,uBAAyC,aAAa,CAAA,CAAA;AAQ5D,MAAA,WAAA,GAAc,CAAC,KAA+C,KAAA;AACzE,EAAM,MAAA,EAAE,IAAM,EAAA,QAAA,EAAa,GAAA,KAAA,CAAA;AAC3B,EAAA,MAAM,YAAe,GAAA,UAAA,CAAW,UAAU,CAAA,EAAG,UAAU,CAAC,CAAA,CAAA;AACxD,EAAA,MAAM,SAAS,YAAe,GAAA,IAAI,aAAc,CAAA,IAAA,EAAM,YAAY,CAAI,GAAA,IAAA,CAAA;AAEtE,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,UAAW,CAAA,QAAA;AAAA,IAAX;AAAA,MACC,KAAO,EAAA,uBAAA,CAAwB,EAAE,CAAA,EAAG,QAAQ,CAAA;AAAA,MAC5C,QAAA;AAAA,KAAA;AAAA,GACF,CAAA;AAEJ,EAAA;AAEA,WAAA,CAAY,SAAY,GAAA;AAAA,EACtB,IAAA,EAAM,UAAU,KAAM,CAAA,EAAE,KAAK,SAAU,CAAA,IAAA,CAAK,UAAW,EAAC,CAAE,CAAA,UAAA;AAAA,EAC1D,UAAU,SAAU,CAAA,IAAA;AACtB,CAAA;;;;"}

package/dist/frontend-plugin-api/src/routing/ExternalRouteRef.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExternalRouteRef.esm.js","sources":["../../../../../frontend-plugin-api/src/routing/ExternalRouteRef.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { RouteRefImpl } from './RouteRef';\nimport { describeParentCallSite } from './describeParentCallSite';\nimport { AnyRouteRefParams } from './types';\n\n/**\n * Route descriptor, to be later bound to a concrete route by the app. Used to implement cross-plugin route references.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport interface ExternalRouteRef<\n  TParams extends AnyRouteRefParams = AnyRouteRefParams,\n  TOptional extends boolean = boolean,\n> {\n  readonly $$type: '@backstage/ExternalRouteRef';\n  readonly T: TParams;\n  readonly optional: TOptional;\n}\n\n/** @internal */\nexport interface InternalExternalRouteRef<\n  TParams extends AnyRouteRefParams = AnyRouteRefParams,\n  TOptional extends boolean = boolean,\n> extends ExternalRouteRef<TParams, TOptional> {\n  readonly version: 'v1';\n  getParams(): string[];\n  getDescription(): string;\n  getDefaultTarget(): string | undefined;\n\n  setId(id: string): void;\n}\n\n/** @internal */\nexport function toInternalExternalRouteRef<\n  TParams extends AnyRouteRefParams = AnyRouteRefParams,\n  TOptional extends boolean = boolean,\n>(\n  resource: ExternalRouteRef<TParams, TOptional>,\n): InternalExternalRouteRef<TParams, TOptional> {\n  const r = resource as InternalExternalRouteRef<TParams, TOptional>;\n  if (r.$$type !== '@backstage/ExternalRouteRef') {\n    throw new Error(`Invalid ExternalRouteRef, bad type '${r.$$type}'`);\n  }\n\n  return r;\n}\n\n/** @internal */\nexport function isExternalRouteRef(opaque: {\n  $$type: string;\n}): opaque is ExternalRouteRef {\n  return opaque.$$type === '@backstage/ExternalRouteRef';\n}\n\n/** @internal */\nclass ExternalRouteRefImpl\n  extends RouteRefImpl\n  implements InternalExternalRouteRef\n{\n  readonly $$type = '@backstage/ExternalRouteRef' as any;\n\n  constructor(\n    readonly optional: boolean,\n    readonly params: string[] = [],\n    readonly defaultTarget: string | undefined,\n    creationSite: string,\n  ) {\n    super(params, creationSite);\n  }\n\n  getDefaultTarget() {\n    return this.defaultTarget;\n  }\n}\n\n/**\n * Creates a route descriptor, to be later bound to a concrete route by the app. Used to implement cross-plugin route references.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @param options - Description of the route reference to be created.\n * @public\n */\nexport function createExternalRouteRef<\n  TParams extends { [param in TParamKeys]: string } | undefined = undefined,\n  TOptional extends boolean = false,\n  TParamKeys extends string = string,\n>(options?: {\n  /**\n   * The parameters that will be provided to the external route reference.\n   */\n  readonly params?: string extends TParamKeys\n    ? (keyof TParams)[]\n    : TParamKeys[];\n\n  /**\n   * Whether or not this route is optional, defaults to false.\n   *\n   * Optional external routes are not required to be bound in the app, and\n   * if they aren't, `useExternalRouteRef` will return `undefined`.\n   */\n  optional?: TOptional;\n\n  /**\n   * The route (typically in another plugin) that this should map to by default.\n   *\n   * The string is expected to be on the standard `<plugin id>.<route id>` form,\n   * for example `techdocs.docRoot`.\n   */\n  defaultTarget?: string;\n}): ExternalRouteRef<\n  keyof TParams extends never\n    ? undefined\n    : string extends TParamKeys\n    ? TParams\n    : { [param in TParamKeys]: string },\n  TOptional\n> {\n  return new ExternalRouteRefImpl(\n    Boolean(options?.optional),\n    options?.params as string[] | undefined,\n    options?.defaultTarget,\n    describeParentCallSite(),\n  ) as ExternalRouteRef<any, any>;\n}\n"],"names":[],"mappings":"AAoDO,SAAS,2BAId,QAC8C,EAAA;AAC9C,EAAA,MAAM,CAAI,GAAA,QAAA,CAAA;AACV,EAAI,IAAA,CAAA,CAAE,WAAW,6BAA+B,EAAA;AAC9C,IAAA,MAAM,IAAI,KAAA,CAAM,CAAuC,oCAAA,EAAA,CAAA,CAAE,MAAM,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACpE;AAEA,EAAO,OAAA,CAAA,CAAA;AACT;;;;"}
+{"version":3,"file":"ExternalRouteRef.esm.js","sources":["../../../../../frontend-plugin-api/src/routing/ExternalRouteRef.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { RouteRefImpl } from './RouteRef';\nimport { describeParentCallSite } from './describeParentCallSite';\nimport { AnyRouteRefParams } from './types';\n\n/**\n * Route descriptor, to be later bound to a concrete route by the app. Used to implement cross-plugin route references.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport interface ExternalRouteRef<\n  TParams extends AnyRouteRefParams = AnyRouteRefParams,\n> {\n  readonly $$type: '@backstage/ExternalRouteRef';\n  readonly T: TParams;\n}\n\n/** @internal */\nexport interface InternalExternalRouteRef<\n  TParams extends AnyRouteRefParams = AnyRouteRefParams,\n> extends ExternalRouteRef<TParams> {\n  readonly version: 'v1';\n  getParams(): string[];\n  getDescription(): string;\n  getDefaultTarget(): string | undefined;\n\n  setId(id: string): void;\n}\n\n/** @internal */\nexport function toInternalExternalRouteRef<\n  TParams extends AnyRouteRefParams = AnyRouteRefParams,\n>(resource: ExternalRouteRef<TParams>): InternalExternalRouteRef<TParams> {\n  const r = resource as InternalExternalRouteRef<TParams>;\n  if (r.$$type !== '@backstage/ExternalRouteRef') {\n    throw new Error(`Invalid ExternalRouteRef, bad type '${r.$$type}'`);\n  }\n\n  return r;\n}\n\n/** @internal */\nexport function isExternalRouteRef(opaque: {\n  $$type: string;\n}): opaque is ExternalRouteRef {\n  return opaque.$$type === '@backstage/ExternalRouteRef';\n}\n\n/** @internal */\nclass ExternalRouteRefImpl\n  extends RouteRefImpl\n  implements InternalExternalRouteRef\n{\n  readonly $$type = '@backstage/ExternalRouteRef' as any;\n\n  constructor(\n    readonly params: string[] = [],\n    readonly defaultTarget: string | undefined,\n    creationSite: string,\n  ) {\n    super(params, creationSite);\n  }\n\n  getDefaultTarget() {\n    return this.defaultTarget;\n  }\n}\n\n/**\n * Creates a route descriptor, to be later bound to a concrete route by the app. Used to implement cross-plugin route references.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @param options - Description of the route reference to be created.\n * @public\n */\nexport function createExternalRouteRef<\n  TParams extends { [param in TParamKeys]: string } | undefined = undefined,\n  TParamKeys extends string = string,\n>(options?: {\n  /**\n   * The parameters that will be provided to the external route reference.\n   */\n  readonly params?: string extends TParamKeys\n    ? (keyof TParams)[]\n    : TParamKeys[];\n\n  /**\n   * The route (typically in another plugin) that this should map to by default.\n   *\n   * The string is expected to be on the standard `<plugin id>.<route id>` form,\n   * for example `techdocs.docRoot`.\n   */\n  defaultTarget?: string;\n}): ExternalRouteRef<\n  keyof TParams extends never\n    ? undefined\n    : string extends TParamKeys\n    ? TParams\n    : { [param in TParamKeys]: string }\n> {\n  return new ExternalRouteRefImpl(\n    options?.params as string[] | undefined,\n    options?.defaultTarget,\n    describeParentCallSite(),\n  );\n}\n"],"names":[],"mappings":"AAiDO,SAAS,2BAEd,QAAwE,EAAA;AACxE,EAAA,MAAM,CAAI,GAAA,QAAA,CAAA;AACV,EAAI,IAAA,CAAA,CAAE,WAAW,6BAA+B,EAAA;AAC9C,IAAA,MAAM,IAAI,KAAA,CAAM,CAAuC,oCAAA,EAAA,CAAA,CAAE,MAAM,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACpE;AAEA,EAAO,OAAA,CAAA,CAAA;AACT;;;;"}

package/dist/index.d.ts

@@ -71,7 +71,7 @@ declare function convertLegacyApp(rootElement: React.JSX.Element): FrontendFeatu
  *
  * @public
  */
-type ToNewRouteRef<T extends RouteRef | SubRouteRef | ExternalRouteRef> = T extends RouteRef<infer IParams> ? RouteRef$1<IParams> : T extends SubRouteRef<infer IParams> ? SubRouteRef$1<IParams> : T extends ExternalRouteRef<infer IParams, infer IOptional> ? ExternalRouteRef$1<IParams, IOptional> : never;
+type ToNewRouteRef<T extends RouteRef | SubRouteRef | ExternalRouteRef> = T extends RouteRef<infer IParams> ? RouteRef$1<IParams> : T extends SubRouteRef<infer IParams> ? SubRouteRef$1<IParams> : T extends ExternalRouteRef<infer IParams> ? ExternalRouteRef$1<IParams> : never;
 /**
  * Converts a collection of legacy route refs to the new system.
  * This is particularly useful when defining plugin `routes` and `externalRoutes`.
@@ -109,6 +109,33 @@ declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: S
  *
  * In the future the legacy createExternalRouteRef will instead create refs compatible with both systems.
  */
-declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams, TOptional extends boolean>(ref: ExternalRouteRef<TParams, TOptional>): ExternalRouteRef$1<TParams, TOptional>;
+declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: ExternalRouteRef<TParams>): ExternalRouteRef$1<TParams>;
+/**
+ * A temporary helper to convert a new route ref to the legacy system.
+ *
+ * @public
+ * @remarks
+ *
+ * In the future the legacy createRouteRef will instead create refs compatible with both systems.
+ */
+declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: RouteRef$1<TParams>): RouteRef<TParams>;
+/**
+ * A temporary helper to convert a new sub route ref to the legacy system.
+ *
+ * @public
+ * @remarks
+ *
+ * In the future the legacy createSubRouteRef will instead create refs compatible with both systems.
+ */
+declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: SubRouteRef$1<TParams>): SubRouteRef<TParams>;
+/**
+ * A temporary helper to convert a new external route ref to the legacy system.
+ *
+ * @public
+ * @remarks
+ *
+ * In the future the legacy createExternalRouteRef will instead create refs compatible with both systems.
+ */
+declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: ExternalRouteRef$1<TParams>): ExternalRouteRef<TParams, true>;
 
 export { MultipleAnalyticsApi, NoOpAnalyticsApi, type ToNewRouteRef, compatWrapper, convertLegacyApp, convertLegacyRouteRef, convertLegacyRouteRefs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/core-compat-api",
-  "version": "0.2.8-next.1",
+  "version": "0.2.8-next.3",
   "backstage": {
     "role": "web-library"
   },
@@ -32,18 +32,19 @@
   },
   "dependencies": {
     "@backstage/core-plugin-api": "^1.9.3",
-    "@backstage/frontend-plugin-api": "^0.6.8-next.1",
+    "@backstage/frontend-plugin-api": "^0.7.0-next.3",
     "@backstage/version-bridge": "^1.0.8",
     "@types/react": "^16.13.1 || ^17.0.0"
   },
   "devDependencies": {
     "@backstage-community/plugin-puppetdb": "^0.1.18",
     "@backstage-community/plugin-stackstorm": "^0.1.16",
-    "@backstage/cli": "^0.27.0-next.1",
+    "@backstage/cli": "^0.27.0-next.4",
     "@backstage/core-app-api": "^1.14.2-next.0",
-    "@backstage/frontend-app-api": "^0.7.5-next.1",
-    "@backstage/frontend-test-utils": "^0.1.12-next.1",
-    "@backstage/plugin-catalog": "^1.21.2-next.1",
+    "@backstage/frontend-app-api": "^0.7.5-next.3",
+    "@backstage/frontend-test-utils": "^0.1.12-next.3",
+    "@backstage/plugin-catalog": "^1.22.0-next.3",
+    "@backstage/test-utils": "^1.5.10-next.2",
     "@oriflame/backstage-plugin-score-card": "^0.8.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^15.0.0"