@backstage/plugin-catalog-node 2.0.0-next.1 → 2.1.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,55 @@
 # @backstage/plugin-catalog-node
 
+## 2.1.0-next.0
+
+### Minor Changes
+
+- bf71677: Added the ability for SCM events subscribers to mark the fact that they have taken actions based on events, which produces output metrics:
+
+  - `catalog.events.scm.actions` with attribute `action`: Counter for the number of actions actually taken by catalog internals or other subscribers, based on SCM events. The `action` is currently either `create`, `delete`, `refresh`, or `move`.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.7.1-next.0
+  - @backstage/catalog-client@1.13.1-next.0
+  - @backstage/backend-test-utils@1.11.1-next.0
+  - @backstage/catalog-model@1.7.6
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.2
+  - @backstage/plugin-catalog-common@1.1.8
+  - @backstage/plugin-permission-common@0.9.6
+  - @backstage/plugin-permission-node@0.10.11-next.0
+
+## 2.0.0
+
+### Minor Changes
+
+- cfd8103: Promoted stable catalog extension points from alpha to main export. The following extension points are now exported from `@backstage/plugin-catalog-node` instead of `@backstage/plugin-catalog-node/alpha`:
+
+  - `catalogLocationsExtensionPoint` and `CatalogLocationsExtensionPoint`
+  - `catalogProcessingExtensionPoint` and `CatalogProcessingExtensionPoint`
+  - `catalogAnalysisExtensionPoint` and `CatalogAnalysisExtensionPoint`
+
+  The old alpha exports for these extension points are now deprecated with `@deprecated` markers pointing to the new stable exports. Please update your imports from `@backstage/plugin-catalog-node/alpha` to `@backstage/plugin-catalog-node`.
+
+  Note: The `catalogModelExtensionPoint`, `catalogPermissionExtensionPoint`, and related types remain in alpha.
+
+- b4e8249: Implemented support for the new `queryLocations` and `streamLocations` that allow paginated/streamed and filtered location queries
+- 34cc520: Introduced the `catalogScmEventsServiceRef`, along with `CatalogScmEventsService` and associated types. These allow communicating a unified set of events, that parts of the catalog can react to.
+
+### Patch Changes
+
+- 42abfb1: Updated `catalogServiceMock.mock` to use `createServiceMock` from `@backstage/backend-test-utils`, replacing the internal copy of `simpleMock`. Added `@backstage/backend-test-utils` as an optional peer dependency.
+- 7455dae: Use node prefix on native imports
+- Updated dependencies
+  - @backstage/backend-test-utils@1.11.0
+  - @backstage/backend-plugin-api@1.7.0
+  - @backstage/catalog-client@1.13.0
+  - @backstage/plugin-permission-common@0.9.6
+  - @backstage/plugin-permission-node@0.10.10
+  - @backstage/plugin-catalog-common@1.1.8
+
 ## 2.0.0-next.1
 
 ### Patch Changes

package/dist/alpha.cjs.js

