@backstage/frontend-app-api 0.16.0-next.1 → 0.16.1

package/dist/wiring/phaseApis.esm.js

@@ -0,0 +1,161 @@
+import { createApiFactory, appTreeApiRef, configApiRef, routeResolutionApiRef, identityApiRef } from '@backstage/frontend-plugin-api';
+import { matchRoutes } from 'react-router-dom';
+import { AppIdentityProxy } from '../core-app-api/src/apis/implementations/IdentityApi/AppIdentityProxy.esm.js';
+import { createRouteAliasResolver } from '../routing/RouteAliasResolver.esm.js';
+import { RouteResolver } from '../routing/RouteResolver.esm.js';
+import { extractRouteInfoFromAppNode } from '../routing/extractRouteInfoFromAppNode.esm.js';
+import { instantiateAppNodeTree } from '../tree/instantiateAppNodeTree.esm.js';
+import { FrontendApiRegistry, FrontendApiResolver } from './FrontendApiRegistry.esm.js';
+
+class AppTreeApiProxy {
+  #routeInfo;
+  tree;
+  appBasePath;
+  constructor(tree, appBasePath) {
+    this.tree = tree;
+    this.appBasePath = appBasePath;
+  }
+  checkIfInitialized() {
+    if (!this.#routeInfo) {
+      throw new Error(
+        `You can't access the AppTreeApi during initialization of the app tree. Please move occurrences of this out of the initialization of the factory`
+      );
+    }
+  }
+  getTree() {
+    this.checkIfInitialized();
+    return { tree: this.tree };
+  }
+  getNodesByRoutePath(routePath) {
+    this.checkIfInitialized();
+    const routeInfo = this.#routeInfo;
+    if (!routeInfo) {
+      throw new Error(
+        `You can't access the AppTreeApi during initialization of the app tree. Please move occurrences of this out of the initialization of the factory`
+      );
+    }
+    let path = routePath;
+    if (path.startsWith(this.appBasePath)) {
+      path = path.slice(this.appBasePath.length);
+    }
+    const matchedRoutes = matchRoutes(routeInfo.routeObjects, path);
+    const matchedAppNodes = matchedRoutes?.flatMap((routeObj) => {
+      const appNode = routeObj.route.appNode;
+      return appNode ? [appNode] : [];
+    }) || [];
+    return { nodes: matchedAppNodes };
+  }
+  initialize(routeInfo) {
+    this.#routeInfo = routeInfo;
+  }
+}
+class RouteResolutionApiProxy {
+  #delegate;
+  #routeObjects;
+  routeBindings;
+  appBasePath;
+  constructor(routeBindings, appBasePath) {
+    this.routeBindings = routeBindings;
+    this.appBasePath = appBasePath;
+  }
+  resolve(anyRouteRef, options) {
+    if (!this.#delegate) {
+      throw new Error(
+        `You can't access the RouteResolver during initialization of the app tree. Please move occurrences of this out of the initialization of the factory`
+      );
+    }
+    return this.#delegate.resolve(anyRouteRef, options);
+  }
+  initialize(routeInfo, routeRefsById) {
+    this.#delegate = new RouteResolver(
+      routeInfo.routePaths,
+      routeInfo.routeParents,
+      routeInfo.routeObjects,
+      this.routeBindings,
+      this.appBasePath,
+      routeInfo.routeAliasResolver,
+      routeRefsById
+    );
+    this.#routeObjects = routeInfo.routeObjects;
+    return routeInfo;
+  }
+  getRouteObjects() {
+    return this.#routeObjects;
+  }
+}
+class PreparedAppIdentityProxy extends AppIdentityProxy {
+  #onTargetSet;
+  setTargetHandlers(options) {
+    this.#onTargetSet = options.onTargetSet;
+  }
+  clearTargetHandlers() {
+    this.#onTargetSet = void 0;
+  }
+  setTarget(identityApi, targetOptions) {
+    super.setTarget(identityApi, targetOptions);
+    const onTargetSet = this.#onTargetSet;
+    if (!onTargetSet) {
+      return;
+    }
+    this.clearTargetHandlers();
+    onTargetSet(identityApi);
+  }
+}
+function createPhaseApis(options) {
+  const appTreeApi = new AppTreeApiProxy(options.tree, options.appBasePath);
+  const routeResolutionApi = new RouteResolutionApiProxy(
+    options.routeBindings,
+    options.appBasePath
+  );
+  const identityProxy = new PreparedAppIdentityProxy();
+  const phaseApiRegistry = new FrontendApiRegistry();
+  phaseApiRegistry.registerAll([
+    createApiFactory(appTreeApiRef, appTreeApi),
+    ...options.includeConfigApi ? [createApiFactory(configApiRef, options.config)] : [],
+    createApiFactory(routeResolutionApiRef, routeResolutionApi),
+    createApiFactory(identityApiRef, identityProxy),
+    ...options.staticFactories
+  ]);
+  const apis = new FrontendApiResolver({
+    primaryRegistry: phaseApiRegistry,
+    secondaryRegistry: options.appApiRegistry,
+    fallbackApis: options.fallbackApis
+  });
+  return {
+    apis,
+    routeResolutionApi,
+    appTreeApi,
+    identityApiProxy: identityProxy
+  };
+}
+function instantiateAndInitializePhaseTree(options) {
+  instantiateAppNodeTree(
+    options.tree.root,
+    options.apis,
+    options.collector,
+    options.extensionFactoryMiddleware,
+    {
+      ...options.stopAtAttachment ? { stopAtAttachment: options.stopAtAttachment } : {},
+      skipChild: options.skipChild,
+      onMissingApi: options.onMissingApi,
+      predicateContext: options.predicateContext
+    }
+  );
+  const routeInfo = extractRouteInfoFromAppNode(
+    options.tree.root,
+    createRouteAliasResolver(options.routeRefsById)
+  );
+  options.routeResolutionApi.initialize(
+    routeInfo,
+    options.routeRefsById.routes
+  );
+  options.appTreeApi.initialize(routeInfo);
+}
+function setIdentityApiTarget(options) {
+  options.identityApiProxy.setTarget(options.identityApi, {
+    signOutTargetUrl: options.signOutTargetUrl
+  });
+}
+
+export { AppTreeApiProxy, PreparedAppIdentityProxy, RouteResolutionApiProxy, createPhaseApis, instantiateAndInitializePhaseTree, setIdentityApiTarget };
+//# sourceMappingURL=phaseApis.esm.js.map

