@backstage/core-plugin-api 1.12.1-next.0 → 1.12.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @backstage/core-plugin-api
 
+## 1.12.2-next.0
+
+### Patch Changes
+
+- 53b6549: Plugins in the new frontend system now have a `pluginId` field rather than `id` to better align with naming conventions used throughout the frontend and backend systems. The old field is still present but marked as deprecated. All internal code has been updated to prefer `pluginId` while maintaining backward compatibility by falling back to `id` when needed.
+- 69d880e: Bump to latest zod to ensure it has the latest features
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.14.0-next.0
+  - @backstage/config@1.3.6
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.2
+  - @backstage/version-bridge@1.0.11
+
+## 1.12.1
+
+### Patch Changes
+
+- 358c6f7: The `useApp` and `useRouteRef` functions are now forwards compatible with the new frontend system. Along with the previous route reference changes this means that there is no longer a need to use `compatWrapper` from `@backstage/core-compat-api` to make code based on `@backstage/core-plugin-api` compatible with `@backstage/frontend-plugin-api` APIs.
+- 97cd16f: Reversed the relationship between the old `@backstage/core-plugin-api` and the new `@backstage/frontend-plugin-api`. Previously, the a lot of API definitions and utilities where defined in the old and re-exported from the old, but this change flips that around so that they now reside in the new package and are re-exported from the old. The external API of both packages remain the same, but this is a step towards being able to add further compatibility with the new frontend system built into the old.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.13.2
+
 ## 1.12.1-next.0
 
 ### Patch Changes

package/dist/app/useApp.esm.js

