@backstage/frontend-app-api 0.16.2 → 0.16.3-next.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @backstage/frontend-app-api
 
+## 0.16.3-next.0
+
+### Patch Changes
+
+- f79eaf2: Internal cleanup of routing utilities.
+- Updated dependencies
+  - @backstage/errors@1.3.1-next.0
+  - @backstage/frontend-plugin-api@0.17.0-next.0
+  - @backstage/frontend-defaults@0.5.2-next.0
+  - @backstage/core-app-api@1.20.1-next.0
+  - @backstage/config@1.3.8-next.0
+  - @backstage/core-plugin-api@1.12.6-next.0
+  - @backstage/filter-predicates@0.1.3-next.0
+  - @backstage/types@1.2.2
+  - @backstage/version-bridge@1.0.12
+
 ## 0.16.2
 
 ### Patch Changes

package/dist/routing/RouteResolver.esm.js

@@ -1,16 +1,10 @@
 import { generatePath, matchRoutes } from 'react-router-dom';
 import mapValues from 'lodash/mapValues';
+import { joinPaths } from './joinPaths.esm.js';
 import { OpaqueExternalRouteRef } from '../frontend-internal/src/routing/OpaqueExternalRouteRef.esm.js';
 import { OpaqueRouteRef } from '../frontend-internal/src/routing/OpaqueRouteRef.esm.js';
 import { OpaqueSubRouteRef } from '../frontend-internal/src/routing/OpaqueSubRouteRef.esm.js';
 
-function joinPaths(...paths) {
-  const normalized = paths.join("/").replace(/\/\/+/g, "/");
-  if (normalized !== "/" && normalized.endsWith("/")) {
-    return normalized.slice(0, -1);
-  }
-  return normalized;
-}
 function resolveTargetRef(targetRouteRef, routePaths, routeBindings, routeRefsById) {
   let ref = targetRouteRef;
   let path = "";
@@ -133,5 +127,5 @@ class RouteResolver {
   }
 }
 