package/dist/wiring/phaseApis.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"phaseApis.esm.js","sources":["../../src/wiring/phaseApis.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  AnyApiFactory,\n  ApiHolder,\n  AppTree,\n  AppTreeApi,\n  appTreeApiRef,\n  ConfigApi,\n  configApiRef,\n  createApiFactory,\n  ExternalRouteRef,\n  identityApiRef,\n  RouteFunc,\n  RouteRef,\n  RouteResolutionApi,\n  routeResolutionApiRef,\n  SubRouteRef,\n  type AnyRouteRefParams,\n  type AppNode,\n  type ExtensionFactoryMiddleware,\n  type IdentityApi,\n} from '@backstage/frontend-plugin-api';\nimport { matchRoutes } from 'react-router-dom';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { AppIdentityProxy } from '../../../core-app-api/src/apis/implementations/IdentityApi/AppIdentityProxy';\nimport { createRouteAliasResolver } from '../routing/RouteAliasResolver';\nimport { RouteResolver } from '../routing/RouteResolver';\nimport { collectRouteIds } from '../routing/collectRouteIds';\nimport {\n  extractRouteInfoFromAppNode,\n  type RouteInfo,\n} from '../routing/extractRouteInfoFromAppNode';\nimport { type BackstageRouteObject } from '../routing/types';\nimport { instantiateAppNodeTree } from '../tree/instantiateAppNodeTree';\nimport {\n  FrontendApiRegistry,\n  FrontendApiResolver,\n} from './FrontendApiRegistry';\nimport { type ExtensionPredicateContext } from './predicates';\nimport { type ErrorCollector } from './createErrorCollector';\n\n// Helps delay callers from reaching out to the API before the app tree has been materialized\nexport class AppTreeApiProxy implements AppTreeApi {\n  #routeInfo?: RouteInfo;\n  private readonly tree: AppTree;\n  private readonly appBasePath: string;\n\n  constructor(tree: AppTree, appBasePath: string) {\n    this.tree = tree;\n    this.appBasePath = appBasePath;\n  }\n\n  private checkIfInitialized() {\n    if (!this.#routeInfo) {\n      throw new Error(\n        `You can't access the AppTreeApi during initialization of the app tree. Please move occurrences of this out of the initialization of the factory`,\n      );\n    }\n  }\n\n  getTree() {\n    this.checkIfInitialized();\n\n    return { tree: this.tree };\n  }\n\n  getNodesByRoutePath(routePath: string): { nodes: AppNode[] } {\n    this.checkIfInitialized();\n    const routeInfo = this.#routeInfo;\n    if (!routeInfo) {\n      throw new Error(\n        `You can't access the AppTreeApi during initialization of the app tree. Please move occurrences of this out of the initialization of the factory`,\n      );\n    }\n\n    let path = routePath;\n    if (path.startsWith(this.appBasePath)) {\n      path = path.slice(this.appBasePath.length);\n    }\n\n    const matchedRoutes = matchRoutes(routeInfo.routeObjects, path);\n\n    const matchedAppNodes =\n      matchedRoutes?.flatMap(routeObj => {\n        const appNode = routeObj.route.appNode;\n        return appNode ? [appNode] : [];\n      }) || [];\n\n    return { nodes: matchedAppNodes };\n  }\n\n  initialize(routeInfo: RouteInfo) {\n    this.#routeInfo = routeInfo;\n  }\n}\n\n// Helps delay callers from reaching out to the API before the app tree has been materialized\nexport class RouteResolutionApiProxy implements RouteResolutionApi {\n  #delegate: RouteResolutionApi | undefined;\n  #routeObjects: BackstageRouteObject[] | undefined;\n\n  private readonly routeBindings: Map<ExternalRouteRef, RouteRef | SubRouteRef>;\n  private readonly appBasePath: string;\n\n  constructor(\n    routeBindings: Map<ExternalRouteRef, RouteRef | SubRouteRef>,\n    appBasePath: string,\n  ) {\n    this.routeBindings = routeBindings;\n    this.appBasePath = appBasePath;\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    if (!this.#delegate) {\n      throw new Error(\n        `You can't access the RouteResolver during initialization of the app tree. Please move occurrences of this out of the initialization of the factory`,\n      );\n    }\n\n    return this.#delegate.resolve(anyRouteRef, options);\n  }\n\n  initialize(\n    routeInfo: RouteInfo,\n    routeRefsById: Map<string, RouteRef | SubRouteRef>,\n  ) {\n    this.#delegate = new RouteResolver(\n      routeInfo.routePaths,\n      routeInfo.routeParents,\n      routeInfo.routeObjects,\n      this.routeBindings,\n      this.appBasePath,\n      routeInfo.routeAliasResolver,\n      routeRefsById,\n    );\n    this.#routeObjects = routeInfo.routeObjects;\n\n    return routeInfo;\n  }\n\n  getRouteObjects() {\n    return this.#routeObjects;\n  }\n}\n\nexport class PreparedAppIdentityProxy extends AppIdentityProxy {\n  #onTargetSet?:\n    | ((identityApi: Parameters<AppIdentityProxy['setTarget']>[0]) => void)\n    | undefined;\n\n  setTargetHandlers(options: {\n    onTargetSet?(\n      identityApi: Parameters<AppIdentityProxy['setTarget']>[0],\n    ): void;\n  }) {\n    this.#onTargetSet = options.onTargetSet;\n  }\n\n  clearTargetHandlers() {\n    this.#onTargetSet = undefined;\n  }\n\n  override setTarget(\n    identityApi: Parameters<AppIdentityProxy['setTarget']>[0],\n    targetOptions: Parameters<AppIdentityProxy['setTarget']>[1],\n  ) {\n    super.setTarget(identityApi, targetOptions);\n\n    const onTargetSet = this.#onTargetSet;\n    if (!onTargetSet) {\n      return;\n    }\n\n    this.clearTargetHandlers();\n    onTargetSet(identityApi);\n  }\n}\n\nexport function createPhaseApis(options: {\n  tree: AppTree;\n  config: ConfigApi;\n  appApiRegistry: FrontendApiRegistry;\n  fallbackApis?: ApiHolder;\n  includeConfigApi: boolean;\n  appBasePath: string;\n  routeBindings: Map<ExternalRouteRef, RouteRef | SubRouteRef>;\n  staticFactories: AnyApiFactory[];\n}) {\n  const appTreeApi = new AppTreeApiProxy(options.tree, options.appBasePath);\n  const routeResolutionApi = new RouteResolutionApiProxy(\n    options.routeBindings,\n    options.appBasePath,\n  );\n  const identityProxy = new PreparedAppIdentityProxy();\n  const phaseApiRegistry = new FrontendApiRegistry();\n  phaseApiRegistry.registerAll([\n    createApiFactory(appTreeApiRef, appTreeApi),\n    ...(options.includeConfigApi\n      ? [createApiFactory(configApiRef, options.config)]\n      : []),\n    createApiFactory(routeResolutionApiRef, routeResolutionApi),\n    createApiFactory(identityApiRef, identityProxy),\n    ...options.staticFactories,\n  ]);\n\n  const apis = new FrontendApiResolver({\n    primaryRegistry: phaseApiRegistry,\n    secondaryRegistry: options.appApiRegistry,\n    fallbackApis: options.fallbackApis,\n  });\n\n  return {\n    apis,\n    routeResolutionApi,\n    appTreeApi,\n    identityApiProxy: identityProxy,\n  };\n}\n\nexport function instantiateAndInitializePhaseTree(options: {\n  tree: AppTree;\n  apis: ApiHolder;\n  collector: ErrorCollector;\n  extensionFactoryMiddleware?: ExtensionFactoryMiddleware;\n  routeResolutionApi: RouteResolutionApiProxy;\n  appTreeApi: AppTreeApiProxy;\n  routeRefsById: ReturnType<typeof collectRouteIds>;\n  skipChild?(ctx: { node: AppNode; input: string; child: AppNode }): boolean;\n  onMissingApi?(ctx: { node: AppNode; apiRefId: string }): void;\n  predicateContext?: ExtensionPredicateContext;\n  stopAtAttachment?(ctx: { node: AppNode; input: string }): boolean;\n}) {\n  instantiateAppNodeTree(\n    options.tree.root,\n    options.apis,\n    options.collector,\n    options.extensionFactoryMiddleware,\n    {\n      ...(options.stopAtAttachment\n        ? { stopAtAttachment: options.stopAtAttachment }\n        : {}),\n      skipChild: options.skipChild,\n      onMissingApi: options.onMissingApi,\n      predicateContext: options.predicateContext,\n    },\n  );\n\n  const routeInfo = extractRouteInfoFromAppNode(\n    options.tree.root,\n    createRouteAliasResolver(options.routeRefsById),\n  );\n\n  options.routeResolutionApi.initialize(\n    routeInfo,\n    options.routeRefsById.routes,\n  );\n  options.appTreeApi.initialize(routeInfo);\n}\n\nexport function setIdentityApiTarget(options: {\n  identityApiProxy: AppIdentityProxy;\n  identityApi: IdentityApi;\n  signOutTargetUrl: string;\n}) {\n  options.identityApiProxy.setTarget(options.identityApi, {\n    signOutTargetUrl: options.signOutTargetUrl,\n  });\n}\n"],"names":[],"mappings":";;;;;;;;;AAyDO,MAAM,eAAA,CAAsC;AAAA,EACjD,UAAA;AAAA,EACiB,IAAA;AAAA,EACA,WAAA;AAAA,EAEjB,WAAA,CAAY,MAAe,WAAA,EAAqB;AAC9C,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AAAA,EACrB;AAAA,EAEQ,kBAAA,GAAqB;AAC3B,IAAA,IAAI,CAAC,KAAK,UAAA,EAAY;AACpB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,+IAAA;AAAA,OACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,OAAA,GAAU;AACR,IAAA,IAAA,CAAK,kBAAA,EAAmB;AAExB,IAAA,OAAO,EAAE,IAAA,EAAM,IAAA,CAAK,IAAA,EAAK;AAAA,EAC3B;AAAA,EAEA,oBAAoB,SAAA,EAAyC;AAC3D,IAAA,IAAA,CAAK,kBAAA,EAAmB;AACxB,IAAA,MAAM,YAAY,IAAA,CAAK,UAAA;AACvB,IAAA,IAAI,CAAC,SAAA,EAAW;AACd,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,+IAAA;AAAA,OACF;AAAA,IACF;AAEA,IAAA,IAAI,IAAA,GAAO,SAAA;AACX,IAAA,IAAI,IAAA,CAAK,UAAA,CAAW,IAAA,CAAK,WAAW,CAAA,EAAG;AACrC,MAAA,IAAA,GAAO,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA,IAC3C;AAEA,IAAA,MAAM,aAAA,GAAgB,WAAA,CAAY,SAAA,CAAU,YAAA,EAAc,IAAI,CAAA;AAE9D,IAAA,MAAM,eAAA,GACJ,aAAA,EAAe,OAAA,CAAQ,CAAA,QAAA,KAAY;AACjC,MAAA,MAAM,OAAA,GAAU,SAAS,KAAA,CAAM,OAAA;AAC/B,MAAA,OAAO,OAAA,GAAU,CAAC,OAAO,CAAA,GAAI,EAAC;AAAA,IAChC,CAAC,KAAK,EAAC;AAET,IAAA,OAAO,EAAE,OAAO,eAAA,EAAgB;AAAA,EAClC;AAAA,EAEA,WAAW,SAAA,EAAsB;AAC/B,IAAA,IAAA,CAAK,UAAA,GAAa,SAAA;AAAA,EACpB;AACF;AAGO,MAAM,uBAAA,CAAsD;AAAA,EACjE,SAAA;AAAA,EACA,aAAA;AAAA,EAEiB,aAAA;AAAA,EACA,WAAA;AAAA,EAEjB,WAAA,CACE,eACA,WAAA,EACA;AACA,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AACrB,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AAAA,EACrB;AAAA,EAEA,OAAA,CACE,aAIA,OAAA,EACgC;AAChC,IAAA,IAAI,CAAC,KAAK,SAAA,EAAW;AACnB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,kJAAA;AAAA,OACF;AAAA,IACF;AAEA,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,OAAA,CAAQ,WAAA,EAAa,OAAO,CAAA;AAAA,EACpD;AAAA,EAEA,UAAA,CACE,WACA,aAAA,EACA;AACA,IAAA,IAAA,CAAK,YAAY,IAAI,aAAA;AAAA,MACnB,SAAA,CAAU,UAAA;AAAA,MACV,SAAA,CAAU,YAAA;AAAA,MACV,SAAA,CAAU,YAAA;AAAA,MACV,IAAA,CAAK,aAAA;AAAA,MACL,IAAA,CAAK,WAAA;AAAA,MACL,SAAA,CAAU,kBAAA;AAAA,MACV;AAAA,KACF;AACA,IAAA,IAAA,CAAK,gBAAgB,SAAA,CAAU,YAAA;AAE/B,IAAA,OAAO,SAAA;AAAA,EACT;AAAA,EAEA,eAAA,GAAkB;AAChB,IAAA,OAAO,IAAA,CAAK,aAAA;AAAA,EACd;AACF;AAEO,MAAM,iCAAiC,gBAAA,CAAiB;AAAA,EAC7D,YAAA;AAAA,EAIA,kBAAkB,OAAA,EAIf;AACD,IAAA,IAAA,CAAK,eAAe,OAAA,CAAQ,WAAA;AAAA,EAC9B;AAAA,EAEA,mBAAA,GAAsB;AACpB,IAAA,IAAA,CAAK,YAAA,GAAe,MAAA;AAAA,EACtB;AAAA,EAES,SAAA,CACP,aACA,aAAA,EACA;AACA,IAAA,KAAA,CAAM,SAAA,CAAU,aAAa,aAAa,CAAA;AAE1C,IAAA,MAAM,cAAc,IAAA,CAAK,YAAA;AACzB,IAAA,IAAI,CAAC,WAAA,EAAa;AAChB,MAAA;AAAA,IACF;AAEA,IAAA,IAAA,CAAK,mBAAA,EAAoB;AACzB,IAAA,WAAA,CAAY,WAAW,CAAA;AAAA,EACzB;AACF;AAEO,SAAS,gBAAgB,OAAA,EAS7B;AACD,EAAA,MAAM,aAAa,IAAI,eAAA,CAAgB,OAAA,CAAQ,IAAA,EAAM,QAAQ,WAAW,CAAA;AACxE,EAAA,MAAM,qBAAqB,IAAI,uBAAA;AAAA,IAC7B,OAAA,CAAQ,aAAA;AAAA,IACR,OAAA,CAAQ;AAAA,GACV;AACA,EAAA,MAAM,aAAA,GAAgB,IAAI,wBAAA,EAAyB;AACnD,EAAA,MAAM,gBAAA,GAAmB,IAAI,mBAAA,EAAoB;AACjD,EAAA,gBAAA,CAAiB,WAAA,CAAY;AAAA,IAC3B,gBAAA,CAAiB,eAAe,UAAU,CAAA;AAAA,IAC1C,GAAI,OAAA,CAAQ,gBAAA,GACR,CAAC,gBAAA,CAAiB,cAAc,OAAA,CAAQ,MAAM,CAAC,CAAA,GAC/C,EAAC;AAAA,IACL,gBAAA,CAAiB,uBAAuB,kBAAkB,CAAA;AAAA,IAC1D,gBAAA,CAAiB,gBAAgB,aAAa,CAAA;AAAA,IAC9C,GAAG,OAAA,CAAQ;AAAA,GACZ,CAAA;AAED,EAAA,MAAM,IAAA,GAAO,IAAI,mBAAA,CAAoB;AAAA,IACnC,eAAA,EAAiB,gBAAA;AAAA,IACjB,mBAAmB,OAAA,CAAQ,cAAA;AAAA,IAC3B,cAAc,OAAA,CAAQ;AAAA,GACvB,CAAA;AAED,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA,kBAAA;AAAA,IACA,UAAA;AAAA,IACA,gBAAA,EAAkB;AAAA,GACpB;AACF;AAEO,SAAS,kCAAkC,OAAA,EAY/C;AACD,EAAA,sBAAA;AAAA,IACE,QAAQ,IAAA,CAAK,IAAA;AAAA,IACb,OAAA,CAAQ,IAAA;AAAA,IACR,OAAA,CAAQ,SAAA;AAAA,IACR,OAAA,CAAQ,0BAAA;AAAA,IACR;AAAA,MACE,GAAI,QAAQ,gBAAA,GACR,EAAE,kBAAkB,OAAA,CAAQ,gBAAA,KAC5B,EAAC;AAAA,MACL,WAAW,OAAA,CAAQ,SAAA;AAAA,MACnB,cAAc,OAAA,CAAQ,YAAA;AAAA,MACtB,kBAAkB,OAAA,CAAQ;AAAA;AAC5B,GACF;AAEA,EAAA,MAAM,SAAA,GAAY,2BAAA;AAAA,IAChB,QAAQ,IAAA,CAAK,IAAA;AAAA,IACb,wBAAA,CAAyB,QAAQ,aAAa;AAAA,GAChD;AAEA,EAAA,OAAA,CAAQ,kBAAA,CAAmB,UAAA;AAAA,IACzB,SAAA;AAAA,IACA,QAAQ,aAAA,CAAc;AAAA,GACxB;AACA,EAAA,OAAA,CAAQ,UAAA,CAAW,WAAW,SAAS,CAAA;AACzC;AAEO,SAAS,qBAAqB,OAAA,EAIlC;AACD,EAAA,OAAA,CAAQ,gBAAA,CAAiB,SAAA,CAAU,OAAA,CAAQ,WAAA,EAAa;AAAA,IACtD,kBAAkB,OAAA,CAAQ;AAAA,GAC3B,CAAA;AACH;;;;"}