@@ -6,6 +6,7 @@ var alpha = require('@backstage/plugin-catalog-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
 var pluginCatalogNode = require('@backstage/plugin-catalog-node');
 var extensions = require('./extensions.cjs.js');
+var catalogScmEventsServiceRef = require('./scmEvents/catalogScmEventsServiceRef.cjs.js');
 
 const catalogEntityPermissionResourceRef = pluginPermissionNode.createPermissionResourceRef().with({
   pluginId: "catalog",
@@ -29,6 +30,7 @@ const catalogAnalysisExtensionPoint = pluginCatalogNode.catalogAnalysisExtension
 
 exports.catalogModelExtensionPoint = extensions.catalogModelExtensionPoint;
 exports.catalogPermissionExtensionPoint = extensions.catalogPermissionExtensionPoint;
+exports.catalogScmEventsServiceRef = catalogScmEventsServiceRef.catalogScmEventsServiceRef;
 exports.catalogAnalysisExtensionPoint = catalogAnalysisExtensionPoint;
 exports.catalogEntityPermissionResourceRef = catalogEntityPermissionResourceRef;
 exports.catalogLocationsExtensionPoint = catalogLocationsExtensionPoint;

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.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  coreServices,\n  createServiceFactory,\n  createServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef as _catalogServiceRef } from './catalogService';\nimport { CatalogApi, CatalogClient } from '@backstage/catalog-client';\nimport { RESOURCE_TYPE_CATALOG_ENTITY } from '@backstage/plugin-catalog-common/alpha';\nimport { createPermissionResourceRef } from '@backstage/plugin-permission-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { EntitiesSearchFilter } from '@backstage/plugin-catalog-node';\n\n/** @alpha */\nexport const catalogEntityPermissionResourceRef = createPermissionResourceRef<\n  Entity,\n  EntitiesSearchFilter\n>().with({\n  pluginId: 'catalog',\n  resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n});\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogServiceRef} instead\n */\nexport const catalogServiceRef = createServiceRef<CatalogApi>({\n  id: 'catalog-client-legacy',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\n        discoveryApi: coreServices.discovery,\n      },\n      async factory({ discoveryApi }) {\n        return new CatalogClient({ discoveryApi });\n      },\n    }),\n});\n\nimport {\n  CatalogLocationsExtensionPoint as _CatalogLocationsExtensionPoint,\n  CatalogProcessingExtensionPoint as _CatalogProcessingExtensionPoint,\n  CatalogAnalysisExtensionPoint as _CatalogAnalysisExtensionPoint,\n  catalogLocationsExtensionPoint as _catalogLocationsExtensionPoint,\n  catalogProcessingExtensionPoint as _catalogProcessingExtensionPoint,\n  catalogAnalysisExtensionPoint as _catalogAnalysisExtensionPoint,\n} from '@backstage/plugin-catalog-node';\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogLocationsExtensionPoint} instead\n */\nexport type CatalogLocationsExtensionPoint = _CatalogLocationsExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogLocationsExtensionPoint} instead\n */\nexport const catalogLocationsExtensionPoint = _catalogLocationsExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogProcessingExtensionPoint} instead\n */\nexport type CatalogProcessingExtensionPoint = _CatalogProcessingExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogProcessingExtensionPoint} instead\n */\nexport const catalogProcessingExtensionPoint = _catalogProcessingExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogAnalysisExtensionPoint} instead\n */\nexport type CatalogAnalysisExtensionPoint = _CatalogAnalysisExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogAnalysisExtensionPoint} instead\n */\nexport const catalogAnalysisExtensionPoint = _catalogAnalysisExtensionPoint;\n\nexport type { CatalogModelExtensionPoint } from './extensions';\nexport { catalogModelExtensionPoint } from './extensions';\nexport type { CatalogPermissionRuleInput } from './extensions';\nexport type { CatalogPermissionExtensionPoint } from './extensions';\nexport { catalogPermissionExtensionPoint } from './extensions';\n"],"names":["createPermissionResourceRef","RESOURCE_TYPE_CATALOG_ENTITY","createServiceRef","createServiceFactory","coreServices","CatalogClient","_catalogLocationsExtensionPoint","_catalogProcessingExtensionPoint","_catalogAnalysisExtensionPoint"],"mappings":";;;;;;;;;AA6BO,MAAM,kCAAA,GAAqCA,gDAAA,EAGhD,CAAE,IAAA,CAAK;AAAA,EACP,QAAA,EAAU,SAAA;AAAA,EACV,YAAA,EAAcC;AAChB,CAAC;AAMM,MAAM,oBAAoBC,iCAAA,CAA6B;AAAA,EAC5D,EAAA,EAAI,uBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAA,CAAqB;AAAA,IACnB,OAAA;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,cAAcC,6BAAA,CAAa;AAAA,KAC7B;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,YAAA,EAAa,EAAG;AAC9B,MAAA,OAAO,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,CAAA;AAAA,IAC3C;AAAA,GACD;AACL,CAAC;AAqBM,MAAM,8BAAA,GAAiCC;AAYvC,MAAM,+BAAA,GAAkCC;AAYxC,MAAM,6BAAA,GAAgCC;;;;;;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.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  coreServices,\n  createServiceFactory,\n  createServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef as _catalogServiceRef } from './catalogService';\nimport { CatalogApi, CatalogClient } from '@backstage/catalog-client';\nimport { RESOURCE_TYPE_CATALOG_ENTITY } from '@backstage/plugin-catalog-common/alpha';\nimport { createPermissionResourceRef } from '@backstage/plugin-permission-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { EntitiesSearchFilter } from '@backstage/plugin-catalog-node';\n\n/** @alpha */\nexport const catalogEntityPermissionResourceRef = createPermissionResourceRef<\n  Entity,\n  EntitiesSearchFilter\n>().with({\n  pluginId: 'catalog',\n  resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n});\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogServiceRef} instead\n */\nexport const catalogServiceRef = createServiceRef<CatalogApi>({\n  id: 'catalog-client-legacy',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\n        discoveryApi: coreServices.discovery,\n      },\n      async factory({ discoveryApi }) {\n        return new CatalogClient({ discoveryApi });\n      },\n    }),\n});\n\nimport {\n  CatalogLocationsExtensionPoint as _CatalogLocationsExtensionPoint,\n  CatalogProcessingExtensionPoint as _CatalogProcessingExtensionPoint,\n  CatalogAnalysisExtensionPoint as _CatalogAnalysisExtensionPoint,\n  catalogLocationsExtensionPoint as _catalogLocationsExtensionPoint,\n  catalogProcessingExtensionPoint as _catalogProcessingExtensionPoint,\n  catalogAnalysisExtensionPoint as _catalogAnalysisExtensionPoint,\n} from '@backstage/plugin-catalog-node';\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogLocationsExtensionPoint} instead\n */\nexport type CatalogLocationsExtensionPoint = _CatalogLocationsExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogLocationsExtensionPoint} instead\n */\nexport const catalogLocationsExtensionPoint = _catalogLocationsExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogProcessingExtensionPoint} instead\n */\nexport type CatalogProcessingExtensionPoint = _CatalogProcessingExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogProcessingExtensionPoint} instead\n */\nexport const catalogProcessingExtensionPoint = _catalogProcessingExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogAnalysisExtensionPoint} instead\n */\nexport type CatalogAnalysisExtensionPoint = _CatalogAnalysisExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogAnalysisExtensionPoint} instead\n */\nexport const catalogAnalysisExtensionPoint = _catalogAnalysisExtensionPoint;\n\nexport type { CatalogModelExtensionPoint } from './extensions';\nexport { catalogModelExtensionPoint } from './extensions';\nexport type { CatalogPermissionRuleInput } from './extensions';\nexport type { CatalogPermissionExtensionPoint } from './extensions';\nexport { catalogPermissionExtensionPoint } from './extensions';\n\nexport * from './scmEvents';\n"],"names":["createPermissionResourceRef","RESOURCE_TYPE_CATALOG_ENTITY","createServiceRef","createServiceFactory","coreServices","CatalogClient","_catalogLocationsExtensionPoint","_catalogProcessingExtensionPoint","_catalogAnalysisExtensionPoint"],"mappings":";;;;;;;;;;AA6BO,MAAM,kCAAA,GAAqCA,gDAAA,EAGhD,CAAE,IAAA,CAAK;AAAA,EACP,QAAA,EAAU,SAAA;AAAA,EACV,YAAA,EAAcC;AAChB,CAAC;AAMM,MAAM,oBAAoBC,iCAAA,CAA6B;AAAA,EAC5D,EAAA,EAAI,uBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAA,CAAqB;AAAA,IACnB,OAAA;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,cAAcC,6BAAA,CAAa;AAAA,KAC7B;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,YAAA,EAAa,EAAG;AAC9B,MAAA,OAAO,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,CAAA;AAAA,IAC3C;AAAA,GACD;AACL,CAAC;AAqBM,MAAM,8BAAA,GAAiCC;AAYvC,MAAM,+BAAA,GAAkCC;AAYxC,MAAM,6BAAA,GAAgCC;;;;;;;;;;;"}

package/dist/alpha.d.ts

