@backstage/frontend-app-api 0.7.1 → 0.7.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/frontend-app-api
 
+## 0.7.2-next.0
+
+### Patch Changes
+
+- d3c39fc: Allow for the disabling of external routes through config, which was rendered impossible after the introduction of default targets.
+
+  ```yaml
+  app:
+    routes:
+      bindings:
+        # This has the effect of removing the button for registering new
+        # catalog entities in the scaffolder template list view
+        scaffolder.registerComponent: false
+  ```
+
+- Updated dependencies
+  - @backstage/core-components@0.14.9-next.0
+  - @backstage/core-app-api@1.13.0-next.0
+  - @backstage/frontend-plugin-api@0.6.7-next.0
+  - @backstage/core-plugin-api@1.9.3
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/theme@0.5.6
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.8
+
 ## 0.7.1
 
 ### Patch Changes

package/config.d.ts

@@ -26,9 +26,14 @@ export interface Config {
 
     routes?: {
       /**
+       * Maps external route references to regular route references. Both the
+       * key and the value is expected to be on the form `<pluginId>.<routeId>`.
+       * If the value is `false`, the route will be disabled even if it has a
+       * default mapping.
+       *
        * @deepVisibility frontend
        */
-      bindings?: { [externalRouteRefId: string]: string };
+      bindings?: { [externalRouteRefId: string]: string | false };
     };
 
     /**

package/dist/routing/resolveRouteBindings.esm.js

@@ -22,11 +22,12 @@ function resolveRouteBindings(bindRoutes, config, routesById) {
     bindRoutes({ bind });
   }
   const bindings = config.getOptionalConfig("app.routes.bindings")?.get();
+  const disabledExternalRefs = /* @__PURE__ */ new Set();
   if (bindings) {
     for (const [externalRefId, targetRefId] of Object.entries(bindings)) {
-      if (typeof targetRefId !== "string" || targetRefId === "") {
+      if (!isValidTargetRefId(targetRefId)) {
         throw new Error(
-          `Invalid config at app.routes.bindings['${externalRefId}'], value must be a non-empty string`
+          `Invalid config at app.routes.bindings['${externalRefId}'], value must be a non-empty string or false`
         );
       }
       const externalRef = routesById.externalRoutes.get(externalRefId);
@@ -35,20 +36,22 @@ function resolveRouteBindings(bindRoutes, config, routesById) {
           `Invalid config at app.routes.bindings, '${externalRefId}' is not a valid external route`
         );
       }
-      if (result.has(externalRef)) {
-        continue;
-      }
-      const targetRef = routesById.routes.get(targetRefId);
-      if (!targetRef) {
-        throw new Error(
-          `Invalid config at app.routes.bindings['${externalRefId}'], '${targetRefId}' is not a valid route`
-        );
+      if (targetRefId === false) {
+        disabledExternalRefs.add(externalRef);
+        result.delete(externalRef);
+      } else if (!result.has(externalRef)) {
+        const targetRef = routesById.routes.get(targetRefId);
+        if (!targetRef) {
+          throw new Error(
+            `Invalid config at app.routes.bindings['${externalRefId}'], '${targetRefId}' is not a valid route`
+          );
+        }
+        result.set(externalRef, targetRef);
       }
-      result.set(externalRef, targetRef);
     }
   }
   for (const externalRef of routesById.externalRoutes.values()) {
-    if (!result.has(externalRef)) {
+    if (!result.has(externalRef) && !disabledExternalRefs.has(externalRef)) {
       const defaultRefId = toInternalExternalRouteRef(externalRef).getDefaultTarget();
       if (defaultRefId) {
         const defaultRef = routesById.routes.get(defaultRefId);
@@ -60,6 +63,15 @@ function resolveRouteBindings(bindRoutes, config, routesById) {
   }
   return result;
 }
+function isValidTargetRefId(value) {
+  if (value === false) {
+    return true;
+  }
+  if (typeof value === "string" && value) {
+    return true;
+  }
+  return false;
+}
 
 export { resolveRouteBindings };
 //# sourceMappingURL=resolveRouteBindings.esm.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"resolveRouteBindings.esm.js","sources":["../../src/routing/resolveRouteBindings.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 {\n  RouteRef,\n  SubRouteRef,\n  ExternalRouteRef,\n} from '@backstage/frontend-plugin-api';\nimport { RouteRefsById } from './collectRouteIds';\nimport { Config } from '@backstage/config';\nimport { JsonObject } from '@backstage/types';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExternalRouteRef } from '../../../frontend-plugin-api/src/routing/ExternalRouteRef';\n\n/**\n * Extracts a union of the keys in a map whose value extends the given type\n *\n * @ignore\n */\ntype KeysWithType<Obj extends { [key in string]: any }, Type> = {\n  [key in keyof Obj]: Obj[key] extends Type ? key : never;\n}[keyof Obj];\n\n/**\n * Takes a map Map required values and makes all keys matching Keys optional\n *\n * @ignore\n */\ntype PartialKeys<\n  Map extends { [name in string]: any },\n  Keys extends keyof Map,\n> = Partial<Pick<Map, Keys>> & Required<Omit<Map, Keys>>;\n\n/**\n * Creates a map of target routes with matching parameters based on a map of external routes.\n *\n * @ignore\n */\ntype TargetRouteMap<\n  ExternalRoutes extends { [name: string]: ExternalRouteRef },\n> = {\n  [name in keyof ExternalRoutes]: ExternalRoutes[name] extends ExternalRouteRef<\n    infer Params,\n    any\n  >\n    ? RouteRef<Params> | SubRouteRef<Params>\n    : never;\n};\n\n/**\n * A function that can bind from external routes of a given plugin, to concrete\n * routes of other plugins. See {@link createApp}.\n *\n * @public\n */\nexport type CreateAppRouteBinder = <\n  TExternalRoutes extends { [name: string]: ExternalRouteRef },\n>(\n  externalRoutes: TExternalRoutes,\n  targetRoutes: PartialKeys<\n    TargetRouteMap<TExternalRoutes>,\n    KeysWithType<TExternalRoutes, ExternalRouteRef<any, true>>\n  >,\n) => void;\n\n/** @internal */\nexport function resolveRouteBindings(\n  bindRoutes: ((context: { bind: CreateAppRouteBinder }) => void) | undefined,\n  config: Config,\n  routesById: RouteRefsById,\n): Map<ExternalRouteRef, RouteRef | SubRouteRef> {\n  const result = new Map<ExternalRouteRef, RouteRef | SubRouteRef>();\n\n  // Perform callback bindings first with highest priority\n  if (bindRoutes) {\n    const bind: CreateAppRouteBinder = (\n      externalRoutes,\n      targetRoutes: { [name: string]: RouteRef | SubRouteRef },\n    ) => {\n      for (const [key, value] of Object.entries(targetRoutes)) {\n        const externalRoute = externalRoutes[key];\n        if (!externalRoute) {\n          throw new Error(`Key ${key} is not an existing external route`);\n        }\n        if (!value && !externalRoute.optional) {\n          throw new Error(\n            `External route ${key} is required but was undefined`,\n          );\n        }\n        if (value) {\n          result.set(externalRoute, value);\n        }\n      }\n    };\n    bindRoutes({ bind });\n  }\n\n  // Then perform config based bindings with lower priority\n  const bindings = config\n    .getOptionalConfig('app.routes.bindings')\n    ?.get<JsonObject>();\n  if (bindings) {\n    for (const [externalRefId, targetRefId] of Object.entries(bindings)) {\n      if (typeof targetRefId !== 'string' || targetRefId === '') {\n        throw new Error(\n          `Invalid config at app.routes.bindings['${externalRefId}'], value must be a non-empty string`,\n        );\n      }\n\n      const externalRef = routesById.externalRoutes.get(externalRefId);\n      if (!externalRef) {\n        throw new Error(\n          `Invalid config at app.routes.bindings, '${externalRefId}' is not a valid external route`,\n        );\n      }\n      if (result.has(externalRef)) {\n        continue;\n      }\n      const targetRef = routesById.routes.get(targetRefId);\n      if (!targetRef) {\n        throw new Error(\n          `Invalid config at app.routes.bindings['${externalRefId}'], '${targetRefId}' is not a valid route`,\n        );\n      }\n\n      result.set(externalRef, targetRef);\n    }\n  }\n\n  // Finally fall back to attempting to map defaults, at lowest priority\n  for (const externalRef of routesById.externalRoutes.values()) {\n    if (!result.has(externalRef)) {\n      const defaultRefId =\n        toInternalExternalRouteRef(externalRef).getDefaultTarget();\n      if (defaultRefId) {\n        const defaultRef = routesById.routes.get(defaultRefId);\n        if (defaultRef) {\n          result.set(externalRef, defaultRef);\n        }\n      }\n    }\n  }\n\n  return result;\n}\n"],"names":[],"mappings":";;AA+EgB,SAAA,oBAAA,CACd,UACA,EAAA,MAAA,EACA,UAC+C,EAAA;AAC/C,EAAM,MAAA,MAAA,uBAAa,GAA8C,EAAA,CAAA;AAGjE,EAAA,IAAI,UAAY,EAAA;AACd,IAAM,MAAA,IAAA,GAA6B,CACjC,cAAA,EACA,YACG,KAAA;AACH,MAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,YAAY,CAAG,EAAA;AACvD,QAAM,MAAA,aAAA,GAAgB,eAAe,GAAG,CAAA,CAAA;AACxC,QAAA,IAAI,CAAC,aAAe,EAAA;AAClB,UAAA,MAAM,IAAI,KAAA,CAAM,CAAO,IAAA,EAAA,GAAG,CAAoC,kCAAA,CAAA,CAAA,CAAA;AAAA,SAChE;AACA,QAAA,IAAI,CAAC,KAAA,IAAS,CAAC,aAAA,CAAc,QAAU,EAAA;AACrC,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,kBAAkB,GAAG,CAAA,8BAAA,CAAA;AAAA,WACvB,CAAA;AAAA,SACF;AACA,QAAA,IAAI,KAAO,EAAA;AACT,UAAO,MAAA,CAAA,GAAA,CAAI,eAAe,KAAK,CAAA,CAAA;AAAA,SACjC;AAAA,OACF;AAAA,KACF,CAAA;AACA,IAAW,UAAA,CAAA,EAAE,MAAM,CAAA,CAAA;AAAA,GACrB;AAGA,EAAA,MAAM,QAAW,GAAA,MAAA,CACd,iBAAkB,CAAA,qBAAqB,GACtC,GAAgB,EAAA,CAAA;AACpB,EAAA,IAAI,QAAU,EAAA;AACZ,IAAA,KAAA,MAAW,CAAC,aAAe,EAAA,WAAW,KAAK,MAAO,CAAA,OAAA,CAAQ,QAAQ,CAAG,EAAA;AACnE,MAAA,IAAI,OAAO,WAAA,KAAgB,QAAY,IAAA,WAAA,KAAgB,EAAI,EAAA;AACzD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,0CAA0C,aAAa,CAAA,oCAAA,CAAA;AAAA,SACzD,CAAA;AAAA,OACF;AAEA,MAAA,MAAM,WAAc,GAAA,UAAA,CAAW,cAAe,CAAA,GAAA,CAAI,aAAa,CAAA,CAAA;AAC/D,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,2CAA2C,aAAa,CAAA,+BAAA,CAAA;AAAA,SAC1D,CAAA;AAAA,OACF;AACA,MAAI,IAAA,MAAA,CAAO,GAAI,CAAA,WAAW,CAAG,EAAA;AAC3B,QAAA,SAAA;AAAA,OACF;AACA,MAAA,MAAM,SAAY,GAAA,UAAA,CAAW,MAAO,CAAA,GAAA,CAAI,WAAW,CAAA,CAAA;AACnD,MAAA,IAAI,CAAC,SAAW,EAAA;AACd,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,uCAAA,EAA0C,aAAa,CAAA,KAAA,EAAQ,WAAW,CAAA,sBAAA,CAAA;AAAA,SAC5E,CAAA;AAAA,OACF;AAEA,MAAO,MAAA,CAAA,GAAA,CAAI,aAAa,SAAS,CAAA,CAAA;AAAA,KACnC;AAAA,GACF;AAGA,EAAA,KAAA,MAAW,WAAe,IAAA,UAAA,CAAW,cAAe,CAAA,MAAA,EAAU,EAAA;AAC5D,IAAA,IAAI,CAAC,MAAA,CAAO,GAAI,CAAA,WAAW,CAAG,EAAA;AAC5B,MAAA,MAAM,YACJ,GAAA,0BAAA,CAA2B,WAAW,CAAA,CAAE,gBAAiB,EAAA,CAAA;AAC3D,MAAA,IAAI,YAAc,EAAA;AAChB,QAAA,MAAM,UAAa,GAAA,UAAA,CAAW,MAAO,CAAA,GAAA,CAAI,YAAY,CAAA,CAAA;AACrD,QAAA,IAAI,UAAY,EAAA;AACd,UAAO,MAAA,CAAA,GAAA,CAAI,aAAa,UAAU,CAAA,CAAA;AAAA,SACpC;AAAA,OACF;AAAA,KACF;AAAA,GACF;AAEA,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}
+{"version":3,"file":"resolveRouteBindings.esm.js","sources":["../../src/routing/resolveRouteBindings.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 {\n  RouteRef,\n  SubRouteRef,\n  ExternalRouteRef,\n} from '@backstage/frontend-plugin-api';\nimport { RouteRefsById } from './collectRouteIds';\nimport { Config } from '@backstage/config';\nimport { JsonObject } from '@backstage/types';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExternalRouteRef } from '../../../frontend-plugin-api/src/routing/ExternalRouteRef';\n\n/**\n * Extracts a union of the keys in a map whose value extends the given type\n *\n * @ignore\n */\ntype KeysWithType<Obj extends { [key in string]: any }, Type> = {\n  [key in keyof Obj]: Obj[key] extends Type ? key : never;\n}[keyof Obj];\n\n/**\n * Takes a map Map required values and makes all keys matching Keys optional\n *\n * @ignore\n */\ntype PartialKeys<\n  Map extends { [name in string]: any },\n  Keys extends keyof Map,\n> = Partial<Pick<Map, Keys>> & Required<Omit<Map, Keys>>;\n\n/**\n * Creates a map of target routes with matching parameters based on a map of external routes.\n *\n * @ignore\n */\ntype TargetRouteMap<\n  ExternalRoutes extends { [name: string]: ExternalRouteRef },\n> = {\n  [name in keyof ExternalRoutes]: ExternalRoutes[name] extends ExternalRouteRef<\n    infer Params,\n    any\n  >\n    ? RouteRef<Params> | SubRouteRef<Params>\n    : never;\n};\n\n/**\n * A function that can bind from external routes of a given plugin, to concrete\n * routes of other plugins. See {@link createApp}.\n *\n * @public\n */\nexport type CreateAppRouteBinder = <\n  TExternalRoutes extends { [name: string]: ExternalRouteRef },\n>(\n  externalRoutes: TExternalRoutes,\n  targetRoutes: PartialKeys<\n    TargetRouteMap<TExternalRoutes>,\n    KeysWithType<TExternalRoutes, ExternalRouteRef<any, true>>\n  >,\n) => void;\n\n/** @internal */\nexport function resolveRouteBindings(\n  bindRoutes: ((context: { bind: CreateAppRouteBinder }) => void) | undefined,\n  config: Config,\n  routesById: RouteRefsById,\n): Map<ExternalRouteRef, RouteRef | SubRouteRef> {\n  const result = new Map<ExternalRouteRef, RouteRef | SubRouteRef>();\n\n  // Perform callback bindings first with highest priority\n  if (bindRoutes) {\n    const bind: CreateAppRouteBinder = (\n      externalRoutes,\n      targetRoutes: { [name: string]: RouteRef | SubRouteRef },\n    ) => {\n      for (const [key, value] of Object.entries(targetRoutes)) {\n        const externalRoute = externalRoutes[key];\n        if (!externalRoute) {\n          throw new Error(`Key ${key} is not an existing external route`);\n        }\n        if (!value && !externalRoute.optional) {\n          throw new Error(\n            `External route ${key} is required but was undefined`,\n          );\n        }\n        if (value) {\n          result.set(externalRoute, value);\n        }\n      }\n    };\n    bindRoutes({ bind });\n  }\n\n  // Then perform config based bindings with lower priority\n  const bindings = config\n    .getOptionalConfig('app.routes.bindings')\n    ?.get<JsonObject>();\n  const disabledExternalRefs = new Set<ExternalRouteRef>();\n  if (bindings) {\n    for (const [externalRefId, targetRefId] of Object.entries(bindings)) {\n      if (!isValidTargetRefId(targetRefId)) {\n        throw new Error(\n          `Invalid config at app.routes.bindings['${externalRefId}'], value must be a non-empty string or false`,\n        );\n      }\n\n      const externalRef = routesById.externalRoutes.get(externalRefId);\n      if (!externalRef) {\n        throw new Error(\n          `Invalid config at app.routes.bindings, '${externalRefId}' is not a valid external route`,\n        );\n      }\n\n      if (targetRefId === false) {\n        disabledExternalRefs.add(externalRef);\n\n        result.delete(externalRef);\n      } else if (!result.has(externalRef)) {\n        const targetRef = routesById.routes.get(targetRefId);\n        if (!targetRef) {\n          throw new Error(\n            `Invalid config at app.routes.bindings['${externalRefId}'], '${targetRefId}' is not a valid route`,\n          );\n        }\n\n        result.set(externalRef, targetRef);\n      }\n    }\n  }\n\n  // Finally fall back to attempting to map defaults, at lowest priority\n  for (const externalRef of routesById.externalRoutes.values()) {\n    if (!result.has(externalRef) && !disabledExternalRefs.has(externalRef)) {\n      const defaultRefId =\n        toInternalExternalRouteRef(externalRef).getDefaultTarget();\n      if (defaultRefId) {\n        const defaultRef = routesById.routes.get(defaultRefId);\n        if (defaultRef) {\n          result.set(externalRef, defaultRef);\n        }\n      }\n    }\n  }\n\n  return result;\n}\n\nfunction isValidTargetRefId(value: unknown): value is string | false {\n  if (value === false) {\n    return true;\n  }\n\n  if (typeof value === 'string' && value) {\n    return true;\n  }\n\n  return false;\n}\n"],"names":[],"mappings":";;AA+EgB,SAAA,oBAAA,CACd,UACA,EAAA,MAAA,EACA,UAC+C,EAAA;AAC/C,EAAM,MAAA,MAAA,uBAAa,GAA8C,EAAA,CAAA;AAGjE,EAAA,IAAI,UAAY,EAAA;AACd,IAAM,MAAA,IAAA,GAA6B,CACjC,cAAA,EACA,YACG,KAAA;AACH,MAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,YAAY,CAAG,EAAA;AACvD,QAAM,MAAA,aAAA,GAAgB,eAAe,GAAG,CAAA,CAAA;AACxC,QAAA,IAAI,CAAC,aAAe,EAAA;AAClB,UAAA,MAAM,IAAI,KAAA,CAAM,CAAO,IAAA,EAAA,GAAG,CAAoC,kCAAA,CAAA,CAAA,CAAA;AAAA,SAChE;AACA,QAAA,IAAI,CAAC,KAAA,IAAS,CAAC,aAAA,CAAc,QAAU,EAAA;AACrC,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,kBAAkB,GAAG,CAAA,8BAAA,CAAA;AAAA,WACvB,CAAA;AAAA,SACF;AACA,QAAA,IAAI,KAAO,EAAA;AACT,UAAO,MAAA,CAAA,GAAA,CAAI,eAAe,KAAK,CAAA,CAAA;AAAA,SACjC;AAAA,OACF;AAAA,KACF,CAAA;AACA,IAAW,UAAA,CAAA,EAAE,MAAM,CAAA,CAAA;AAAA,GACrB;AAGA,EAAA,MAAM,QAAW,GAAA,MAAA,CACd,iBAAkB,CAAA,qBAAqB,GACtC,GAAgB,EAAA,CAAA;AACpB,EAAM,MAAA,oBAAA,uBAA2B,GAAsB,EAAA,CAAA;AACvD,EAAA,IAAI,QAAU,EAAA;AACZ,IAAA,KAAA,MAAW,CAAC,aAAe,EAAA,WAAW,KAAK,MAAO,CAAA,OAAA,CAAQ,QAAQ,CAAG,EAAA;AACnE,MAAI,IAAA,CAAC,kBAAmB,CAAA,WAAW,CAAG,EAAA;AACpC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,0CAA0C,aAAa,CAAA,6CAAA,CAAA;AAAA,SACzD,CAAA;AAAA,OACF;AAEA,MAAA,MAAM,WAAc,GAAA,UAAA,CAAW,cAAe,CAAA,GAAA,CAAI,aAAa,CAAA,CAAA;AAC/D,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,2CAA2C,aAAa,CAAA,+BAAA,CAAA;AAAA,SAC1D,CAAA;AAAA,OACF;AAEA,MAAA,IAAI,gBAAgB,KAAO,EAAA;AACzB,QAAA,oBAAA,CAAqB,IAAI,WAAW,CAAA,CAAA;AAEpC,QAAA,MAAA,CAAO,OAAO,WAAW,CAAA,CAAA;AAAA,OAChB,MAAA,IAAA,CAAC,MAAO,CAAA,GAAA,CAAI,WAAW,CAAG,EAAA;AACnC,QAAA,MAAM,SAAY,GAAA,UAAA,CAAW,MAAO,CAAA,GAAA,CAAI,WAAW,CAAA,CAAA;AACnD,QAAA,IAAI,CAAC,SAAW,EAAA;AACd,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,CAAA,uCAAA,EAA0C,aAAa,CAAA,KAAA,EAAQ,WAAW,CAAA,sBAAA,CAAA;AAAA,WAC5E,CAAA;AAAA,SACF;AAEA,QAAO,MAAA,CAAA,GAAA,CAAI,aAAa,SAAS,CAAA,CAAA;AAAA,OACnC;AAAA,KACF;AAAA,GACF;AAGA,EAAA,KAAA,MAAW,WAAe,IAAA,UAAA,CAAW,cAAe,CAAA,MAAA,EAAU,EAAA;AAC5D,IAAI,IAAA,CAAC,OAAO,GAAI,CAAA,WAAW,KAAK,CAAC,oBAAA,CAAqB,GAAI,CAAA,WAAW,CAAG,EAAA;AACtE,MAAA,MAAM,YACJ,GAAA,0BAAA,CAA2B,WAAW,CAAA,CAAE,gBAAiB,EAAA,CAAA;AAC3D,MAAA,IAAI,YAAc,EAAA;AAChB,QAAA,MAAM,UAAa,GAAA,UAAA,CAAW,MAAO,CAAA,GAAA,CAAI,YAAY,CAAA,CAAA;AACrD,QAAA,IAAI,UAAY,EAAA;AACd,UAAO,MAAA,CAAA,GAAA,CAAI,aAAa,UAAU,CAAA,CAAA;AAAA,SACpC;AAAA,OACF;AAAA,KACF;AAAA,GACF;AAEA,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AAEA,SAAS,mBAAmB,KAAyC,EAAA;AACnE,EAAA,IAAI,UAAU,KAAO,EAAA;AACnB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAEA,EAAI,IAAA,OAAO,KAAU,KAAA,QAAA,IAAY,KAAO,EAAA;AACtC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAEA,EAAO,OAAA,KAAA,CAAA;AACT;;;;"}

package/dist/tree/resolveAppNodeSpecs.esm.js

@@ -101,8 +101,7 @@ function resolveAppNodeSpecs(options) {
   const duplicatedExtensionData = configuredExtensions.reduce((data, { extension, params }) => {
     const extensionId = extension.id;
     const extensionData = data?.[extensionId];
-    if (extensionData)
-      duplicatedExtensionIds.add(extensionId);
+    if (extensionData) duplicatedExtensionIds.add(extensionId);
     const pluginId = params.source?.id ?? "internal";
     const pluginCount = extensionData?.[pluginId] ?? 0;
     return {

package/dist/tree/resolveAppNodeSpecs.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolveAppNodeSpecs.esm.js","sources":["../../src/tree/resolveAppNodeSpecs.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  BackstagePlugin,\n  Extension,\n  ExtensionOverrides,\n  FrontendFeature,\n} from '@backstage/frontend-plugin-api';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExtensionOverrides } from '../../../frontend-plugin-api/src/wiring/createExtensionOverrides';\nimport { ExtensionParameters } from './readAppExtensionsConfig';\nimport { AppNodeSpec } from '@backstage/frontend-plugin-api';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalBackstagePlugin } from '../../../frontend-plugin-api/src/wiring/createPlugin';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExtension } from '../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition';\n\n/** @internal */\nexport function resolveAppNodeSpecs(options: {\n  features?: FrontendFeature[];\n  builtinExtensions?: Extension<unknown>[];\n  parameters?: Array<ExtensionParameters>;\n  forbidden?: Set<string>;\n}): AppNodeSpec[] {\n  const {\n    builtinExtensions = [],\n    parameters = [],\n    forbidden = new Set(),\n    features = [],\n  } = options;\n\n  const plugins = features.filter(\n    (f): f is BackstagePlugin => f.$$type === '@backstage/BackstagePlugin',\n  );\n  const overrides = features.filter(\n    (f): f is ExtensionOverrides =>\n      f.$$type === '@backstage/ExtensionOverrides',\n  );\n\n  const pluginExtensions = plugins.flatMap(source => {\n    return toInternalBackstagePlugin(source).extensions.map(extension => ({\n      ...extension,\n      source,\n    }));\n  });\n  const overrideExtensions = overrides.flatMap(\n    override => toInternalExtensionOverrides(override).extensions,\n  );\n\n  // Prevent core override\n  if (pluginExtensions.some(({ id }) => forbidden.has(id))) {\n    const pluginsStr = pluginExtensions\n      .filter(({ id }) => forbidden.has(id))\n      .map(({ source }) => `'${source.id}'`)\n      .join(', ');\n    const forbiddenStr = [...forbidden].map(id => `'${id}'`).join(', ');\n    throw new Error(\n      `It is forbidden to override the following extension(s): ${forbiddenStr}, which is done by the following plugin(s): ${pluginsStr}`,\n    );\n  }\n\n  if (overrideExtensions.some(({ id }) => forbidden.has(id))) {\n    const forbiddenStr = [...forbidden].map(id => `'${id}'`).join(', ');\n    throw new Error(\n      `It is forbidden to override the following extension(s): ${forbiddenStr}, which is done by one or more extension overrides`,\n    );\n  }\n  const overrideExtensionIds = overrideExtensions.map(({ id }) => id);\n  if (overrideExtensionIds.length !== new Set(overrideExtensionIds).size) {\n    const counts = new Map<string, number>();\n    for (const id of overrideExtensionIds) {\n      counts.set(id, (counts.get(id) ?? 0) + 1);\n    }\n    const duplicated = Array.from(counts.entries())\n      .filter(([, count]) => count > 1)\n      .map(([id]) => id);\n    throw new Error(\n      `The following extensions had duplicate overrides: ${duplicated.join(\n        ', ',\n      )}`,\n    );\n  }\n\n  const configuredExtensions = [\n    ...pluginExtensions.map(({ source, ...extension }) => {\n      const internalExtension = toInternalExtension(extension);\n      return {\n        extension: internalExtension,\n        params: {\n          source,\n          attachTo: internalExtension.attachTo,\n          disabled: internalExtension.disabled,\n          config: undefined as unknown,\n        },\n      };\n    }),\n    ...builtinExtensions.map(extension => {\n      const internalExtension = toInternalExtension(extension);\n      return {\n        extension: internalExtension,\n        params: {\n          source: undefined,\n          attachTo: internalExtension.attachTo,\n          disabled: internalExtension.disabled,\n          config: undefined as unknown,\n        },\n      };\n    }),\n  ];\n\n  // Install all extension overrides\n  for (const extension of overrideExtensions) {\n    const internalExtension = toInternalExtension(extension);\n\n    // Check if our override is overriding an extension that already exists\n    const index = configuredExtensions.findIndex(\n      e => e.extension.id === extension.id,\n    );\n    if (index !== -1) {\n      // Only implementation, attachment point and default disabled status are overridden, the source is kept\n      configuredExtensions[index].extension = internalExtension;\n      configuredExtensions[index].params.attachTo = internalExtension.attachTo;\n      configuredExtensions[index].params.disabled = internalExtension.disabled;\n    } else {\n      // Add the extension as a new one when not overriding an existing one\n      configuredExtensions.push({\n        extension: internalExtension,\n        params: {\n          source: undefined,\n          attachTo: internalExtension.attachTo,\n          disabled: internalExtension.disabled,\n          config: undefined,\n        },\n      });\n    }\n  }\n\n  const duplicatedExtensionIds = new Set<string>();\n  const duplicatedExtensionData = configuredExtensions.reduce<\n    Record<string, Record<string, number>>\n  >((data, { extension, params }) => {\n    const extensionId = extension.id;\n    const extensionData = data?.[extensionId];\n    if (extensionData) duplicatedExtensionIds.add(extensionId);\n    const pluginId = params.source?.id ?? 'internal';\n    const pluginCount = extensionData?.[pluginId] ?? 0;\n    return {\n      ...data,\n      [extensionId]: { ...extensionData, [pluginId]: pluginCount + 1 },\n    };\n  }, {});\n\n  if (duplicatedExtensionIds.size > 0) {\n    throw new Error(\n      `The following extensions are duplicated: ${Array.from(\n        duplicatedExtensionIds,\n      )\n        .map(\n          extensionId =>\n            `The extension '${extensionId}' was provided ${Object.keys(\n              duplicatedExtensionData[extensionId],\n            )\n              .map(\n                pluginId =>\n                  `${duplicatedExtensionData[extensionId][pluginId]} time(s) by the plugin '${pluginId}'`,\n              )\n              .join(' and ')}`,\n        )\n        .join(', ')}`,\n    );\n  }\n\n  const order = new Map<string, (typeof configuredExtensions)[number]>();\n  for (const overrideParam of parameters) {\n    const extensionId = overrideParam.id;\n\n    if (forbidden.has(extensionId)) {\n      throw new Error(\n        `Configuration of the '${extensionId}' extension is forbidden`,\n      );\n    }\n\n    const existing = configuredExtensions.find(\n      e => e.extension.id === extensionId,\n    );\n    if (existing) {\n      if (overrideParam.attachTo) {\n        existing.params.attachTo = overrideParam.attachTo;\n      }\n      if (overrideParam.config) {\n        // TODO: merge config?\n        existing.params.config = overrideParam.config;\n      }\n      if (\n        Boolean(existing.params.disabled) !== Boolean(overrideParam.disabled)\n      ) {\n        existing.params.disabled = Boolean(overrideParam.disabled);\n      }\n      order.set(extensionId, existing);\n    } else {\n      throw new Error(`Extension ${extensionId} does not exist`);\n    }\n  }\n\n  const orderedExtensions = [\n    ...order.values(),\n    ...configuredExtensions.filter(e => !order.has(e.extension.id)),\n  ];\n\n  return orderedExtensions.map(param => ({\n    id: param.extension.id,\n    attachTo: param.params.attachTo,\n    extension: param.extension,\n    disabled: param.params.disabled,\n    source: param.params.source,\n    config: param.params.config,\n  }));\n}\n"],"names":[],"mappings":";;;;AAgCO,SAAS,oBAAoB,OAKlB,EAAA;AAChB,EAAM,MAAA;AAAA,IACJ,oBAAoB,EAAC;AAAA,IACrB,aAAa,EAAC;AAAA,IACd,SAAA,uBAAgB,GAAI,EAAA;AAAA,IACpB,WAAW,EAAC;AAAA,GACV,GAAA,OAAA,CAAA;AAEJ,EAAA,MAAM,UAAU,QAAS,CAAA,MAAA;AAAA,IACvB,CAAC,CAA4B,KAAA,CAAA,CAAE,MAAW,KAAA,4BAAA;AAAA,GAC5C,CAAA;AACA,EAAA,MAAM,YAAY,QAAS,CAAA,MAAA;AAAA,IACzB,CAAC,CACC,KAAA,CAAA,CAAE,MAAW,KAAA,+BAAA;AAAA,GACjB,CAAA;AAEA,EAAM,MAAA,gBAAA,GAAmB,OAAQ,CAAA,OAAA,CAAQ,CAAU,MAAA,KAAA;AACjD,IAAA,OAAO,yBAA0B,CAAA,MAAM,CAAE,CAAA,UAAA,CAAW,IAAI,CAAc,SAAA,MAAA;AAAA,MACpE,GAAG,SAAA;AAAA,MACH,MAAA;AAAA,KACA,CAAA,CAAA,CAAA;AAAA,GACH,CAAA,CAAA;AACD,EAAA,MAAM,qBAAqB,SAAU,CAAA,OAAA;AAAA,IACnC,CAAA,QAAA,KAAY,4BAA6B,CAAA,QAAQ,CAAE,CAAA,UAAA;AAAA,GACrD,CAAA;AAGA,EAAI,IAAA,gBAAA,CAAiB,IAAK,CAAA,CAAC,EAAE,EAAA,OAAS,SAAU,CAAA,GAAA,CAAI,EAAE,CAAC,CAAG,EAAA;AACxD,IAAM,MAAA,UAAA,GAAa,iBAChB,MAAO,CAAA,CAAC,EAAE,EAAG,EAAA,KAAM,SAAU,CAAA,GAAA,CAAI,EAAE,CAAC,EACpC,GAAI,CAAA,CAAC,EAAE,MAAA,EAAa,KAAA,CAAA,CAAA,EAAI,OAAO,EAAE,CAAA,CAAA,CAAG,CACpC,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AACZ,IAAA,MAAM,YAAe,GAAA,CAAC,GAAG,SAAS,CAAE,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA,CAAA,CAAA,EAAI,EAAE,CAAA,CAAA,CAAG,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAClE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,wDAAA,EAA2D,YAAY,CAAA,4CAAA,EAA+C,UAAU,CAAA,CAAA;AAAA,KAClI,CAAA;AAAA,GACF;AAEA,EAAI,IAAA,kBAAA,CAAmB,IAAK,CAAA,CAAC,EAAE,EAAA,OAAS,SAAU,CAAA,GAAA,CAAI,EAAE,CAAC,CAAG,EAAA;AAC1D,IAAA,MAAM,YAAe,GAAA,CAAC,GAAG,SAAS,CAAE,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA,CAAA,CAAA,EAAI,EAAE,CAAA,CAAA,CAAG,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAClE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,2DAA2D,YAAY,CAAA,kDAAA,CAAA;AAAA,KACzE,CAAA;AAAA,GACF;AACA,EAAA,MAAM,uBAAuB,kBAAmB,CAAA,GAAA,CAAI,CAAC,EAAE,EAAA,OAAS,EAAE,CAAA,CAAA;AAClE,EAAA,IAAI,qBAAqB,MAAW,KAAA,IAAI,GAAI,CAAA,oBAAoB,EAAE,IAAM,EAAA;AACtE,IAAM,MAAA,MAAA,uBAAa,GAAoB,EAAA,CAAA;AACvC,IAAA,KAAA,MAAW,MAAM,oBAAsB,EAAA;AACrC,MAAA,MAAA,CAAO,IAAI,EAAK,EAAA,CAAA,MAAA,CAAO,IAAI,EAAE,CAAA,IAAK,KAAK,CAAC,CAAA,CAAA;AAAA,KAC1C;AACA,IAAM,MAAA,UAAA,GAAa,MAAM,IAAK,CAAA,MAAA,CAAO,SAAS,CAAA,CAC3C,OAAO,CAAC,GAAG,KAAK,CAAA,KAAM,QAAQ,CAAC,CAAA,CAC/B,IAAI,CAAC,CAAC,EAAE,CAAA,KAAM,EAAE,CAAA,CAAA;AACnB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,qDAAqD,UAAW,CAAA,IAAA;AAAA,QAC9D,IAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,oBAAuB,GAAA;AAAA,IAC3B,GAAG,iBAAiB,GAAI,CAAA,CAAC,EAAE,MAAQ,EAAA,GAAG,WAAgB,KAAA;AACpD,MAAM,MAAA,iBAAA,GAAoB,oBAAoB,SAAS,CAAA,CAAA;AACvD,MAAO,OAAA;AAAA,QACL,SAAW,EAAA,iBAAA;AAAA,QACX,MAAQ,EAAA;AAAA,UACN,MAAA;AAAA,UACA,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,MAAQ,EAAA,KAAA,CAAA;AAAA,SACV;AAAA,OACF,CAAA;AAAA,KACD,CAAA;AAAA,IACD,GAAG,iBAAkB,CAAA,GAAA,CAAI,CAAa,SAAA,KAAA;AACpC,MAAM,MAAA,iBAAA,GAAoB,oBAAoB,SAAS,CAAA,CAAA;AACvD,MAAO,OAAA;AAAA,QACL,SAAW,EAAA,iBAAA;AAAA,QACX,MAAQ,EAAA;AAAA,UACN,MAAQ,EAAA,KAAA,CAAA;AAAA,UACR,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,MAAQ,EAAA,KAAA,CAAA;AAAA,SACV;AAAA,OACF,CAAA;AAAA,KACD,CAAA;AAAA,GACH,CAAA;AAGA,EAAA,KAAA,MAAW,aAAa,kBAAoB,EAAA;AAC1C,IAAM,MAAA,iBAAA,GAAoB,oBAAoB,SAAS,CAAA,CAAA;AAGvD,IAAA,MAAM,QAAQ,oBAAqB,CAAA,SAAA;AAAA,MACjC,CAAK,CAAA,KAAA,CAAA,CAAE,SAAU,CAAA,EAAA,KAAO,SAAU,CAAA,EAAA;AAAA,KACpC,CAAA;AACA,IAAA,IAAI,UAAU,CAAI,CAAA,EAAA;AAEhB,MAAqB,oBAAA,CAAA,KAAK,EAAE,SAAY,GAAA,iBAAA,CAAA;AACxC,MAAA,oBAAA,CAAqB,KAAK,CAAA,CAAE,MAAO,CAAA,QAAA,GAAW,iBAAkB,CAAA,QAAA,CAAA;AAChE,MAAA,oBAAA,CAAqB,KAAK,CAAA,CAAE,MAAO,CAAA,QAAA,GAAW,iBAAkB,CAAA,QAAA,CAAA;AAAA,KAC3D,MAAA;AAEL,MAAA,oBAAA,CAAqB,IAAK,CAAA;AAAA,QACxB,SAAW,EAAA,iBAAA;AAAA,QACX,MAAQ,EAAA;AAAA,UACN,MAAQ,EAAA,KAAA,CAAA;AAAA,UACR,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,MAAQ,EAAA,KAAA,CAAA;AAAA,SACV;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF;AAEA,EAAM,MAAA,sBAAA,uBAA6B,GAAY,EAAA,CAAA;AAC/C,EAAM,MAAA,uBAAA,GAA0B,qBAAqB,MAEnD,CAAA,CAAC,MAAM,EAAE,SAAA,EAAW,QAAa,KAAA;AACjC,IAAA,MAAM,cAAc,SAAU,CAAA,EAAA,CAAA;AAC9B,IAAM,MAAA,aAAA,GAAgB,OAAO,WAAW,CAAA,CAAA;AACxC,IAAI,IAAA,aAAA;AAAe,MAAA,sBAAA,CAAuB,IAAI,WAAW,CAAA,CAAA;AACzD,IAAM,MAAA,QAAA,GAAW,MAAO,CAAA,MAAA,EAAQ,EAAM,IAAA,UAAA,CAAA;AACtC,IAAM,MAAA,WAAA,GAAc,aAAgB,GAAA,QAAQ,CAAK,IAAA,CAAA,CAAA;AACjD,IAAO,OAAA;AAAA,MACL,GAAG,IAAA;AAAA,MACH,CAAC,WAAW,GAAG,EAAE,GAAG,eAAe,CAAC,QAAQ,GAAG,WAAA,GAAc,CAAE,EAAA;AAAA,KACjE,CAAA;AAAA,GACF,EAAG,EAAE,CAAA,CAAA;AAEL,EAAI,IAAA,sBAAA,CAAuB,OAAO,CAAG,EAAA;AACnC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,4CAA4C,KAAM,CAAA,IAAA;AAAA,QAChD,sBAAA;AAAA,OAEC,CAAA,GAAA;AAAA,QACC,CACE,WAAA,KAAA,CAAA,eAAA,EAAkB,WAAW,CAAA,eAAA,EAAkB,MAAO,CAAA,IAAA;AAAA,UACpD,wBAAwB,WAAW,CAAA;AAAA,SAElC,CAAA,GAAA;AAAA,UACC,CAAA,QAAA,KACE,GAAG,uBAAwB,CAAA,WAAW,EAAE,QAAQ,CAAC,2BAA2B,QAAQ,CAAA,CAAA,CAAA;AAAA,SACxF,CACC,IAAK,CAAA,OAAO,CAAC,CAAA,CAAA;AAAA,OACpB,CACC,IAAK,CAAA,IAAI,CAAC,CAAA,CAAA;AAAA,KACf,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,KAAA,uBAAY,GAAmD,EAAA,CAAA;AACrE,EAAA,KAAA,MAAW,iBAAiB,UAAY,EAAA;AACtC,IAAA,MAAM,cAAc,aAAc,CAAA,EAAA,CAAA;AAElC,IAAI,IAAA,SAAA,CAAU,GAAI,CAAA,WAAW,CAAG,EAAA;AAC9B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,yBAAyB,WAAW,CAAA,wBAAA,CAAA;AAAA,OACtC,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,WAAW,oBAAqB,CAAA,IAAA;AAAA,MACpC,CAAA,CAAA,KAAK,CAAE,CAAA,SAAA,CAAU,EAAO,KAAA,WAAA;AAAA,KAC1B,CAAA;AACA,IAAA,IAAI,QAAU,EAAA;AACZ,MAAA,IAAI,cAAc,QAAU,EAAA;AAC1B,QAAS,QAAA,CAAA,MAAA,CAAO,WAAW,aAAc,CAAA,QAAA,CAAA;AAAA,OAC3C;AACA,MAAA,IAAI,cAAc,MAAQ,EAAA;AAExB,QAAS,QAAA,CAAA,MAAA,CAAO,SAAS,aAAc,CAAA,MAAA,CAAA;AAAA,OACzC;AACA,MACE,IAAA,OAAA,CAAQ,SAAS,MAAO,CAAA,QAAQ,MAAM,OAAQ,CAAA,aAAA,CAAc,QAAQ,CACpE,EAAA;AACA,QAAA,QAAA,CAAS,MAAO,CAAA,QAAA,GAAW,OAAQ,CAAA,aAAA,CAAc,QAAQ,CAAA,CAAA;AAAA,OAC3D;AACA,MAAM,KAAA,CAAA,GAAA,CAAI,aAAa,QAAQ,CAAA,CAAA;AAAA,KAC1B,MAAA;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAa,UAAA,EAAA,WAAW,CAAiB,eAAA,CAAA,CAAA,CAAA;AAAA,KAC3D;AAAA,GACF;AAEA,EAAA,MAAM,iBAAoB,GAAA;AAAA,IACxB,GAAG,MAAM,MAAO,EAAA;AAAA,IAChB,GAAG,oBAAqB,CAAA,MAAA,CAAO,CAAK,CAAA,KAAA,CAAC,MAAM,GAAI,CAAA,CAAA,CAAE,SAAU,CAAA,EAAE,CAAC,CAAA;AAAA,GAChE,CAAA;AAEA,EAAO,OAAA,iBAAA,CAAkB,IAAI,CAAU,KAAA,MAAA;AAAA,IACrC,EAAA,EAAI,MAAM,SAAU,CAAA,EAAA;AAAA,IACpB,QAAA,EAAU,MAAM,MAAO,CAAA,QAAA;AAAA,IACvB,WAAW,KAAM,CAAA,SAAA;AAAA,IACjB,QAAA,EAAU,MAAM,MAAO,CAAA,QAAA;AAAA,IACvB,MAAA,EAAQ,MAAM,MAAO,CAAA,MAAA;AAAA,IACrB,MAAA,EAAQ,MAAM,MAAO,CAAA,MAAA;AAAA,GACrB,CAAA,CAAA,CAAA;AACJ;;;;"}
+{"version":3,"file":"resolveAppNodeSpecs.esm.js","sources":["../../src/tree/resolveAppNodeSpecs.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  BackstagePlugin,\n  Extension,\n  ExtensionOverrides,\n  FrontendFeature,\n} from '@backstage/frontend-plugin-api';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExtensionOverrides } from '../../../frontend-plugin-api/src/wiring/createExtensionOverrides';\nimport { ExtensionParameters } from './readAppExtensionsConfig';\nimport { AppNodeSpec } from '@backstage/frontend-plugin-api';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalBackstagePlugin } from '../../../frontend-plugin-api/src/wiring/createPlugin';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExtension } from '../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition';\n\n/** @internal */\nexport function resolveAppNodeSpecs(options: {\n  features?: FrontendFeature[];\n  builtinExtensions?: Extension<unknown>[];\n  parameters?: Array<ExtensionParameters>;\n  forbidden?: Set<string>;\n}): AppNodeSpec[] {\n  const {\n    builtinExtensions = [],\n    parameters = [],\n    forbidden = new Set(),\n    features = [],\n  } = options;\n\n  const plugins = features.filter(\n    (f): f is BackstagePlugin => f.$$type === '@backstage/BackstagePlugin',\n  );\n  const overrides = features.filter(\n    (f): f is ExtensionOverrides =>\n      f.$$type === '@backstage/ExtensionOverrides',\n  );\n\n  const pluginExtensions = plugins.flatMap(source => {\n    return toInternalBackstagePlugin(source).extensions.map(extension => ({\n      ...extension,\n      source,\n    }));\n  });\n  const overrideExtensions = overrides.flatMap(\n    override => toInternalExtensionOverrides(override).extensions,\n  );\n\n  // Prevent core override\n  if (pluginExtensions.some(({ id }) => forbidden.has(id))) {\n    const pluginsStr = pluginExtensions\n      .filter(({ id }) => forbidden.has(id))\n      .map(({ source }) => `'${source.id}'`)\n      .join(', ');\n    const forbiddenStr = [...forbidden].map(id => `'${id}'`).join(', ');\n    throw new Error(\n      `It is forbidden to override the following extension(s): ${forbiddenStr}, which is done by the following plugin(s): ${pluginsStr}`,\n    );\n  }\n\n  if (overrideExtensions.some(({ id }) => forbidden.has(id))) {\n    const forbiddenStr = [...forbidden].map(id => `'${id}'`).join(', ');\n    throw new Error(\n      `It is forbidden to override the following extension(s): ${forbiddenStr}, which is done by one or more extension overrides`,\n    );\n  }\n  const overrideExtensionIds = overrideExtensions.map(({ id }) => id);\n  if (overrideExtensionIds.length !== new Set(overrideExtensionIds).size) {\n    const counts = new Map<string, number>();\n    for (const id of overrideExtensionIds) {\n      counts.set(id, (counts.get(id) ?? 0) + 1);\n    }\n    const duplicated = Array.from(counts.entries())\n      .filter(([, count]) => count > 1)\n      .map(([id]) => id);\n    throw new Error(\n      `The following extensions had duplicate overrides: ${duplicated.join(\n        ', ',\n      )}`,\n    );\n  }\n\n  const configuredExtensions = [\n    ...pluginExtensions.map(({ source, ...extension }) => {\n      const internalExtension = toInternalExtension(extension);\n      return {\n        extension: internalExtension,\n        params: {\n          source,\n          attachTo: internalExtension.attachTo,\n          disabled: internalExtension.disabled,\n          config: undefined as unknown,\n        },\n      };\n    }),\n    ...builtinExtensions.map(extension => {\n      const internalExtension = toInternalExtension(extension);\n      return {\n        extension: internalExtension,\n        params: {\n          source: undefined,\n          attachTo: internalExtension.attachTo,\n          disabled: internalExtension.disabled,\n          config: undefined as unknown,\n        },\n      };\n    }),\n  ];\n\n  // Install all extension overrides\n  for (const extension of overrideExtensions) {\n    const internalExtension = toInternalExtension(extension);\n\n    // Check if our override is overriding an extension that already exists\n    const index = configuredExtensions.findIndex(\n      e => e.extension.id === extension.id,\n    );\n    if (index !== -1) {\n      // Only implementation, attachment point and default disabled status are overridden, the source is kept\n      configuredExtensions[index].extension = internalExtension;\n      configuredExtensions[index].params.attachTo = internalExtension.attachTo;\n      configuredExtensions[index].params.disabled = internalExtension.disabled;\n    } else {\n      // Add the extension as a new one when not overriding an existing one\n      configuredExtensions.push({\n        extension: internalExtension,\n        params: {\n          source: undefined,\n          attachTo: internalExtension.attachTo,\n          disabled: internalExtension.disabled,\n          config: undefined,\n        },\n      });\n    }\n  }\n\n  const duplicatedExtensionIds = new Set<string>();\n  const duplicatedExtensionData = configuredExtensions.reduce<\n    Record<string, Record<string, number>>\n  >((data, { extension, params }) => {\n    const extensionId = extension.id;\n    const extensionData = data?.[extensionId];\n    if (extensionData) duplicatedExtensionIds.add(extensionId);\n    const pluginId = params.source?.id ?? 'internal';\n    const pluginCount = extensionData?.[pluginId] ?? 0;\n    return {\n      ...data,\n      [extensionId]: { ...extensionData, [pluginId]: pluginCount + 1 },\n    };\n  }, {});\n\n  if (duplicatedExtensionIds.size > 0) {\n    throw new Error(\n      `The following extensions are duplicated: ${Array.from(\n        duplicatedExtensionIds,\n      )\n        .map(\n          extensionId =>\n            `The extension '${extensionId}' was provided ${Object.keys(\n              duplicatedExtensionData[extensionId],\n            )\n              .map(\n                pluginId =>\n                  `${duplicatedExtensionData[extensionId][pluginId]} time(s) by the plugin '${pluginId}'`,\n              )\n              .join(' and ')}`,\n        )\n        .join(', ')}`,\n    );\n  }\n\n  const order = new Map<string, (typeof configuredExtensions)[number]>();\n  for (const overrideParam of parameters) {\n    const extensionId = overrideParam.id;\n\n    if (forbidden.has(extensionId)) {\n      throw new Error(\n        `Configuration of the '${extensionId}' extension is forbidden`,\n      );\n    }\n\n    const existing = configuredExtensions.find(\n      e => e.extension.id === extensionId,\n    );\n    if (existing) {\n      if (overrideParam.attachTo) {\n        existing.params.attachTo = overrideParam.attachTo;\n      }\n      if (overrideParam.config) {\n        // TODO: merge config?\n        existing.params.config = overrideParam.config;\n      }\n      if (\n        Boolean(existing.params.disabled) !== Boolean(overrideParam.disabled)\n      ) {\n        existing.params.disabled = Boolean(overrideParam.disabled);\n      }\n      order.set(extensionId, existing);\n    } else {\n      throw new Error(`Extension ${extensionId} does not exist`);\n    }\n  }\n\n  const orderedExtensions = [\n    ...order.values(),\n    ...configuredExtensions.filter(e => !order.has(e.extension.id)),\n  ];\n\n  return orderedExtensions.map(param => ({\n    id: param.extension.id,\n    attachTo: param.params.attachTo,\n    extension: param.extension,\n    disabled: param.params.disabled,\n    source: param.params.source,\n    config: param.params.config,\n  }));\n}\n"],"names":[],"mappings":";;;;AAgCO,SAAS,oBAAoB,OAKlB,EAAA;AAChB,EAAM,MAAA;AAAA,IACJ,oBAAoB,EAAC;AAAA,IACrB,aAAa,EAAC;AAAA,IACd,SAAA,uBAAgB,GAAI,EAAA;AAAA,IACpB,WAAW,EAAC;AAAA,GACV,GAAA,OAAA,CAAA;AAEJ,EAAA,MAAM,UAAU,QAAS,CAAA,MAAA;AAAA,IACvB,CAAC,CAA4B,KAAA,CAAA,CAAE,MAAW,KAAA,4BAAA;AAAA,GAC5C,CAAA;AACA,EAAA,MAAM,YAAY,QAAS,CAAA,MAAA;AAAA,IACzB,CAAC,CACC,KAAA,CAAA,CAAE,MAAW,KAAA,+BAAA;AAAA,GACjB,CAAA;AAEA,EAAM,MAAA,gBAAA,GAAmB,OAAQ,CAAA,OAAA,CAAQ,CAAU,MAAA,KAAA;AACjD,IAAA,OAAO,yBAA0B,CAAA,MAAM,CAAE,CAAA,UAAA,CAAW,IAAI,CAAc,SAAA,MAAA;AAAA,MACpE,GAAG,SAAA;AAAA,MACH,MAAA;AAAA,KACA,CAAA,CAAA,CAAA;AAAA,GACH,CAAA,CAAA;AACD,EAAA,MAAM,qBAAqB,SAAU,CAAA,OAAA;AAAA,IACnC,CAAA,QAAA,KAAY,4BAA6B,CAAA,QAAQ,CAAE,CAAA,UAAA;AAAA,GACrD,CAAA;AAGA,EAAI,IAAA,gBAAA,CAAiB,IAAK,CAAA,CAAC,EAAE,EAAA,OAAS,SAAU,CAAA,GAAA,CAAI,EAAE,CAAC,CAAG,EAAA;AACxD,IAAM,MAAA,UAAA,GAAa,iBAChB,MAAO,CAAA,CAAC,EAAE,EAAG,EAAA,KAAM,SAAU,CAAA,GAAA,CAAI,EAAE,CAAC,EACpC,GAAI,CAAA,CAAC,EAAE,MAAA,EAAa,KAAA,CAAA,CAAA,EAAI,OAAO,EAAE,CAAA,CAAA,CAAG,CACpC,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AACZ,IAAA,MAAM,YAAe,GAAA,CAAC,GAAG,SAAS,CAAE,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA,CAAA,CAAA,EAAI,EAAE,CAAA,CAAA,CAAG,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAClE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,wDAAA,EAA2D,YAAY,CAAA,4CAAA,EAA+C,UAAU,CAAA,CAAA;AAAA,KAClI,CAAA;AAAA,GACF;AAEA,EAAI,IAAA,kBAAA,CAAmB,IAAK,CAAA,CAAC,EAAE,EAAA,OAAS,SAAU,CAAA,GAAA,CAAI,EAAE,CAAC,CAAG,EAAA;AAC1D,IAAA,MAAM,YAAe,GAAA,CAAC,GAAG,SAAS,CAAE,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA,CAAA,CAAA,EAAI,EAAE,CAAA,CAAA,CAAG,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAClE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,2DAA2D,YAAY,CAAA,kDAAA,CAAA;AAAA,KACzE,CAAA;AAAA,GACF;AACA,EAAA,MAAM,uBAAuB,kBAAmB,CAAA,GAAA,CAAI,CAAC,EAAE,EAAA,OAAS,EAAE,CAAA,CAAA;AAClE,EAAA,IAAI,qBAAqB,MAAW,KAAA,IAAI,GAAI,CAAA,oBAAoB,EAAE,IAAM,EAAA;AACtE,IAAM,MAAA,MAAA,uBAAa,GAAoB,EAAA,CAAA;AACvC,IAAA,KAAA,MAAW,MAAM,oBAAsB,EAAA;AACrC,MAAA,MAAA,CAAO,IAAI,EAAK,EAAA,CAAA,MAAA,CAAO,IAAI,EAAE,CAAA,IAAK,KAAK,CAAC,CAAA,CAAA;AAAA,KAC1C;AACA,IAAM,MAAA,UAAA,GAAa,MAAM,IAAK,CAAA,MAAA,CAAO,SAAS,CAAA,CAC3C,OAAO,CAAC,GAAG,KAAK,CAAA,KAAM,QAAQ,CAAC,CAAA,CAC/B,IAAI,CAAC,CAAC,EAAE,CAAA,KAAM,EAAE,CAAA,CAAA;AACnB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,qDAAqD,UAAW,CAAA,IAAA;AAAA,QAC9D,IAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,oBAAuB,GAAA;AAAA,IAC3B,GAAG,iBAAiB,GAAI,CAAA,CAAC,EAAE,MAAQ,EAAA,GAAG,WAAgB,KAAA;AACpD,MAAM,MAAA,iBAAA,GAAoB,oBAAoB,SAAS,CAAA,CAAA;AACvD,MAAO,OAAA;AAAA,QACL,SAAW,EAAA,iBAAA;AAAA,QACX,MAAQ,EAAA;AAAA,UACN,MAAA;AAAA,UACA,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,MAAQ,EAAA,KAAA,CAAA;AAAA,SACV;AAAA,OACF,CAAA;AAAA,KACD,CAAA;AAAA,IACD,GAAG,iBAAkB,CAAA,GAAA,CAAI,CAAa,SAAA,KAAA;AACpC,MAAM,MAAA,iBAAA,GAAoB,oBAAoB,SAAS,CAAA,CAAA;AACvD,MAAO,OAAA;AAAA,QACL,SAAW,EAAA,iBAAA;AAAA,QACX,MAAQ,EAAA;AAAA,UACN,MAAQ,EAAA,KAAA,CAAA;AAAA,UACR,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,MAAQ,EAAA,KAAA,CAAA;AAAA,SACV;AAAA,OACF,CAAA;AAAA,KACD,CAAA;AAAA,GACH,CAAA;AAGA,EAAA,KAAA,MAAW,aAAa,kBAAoB,EAAA;AAC1C,IAAM,MAAA,iBAAA,GAAoB,oBAAoB,SAAS,CAAA,CAAA;AAGvD,IAAA,MAAM,QAAQ,oBAAqB,CAAA,SAAA;AAAA,MACjC,CAAK,CAAA,KAAA,CAAA,CAAE,SAAU,CAAA,EAAA,KAAO,SAAU,CAAA,EAAA;AAAA,KACpC,CAAA;AACA,IAAA,IAAI,UAAU,CAAI,CAAA,EAAA;AAEhB,MAAqB,oBAAA,CAAA,KAAK,EAAE,SAAY,GAAA,iBAAA,CAAA;AACxC,MAAA,oBAAA,CAAqB,KAAK,CAAA,CAAE,MAAO,CAAA,QAAA,GAAW,iBAAkB,CAAA,QAAA,CAAA;AAChE,MAAA,oBAAA,CAAqB,KAAK,CAAA,CAAE,MAAO,CAAA,QAAA,GAAW,iBAAkB,CAAA,QAAA,CAAA;AAAA,KAC3D,MAAA;AAEL,MAAA,oBAAA,CAAqB,IAAK,CAAA;AAAA,QACxB,SAAW,EAAA,iBAAA;AAAA,QACX,MAAQ,EAAA;AAAA,UACN,MAAQ,EAAA,KAAA,CAAA;AAAA,UACR,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,UAAU,iBAAkB,CAAA,QAAA;AAAA,UAC5B,MAAQ,EAAA,KAAA,CAAA;AAAA,SACV;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF;AAEA,EAAM,MAAA,sBAAA,uBAA6B,GAAY,EAAA,CAAA;AAC/C,EAAM,MAAA,uBAAA,GAA0B,qBAAqB,MAEnD,CAAA,CAAC,MAAM,EAAE,SAAA,EAAW,QAAa,KAAA;AACjC,IAAA,MAAM,cAAc,SAAU,CAAA,EAAA,CAAA;AAC9B,IAAM,MAAA,aAAA,GAAgB,OAAO,WAAW,CAAA,CAAA;AACxC,IAAI,IAAA,aAAA,EAAsC,sBAAA,CAAA,GAAA,CAAI,WAAW,CAAA,CAAA;AACzD,IAAM,MAAA,QAAA,GAAW,MAAO,CAAA,MAAA,EAAQ,EAAM,IAAA,UAAA,CAAA;AACtC,IAAM,MAAA,WAAA,GAAc,aAAgB,GAAA,QAAQ,CAAK,IAAA,CAAA,CAAA;AACjD,IAAO,OAAA;AAAA,MACL,GAAG,IAAA;AAAA,MACH,CAAC,WAAW,GAAG,EAAE,GAAG,eAAe,CAAC,QAAQ,GAAG,WAAA,GAAc,CAAE,EAAA;AAAA,KACjE,CAAA;AAAA,GACF,EAAG,EAAE,CAAA,CAAA;AAEL,EAAI,IAAA,sBAAA,CAAuB,OAAO,CAAG,EAAA;AACnC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,4CAA4C,KAAM,CAAA,IAAA;AAAA,QAChD,sBAAA;AAAA,OAEC,CAAA,GAAA;AAAA,QACC,CACE,WAAA,KAAA,CAAA,eAAA,EAAkB,WAAW,CAAA,eAAA,EAAkB,MAAO,CAAA,IAAA;AAAA,UACpD,wBAAwB,WAAW,CAAA;AAAA,SAElC,CAAA,GAAA;AAAA,UACC,CAAA,QAAA,KACE,GAAG,uBAAwB,CAAA,WAAW,EAAE,QAAQ,CAAC,2BAA2B,QAAQ,CAAA,CAAA,CAAA;AAAA,SACxF,CACC,IAAK,CAAA,OAAO,CAAC,CAAA,CAAA;AAAA,OACpB,CACC,IAAK,CAAA,IAAI,CAAC,CAAA,CAAA;AAAA,KACf,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,KAAA,uBAAY,GAAmD,EAAA,CAAA;AACrE,EAAA,KAAA,MAAW,iBAAiB,UAAY,EAAA;AACtC,IAAA,MAAM,cAAc,aAAc,CAAA,EAAA,CAAA;AAElC,IAAI,IAAA,SAAA,CAAU,GAAI,CAAA,WAAW,CAAG,EAAA;AAC9B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,yBAAyB,WAAW,CAAA,wBAAA,CAAA;AAAA,OACtC,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,WAAW,oBAAqB,CAAA,IAAA;AAAA,MACpC,CAAA,CAAA,KAAK,CAAE,CAAA,SAAA,CAAU,EAAO,KAAA,WAAA;AAAA,KAC1B,CAAA;AACA,IAAA,IAAI,QAAU,EAAA;AACZ,MAAA,IAAI,cAAc,QAAU,EAAA;AAC1B,QAAS,QAAA,CAAA,MAAA,CAAO,WAAW,aAAc,CAAA,QAAA,CAAA;AAAA,OAC3C;AACA,MAAA,IAAI,cAAc,MAAQ,EAAA;AAExB,QAAS,QAAA,CAAA,MAAA,CAAO,SAAS,aAAc,CAAA,MAAA,CAAA;AAAA,OACzC;AACA,MACE,IAAA,OAAA,CAAQ,SAAS,MAAO,CAAA,QAAQ,MAAM,OAAQ,CAAA,aAAA,CAAc,QAAQ,CACpE,EAAA;AACA,QAAA,QAAA,CAAS,MAAO,CAAA,QAAA,GAAW,OAAQ,CAAA,aAAA,CAAc,QAAQ,CAAA,CAAA;AAAA,OAC3D;AACA,MAAM,KAAA,CAAA,GAAA,CAAI,aAAa,QAAQ,CAAA,CAAA;AAAA,KAC1B,MAAA;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAa,UAAA,EAAA,WAAW,CAAiB,eAAA,CAAA,CAAA,CAAA;AAAA,KAC3D;AAAA,GACF;AAEA,EAAA,MAAM,iBAAoB,GAAA;AAAA,IACxB,GAAG,MAAM,MAAO,EAAA;AAAA,IAChB,GAAG,oBAAqB,CAAA,MAAA,CAAO,CAAK,CAAA,KAAA,CAAC,MAAM,GAAI,CAAA,CAAA,CAAE,SAAU,CAAA,EAAE,CAAC,CAAA;AAAA,GAChE,CAAA;AAEA,EAAO,OAAA,iBAAA,CAAkB,IAAI,CAAU,KAAA,MAAA;AAAA,IACrC,EAAA,EAAI,MAAM,SAAU,CAAA,EAAA;AAAA,IACpB,QAAA,EAAU,MAAM,MAAO,CAAA,QAAA;AAAA,IACvB,WAAW,KAAM,CAAA,SAAA;AAAA,IACjB,QAAA,EAAU,MAAM,MAAO,CAAA,QAAA;AAAA,IACvB,MAAA,EAAQ,MAAM,MAAO,CAAA,MAAA;AAAA,IACrB,MAAA,EAAQ,MAAM,MAAO,CAAA,MAAA;AAAA,GACrB,CAAA,CAAA,CAAA;AACJ;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/frontend-app-api",
-  "version": "0.7.1",
+  "version": "0.7.2-next.0",
   "backstage": {
     "role": "web-library"
   },
@@ -33,11 +33,11 @@
   },
   "dependencies": {
     "@backstage/config": "^1.2.0",
-    "@backstage/core-app-api": "^1.12.6",
-    "@backstage/core-components": "^0.14.8",
+    "@backstage/core-app-api": "^1.13.0-next.0",
+    "@backstage/core-components": "^0.14.9-next.0",
     "@backstage/core-plugin-api": "^1.9.3",
     "@backstage/errors": "^1.2.4",
-    "@backstage/frontend-plugin-api": "^0.6.6",
+    "@backstage/frontend-plugin-api": "^0.6.7-next.0",
     "@backstage/theme": "^0.5.6",
     "@backstage/types": "^1.1.1",
     "@backstage/version-bridge": "^1.0.8",
@@ -47,8 +47,8 @@
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.26.7",
-    "@backstage/test-utils": "^1.5.6",
+    "@backstage/cli": "^0.26.10-next.0",
+    "@backstage/test-utils": "^1.5.7-next.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^15.0.0"
   },