package/dist/wiring/predicates.esm.js

@@ -0,0 +1,116 @@
+import { createApiRef, featureFlagsApiRef } from '@backstage/frontend-plugin-api';
+
+const EMPTY_PREDICATE_CONTEXT = {
+  featureFlags: [],
+  permissions: []
+};
+const localPermissionApiRef = createApiRef({
+  id: "plugin.permission.api"
+});
+function createPredicateContextLoader(options) {
+  function getActiveFeatureFlags() {
+    const featureFlagsApi = options.apis.get(featureFlagsApiRef);
+    if (!featureFlagsApi) {
+      return [];
+    }
+    return options.predicateReferences.featureFlags.filter(
+      (name) => featureFlagsApi.isActive(name)
+    );
+  }
+  function getImmediate() {
+    if (options.predicateReferences.permissions.length > 0) {
+      const permissionApi = options.apis.get(localPermissionApiRef);
+      if (permissionApi) {
+        return void 0;
+      }
+    }
+    return {
+      featureFlags: getActiveFeatureFlags(),
+      permissions: []
+    };
+  }
+  async function load() {
+    const immediatePredicateContext = getImmediate();
+    if (immediatePredicateContext) {
+      return immediatePredicateContext;
+    }
+    let allowedPermissions = [];
+    const permissionApi = options.apis.get(localPermissionApiRef);
+    if (permissionApi) {
+      const permissionNames = options.predicateReferences.permissions;
+      const responses = await Promise.all(
+        permissionNames.map(
+          (name) => permissionApi.authorize({
+            permission: { name, type: "basic", attributes: {} }
+          })
+        )
+      );
+      allowedPermissions = permissionNames.filter(
+        (_, i) => responses[i].result === "ALLOW"
+      );
+    }
+    return {
+      featureFlags: getActiveFeatureFlags(),
+      permissions: allowedPermissions
+    };
+  }
+  return {
+    getImmediate,
+    load
+  };
+}
+function collectPredicateReferences(nodes) {
+  const featureFlags = /* @__PURE__ */ new Set();
+  const permissions = /* @__PURE__ */ new Set();
+  for (const node of nodes) {
+    if (node.spec.if === void 0) {
+      continue;
+    }
+    for (const name of extractFeatureFlagNames(node.spec.if)) {
+      featureFlags.add(name);
+    }
+    for (const name of extractPermissionNames(node.spec.if)) {
+      permissions.add(name);
+    }
+  }
+  return {
+    featureFlags: Array.from(featureFlags),
+    permissions: Array.from(permissions)
+  };
+}
+function extractFeatureFlagNames(predicate) {
+  return extractPredicateKeyNames(predicate, "featureFlags");
+}
+function extractPermissionNames(predicate) {
+  return extractPredicateKeyNames(predicate, "permissions");
+}
+function extractPredicateKeyNames(predicate, key) {
+  if (typeof predicate !== "object" || predicate === null) {
+    return [];
+  }
+  const obj = predicate;
+  if (Array.isArray(obj.$all)) {
+    return obj.$all.flatMap(
+      (p) => extractPredicateKeyNames(p, key)
+    );
+  }
+  if (Array.isArray(obj.$any)) {
+    return obj.$any.flatMap(
+      (p) => extractPredicateKeyNames(p, key)
+    );
+  }
+  if (obj.$not !== void 0) {
+    return extractPredicateKeyNames(obj.$not, key);
+  }
+  const value = obj[key];
+  if (typeof value === "object" && value !== null && !Array.isArray(value)) {
+    const contains = value.$contains;
+    if (typeof contains === "string") {
+      return [contains];
+    }
+  }
+  return [];
+}
+
+export { EMPTY_PREDICATE_CONTEXT, collectPredicateReferences, createPredicateContextLoader, localPermissionApiRef };
+//# sourceMappingURL=predicates.esm.js.map