-export { RouteResolver, joinPaths };
+export { RouteResolver };
 //# sourceMappingURL=RouteResolver.esm.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"RouteResolver.esm.js","sources":["../../src/routing/RouteResolver.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 { generatePath, matchRoutes } from 'react-router-dom';\nimport {\n  RouteRef,\n  ExternalRouteRef,\n  SubRouteRef,\n  AnyRouteRefParams,\n  RouteFunc,\n  RouteResolutionApi,\n} from '@backstage/frontend-plugin-api';\nimport mapValues from 'lodash/mapValues';\nimport { AnyRouteRef, BackstageRouteObject } from './types';\nimport {\n  OpaqueRouteRef,\n  OpaqueExternalRouteRef,\n  OpaqueSubRouteRef,\n} from '@internal/frontend';\nimport { RouteAliasResolver } from './RouteAliasResolver';\n\n// Joins a list of paths together, avoiding trailing and duplicate slashes\nexport function joinPaths(...paths: string[]): string {\n  const normalized = paths.join('/').replace(/\\/\\/+/g, '/');\n  if (normalized !== '/' && normalized.endsWith('/')) {\n    return normalized.slice(0, -1);\n  }\n  return normalized;\n}\n\n/**\n * Resolves the absolute route ref that our target route ref is pointing pointing to, as well\n * as the relative target path.\n *\n * Returns an undefined target ref if one could not be fully resolved.\n */\nfunction resolveTargetRef(\n  targetRouteRef: AnyRouteRef,\n  routePaths: Map<RouteRef, string>,\n  routeBindings: Map<AnyRouteRef, AnyRouteRef | undefined>,\n  routeRefsById: Map<string, RouteRef | SubRouteRef>,\n): readonly [RouteRef | undefined, string] {\n  // First we figure out which absolute route ref we're dealing with, an if there was an sub route path to append.\n  // For sub routes it will be the parent path, while for external routes it will be the bound route.\n  let ref: AnyRouteRef = targetRouteRef;\n  let path = '';\n\n  if (OpaqueExternalRouteRef.isType(ref)) {\n    let resolvedRoute = routeBindings.get(ref);\n    if (!resolvedRoute) {\n      const internal = OpaqueExternalRouteRef.toInternal(ref);\n      const defaultTarget = internal.getDefaultTarget();\n      if (defaultTarget) {\n        resolvedRoute = routeRefsById.get(defaultTarget);\n      }\n    }\n    if (!resolvedRoute) {\n      return [undefined, ''];\n    }\n    ref = resolvedRoute;\n  }\n\n  if (OpaqueSubRouteRef.isType(ref)) {\n    const internal = OpaqueSubRouteRef.toInternal(ref);\n    path = ref.path;\n    ref = internal.getParent();\n  }\n\n  if (!OpaqueRouteRef.isType(ref)) {\n    throw new Error(\n      `Unexpectedly resolved ${targetRouteRef} to a non-route ref ${ref}`,\n    );\n  }\n\n  // Find the path that our target route is bound to\n  const resolvedPath = routePaths.get(ref);\n  if (resolvedPath === undefined) {\n    return [undefined, ''];\n  }\n\n  return [ref, path ? joinPaths(resolvedPath, path) : resolvedPath];\n}\n\n/**\n * Resolves the complete base path for navigating to the target RouteRef.\n */\nfunction resolveBasePath(\n  targetRef: RouteRef,\n  sourceLocation: Parameters<typeof matchRoutes>[1],\n  routePaths: Map<RouteRef, string>,\n  routeParents: Map<RouteRef, RouteRef | undefined>,\n  routeObjects: BackstageRouteObject[],\n) {\n  // While traversing the app element tree we build up the routeObjects structure\n  // used here. It is the same kind of structure that react-router creates, with the\n  // addition that associated route refs are stored throughout the tree. This lets\n  // us look up all route refs that can be reached from our source location.\n  // Because of the similar route object structure, we can use `matchRoutes` from\n  // react-router to do the lookup of our current location.\n  const match = matchRoutes(routeObjects, sourceLocation) ?? [];\n\n  // While we search for a common routing root between our current location and\n  // the target route, we build a list of all route refs we find that we need\n  // to traverse to reach the target.\n  const refDiffList = Array<RouteRef>();\n\n  let matchIndex = -1;\n  for (\n    let targetSearchRef: RouteRef | undefined = targetRef;\n    targetSearchRef;\n    targetSearchRef = routeParents.get(targetSearchRef)\n  ) {\n    // The match contains a list of all ancestral route refs present at our current location\n    // Starting at the desired target ref and traversing back through its parents, we search\n    // for a target ref that is present in the match for our current location. When a match\n    // is found it means we have found a common base to resolve the route from.\n    matchIndex = match.findIndex(m =>\n      (m.route as BackstageRouteObject).routeRefs.has(targetSearchRef!),\n    );\n    if (matchIndex !== -1) {\n      break;\n    }\n\n    // Every time we move a step up in the ancestry of the target ref, we add the current ref\n    // to the diff list, which ends up being the list of route refs to traverse form the common base\n    // in order to reach our target.\n    refDiffList.unshift(targetSearchRef);\n  }\n\n  // If our target route is present in the initial match we need to construct the final path\n  // from the parent of the matched route segment. That's to allow the caller of the route\n  // function to supply their own params.\n  if (refDiffList.length === 0) {\n    matchIndex -= 1;\n  }\n\n  // This is the part of the route tree that the target and source locations have in common.\n  // We re-use the existing pathname directly along with all params.\n  const parentPath = matchIndex === -1 ? '' : match[matchIndex].pathname;\n\n  // This constructs the mid section of the path using paths resolved from all route refs\n  // we need to traverse to reach our target except for the very last one. None of these\n  // paths are allowed to require any parameters, as the caller would have no way of knowing\n  // what parameters those are.\n  const diffPaths = refDiffList.slice(0, -1).map(ref => {\n    const path = routePaths.get(ref);\n    if (path === undefined) {\n      throw new Error(`No path for ${ref}`);\n    }\n    if (path.includes(':')) {\n      throw new Error(\n        `Cannot route to ${targetRef} with parent ${ref} as it has parameters`,\n      );\n    }\n    return path;\n  });\n\n  return `${joinPaths(parentPath, ...diffPaths)}/`;\n}\n\nexport class RouteResolver implements RouteResolutionApi {\n  private readonly routePaths: Map<RouteRef, string>;\n  private readonly routeParents: Map<RouteRef, RouteRef | undefined>;\n  private readonly routeObjects: BackstageRouteObject[];\n  private readonly routeBindings: Map<ExternalRouteRef, RouteRef | SubRouteRef>;\n  private readonly appBasePath: string; // base path without a trailing slash\n  private readonly routeAliasResolver: RouteAliasResolver;\n  private readonly routeRefsById: Map<string, RouteRef | SubRouteRef>;\n\n  constructor(\n    routePaths: Map<RouteRef, string>,\n    routeParents: Map<RouteRef, RouteRef | undefined>,\n    routeObjects: BackstageRouteObject[],\n    routeBindings: Map<ExternalRouteRef, RouteRef | SubRouteRef>,\n    appBasePath: string, // base path without a trailing slash\n    routeAliasResolver: RouteAliasResolver,\n    routeRefsById: Map<string, RouteRef | SubRouteRef>,\n  ) {\n    this.routePaths = routePaths;\n    this.routeParents = routeParents;\n    this.routeObjects = routeObjects;\n    this.routeBindings = routeBindings;\n    this.appBasePath = appBasePath;\n    this.routeAliasResolver = routeAliasResolver;\n    this.routeRefsById = routeRefsById;\n  }\n\n  resolve<TParams extends AnyRouteRefParams>(\n    anyRouteRef:\n      | RouteRef<TParams>\n      | SubRouteRef<TParams>\n      | ExternalRouteRef<TParams>,\n    options?: { sourcePath?: string },\n  ): RouteFunc<TParams> | undefined {\n    // First figure out what our target absolute ref is, as well as our target path.\n    const [targetRef, targetPath] = resolveTargetRef(\n      anyRouteRef?.$$type === '@backstage/RouteRef'\n        ? this.routeAliasResolver(anyRouteRef)\n        : anyRouteRef,\n      this.routePaths,\n      this.routeBindings,\n      this.routeRefsById,\n    );\n    if (!targetRef) {\n      return undefined;\n    }\n\n    // The location that we get passed in uses the full path, so start by trimming off\n    // the app base path prefix in case we're running the app on a sub-path.\n    const relativeSourceLocation = this.trimPath(options?.sourcePath ?? '');\n\n    // Next we figure out the base path, which is the combination of the common parent path\n    // between our current location and our target location, as well as the additional path\n    // that is the difference between the parent path and the base of our target location.\n    const basePath = resolveBasePath(\n      targetRef,\n      relativeSourceLocation,\n      this.routePaths,\n      this.routeParents,\n      this.routeObjects,\n    );\n\n    const routeFunc: RouteFunc<TParams> = (...[params]) => {\n      // We selectively encode some some known-dangerous characters in the\n      // params. The reason that we don't perform a blanket `encodeURIComponent`\n      // here is that this encoding was added defensively long after the initial\n      // release of this code. There's likely to be many users of this code that\n      // already encode their parameters knowing that this code didn't do this\n      // for them in the past. Therefore, we are extra careful NOT to include\n      // the percent character in this set, even though that might seem like a\n      // bad idea.\n      const encodedParams =\n        params &&\n        mapValues(params, value => {\n          if (typeof value === 'string') {\n            return value.replaceAll(/[&?#;\\/]/g, c => encodeURIComponent(c));\n          }\n          return value;\n        });\n      return joinPaths(basePath, generatePath(targetPath, encodedParams));\n    };\n    return routeFunc;\n  }\n\n  private trimPath(targetPath: string) {\n    if (!targetPath) {\n      return targetPath;\n    }\n\n    if (targetPath.startsWith(this.appBasePath)) {\n      return targetPath.slice(this.appBasePath.length);\n    }\n    return targetPath;\n  }\n}\n"],"names":[],"mappings":";;;;;;AAmCO,SAAS,aAAa,KAAA,EAAyB;AACpD,EAAA,MAAM,aAAa,KAAA,CAAM,IAAA,CAAK,GAAG,CAAA,CAAE,OAAA,CAAQ,UAAU,GAAG,CAAA;AACxD,EAAA,IAAI,UAAA,KAAe,GAAA,IAAO,UAAA,CAAW,QAAA,CAAS,GAAG,CAAA,EAAG;AAClD,IAAA,OAAO,UAAA,CAAW,KAAA,CAAM,CAAA,EAAG,EAAE,CAAA;AAAA,EAC/B;AACA,EAAA,OAAO,UAAA;AACT;AAQA,SAAS,gBAAA,CACP,cAAA,EACA,UAAA,EACA,aAAA,EACA,aAAA,EACyC;AAGzC,EAAA,IAAI,GAAA,GAAmB,cAAA;AACvB,EAAA,IAAI,IAAA,GAAO,EAAA;AAEX,EAAA,IAAI,sBAAA,CAAuB,MAAA,CAAO,GAAG,CAAA,EAAG;AACtC,IAAA,IAAI,aAAA,GAAgB,aAAA,CAAc,GAAA,CAAI,GAAG,CAAA;AACzC,IAAA,IAAI,CAAC,aAAA,EAAe;AAClB,MAAA,MAAM,QAAA,GAAW,sBAAA,CAAuB,UAAA,CAAW,GAAG,CAAA;AACtD,MAAA,MAAM,aAAA,GAAgB,SAAS,gBAAA,EAAiB;AAChD,MAAA,IAAI,aAAA,EAAe;AACjB,QAAA,aAAA,GAAgB,aAAA,CAAc,IAAI,aAAa,CAAA;AAAA,MACjD;AAAA,IACF;AACA,IAAA,IAAI,CAAC,aAAA,EAAe;AAClB,MAAA,OAAO,CAAC,QAAW,EAAE,CAAA;AAAA,IACvB;AACA,IAAA,GAAA,GAAM,aAAA;AAAA,EACR;AAEA,EAAA,IAAI,iBAAA,CAAkB,MAAA,CAAO,GAAG,CAAA,EAAG;AACjC,IAAA,MAAM,QAAA,GAAW,iBAAA,CAAkB,UAAA,CAAW,GAAG,CAAA;AACjD,IAAA,IAAA,GAAO,GAAA,CAAI,IAAA;AACX,IAAA,GAAA,GAAM,SAAS,SAAA,EAAU;AAAA,EAC3B;AAEA,EAAA,IAAI,CAAC,cAAA,CAAe,MAAA,CAAO,GAAG,CAAA,EAAG;AAC/B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sBAAA,EAAyB,cAAc,CAAA,oBAAA,EAAuB,GAAG,CAAA;AAAA,KACnE;AAAA,EACF;AAGA,EAAA,MAAM,YAAA,GAAe,UAAA,CAAW,GAAA,CAAI,GAAG,CAAA;AACvC,EAAA,IAAI,iBAAiB,MAAA,EAAW;AAC9B,IAAA,OAAO,CAAC,QAAW,EAAE,CAAA;AAAA,EACvB;AAEA,EAAA,OAAO,CAAC,GAAA,EAAK,IAAA,GAAO,UAAU,YAAA,EAAc,IAAI,IAAI,YAAY,CAAA;AAClE;AAKA,SAAS,eAAA,CACP,SAAA,EACA,cAAA,EACA,UAAA,EACA,cACA,YAAA,EACA;AAOA,EAAA,MAAM,KAAA,GAAQ,WAAA,CAAY,YAAA,EAAc,cAAc,KAAK,EAAC;AAK5D,EAAA,MAAM,cAAc,KAAA,EAAgB;AAEpC,EAAA,IAAI,UAAA,GAAa,EAAA;AACjB,EAAA,KAAA,IACM,kBAAwC,SAAA,EAC5C,eAAA,EACA,kBAAkB,YAAA,CAAa,GAAA,CAAI,eAAe,CAAA,EAClD;AAKA,IAAA,UAAA,GAAa,KAAA,CAAM,SAAA;AAAA,MAAU,CAAA,CAAA,KAC1B,CAAA,CAAE,KAAA,CAA+B,SAAA,CAAU,IAAI,eAAgB;AAAA,KAClE;AACA,IAAA,IAAI,eAAe,EAAA,EAAI;AACrB,MAAA;AAAA,IACF;AAKA,IAAA,WAAA,CAAY,QAAQ,eAAe,CAAA;AAAA,EACrC;AAKA,EAAA,IAAI,WAAA,CAAY,WAAW,CAAA,EAAG;AAC5B,IAAA,UAAA,IAAc,CAAA;AAAA,EAChB;AAIA,EAAA,MAAM,aAAa,UAAA,KAAe,EAAA,GAAK,EAAA,GAAK,KAAA,CAAM,UAAU,CAAA,CAAE,QAAA;AAM9D,EAAA,MAAM,YAAY,WAAA,CAAY,KAAA,CAAM,GAAG,EAAE,CAAA,CAAE,IAAI,CAAA,GAAA,KAAO;AACpD,IAAA,MAAM,IAAA,GAAO,UAAA,CAAW,GAAA,CAAI,GAAG,CAAA;AAC/B,IAAA,IAAI,SAAS,MAAA,EAAW;AACtB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,YAAA,EAAe,GAAG,CAAA,CAAE,CAAA;AAAA,IACtC;AACA,IAAA,IAAI,IAAA,CAAK,QAAA,CAAS,GAAG,CAAA,EAAG;AACtB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gBAAA,EAAmB,SAAS,CAAA,aAAA,EAAgB,GAAG,CAAA,qBAAA;AAAA,OACjD;AAAA,IACF;AACA,IAAA,OAAO,IAAA;AAAA,EACT,CAAC,CAAA;AAED,EAAA,OAAO,CAAA,EAAG,SAAA,CAAU,UAAA,EAAY,GAAG,SAAS,CAAC,CAAA,CAAA,CAAA;AAC/C;AAEO,MAAM,aAAA,CAA4C;AAAA,EACtC,UAAA;AAAA,EACA,YAAA;AAAA,EACA,YAAA;AAAA,EACA,aAAA;AAAA,EACA,WAAA;AAAA;AAAA,EACA,kBAAA;AAAA,EACA,aAAA;AAAA,EAEjB,YACE,UAAA,EACA,YAAA,EACA,cACA,aAAA,EACA,WAAA,EACA,oBACA,aAAA,EACA;AACA,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAClB,IAAA,IAAA,CAAK,YAAA,GAAe,YAAA;AACpB,IAAA,IAAA,CAAK,YAAA,GAAe,YAAA;AACpB,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AACrB,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,kBAAA,GAAqB,kBAAA;AAC1B,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AAAA,EACvB;AAAA,EAEA,OAAA,CACE,aAIA,OAAA,EACgC;AAEhC,IAAA,MAAM,CAAC,SAAA,EAAW,UAAU,CAAA,GAAI,gBAAA;AAAA,MAC9B,aAAa,MAAA,KAAW,qBAAA,GACpB,IAAA,CAAK,kBAAA,CAAmB,WAAW,CAAA,GACnC,WAAA;AAAA,MACJ,IAAA,CAAK,UAAA;AAAA,MACL,IAAA,CAAK,aAAA;AAAA,MACL,IAAA,CAAK;AAAA,KACP;AACA,IAAA,IAAI,CAAC,SAAA,EAAW;AACd,MAAA,OAAO,MAAA;AAAA,IACT;AAIA,IAAA,MAAM,sBAAA,GAAyB,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS,cAAc,EAAE,CAAA;AAKtE,IAAA,MAAM,QAAA,GAAW,eAAA;AAAA,MACf,SAAA;AAAA,MACA,sBAAA;AAAA,MACA,IAAA,CAAK,UAAA;AAAA,MACL,IAAA,CAAK,YAAA;AAAA,MACL,IAAA,CAAK;AAAA,KACP;AAEA,IAAA,MAAM,SAAA,GAAgC,CAAA,GAAI,CAAC,MAAM,CAAA,KAAM;AASrD,MAAA,MAAM,aAAA,GACJ,MAAA,IACA,SAAA,CAAU,MAAA,EAAQ,CAAA,KAAA,KAAS;AACzB,QAAA,IAAI,OAAO,UAAU,QAAA,EAAU;AAC7B,UAAA,OAAO,MAAM,UAAA,CAAW,WAAA,EAAa,CAAA,CAAA,KAAK,kBAAA,CAAmB,CAAC,CAAC,CAAA;AAAA,QACjE;AACA,QAAA,OAAO,KAAA;AAAA,MACT,CAAC,CAAA;AACH,MAAA,OAAO,SAAA,CAAU,QAAA,EAAU,YAAA,CAAa,UAAA,EAAY,aAAa,CAAC,CAAA;AAAA,IACpE,CAAA;AACA,IAAA,OAAO,SAAA;AAAA,EACT;AAAA,EAEQ,SAAS,UAAA,EAAoB;AACnC,IAAA,IAAI,CAAC,UAAA,EAAY;AACf,MAAA,OAAO,UAAA;AAAA,IACT;AAEA,IAAA,IAAI,UAAA,CAAW,UAAA,CAAW,IAAA,CAAK,WAAW,CAAA,EAAG;AAC3C,MAAA,OAAO,UAAA,CAAW,KAAA,CAAM,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA,IACjD;AACA,IAAA,OAAO,UAAA;AAAA,EACT;AACF;;;;"}