@@ -18,7 +18,7 @@ function toLegacyPlugin(plugin) {
   };
   legacy = {
     getId() {
-      return plugin.id;
+      return plugin.pluginId ?? plugin.id;
     },
     get routes() {
       return {};

package/dist/app/useApp.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"useApp.esm.js","sources":["../../src/app/useApp.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 { useMemo } from 'react';\nimport { useVersionedContext } from '@backstage/version-bridge';\nimport {\n  appTreeApiRef,\n  iconsApiRef,\n  useApiHolder,\n  ErrorDisplay,\n  NotFoundErrorPage,\n  Progress,\n  createFrontendPlugin,\n  FrontendPlugin,\n  ApiHolder,\n} from '@backstage/frontend-plugin-api';\nimport {\n  AppComponents,\n  IconComponent,\n  BackstagePlugin,\n} from '@backstage/core-plugin-api';\nimport { getOrCreateGlobalSingleton } from '@backstage/version-bridge';\nimport { AppContext as AppContextV1 } from './types';\n\nconst legacyPluginStore = getOrCreateGlobalSingleton(\n  'legacy-plugin-compatibility-store',\n  () => new WeakMap<FrontendPlugin, BackstagePlugin>(),\n);\n\nfunction toLegacyPlugin(plugin: FrontendPlugin): BackstagePlugin {\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\nfunction toNewPlugin(plugin: BackstagePlugin): FrontendPlugin {\n  return createFrontendPlugin({\n    pluginId: plugin.getId(),\n  });\n}\n\nfunction useOptionalApiHolder(): ApiHolder | undefined {\n  try {\n    return useApiHolder();\n  } catch {\n    return undefined;\n  }\n}\n\n/**\n * React hook providing {@link AppContext}.\n *\n * @public\n */\nexport const useApp = (): AppContextV1 => {\n  const apiHolder = useOptionalApiHolder();\n  const appTreeApi = apiHolder?.get(appTreeApiRef);\n  const iconsApi = apiHolder?.get(iconsApiRef);\n  const versionedContext = useVersionedContext<{ 1: AppContextV1 }>(\n    'app-context',\n  );\n\n  const newAppContext = useMemo<AppContextV1 | undefined>(() => {\n    if (!appTreeApi) {\n      return undefined;\n    }\n\n    if (!iconsApi) {\n      return undefined;\n    }\n\n    const { tree } = appTreeApi.getTree();\n\n    let gatheredPlugins: BackstagePlugin[] | undefined = undefined;\n\n    const ErrorBoundaryFallbackWrapper: AppComponents['ErrorBoundaryFallback'] =\n      ({ plugin, ...rest }) => (\n        <ErrorDisplay {...rest} plugin={plugin && toNewPlugin(plugin)} />\n      );\n\n    return {\n      getPlugins(): BackstagePlugin[] {\n        if (gatheredPlugins) {\n          return gatheredPlugins;\n        }\n\n        const pluginSet = new Set<BackstagePlugin>();\n        for (const node of tree.nodes.values()) {\n          const plugin = node.spec.plugin;\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: NotFoundErrorPage,\n          BootErrorPage() {\n            throw new Error(\n              'The BootErrorPage app component should not be accessed by plugins',\n            );\n          },\n          Progress: 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, iconsApi]);\n\n  if (newAppContext) {\n    return newAppContext;\n  }\n\n  if (!versionedContext) {\n    throw new Error('App context is not available');\n  }\n\n  const appContext = versionedContext.atVersion(1);\n  if (!appContext) {\n    throw new Error('AppContext v1 not available');\n  }\n  return appContext;\n};\n"],"names":[],"mappings":";;;;;AAqCA,MAAM,iBAAA,GAAoB,0BAAA;AAAA,EACxB,mCAAA;AAAA,EACA,0BAAU,OAAA;AACZ,CAAA;AAEA,SAAS,eAAe,MAAA,EAAyC;AAC/D,EAAA,IAAI,MAAA,GAAS,iBAAA,CAAkB,GAAA,CAAI,MAAM,CAAA;AACzC,EAAA,IAAI,MAAA,EAAQ;AACV,IAAA,OAAO,MAAA;AAAA,EACT;AAEA,EAAA,MAAM,QAAA,GAAW,sDAAA;AACjB,EAAA,MAAM,iBAAiB,MAAM;AAC3B,IAAA,MAAM,IAAI,MAAM,QAAQ,CAAA;AAAA,EAC1B,CAAA;AAEA,EAAA,MAAA,GAAS;AAAA,IACP,KAAA,GAAgB;AACd,MAAA,OAAO,MAAA,CAAO,EAAA;AAAA,IAChB,CAAA;AAAA,IACA,IAAI,MAAA,GAAS;AACX,MAAA,OAAO,EAAC;AAAA,IACV,CAAA;AAAA,IACA,IAAI,cAAA,GAAiB;AACnB,MAAA,OAAO,EAAC;AAAA,IACV,CAAA;AAAA,IACA,OAAA,EAAS,cAAA;AAAA,IACT,eAAA,EAAiB,cAAA;AAAA,IACjB,OAAA,EAAS;AAAA,GACX;AAEA,EAAA,iBAAA,CAAkB,GAAA,CAAI,QAAQ,MAAM,CAAA;AACpC,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,YAAY,MAAA,EAAyC;AAC5D,EAAA,OAAO,oBAAA,CAAqB;AAAA,IAC1B,QAAA,EAAU,OAAO,KAAA;AAAM,GACxB,CAAA;AACH;AAEA,SAAS,oBAAA,GAA8C;AACrD,EAAA,IAAI;AACF,IAAA,OAAO,YAAA,EAAa;AAAA,EACtB,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,MAAA;AAAA,EACT;AACF;AAOO,MAAM,SAAS,MAAoB;AACxC,EAAA,MAAM,YAAY,oBAAA,EAAqB;AACvC,EAAA,MAAM,UAAA,GAAa,SAAA,EAAW,GAAA,CAAI,aAAa,CAAA;AAC/C,EAAA,MAAM,QAAA,GAAW,SAAA,EAAW,GAAA,CAAI,WAAW,CAAA;AAC3C,EAAA,MAAM,gBAAA,GAAmB,mBAAA;AAAA,IACvB;AAAA,GACF;AAEA,EAAA,MAAM,aAAA,GAAgB,QAAkC,MAAM;AAC5D,IAAA,IAAI,CAAC,UAAA,EAAY;AACf,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,IAAI,CAAC,QAAA,EAAU;AACb,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,UAAA,CAAW,OAAA,EAAQ;AAEpC,IAAA,IAAI,eAAA,GAAiD,MAAA;AAErD,IAAA,MAAM,4BAAA,GACJ,CAAC,EAAE,MAAA,EAAQ,GAAG,IAAA,EAAK,qBACjB,GAAA,CAAC,YAAA,EAAA,EAAc,GAAG,IAAA,EAAM,MAAA,EAAQ,MAAA,IAAU,WAAA,CAAY,MAAM,CAAA,EAAG,CAAA;AAGnE,IAAA,OAAO;AAAA,MACL,UAAA,GAAgC;AAC9B,QAAA,IAAI,eAAA,EAAiB;AACnB,UAAA,OAAO,eAAA;AAAA,QACT;AAEA,QAAA,MAAM,SAAA,uBAAgB,GAAA,EAAqB;AAC3C,QAAA,KAAA,MAAW,IAAA,IAAQ,IAAA,CAAK,KAAA,CAAM,MAAA,EAAO,EAAG;AACtC,UAAA,MAAM,MAAA,GAAS,KAAK,IAAA,CAAK,MAAA;AACzB,UAAA,IAAI,MAAA,EAAQ;AACV,YAAA,SAAA,CAAU,GAAA,CAAI,cAAA,CAAe,MAAM,CAAC,CAAA;AAAA,UACtC;AAAA,QACF;AACA,QAAA,eAAA,GAAkB,KAAA,CAAM,KAAK,SAAS,CAAA;AAEtC,QAAA,OAAO,eAAA;AAAA,MACT,CAAA;AAAA,MAEA,cAAc,GAAA,EAAwC;AACpD,QAAA,OAAO,QAAA,CAAS,QAAQ,GAAG,CAAA;AAAA,MAC7B,CAAA;AAAA,MAEA,cAAA,GAAgD;AAC9C,QAAA,OAAO,MAAA,CAAO,WAAA;AAAA,UACZ,QAAA,CAAS,YAAA,EAAa,CAAE,GAAA,CAAI,CAAA,GAAA,KAAO,CAAC,GAAA,EAAK,QAAA,CAAS,OAAA,CAAQ,GAAG,CAAE,CAAC;AAAA,SAClE;AAAA,MACF,CAAA;AAAA,MAEA,aAAA,GAA+B;AAC7B,QAAA,OAAO;AAAA,UACL,iBAAA;AAAA,UACA,aAAA,GAAgB;AACd,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA,UACF,CAAA;AAAA,UACA,QAAA;AAAA,UACA,MAAA,GAAS;AACP,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA,UACF,CAAA;AAAA,UACA,qBAAA,EAAuB;AAAA,SACzB;AAAA,MACF;AAAA,KACF;AAAA,EACF,CAAA,EAAG,CAAC,UAAA,EAAY,QAAQ,CAAC,CAAA;AAEzB,EAAA,IAAI,aAAA,EAAe;AACjB,IAAA,OAAO,aAAA;AAAA,EACT;AAEA,EAAA,IAAI,CAAC,gBAAA,EAAkB;AACrB,IAAA,MAAM,IAAI,MAAM,8BAA8B,CAAA;AAAA,EAChD;AAEA,EAAA,MAAM,UAAA,GAAa,gBAAA,CAAiB,SAAA,CAAU,CAAC,CAAA;AAC/C,EAAA,IAAI,CAAC,UAAA,EAAY;AACf,IAAA,MAAM,IAAI,MAAM,6BAA6B,CAAA;AAAA,EAC/C;AACA,EAAA,OAAO,UAAA;AACT;;;;"}
+{"version":3,"file":"useApp.esm.js","sources":["../../src/app/useApp.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 { useMemo } from 'react';\nimport { useVersionedContext } from '@backstage/version-bridge';\nimport {\n  appTreeApiRef,\n  iconsApiRef,\n  useApiHolder,\n  ErrorDisplay,\n  NotFoundErrorPage,\n  Progress,\n  createFrontendPlugin,\n  FrontendPlugin,\n  ApiHolder,\n} from '@backstage/frontend-plugin-api';\nimport {\n  AppComponents,\n  IconComponent,\n  BackstagePlugin,\n} from '@backstage/core-plugin-api';\nimport { getOrCreateGlobalSingleton } from '@backstage/version-bridge';\nimport { AppContext as AppContextV1 } from './types';\n\nconst legacyPluginStore = getOrCreateGlobalSingleton(\n  'legacy-plugin-compatibility-store',\n  () => new WeakMap<FrontendPlugin, BackstagePlugin>(),\n);\n\nfunction toLegacyPlugin(plugin: FrontendPlugin): BackstagePlugin {\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.pluginId ?? 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\nfunction toNewPlugin(plugin: BackstagePlugin): FrontendPlugin {\n  return createFrontendPlugin({\n    pluginId: plugin.getId(),\n  });\n}\n\nfunction useOptionalApiHolder(): ApiHolder | undefined {\n  try {\n    return useApiHolder();\n  } catch {\n    return undefined;\n  }\n}\n\n/**\n * React hook providing {@link AppContext}.\n *\n * @public\n */\nexport const useApp = (): AppContextV1 => {\n  const apiHolder = useOptionalApiHolder();\n  const appTreeApi = apiHolder?.get(appTreeApiRef);\n  const iconsApi = apiHolder?.get(iconsApiRef);\n  const versionedContext = useVersionedContext<{ 1: AppContextV1 }>(\n    'app-context',\n  );\n\n  const newAppContext = useMemo<AppContextV1 | undefined>(() => {\n    if (!appTreeApi) {\n      return undefined;\n    }\n\n    if (!iconsApi) {\n      return undefined;\n    }\n\n    const { tree } = appTreeApi.getTree();\n\n    let gatheredPlugins: BackstagePlugin[] | undefined = undefined;\n\n    const ErrorBoundaryFallbackWrapper: AppComponents['ErrorBoundaryFallback'] =\n      ({ plugin, ...rest }) => (\n        <ErrorDisplay {...rest} plugin={plugin && toNewPlugin(plugin)} />\n      );\n\n    return {\n      getPlugins(): BackstagePlugin[] {\n        if (gatheredPlugins) {\n          return gatheredPlugins;\n        }\n\n        const pluginSet = new Set<BackstagePlugin>();\n        for (const node of tree.nodes.values()) {\n          const plugin = node.spec.plugin;\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: NotFoundErrorPage,\n          BootErrorPage() {\n            throw new Error(\n              'The BootErrorPage app component should not be accessed by plugins',\n            );\n          },\n          Progress: 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, iconsApi]);\n\n  if (newAppContext) {\n    return newAppContext;\n  }\n\n  if (!versionedContext) {\n    throw new Error('App context is not available');\n  }\n\n  const appContext = versionedContext.atVersion(1);\n  if (!appContext) {\n    throw new Error('AppContext v1 not available');\n  }\n  return appContext;\n};\n"],"names":[],"mappings":";;;;;AAqCA,MAAM,iBAAA,GAAoB,0BAAA;AAAA,EACxB,mCAAA;AAAA,EACA,0BAAU,OAAA;AACZ,CAAA;AAEA,SAAS,eAAe,MAAA,EAAyC;AAC/D,EAAA,IAAI,MAAA,GAAS,iBAAA,CAAkB,GAAA,CAAI,MAAM,CAAA;AACzC,EAAA,IAAI,MAAA,EAAQ;AACV,IAAA,OAAO,MAAA;AAAA,EACT;AAEA,EAAA,MAAM,QAAA,GAAW,sDAAA;AACjB,EAAA,MAAM,iBAAiB,MAAM;AAC3B,IAAA,MAAM,IAAI,MAAM,QAAQ,CAAA;AAAA,EAC1B,CAAA;AAEA,EAAA,MAAA,GAAS;AAAA,IACP,KAAA,GAAgB;AACd,MAAA,OAAO,MAAA,CAAO,YAAY,MAAA,CAAO,EAAA;AAAA,IACnC,CAAA;AAAA,IACA,IAAI,MAAA,GAAS;AACX,MAAA,OAAO,EAAC;AAAA,IACV,CAAA;AAAA,IACA,IAAI,cAAA,GAAiB;AACnB,MAAA,OAAO,EAAC;AAAA,IACV,CAAA;AAAA,IACA,OAAA,EAAS,cAAA;AAAA,IACT,eAAA,EAAiB,cAAA;AAAA,IACjB,OAAA,EAAS;AAAA,GACX;AAEA,EAAA,iBAAA,CAAkB,GAAA,CAAI,QAAQ,MAAM,CAAA;AACpC,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,YAAY,MAAA,EAAyC;AAC5D,EAAA,OAAO,oBAAA,CAAqB;AAAA,IAC1B,QAAA,EAAU,OAAO,KAAA;AAAM,GACxB,CAAA;AACH;AAEA,SAAS,oBAAA,GAA8C;AACrD,EAAA,IAAI;AACF,IAAA,OAAO,YAAA,EAAa;AAAA,EACtB,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,MAAA;AAAA,EACT;AACF;AAOO,MAAM,SAAS,MAAoB;AACxC,EAAA,MAAM,YAAY,oBAAA,EAAqB;AACvC,EAAA,MAAM,UAAA,GAAa,SAAA,EAAW,GAAA,CAAI,aAAa,CAAA;AAC/C,EAAA,MAAM,QAAA,GAAW,SAAA,EAAW,GAAA,CAAI,WAAW,CAAA;AAC3C,EAAA,MAAM,gBAAA,GAAmB,mBAAA;AAAA,IACvB;AAAA,GACF;AAEA,EAAA,MAAM,aAAA,GAAgB,QAAkC,MAAM;AAC5D,IAAA,IAAI,CAAC,UAAA,EAAY;AACf,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,IAAI,CAAC,QAAA,EAAU;AACb,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,UAAA,CAAW,OAAA,EAAQ;AAEpC,IAAA,IAAI,eAAA,GAAiD,MAAA;AAErD,IAAA,MAAM,4BAAA,GACJ,CAAC,EAAE,MAAA,EAAQ,GAAG,IAAA,EAAK,qBACjB,GAAA,CAAC,YAAA,EAAA,EAAc,GAAG,IAAA,EAAM,MAAA,EAAQ,MAAA,IAAU,WAAA,CAAY,MAAM,CAAA,EAAG,CAAA;AAGnE,IAAA,OAAO;AAAA,MACL,UAAA,GAAgC;AAC9B,QAAA,IAAI,eAAA,EAAiB;AACnB,UAAA,OAAO,eAAA;AAAA,QACT;AAEA,QAAA,MAAM,SAAA,uBAAgB,GAAA,EAAqB;AAC3C,QAAA,KAAA,MAAW,IAAA,IAAQ,IAAA,CAAK,KAAA,CAAM,MAAA,EAAO,EAAG;AACtC,UAAA,MAAM,MAAA,GAAS,KAAK,IAAA,CAAK,MAAA;AACzB,UAAA,IAAI,MAAA,EAAQ;AACV,YAAA,SAAA,CAAU,GAAA,CAAI,cAAA,CAAe,MAAM,CAAC,CAAA;AAAA,UACtC;AAAA,QACF;AACA,QAAA,eAAA,GAAkB,KAAA,CAAM,KAAK,SAAS,CAAA;AAEtC,QAAA,OAAO,eAAA;AAAA,MACT,CAAA;AAAA,MAEA,cAAc,GAAA,EAAwC;AACpD,QAAA,OAAO,QAAA,CAAS,QAAQ,GAAG,CAAA;AAAA,MAC7B,CAAA;AAAA,MAEA,cAAA,GAAgD;AAC9C,QAAA,OAAO,MAAA,CAAO,WAAA;AAAA,UACZ,QAAA,CAAS,YAAA,EAAa,CAAE,GAAA,CAAI,CAAA,GAAA,KAAO,CAAC,GAAA,EAAK,QAAA,CAAS,OAAA,CAAQ,GAAG,CAAE,CAAC;AAAA,SAClE;AAAA,MACF,CAAA;AAAA,MAEA,aAAA,GAA+B;AAC7B,QAAA,OAAO;AAAA,UACL,iBAAA;AAAA,UACA,aAAA,GAAgB;AACd,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA,UACF,CAAA;AAAA,UACA,QAAA;AAAA,UACA,MAAA,GAAS;AACP,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA,UACF,CAAA;AAAA,UACA,qBAAA,EAAuB;AAAA,SACzB;AAAA,MACF;AAAA,KACF;AAAA,EACF,CAAA,EAAG,CAAC,UAAA,EAAY,QAAQ,CAAC,CAAA;AAEzB,EAAA,IAAI,aAAA,EAAe;AACjB,IAAA,OAAO,aAAA;AAAA,EACT;AAEA,EAAA,IAAI,CAAC,gBAAA,EAAkB;AACrB,IAAA,MAAM,IAAI,MAAM,8BAA8B,CAAA;AAAA,EAChD;AAEA,EAAA,MAAM,UAAA,GAAa,gBAAA,CAAiB,SAAA,CAAU,CAAC,CAAA;AAC/C,EAAA,IAAI,CAAC,UAAA,EAAY;AACf,IAAA,MAAM,IAAI,MAAM,6BAA6B,CAAA;AAAA,EAC/C;AACA,EAAA,OAAO,UAAA;AACT;;;;"}

package/dist/index.d.ts

@@ -775,4 +775,5 @@ interface ElementCollection {
  */
 declare function useElementFilter<T>(node: ReactNode, filterFn: (arg: ElementCollection) => T, dependencies?: any[]): T;
 
-export { type AnalyticsApi, AnalyticsContext, type AnalyticsContextValue, type AnalyticsEvent, type AnalyticsEventAttributes, type AnalyticsTracker, type AnyExternalRoutes, type AnyParams, type AnyRouteRefParams, type AnyRoutes, type AppComponents, type AppContext, type BackstagePlugin, type BootErrorPageProps, type CommonAnalyticsContext, type ComponentLoader, type ElementCollection, type ErrorBoundaryFallbackProps, type Extension, type ExternalRouteRef, type FeatureFlagsHooks, type MakeSubRouteRef, type MergeParams, type OptionalParams, type ParamKeys, type ParamNames, type ParamPart, type PathParams, type PluginConfig, type PluginFeatureFlagConfig, type RouteFunc, type RouteRef, type SignInPageProps, type SubRouteRef, analyticsApiRef, attachComponentData, createComponentExtension, createExternalRouteRef, createPlugin, createReactExtension, createRoutableExtension, createRouteRef, createSubRouteRef, getComponentData, useAnalytics, useApp, useElementFilter, useRouteRef, useRouteRefParams };
+export { AnalyticsContext, analyticsApiRef, attachComponentData, createComponentExtension, createExternalRouteRef, createPlugin, createReactExtension, createRoutableExtension, createRouteRef, createSubRouteRef, getComponentData, useAnalytics, useApp, useElementFilter, useRouteRef, useRouteRefParams };
+export type { AnalyticsApi, AnalyticsContextValue, AnalyticsEvent, AnalyticsEventAttributes, AnalyticsTracker, AnyExternalRoutes, AnyParams, AnyRouteRefParams, AnyRoutes, AppComponents, AppContext, BackstagePlugin, BootErrorPageProps, CommonAnalyticsContext, ComponentLoader, ElementCollection, ErrorBoundaryFallbackProps, Extension, ExternalRouteRef, FeatureFlagsHooks, MakeSubRouteRef, MergeParams, OptionalParams, ParamKeys, ParamNames, ParamPart, PathParams, PluginConfig, PluginFeatureFlagConfig, RouteFunc, RouteRef, SignInPageProps, SubRouteRef };

package/dist/routing/types.esm.js

@@ -2,7 +2,7 @@ import { getOrCreateGlobalSingleton } from '@backstage/version-bridge';
 
 const routeRefType = getOrCreateGlobalSingleton(
   "route-ref-type",
-  () => Symbol("route-ref-type")
+  () => /* @__PURE__ */ Symbol("route-ref-type")
 );
 
 export { routeRefType };

package/dist/routing/types.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.esm.js","sources":["../../src/routing/types.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 { getOrCreateGlobalSingleton } from '@backstage/version-bridge';\n\n/**\n * Catch-all type for route params.\n *\n * @public\n */\nexport type AnyRouteRefParams = { [param in string]: string } | undefined;\n\n/**\n * @deprecated use {@link AnyRouteRefParams} instead\n * @public\n */\nexport type AnyParams = AnyRouteRefParams;\n\n/**\n * Type describing the key type of a route parameter mapping.\n *\n * @public\n * @deprecated this type is deprecated and will be removed in the future\n */\nexport type ParamKeys<Params extends AnyParams> = [AnyRouteRefParams] extends [\n  Params,\n]\n  ? string[]\n  : keyof Params extends never\n  ? []\n  : Array<keyof Params>;\n\n/**\n * Optional route params.\n *\n * @public\n * @deprecated this type is deprecated and will be removed in the future\n */\nexport type OptionalParams<Params extends { [param in string]: string }> =\n  Params[keyof Params] extends never ? undefined : Params;\n\n/**\n * TS magic for handling route parameters.\n *\n * @remarks\n *\n * The extra TS magic here is to require a single params argument if the RouteRef\n * had at least one param defined, but require 0 arguments if there are no params defined.\n * Without this we'd have to pass in empty object to all parameter-less RouteRefs\n * just to make TypeScript happy, or we would have to make the argument optional in\n * which case you might forget to pass it in when it is actually required.\n *\n * @public\n */\nexport type RouteFunc<Params extends AnyParams> = (\n  ...[params]: Params extends undefined ? readonly [] : readonly [Params]\n) => string;\n\n/**\n * This symbol is what we use at runtime to determine whether a given object\n * is a type of RouteRef or not. It doesn't work well in TypeScript though since\n * the `unique symbol` will refer to different values between package versions.\n * For that reason we use the marker $$routeRefType to represent the symbol at\n * compile-time instead of using the symbol directly.\n *\n * @internal\n */\nexport const routeRefType: unique symbol = getOrCreateGlobalSingleton<any>(\n  'route-ref-type',\n  () => Symbol('route-ref-type'),\n);\n\n/**\n * Absolute route reference.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport type RouteRef<Params extends AnyParams = any> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'absolute'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/RouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\n\n/**\n * Descriptor of a route relative to an absolute {@link RouteRef}.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport type SubRouteRef<Params extends AnyParams = any> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'sub'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  parent: RouteRef;\n\n  path: string;\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/SubRouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\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 type ExternalRouteRef<\n  Params extends AnyParams = any,\n  Optional extends boolean = any,\n> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'external'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  optional?: Optional;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/ExternalRouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\n\n/**\n * @internal\n */\nexport type AnyRouteRef =\n  | RouteRef<any>\n  | SubRouteRef<any>\n  | ExternalRouteRef<any, any>;\n\n/**\n * A duplicate of the react-router RouteObject, but with routeRef added\n * @internal\n */\nexport interface BackstageRouteObject {\n  caseSensitive: boolean;\n  children?: BackstageRouteObject[];\n  element: React.ReactNode;\n  path: string;\n  routeRefs: Set<RouteRef>;\n}\n"],"names":[],"mappings":";;AAgFO,MAAM,YAAA,GAA8B,0BAAA;AAAA,EACzC,gBAAA;AAAA,EACA,MAAM,OAAO,gBAAgB;AAC/B;;;;"}
+{"version":3,"file":"types.esm.js","sources":["../../src/routing/types.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 { getOrCreateGlobalSingleton } from '@backstage/version-bridge';\n\n/**\n * Catch-all type for route params.\n *\n * @public\n */\nexport type AnyRouteRefParams = { [param in string]: string } | undefined;\n\n/**\n * @deprecated use {@link AnyRouteRefParams} instead\n * @public\n */\nexport type AnyParams = AnyRouteRefParams;\n\n/**\n * Type describing the key type of a route parameter mapping.\n *\n * @public\n * @deprecated this type is deprecated and will be removed in the future\n */\nexport type ParamKeys<Params extends AnyParams> = [AnyRouteRefParams] extends [\n  Params,\n]\n  ? string[]\n  : keyof Params extends never\n  ? []\n  : Array<keyof Params>;\n\n/**\n * Optional route params.\n *\n * @public\n * @deprecated this type is deprecated and will be removed in the future\n */\nexport type OptionalParams<Params extends { [param in string]: string }> =\n  Params[keyof Params] extends never ? undefined : Params;\n\n/**\n * TS magic for handling route parameters.\n *\n * @remarks\n *\n * The extra TS magic here is to require a single params argument if the RouteRef\n * had at least one param defined, but require 0 arguments if there are no params defined.\n * Without this we'd have to pass in empty object to all parameter-less RouteRefs\n * just to make TypeScript happy, or we would have to make the argument optional in\n * which case you might forget to pass it in when it is actually required.\n *\n * @public\n */\nexport type RouteFunc<Params extends AnyParams> = (\n  ...[params]: Params extends undefined ? readonly [] : readonly [Params]\n) => string;\n\n/**\n * This symbol is what we use at runtime to determine whether a given object\n * is a type of RouteRef or not. It doesn't work well in TypeScript though since\n * the `unique symbol` will refer to different values between package versions.\n * For that reason we use the marker $$routeRefType to represent the symbol at\n * compile-time instead of using the symbol directly.\n *\n * @internal\n */\nexport const routeRefType: unique symbol = getOrCreateGlobalSingleton<any>(\n  'route-ref-type',\n  () => Symbol('route-ref-type'),\n);\n\n/**\n * Absolute route reference.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport type RouteRef<Params extends AnyParams = any> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'absolute'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/RouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\n\n/**\n * Descriptor of a route relative to an absolute {@link RouteRef}.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport type SubRouteRef<Params extends AnyParams = any> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'sub'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  parent: RouteRef;\n\n  path: string;\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/SubRouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\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 type ExternalRouteRef<\n  Params extends AnyParams = any,\n  Optional extends boolean = any,\n> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'external'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  optional?: Optional;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/ExternalRouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\n\n/**\n * @internal\n */\nexport type AnyRouteRef =\n  | RouteRef<any>\n  | SubRouteRef<any>\n  | ExternalRouteRef<any, any>;\n\n/**\n * A duplicate of the react-router RouteObject, but with routeRef added\n * @internal\n */\nexport interface BackstageRouteObject {\n  caseSensitive: boolean;\n  children?: BackstageRouteObject[];\n  element: React.ReactNode;\n  path: string;\n  routeRefs: Set<RouteRef>;\n}\n"],"names":[],"mappings":";;AAgFO,MAAM,YAAA,GAA8B,0BAAA;AAAA,EACzC,gBAAA;AAAA,EACA,6BAAa,gBAAgB;AAC/B;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/core-plugin-api",
-  "version": "1.12.1-next.0",
+  "version": "1.12.2-next.0",
   "description": "Core API used by Backstage plugins",
   "backstage": {
     "role": "web-library"
@@ -59,16 +59,16 @@
   "dependencies": {
     "@backstage/config": "1.3.6",
     "@backstage/errors": "1.2.7",
-    "@backstage/frontend-plugin-api": "0.13.2-next.0",
+    "@backstage/frontend-plugin-api": "0.14.0-next.0",
     "@backstage/types": "1.2.2",
     "@backstage/version-bridge": "1.0.11",
     "history": "^5.0.0",
-    "zod": "^3.22.4"
+    "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@backstage/cli": "0.34.6-next.0",
-    "@backstage/core-app-api": "1.19.3-next.0",
-    "@backstage/test-utils": "1.7.14-next.0",
+    "@backstage/cli": "0.35.3-next.0",
+    "@backstage/core-app-api": "1.19.4-next.0",
+    "@backstage/test-utils": "1.7.15-next.0",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",