@@ -6,6 +6,192 @@ import { EntitiesSearchFilter, CatalogLocationsExtensionPoint as CatalogLocation
 export { f as CatalogModelExtensionPoint, i as CatalogPermissionExtensionPoint, h as CatalogPermissionRuleInput, g as catalogModelExtensionPoint, j as catalogPermissionExtensionPoint } from './types/extensions.d-Cvnx6_V0.js';
 import '@backstage/plugin-permission-common';
 
+/**
+ * A subscriber of the {@link CatalogScmEventsService}.
+ *
+ * @alpha
+ */
+interface CatalogScmEventsServiceSubscriber {
+    /**
+     * Receives a number of events.
+     */
+    onEvents: (events: CatalogScmEvent[]) => Promise<void>;
+}
+/**
+ * A publish/subscribe service for source control management system events. This
+ * allows different producers of interesting events in a multi-SCM environment
+ * communicate those events to multiple interested parties. As an example, one
+ * entity provider might automatically register and unregister locations as an
+ * effect of these events.
+ *
+ * @alpha
+ */
+interface CatalogScmEventsService {
+    /**
+     * Subscribes to events, and returns a function to unsubscribe.
+     */
+    subscribe(subscriber: CatalogScmEventsServiceSubscriber): {
+        unsubscribe: () => void;
+    };
+    /**
+     * Publish an event to all subscribers.
+     *
+     * @remarks
+     *
+     * This call blocks until all subscribers have either acknowledged that they
+     * have received and handled the event, or thrown an error. There are no
+     * re-sends or dead letter queues; receivers must implement a suitable
+     * resilience model themselves internally if they want to have better delivery
+     * guarantees.
+     */
+    publish(events: CatalogScmEvent[]): Promise<void>;
+    /**
+     * As a consumer of SCM events, mark that you have taken an action as a result
+     * of an SCM event.
+     *
+     * This is typically used to record metrics or other observability signals
+     * about how SCM events are handled, for example counting how many refresh,
+     * delete, create, or move operations are triggered by incoming events.
+     */
+    markEventActionTaken(options: {
+        /**
+         * The number of actions taken of the given type. Defaults to 1.
+         */
+        count?: number;
+        /**
+         * The type of action taken - typically "refresh", "delete",
+         * "create", or "move".
+         */
+        action: string;
+    }): void;
+}
+/**
+ * Voluntary contextual information related to a {@link CatalogScmEvent}.
+ *
+ * @alpha
+ */
+type CatalogScmEventContext = {
+    /**
+     * URL to a commit related to this event being generated, if relevant.
+     */
+    commitUrl?: string;
+};
+/**
+ * Represents a high level change event that happened in a source control
+ * management system. These are usually produced as a distilled version of an
+ * incoming webhook event or similar.
+ *
+ * @alpha
+ */
+type CatalogScmEvent = {
+    /**
+     * A new location was created.
+     *
+     * @remarks
+     *
+     * This typically means that an individual file was created in an existing
+     * repository, for example through a git push or merge.
+     */
+    type: 'location.created';
+    url: string;
+    context?: CatalogScmEventContext;
+} | {
+    /**
+     * An existing location was modified.
+     *
+     * @remarks
+     *
+     * This typically means that an individual file was modified in an existing
+     * repository, for example through a git push or merge.
+     */
+    type: 'location.updated';
+    url: string;
+    context?: CatalogScmEventContext;
+} | {
+    /**
+     * An existing location was deleted.
+     *
+     * @remarks
+     *
+     * This typically means that an individual file was deleted in an existing
+     * repository, for example through a git push or merge.
+     */
+    type: 'location.deleted';
+    url: string;
+    context?: CatalogScmEventContext;
+} | {
+    /**
+     * An existing location was moved from one place to another.
+     *
+     * @remarks
+     *
+     * This typically means that an individual file was moved or renamed, for
+     * example through a git push or merge. The URLs do not necessarily refer
+     * to the same repository before and after the move.
+     */
+    type: 'location.moved';
+    fromUrl: string;
+    toUrl: string;
+    context?: CatalogScmEventContext;
+} | {
+    /**
+     * A new repository was created.
+     */
+    type: 'repository.created';
+    url: string;
+    context?: CatalogScmEventContext;
+} | {
+    /**
+     * An existing repository was updated.
+     *
+     * @remarks
+     *
+     * This usually refers to some form of meta state change, such as it being
+     * made public or private, or its visibility being changed.
+     */
+    type: 'repository.updated';
+    url: string;
+    context?: CatalogScmEventContext;
+} | {
+    /**
+     * An existing repository was deleted.
+     */
+    type: 'repository.deleted';
+    url: string;
+    context?: CatalogScmEventContext;
+} | {
+    /**
+     * An existing repository was moved or in some other way had its effective
+     * base URL changed.
+     *
+     * @remarks
+     *
+     * This typically refers to a repository being renamed, or transferred to
+     * a different owner. It can also refer to a change of base branch, which
+     * effectively changes the base URL for many repository URL patterns.
+     *
+     * The source and target URLs do not necessarily end exactly on a
+     * repository, but MAY include additional path segments such as the branch
+     * name.
+     */
+    type: 'repository.moved';
+    fromUrl: string;
+    toUrl: string;
+    context?: CatalogScmEventContext;
+};
+
+/**
+ * A service that allows publishing and subscribing to source control management
+ * system events.
+ *
+ * @alpha
+ * @remarks
+ *
+ * The default implementation of this service acts in-memory, which requires the
+ * producers and consumer (the catalog backend) to be deployed together.
+ */
+declare const catalogScmEventsServiceRef: _backstage_backend_plugin_api.ServiceRef<CatalogScmEventsService, "plugin", "singleton">;
+
 /** @alpha */
 declare const catalogEntityPermissionResourceRef: _backstage_plugin_permission_node.PermissionResourceRef<Entity, EntitiesSearchFilter, "catalog-entity", "catalog">;
 /**
@@ -45,5 +231,5 @@ type CatalogAnalysisExtensionPoint = CatalogAnalysisExtensionPoint$1;
  */
 declare const catalogAnalysisExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogAnalysisExtensionPoint$1>;
 
-export { catalogAnalysisExtensionPoint, catalogEntityPermissionResourceRef, catalogLocationsExtensionPoint, catalogProcessingExtensionPoint, catalogServiceRef };
-export type { CatalogAnalysisExtensionPoint, CatalogLocationsExtensionPoint, CatalogProcessingExtensionPoint };
+export { catalogAnalysisExtensionPoint, catalogEntityPermissionResourceRef, catalogLocationsExtensionPoint, catalogProcessingExtensionPoint, catalogScmEventsServiceRef, catalogServiceRef };
+export type { CatalogAnalysisExtensionPoint, CatalogLocationsExtensionPoint, CatalogProcessingExtensionPoint, CatalogScmEvent, CatalogScmEventContext, CatalogScmEventsService, CatalogScmEventsServiceSubscriber };

package/dist/catalogService.cjs.js

@@ -67,6 +67,18 @@ class DefaultCatalogService {
       await this.#getOptions(options)
     );
   }