+{"version":3,"file":"RouteResolver.esm.js","sources":["../../src/routing/RouteResolver.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 { generatePath, matchRoutes } from 'react-router-dom';\nimport {\n  RouteRef,\n  ExternalRouteRef,\n  SubRouteRef,\n  AnyRouteRefParams,\n  RouteFunc,\n  RouteResolutionApi,\n} from '@backstage/frontend-plugin-api';\nimport mapValues from 'lodash/mapValues';\nimport { AnyRouteRef, BackstageRouteObject } from './types';\nimport {\n  OpaqueRouteRef,\n  OpaqueExternalRouteRef,\n  OpaqueSubRouteRef,\n} from '@internal/frontend';\nimport { RouteAliasResolver } from './RouteAliasResolver';\nimport { joinPaths } from './joinPaths';\n\n/**\n * Resolves the absolute route ref that our target route ref is pointing pointing to, as well\n * as the relative target path.\n *\n * Returns an undefined target ref if one could not be fully resolved.\n */\nfunction resolveTargetRef(\n  targetRouteRef: AnyRouteRef,\n  routePaths: Map<RouteRef, string>,\n  routeBindings: Map<AnyRouteRef, AnyRouteRef | undefined>,\n  routeRefsById: Map<string, RouteRef | SubRouteRef>,\n): readonly [RouteRef | undefined, string] {\n  // First we figure out which absolute route ref we're dealing with, an if there was an sub route path to append.\n  // For sub routes it will be the parent path, while for external routes it will be the bound route.\n  let ref: AnyRouteRef = targetRouteRef;\n  let path = '';\n\n  if (OpaqueExternalRouteRef.isType(ref)) {\n    let resolvedRoute = routeBindings.get(ref);\n    if (!resolvedRoute) {\n      const internal = OpaqueExternalRouteRef.toInternal(ref);\n      const defaultTarget = internal.getDefaultTarget();\n      if (defaultTarget) {\n        resolvedRoute = routeRefsById.get(defaultTarget);\n      }\n    }\n    if (!resolvedRoute) {\n      return [undefined, ''];\n    }\n    ref = resolvedRoute;\n  }\n\n  if (OpaqueSubRouteRef.isType(ref)) {\n    const internal = OpaqueSubRouteRef.toInternal(ref);\n    path = ref.path;\n    ref = internal.getParent();\n  }\n\n  if (!OpaqueRouteRef.isType(ref)) {\n    throw new Error(\n      `Unexpectedly resolved ${targetRouteRef} to a non-route ref ${ref}`,\n    );\n  }\n\n  // Find the path that our target route is bound to\n  const resolvedPath = routePaths.get(ref);\n  if (resolvedPath === undefined) {\n    return [undefined, ''];\n  }\n\n  return [ref, path ? joinPaths(resolvedPath, path) : resolvedPath];\n}\n\n/**\n * Resolves the complete base path for navigating to the target RouteRef.\n */\nfunction resolveBasePath(\n  targetRef: RouteRef,\n  sourceLocation: Parameters<typeof matchRoutes>[1],\n  routePaths: Map<RouteRef, string>,\n  routeParents: Map<RouteRef, RouteRef | undefined>,\n  routeObjects: BackstageRouteObject[],\n) {\n  // While traversing the app element tree we build up the routeObjects structure\n  // used here. It is the same kind of structure that react-router creates, with the\n  // addition that associated route refs are stored throughout the tree. This lets\n  // us look up all route refs that can be reached from our source location.\n  // Because of the similar route object structure, we can use `matchRoutes` from\n  // react-router to do the lookup of our current location.\n  const match = matchRoutes(routeObjects, sourceLocation) ?? [];\n\n  // While we search for a common routing root between our current location and\n  // the target route, we build a list of all route refs we find that we need\n  // to traverse to reach the target.\n  const refDiffList = Array<RouteRef>();\n\n  let matchIndex = -1;\n  for (\n    let targetSearchRef: RouteRef | undefined = targetRef;\n    targetSearchRef;\n    targetSearchRef = routeParents.get(targetSearchRef)\n  ) {\n    // The match contains a list of all ancestral route refs present at our current location\n    // Starting at the desired target ref and traversing back through its parents, we search\n    // for a target ref that is present in the match for our current location. When a match\n    // is found it means we have found a common base to resolve the route from.\n    matchIndex = match.findIndex(m =>\n      (m.route as BackstageRouteObject).routeRefs.has(targetSearchRef!),\n    );\n    if (matchIndex !== -1) {\n      break;\n    }\n\n    // Every time we move a step up in the ancestry of the target ref, we add the current ref\n    // to the diff list, which ends up being the list of route refs to traverse form the common base\n    // in order to reach our target.\n    refDiffList.unshift(targetSearchRef);\n  }\n\n  // If our target route is present in the initial match we need to construct the final path\n  // from the parent of the matched route segment. That's to allow the caller of the route\n  // function to supply their own params.\n  if (refDiffList.length === 0) {\n    matchIndex -= 1;\n  }\n\n  // This is the part of the route tree that the target and source locations have in common.\n  // We re-use the existing pathname directly along with all params.\n  const parentPath = matchIndex === -1 ? '' : match[matchIndex].pathname;\n\n  // This constructs the mid section of the path using paths resolved from all route refs\n  // we need to traverse to reach our target except for the very last one. None of these\n  // paths are allowed to require any parameters, as the caller would have no way of knowing\n  // what parameters those are.\n  const diffPaths = refDiffList.slice(0, -1).map(ref => {\n    const path = routePaths.get(ref);\n    if (path === undefined) {\n      throw new Error(`No path for ${ref}`);\n    }\n    if (path.includes(':')) {\n      throw new Error(\n        `Cannot route to ${targetRef} with parent ${ref} as it has parameters`,\n      );\n    }\n    return path;\n  });\n\n  return `${joinPaths(parentPath, ...diffPaths)}/`;\n}\n\nexport class RouteResolver implements RouteResolutionApi {\n  private readonly routePaths: Map<RouteRef, string>;\n  private readonly routeParents: Map<RouteRef, RouteRef | undefined>;\n  private readonly routeObjects: BackstageRouteObject[];\n  private readonly routeBindings: Map<ExternalRouteRef, RouteRef | SubRouteRef>;\n  private readonly appBasePath: string; // base path without a trailing slash\n  private readonly routeAliasResolver: RouteAliasResolver;\n  private readonly routeRefsById: Map<string, RouteRef | SubRouteRef>;\n\n  constructor(\n    routePaths: Map<RouteRef, string>,\n    routeParents: Map<RouteRef, RouteRef | undefined>,\n    routeObjects: BackstageRouteObject[],\n    routeBindings: Map<ExternalRouteRef, RouteRef | SubRouteRef>,\n    appBasePath: string, // base path without a trailing slash\n    routeAliasResolver: RouteAliasResolver,\n    routeRefsById: Map<string, RouteRef | SubRouteRef>,\n  ) {\n    this.routePaths = routePaths;\n    this.routeParents = routeParents;\n    this.routeObjects = routeObjects;\n    this.routeBindings = routeBindings;\n    this.appBasePath = appBasePath;\n    this.routeAliasResolver = routeAliasResolver;\n    this.routeRefsById = routeRefsById;\n  }\n\n  resolve<TParams extends AnyRouteRefParams>(\n    anyRouteRef:\n      | RouteRef<TParams>\n      | SubRouteRef<TParams>\n      | ExternalRouteRef<TParams>,\n    options?: { sourcePath?: string },\n  ): RouteFunc<TParams> | undefined {\n    // First figure out what our target absolute ref is, as well as our target path.\n    const [targetRef, targetPath] = resolveTargetRef(\n      anyRouteRef?.$$type === '@backstage/RouteRef'\n        ? this.routeAliasResolver(anyRouteRef)\n        : anyRouteRef,\n      this.routePaths,\n      this.routeBindings,\n      this.routeRefsById,\n    );\n    if (!targetRef) {\n      return undefined;\n    }\n\n    // The location that we get passed in uses the full path, so start by trimming off\n    // the app base path prefix in case we're running the app on a sub-path.\n    const relativeSourceLocation = this.trimPath(options?.sourcePath ?? '');\n\n    // Next we figure out the base path, which is the combination of the common parent path\n    // between our current location and our target location, as well as the additional path\n    // that is the difference between the parent path and the base of our target location.\n    const basePath = resolveBasePath(\n      targetRef,\n      relativeSourceLocation,\n      this.routePaths,\n      this.routeParents,\n      this.routeObjects,\n    );\n\n    const routeFunc: RouteFunc<TParams> = (...[params]) => {\n      // We selectively encode some some known-dangerous characters in the\n      // params. The reason that we don't perform a blanket `encodeURIComponent`\n      // here is that this encoding was added defensively long after the initial\n      // release of this code. There's likely to be many users of this code that\n      // already encode their parameters knowing that this code didn't do this\n      // for them in the past. Therefore, we are extra careful NOT to include\n      // the percent character in this set, even though that might seem like a\n      // bad idea.\n      const encodedParams =\n        params &&\n        mapValues(params, value => {\n          if (typeof value === 'string') {\n            return value.replaceAll(/[&?#;\\/]/g, c => encodeURIComponent(c));\n          }\n          return value;\n        });\n      return joinPaths(basePath, generatePath(targetPath, encodedParams));\n    };\n    return routeFunc;\n  }\n\n  private trimPath(targetPath: string) {\n    if (!targetPath) {\n      return targetPath;\n    }\n\n    if (targetPath.startsWith(this.appBasePath)) {\n      return targetPath.slice(this.appBasePath.length);\n    }\n    return targetPath;\n  }\n}\n"],"names":[],"mappings":";;;;;;;AAyCA,SAAS,gBAAA,CACP,cAAA,EACA,UAAA,EACA,aAAA,EACA,aAAA,EACyC;AAGzC,EAAA,IAAI,GAAA,GAAmB,cAAA;AACvB,EAAA,IAAI,IAAA,GAAO,EAAA;AAEX,EAAA,IAAI,sBAAA,CAAuB,MAAA,CAAO,GAAG,CAAA,EAAG;AACtC,IAAA,IAAI,aAAA,GAAgB,aAAA,CAAc,GAAA,CAAI,GAAG,CAAA;AACzC,IAAA,IAAI,CAAC,aAAA,EAAe;AAClB,MAAA,MAAM,QAAA,GAAW,sBAAA,CAAuB,UAAA,CAAW,GAAG,CAAA;AACtD,MAAA,MAAM,aAAA,GAAgB,SAAS,gBAAA,EAAiB;AAChD,MAAA,IAAI,aAAA,EAAe;AACjB,QAAA,aAAA,GAAgB,aAAA,CAAc,IAAI,aAAa,CAAA;AAAA,MACjD;AAAA,IACF;AACA,IAAA,IAAI,CAAC,aAAA,EAAe;AAClB,MAAA,OAAO,CAAC,QAAW,EAAE,CAAA;AAAA,IACvB;AACA,IAAA,GAAA,GAAM,aAAA;AAAA,EACR;AAEA,EAAA,IAAI,iBAAA,CAAkB,MAAA,CAAO,GAAG,CAAA,EAAG;AACjC,IAAA,MAAM,QAAA,GAAW,iBAAA,CAAkB,UAAA,CAAW,GAAG,CAAA;AACjD,IAAA,IAAA,GAAO,GAAA,CAAI,IAAA;AACX,IAAA,GAAA,GAAM,SAAS,SAAA,EAAU;AAAA,EAC3B;AAEA,EAAA,IAAI,CAAC,cAAA,CAAe,MAAA,CAAO,GAAG,CAAA,EAAG;AAC/B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sBAAA,EAAyB,cAAc,CAAA,oBAAA,EAAuB,GAAG,CAAA;AAAA,KACnE;AAAA,EACF;AAGA,EAAA,MAAM,YAAA,GAAe,UAAA,CAAW,GAAA,CAAI,GAAG,CAAA;AACvC,EAAA,IAAI,iBAAiB,MAAA,EAAW;AAC9B,IAAA,OAAO,CAAC,QAAW,EAAE,CAAA;AAAA,EACvB;AAEA,EAAA,OAAO,CAAC,GAAA,EAAK,IAAA,GAAO,UAAU,YAAA,EAAc,IAAI,IAAI,YAAY,CAAA;AAClE;AAKA,SAAS,eAAA,CACP,SAAA,EACA,cAAA,EACA,UAAA,EACA,cACA,YAAA,EACA;AAOA,EAAA,MAAM,KAAA,GAAQ,WAAA,CAAY,YAAA,EAAc,cAAc,KAAK,EAAC;AAK5D,EAAA,MAAM,cAAc,KAAA,EAAgB;AAEpC,EAAA,IAAI,UAAA,GAAa,EAAA;AACjB,EAAA,KAAA,IACM,kBAAwC,SAAA,EAC5C,eAAA,EACA,kBAAkB,YAAA,CAAa,GAAA,CAAI,eAAe,CAAA,EAClD;AAKA,IAAA,UAAA,GAAa,KAAA,CAAM,SAAA;AAAA,MAAU,CAAA,CAAA,KAC1B,CAAA,CAAE,KAAA,CAA+B,SAAA,CAAU,IAAI,eAAgB;AAAA,KAClE;AACA,IAAA,IAAI,eAAe,EAAA,EAAI;AACrB,MAAA;AAAA,IACF;AAKA,IAAA,WAAA,CAAY,QAAQ,eAAe,CAAA;AAAA,EACrC;AAKA,EAAA,IAAI,WAAA,CAAY,WAAW,CAAA,EAAG;AAC5B,IAAA,UAAA,IAAc,CAAA;AAAA,EAChB;AAIA,EAAA,MAAM,aAAa,UAAA,KAAe,EAAA,GAAK,EAAA,GAAK,KAAA,CAAM,UAAU,CAAA,CAAE,QAAA;AAM9D,EAAA,MAAM,YAAY,WAAA,CAAY,KAAA,CAAM,GAAG,EAAE,CAAA,CAAE,IAAI,CAAA,GAAA,KAAO;AACpD,IAAA,MAAM,IAAA,GAAO,UAAA,CAAW,GAAA,CAAI,GAAG,CAAA;AAC/B,IAAA,IAAI,SAAS,MAAA,EAAW;AACtB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,YAAA,EAAe,GAAG,CAAA,CAAE,CAAA;AAAA,IACtC;AACA,IAAA,IAAI,IAAA,CAAK,QAAA,CAAS,GAAG,CAAA,EAAG;AACtB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gBAAA,EAAmB,SAAS,CAAA,aAAA,EAAgB,GAAG,CAAA,qBAAA;AAAA,OACjD;AAAA,IACF;AACA,IAAA,OAAO,IAAA;AAAA,EACT,CAAC,CAAA;AAED,EAAA,OAAO,CAAA,EAAG,SAAA,CAAU,UAAA,EAAY,GAAG,SAAS,CAAC,CAAA,CAAA,CAAA;AAC/C;AAEO,MAAM,aAAA,CAA4C;AAAA,EACtC,UAAA;AAAA,EACA,YAAA;AAAA,EACA,YAAA;AAAA,EACA,aAAA;AAAA,EACA,WAAA;AAAA;AAAA,EACA,kBAAA;AAAA,EACA,aAAA;AAAA,EAEjB,YACE,UAAA,EACA,YAAA,EACA,cACA,aAAA,EACA,WAAA,EACA,oBACA,aAAA,EACA;AACA,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAClB,IAAA,IAAA,CAAK,YAAA,GAAe,YAAA;AACpB,IAAA,IAAA,CAAK,YAAA,GAAe,YAAA;AACpB,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AACrB,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,kBAAA,GAAqB,kBAAA;AAC1B,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AAAA,EACvB;AAAA,EAEA,OAAA,CACE,aAIA,OAAA,EACgC;AAEhC,IAAA,MAAM,CAAC,SAAA,EAAW,UAAU,CAAA,GAAI,gBAAA;AAAA,MAC9B,aAAa,MAAA,KAAW,qBAAA,GACpB,IAAA,CAAK,kBAAA,CAAmB,WAAW,CAAA,GACnC,WAAA;AAAA,MACJ,IAAA,CAAK,UAAA;AAAA,MACL,IAAA,CAAK,aAAA;AAAA,MACL,IAAA,CAAK;AAAA,KACP;AACA,IAAA,IAAI,CAAC,SAAA,EAAW;AACd,MAAA,OAAO,MAAA;AAAA,IACT;AAIA,IAAA,MAAM,sBAAA,GAAyB,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS,cAAc,EAAE,CAAA;AAKtE,IAAA,MAAM,QAAA,GAAW,eAAA;AAAA,MACf,SAAA;AAAA,MACA,sBAAA;AAAA,MACA,IAAA,CAAK,UAAA;AAAA,MACL,IAAA,CAAK,YAAA;AAAA,MACL,IAAA,CAAK;AAAA,KACP;AAEA,IAAA,MAAM,SAAA,GAAgC,CAAA,GAAI,CAAC,MAAM,CAAA,KAAM;AASrD,MAAA,MAAM,aAAA,GACJ,MAAA,IACA,SAAA,CAAU,MAAA,EAAQ,CAAA,KAAA,KAAS;AACzB,QAAA,IAAI,OAAO,UAAU,QAAA,EAAU;AAC7B,UAAA,OAAO,MAAM,UAAA,CAAW,WAAA,EAAa,CAAA,CAAA,KAAK,kBAAA,CAAmB,CAAC,CAAC,CAAA;AAAA,QACjE;AACA,QAAA,OAAO,KAAA;AAAA,MACT,CAAC,CAAA;AACH,MAAA,OAAO,SAAA,CAAU,QAAA,EAAU,YAAA,CAAa,UAAA,EAAY,aAAa,CAAC,CAAA;AAAA,IACpE,CAAA;AACA,IAAA,OAAO,SAAA;AAAA,EACT;AAAA,EAEQ,SAAS,UAAA,EAAoB;AACnC,IAAA,IAAI,CAAC,UAAA,EAAY;AACf,MAAA,OAAO,UAAA;AAAA,IACT;AAEA,IAAA,IAAI,UAAA,CAAW,UAAA,CAAW,IAAA,CAAK,WAAW,CAAA,EAAG;AAC3C,MAAA,OAAO,UAAA,CAAW,KAAA,CAAM,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA,IACjD;AACA,IAAA,OAAO,UAAA;AAAA,EACT;AACF;;;;"}

