@backstage/plugin-catalog-node 1.16.3-next.0 → 1.17.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @backstage/plugin-catalog-node
 
+## 1.17.0-next.0
+
+### Minor Changes
+
+- 1a003ff: Add `getLocations` method to `CatalogApi` and `CatalogClient`. This method calls the [`GET /locations`](https://backstage.io/docs/features/software-catalog/software-catalog-api/#get-locations) endpoint from the catalog backend.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-client@1.10.0-next.0
+  - @backstage/backend-plugin-api@1.3.1-next.0
+  - @backstage/plugin-permission-node@0.9.2-next.0
+  - @backstage/catalog-model@1.7.3
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-catalog-common@1.1.3
+  - @backstage/plugin-permission-common@0.8.4
+
+## 1.16.3
+
+### Patch Changes
+
+- 2c5598c: Adds documentation for the CatalogProcessingExtensionPoint functions.
+- 98b7131: Use a different ID for the deprecated alpha version of the catalog service, as it has a different type definition and cannot be used interchangeably with the non-alpha version.
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.3.0
+  - @backstage/plugin-permission-node@0.9.1
+  - @backstage/catalog-client@1.9.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-catalog-common@1.1.3
+  - @backstage/plugin-permission-common@0.8.4
+
 ## 1.16.3-next.0
 
 ### Patch Changes

package/dist/alpha.d.ts

@@ -24,8 +24,33 @@ declare const catalogLocationsExtensionPoint: _backstage_backend_plugin_api.Exte
  * @alpha
  */
 interface CatalogProcessingExtensionPoint {
+    /**
+     * Adds entity processors. These are responsible for reading, parsing, and
+     * processing entities before they are persisted in the catalog.
+     *
+     * This function also can replace a Default processor if the provided processor
+     * matches the processor name.
+     *
+     * @param processors - One or more processors
+     */
     addProcessor(...processors: Array<CatalogProcessor | Array<CatalogProcessor>>): void;
+    /**
+     * Adds or replaces entity providers. These are responsible for bootstrapping
+     * the list of entities out of original data sources. For example, there is
+     * one entity source for the config locations, and one for the database
+     * stored locations. If you ingest entities out of a third party system, you
+     * may want to implement that in terms of an entity provider as well.
+     *
+     * @param providers - One or more entity providers
+     */
     addEntityProvider(...providers: Array<EntityProvider | Array<EntityProvider>>): void;
+    /**
+     * Adds, or overwrites, a handler for placeholders (e.g. $file) in entity
+     * definition files.
+     *
+     * @param key - The key that identifies the placeholder, e.g. "file"
+     * @param resolver - The resolver that gets values for this placeholder
+     */
     addPlaceholderResolver(key: string, resolver: PlaceholderResolver): void;
     setOnProcessingErrorHandler(handler: (event: {
         unprocessedEntity: Entity;

package/dist/catalogService.cjs.js

@@ -61,6 +61,12 @@ class DefaultCatalogService {
       await this.#getOptions(options)
     );
   }
+  async getLocations(request, options) {
+    return this.#catalogApi.getLocations(
+      request,
+      await this.#getOptions(options)
+    );
+  }
   async getLocationById(id, options) {
     return this.#catalogApi.getLocationById(
       id,

package/dist/catalogService.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"catalogService.cjs.js","sources":["../src/catalogService.ts"],"sourcesContent":["/*\n * Copyright 2022 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  createServiceFactory,\n  createServiceRef,\n  coreServices,\n  BackstageCredentials,\n  AuthService,\n} from '@backstage/backend-plugin-api';\nimport {\n  AddLocationRequest,\n  AddLocationResponse,\n  CatalogApi,\n  CatalogClient,\n  CatalogRequestOptions,\n  GetEntitiesByRefsRequest,\n  GetEntitiesByRefsResponse,\n  GetEntitiesRequest,\n  GetEntitiesResponse,\n  GetEntityAncestorsRequest,\n  GetEntityAncestorsResponse,\n  GetEntityFacetsRequest,\n  GetEntityFacetsResponse,\n  Location,\n  QueryEntitiesRequest,\n  QueryEntitiesResponse,\n  ValidateEntityResponse,\n} from '@backstage/catalog-client';\nimport { CompoundEntityRef, Entity } from '@backstage/catalog-model';\n\n/**\n * @public\n */\nexport interface CatalogServiceRequestOptions {\n  credentials: BackstageCredentials;\n}\n\n/**\n * A version of the {@link @backstage/catalog-client#CatalogApi | CatalogApi} that\n * requires backend credentials to be passed instead of a token.\n *\n * @public\n */\nexport interface CatalogService {\n  getEntities(\n    request: GetEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntitiesResponse>;\n\n  getEntitiesByRefs(\n    request: GetEntitiesByRefsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntitiesByRefsResponse>;\n\n  queryEntities(\n    request: QueryEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<QueryEntitiesResponse>;\n\n  getEntityAncestors(\n    request: GetEntityAncestorsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntityAncestorsResponse>;\n\n  getEntityByRef(\n    entityRef: string | CompoundEntityRef,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Entity | undefined>;\n\n  removeEntityByUid(\n    uid: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void>;\n\n  refreshEntity(\n    entityRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void>;\n\n  getEntityFacets(\n    request: GetEntityFacetsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntityFacetsResponse>;\n\n  getLocationById(\n    id: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined>;\n\n  getLocationByRef(\n    locationRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined>;\n\n  addLocation(\n    location: AddLocationRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<AddLocationResponse>;\n\n  removeLocationById(\n    id: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void>;\n\n  getLocationByEntity(\n    entityRef: string | CompoundEntityRef,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined>;\n\n  validateEntity(\n    entity: Entity,\n    locationRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<ValidateEntityResponse>;\n}\n\nclass DefaultCatalogService implements CatalogService {\n  readonly #auth: AuthService;\n  readonly #catalogApi: CatalogApi;\n\n  constructor({\n    catalogApi,\n    auth,\n  }: {\n    catalogApi: CatalogApi;\n    auth: AuthService;\n  }) {\n    this.#catalogApi = catalogApi;\n    this.#auth = auth;\n  }\n\n  async getEntities(\n    request: GetEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntitiesResponse> {\n    return this.#catalogApi.getEntities(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getEntitiesByRefs(\n    request: GetEntitiesByRefsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntitiesByRefsResponse> {\n    return this.#catalogApi.getEntitiesByRefs(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async queryEntities(\n    request: QueryEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<QueryEntitiesResponse> {\n    return this.#catalogApi.queryEntities(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getEntityAncestors(\n    request: GetEntityAncestorsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntityAncestorsResponse> {\n    return this.#catalogApi.getEntityAncestors(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getEntityByRef(\n    entityRef: string | CompoundEntityRef,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Entity | undefined> {\n    return this.#catalogApi.getEntityByRef(\n      entityRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async removeEntityByUid(\n    uid: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void> {\n    return this.#catalogApi.removeEntityByUid(\n      uid,\n      await this.#getOptions(options),\n    );\n  }\n\n  async refreshEntity(\n    entityRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void> {\n    return this.#catalogApi.refreshEntity(\n      entityRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getEntityFacets(\n    request: GetEntityFacetsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntityFacetsResponse> {\n    return this.#catalogApi.getEntityFacets(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getLocationById(\n    id: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined> {\n    return this.#catalogApi.getLocationById(\n      id,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getLocationByRef(\n    locationRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined> {\n    return this.#catalogApi.getLocationByRef(\n      locationRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async addLocation(\n    location: AddLocationRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<AddLocationResponse> {\n    return this.#catalogApi.addLocation(\n      location,\n      await this.#getOptions(options),\n    );\n  }\n\n  async removeLocationById(\n    id: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void> {\n    return this.#catalogApi.removeLocationById(\n      id,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getLocationByEntity(\n    entityRef: string | CompoundEntityRef,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined> {\n    return this.#catalogApi.getLocationByEntity(\n      entityRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async validateEntity(\n    entity: Entity,\n    locationRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<ValidateEntityResponse> {\n    return this.#catalogApi.validateEntity(\n      entity,\n      locationRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async #getOptions(\n    options: CatalogServiceRequestOptions,\n  ): Promise<CatalogRequestOptions> {\n    return this.#auth.getPluginRequestToken({\n      onBehalfOf: options.credentials,\n      targetPluginId: 'catalog',\n    });\n  }\n}\n\n/**\n * The catalogService provides the catalog API.\n *\n * @public\n */\nexport const catalogServiceRef = createServiceRef<CatalogService>({\n  id: 'catalog-client',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\n        auth: coreServices.auth,\n        discoveryApi: coreServices.discovery,\n      },\n      async factory({ auth, discoveryApi }) {\n        return new DefaultCatalogService({\n          auth,\n          catalogApi: new CatalogClient({ discoveryApi }),\n        });\n      },\n    }),\n});\n"],"names":["createServiceRef","createServiceFactory","coreServices","CatalogClient"],"mappings":";;;;;AAkIA,MAAM,qBAAgD,CAAA;AAAA,EAC3C,KAAA;AAAA,EACA,WAAA;AAAA,EAET,WAAY,CAAA;AAAA,IACV,UAAA;AAAA,IACA;AAAA,GAIC,EAAA;AACD,IAAA,IAAA,CAAK,WAAc,GAAA,UAAA;AACnB,IAAA,IAAA,CAAK,KAAQ,GAAA,IAAA;AAAA;AACf,EAEA,MAAM,WACJ,CAAA,OAAA,EACA,OAC8B,EAAA;AAC9B,IAAA,OAAO,KAAK,WAAY,CAAA,WAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,iBACJ,CAAA,OAAA,EACA,OACoC,EAAA;AACpC,IAAA,OAAO,KAAK,WAAY,CAAA,iBAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,aACJ,CAAA,OAAA,EACA,OACgC,EAAA;AAChC,IAAA,OAAO,KAAK,WAAY,CAAA,aAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,kBACJ,CAAA,OAAA,EACA,OACqC,EAAA;AACrC,IAAA,OAAO,KAAK,WAAY,CAAA,kBAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,cACJ,CAAA,SAAA,EACA,OAC6B,EAAA;AAC7B,IAAA,OAAO,KAAK,WAAY,CAAA,cAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,iBACJ,CAAA,GAAA,EACA,OACe,EAAA;AACf,IAAA,OAAO,KAAK,WAAY,CAAA,iBAAA;AAAA,MACtB,GAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,aACJ,CAAA,SAAA,EACA,OACe,EAAA;AACf,IAAA,OAAO,KAAK,WAAY,CAAA,aAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,eACJ,CAAA,OAAA,EACA,OACkC,EAAA;AAClC,IAAA,OAAO,KAAK,WAAY,CAAA,eAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,eACJ,CAAA,EAAA,EACA,OAC+B,EAAA;AAC/B,IAAA,OAAO,KAAK,WAAY,CAAA,eAAA;AAAA,MACtB,EAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,gBACJ,CAAA,WAAA,EACA,OAC+B,EAAA;AAC/B,IAAA,OAAO,KAAK,WAAY,CAAA,gBAAA;AAAA,MACtB,WAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,WACJ,CAAA,QAAA,EACA,OAC8B,EAAA;AAC9B,IAAA,OAAO,KAAK,WAAY,CAAA,WAAA;AAAA,MACtB,QAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,kBACJ,CAAA,EAAA,EACA,OACe,EAAA;AACf,IAAA,OAAO,KAAK,WAAY,CAAA,kBAAA;AAAA,MACtB,EAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,mBACJ,CAAA,SAAA,EACA,OAC+B,EAAA;AAC/B,IAAA,OAAO,KAAK,WAAY,CAAA,mBAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,cAAA,CACJ,MACA,EAAA,WAAA,EACA,OACiC,EAAA;AACjC,IAAA,OAAO,KAAK,WAAY,CAAA,cAAA;AAAA,MACtB,MAAA;AAAA,MACA,WAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,YACJ,OACgC,EAAA;AAChC,IAAO,OAAA,IAAA,CAAK,MAAM,qBAAsB,CAAA;AAAA,MACtC,YAAY,OAAQ,CAAA,WAAA;AAAA,MACpB,cAAgB,EAAA;AAAA,KACjB,CAAA;AAAA;AAEL;AAOO,MAAM,oBAAoBA,iCAAiC,CAAA;AAAA,EAChE,EAAI,EAAA,gBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAqB,CAAA;AAAA,IACnB,OAAA;AAAA,IACA,IAAM,EAAA;AAAA,MACJ,MAAMC,6BAAa,CAAA,IAAA;AAAA,MACnB,cAAcA,6BAAa,CAAA;AAAA,KAC7B;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,IAAA,EAAM,cAAgB,EAAA;AACpC,MAAA,OAAO,IAAI,qBAAsB,CAAA;AAAA,QAC/B,IAAA;AAAA,QACA,UAAY,EAAA,IAAIC,2BAAc,CAAA,EAAE,cAAc;AAAA,OAC/C,CAAA;AAAA;AACH,GACD;AACL,CAAC;;;;"}
+{"version":3,"file":"catalogService.cjs.js","sources":["../src/catalogService.ts"],"sourcesContent":["/*\n * Copyright 2022 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  createServiceFactory,\n  createServiceRef,\n  coreServices,\n  BackstageCredentials,\n  AuthService,\n} from '@backstage/backend-plugin-api';\nimport {\n  AddLocationRequest,\n  AddLocationResponse,\n  CatalogApi,\n  CatalogClient,\n  CatalogRequestOptions,\n  GetEntitiesByRefsRequest,\n  GetEntitiesByRefsResponse,\n  GetEntitiesRequest,\n  GetEntitiesResponse,\n  GetEntityAncestorsRequest,\n  GetEntityAncestorsResponse,\n  GetEntityFacetsRequest,\n  GetEntityFacetsResponse,\n  GetLocationsResponse,\n  Location,\n  QueryEntitiesRequest,\n  QueryEntitiesResponse,\n  ValidateEntityResponse,\n} from '@backstage/catalog-client';\nimport { CompoundEntityRef, Entity } from '@backstage/catalog-model';\n\n/**\n * @public\n */\nexport interface CatalogServiceRequestOptions {\n  credentials: BackstageCredentials;\n}\n\n/**\n * A version of the {@link @backstage/catalog-client#CatalogApi | CatalogApi} that\n * requires backend credentials to be passed instead of a token.\n *\n * @public\n */\nexport interface CatalogService {\n  getEntities(\n    request: GetEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntitiesResponse>;\n\n  getEntitiesByRefs(\n    request: GetEntitiesByRefsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntitiesByRefsResponse>;\n\n  queryEntities(\n    request: QueryEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<QueryEntitiesResponse>;\n\n  getEntityAncestors(\n    request: GetEntityAncestorsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntityAncestorsResponse>;\n\n  getEntityByRef(\n    entityRef: string | CompoundEntityRef,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Entity | undefined>;\n\n  removeEntityByUid(\n    uid: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void>;\n\n  refreshEntity(\n    entityRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void>;\n\n  getEntityFacets(\n    request: GetEntityFacetsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntityFacetsResponse>;\n\n  getLocations(\n    request: {} | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetLocationsResponse>;\n\n  getLocationById(\n    id: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined>;\n\n  getLocationByRef(\n    locationRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined>;\n\n  addLocation(\n    location: AddLocationRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<AddLocationResponse>;\n\n  removeLocationById(\n    id: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void>;\n\n  getLocationByEntity(\n    entityRef: string | CompoundEntityRef,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined>;\n\n  validateEntity(\n    entity: Entity,\n    locationRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<ValidateEntityResponse>;\n}\n\nclass DefaultCatalogService implements CatalogService {\n  readonly #auth: AuthService;\n  readonly #catalogApi: CatalogApi;\n\n  constructor({\n    catalogApi,\n    auth,\n  }: {\n    catalogApi: CatalogApi;\n    auth: AuthService;\n  }) {\n    this.#catalogApi = catalogApi;\n    this.#auth = auth;\n  }\n\n  async getEntities(\n    request: GetEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntitiesResponse> {\n    return this.#catalogApi.getEntities(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getEntitiesByRefs(\n    request: GetEntitiesByRefsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntitiesByRefsResponse> {\n    return this.#catalogApi.getEntitiesByRefs(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async queryEntities(\n    request: QueryEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<QueryEntitiesResponse> {\n    return this.#catalogApi.queryEntities(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getEntityAncestors(\n    request: GetEntityAncestorsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntityAncestorsResponse> {\n    return this.#catalogApi.getEntityAncestors(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getEntityByRef(\n    entityRef: string | CompoundEntityRef,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Entity | undefined> {\n    return this.#catalogApi.getEntityByRef(\n      entityRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async removeEntityByUid(\n    uid: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void> {\n    return this.#catalogApi.removeEntityByUid(\n      uid,\n      await this.#getOptions(options),\n    );\n  }\n\n  async refreshEntity(\n    entityRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void> {\n    return this.#catalogApi.refreshEntity(\n      entityRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getEntityFacets(\n    request: GetEntityFacetsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetEntityFacetsResponse> {\n    return this.#catalogApi.getEntityFacets(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getLocations(\n    request: {} | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<GetLocationsResponse> {\n    return this.#catalogApi.getLocations(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getLocationById(\n    id: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined> {\n    return this.#catalogApi.getLocationById(\n      id,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getLocationByRef(\n    locationRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined> {\n    return this.#catalogApi.getLocationByRef(\n      locationRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async addLocation(\n    location: AddLocationRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<AddLocationResponse> {\n    return this.#catalogApi.addLocation(\n      location,\n      await this.#getOptions(options),\n    );\n  }\n\n  async removeLocationById(\n    id: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<void> {\n    return this.#catalogApi.removeLocationById(\n      id,\n      await this.#getOptions(options),\n    );\n  }\n\n  async getLocationByEntity(\n    entityRef: string | CompoundEntityRef,\n    options: CatalogServiceRequestOptions,\n  ): Promise<Location | undefined> {\n    return this.#catalogApi.getLocationByEntity(\n      entityRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async validateEntity(\n    entity: Entity,\n    locationRef: string,\n    options: CatalogServiceRequestOptions,\n  ): Promise<ValidateEntityResponse> {\n    return this.#catalogApi.validateEntity(\n      entity,\n      locationRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async #getOptions(\n    options: CatalogServiceRequestOptions,\n  ): Promise<CatalogRequestOptions> {\n    return this.#auth.getPluginRequestToken({\n      onBehalfOf: options.credentials,\n      targetPluginId: 'catalog',\n    });\n  }\n}\n\n/**\n * The catalogService provides the catalog API.\n *\n * @public\n */\nexport const catalogServiceRef = createServiceRef<CatalogService>({\n  id: 'catalog-client',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\n        auth: coreServices.auth,\n        discoveryApi: coreServices.discovery,\n      },\n      async factory({ auth, discoveryApi }) {\n        return new DefaultCatalogService({\n          auth,\n          catalogApi: new CatalogClient({ discoveryApi }),\n        });\n      },\n    }),\n});\n"],"names":["createServiceRef","createServiceFactory","coreServices","CatalogClient"],"mappings":";;;;;AAwIA,MAAM,qBAAgD,CAAA;AAAA,EAC3C,KAAA;AAAA,EACA,WAAA;AAAA,EAET,WAAY,CAAA;AAAA,IACV,UAAA;AAAA,IACA;AAAA,GAIC,EAAA;AACD,IAAA,IAAA,CAAK,WAAc,GAAA,UAAA;AACnB,IAAA,IAAA,CAAK,KAAQ,GAAA,IAAA;AAAA;AACf,EAEA,MAAM,WACJ,CAAA,OAAA,EACA,OAC8B,EAAA;AAC9B,IAAA,OAAO,KAAK,WAAY,CAAA,WAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,iBACJ,CAAA,OAAA,EACA,OACoC,EAAA;AACpC,IAAA,OAAO,KAAK,WAAY,CAAA,iBAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,aACJ,CAAA,OAAA,EACA,OACgC,EAAA;AAChC,IAAA,OAAO,KAAK,WAAY,CAAA,aAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,kBACJ,CAAA,OAAA,EACA,OACqC,EAAA;AACrC,IAAA,OAAO,KAAK,WAAY,CAAA,kBAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,cACJ,CAAA,SAAA,EACA,OAC6B,EAAA;AAC7B,IAAA,OAAO,KAAK,WAAY,CAAA,cAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,iBACJ,CAAA,GAAA,EACA,OACe,EAAA;AACf,IAAA,OAAO,KAAK,WAAY,CAAA,iBAAA;AAAA,MACtB,GAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,aACJ,CAAA,SAAA,EACA,OACe,EAAA;AACf,IAAA,OAAO,KAAK,WAAY,CAAA,aAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,eACJ,CAAA,OAAA,EACA,OACkC,EAAA;AAClC,IAAA,OAAO,KAAK,WAAY,CAAA,eAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,YACJ,CAAA,OAAA,EACA,OAC+B,EAAA;AAC/B,IAAA,OAAO,KAAK,WAAY,CAAA,YAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,eACJ,CAAA,EAAA,EACA,OAC+B,EAAA;AAC/B,IAAA,OAAO,KAAK,WAAY,CAAA,eAAA;AAAA,MACtB,EAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,gBACJ,CAAA,WAAA,EACA,OAC+B,EAAA;AAC/B,IAAA,OAAO,KAAK,WAAY,CAAA,gBAAA;AAAA,MACtB,WAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,WACJ,CAAA,QAAA,EACA,OAC8B,EAAA;AAC9B,IAAA,OAAO,KAAK,WAAY,CAAA,WAAA;AAAA,MACtB,QAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,kBACJ,CAAA,EAAA,EACA,OACe,EAAA;AACf,IAAA,OAAO,KAAK,WAAY,CAAA,kBAAA;AAAA,MACtB,EAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,mBACJ,CAAA,SAAA,EACA,OAC+B,EAAA;AAC/B,IAAA,OAAO,KAAK,WAAY,CAAA,mBAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,cAAA,CACJ,MACA,EAAA,WAAA,EACA,OACiC,EAAA;AACjC,IAAA,OAAO,KAAK,WAAY,CAAA,cAAA;AAAA,MACtB,MAAA;AAAA,MACA,WAAA;AAAA,MACA,MAAM,IAAK,CAAA,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA;AACF,EAEA,MAAM,YACJ,OACgC,EAAA;AAChC,IAAO,OAAA,IAAA,CAAK,MAAM,qBAAsB,CAAA;AAAA,MACtC,YAAY,OAAQ,CAAA,WAAA;AAAA,MACpB,cAAgB,EAAA;AAAA,KACjB,CAAA;AAAA;AAEL;AAOO,MAAM,oBAAoBA,iCAAiC,CAAA;AAAA,EAChE,EAAI,EAAA,gBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAqB,CAAA;AAAA,IACnB,OAAA;AAAA,IACA,IAAM,EAAA;AAAA,MACJ,MAAMC,6BAAa,CAAA,IAAA;AAAA,MACnB,cAAcA,6BAAa,CAAA;AAAA,KAC7B;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,IAAA,EAAM,cAAgB,EAAA;AACpC,MAAA,OAAO,IAAI,qBAAsB,CAAA;AAAA,QAC/B,IAAA;AAAA,QACA,UAAY,EAAA,IAAIC,2BAAc,CAAA,EAAE,cAAc;AAAA,OAC/C,CAAA;AAAA;AACH,GACD;AACL,CAAC;;;;"}

package/dist/extensions.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { Entity, Validators } from '@backstage/catalog-model';\nimport {\n  CatalogProcessor,\n  CatalogProcessorParser,\n  EntitiesSearchFilter,\n  EntityProvider,\n  PlaceholderResolver,\n  LocationAnalyzer,\n  ScmLocationAnalyzer,\n} from '@backstage/plugin-catalog-node';\nimport {\n  Permission,\n  PermissionRuleParams,\n} from '@backstage/plugin-permission-common';\nimport { PermissionRule } from '@backstage/plugin-permission-node';\n\n/**\n * @alpha\n */\nexport interface CatalogLocationsExtensionPoint {\n  /**\n   * Allows setting custom location types, such as showcased in: https://backstage.io/docs/features/software-catalog/external-integrations/#creating-a-catalog-data-reader-processor\n   * @param locationTypes - List of location types to allow, default is \"url\" and \"file\"\n   */\n  setAllowedLocationTypes(locationTypes: Array<string>): void;\n}\n\n/**\n * @alpha\n */\nexport const catalogLocationsExtensionPoint =\n  createExtensionPoint<CatalogLocationsExtensionPoint>({\n    id: 'catalog.locations',\n  });\n\n/**\n * @alpha\n */\nexport interface CatalogProcessingExtensionPoint {\n  addProcessor(\n    ...processors: Array<CatalogProcessor | Array<CatalogProcessor>>\n  ): void;\n  addEntityProvider(\n    ...providers: Array<EntityProvider | Array<EntityProvider>>\n  ): void;\n  addPlaceholderResolver(key: string, resolver: PlaceholderResolver): void;\n  setOnProcessingErrorHandler(\n    handler: (event: {\n      unprocessedEntity: Entity;\n      errors: Error[];\n    }) => Promise<void> | void,\n  ): void;\n}\n\n/** @alpha */\nexport interface CatalogModelExtensionPoint {\n  /**\n   * Sets the validator function to use for one or more special fields of an\n   * entity. This is useful if the default rules for formatting of fields are\n   * not sufficient.\n   *\n   * @param validators - The (subset of) validators to set\n   */\n  setFieldValidators(validators: Partial<Validators>): void;\n\n  /**\n   * Sets the entity data parser which is used to read raw data from locations\n   * @param parser - Parser which will used to extract entities from raw data\n   */\n  setEntityDataParser(parser: CatalogProcessorParser): void;\n}\n\n/**\n * @alpha\n */\nexport const catalogProcessingExtensionPoint =\n  createExtensionPoint<CatalogProcessingExtensionPoint>({\n    id: 'catalog.processing',\n  });\n\n/**\n * @alpha\n */\nexport interface CatalogAnalysisExtensionPoint {\n  /**\n   * Replaces the entire location analyzer with a new one.\n   *\n   * @remarks\n   *\n   * By providing a factory function you can access all the SCM analyzers that\n   * have been added through `addScmLocationAnalyzer`. If you provide a\n   * `LocationAnalyzer` directly, the SCM analyzers will be ignored.\n   */\n  setLocationAnalyzer(\n    analyzerOrFactory:\n      | LocationAnalyzer\n      | ((options: {\n          scmLocationAnalyzers: ScmLocationAnalyzer[];\n        }) => Promise<{ locationAnalyzer: LocationAnalyzer }>),\n  ): void;\n\n  /**\n   * Adds an analyzer for a specific SCM type to the default location analyzer.\n   */\n  addScmLocationAnalyzer(analyzer: ScmLocationAnalyzer): void;\n}\n\n/**\n * @alpha\n */\nexport const catalogAnalysisExtensionPoint =\n  createExtensionPoint<CatalogAnalysisExtensionPoint>({\n    id: 'catalog.analysis',\n  });\n\n/** @alpha */\nexport const catalogModelExtensionPoint =\n  createExtensionPoint<CatalogModelExtensionPoint>({\n    id: 'catalog.model',\n  });\n\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport type CatalogPermissionRuleInput<\n  TParams extends PermissionRuleParams = PermissionRuleParams,\n> = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;\n\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport interface CatalogPermissionExtensionPoint {\n  addPermissions(...permissions: Array<Permission | Array<Permission>>): void;\n  addPermissionRules(\n    ...rules: Array<\n      CatalogPermissionRuleInput | Array<CatalogPermissionRuleInput>\n    >\n  ): void;\n}\n\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport const catalogPermissionExtensionPoint =\n  createExtensionPoint<CatalogPermissionExtensionPoint>({\n    id: 'catalog.permission',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AA+CO,MAAM,iCACXA,qCAAqD,CAAA;AAAA,EACnD,EAAI,EAAA;AACN,CAAC;AA0CI,MAAM,kCACXA,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA;AACN,CAAC;AAgCI,MAAM,gCACXA,qCAAoD,CAAA;AAAA,EAClD,EAAI,EAAA;AACN,CAAC;AAGI,MAAM,6BACXA,qCAAiD,CAAA;AAAA,EAC/C,EAAI,EAAA;AACN,CAAC;AA2BI,MAAM,kCACXA,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA;AACN,CAAC;;;;;;;;"}
+{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { Entity, Validators } from '@backstage/catalog-model';\nimport {\n  CatalogProcessor,\n  CatalogProcessorParser,\n  EntitiesSearchFilter,\n  EntityProvider,\n  PlaceholderResolver,\n  LocationAnalyzer,\n  ScmLocationAnalyzer,\n} from '@backstage/plugin-catalog-node';\nimport {\n  Permission,\n  PermissionRuleParams,\n} from '@backstage/plugin-permission-common';\nimport { PermissionRule } from '@backstage/plugin-permission-node';\n\n/**\n * @alpha\n */\nexport interface CatalogLocationsExtensionPoint {\n  /**\n   * Allows setting custom location types, such as showcased in: https://backstage.io/docs/features/software-catalog/external-integrations/#creating-a-catalog-data-reader-processor\n   * @param locationTypes - List of location types to allow, default is \"url\" and \"file\"\n   */\n  setAllowedLocationTypes(locationTypes: Array<string>): void;\n}\n\n/**\n * @alpha\n */\nexport const catalogLocationsExtensionPoint =\n  createExtensionPoint<CatalogLocationsExtensionPoint>({\n    id: 'catalog.locations',\n  });\n\n/**\n * @alpha\n */\nexport interface CatalogProcessingExtensionPoint {\n  /**\n   * Adds entity processors. These are responsible for reading, parsing, and\n   * processing entities before they are persisted in the catalog.\n   *\n   * This function also can replace a Default processor if the provided processor\n   * matches the processor name.\n   *\n   * @param processors - One or more processors\n   */\n  addProcessor(\n    ...processors: Array<CatalogProcessor | Array<CatalogProcessor>>\n  ): void;\n\n  /**\n   * Adds or replaces entity providers. These are responsible for bootstrapping\n   * the list of entities out of original data sources. For example, there is\n   * one entity source for the config locations, and one for the database\n   * stored locations. If you ingest entities out of a third party system, you\n   * may want to implement that in terms of an entity provider as well.\n   *\n   * @param providers - One or more entity providers\n   */\n  addEntityProvider(\n    ...providers: Array<EntityProvider | Array<EntityProvider>>\n  ): void;\n\n  /**\n   * Adds, or overwrites, a handler for placeholders (e.g. $file) in entity\n   * definition files.\n   *\n   * @param key - The key that identifies the placeholder, e.g. \"file\"\n   * @param resolver - The resolver that gets values for this placeholder\n   */\n  addPlaceholderResolver(key: string, resolver: PlaceholderResolver): void;\n\n  setOnProcessingErrorHandler(\n    handler: (event: {\n      unprocessedEntity: Entity;\n      errors: Error[];\n    }) => Promise<void> | void,\n  ): void;\n}\n\n/** @alpha */\nexport interface CatalogModelExtensionPoint {\n  /**\n   * Sets the validator function to use for one or more special fields of an\n   * entity. This is useful if the default rules for formatting of fields are\n   * not sufficient.\n   *\n   * @param validators - The (subset of) validators to set\n   */\n  setFieldValidators(validators: Partial<Validators>): void;\n\n  /**\n   * Sets the entity data parser which is used to read raw data from locations\n   * @param parser - Parser which will used to extract entities from raw data\n   */\n  setEntityDataParser(parser: CatalogProcessorParser): void;\n}\n\n/**\n * @alpha\n */\nexport const catalogProcessingExtensionPoint =\n  createExtensionPoint<CatalogProcessingExtensionPoint>({\n    id: 'catalog.processing',\n  });\n\n/**\n * @alpha\n */\nexport interface CatalogAnalysisExtensionPoint {\n  /**\n   * Replaces the entire location analyzer with a new one.\n   *\n   * @remarks\n   *\n   * By providing a factory function you can access all the SCM analyzers that\n   * have been added through `addScmLocationAnalyzer`. If you provide a\n   * `LocationAnalyzer` directly, the SCM analyzers will be ignored.\n   */\n  setLocationAnalyzer(\n    analyzerOrFactory:\n      | LocationAnalyzer\n      | ((options: {\n          scmLocationAnalyzers: ScmLocationAnalyzer[];\n        }) => Promise<{ locationAnalyzer: LocationAnalyzer }>),\n  ): void;\n\n  /**\n   * Adds an analyzer for a specific SCM type to the default location analyzer.\n   */\n  addScmLocationAnalyzer(analyzer: ScmLocationAnalyzer): void;\n}\n\n/**\n * @alpha\n */\nexport const catalogAnalysisExtensionPoint =\n  createExtensionPoint<CatalogAnalysisExtensionPoint>({\n    id: 'catalog.analysis',\n  });\n\n/** @alpha */\nexport const catalogModelExtensionPoint =\n  createExtensionPoint<CatalogModelExtensionPoint>({\n    id: 'catalog.model',\n  });\n\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport type CatalogPermissionRuleInput<\n  TParams extends PermissionRuleParams = PermissionRuleParams,\n> = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;\n\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport interface CatalogPermissionExtensionPoint {\n  addPermissions(...permissions: Array<Permission | Array<Permission>>): void;\n  addPermissionRules(\n    ...rules: Array<\n      CatalogPermissionRuleInput | Array<CatalogPermissionRuleInput>\n    >\n  ): void;\n}\n\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport const catalogPermissionExtensionPoint =\n  createExtensionPoint<CatalogPermissionExtensionPoint>({\n    id: 'catalog.permission',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AA+CO,MAAM,iCACXA,qCAAqD,CAAA;AAAA,EACnD,EAAI,EAAA;AACN,CAAC;AAsEI,MAAM,kCACXA,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA;AACN,CAAC;AAgCI,MAAM,gCACXA,qCAAoD,CAAA;AAAA,EAClD,EAAI,EAAA;AACN,CAAC;AAGI,MAAM,6BACXA,qCAAiD,CAAA;AAAA,EAC/C,EAAI,EAAA;AACN,CAAC;AA2BI,MAAM,kCACXA,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA;AACN,CAAC;;;;;;;;"}

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { JsonValue } from '@backstage/types';
 import { LocationSpec as LocationSpec$1, AnalyzeLocationRequest, AnalyzeLocationResponse, AnalyzeLocationExistingEntity } from '@backstage/plugin-catalog-common';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { BackstageCredentials } from '@backstage/backend-plugin-api';
-import { GetEntitiesRequest, GetEntitiesResponse, GetEntitiesByRefsRequest, GetEntitiesByRefsResponse, QueryEntitiesRequest, QueryEntitiesResponse, GetEntityAncestorsRequest, GetEntityAncestorsResponse, GetEntityFacetsRequest, GetEntityFacetsResponse, Location, AddLocationRequest, AddLocationResponse, ValidateEntityResponse } from '@backstage/catalog-client';
+import { GetEntitiesRequest, GetEntitiesResponse, GetEntitiesByRefsRequest, GetEntitiesByRefsResponse, QueryEntitiesRequest, QueryEntitiesResponse, GetEntityAncestorsRequest, GetEntityAncestorsResponse, GetEntityFacetsRequest, GetEntityFacetsResponse, GetLocationsResponse, Location, AddLocationRequest, AddLocationResponse, ValidateEntityResponse } from '@backstage/catalog-client';
 
 /**
  * Holds the entity location information.
@@ -397,6 +397,7 @@ interface CatalogService {
     removeEntityByUid(uid: string, options: CatalogServiceRequestOptions): Promise<void>;
     refreshEntity(entityRef: string, options: CatalogServiceRequestOptions): Promise<void>;
     getEntityFacets(request: GetEntityFacetsRequest, options: CatalogServiceRequestOptions): Promise<GetEntityFacetsResponse>;
+    getLocations(request: {} | undefined, options: CatalogServiceRequestOptions): Promise<GetLocationsResponse>;
     getLocationById(id: string, options: CatalogServiceRequestOptions): Promise<Location | undefined>;
     getLocationByRef(locationRef: string, options: CatalogServiceRequestOptions): Promise<Location | undefined>;
     addLocation(location: AddLocationRequest, options: CatalogServiceRequestOptions): Promise<AddLocationResponse>;

package/dist/testUtils/catalogServiceMock.cjs.js

@@ -43,6 +43,7 @@ function catalogServiceMock(options) {
     removeEntityByUid: jest.fn(),
     refreshEntity: jest.fn(),
     getEntityFacets: jest.fn(),
+    getLocations: jest.fn(),
     getLocationById: jest.fn(),
     getLocationByRef: jest.fn(),
     addLocation: jest.fn(),

package/dist/testUtils/catalogServiceMock.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"catalogServiceMock.cjs.js","sources":["../../src/testUtils/catalogServiceMock.ts"],"sourcesContent":["/*\n * Copyright 2024 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  ServiceFactory,\n  ServiceRef,\n  createServiceFactory,\n} from '@backstage/backend-plugin-api';\nimport { InMemoryCatalogClient } from '@backstage/catalog-client/testUtils';\nimport { Entity } from '@backstage/catalog-model';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\n// eslint-disable-next-line @backstage/no-undeclared-imports\nimport { ServiceMock } from '@backstage/backend-test-utils';\nimport { CatalogServiceMock } from './types';\n\n/** @internal */\nfunction simpleMock<TService>(\n  ref: ServiceRef<TService, any>,\n  mockFactory: () => jest.Mocked<TService>,\n): (partialImpl?: Partial<TService>) => ServiceMock<TService> {\n  return partialImpl => {\n    const mock = mockFactory();\n    if (partialImpl) {\n      for (const [key, impl] of Object.entries(partialImpl)) {\n        if (typeof impl === 'function') {\n          (mock as any)[key].mockImplementation(impl);\n        } else {\n          (mock as any)[key] = impl;\n        }\n      }\n    }\n    return Object.assign(mock, {\n      factory: createServiceFactory({\n        service: ref,\n        deps: {},\n        factory: () => mock,\n      }),\n    }) as ServiceMock<TService>;\n  };\n}\n\n/**\n * Creates a fake catalog client that handles entities in memory storage. Note\n * that this client may be severely limited in functionality, and advanced\n * functions may not be available at all.\n *\n * @public\n */\nexport function catalogServiceMock(options?: {\n  entities?: Entity[];\n}): CatalogServiceMock {\n  return new InMemoryCatalogClient(options);\n}\n\n/**\n * A collection of mock functionality for the catalog service.\n *\n * @public\n */\nexport namespace catalogServiceMock {\n  /**\n   * Creates a fake catalog client that handles entities in memory storage. Note\n   * that this client may be severely limited in functionality, and advanced\n   * functions may not be available at all.\n   */\n  export const factory = (options?: { entities?: Entity[] }) =>\n    createServiceFactory({\n      service: catalogServiceRef,\n      deps: {},\n      factory: () => new InMemoryCatalogClient(options),\n    }) as ServiceFactory<CatalogServiceMock, 'plugin', 'singleton'>;\n  /**\n   * Creates a catalog client whose methods are mock functions, possibly with\n   * some of them overloaded by the caller.\n   */\n  export const mock = simpleMock<CatalogServiceMock>(catalogServiceRef, () => ({\n    getEntities: jest.fn(),\n    getEntitiesByRefs: jest.fn(),\n    queryEntities: jest.fn(),\n    getEntityAncestors: jest.fn(),\n    getEntityByRef: jest.fn(),\n    removeEntityByUid: jest.fn(),\n    refreshEntity: jest.fn(),\n    getEntityFacets: jest.fn(),\n    getLocationById: jest.fn(),\n    getLocationByRef: jest.fn(),\n    addLocation: jest.fn(),\n    removeLocationById: jest.fn(),\n    getLocationByEntity: jest.fn(),\n    validateEntity: jest.fn(),\n  }));\n}\n"],"names":["createServiceFactory","InMemoryCatalogClient","catalogServiceMock","catalogServiceRef"],"mappings":";;;;;;AA6BA,SAAS,UAAA,CACP,KACA,WAC4D,EAAA;AAC5D,EAAA,OAAO,CAAe,WAAA,KAAA;AACpB,IAAA,MAAM,OAAO,WAAY,EAAA;AACzB,IAAA,IAAI,WAAa,EAAA;AACf,MAAA,KAAA,MAAW,CAAC,GAAK,EAAA,IAAI,KAAK,MAAO,CAAA,OAAA,CAAQ,WAAW,CAAG,EAAA;AACrD,QAAI,IAAA,OAAO,SAAS,UAAY,EAAA;AAC9B,UAAC,IAAa,CAAA,GAAG,CAAE,CAAA,kBAAA,CAAmB,IAAI,CAAA;AAAA,SACrC,MAAA;AACL,UAAC,IAAA,CAAa,GAAG,CAAI,GAAA,IAAA;AAAA;AACvB;AACF;AAEF,IAAO,OAAA,MAAA,CAAO,OAAO,IAAM,EAAA;AAAA,MACzB,SAASA,qCAAqB,CAAA;AAAA,QAC5B,OAAS,EAAA,GAAA;AAAA,QACT,MAAM,EAAC;AAAA,QACP,SAAS,MAAM;AAAA,OAChB;AAAA,KACF,CAAA;AAAA,GACH;AACF;AASO,SAAS,mBAAmB,OAEZ,EAAA;AACrB,EAAO,OAAA,IAAIC,gCAAsB,OAAO,CAAA;AAC1C;AAAA,CAOO,CAAUC,mBAAV,KAAA;AAME,EAAMA,mBAAA,CAAA,OAAA,GAAU,CAAC,OAAA,KACtBF,qCAAqB,CAAA;AAAA,IACnB,OAAS,EAAAG,mCAAA;AAAA,IACT,MAAM,EAAC;AAAA,IACP,OAAS,EAAA,MAAM,IAAIF,+BAAA,CAAsB,OAAO;AAAA,GACjD,CAAA;AAKI,EAAMC,mBAAA,CAAA,IAAA,GAAO,UAA+B,CAAAC,mCAAA,EAAmB,OAAO;AAAA,IAC3E,WAAA,EAAa,KAAK,EAAG,EAAA;AAAA,IACrB,iBAAA,EAAmB,KAAK,EAAG,EAAA;AAAA,IAC3B,aAAA,EAAe,KAAK,EAAG,EAAA;AAAA,IACvB,kBAAA,EAAoB,KAAK,EAAG,EAAA;AAAA,IAC5B,cAAA,EAAgB,KAAK,EAAG,EAAA;AAAA,IACxB,iBAAA,EAAmB,KAAK,EAAG,EAAA;AAAA,IAC3B,aAAA,EAAe,KAAK,EAAG,EAAA;AAAA,IACvB,eAAA,EAAiB,KAAK,EAAG,EAAA;AAAA,IACzB,eAAA,EAAiB,KAAK,EAAG,EAAA;AAAA,IACzB,gBAAA,EAAkB,KAAK,EAAG,EAAA;AAAA,IAC1B,WAAA,EAAa,KAAK,EAAG,EAAA;AAAA,IACrB,kBAAA,EAAoB,KAAK,EAAG,EAAA;AAAA,IAC5B,mBAAA,EAAqB,KAAK,EAAG,EAAA;AAAA,IAC7B,cAAA,EAAgB,KAAK,EAAG;AAAA,GACxB,CAAA,CAAA;AAAA,CA/Ba,EAAA,kBAAA,KAAA,kBAAA,GAAA,EAAA,CAAA,CAAA;;;;"}
+{"version":3,"file":"catalogServiceMock.cjs.js","sources":["../../src/testUtils/catalogServiceMock.ts"],"sourcesContent":["/*\n * Copyright 2024 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  ServiceFactory,\n  ServiceRef,\n  createServiceFactory,\n} from '@backstage/backend-plugin-api';\nimport { InMemoryCatalogClient } from '@backstage/catalog-client/testUtils';\nimport { Entity } from '@backstage/catalog-model';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\n// eslint-disable-next-line @backstage/no-undeclared-imports\nimport { ServiceMock } from '@backstage/backend-test-utils';\nimport { CatalogServiceMock } from './types';\n\n/** @internal */\nfunction simpleMock<TService>(\n  ref: ServiceRef<TService, any>,\n  mockFactory: () => jest.Mocked<TService>,\n): (partialImpl?: Partial<TService>) => ServiceMock<TService> {\n  return partialImpl => {\n    const mock = mockFactory();\n    if (partialImpl) {\n      for (const [key, impl] of Object.entries(partialImpl)) {\n        if (typeof impl === 'function') {\n          (mock as any)[key].mockImplementation(impl);\n        } else {\n          (mock as any)[key] = impl;\n        }\n      }\n    }\n    return Object.assign(mock, {\n      factory: createServiceFactory({\n        service: ref,\n        deps: {},\n        factory: () => mock,\n      }),\n    }) as ServiceMock<TService>;\n  };\n}\n\n/**\n * Creates a fake catalog client that handles entities in memory storage. Note\n * that this client may be severely limited in functionality, and advanced\n * functions may not be available at all.\n *\n * @public\n */\nexport function catalogServiceMock(options?: {\n  entities?: Entity[];\n}): CatalogServiceMock {\n  return new InMemoryCatalogClient(options);\n}\n\n/**\n * A collection of mock functionality for the catalog service.\n *\n * @public\n */\nexport namespace catalogServiceMock {\n  /**\n   * Creates a fake catalog client that handles entities in memory storage. Note\n   * that this client may be severely limited in functionality, and advanced\n   * functions may not be available at all.\n   */\n  export const factory = (options?: { entities?: Entity[] }) =>\n    createServiceFactory({\n      service: catalogServiceRef,\n      deps: {},\n      factory: () => new InMemoryCatalogClient(options),\n    }) as ServiceFactory<CatalogServiceMock, 'plugin', 'singleton'>;\n  /**\n   * Creates a catalog client whose methods are mock functions, possibly with\n   * some of them overloaded by the caller.\n   */\n  export const mock = simpleMock<CatalogServiceMock>(catalogServiceRef, () => ({\n    getEntities: jest.fn(),\n    getEntitiesByRefs: jest.fn(),\n    queryEntities: jest.fn(),\n    getEntityAncestors: jest.fn(),\n    getEntityByRef: jest.fn(),\n    removeEntityByUid: jest.fn(),\n    refreshEntity: jest.fn(),\n    getEntityFacets: jest.fn(),\n    getLocations: jest.fn(),\n    getLocationById: jest.fn(),\n    getLocationByRef: jest.fn(),\n    addLocation: jest.fn(),\n    removeLocationById: jest.fn(),\n    getLocationByEntity: jest.fn(),\n    validateEntity: jest.fn(),\n  }));\n}\n"],"names":["createServiceFactory","InMemoryCatalogClient","catalogServiceMock","catalogServiceRef"],"mappings":";;;;;;AA6BA,SAAS,UAAA,CACP,KACA,WAC4D,EAAA;AAC5D,EAAA,OAAO,CAAe,WAAA,KAAA;AACpB,IAAA,MAAM,OAAO,WAAY,EAAA;AACzB,IAAA,IAAI,WAAa,EAAA;AACf,MAAA,KAAA,MAAW,CAAC,GAAK,EAAA,IAAI,KAAK,MAAO,CAAA,OAAA,CAAQ,WAAW,CAAG,EAAA;AACrD,QAAI,IAAA,OAAO,SAAS,UAAY,EAAA;AAC9B,UAAC,IAAa,CAAA,GAAG,CAAE,CAAA,kBAAA,CAAmB,IAAI,CAAA;AAAA,SACrC,MAAA;AACL,UAAC,IAAA,CAAa,GAAG,CAAI,GAAA,IAAA;AAAA;AACvB;AACF;AAEF,IAAO,OAAA,MAAA,CAAO,OAAO,IAAM,EAAA;AAAA,MACzB,SAASA,qCAAqB,CAAA;AAAA,QAC5B,OAAS,EAAA,GAAA;AAAA,QACT,MAAM,EAAC;AAAA,QACP,SAAS,MAAM;AAAA,OAChB;AAAA,KACF,CAAA;AAAA,GACH;AACF;AASO,SAAS,mBAAmB,OAEZ,EAAA;AACrB,EAAO,OAAA,IAAIC,gCAAsB,OAAO,CAAA;AAC1C;AAAA,CAOO,CAAUC,mBAAV,KAAA;AAME,EAAMA,mBAAA,CAAA,OAAA,GAAU,CAAC,OAAA,KACtBF,qCAAqB,CAAA;AAAA,IACnB,OAAS,EAAAG,mCAAA;AAAA,IACT,MAAM,EAAC;AAAA,IACP,OAAS,EAAA,MAAM,IAAIF,+BAAA,CAAsB,OAAO;AAAA,GACjD,CAAA;AAKI,EAAMC,mBAAA,CAAA,IAAA,GAAO,UAA+B,CAAAC,mCAAA,EAAmB,OAAO;AAAA,IAC3E,WAAA,EAAa,KAAK,EAAG,EAAA;AAAA,IACrB,iBAAA,EAAmB,KAAK,EAAG,EAAA;AAAA,IAC3B,aAAA,EAAe,KAAK,EAAG,EAAA;AAAA,IACvB,kBAAA,EAAoB,KAAK,EAAG,EAAA;AAAA,IAC5B,cAAA,EAAgB,KAAK,EAAG,EAAA;AAAA,IACxB,iBAAA,EAAmB,KAAK,EAAG,EAAA;AAAA,IAC3B,aAAA,EAAe,KAAK,EAAG,EAAA;AAAA,IACvB,eAAA,EAAiB,KAAK,EAAG,EAAA;AAAA,IACzB,YAAA,EAAc,KAAK,EAAG,EAAA;AAAA,IACtB,eAAA,EAAiB,KAAK,EAAG,EAAA;AAAA,IACzB,gBAAA,EAAkB,KAAK,EAAG,EAAA;AAAA,IAC1B,WAAA,EAAa,KAAK,EAAG,EAAA;AAAA,IACrB,kBAAA,EAAoB,KAAK,EAAG,EAAA;AAAA,IAC5B,mBAAA,EAAqB,KAAK,EAAG,EAAA;AAAA,IAC7B,cAAA,EAAgB,KAAK,EAAG;AAAA,GACxB,CAAA,CAAA;AAAA,CAhCa,EAAA,kBAAA,KAAA,kBAAA,GAAA,EAAA,CAAA,CAAA;;;;"}

package/dist/testUtils.d.ts

@@ -1,7 +1,7 @@
 import { ServiceFactory } from '@backstage/backend-plugin-api';
 import { CompoundEntityRef, Entity } from '@backstage/catalog-model';
 import { ServiceMock } from '@backstage/backend-test-utils';
-import { CatalogApi, GetEntitiesRequest, CatalogRequestOptions, GetEntitiesResponse, GetEntitiesByRefsRequest, GetEntitiesByRefsResponse, QueryEntitiesRequest, QueryEntitiesResponse, GetEntityAncestorsRequest, GetEntityAncestorsResponse, GetEntityFacetsRequest, GetEntityFacetsResponse, Location, AddLocationRequest, AddLocationResponse, ValidateEntityResponse } from '@backstage/catalog-client';
+import { CatalogApi, GetEntitiesRequest, CatalogRequestOptions, GetEntitiesResponse, GetEntitiesByRefsRequest, GetEntitiesByRefsResponse, QueryEntitiesRequest, QueryEntitiesResponse, GetEntityAncestorsRequest, GetEntityAncestorsResponse, GetEntityFacetsRequest, GetEntityFacetsResponse, GetLocationsResponse, Location, AddLocationRequest, AddLocationResponse, ValidateEntityResponse } from '@backstage/catalog-client';
 import { CatalogService, CatalogServiceRequestOptions } from '@backstage/plugin-catalog-node';
 
 /**
@@ -24,6 +24,7 @@ interface CatalogServiceMock extends CatalogService, CatalogApi {
     removeEntityByUid(uid: string, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<void>;
     refreshEntity(entityRef: string, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<void>;
     getEntityFacets(request: GetEntityFacetsRequest, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<GetEntityFacetsResponse>;
+    getLocations(request?: {}, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<GetLocationsResponse>;
     getLocationById(id: string, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<Location | undefined>;
     getLocationByRef(locationRef: string, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<Location | undefined>;
     addLocation(location: AddLocationRequest, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<AddLocationResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-node",
-  "version": "1.16.3-next.0",
+  "version": "1.17.0-next.0",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
   "backstage": {
     "role": "node-library",
@@ -72,18 +72,18 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.2.1",
-    "@backstage/catalog-client": "1.9.1",
+    "@backstage/backend-plugin-api": "1.3.1-next.0",
+    "@backstage/catalog-client": "1.10.0-next.0",
     "@backstage/catalog-model": "1.7.3",
     "@backstage/errors": "1.2.7",
     "@backstage/plugin-catalog-common": "1.1.3",
     "@backstage/plugin-permission-common": "0.8.4",
-    "@backstage/plugin-permission-node": "0.9.0",
+    "@backstage/plugin-permission-node": "0.9.2-next.0",
     "@backstage/types": "1.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.3.2-next.2",
-    "@backstage/cli": "0.32.0-next.2",
+    "@backstage/backend-test-utils": "1.5.0-next.0",
+    "@backstage/cli": "0.32.1-next.0",
     "msw": "^1.0.0"
   }
 }