+  async queryLocations(request, options) {
+    return this.#catalogApi.queryLocations(
+      request,
+      await this.#getOptions(options)
+    );
+  }
+  async *streamLocations(request, options) {
+    yield* this.#catalogApi.streamLocations(
+      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  AuthService,\n  BackstageCredentials,\n  coreServices,\n  createServiceFactory,\n  createServiceRef,\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  StreamEntitiesRequest,\n  ValidateEntityResponse,\n} from '@backstage/catalog-client';\nimport { CompoundEntityRef, Entity } from '@backstage/catalog-model';\nimport {\n  AnalyzeLocationRequest,\n  AnalyzeLocationResponse,\n} from '@backstage/plugin-catalog-common';\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  analyzeLocation(\n    location: AnalyzeLocationRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<AnalyzeLocationResponse>;\n\n  streamEntities(\n    request: StreamEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): AsyncIterable<Entity[]>;\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 analyzeLocation(\n    location: AnalyzeLocationRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<AnalyzeLocationResponse> {\n    return this.#catalogApi.analyzeLocation(\n      location,\n      await this.#getOptions(options),\n    );\n  }\n\n  async *streamEntities(\n    request: StreamEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): AsyncIterable<Entity[]> {\n    yield* this.#catalogApi.streamEntities(\n      request,\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":";;;;;AAuJA,MAAM,qBAAA,CAAgD;AAAA,EAC3C,KAAA;AAAA,EACA,WAAA;AAAA,EAET,WAAA,CAAY;AAAA,IACV,UAAA;AAAA,IACA;AAAA,GACF,EAGG;AACD,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AACnB,IAAA,IAAA,CAAK,KAAA,GAAQ,IAAA;AAAA,EACf;AAAA,EAEA,MAAM,WAAA,CACJ,OAAA,EACA,OAAA,EAC8B;AAC9B,IAAA,OAAO,KAAK,WAAA,CAAY,WAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,iBAAA,CACJ,OAAA,EACA,OAAA,EACoC;AACpC,IAAA,OAAO,KAAK,WAAA,CAAY,iBAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,aAAA,CACJ,OAAA,EACA,OAAA,EACgC;AAChC,IAAA,OAAO,KAAK,WAAA,CAAY,aAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,kBAAA,CACJ,OAAA,EACA,OAAA,EACqC;AACrC,IAAA,OAAO,KAAK,WAAA,CAAY,kBAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,cAAA,CACJ,SAAA,EACA,OAAA,EAC6B;AAC7B,IAAA,OAAO,KAAK,WAAA,CAAY,cAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,iBAAA,CACJ,GAAA,EACA,OAAA,EACe;AACf,IAAA,OAAO,KAAK,WAAA,CAAY,iBAAA;AAAA,MACtB,GAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,aAAA,CACJ,SAAA,EACA,OAAA,EACe;AACf,IAAA,OAAO,KAAK,WAAA,CAAY,aAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,eAAA,CACJ,OAAA,EACA,OAAA,EACkC;AAClC,IAAA,OAAO,KAAK,WAAA,CAAY,eAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,YAAA,CACJ,OAAA,EACA,OAAA,EAC+B;AAC/B,IAAA,OAAO,KAAK,WAAA,CAAY,YAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,eAAA,CACJ,EAAA,EACA,OAAA,EAC+B;AAC/B,IAAA,OAAO,KAAK,WAAA,CAAY,eAAA;AAAA,MACtB,EAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,gBAAA,CACJ,WAAA,EACA,OAAA,EAC+B;AAC/B,IAAA,OAAO,KAAK,WAAA,CAAY,gBAAA;AAAA,MACtB,WAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,WAAA,CACJ,QAAA,EACA,OAAA,EAC8B;AAC9B,IAAA,OAAO,KAAK,WAAA,CAAY,WAAA;AAAA,MACtB,QAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,kBAAA,CACJ,EAAA,EACA,OAAA,EACe;AACf,IAAA,OAAO,KAAK,WAAA,CAAY,kBAAA;AAAA,MACtB,EAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,mBAAA,CACJ,SAAA,EACA,OAAA,EAC+B;AAC/B,IAAA,OAAO,KAAK,WAAA,CAAY,mBAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,cAAA,CACJ,MAAA,EACA,WAAA,EACA,OAAA,EACiC;AACjC,IAAA,OAAO,KAAK,WAAA,CAAY,cAAA;AAAA,MACtB,MAAA;AAAA,MACA,WAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,eAAA,CACJ,QAAA,EACA,OAAA,EACkC;AAClC,IAAA,OAAO,KAAK,WAAA,CAAY,eAAA;AAAA,MACtB,QAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,OAAO,cAAA,CACL,OAAA,EACA,OAAA,EACyB;AACzB,IAAA,OAAO,KAAK,WAAA,CAAY,cAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,YACJ,OAAA,EACgC;AAChC,IAAA,OAAO,IAAA,CAAK,MAAM,qBAAA,CAAsB;AAAA,MACtC,YAAY,OAAA,CAAQ,WAAA;AAAA,MACpB,cAAA,EAAgB;AAAA,KACjB,CAAA;AAAA,EACH;AACF;AAOO,MAAM,oBAAoBA,iCAAA,CAAiC;AAAA,EAChE,EAAA,EAAI,gBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAA,CAAqB;AAAA,IACnB,OAAA;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,MAAMC,6BAAA,CAAa,IAAA;AAAA,MACnB,cAAcA,6BAAA,CAAa;AAAA,KAC7B;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,IAAA,EAAM,cAAa,EAAG;AACpC,MAAA,OAAO,IAAI,qBAAA,CAAsB;AAAA,QAC/B,IAAA;AAAA,QACA,UAAA,EAAY,IAAIC,2BAAA,CAAc,EAAE,cAAc;AAAA,OAC/C,CAAA;AAAA,IACH;AAAA,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  AuthService,\n  BackstageCredentials,\n  coreServices,\n  createServiceFactory,\n  createServiceRef,\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  QueryLocationsInitialRequest,\n  QueryLocationsRequest,\n  QueryLocationsResponse,\n  StreamEntitiesRequest,\n  ValidateEntityResponse,\n} from '@backstage/catalog-client';\nimport { CompoundEntityRef, Entity } from '@backstage/catalog-model';\nimport {\n  AnalyzeLocationRequest,\n  AnalyzeLocationResponse,\n} from '@backstage/plugin-catalog-common';\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  queryLocations(\n    request: QueryLocationsRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): Promise<QueryLocationsResponse>;\n\n  streamLocations(\n    request: QueryLocationsInitialRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): AsyncIterable<Location[]>;\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  analyzeLocation(\n    location: AnalyzeLocationRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<AnalyzeLocationResponse>;\n\n  streamEntities(\n    request: StreamEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): AsyncIterable<Entity[]>;\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 queryLocations(\n    request: QueryLocationsRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<QueryLocationsResponse> {\n    return this.#catalogApi.queryLocations(\n      request,\n      await this.#getOptions(options),\n    );\n  }\n\n  async *streamLocations(\n    request: QueryLocationsInitialRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): AsyncIterable<Location[]> {\n    yield* this.#catalogApi.streamLocations(\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 analyzeLocation(\n    location: AnalyzeLocationRequest,\n    options: CatalogServiceRequestOptions,\n  ): Promise<AnalyzeLocationResponse> {\n    return this.#catalogApi.analyzeLocation(\n      location,\n      await this.#getOptions(options),\n    );\n  }\n\n  async *streamEntities(\n    request: StreamEntitiesRequest | undefined,\n    options: CatalogServiceRequestOptions,\n  ): AsyncIterable<Entity[]> {\n    yield* this.#catalogApi.streamEntities(\n      request,\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":";;;;;AAoKA,MAAM,qBAAA,CAAgD;AAAA,EAC3C,KAAA;AAAA,EACA,WAAA;AAAA,EAET,WAAA,CAAY;AAAA,IACV,UAAA;AAAA,IACA;AAAA,GACF,EAGG;AACD,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AACnB,IAAA,IAAA,CAAK,KAAA,GAAQ,IAAA;AAAA,EACf;AAAA,EAEA,MAAM,WAAA,CACJ,OAAA,EACA,OAAA,EAC8B;AAC9B,IAAA,OAAO,KAAK,WAAA,CAAY,WAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,iBAAA,CACJ,OAAA,EACA,OAAA,EACoC;AACpC,IAAA,OAAO,KAAK,WAAA,CAAY,iBAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,aAAA,CACJ,OAAA,EACA,OAAA,EACgC;AAChC,IAAA,OAAO,KAAK,WAAA,CAAY,aAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,kBAAA,CACJ,OAAA,EACA,OAAA,EACqC;AACrC,IAAA,OAAO,KAAK,WAAA,CAAY,kBAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,cAAA,CACJ,SAAA,EACA,OAAA,EAC6B;AAC7B,IAAA,OAAO,KAAK,WAAA,CAAY,cAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,iBAAA,CACJ,GAAA,EACA,OAAA,EACe;AACf,IAAA,OAAO,KAAK,WAAA,CAAY,iBAAA;AAAA,MACtB,GAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,aAAA,CACJ,SAAA,EACA,OAAA,EACe;AACf,IAAA,OAAO,KAAK,WAAA,CAAY,aAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,eAAA,CACJ,OAAA,EACA,OAAA,EACkC;AAClC,IAAA,OAAO,KAAK,WAAA,CAAY,eAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,YAAA,CACJ,OAAA,EACA,OAAA,EAC+B;AAC/B,IAAA,OAAO,KAAK,WAAA,CAAY,YAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,cAAA,CACJ,OAAA,EACA,OAAA,EACiC;AACjC,IAAA,OAAO,KAAK,WAAA,CAAY,cAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,OAAO,eAAA,CACL,OAAA,EACA,OAAA,EAC2B;AAC3B,IAAA,OAAO,KAAK,WAAA,CAAY,eAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,eAAA,CACJ,EAAA,EACA,OAAA,EAC+B;AAC/B,IAAA,OAAO,KAAK,WAAA,CAAY,eAAA;AAAA,MACtB,EAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,gBAAA,CACJ,WAAA,EACA,OAAA,EAC+B;AAC/B,IAAA,OAAO,KAAK,WAAA,CAAY,gBAAA;AAAA,MACtB,WAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,WAAA,CACJ,QAAA,EACA,OAAA,EAC8B;AAC9B,IAAA,OAAO,KAAK,WAAA,CAAY,WAAA;AAAA,MACtB,QAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,kBAAA,CACJ,EAAA,EACA,OAAA,EACe;AACf,IAAA,OAAO,KAAK,WAAA,CAAY,kBAAA;AAAA,MACtB,EAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,mBAAA,CACJ,SAAA,EACA,OAAA,EAC+B;AAC/B,IAAA,OAAO,KAAK,WAAA,CAAY,mBAAA;AAAA,MACtB,SAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,cAAA,CACJ,MAAA,EACA,WAAA,EACA,OAAA,EACiC;AACjC,IAAA,OAAO,KAAK,WAAA,CAAY,cAAA;AAAA,MACtB,MAAA;AAAA,MACA,WAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,eAAA,CACJ,QAAA,EACA,OAAA,EACkC;AAClC,IAAA,OAAO,KAAK,WAAA,CAAY,eAAA;AAAA,MACtB,QAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,OAAO,cAAA,CACL,OAAA,EACA,OAAA,EACyB;AACzB,IAAA,OAAO,KAAK,WAAA,CAAY,cAAA;AAAA,MACtB,OAAA;AAAA,MACA,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,YACJ,OAAA,EACgC;AAChC,IAAA,OAAO,IAAA,CAAK,MAAM,qBAAA,CAAsB;AAAA,MACtC,YAAY,OAAA,CAAQ,WAAA;AAAA,MACpB,cAAA,EAAgB;AAAA,KACjB,CAAA;AAAA,EACH;AACF;AAOO,MAAM,oBAAoBA,iCAAA,CAAiC;AAAA,EAChE,EAAA,EAAI,gBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAA,CAAqB;AAAA,IACnB,OAAA;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,MAAMC,6BAAA,CAAa,IAAA;AAAA,MACnB,cAAcA,6BAAA,CAAa;AAAA,KAC7B;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,IAAA,EAAM,cAAa,EAAG;AACpC,MAAA,OAAO,IAAI,qBAAA,CAAsB;AAAA,QAC/B,IAAA;AAAA,QACA,UAAA,EAAY,IAAIC,2BAAA,CAAc,EAAE,cAAc;AAAA,OAC/C,CAAA;AAAA,IACH;AAAA,GACD;AACL,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, GetLocationsResponse, Location, AddLocationRequest, AddLocationResponse, ValidateEntityResponse, StreamEntitiesRequest } from '@backstage/catalog-client';
+import { GetEntitiesRequest, GetEntitiesResponse, GetEntitiesByRefsRequest, GetEntitiesByRefsResponse, QueryEntitiesRequest, QueryEntitiesResponse, GetEntityAncestorsRequest, GetEntityAncestorsResponse, GetEntityFacetsRequest, GetEntityFacetsResponse, GetLocationsResponse, QueryLocationsRequest, QueryLocationsResponse, QueryLocationsInitialRequest, Location, AddLocationRequest, AddLocationResponse, ValidateEntityResponse, StreamEntitiesRequest } from '@backstage/catalog-client';
 export { b as CatalogAnalysisExtensionPoint, C as CatalogLocationsExtensionPoint, a as CatalogProcessingExtensionPoint, e as catalogAnalysisExtensionPoint, c as catalogLocationsExtensionPoint, d as catalogProcessingExtensionPoint } from './types/extensions.d-Cvnx6_V0.js';
 import '@backstage/plugin-catalog-node';
 import '@backstage/plugin-permission-common';
@@ -435,6 +435,8 @@ interface CatalogService {
     refreshEntity(entityRef: string, options: CatalogServiceRequestOptions): Promise<void>;
     getEntityFacets(request: GetEntityFacetsRequest, options: CatalogServiceRequestOptions): Promise<GetEntityFacetsResponse>;
     getLocations(request: {} | undefined, options: CatalogServiceRequestOptions): Promise<GetLocationsResponse>;
+    queryLocations(request: QueryLocationsRequest | undefined, options: CatalogServiceRequestOptions): Promise<QueryLocationsResponse>;
+    streamLocations(request: QueryLocationsInitialRequest | undefined, options: CatalogServiceRequestOptions): AsyncIterable<Location[]>;
     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/scmEvents/DefaultCatalogScmEventsService.cjs.js

@@ -0,0 +1,40 @@
+'use strict';
+
+class DefaultCatalogScmEventsService {
+  #subscribers;
+  #metrics;
+  constructor(metrics) {
+    this.#subscribers = /* @__PURE__ */ new Set();
+    const meter = metrics.getMeter("default");
+    this.#metrics = {
+      actions: meter.createCounter("catalog.events.scm.actions", {
+        description: "Number of actions taken as a result of SCM event messages",
+        unit: "short"
+      })
+    };
+  }
+  subscribe(subscriber) {
+    this.#subscribers.add(subscriber);
+    return {
+      unsubscribe: () => {
+        this.#subscribers.delete(subscriber);
+      }
+    };
+  }
+  async publish(events) {
+    await Promise.all(
+      Array.from(this.#subscribers).map(async (subscriber) => {
+        try {
+          await subscriber.onEvents(events);
+        } catch (error) {
+        }
+      })
+    );
+  }
+  markEventActionTaken(options) {
+    this.#metrics.actions.add(options.count ?? 1, { action: options.action });
+  }
+}
+
+exports.DefaultCatalogScmEventsService = DefaultCatalogScmEventsService;
+//# sourceMappingURL=DefaultCatalogScmEventsService.cjs.js.map

package/dist/scmEvents/DefaultCatalogScmEventsService.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultCatalogScmEventsService.cjs.js","sources":["../../src/scmEvents/DefaultCatalogScmEventsService.ts"],"sourcesContent":["/*\n * Copyright 2026 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 { Counter, MetricsAPI } from '@opentelemetry/api';\nimport {\n  CatalogScmEvent,\n  CatalogScmEventsService,\n  CatalogScmEventsServiceSubscriber,\n} from './types';\n\n/**\n * The default implementation of the\n * {@link CatalogScmEventsService}/{@link catalogScmEventsServiceRef}.\n *\n * @internal\n * @remarks\n *\n * This implementation is in-memory, which requires the producers and consumer\n * (the catalog backend) to be deployed together.\n *\n * It's defined in here instead of in the catalog-backend plugin because this\n * allows us to have a default factory whether you happen to be co-installed\n * with the catalog-backend plugin or not.\n */\nexport class DefaultCatalogScmEventsService implements CatalogScmEventsService {\n  readonly #subscribers: Set<CatalogScmEventsServiceSubscriber>;\n  readonly #metrics: {\n    actions: Counter<{ action: string }>;\n  };\n\n  constructor(metrics: MetricsAPI) {\n    this.#subscribers = new Set();\n\n    const meter = metrics.getMeter('default');\n    this.#metrics = {\n      actions: meter.createCounter('catalog.events.scm.actions', {\n        description:\n          'Number of actions taken as a result of SCM event messages',\n        unit: 'short',\n      }),\n    };\n  }\n\n  subscribe(subscriber: CatalogScmEventsServiceSubscriber): {\n    unsubscribe: () => void;\n  } {\n    this.#subscribers.add(subscriber);\n    return {\n      unsubscribe: () => {\n        this.#subscribers.delete(subscriber);\n      },\n    };\n  }\n\n  async publish(events: CatalogScmEvent[]): Promise<void> {\n    await Promise.all(\n      Array.from(this.#subscribers).map(async subscriber => {\n        try {\n          await subscriber.onEvents(events);\n        } catch (error) {\n          // The subscribers are expected to handle errors themselves.\n        }\n      }),\n    );\n  }\n\n  markEventActionTaken(options: { count?: number; action: string }): void {\n    this.#metrics.actions.add(options.count ?? 1, { action: options.action });\n  }\n}\n"],"names":[],"mappings":";;AAqCO,MAAM,8BAAA,CAAkE;AAAA,EACpE,YAAA;AAAA,EACA,QAAA;AAAA,EAIT,YAAY,OAAA,EAAqB;AAC/B,IAAA,IAAA,CAAK,YAAA,uBAAmB,GAAA,EAAI;AAE5B,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,QAAA,CAAS,SAAS,CAAA;AACxC,IAAA,IAAA,CAAK,QAAA,GAAW;AAAA,MACd,OAAA,EAAS,KAAA,CAAM,aAAA,CAAc,4BAAA,EAA8B;AAAA,QACzD,WAAA,EACE,2DAAA;AAAA,QACF,IAAA,EAAM;AAAA,OACP;AAAA,KACH;AAAA,EACF;AAAA,EAEA,UAAU,UAAA,EAER;AACA,IAAA,IAAA,CAAK,YAAA,CAAa,IAAI,UAAU,CAAA;AAChC,IAAA,OAAO;AAAA,MACL,aAAa,MAAM;AACjB,QAAA,IAAA,CAAK,YAAA,CAAa,OAAO,UAAU,CAAA;AAAA,MACrC;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,QAAQ,MAAA,EAA0C;AACtD,IAAA,MAAM,OAAA,CAAQ,GAAA;AAAA,MACZ,MAAM,IAAA,CAAK,IAAA,CAAK,YAAY,CAAA,CAAE,GAAA,CAAI,OAAM,UAAA,KAAc;AACpD,QAAA,IAAI;AACF,UAAA,MAAM,UAAA,CAAW,SAAS,MAAM,CAAA;AAAA,QAClC,SAAS,KAAA,EAAO;AAAA,QAEhB;AAAA,MACF,CAAC;AAAA,KACH;AAAA,EACF;AAAA,EAEA,qBAAqB,OAAA,EAAmD;AACtE,IAAA,IAAA,CAAK,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,OAAA,CAAQ,KAAA,IAAS,GAAG,EAAE,MAAA,EAAQ,OAAA,CAAQ,MAAA,EAAQ,CAAA;AAAA,EAC1E;AACF;;;;"}

package/dist/scmEvents/catalogScmEventsServiceRef.cjs.js

@@ -0,0 +1,22 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var api = require('@opentelemetry/api');
+var DefaultCatalogScmEventsService = require('./DefaultCatalogScmEventsService.cjs.js');
+
+const catalogScmEventsServiceRef = backendPluginApi.createServiceRef({
+  id: "catalog.scm-events.alpha",
+  defaultFactory: async (service) => backendPluginApi.createServiceFactory({
+    service,
+    deps: {},
+    createRootContext() {
+      return new DefaultCatalogScmEventsService.DefaultCatalogScmEventsService(api.metrics);
+    },
+    factory(_, ctx) {
+      return ctx;
+    }
+  })
+});
+
+exports.catalogScmEventsServiceRef = catalogScmEventsServiceRef;
+//# sourceMappingURL=catalogScmEventsServiceRef.cjs.js.map

package/dist/scmEvents/catalogScmEventsServiceRef.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalogScmEventsServiceRef.cjs.js","sources":["../../src/scmEvents/catalogScmEventsServiceRef.ts"],"sourcesContent":["/*\n * Copyright 2025 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} from '@backstage/backend-plugin-api';\nimport { metrics } from '@opentelemetry/api';\nimport { CatalogScmEventsService } from './types';\nimport { DefaultCatalogScmEventsService } from './DefaultCatalogScmEventsService';\n\n/**\n * A service that allows publishing and subscribing to source control management\n * system events.\n *\n * @alpha\n * @remarks\n *\n * The default implementation of this service acts in-memory, which requires the\n * producers and consumer (the catalog backend) to be deployed together.\n */\nexport const catalogScmEventsServiceRef =\n  createServiceRef<CatalogScmEventsService>({\n    id: 'catalog.scm-events.alpha',\n    defaultFactory: async service =>\n      createServiceFactory({\n        service,\n        deps: {},\n        createRootContext() {\n          return new DefaultCatalogScmEventsService(metrics);\n        },\n        factory(_, ctx) {\n          return ctx;\n        },\n      }),\n  });\n"],"names":["createServiceRef","createServiceFactory","DefaultCatalogScmEventsService","metrics"],"mappings":";;;;;;AAkCO,MAAM,6BACXA,iCAAA,CAA0C;AAAA,EACxC,EAAA,EAAI,0BAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAA,CAAqB;AAAA,IACnB,OAAA;AAAA,IACA,MAAM,EAAC;AAAA,IACP,iBAAA,GAAoB;AAClB,MAAA,OAAO,IAAIC,8DAA+BC,WAAO,CAAA;AAAA,IACnD,CAAA;AAAA,IACA,OAAA,CAAQ,GAAG,GAAA,EAAK;AACd,MAAA,OAAO,GAAA;AAAA,IACT;AAAA,GACD;AACL,CAAC;;;;"}

package/dist/testUtils/catalogServiceMock.cjs.js

@@ -26,6 +26,8 @@ function catalogServiceMock(options) {
       refreshEntity: jest.fn(),
       getEntityFacets: jest.fn(),
       getLocations: jest.fn(),
+      queryLocations: jest.fn(),
+      streamLocations: 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  createServiceFactory,\n  ServiceFactory,\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';\nimport { createServiceMock } from '@backstage/backend-test-utils';\nimport { CatalogServiceMock } from './types';\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 = createServiceMock<CatalogServiceMock>(\n    catalogServiceRef,\n    () => ({\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      analyzeLocation: jest.fn(),\n      streamEntities: jest.fn(),\n    }),\n  );\n}\n"],"names":["InMemoryCatalogClient","catalogServiceMock","createServiceFactory","catalogServiceRef","createServiceMock"],"mappings":";;;;;;;AAiCO,SAAS,mBAAmB,OAAA,EAEZ;AACrB,EAAA,OAAO,IAAIA,gCAAsB,OAAO,CAAA;AAC1C;AAAA,CAOO,CAAUC,mBAAAA,KAAV;AAME,EAAMA,mBAAAA,CAAA,OAAA,GAAU,CAAC,OAAA,KACtBC,qCAAA,CAAqB;AAAA,IACnB,OAAA,EAASC,mCAAA;AAAA,IACT,MAAM,EAAC;AAAA,IACP,OAAA,EAAS,MAAM,IAAIH,+BAAA,CAAsB,OAAO;AAAA,GACjD,CAAA;AAKI,EAAMC,oBAAA,IAAA,GAAOG,kCAAA;AAAA,IAClBD,mCAAA;AAAA,IACA,OAAO;AAAA,MACL,WAAA,EAAa,KAAK,EAAA,EAAG;AAAA,MACrB,iBAAA,EAAmB,KAAK,EAAA,EAAG;AAAA,MAC3B,aAAA,EAAe,KAAK,EAAA,EAAG;AAAA,MACvB,kBAAA,EAAoB,KAAK,EAAA,EAAG;AAAA,MAC5B,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,MACxB,iBAAA,EAAmB,KAAK,EAAA,EAAG;AAAA,MAC3B,aAAA,EAAe,KAAK,EAAA,EAAG;AAAA,MACvB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,MACzB,YAAA,EAAc,KAAK,EAAA,EAAG;AAAA,MACtB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,MACzB,gBAAA,EAAkB,KAAK,EAAA,EAAG;AAAA,MAC1B,WAAA,EAAa,KAAK,EAAA,EAAG;AAAA,MACrB,kBAAA,EAAoB,KAAK,EAAA,EAAG;AAAA,MAC5B,mBAAA,EAAqB,KAAK,EAAA,EAAG;AAAA,MAC7B,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,MACxB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,MACzB,cAAA,EAAgB,KAAK,EAAA;AAAG,KAC1B;AAAA,GACF;AAAA,CAAA,EArCe,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  createServiceFactory,\n  ServiceFactory,\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';\nimport { createServiceMock } from '@backstage/backend-test-utils';\nimport { CatalogServiceMock } from './types';\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 = createServiceMock<CatalogServiceMock>(\n    catalogServiceRef,\n    () => ({\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      queryLocations: jest.fn(),\n      streamLocations: 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      analyzeLocation: jest.fn(),\n      streamEntities: jest.fn(),\n    }),\n  );\n}\n"],"names":["InMemoryCatalogClient","catalogServiceMock","createServiceFactory","catalogServiceRef","createServiceMock"],"mappings":";;;;;;;AAiCO,SAAS,mBAAmB,OAAA,EAEZ;AACrB,EAAA,OAAO,IAAIA,gCAAsB,OAAO,CAAA;AAC1C;AAAA,CAOO,CAAUC,mBAAAA,KAAV;AAME,EAAMA,mBAAAA,CAAA,OAAA,GAAU,CAAC,OAAA,KACtBC,qCAAA,CAAqB;AAAA,IACnB,OAAA,EAASC,mCAAA;AAAA,IACT,MAAM,EAAC;AAAA,IACP,OAAA,EAAS,MAAM,IAAIH,+BAAA,CAAsB,OAAO;AAAA,GACjD,CAAA;AAKI,EAAMC,oBAAA,IAAA,GAAOG,kCAAA;AAAA,IAClBD,mCAAA;AAAA,IACA,OAAO;AAAA,MACL,WAAA,EAAa,KAAK,EAAA,EAAG;AAAA,MACrB,iBAAA,EAAmB,KAAK,EAAA,EAAG;AAAA,MAC3B,aAAA,EAAe,KAAK,EAAA,EAAG;AAAA,MACvB,kBAAA,EAAoB,KAAK,EAAA,EAAG;AAAA,MAC5B,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,MACxB,iBAAA,EAAmB,KAAK,EAAA,EAAG;AAAA,MAC3B,aAAA,EAAe,KAAK,EAAA,EAAG;AAAA,MACvB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,MACzB,YAAA,EAAc,KAAK,EAAA,EAAG;AAAA,MACtB,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,MACxB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,MACzB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,MACzB,gBAAA,EAAkB,KAAK,EAAA,EAAG;AAAA,MAC1B,WAAA,EAAa,KAAK,EAAA,EAAG;AAAA,MACrB,kBAAA,EAAoB,KAAK,EAAA,EAAG;AAAA,MAC5B,mBAAA,EAAqB,KAAK,EAAA,EAAG;AAAA,MAC7B,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,MACxB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,MACzB,cAAA,EAAgB,KAAK,EAAA;AAAG,KAC1B;AAAA,GACF;AAAA,CAAA,EAvCe,kBAAA,KAAA,kBAAA,GAAA,EAAA,CAAA,CAAA;;;;"}

package/dist/testUtils.d.ts

@@ -1,7 +1,7 @@
 import * as _backstage_backend_test_utils from '@backstage/backend-test-utils';
 import { ServiceFactory } from '@backstage/backend-plugin-api';
 import { CompoundEntityRef, Entity } from '@backstage/catalog-model';
-import { CatalogApi, GetEntitiesRequest, CatalogRequestOptions, GetEntitiesResponse, GetEntitiesByRefsRequest, GetEntitiesByRefsResponse, QueryEntitiesRequest, QueryEntitiesResponse, GetEntityAncestorsRequest, GetEntityAncestorsResponse, GetEntityFacetsRequest, GetEntityFacetsResponse, GetLocationsResponse, Location, AddLocationRequest, AddLocationResponse, ValidateEntityResponse, StreamEntitiesRequest } from '@backstage/catalog-client';
+import { CatalogApi, GetEntitiesRequest, CatalogRequestOptions, GetEntitiesResponse, GetEntitiesByRefsRequest, GetEntitiesByRefsResponse, QueryEntitiesRequest, QueryEntitiesResponse, GetEntityAncestorsRequest, GetEntityAncestorsResponse, GetEntityFacetsRequest, GetEntityFacetsResponse, GetLocationsResponse, QueryLocationsRequest, QueryLocationsResponse, QueryLocationsInitialRequest, Location, AddLocationRequest, AddLocationResponse, ValidateEntityResponse, StreamEntitiesRequest } from '@backstage/catalog-client';
 import { AnalyzeLocationRequest, AnalyzeLocationResponse } from '@backstage/plugin-catalog-common';
 import { CatalogService, CatalogServiceRequestOptions } from '@backstage/plugin-catalog-node';
 
@@ -26,6 +26,8 @@ interface CatalogServiceMock extends CatalogService, CatalogApi {
     refreshEntity(entityRef: string, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<void>;
     getEntityFacets(request: GetEntityFacetsRequest, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<GetEntityFacetsResponse>;
     getLocations(request?: {}, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<GetLocationsResponse>;
+    queryLocations(request?: QueryLocationsRequest, options?: CatalogServiceRequestOptions | CatalogRequestOptions): Promise<QueryLocationsResponse>;
+    streamLocations(request?: QueryLocationsInitialRequest, options?: CatalogServiceRequestOptions | CatalogRequestOptions): AsyncIterable<Location[]>;
     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": "2.0.0-next.1",
+  "version": "2.1.0-next.0",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
   "backstage": {
     "role": "node-library",
@@ -72,28 +72,29 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.7.0-next.1",
-    "@backstage/catalog-client": "1.12.2-next.0",
+    "@backstage/backend-plugin-api": "1.7.1-next.0",
+    "@backstage/catalog-client": "1.13.1-next.0",
     "@backstage/catalog-model": "1.7.6",
     "@backstage/errors": "1.2.7",
-    "@backstage/plugin-catalog-common": "1.1.8-next.0",
-    "@backstage/plugin-permission-common": "0.9.6-next.0",
-    "@backstage/plugin-permission-node": "0.10.10-next.0",
+    "@backstage/plugin-catalog-common": "1.1.8",
+    "@backstage/plugin-permission-common": "0.9.6",
+    "@backstage/plugin-permission-node": "0.10.11-next.0",
     "@backstage/types": "1.2.2",
+    "@opentelemetry/api": "^1.9.0",
     "lodash": "^4.17.21",
     "yaml": "^2.0.0"
   },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "1.11.1-next.0",
+    "@backstage/cli": "0.35.5-next.0",
+    "msw": "^1.0.0"
+  },
   "peerDependencies": {
-    "@backstage/backend-test-utils": "1.11.0-next.1"
+    "@backstage/backend-test-utils": "1.11.1-next.0"
   },
   "peerDependenciesMeta": {
     "@backstage/backend-test-utils": {
       "optional": true
     }
-  },
-  "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.0-next.1",
-    "@backstage/cli": "0.35.4-next.2",
-    "msw": "^1.0.0"
   }
 }