package/dist/wiring/predicates.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"predicates.esm.js","sources":["../../src/wiring/predicates.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  ApiHolder,\n  createApiRef,\n  featureFlagsApiRef,\n} from '@backstage/frontend-plugin-api';\nimport { FilterPredicate } from '@backstage/filter-predicates';\nimport type {\n  EvaluatePermissionRequest,\n  EvaluatePermissionResponse,\n} from '@backstage/plugin-permission-common';\n\nexport type ExtensionPredicateContext = {\n  featureFlags: string[];\n  permissions: string[];\n};\n\nexport const EMPTY_PREDICATE_CONTEXT: ExtensionPredicateContext = {\n  featureFlags: [],\n  permissions: [],\n};\n\n// Minimal local permission API interface to avoid a dependency on @backstage/plugin-permission-react\ntype MinimalPermissionApi = {\n  authorize(\n    request: EvaluatePermissionRequest,\n  ): Promise<EvaluatePermissionResponse>;\n};\n\nexport const localPermissionApiRef = createApiRef<MinimalPermissionApi>({\n  id: 'plugin.permission.api',\n});\n\nexport function createPredicateContextLoader(options: {\n  apis: ApiHolder;\n  predicateReferences: ExtensionPredicateContext;\n}) {\n  function getActiveFeatureFlags() {\n    const featureFlagsApi = options.apis.get(featureFlagsApiRef);\n    if (!featureFlagsApi) {\n      return [];\n    }\n\n    return options.predicateReferences.featureFlags.filter(name =>\n      featureFlagsApi.isActive(name),\n    );\n  }\n\n  function getImmediate(): ExtensionPredicateContext | undefined {\n    if (options.predicateReferences.permissions.length > 0) {\n      const permissionApi = options.apis.get(localPermissionApiRef);\n      if (permissionApi) {\n        return undefined;\n      }\n    }\n\n    return {\n      featureFlags: getActiveFeatureFlags(),\n      permissions: [],\n    };\n  }\n\n  async function load() {\n    const immediatePredicateContext = getImmediate();\n    if (immediatePredicateContext) {\n      return immediatePredicateContext;\n    }\n\n    let allowedPermissions: string[] = [];\n    const permissionApi = options.apis.get(localPermissionApiRef);\n    if (permissionApi) {\n      const permissionNames = options.predicateReferences.permissions;\n      const responses = await Promise.all(\n        permissionNames.map(name =>\n          permissionApi.authorize({\n            permission: { name, type: 'basic', attributes: {} },\n          }),\n        ),\n      );\n      allowedPermissions = permissionNames.filter(\n        (_, i) => responses[i].result === 'ALLOW',\n      );\n    }\n\n    return {\n      featureFlags: getActiveFeatureFlags(),\n      permissions: allowedPermissions,\n    };\n  }\n\n  return {\n    getImmediate,\n    load,\n  };\n}\n\nexport function collectPredicateReferences(\n  nodes: Iterable<{ spec: { if?: FilterPredicate } }>,\n): ExtensionPredicateContext {\n  const featureFlags = new Set<string>();\n  const permissions = new Set<string>();\n\n  for (const node of nodes) {\n    if (node.spec.if === undefined) {\n      continue;\n    }\n\n    for (const name of extractFeatureFlagNames(node.spec.if)) {\n      featureFlags.add(name);\n    }\n    for (const name of extractPermissionNames(node.spec.if)) {\n      permissions.add(name);\n    }\n  }\n\n  return {\n    featureFlags: Array.from(featureFlags),\n    permissions: Array.from(permissions),\n  };\n}\n\n/**\n * Recursively walks a FilterPredicate and returns all string values referenced\n * by `featureFlags: { $contains: '...' }` expressions. This lets us call\n * `isActive()` only for the flags that are actually used in predicates rather\n * than fetching the full registered-flag list.\n */\nfunction extractFeatureFlagNames(predicate: FilterPredicate): string[] {\n  return extractPredicateKeyNames(predicate, 'featureFlags');\n}\n\n/**\n * Recursively walks a FilterPredicate and returns all string values referenced\n * by `permissions: { $contains: '...' }` expressions. This lets us issue a\n * single batched authorize call for only the permissions actually referenced.\n */\nfunction extractPermissionNames(predicate: FilterPredicate): string[] {\n  return extractPredicateKeyNames(predicate, 'permissions');\n}\n\nfunction extractPredicateKeyNames(\n  predicate: FilterPredicate,\n  key: string,\n): string[] {\n  if (typeof predicate !== 'object' || predicate === null) {\n    return [];\n  }\n  const obj = predicate as Record<string, unknown>;\n  if (Array.isArray(obj.$all)) {\n    return (obj.$all as FilterPredicate[]).flatMap(p =>\n      extractPredicateKeyNames(p, key),\n    );\n  }\n  if (Array.isArray(obj.$any)) {\n    return (obj.$any as FilterPredicate[]).flatMap(p =>\n      extractPredicateKeyNames(p, key),\n    );\n  }\n  if (obj.$not !== undefined) {\n    return extractPredicateKeyNames(obj.$not as FilterPredicate, key);\n  }\n  const value = obj[key];\n  if (typeof value === 'object' && value !== null && !Array.isArray(value)) {\n    const contains = (value as Record<string, unknown>).$contains;\n    if (typeof contains === 'string') {\n      return [contains];\n    }\n  }\n  return [];\n}\n"],"names":[],"mappings":";;AAgCO,MAAM,uBAAA,GAAqD;AAAA,EAChE,cAAc,EAAC;AAAA,EACf,aAAa;AACf;AASO,MAAM,wBAAwB,YAAA,CAAmC;AAAA,EACtE,EAAA,EAAI;AACN,CAAC;AAEM,SAAS,6BAA6B,OAAA,EAG1C;AACD,EAAA,SAAS,qBAAA,GAAwB;AAC/B,IAAA,MAAM,eAAA,GAAkB,OAAA,CAAQ,IAAA,CAAK,GAAA,CAAI,kBAAkB,CAAA;AAC3D,IAAA,IAAI,CAAC,eAAA,EAAiB;AACpB,MAAA,OAAO,EAAC;AAAA,IACV;AAEA,IAAA,OAAO,OAAA,CAAQ,oBAAoB,YAAA,CAAa,MAAA;AAAA,MAAO,CAAA,IAAA,KACrD,eAAA,CAAgB,QAAA,CAAS,IAAI;AAAA,KAC/B;AAAA,EACF;AAEA,EAAA,SAAS,YAAA,GAAsD;AAC7D,IAAA,IAAI,OAAA,CAAQ,mBAAA,CAAoB,WAAA,CAAY,MAAA,GAAS,CAAA,EAAG;AACtD,MAAA,MAAM,aAAA,GAAgB,OAAA,CAAQ,IAAA,CAAK,GAAA,CAAI,qBAAqB,CAAA;AAC5D,MAAA,IAAI,aAAA,EAAe;AACjB,QAAA,OAAO,MAAA;AAAA,MACT;AAAA,IACF;AAEA,IAAA,OAAO;AAAA,MACL,cAAc,qBAAA,EAAsB;AAAA,MACpC,aAAa;AAAC,KAChB;AAAA,EACF;AAEA,EAAA,eAAe,IAAA,GAAO;AACpB,IAAA,MAAM,4BAA4B,YAAA,EAAa;AAC/C,IAAA,IAAI,yBAAA,EAA2B;AAC7B,MAAA,OAAO,yBAAA;AAAA,IACT;AAEA,IAAA,IAAI,qBAA+B,EAAC;AACpC,IAAA,MAAM,aAAA,GAAgB,OAAA,CAAQ,IAAA,CAAK,GAAA,CAAI,qBAAqB,CAAA;AAC5D,IAAA,IAAI,aAAA,EAAe;AACjB,MAAA,MAAM,eAAA,GAAkB,QAAQ,mBAAA,CAAoB,WAAA;AACpD,MAAA,MAAM,SAAA,GAAY,MAAM,OAAA,CAAQ,GAAA;AAAA,QAC9B,eAAA,CAAgB,GAAA;AAAA,UAAI,CAAA,IAAA,KAClB,cAAc,SAAA,CAAU;AAAA,YACtB,YAAY,EAAE,IAAA,EAAM,MAAM,OAAA,EAAS,UAAA,EAAY,EAAC;AAAE,WACnD;AAAA;AACH,OACF;AACA,MAAA,kBAAA,GAAqB,eAAA,CAAgB,MAAA;AAAA,QACnC,CAAC,CAAA,EAAG,CAAA,KAAM,SAAA,CAAU,CAAC,EAAE,MAAA,KAAW;AAAA,OACpC;AAAA,IACF;AAEA,IAAA,OAAO;AAAA,MACL,cAAc,qBAAA,EAAsB;AAAA,MACpC,WAAA,EAAa;AAAA,KACf;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,YAAA;AAAA,IACA;AAAA,GACF;AACF;AAEO,SAAS,2BACd,KAAA,EAC2B;AAC3B,EAAA,MAAM,YAAA,uBAAmB,GAAA,EAAY;AACrC,EAAA,MAAM,WAAA,uBAAkB,GAAA,EAAY;AAEpC,EAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,IAAA,IAAI,IAAA,CAAK,IAAA,CAAK,EAAA,KAAO,MAAA,EAAW;AAC9B,MAAA;AAAA,IACF;AAEA,IAAA,KAAA,MAAW,IAAA,IAAQ,uBAAA,CAAwB,IAAA,CAAK,IAAA,CAAK,EAAE,CAAA,EAAG;AACxD,MAAA,YAAA,CAAa,IAAI,IAAI,CAAA;AAAA,IACvB;AACA,IAAA,KAAA,MAAW,IAAA,IAAQ,sBAAA,CAAuB,IAAA,CAAK,IAAA,CAAK,EAAE,CAAA,EAAG;AACvD,MAAA,WAAA,CAAY,IAAI,IAAI,CAAA;AAAA,IACtB;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,YAAA,EAAc,KAAA,CAAM,IAAA,CAAK,YAAY,CAAA;AAAA,IACrC,WAAA,EAAa,KAAA,CAAM,IAAA,CAAK,WAAW;AAAA,GACrC;AACF;AAQA,SAAS,wBAAwB,SAAA,EAAsC;AACrE,EAAA,OAAO,wBAAA,CAAyB,WAAW,cAAc,CAAA;AAC3D;AAOA,SAAS,uBAAuB,SAAA,EAAsC;AACpE,EAAA,OAAO,wBAAA,CAAyB,WAAW,aAAa,CAAA;AAC1D;AAEA,SAAS,wBAAA,CACP,WACA,GAAA,EACU;AACV,EAAA,IAAI,OAAO,SAAA,KAAc,QAAA,IAAY,SAAA,KAAc,IAAA,EAAM;AACvD,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,GAAA,GAAM,SAAA;AACZ,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,GAAA,CAAI,IAAI,CAAA,EAAG;AAC3B,IAAA,OAAQ,IAAI,IAAA,CAA2B,OAAA;AAAA,MAAQ,CAAA,CAAA,KAC7C,wBAAA,CAAyB,CAAA,EAAG,GAAG;AAAA,KACjC;AAAA,EACF;AACA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,GAAA,CAAI,IAAI,CAAA,EAAG;AAC3B,IAAA,OAAQ,IAAI,IAAA,CAA2B,OAAA;AAAA,MAAQ,CAAA,CAAA,KAC7C,wBAAA,CAAyB,CAAA,EAAG,GAAG;AAAA,KACjC;AAAA,EACF;AACA,EAAA,IAAI,GAAA,CAAI,SAAS,MAAA,EAAW;AAC1B,IAAA,OAAO,wBAAA,CAAyB,GAAA,CAAI,IAAA,EAAyB,GAAG,CAAA;AAAA,EAClE;AACA,EAAA,MAAM,KAAA,GAAQ,IAAI,GAAG,CAAA;AACrB,EAAA,IAAI,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACxE,IAAA,MAAM,WAAY,KAAA,CAAkC,SAAA;AACpD,IAAA,IAAI,OAAO,aAAa,QAAA,EAAU;AAChC,MAAA,OAAO,CAAC,QAAQ,CAAA;AAAA,IAClB;AAAA,EACF;AACA,EAAA,OAAO,EAAC;AACV;;;;"}