package/dist/routing/extractRouteInfoFromAppNode.esm.js

@@ -1,5 +1,6 @@
 import { coreExtensionData } from '@backstage/frontend-plugin-api';
 import { createExactRouteAliasResolver } from './RouteAliasResolver.esm.js';
+import { joinPaths } from './joinPaths.esm.js';
 
 const MATCH_ALL_ROUTE = {
   caseSensitive: false,
@@ -8,13 +9,6 @@ const MATCH_ALL_ROUTE = {
   // These elements aren't used, so we add in a bit of debug information
   routeRefs: /* @__PURE__ */ new Set()
 };
-function joinPaths(...paths) {
-  const normalized = paths.join("/").replace(/\/\/+/g, "/");
-  if (normalized !== "/" && normalized.endsWith("/")) {
-    return normalized.slice(0, -1);
-  }
-  return normalized;
-}
 function extractRouteInfoFromAppNode(node, routeAliasResolver) {
   const routePaths = /* @__PURE__ */ new Map();
   const routeParents = /* @__PURE__ */ new Map();
@@ -85,5 +79,5 @@ function extractRouteInfoFromAppNode(node, routeAliasResolver) {
   };
 }
 
-export { MATCH_ALL_ROUTE, extractRouteInfoFromAppNode, joinPaths };
+export { MATCH_ALL_ROUTE, extractRouteInfoFromAppNode };
 //# sourceMappingURL=extractRouteInfoFromAppNode.esm.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"extractRouteInfoFromAppNode.esm.js","sources":["../../src/routing/extractRouteInfoFromAppNode.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 { RouteRef, coreExtensionData } from '@backstage/frontend-plugin-api';\nimport { BackstageRouteObject } from './types';\nimport { AppNode } from '@backstage/frontend-plugin-api';\nimport {\n  createExactRouteAliasResolver,\n  RouteAliasResolver,\n} from './RouteAliasResolver';\n\n/** @internal */\nexport type RouteInfo = {\n  routePaths: Map<RouteRef, string>;\n  routeParents: Map<RouteRef, RouteRef | undefined>;\n  routeObjects: BackstageRouteObject[];\n  routeAliasResolver: RouteAliasResolver;\n};\n\n// We always add a child that matches all subroutes but without any route refs. This makes\n// sure that we're always able to match each route no matter how deep the navigation goes.\n// The route resolver then takes care of selecting the most specific match in order to find\n// mount points that are as deep in the routing tree as possible.\nexport const MATCH_ALL_ROUTE: BackstageRouteObject = {\n  caseSensitive: false,\n  path: '*',\n  element: 'match-all', // These elements aren't used, so we add in a bit of debug information\n  routeRefs: new Set(),\n};\n\n// Joins a list of paths together, avoiding trailing and duplicate slashes\nexport function joinPaths(...paths: string[]): string {\n  const normalized = paths.join('/').replace(/\\/\\/+/g, '/');\n  if (normalized !== '/' && normalized.endsWith('/')) {\n    return normalized.slice(0, -1);\n  }\n  return normalized;\n}\n\nexport function extractRouteInfoFromAppNode(\n  node: AppNode,\n  routeAliasResolver: RouteAliasResolver,\n): RouteInfo {\n  // This tracks the route path for each route ref, the value is the route path relative to the parent ref\n  const routePaths = new Map<RouteRef, string>();\n  // This tracks the parents of each route ref. To find the full path of any route ref you traverse\n  // upwards in this tree and substitute each route ref for its route path along then way.\n  const routeParents = new Map<RouteRef, RouteRef | undefined>();\n  // This route object tree is passed to react-router in order to be able to look up the current route\n  // ref or extension/source based on our current location.\n  const routeObjects = new Array<BackstageRouteObject>();\n  // This tracks all resolved route aliases. By storing and re-using the resolutions here we make sure that it's not\n  // possible to pass an aliased route ref directly to the resolver, e.g. `useRouteRef(createRouteRef({ aliasFor: 'example.root' }))`\n  const routeAliases = new Map<RouteRef, RouteRef | undefined>();\n\n  function visit(\n    current: AppNode,\n    collectedPath?: string,\n    foundRefForCollectedPath: boolean = false,\n    parentRef?: RouteRef,\n    candidateParentRef?: RouteRef,\n    parentObj?: BackstageRouteObject,\n  ) {\n    const routePath = current.instance\n      ?.getData(coreExtensionData.routePath)\n      ?.replace(/^\\//, '');\n\n    const foundRouteRef = current.instance?.getData(coreExtensionData.routeRef);\n    const routeRef = routeAliasResolver(foundRouteRef, current.spec.plugin?.id);\n    if (foundRouteRef && routeRef !== foundRouteRef) {\n      routeAliases.set(foundRouteRef, routeRef);\n    }\n\n    const parentChildren = parentObj?.children ?? routeObjects;\n    let currentObj = parentObj;\n\n    let newCollectedPath = collectedPath;\n    let newFoundRefForCollectedPath = foundRefForCollectedPath;\n\n    let newParentRef = parentRef;\n    let newCandidateParentRef = candidateParentRef;\n\n    // Whenever a route path is encountered, a new node is created in the routing tree.\n    if (routePath !== undefined) {\n      currentObj = {\n        path: routePath,\n        element: 'mounted',\n        routeRefs: new Set<RouteRef>(),\n        caseSensitive: false,\n        children: [MATCH_ALL_ROUTE],\n        appNode: current,\n      };\n      parentChildren.push(currentObj);\n\n      // Each route path that we discover creates a new node in the routing tree, at that point\n      // we also switch out our candidate parent ref to be the active one.\n      newParentRef = candidateParentRef;\n      newCandidateParentRef = undefined;\n\n      // We need to collect and concatenate route paths until the path has been assigned a route ref:\n      // Once we find a route ref the collection starts over from an empty path, that way each route\n      // path assignment only contains the diff from the parent ref.\n      if (newFoundRefForCollectedPath) {\n        newCollectedPath = routePath;\n        newFoundRefForCollectedPath = false;\n      } else {\n        newCollectedPath = collectedPath\n          ? joinPaths(collectedPath, routePath)\n          : routePath;\n      }\n    }\n\n    // Whenever a route ref is encountered, we need to give it a route path and position in the ref tree.\n    if (routeRef) {\n      // The first route ref we find after encountering a route path is selected to be used as the\n      // parent ref further down the tree. We don't start using this candidate ref until we encounter\n      // another route path though, at which point we repeat the process and select another candidate.\n      if (!newCandidateParentRef) {\n        newCandidateParentRef = routeRef;\n      }\n\n      // Check if we've encountered any route paths since the closest route ref, in that case we assign\n      // that path to this and following route refs until we encounter another route path.\n      if (newCollectedPath !== undefined) {\n        routePaths.set(routeRef, newCollectedPath);\n        newFoundRefForCollectedPath = true;\n      }\n\n      routeParents.set(routeRef, newParentRef);\n      currentObj?.routeRefs.add(routeRef);\n    }\n\n    for (const children of current.edges.attachments.values()) {\n      for (const child of children) {\n        visit(\n          child,\n          newCollectedPath,\n          newFoundRefForCollectedPath,\n          newParentRef,\n          newCandidateParentRef,\n          currentObj,\n        );\n      }\n    }\n  }\n\n  visit(node);\n\n  return {\n    routePaths,\n    routeParents,\n    routeObjects,\n    routeAliasResolver: createExactRouteAliasResolver(routeAliases),\n  };\n}\n"],"names":[],"mappings":";;;AAoCO,MAAM,eAAA,GAAwC;AAAA,EACnD,aAAA,EAAe,KAAA;AAAA,EACf,IAAA,EAAM,GAAA;AAAA,EACN,OAAA,EAAS,WAAA;AAAA;AAAA,EACT,SAAA,sBAAe,GAAA;AACjB;AAGO,SAAS,aAAa,KAAA,EAAyB;AACpD,EAAA,MAAM,aAAa,KAAA,CAAM,IAAA,CAAK,GAAG,CAAA,CAAE,OAAA,CAAQ,UAAU,GAAG,CAAA;AACxD,EAAA,IAAI,UAAA,KAAe,GAAA,IAAO,UAAA,CAAW,QAAA,CAAS,GAAG,CAAA,EAAG;AAClD,IAAA,OAAO,UAAA,CAAW,KAAA,CAAM,CAAA,EAAG,EAAE,CAAA;AAAA,EAC/B;AACA,EAAA,OAAO,UAAA;AACT;AAEO,SAAS,2BAAA,CACd,MACA,kBAAA,EACW;AAEX,EAAA,MAAM,UAAA,uBAAiB,GAAA,EAAsB;AAG7C,EAAA,MAAM,YAAA,uBAAmB,GAAA,EAAoC;AAG7D,EAAA,MAAM,YAAA,GAAe,IAAI,KAAA,EAA4B;AAGrD,EAAA,MAAM,YAAA,uBAAmB,GAAA,EAAoC;AAE7D,EAAA,SAAS,MACP,OAAA,EACA,aAAA,EACA,2BAAoC,KAAA,EACpC,SAAA,EACA,oBACA,SAAA,EACA;AACA,IAAA,MAAM,SAAA,GAAY,QAAQ,QAAA,EACtB,OAAA,CAAQ,kBAAkB,SAAS,CAAA,EACnC,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AAErB,IAAA,MAAM,aAAA,GAAgB,OAAA,CAAQ,QAAA,EAAU,OAAA,CAAQ,kBAAkB,QAAQ,CAAA;AAC1E,IAAA,MAAM,WAAW,kBAAA,CAAmB,aAAA,EAAe,OAAA,CAAQ,IAAA,CAAK,QAAQ,EAAE,CAAA;AAC1E,IAAA,IAAI,aAAA,IAAiB,aAAa,aAAA,EAAe;AAC/C,MAAA,YAAA,CAAa,GAAA,CAAI,eAAe,QAAQ,CAAA;AAAA,IAC1C;AAEA,IAAA,MAAM,cAAA,GAAiB,WAAW,QAAA,IAAY,YAAA;AAC9C,IAAA,IAAI,UAAA,GAAa,SAAA;AAEjB,IAAA,IAAI,gBAAA,GAAmB,aAAA;AACvB,IAAA,IAAI,2BAAA,GAA8B,wBAAA;AAElC,IAAA,IAAI,YAAA,GAAe,SAAA;AACnB,IAAA,IAAI,qBAAA,GAAwB,kBAAA;AAG5B,IAAA,IAAI,cAAc,MAAA,EAAW;AAC3B,MAAA,UAAA,GAAa;AAAA,QACX,IAAA,EAAM,SAAA;AAAA,QACN,OAAA,EAAS,SAAA;AAAA,QACT,SAAA,sBAAe,GAAA,EAAc;AAAA,QAC7B,aAAA,EAAe,KAAA;AAAA,QACf,QAAA,EAAU,CAAC,eAAe,CAAA;AAAA,QAC1B,OAAA,EAAS;AAAA,OACX;AACA,MAAA,cAAA,CAAe,KAAK,UAAU,CAAA;AAI9B,MAAA,YAAA,GAAe,kBAAA;AACf,MAAA,qBAAA,GAAwB,MAAA;AAKxB,MAAA,IAAI,2BAAA,EAA6B;AAC/B,QAAA,gBAAA,GAAmB,SAAA;AACnB,QAAA,2BAAA,GAA8B,KAAA;AAAA,MAChC,CAAA,MAAO;AACL,QAAA,gBAAA,GAAmB,aAAA,GACf,SAAA,CAAU,aAAA,EAAe,SAAS,CAAA,GAClC,SAAA;AAAA,MACN;AAAA,IACF;AAGA,IAAA,IAAI,QAAA,EAAU;AAIZ,MAAA,IAAI,CAAC,qBAAA,EAAuB;AAC1B,QAAA,qBAAA,GAAwB,QAAA;AAAA,MAC1B;AAIA,MAAA,IAAI,qBAAqB,MAAA,EAAW;AAClC,QAAA,UAAA,CAAW,GAAA,CAAI,UAAU,gBAAgB,CAAA;AACzC,QAAA,2BAAA,GAA8B,IAAA;AAAA,MAChC;AAEA,MAAA,YAAA,CAAa,GAAA,CAAI,UAAU,YAAY,CAAA;AACvC,MAAA,UAAA,EAAY,SAAA,CAAU,IAAI,QAAQ,CAAA;AAAA,IACpC;AAEA,IAAA,KAAA,MAAW,QAAA,IAAY,OAAA,CAAQ,KAAA,CAAM,WAAA,CAAY,QAAO,EAAG;AACzD,MAAA,KAAA,MAAW,SAAS,QAAA,EAAU;AAC5B,QAAA,KAAA;AAAA,UACE,KAAA;AAAA,UACA,gBAAA;AAAA,UACA,2BAAA;AAAA,UACA,YAAA;AAAA,UACA,qBAAA;AAAA,UACA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,EAAA,KAAA,CAAM,IAAI,CAAA;AAEV,EAAA,OAAO;AAAA,IACL,UAAA;AAAA,IACA,YAAA;AAAA,IACA,YAAA;AAAA,IACA,kBAAA,EAAoB,8BAA8B,YAAY;AAAA,GAChE;AACF;;;;"}
+{"version":3,"file":"extractRouteInfoFromAppNode.esm.js","sources":["../../src/routing/extractRouteInfoFromAppNode.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 { RouteRef, coreExtensionData } from '@backstage/frontend-plugin-api';\nimport { BackstageRouteObject } from './types';\nimport { AppNode } from '@backstage/frontend-plugin-api';\nimport {\n  createExactRouteAliasResolver,\n  RouteAliasResolver,\n} from './RouteAliasResolver';\nimport { joinPaths } from './joinPaths';\n\n/** @internal */\nexport type RouteInfo = {\n  routePaths: Map<RouteRef, string>;\n  routeParents: Map<RouteRef, RouteRef | undefined>;\n  routeObjects: BackstageRouteObject[];\n  routeAliasResolver: RouteAliasResolver;\n};\n\n// We always add a child that matches all subroutes but without any route refs. This makes\n// sure that we're always able to match each route no matter how deep the navigation goes.\n// The route resolver then takes care of selecting the most specific match in order to find\n// mount points that are as deep in the routing tree as possible.\nexport const MATCH_ALL_ROUTE: BackstageRouteObject = {\n  caseSensitive: false,\n  path: '*',\n  element: 'match-all', // These elements aren't used, so we add in a bit of debug information\n  routeRefs: new Set(),\n};\n\nexport function extractRouteInfoFromAppNode(\n  node: AppNode,\n  routeAliasResolver: RouteAliasResolver,\n): RouteInfo {\n  // This tracks the route path for each route ref, the value is the route path relative to the parent ref\n  const routePaths = new Map<RouteRef, string>();\n  // This tracks the parents of each route ref. To find the full path of any route ref you traverse\n  // upwards in this tree and substitute each route ref for its route path along then way.\n  const routeParents = new Map<RouteRef, RouteRef | undefined>();\n  // This route object tree is passed to react-router in order to be able to look up the current route\n  // ref or extension/source based on our current location.\n  const routeObjects = new Array<BackstageRouteObject>();\n  // This tracks all resolved route aliases. By storing and re-using the resolutions here we make sure that it's not\n  // possible to pass an aliased route ref directly to the resolver, e.g. `useRouteRef(createRouteRef({ aliasFor: 'example.root' }))`\n  const routeAliases = new Map<RouteRef, RouteRef | undefined>();\n\n  function visit(\n    current: AppNode,\n    collectedPath?: string,\n    foundRefForCollectedPath: boolean = false,\n    parentRef?: RouteRef,\n    candidateParentRef?: RouteRef,\n    parentObj?: BackstageRouteObject,\n  ) {\n    const routePath = current.instance\n      ?.getData(coreExtensionData.routePath)\n      ?.replace(/^\\//, '');\n\n    const foundRouteRef = current.instance?.getData(coreExtensionData.routeRef);\n    const routeRef = routeAliasResolver(foundRouteRef, current.spec.plugin?.id);\n    if (foundRouteRef && routeRef !== foundRouteRef) {\n      routeAliases.set(foundRouteRef, routeRef);\n    }\n\n    const parentChildren = parentObj?.children ?? routeObjects;\n    let currentObj = parentObj;\n\n    let newCollectedPath = collectedPath;\n    let newFoundRefForCollectedPath = foundRefForCollectedPath;\n\n    let newParentRef = parentRef;\n    let newCandidateParentRef = candidateParentRef;\n\n    // Whenever a route path is encountered, a new node is created in the routing tree.\n    if (routePath !== undefined) {\n      currentObj = {\n        path: routePath,\n        element: 'mounted',\n        routeRefs: new Set<RouteRef>(),\n        caseSensitive: false,\n        children: [MATCH_ALL_ROUTE],\n        appNode: current,\n      };\n      parentChildren.push(currentObj);\n\n      // Each route path that we discover creates a new node in the routing tree, at that point\n      // we also switch out our candidate parent ref to be the active one.\n      newParentRef = candidateParentRef;\n      newCandidateParentRef = undefined;\n\n      // We need to collect and concatenate route paths until the path has been assigned a route ref:\n      // Once we find a route ref the collection starts over from an empty path, that way each route\n      // path assignment only contains the diff from the parent ref.\n      if (newFoundRefForCollectedPath) {\n        newCollectedPath = routePath;\n        newFoundRefForCollectedPath = false;\n      } else {\n        newCollectedPath = collectedPath\n          ? joinPaths(collectedPath, routePath)\n          : routePath;\n      }\n    }\n\n    // Whenever a route ref is encountered, we need to give it a route path and position in the ref tree.\n    if (routeRef) {\n      // The first route ref we find after encountering a route path is selected to be used as the\n      // parent ref further down the tree. We don't start using this candidate ref until we encounter\n      // another route path though, at which point we repeat the process and select another candidate.\n      if (!newCandidateParentRef) {\n        newCandidateParentRef = routeRef;\n      }\n\n      // Check if we've encountered any route paths since the closest route ref, in that case we assign\n      // that path to this and following route refs until we encounter another route path.\n      if (newCollectedPath !== undefined) {\n        routePaths.set(routeRef, newCollectedPath);\n        newFoundRefForCollectedPath = true;\n      }\n\n      routeParents.set(routeRef, newParentRef);\n      currentObj?.routeRefs.add(routeRef);\n    }\n\n    for (const children of current.edges.attachments.values()) {\n      for (const child of children) {\n        visit(\n          child,\n          newCollectedPath,\n          newFoundRefForCollectedPath,\n          newParentRef,\n          newCandidateParentRef,\n          currentObj,\n        );\n      }\n    }\n  }\n\n  visit(node);\n\n  return {\n    routePaths,\n    routeParents,\n    routeObjects,\n    routeAliasResolver: createExactRouteAliasResolver(routeAliases),\n  };\n}\n"],"names":[],"mappings":";;;;AAqCO,MAAM,eAAA,GAAwC;AAAA,EACnD,aAAA,EAAe,KAAA;AAAA,EACf,IAAA,EAAM,GAAA;AAAA,EACN,OAAA,EAAS,WAAA;AAAA;AAAA,EACT,SAAA,sBAAe,GAAA;AACjB;AAEO,SAAS,2BAAA,CACd,MACA,kBAAA,EACW;AAEX,EAAA,MAAM,UAAA,uBAAiB,GAAA,EAAsB;AAG7C,EAAA,MAAM,YAAA,uBAAmB,GAAA,EAAoC;AAG7D,EAAA,MAAM,YAAA,GAAe,IAAI,KAAA,EAA4B;AAGrD,EAAA,MAAM,YAAA,uBAAmB,GAAA,EAAoC;AAE7D,EAAA,SAAS,MACP,OAAA,EACA,aAAA,EACA,2BAAoC,KAAA,EACpC,SAAA,EACA,oBACA,SAAA,EACA;AACA,IAAA,MAAM,SAAA,GAAY,QAAQ,QAAA,EACtB,OAAA,CAAQ,kBAAkB,SAAS,CAAA,EACnC,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AAErB,IAAA,MAAM,aAAA,GAAgB,OAAA,CAAQ,QAAA,EAAU,OAAA,CAAQ,kBAAkB,QAAQ,CAAA;AAC1E,IAAA,MAAM,WAAW,kBAAA,CAAmB,aAAA,EAAe,OAAA,CAAQ,IAAA,CAAK,QAAQ,EAAE,CAAA;AAC1E,IAAA,IAAI,aAAA,IAAiB,aAAa,aAAA,EAAe;AAC/C,MAAA,YAAA,CAAa,GAAA,CAAI,eAAe,QAAQ,CAAA;AAAA,IAC1C;AAEA,IAAA,MAAM,cAAA,GAAiB,WAAW,QAAA,IAAY,YAAA;AAC9C,IAAA,IAAI,UAAA,GAAa,SAAA;AAEjB,IAAA,IAAI,gBAAA,GAAmB,aAAA;AACvB,IAAA,IAAI,2BAAA,GAA8B,wBAAA;AAElC,IAAA,IAAI,YAAA,GAAe,SAAA;AACnB,IAAA,IAAI,qBAAA,GAAwB,kBAAA;AAG5B,IAAA,IAAI,cAAc,MAAA,EAAW;AAC3B,MAAA,UAAA,GAAa;AAAA,QACX,IAAA,EAAM,SAAA;AAAA,QACN,OAAA,EAAS,SAAA;AAAA,QACT,SAAA,sBAAe,GAAA,EAAc;AAAA,QAC7B,aAAA,EAAe,KAAA;AAAA,QACf,QAAA,EAAU,CAAC,eAAe,CAAA;AAAA,QAC1B,OAAA,EAAS;AAAA,OACX;AACA,MAAA,cAAA,CAAe,KAAK,UAAU,CAAA;AAI9B,MAAA,YAAA,GAAe,kBAAA;AACf,MAAA,qBAAA,GAAwB,MAAA;AAKxB,MAAA,IAAI,2BAAA,EAA6B;AAC/B,QAAA,gBAAA,GAAmB,SAAA;AACnB,QAAA,2BAAA,GAA8B,KAAA;AAAA,MAChC,CAAA,MAAO;AACL,QAAA,gBAAA,GAAmB,aAAA,GACf,SAAA,CAAU,aAAA,EAAe,SAAS,CAAA,GAClC,SAAA;AAAA,MACN;AAAA,IACF;AAGA,IAAA,IAAI,QAAA,EAAU;AAIZ,MAAA,IAAI,CAAC,qBAAA,EAAuB;AAC1B,QAAA,qBAAA,GAAwB,QAAA;AAAA,MAC1B;AAIA,MAAA,IAAI,qBAAqB,MAAA,EAAW;AAClC,QAAA,UAAA,CAAW,GAAA,CAAI,UAAU,gBAAgB,CAAA;AACzC,QAAA,2BAAA,GAA8B,IAAA;AAAA,MAChC;AAEA,MAAA,YAAA,CAAa,GAAA,CAAI,UAAU,YAAY,CAAA;AACvC,MAAA,UAAA,EAAY,SAAA,CAAU,IAAI,QAAQ,CAAA;AAAA,IACpC;AAEA,IAAA,KAAA,MAAW,QAAA,IAAY,OAAA,CAAQ,KAAA,CAAM,WAAA,CAAY,QAAO,EAAG;AACzD,MAAA,KAAA,MAAW,SAAS,QAAA,EAAU;AAC5B,QAAA,KAAA;AAAA,UACE,KAAA;AAAA,UACA,gBAAA;AAAA,UACA,2BAAA;AAAA,UACA,YAAA;AAAA,UACA,qBAAA;AAAA,UACA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,EAAA,KAAA,CAAM,IAAI,CAAA;AAEV,EAAA,OAAO;AAAA,IACL,UAAA;AAAA,IACA,YAAA;AAAA,IACA,YAAA;AAAA,IACA,kBAAA,EAAoB,8BAA8B,YAAY;AAAA,GAChE;AACF;;;;"}

package/dist/routing/joinPaths.esm.js

@@ -0,0 +1,10 @@
+function joinPaths(...paths) {
+  const normalized = paths.join("/").replace(/\/\/+/g, "/");
+  if (normalized !== "/" && normalized.endsWith("/")) {
+    return normalized.slice(0, -1);
+  }
+  return normalized;
+}
+
+export { joinPaths };
+//# sourceMappingURL=joinPaths.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"joinPaths.esm.js","sources":["../../src/routing/joinPaths.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\n// Joins a list of paths together, avoiding trailing and duplicate slashes\nexport function joinPaths(...paths: string[]): string {\n  const normalized = paths.join('/').replace(/\\/\\/+/g, '/');\n  if (normalized !== '/' && normalized.endsWith('/')) {\n    return normalized.slice(0, -1);\n  }\n  return normalized;\n}\n"],"names":[],"mappings":"AAiBO,SAAS,aAAa,KAAA,EAAyB;AACpD,EAAA,MAAM,aAAa,KAAA,CAAM,IAAA,CAAK,GAAG,CAAA,CAAE,OAAA,CAAQ,UAAU,GAAG,CAAA;AACxD,EAAA,IAAI,UAAA,KAAe,GAAA,IAAO,UAAA,CAAW,QAAA,CAAS,GAAG,CAAA,EAAG;AAClD,IAAA,OAAO,UAAA,CAAW,KAAA,CAAM,CAAA,EAAG,EAAE,CAAA;AAAA,EAC/B;AACA,EAAA,OAAO,UAAA;AACT;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/frontend-app-api",
-  "version": "0.16.2",
+  "version": "0.16.3-next.0",
   "backstage": {
     "role": "web-library"
   },
@@ -32,24 +32,24 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/config": "^1.3.7",
-    "@backstage/core-app-api": "^1.20.0",
-    "@backstage/core-plugin-api": "^1.12.5",
-    "@backstage/errors": "^1.3.0",
-    "@backstage/filter-predicates": "^0.1.2",
-    "@backstage/frontend-defaults": "^0.5.1",
-    "@backstage/frontend-plugin-api": "^0.16.0",
-    "@backstage/types": "^1.2.2",
-    "@backstage/version-bridge": "^1.0.12",
+    "@backstage/config": "1.3.8-next.0",
+    "@backstage/core-app-api": "1.20.1-next.0",
+    "@backstage/core-plugin-api": "1.12.6-next.0",
+    "@backstage/errors": "1.3.1-next.0",
+    "@backstage/filter-predicates": "0.1.3-next.0",
+    "@backstage/frontend-defaults": "0.5.2-next.0",
+    "@backstage/frontend-plugin-api": "0.17.0-next.0",
+    "@backstage/types": "1.2.2",
+    "@backstage/version-bridge": "1.0.12",
     "lodash": "^4.17.21",
     "zod": "^3.25.76 || ^4.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.36.1",
-    "@backstage/frontend-test-utils": "^0.5.2",
-    "@backstage/plugin-app": "^0.4.3",
-    "@backstage/plugin-permission-common": "^0.9.8",
-    "@backstage/test-utils": "^1.7.17",
+    "@backstage/cli": "0.36.2-next.0",
+    "@backstage/frontend-test-utils": "0.5.3-next.0",
+    "@backstage/plugin-app": "0.4.6-next.0",
+    "@backstage/plugin-permission-common": "0.9.9-next.0",
+    "@backstage/test-utils": "1.7.18-next.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
     "@types/react": "^18.0.0",