@backstage/plugin-search-backend-module-catalog 0.2.3-next.1 → 0.2.3

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @backstage/plugin-search-backend-module-catalog
 
+## 0.2.3
+
+### Patch Changes
+
+- 4b60e0c: Remove extension points from `/alpha` export, they're available from the main package already
+- 094eaa3: Remove references to in-repo backend-common
+- 3109c24: The export for the new backend system at the `/alpha` export is now also available via the main entry point, which means that you can remove the `/alpha` suffix from the import.
+- 2f88f88: Updated backend installation instructions.
+- Updated dependencies
+  - @backstage/plugin-search-backend-node@1.3.3
+  - @backstage/plugin-catalog-node@1.13.1
+  - @backstage/catalog-client@1.7.1
+  - @backstage/backend-plugin-api@1.0.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/plugin-catalog-common@1.1.0
+  - @backstage/plugin-permission-common@0.8.1
+  - @backstage/plugin-search-common@1.2.14
+
+## 0.2.3-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.13.1-next.1
+  - @backstage/catalog-client@1.7.1-next.0
+  - @backstage/backend-plugin-api@1.0.1-next.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/plugin-catalog-common@1.1.0
+  - @backstage/plugin-permission-common@0.8.1
+  - @backstage/plugin-search-backend-node@1.3.3-next.2
+  - @backstage/plugin-search-common@1.2.14
+
 ## 0.2.3-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-module-catalog__alpha",
-  "version": "0.2.3-next.1",
+  "version": "0.2.3",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -2,62 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var backendPluginApi = require('@backstage/backend-plugin-api');
-var alpha$2 = require('@backstage/plugin-catalog-node/alpha');
-var pluginSearchBackendModuleCatalog = require('@backstage/plugin-search-backend-module-catalog');
-var alpha$1 = require('@backstage/plugin-search-backend-node/alpha');
-var config = require('./cjs/config-BgngnqUm.cjs.js');
-require('@backstage/errors');
+var module$1 = require('./module.cjs.js');
 
-const catalogCollatorExtensionPoint = backendPluginApi.createExtensionPoint({
-  id: "search.catalogCollator.extension"
-});
-var alpha = backendPluginApi.createBackendModule({
-  pluginId: "search",
-  moduleId: "catalog-collator",
-  register(env) {
-    let entityTransformer;
-    env.registerExtensionPoint(catalogCollatorExtensionPoint, {
-      setEntityTransformer(transformer) {
-        if (entityTransformer) {
-          throw new Error("setEntityTransformer can only be called once");
-        }
-        entityTransformer = transformer;
-      }
-    });
-    env.registerInit({
-      deps: {
-        auth: backendPluginApi.coreServices.auth,
-        config: backendPluginApi.coreServices.rootConfig,
-        discovery: backendPluginApi.coreServices.discovery,
-        scheduler: backendPluginApi.coreServices.scheduler,
-        indexRegistry: alpha$1.searchIndexRegistryExtensionPoint,
-        catalog: alpha$2.catalogServiceRef
-      },
-      async init({
-        auth,
-        config: config$1,
-        discovery,
-        scheduler,
-        indexRegistry,
-        catalog
-      }) {
-        indexRegistry.addCollator({
-          schedule: scheduler.createScheduledTaskRunner(
-            config.readScheduleConfigOptions(config$1)
-          ),
-          factory: pluginSearchBackendModuleCatalog.DefaultCatalogCollatorFactory.fromConfig(config$1, {
-            auth,
-            entityTransformer,
-            discovery,
-            catalogClient: catalog
-          })
-        });
-      }
-    });
-  }
-});
+const _feature = module$1.default;
 
-exports.catalogCollatorExtensionPoint = catalogCollatorExtensionPoint;
-exports.default = alpha;
+exports.default = _feature;
 //# sourceMappingURL=alpha.cjs.js.map

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\n/**\n * @packageDocumentation\n * A module for the search backend that exports Catalog modules.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n  createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport {\n  CatalogCollatorEntityTransformer,\n  DefaultCatalogCollatorFactory,\n} from '@backstage/plugin-search-backend-module-catalog';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { readScheduleConfigOptions } from './collators/config';\n\n/**\n * Options for {@link catalogCollatorExtensionPoint}.\n *\n * @alpha\n */\nexport type CatalogCollatorExtensionPoint = {\n  /**\n   * Allows you to customize how entities are shaped into documents.\n   */\n  setEntityTransformer(transformer: CatalogCollatorEntityTransformer): void;\n};\n\n/**\n * Extension point for customizing how catalog entities are shaped into\n * documents for the search backend.\n *\n * @alpha\n */\nexport const catalogCollatorExtensionPoint =\n  createExtensionPoint<CatalogCollatorExtensionPoint>({\n    id: 'search.catalogCollator.extension',\n  });\n\n/**\n * Search backend module for the Catalog index.\n *\n * @alpha\n */\nexport default createBackendModule({\n  pluginId: 'search',\n  moduleId: 'catalog-collator',\n  register(env) {\n    let entityTransformer: CatalogCollatorEntityTransformer | undefined;\n\n    env.registerExtensionPoint(catalogCollatorExtensionPoint, {\n      setEntityTransformer(transformer) {\n        if (entityTransformer) {\n          throw new Error('setEntityTransformer can only be called once');\n        }\n        entityTransformer = transformer;\n      },\n    });\n\n    env.registerInit({\n      deps: {\n        auth: coreServices.auth,\n        config: coreServices.rootConfig,\n        discovery: coreServices.discovery,\n        scheduler: coreServices.scheduler,\n        indexRegistry: searchIndexRegistryExtensionPoint,\n        catalog: catalogServiceRef,\n      },\n      async init({\n        auth,\n        config,\n        discovery,\n        scheduler,\n        indexRegistry,\n        catalog,\n      }) {\n        indexRegistry.addCollator({\n          schedule: scheduler.createScheduledTaskRunner(\n            readScheduleConfigOptions(config),\n          ),\n          factory: DefaultCatalogCollatorFactory.fromConfig(config, {\n            auth,\n            entityTransformer,\n            discovery,\n            catalogClient: catalog,\n          }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","searchIndexRegistryExtensionPoint","catalogServiceRef","config","readScheduleConfigOptions","DefaultCatalogCollatorFactory"],"mappings":";;;;;;;;;;;AAoDO,MAAM,gCACXA,qCAAoD,CAAA;AAAA,EAClD,EAAI,EAAA,kCAAA;AACN,CAAC,EAAA;AAOH,YAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,kBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA,CAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,6BAA+B,EAAA;AAAA,MACxD,qBAAqB,WAAa,EAAA;AAChC,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,8CAA8C,CAAA,CAAA;AAAA,SAChE;AACA,QAAoB,iBAAA,GAAA,WAAA,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAMC,6BAAa,CAAA,IAAA;AAAA,QACnB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,aAAe,EAAAC,yCAAA;AAAA,QACf,OAAS,EAAAC,yBAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,IAAA;AAAA,gBACAC,QAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,OACC,EAAA;AACD,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,UAAU,SAAU,CAAA,yBAAA;AAAA,YAClBC,iCAA0BD,QAAM,CAAA;AAAA,WAClC;AAAA,UACA,OAAA,EAASE,8DAA8B,CAAA,UAAA,CAAWF,QAAQ,EAAA;AAAA,YACxD,IAAA;AAAA,YACA,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,WAChB,CAAA;AAAA,SACF,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.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 { default as feature } from './module';\n\n/** @alpha */\nconst _feature = feature;\nexport default _feature;\n"],"names":["feature"],"mappings":";;;;;;AAmBA,MAAM,QAAW,GAAAA;;;;"}

package/dist/alpha.d.ts

@@ -1,29 +1,6 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { CatalogCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-catalog';
 
-/**
- * Options for {@link catalogCollatorExtensionPoint}.
- *
- * @alpha
- */
-type CatalogCollatorExtensionPoint = {
-    /**
-     * Allows you to customize how entities are shaped into documents.
-     */
-    setEntityTransformer(transformer: CatalogCollatorEntityTransformer): void;
-};
-/**
- * Extension point for customizing how catalog entities are shaped into
- * documents for the search backend.
- *
- * @alpha
- */
-declare const catalogCollatorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogCollatorExtensionPoint>;
-/**
- * Search backend module for the Catalog index.
- *
- * @alpha
- */
-declare const _default: _backstage_backend_plugin_api.BackendFeature;
+/** @alpha */
+declare const _feature: _backstage_backend_plugin_api.BackendFeature;
 
-export { type CatalogCollatorExtensionPoint, catalogCollatorExtensionPoint, _default as default };
+export { _feature as default };

package/dist/collators/DefaultCatalogCollatorFactory.cjs.js

@@ -0,0 +1,100 @@
+'use strict';
+
+var backendCommon = require('@backstage/backend-common');
+var catalogClient = require('@backstage/catalog-client');
+var catalogModel = require('@backstage/catalog-model');
+var alpha = require('@backstage/plugin-catalog-common/alpha');
+var stream = require('stream');
+var config = require('./config.cjs.js');
+var defaultCatalogCollatorEntityTransformer = require('./defaultCatalogCollatorEntityTransformer.cjs.js');
+
+class DefaultCatalogCollatorFactory {
+  type = "software-catalog";
+  visibilityPermission = alpha.catalogEntityReadPermission;
+  locationTemplate;
+  filter;
+  batchSize;
+  catalogClient;
+  entityTransformer;
+  auth;
+  static fromConfig(configRoot, options) {
+    const configOptions = config.readCollatorConfigOptions(configRoot);
+    const { auth: adaptedAuth } = backendCommon.createLegacyAuthAdapters({
+      auth: options.auth,
+      discovery: options.discovery,
+      tokenManager: options.tokenManager
+    });
+    return new DefaultCatalogCollatorFactory({
+      locationTemplate: options.locationTemplate ?? configOptions.locationTemplate,
+      filter: options.filter ?? configOptions.filter,
+      batchSize: options.batchSize ?? configOptions.batchSize,
+      entityTransformer: options.entityTransformer,
+      auth: adaptedAuth,
+      discovery: options.discovery,
+      catalogClient: options.catalogClient
+    });
+  }
+  constructor(options) {
+    const {
+      auth,
+      batchSize,
+      discovery,
+      locationTemplate,
+      filter,
+      catalogClient: catalogClient$1,
+      entityTransformer
+    } = options;
+    this.locationTemplate = locationTemplate;
+    this.filter = filter;
+    this.batchSize = batchSize;
+    this.catalogClient = catalogClient$1 || new catalogClient.CatalogClient({ discoveryApi: discovery });
+    this.entityTransformer = entityTransformer ?? defaultCatalogCollatorEntityTransformer.defaultCatalogCollatorEntityTransformer;
+    this.auth = auth;
+  }
+  async getCollator() {
+    return stream.Readable.from(this.execute());
+  }
+  async *execute() {
+    let entitiesRetrieved = 0;
+    let moreEntitiesToGet = true;
+    while (moreEntitiesToGet) {
+      const { token } = await this.auth.getPluginRequestToken({
+        onBehalfOf: await this.auth.getOwnServiceCredentials(),
+        targetPluginId: "catalog"
+      });
+      const entities = (await this.catalogClient.getEntities(
+        {
+          filter: this.filter,
+          limit: this.batchSize,
+          offset: entitiesRetrieved
+        },
+        { token }
+      )).items;
+      moreEntitiesToGet = entities.length === this.batchSize;
+      entitiesRetrieved += entities.length;
+      for (const entity of entities) {
+        yield {
+          ...this.entityTransformer(entity),
+          authorization: {
+            resourceRef: catalogModel.stringifyEntityRef(entity)
+          },
+          location: this.applyArgsToFormat(this.locationTemplate, {
+            namespace: entity.metadata.namespace || "default",
+            kind: entity.kind,
+            name: entity.metadata.name
+          })
+        };
+      }
+    }
+  }
+  applyArgsToFormat(format, args) {
+    let formatted = format;
+    for (const [key, value] of Object.entries(args)) {
+      formatted = formatted.replace(`:${key}`, value);
+    }
+    return formatted.toLowerCase();
+  }
+}
+
+exports.DefaultCatalogCollatorFactory = DefaultCatalogCollatorFactory;
+//# sourceMappingURL=DefaultCatalogCollatorFactory.cjs.js.map

package/dist/collators/DefaultCatalogCollatorFactory.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultCatalogCollatorFactory.cjs.js","sources":["../../src/collators/DefaultCatalogCollatorFactory.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  TokenManager,\n  createLegacyAuthAdapters,\n} from '@backstage/backend-common';\nimport {\n  CatalogApi,\n  CatalogClient,\n  GetEntitiesRequest,\n} from '@backstage/catalog-client';\nimport { stringifyEntityRef } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { CatalogEntityDocument } from '@backstage/plugin-catalog-common';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { Readable } from 'stream';\nimport { CatalogCollatorEntityTransformer } from './CatalogCollatorEntityTransformer';\nimport { readCollatorConfigOptions } from './config';\nimport { defaultCatalogCollatorEntityTransformer } from './defaultCatalogCollatorEntityTransformer';\nimport { AuthService, DiscoveryService } from '@backstage/backend-plugin-api';\n\n/**\n * @public\n * @deprecated This type is deprecated along with the {@link DefaultCatalogCollatorFactory}.\n */\nexport type DefaultCatalogCollatorFactoryOptions = {\n  auth?: AuthService;\n  discovery: DiscoveryService;\n  tokenManager?: TokenManager;\n  /**\n   * @deprecated Use the config key `search.collators.catalog.locationTemplate` instead.\n   */\n  locationTemplate?: string;\n  /**\n   * @deprecated Use the config key `search.collators.catalog.filter` instead.\n   */\n  filter?: GetEntitiesRequest['filter'];\n  /**\n   * @deprecated Use the config key `search.collators.catalog.batchSize` instead.\n   */\n  batchSize?: number;\n  catalogClient?: CatalogApi;\n  /**\n   * Allows you to customize how entities are shaped into documents.\n   */\n  entityTransformer?: CatalogCollatorEntityTransformer;\n};\n\n/**\n * Collates entities from the Catalog into documents for the search backend.\n *\n * @public\n * @deprecated Migrate to the {@link https://backstage.io/docs/backend-system/building-backends/migrating | new backend system} and install this collator via module instead (see {@link https://github.com/backstage/backstage/blob/nbs10/search-deprecate-create-router/plugins/search-backend-module-catalog/README.md#installation | here} for more installation details).\n */\nexport class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {\n  public readonly type = 'software-catalog';\n  public readonly visibilityPermission: Permission =\n    catalogEntityReadPermission;\n\n  private locationTemplate: string;\n  private filter?: GetEntitiesRequest['filter'];\n  private batchSize: number;\n  private readonly catalogClient: CatalogApi;\n  private entityTransformer: CatalogCollatorEntityTransformer;\n  private auth: AuthService;\n\n  static fromConfig(\n    configRoot: Config,\n    options: DefaultCatalogCollatorFactoryOptions,\n  ) {\n    const configOptions = readCollatorConfigOptions(configRoot);\n    const { auth: adaptedAuth } = createLegacyAuthAdapters({\n      auth: options.auth,\n      discovery: options.discovery,\n      tokenManager: options.tokenManager,\n    });\n    return new DefaultCatalogCollatorFactory({\n      locationTemplate:\n        options.locationTemplate ?? configOptions.locationTemplate,\n      filter: options.filter ?? configOptions.filter,\n      batchSize: options.batchSize ?? configOptions.batchSize,\n      entityTransformer: options.entityTransformer,\n      auth: adaptedAuth,\n      discovery: options.discovery,\n      catalogClient: options.catalogClient,\n    });\n  }\n\n  private constructor(options: {\n    locationTemplate: string;\n    filter: GetEntitiesRequest['filter'];\n    batchSize: number;\n    entityTransformer?: CatalogCollatorEntityTransformer;\n    auth: AuthService;\n    discovery: DiscoveryService;\n    catalogClient?: CatalogApi;\n  }) {\n    const {\n      auth,\n      batchSize,\n      discovery,\n      locationTemplate,\n      filter,\n      catalogClient,\n      entityTransformer,\n    } = options;\n\n    this.locationTemplate = locationTemplate;\n    this.filter = filter;\n    this.batchSize = batchSize;\n    this.catalogClient =\n      catalogClient || new CatalogClient({ discoveryApi: discovery });\n    this.entityTransformer =\n      entityTransformer ?? defaultCatalogCollatorEntityTransformer;\n    this.auth = auth;\n  }\n\n  async getCollator(): Promise<Readable> {\n    return Readable.from(this.execute());\n  }\n\n  private async *execute(): AsyncGenerator<CatalogEntityDocument> {\n    let entitiesRetrieved = 0;\n    let moreEntitiesToGet = true;\n\n    // Offset/limit pagination is used on the Catalog Client in order to\n    // limit (and allow some control over) memory used by the search backend\n    // at index-time.\n    while (moreEntitiesToGet) {\n      const { token } = await this.auth.getPluginRequestToken({\n        onBehalfOf: await this.auth.getOwnServiceCredentials(),\n        targetPluginId: 'catalog',\n      });\n      const entities = (\n        await this.catalogClient.getEntities(\n          {\n            filter: this.filter,\n            limit: this.batchSize,\n            offset: entitiesRetrieved,\n          },\n          { token },\n        )\n      ).items;\n\n      // Control looping through entity batches.\n      moreEntitiesToGet = entities.length === this.batchSize;\n      entitiesRetrieved += entities.length;\n\n      for (const entity of entities) {\n        yield {\n          ...this.entityTransformer(entity),\n          authorization: {\n            resourceRef: stringifyEntityRef(entity),\n          },\n          location: this.applyArgsToFormat(this.locationTemplate, {\n            namespace: entity.metadata.namespace || 'default',\n            kind: entity.kind,\n            name: entity.metadata.name,\n          }),\n        };\n      }\n    }\n  }\n\n  private applyArgsToFormat(\n    format: string,\n    args: Record<string, string>,\n  ): string {\n    let formatted = format;\n\n    for (const [key, value] of Object.entries(args)) {\n      formatted = formatted.replace(`:${key}`, value);\n    }\n\n    return formatted.toLowerCase();\n  }\n}\n"],"names":["catalogEntityReadPermission","readCollatorConfigOptions","createLegacyAuthAdapters","catalogClient","CatalogClient","defaultCatalogCollatorEntityTransformer","Readable","stringifyEntityRef"],"mappings":";;;;;;;;;;AAsEO,MAAM,6BAAiE,CAAA;AAAA,EAC5D,IAAO,GAAA,kBAAA,CAAA;AAAA,EACP,oBACd,GAAAA,iCAAA,CAAA;AAAA,EAEM,gBAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,SAAA,CAAA;AAAA,EACS,aAAA,CAAA;AAAA,EACT,iBAAA,CAAA;AAAA,EACA,IAAA,CAAA;AAAA,EAER,OAAO,UACL,CAAA,UAAA,EACA,OACA,EAAA;AACA,IAAM,MAAA,aAAA,GAAgBC,iCAA0B,UAAU,CAAA,CAAA;AAC1D,IAAA,MAAM,EAAE,IAAA,EAAM,WAAY,EAAA,GAAIC,sCAAyB,CAAA;AAAA,MACrD,MAAM,OAAQ,CAAA,IAAA;AAAA,MACd,WAAW,OAAQ,CAAA,SAAA;AAAA,MACnB,cAAc,OAAQ,CAAA,YAAA;AAAA,KACvB,CAAA,CAAA;AACD,IAAA,OAAO,IAAI,6BAA8B,CAAA;AAAA,MACvC,gBAAA,EACE,OAAQ,CAAA,gBAAA,IAAoB,aAAc,CAAA,gBAAA;AAAA,MAC5C,MAAA,EAAQ,OAAQ,CAAA,MAAA,IAAU,aAAc,CAAA,MAAA;AAAA,MACxC,SAAA,EAAW,OAAQ,CAAA,SAAA,IAAa,aAAc,CAAA,SAAA;AAAA,MAC9C,mBAAmB,OAAQ,CAAA,iBAAA;AAAA,MAC3B,IAAM,EAAA,WAAA;AAAA,MACN,WAAW,OAAQ,CAAA,SAAA;AAAA,MACnB,eAAe,OAAQ,CAAA,aAAA;AAAA,KACxB,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,YAAY,OAQjB,EAAA;AACD,IAAM,MAAA;AAAA,MACJ,IAAA;AAAA,MACA,SAAA;AAAA,MACA,SAAA;AAAA,MACA,gBAAA;AAAA,MACA,MAAA;AAAA,qBACAC,eAAA;AAAA,MACA,iBAAA;AAAA,KACE,GAAA,OAAA,CAAA;AAEJ,IAAA,IAAA,CAAK,gBAAmB,GAAA,gBAAA,CAAA;AACxB,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,SAAY,GAAA,SAAA,CAAA;AACjB,IAAA,IAAA,CAAK,gBACHA,eAAiB,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,WAAW,CAAA,CAAA;AAChE,IAAA,IAAA,CAAK,oBACH,iBAAqB,IAAAC,+EAAA,CAAA;AACvB,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,GACd;AAAA,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAe,OAAiD,GAAA;AAC9D,IAAA,IAAI,iBAAoB,GAAA,CAAA,CAAA;AACxB,IAAA,IAAI,iBAAoB,GAAA,IAAA,CAAA;AAKxB,IAAA,OAAO,iBAAmB,EAAA;AACxB,MAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,QACtD,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,QACrD,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA,CAAA;AACD,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,IAAA,CAAK,aAAc,CAAA,WAAA;AAAA,QACvB;AAAA,UACE,QAAQ,IAAK,CAAA,MAAA;AAAA,UACb,OAAO,IAAK,CAAA,SAAA;AAAA,UACZ,MAAQ,EAAA,iBAAA;AAAA,SACV;AAAA,QACA,EAAE,KAAM,EAAA;AAAA,OAEV,EAAA,KAAA,CAAA;AAGF,MAAoB,iBAAA,GAAA,QAAA,CAAS,WAAW,IAAK,CAAA,SAAA,CAAA;AAC7C,MAAA,iBAAA,IAAqB,QAAS,CAAA,MAAA,CAAA;AAE9B,MAAA,KAAA,MAAW,UAAU,QAAU,EAAA;AAC7B,QAAM,MAAA;AAAA,UACJ,GAAG,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAAA,UAChC,aAAe,EAAA;AAAA,YACb,WAAA,EAAaC,gCAAmB,MAAM,CAAA;AAAA,WACxC;AAAA,UACA,QAAU,EAAA,IAAA,CAAK,iBAAkB,CAAA,IAAA,CAAK,gBAAkB,EAAA;AAAA,YACtD,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,YACxC,MAAM,MAAO,CAAA,IAAA;AAAA,YACb,IAAA,EAAM,OAAO,QAAS,CAAA,IAAA;AAAA,WACvB,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACF;AAAA,GACF;AAAA,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA,CAAA;AAEhB,IAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,IAAI,CAAG,EAAA;AAC/C,MAAA,SAAA,GAAY,SAAU,CAAA,OAAA,CAAQ,CAAI,CAAA,EAAA,GAAG,IAAI,KAAK,CAAA,CAAA;AAAA,KAChD;AAEA,IAAA,OAAO,UAAU,WAAY,EAAA,CAAA;AAAA,GAC/B;AACF;;;;"}

package/dist/{cjs/config-BgngnqUm.cjs.js → collators/config.cjs.js}

@@ -43,6 +43,7 @@ function readCollatorConfigOptions(configRoot) {
   };
 }
 
+exports.defaults = defaults;
 exports.readCollatorConfigOptions = readCollatorConfigOptions;
 exports.readScheduleConfigOptions = readScheduleConfigOptions;
-//# sourceMappingURL=config-BgngnqUm.cjs.js.map
+//# sourceMappingURL=config.cjs.js.map

package/dist/collators/config.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.cjs.js","sources":["../../src/collators/config.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  SchedulerServiceTaskScheduleDefinition,\n  readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport { EntityFilterQuery } from '@backstage/catalog-client';\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\n\nconst configKey = 'search.collators.catalog';\n\nexport const defaults = {\n  schedule: {\n    frequency: { minutes: 10 },\n    timeout: { minutes: 15 },\n    initialDelay: { seconds: 3 },\n  },\n  collatorOptions: {\n    locationTemplate: '/catalog/:namespace/:kind/:name',\n    filter: undefined,\n    batchSize: 500,\n  },\n};\n\nexport function readScheduleConfigOptions(\n  configRoot: Config,\n): SchedulerServiceTaskScheduleDefinition {\n  let schedule: SchedulerServiceTaskScheduleDefinition | undefined = undefined;\n\n  const config = configRoot.getOptionalConfig(configKey);\n  if (config) {\n    const scheduleConfig = config.getOptionalConfig('schedule');\n    if (scheduleConfig) {\n      try {\n        schedule =\n          readSchedulerServiceTaskScheduleDefinitionFromConfig(scheduleConfig);\n      } catch (error) {\n        throw new InputError(`Invalid schedule at ${configKey}, ${error}`);\n      }\n    }\n  }\n\n  return schedule ?? defaults.schedule;\n}\n\nexport function readCollatorConfigOptions(configRoot: Config): {\n  locationTemplate: string;\n  filter: EntityFilterQuery | undefined;\n  batchSize: number;\n} {\n  const config = configRoot.getOptionalConfig(configKey);\n  if (!config) {\n    return defaults.collatorOptions;\n  }\n\n  return {\n    locationTemplate:\n      config.getOptionalString('locationTemplate') ??\n      defaults.collatorOptions.locationTemplate,\n    filter:\n      config.getOptionalConfig('filter')?.get<EntityFilterQuery>() ??\n      defaults.collatorOptions.filter,\n    batchSize:\n      config.getOptionalNumber('batchSize') ??\n      defaults.collatorOptions.batchSize,\n  };\n}\n"],"names":["readSchedulerServiceTaskScheduleDefinitionFromConfig","InputError"],"mappings":";;;;;AAwBA,MAAM,SAAY,GAAA,0BAAA,CAAA;AAEX,MAAM,QAAW,GAAA;AAAA,EACtB,QAAU,EAAA;AAAA,IACR,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,IACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,IACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,GAC7B;AAAA,EACA,eAAiB,EAAA;AAAA,IACf,gBAAkB,EAAA,iCAAA;AAAA,IAClB,MAAQ,EAAA,KAAA,CAAA;AAAA,IACR,SAAW,EAAA,GAAA;AAAA,GACb;AACF,EAAA;AAEO,SAAS,0BACd,UACwC,EAAA;AACxC,EAAA,IAAI,QAA+D,GAAA,KAAA,CAAA,CAAA;AAEnE,EAAM,MAAA,MAAA,GAAS,UAAW,CAAA,iBAAA,CAAkB,SAAS,CAAA,CAAA;AACrD,EAAA,IAAI,MAAQ,EAAA;AACV,IAAM,MAAA,cAAA,GAAiB,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA,CAAA;AAC1D,IAAA,IAAI,cAAgB,EAAA;AAClB,MAAI,IAAA;AACF,QAAA,QAAA,GACEA,sEAAqD,cAAc,CAAA,CAAA;AAAA,eAC9D,KAAO,EAAA;AACd,QAAA,MAAM,IAAIC,iBAAW,CAAA,CAAA,oBAAA,EAAuB,SAAS,CAAA,EAAA,EAAK,KAAK,CAAE,CAAA,CAAA,CAAA;AAAA,OACnE;AAAA,KACF;AAAA,GACF;AAEA,EAAA,OAAO,YAAY,QAAS,CAAA,QAAA,CAAA;AAC9B,CAAA;AAEO,SAAS,0BAA0B,UAIxC,EAAA;AACA,EAAM,MAAA,MAAA,GAAS,UAAW,CAAA,iBAAA,CAAkB,SAAS,CAAA,CAAA;AACrD,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAA,OAAO,QAAS,CAAA,eAAA,CAAA;AAAA,GAClB;AAEA,EAAO,OAAA;AAAA,IACL,kBACE,MAAO,CAAA,iBAAA,CAAkB,kBAAkB,CAAA,IAC3C,SAAS,eAAgB,CAAA,gBAAA;AAAA,IAC3B,MAAA,EACE,OAAO,iBAAkB,CAAA,QAAQ,GAAG,GAAuB,EAAA,IAC3D,SAAS,eAAgB,CAAA,MAAA;AAAA,IAC3B,WACE,MAAO,CAAA,iBAAA,CAAkB,WAAW,CAAA,IACpC,SAAS,eAAgB,CAAA,SAAA;AAAA,GAC7B,CAAA;AACF;;;;;;"}

package/dist/collators/defaultCatalogCollatorEntityTransformer.cjs.js

@@ -0,0 +1,34 @@
+'use strict';
+
+var catalogModel = require('@backstage/catalog-model');
+
+const getDocumentText = (entity) => {
+  const documentTexts = [];
+  documentTexts.push(entity.metadata.description || "");
+  if (catalogModel.isUserEntity(entity) || catalogModel.isGroupEntity(entity)) {
+    if (entity.spec?.profile?.displayName) {
+      documentTexts.push(entity.spec.profile.displayName);
+    }
+  }
+  if (catalogModel.isUserEntity(entity)) {
+    if (entity.spec?.profile?.email) {
+      documentTexts.push(entity.spec.profile.email);
+    }
+  }
+  return documentTexts.join(" : ");
+};
+const defaultCatalogCollatorEntityTransformer = (entity) => {
+  return {
+    title: entity.metadata.title ?? entity.metadata.name,
+    text: getDocumentText(entity),
+    componentType: entity.spec?.type?.toString() || "other",
+    type: entity.spec?.type?.toString() || "other",
+    namespace: entity.metadata.namespace || "default",
+    kind: entity.kind,
+    lifecycle: entity.spec?.lifecycle || "",
+    owner: entity.spec?.owner || ""
+  };
+};
+
+exports.defaultCatalogCollatorEntityTransformer = defaultCatalogCollatorEntityTransformer;
+//# sourceMappingURL=defaultCatalogCollatorEntityTransformer.cjs.js.map

package/dist/collators/defaultCatalogCollatorEntityTransformer.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultCatalogCollatorEntityTransformer.cjs.js","sources":["../../src/collators/defaultCatalogCollatorEntityTransformer.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 { Entity, isGroupEntity, isUserEntity } from '@backstage/catalog-model';\nimport { CatalogCollatorEntityTransformer } from './CatalogCollatorEntityTransformer';\n\nconst getDocumentText = (entity: Entity): string => {\n  const documentTexts: string[] = [];\n  documentTexts.push(entity.metadata.description || '');\n\n  if (isUserEntity(entity) || isGroupEntity(entity)) {\n    if (entity.spec?.profile?.displayName) {\n      documentTexts.push(entity.spec.profile.displayName);\n    }\n  }\n\n  if (isUserEntity(entity)) {\n    if (entity.spec?.profile?.email) {\n      documentTexts.push(entity.spec.profile.email);\n    }\n  }\n\n  return documentTexts.join(' : ');\n};\n\n/** @public */\nexport const defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer =\n  (entity: Entity) => {\n    return {\n      title: entity.metadata.title ?? entity.metadata.name,\n      text: getDocumentText(entity),\n      componentType: entity.spec?.type?.toString() || 'other',\n      type: entity.spec?.type?.toString() || 'other',\n      namespace: entity.metadata.namespace || 'default',\n      kind: entity.kind,\n      lifecycle: (entity.spec?.lifecycle as string) || '',\n      owner: (entity.spec?.owner as string) || '',\n    };\n  };\n"],"names":["isUserEntity","isGroupEntity"],"mappings":";;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAA2B,KAAA;AAClD,EAAA,MAAM,gBAA0B,EAAC,CAAA;AACjC,EAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,WAAA,IAAe,EAAE,CAAA,CAAA;AAEpD,EAAA,IAAIA,yBAAa,CAAA,MAAM,CAAK,IAAAC,0BAAA,CAAc,MAAM,CAAG,EAAA;AACjD,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,WAAa,EAAA;AACrC,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,WAAW,CAAA,CAAA;AAAA,KACpD;AAAA,GACF;AAEA,EAAI,IAAAD,yBAAA,CAAa,MAAM,CAAG,EAAA;AACxB,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,KAAO,EAAA;AAC/B,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,KAC9C;AAAA,GACF;AAEA,EAAO,OAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACjC,CAAA,CAAA;AAGa,MAAA,uCAAA,GACX,CAAC,MAAmB,KAAA;AAClB,EAAO,OAAA;AAAA,IACL,KAAO,EAAA,MAAA,CAAO,QAAS,CAAA,KAAA,IAAS,OAAO,QAAS,CAAA,IAAA;AAAA,IAChD,IAAA,EAAM,gBAAgB,MAAM,CAAA;AAAA,IAC5B,aAAe,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IAChD,IAAM,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IACvC,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,IACxC,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,IACjD,KAAA,EAAQ,MAAO,CAAA,IAAA,EAAM,KAAoB,IAAA,EAAA;AAAA,GAC3C,CAAA;AACF;;;;"}

package/dist/index.cjs.js

@@ -1,130 +1,15 @@
 'use strict';
 
-var backendCommon = require('@backstage/backend-common');
-var catalogClient = require('@backstage/catalog-client');
-var catalogModel = require('@backstage/catalog-model');
-var alpha = require('@backstage/plugin-catalog-common/alpha');
-var stream = require('stream');
-var config = require('./cjs/config-BgngnqUm.cjs.js');
-require('@backstage/backend-plugin-api');
-require('@backstage/errors');
+Object.defineProperty(exports, '__esModule', { value: true });
 
-const getDocumentText = (entity) => {
-  const documentTexts = [];
-  documentTexts.push(entity.metadata.description || "");
-  if (catalogModel.isUserEntity(entity) || catalogModel.isGroupEntity(entity)) {
-    if (entity.spec?.profile?.displayName) {
-      documentTexts.push(entity.spec.profile.displayName);
-    }
-  }
-  if (catalogModel.isUserEntity(entity)) {
-    if (entity.spec?.profile?.email) {
-      documentTexts.push(entity.spec.profile.email);
-    }
-  }
-  return documentTexts.join(" : ");
-};
-const defaultCatalogCollatorEntityTransformer = (entity) => {
-  return {
-    title: entity.metadata.title ?? entity.metadata.name,
-    text: getDocumentText(entity),
-    componentType: entity.spec?.type?.toString() || "other",
-    type: entity.spec?.type?.toString() || "other",
-    namespace: entity.metadata.namespace || "default",
-    kind: entity.kind,
-    lifecycle: entity.spec?.lifecycle || "",
-    owner: entity.spec?.owner || ""
-  };
-};
+var module$1 = require('./module.cjs.js');
+var DefaultCatalogCollatorFactory = require('./collators/DefaultCatalogCollatorFactory.cjs.js');
+var defaultCatalogCollatorEntityTransformer = require('./collators/defaultCatalogCollatorEntityTransformer.cjs.js');
 
-class DefaultCatalogCollatorFactory {
-  type = "software-catalog";
-  visibilityPermission = alpha.catalogEntityReadPermission;
-  locationTemplate;
-  filter;
-  batchSize;
-  catalogClient;
-  entityTransformer;
-  auth;
-  static fromConfig(configRoot, options) {
-    const configOptions = config.readCollatorConfigOptions(configRoot);
-    const { auth: adaptedAuth } = backendCommon.createLegacyAuthAdapters({
-      auth: options.auth,
-      discovery: options.discovery,
-      tokenManager: options.tokenManager
-    });
-    return new DefaultCatalogCollatorFactory({
-      locationTemplate: options.locationTemplate ?? configOptions.locationTemplate,
-      filter: options.filter ?? configOptions.filter,
-      batchSize: options.batchSize ?? configOptions.batchSize,
-      entityTransformer: options.entityTransformer,
-      auth: adaptedAuth,
-      discovery: options.discovery,
-      catalogClient: options.catalogClient
-    });
-  }
-  constructor(options) {
-    const {
-      auth,
-      batchSize,
-      discovery,
-      locationTemplate,
-      filter,
-      catalogClient: catalogClient$1,
-      entityTransformer
-    } = options;
-    this.locationTemplate = locationTemplate;
-    this.filter = filter;
-    this.batchSize = batchSize;
-    this.catalogClient = catalogClient$1 || new catalogClient.CatalogClient({ discoveryApi: discovery });
-    this.entityTransformer = entityTransformer ?? defaultCatalogCollatorEntityTransformer;
-    this.auth = auth;
-  }
-  async getCollator() {
-    return stream.Readable.from(this.execute());
-  }
-  async *execute() {
-    let entitiesRetrieved = 0;
-    let moreEntitiesToGet = true;
-    while (moreEntitiesToGet) {
-      const { token } = await this.auth.getPluginRequestToken({
-        onBehalfOf: await this.auth.getOwnServiceCredentials(),
-        targetPluginId: "catalog"
-      });
-      const entities = (await this.catalogClient.getEntities(
-        {
-          filter: this.filter,
-          limit: this.batchSize,
-          offset: entitiesRetrieved
-        },
-        { token }
-      )).items;
-      moreEntitiesToGet = entities.length === this.batchSize;
-      entitiesRetrieved += entities.length;
-      for (const entity of entities) {
-        yield {
-          ...this.entityTransformer(entity),
-          authorization: {
-            resourceRef: catalogModel.stringifyEntityRef(entity)
-          },
-          location: this.applyArgsToFormat(this.locationTemplate, {
-            namespace: entity.metadata.namespace || "default",
-            kind: entity.kind,
-            name: entity.metadata.name
-          })
-        };
-      }
-    }
-  }
-  applyArgsToFormat(format, args) {
-    let formatted = format;
-    for (const [key, value] of Object.entries(args)) {
-      formatted = formatted.replace(`:${key}`, value);
-    }
-    return formatted.toLowerCase();
-  }
-}
 
-exports.DefaultCatalogCollatorFactory = DefaultCatalogCollatorFactory;
-exports.defaultCatalogCollatorEntityTransformer = defaultCatalogCollatorEntityTransformer;
+
+exports.catalogCollatorExtensionPoint = module$1.catalogCollatorExtensionPoint;
+exports.default = module$1.default;
+exports.DefaultCatalogCollatorFactory = DefaultCatalogCollatorFactory.DefaultCatalogCollatorFactory;
+exports.defaultCatalogCollatorEntityTransformer = defaultCatalogCollatorEntityTransformer.defaultCatalogCollatorEntityTransformer;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/collators/defaultCatalogCollatorEntityTransformer.ts","../src/collators/DefaultCatalogCollatorFactory.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 { Entity, isGroupEntity, isUserEntity } from '@backstage/catalog-model';\nimport { CatalogCollatorEntityTransformer } from './CatalogCollatorEntityTransformer';\n\nconst getDocumentText = (entity: Entity): string => {\n  const documentTexts: string[] = [];\n  documentTexts.push(entity.metadata.description || '');\n\n  if (isUserEntity(entity) || isGroupEntity(entity)) {\n    if (entity.spec?.profile?.displayName) {\n      documentTexts.push(entity.spec.profile.displayName);\n    }\n  }\n\n  if (isUserEntity(entity)) {\n    if (entity.spec?.profile?.email) {\n      documentTexts.push(entity.spec.profile.email);\n    }\n  }\n\n  return documentTexts.join(' : ');\n};\n\n/** @public */\nexport const defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer =\n  (entity: Entity) => {\n    return {\n      title: entity.metadata.title ?? entity.metadata.name,\n      text: getDocumentText(entity),\n      componentType: entity.spec?.type?.toString() || 'other',\n      type: entity.spec?.type?.toString() || 'other',\n      namespace: entity.metadata.namespace || 'default',\n      kind: entity.kind,\n      lifecycle: (entity.spec?.lifecycle as string) || '',\n      owner: (entity.spec?.owner as string) || '',\n    };\n  };\n","/*\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  TokenManager,\n  createLegacyAuthAdapters,\n} from '@backstage/backend-common';\nimport {\n  CatalogApi,\n  CatalogClient,\n  GetEntitiesRequest,\n} from '@backstage/catalog-client';\nimport { stringifyEntityRef } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { CatalogEntityDocument } from '@backstage/plugin-catalog-common';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { Readable } from 'stream';\nimport { CatalogCollatorEntityTransformer } from './CatalogCollatorEntityTransformer';\nimport { readCollatorConfigOptions } from './config';\nimport { defaultCatalogCollatorEntityTransformer } from './defaultCatalogCollatorEntityTransformer';\nimport { AuthService, DiscoveryService } from '@backstage/backend-plugin-api';\n\n/**\n * @public\n * @deprecated This type is deprecated along with the {@link DefaultCatalogCollatorFactory}.\n */\nexport type DefaultCatalogCollatorFactoryOptions = {\n  auth?: AuthService;\n  discovery: DiscoveryService;\n  tokenManager?: TokenManager;\n  /**\n   * @deprecated Use the config key `search.collators.catalog.locationTemplate` instead.\n   */\n  locationTemplate?: string;\n  /**\n   * @deprecated Use the config key `search.collators.catalog.filter` instead.\n   */\n  filter?: GetEntitiesRequest['filter'];\n  /**\n   * @deprecated Use the config key `search.collators.catalog.batchSize` instead.\n   */\n  batchSize?: number;\n  catalogClient?: CatalogApi;\n  /**\n   * Allows you to customize how entities are shaped into documents.\n   */\n  entityTransformer?: CatalogCollatorEntityTransformer;\n};\n\n/**\n * Collates entities from the Catalog into documents for the search backend.\n *\n * @public\n * @deprecated Migrate to the {@link https://backstage.io/docs/backend-system/building-backends/migrating | new backend system} and install this collator via module instead (see {@link https://github.com/backstage/backstage/blob/nbs10/search-deprecate-create-router/plugins/search-backend-module-catalog/README.md#installation | here} for more installation details).\n */\nexport class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {\n  public readonly type = 'software-catalog';\n  public readonly visibilityPermission: Permission =\n    catalogEntityReadPermission;\n\n  private locationTemplate: string;\n  private filter?: GetEntitiesRequest['filter'];\n  private batchSize: number;\n  private readonly catalogClient: CatalogApi;\n  private entityTransformer: CatalogCollatorEntityTransformer;\n  private auth: AuthService;\n\n  static fromConfig(\n    configRoot: Config,\n    options: DefaultCatalogCollatorFactoryOptions,\n  ) {\n    const configOptions = readCollatorConfigOptions(configRoot);\n    const { auth: adaptedAuth } = createLegacyAuthAdapters({\n      auth: options.auth,\n      discovery: options.discovery,\n      tokenManager: options.tokenManager,\n    });\n    return new DefaultCatalogCollatorFactory({\n      locationTemplate:\n        options.locationTemplate ?? configOptions.locationTemplate,\n      filter: options.filter ?? configOptions.filter,\n      batchSize: options.batchSize ?? configOptions.batchSize,\n      entityTransformer: options.entityTransformer,\n      auth: adaptedAuth,\n      discovery: options.discovery,\n      catalogClient: options.catalogClient,\n    });\n  }\n\n  private constructor(options: {\n    locationTemplate: string;\n    filter: GetEntitiesRequest['filter'];\n    batchSize: number;\n    entityTransformer?: CatalogCollatorEntityTransformer;\n    auth: AuthService;\n    discovery: DiscoveryService;\n    catalogClient?: CatalogApi;\n  }) {\n    const {\n      auth,\n      batchSize,\n      discovery,\n      locationTemplate,\n      filter,\n      catalogClient,\n      entityTransformer,\n    } = options;\n\n    this.locationTemplate = locationTemplate;\n    this.filter = filter;\n    this.batchSize = batchSize;\n    this.catalogClient =\n      catalogClient || new CatalogClient({ discoveryApi: discovery });\n    this.entityTransformer =\n      entityTransformer ?? defaultCatalogCollatorEntityTransformer;\n    this.auth = auth;\n  }\n\n  async getCollator(): Promise<Readable> {\n    return Readable.from(this.execute());\n  }\n\n  private async *execute(): AsyncGenerator<CatalogEntityDocument> {\n    let entitiesRetrieved = 0;\n    let moreEntitiesToGet = true;\n\n    // Offset/limit pagination is used on the Catalog Client in order to\n    // limit (and allow some control over) memory used by the search backend\n    // at index-time.\n    while (moreEntitiesToGet) {\n      const { token } = await this.auth.getPluginRequestToken({\n        onBehalfOf: await this.auth.getOwnServiceCredentials(),\n        targetPluginId: 'catalog',\n      });\n      const entities = (\n        await this.catalogClient.getEntities(\n          {\n            filter: this.filter,\n            limit: this.batchSize,\n            offset: entitiesRetrieved,\n          },\n          { token },\n        )\n      ).items;\n\n      // Control looping through entity batches.\n      moreEntitiesToGet = entities.length === this.batchSize;\n      entitiesRetrieved += entities.length;\n\n      for (const entity of entities) {\n        yield {\n          ...this.entityTransformer(entity),\n          authorization: {\n            resourceRef: stringifyEntityRef(entity),\n          },\n          location: this.applyArgsToFormat(this.locationTemplate, {\n            namespace: entity.metadata.namespace || 'default',\n            kind: entity.kind,\n            name: entity.metadata.name,\n          }),\n        };\n      }\n    }\n  }\n\n  private applyArgsToFormat(\n    format: string,\n    args: Record<string, string>,\n  ): string {\n    let formatted = format;\n\n    for (const [key, value] of Object.entries(args)) {\n      formatted = formatted.replace(`:${key}`, value);\n    }\n\n    return formatted.toLowerCase();\n  }\n}\n"],"names":["isUserEntity","isGroupEntity","catalogEntityReadPermission","readCollatorConfigOptions","createLegacyAuthAdapters","catalogClient","CatalogClient","Readable","stringifyEntityRef"],"mappings":";;;;;;;;;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAA2B,KAAA;AAClD,EAAA,MAAM,gBAA0B,EAAC,CAAA;AACjC,EAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,WAAA,IAAe,EAAE,CAAA,CAAA;AAEpD,EAAA,IAAIA,yBAAa,CAAA,MAAM,CAAK,IAAAC,0BAAA,CAAc,MAAM,CAAG,EAAA;AACjD,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,WAAa,EAAA;AACrC,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,WAAW,CAAA,CAAA;AAAA,KACpD;AAAA,GACF;AAEA,EAAI,IAAAD,yBAAA,CAAa,MAAM,CAAG,EAAA;AACxB,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,KAAO,EAAA;AAC/B,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,KAC9C;AAAA,GACF;AAEA,EAAO,OAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACjC,CAAA,CAAA;AAGa,MAAA,uCAAA,GACX,CAAC,MAAmB,KAAA;AAClB,EAAO,OAAA;AAAA,IACL,KAAO,EAAA,MAAA,CAAO,QAAS,CAAA,KAAA,IAAS,OAAO,QAAS,CAAA,IAAA;AAAA,IAChD,IAAA,EAAM,gBAAgB,MAAM,CAAA;AAAA,IAC5B,aAAe,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IAChD,IAAM,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IACvC,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,IACxC,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,IACjD,KAAA,EAAQ,MAAO,CAAA,IAAA,EAAM,KAAoB,IAAA,EAAA;AAAA,GAC3C,CAAA;AACF;;ACmBK,MAAM,6BAAiE,CAAA;AAAA,EAC5D,IAAO,GAAA,kBAAA,CAAA;AAAA,EACP,oBACd,GAAAE,iCAAA,CAAA;AAAA,EAEM,gBAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,SAAA,CAAA;AAAA,EACS,aAAA,CAAA;AAAA,EACT,iBAAA,CAAA;AAAA,EACA,IAAA,CAAA;AAAA,EAER,OAAO,UACL,CAAA,UAAA,EACA,OACA,EAAA;AACA,IAAM,MAAA,aAAA,GAAgBC,iCAA0B,UAAU,CAAA,CAAA;AAC1D,IAAA,MAAM,EAAE,IAAA,EAAM,WAAY,EAAA,GAAIC,sCAAyB,CAAA;AAAA,MACrD,MAAM,OAAQ,CAAA,IAAA;AAAA,MACd,WAAW,OAAQ,CAAA,SAAA;AAAA,MACnB,cAAc,OAAQ,CAAA,YAAA;AAAA,KACvB,CAAA,CAAA;AACD,IAAA,OAAO,IAAI,6BAA8B,CAAA;AAAA,MACvC,gBAAA,EACE,OAAQ,CAAA,gBAAA,IAAoB,aAAc,CAAA,gBAAA;AAAA,MAC5C,MAAA,EAAQ,OAAQ,CAAA,MAAA,IAAU,aAAc,CAAA,MAAA;AAAA,MACxC,SAAA,EAAW,OAAQ,CAAA,SAAA,IAAa,aAAc,CAAA,SAAA;AAAA,MAC9C,mBAAmB,OAAQ,CAAA,iBAAA;AAAA,MAC3B,IAAM,EAAA,WAAA;AAAA,MACN,WAAW,OAAQ,CAAA,SAAA;AAAA,MACnB,eAAe,OAAQ,CAAA,aAAA;AAAA,KACxB,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,YAAY,OAQjB,EAAA;AACD,IAAM,MAAA;AAAA,MACJ,IAAA;AAAA,MACA,SAAA;AAAA,MACA,SAAA;AAAA,MACA,gBAAA;AAAA,MACA,MAAA;AAAA,qBACAC,eAAA;AAAA,MACA,iBAAA;AAAA,KACE,GAAA,OAAA,CAAA;AAEJ,IAAA,IAAA,CAAK,gBAAmB,GAAA,gBAAA,CAAA;AACxB,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,SAAY,GAAA,SAAA,CAAA;AACjB,IAAA,IAAA,CAAK,gBACHA,eAAiB,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,WAAW,CAAA,CAAA;AAChE,IAAA,IAAA,CAAK,oBACH,iBAAqB,IAAA,uCAAA,CAAA;AACvB,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,GACd;AAAA,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAe,OAAiD,GAAA;AAC9D,IAAA,IAAI,iBAAoB,GAAA,CAAA,CAAA;AACxB,IAAA,IAAI,iBAAoB,GAAA,IAAA,CAAA;AAKxB,IAAA,OAAO,iBAAmB,EAAA;AACxB,MAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,QACtD,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,QACrD,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA,CAAA;AACD,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,IAAA,CAAK,aAAc,CAAA,WAAA;AAAA,QACvB;AAAA,UACE,QAAQ,IAAK,CAAA,MAAA;AAAA,UACb,OAAO,IAAK,CAAA,SAAA;AAAA,UACZ,MAAQ,EAAA,iBAAA;AAAA,SACV;AAAA,QACA,EAAE,KAAM,EAAA;AAAA,OAEV,EAAA,KAAA,CAAA;AAGF,MAAoB,iBAAA,GAAA,QAAA,CAAS,WAAW,IAAK,CAAA,SAAA,CAAA;AAC7C,MAAA,iBAAA,IAAqB,QAAS,CAAA,MAAA,CAAA;AAE9B,MAAA,KAAA,MAAW,UAAU,QAAU,EAAA;AAC7B,QAAM,MAAA;AAAA,UACJ,GAAG,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAAA,UAChC,aAAe,EAAA;AAAA,YACb,WAAA,EAAaC,gCAAmB,MAAM,CAAA;AAAA,WACxC;AAAA,UACA,QAAU,EAAA,IAAA,CAAK,iBAAkB,CAAA,IAAA,CAAK,gBAAkB,EAAA;AAAA,YACtD,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,YACxC,MAAM,MAAO,CAAA,IAAA;AAAA,YACb,IAAA,EAAM,OAAO,QAAS,CAAA,IAAA;AAAA,WACvB,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACF;AAAA,GACF;AAAA,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA,CAAA;AAEhB,IAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,IAAI,CAAG,EAAA;AAC/C,MAAA,SAAA,GAAY,SAAU,CAAA,OAAA,CAAQ,CAAI,CAAA,EAAA,GAAG,IAAI,KAAK,CAAA,CAAA;AAAA,KAChD;AAEA,IAAA,OAAO,UAAU,WAAY,EAAA,CAAA;AAAA,GAC/B;AACF;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="node" />
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { AuthService, DiscoveryService } from '@backstage/backend-plugin-api';
+import { CatalogCollatorEntityTransformer as CatalogCollatorEntityTransformer$1 } from '@backstage/plugin-search-backend-module-catalog';
 import { TokenManager } from '@backstage/backend-common';
 import { GetEntitiesRequest, CatalogApi } from '@backstage/catalog-client';
 import { Config } from '@backstage/config';
@@ -7,7 +10,31 @@ import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
 import { Readable } from 'stream';
 import { Entity } from '@backstage/catalog-model';
 import { CatalogEntityDocument } from '@backstage/plugin-catalog-common';
-import { AuthService, DiscoveryService } from '@backstage/backend-plugin-api';
+
+/**
+ * Options for {@link catalogCollatorExtensionPoint}.
+ *
+ * @public
+ */
+type CatalogCollatorExtensionPoint = {
+    /**
+     * Allows you to customize how entities are shaped into documents.
+     */
+    setEntityTransformer(transformer: CatalogCollatorEntityTransformer$1): void;
+};
+/**
+ * Extension point for customizing how catalog entities are shaped into
+ * documents for the search backend.
+ *
+ * @public
+ */
+declare const catalogCollatorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogCollatorExtensionPoint>;
+/**
+ * Search backend module for the Catalog index.
+ *
+ * @public
+ */
+declare const _default: _backstage_backend_plugin_api.BackendFeature;
 
 /** @public */
 type CatalogCollatorEntityTransformer = (entity: Entity) => Omit<CatalogEntityDocument, 'location' | 'authorization'>;
@@ -63,4 +90,4 @@ declare class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
 /** @public */
 declare const defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer;
 
-export { type CatalogCollatorEntityTransformer, DefaultCatalogCollatorFactory, type DefaultCatalogCollatorFactoryOptions, defaultCatalogCollatorEntityTransformer };
+export { type CatalogCollatorEntityTransformer, type CatalogCollatorExtensionPoint, DefaultCatalogCollatorFactory, type DefaultCatalogCollatorFactoryOptions, catalogCollatorExtensionPoint, _default as default, defaultCatalogCollatorEntityTransformer };

package/dist/module.cjs.js

@@ -0,0 +1,62 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
+var pluginSearchBackendModuleCatalog = require('@backstage/plugin-search-backend-module-catalog');
+var alpha = require('@backstage/plugin-search-backend-node/alpha');
+var config = require('./collators/config.cjs.js');
+
+const catalogCollatorExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "search.catalogCollator.extension"
+});
+var feature = backendPluginApi.createBackendModule({
+  pluginId: "search",
+  moduleId: "catalog-collator",
+  register(env) {
+    let entityTransformer;
+    env.registerExtensionPoint(catalogCollatorExtensionPoint, {
+      setEntityTransformer(transformer) {
+        if (entityTransformer) {
+          throw new Error("setEntityTransformer can only be called once");
+        }
+        entityTransformer = transformer;
+      }
+    });
+    env.registerInit({
+      deps: {
+        auth: backendPluginApi.coreServices.auth,
+        config: backendPluginApi.coreServices.rootConfig,
+        discovery: backendPluginApi.coreServices.discovery,
+        scheduler: backendPluginApi.coreServices.scheduler,
+        indexRegistry: alpha.searchIndexRegistryExtensionPoint,
+        catalog: alpha$1.catalogServiceRef
+      },
+      async init({
+        auth,
+        config: config$1,
+        discovery,
+        scheduler,
+        indexRegistry,
+        catalog
+      }) {
+        indexRegistry.addCollator({
+          schedule: scheduler.createScheduledTaskRunner(
+            config.readScheduleConfigOptions(config$1)
+          ),
+          factory: pluginSearchBackendModuleCatalog.DefaultCatalogCollatorFactory.fromConfig(config$1, {
+            auth,
+            entityTransformer,
+            discovery,
+            catalogClient: catalog
+          })
+        });
+      }
+    });
+  }
+});
+
+exports.catalogCollatorExtensionPoint = catalogCollatorExtensionPoint;
+exports.default = feature;
+//# sourceMappingURL=module.cjs.js.map

package/dist/module.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * @packageDocumentation\n * A module for the search backend that exports Catalog modules.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n  createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport {\n  CatalogCollatorEntityTransformer,\n  DefaultCatalogCollatorFactory,\n} from '@backstage/plugin-search-backend-module-catalog';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { readScheduleConfigOptions } from './collators/config';\n\n/**\n * Options for {@link catalogCollatorExtensionPoint}.\n *\n * @public\n */\nexport type CatalogCollatorExtensionPoint = {\n  /**\n   * Allows you to customize how entities are shaped into documents.\n   */\n  setEntityTransformer(transformer: CatalogCollatorEntityTransformer): void;\n};\n\n/**\n * Extension point for customizing how catalog entities are shaped into\n * documents for the search backend.\n *\n * @public\n */\nexport const catalogCollatorExtensionPoint =\n  createExtensionPoint<CatalogCollatorExtensionPoint>({\n    id: 'search.catalogCollator.extension',\n  });\n\n/**\n * Search backend module for the Catalog index.\n *\n * @public\n */\nexport default createBackendModule({\n  pluginId: 'search',\n  moduleId: 'catalog-collator',\n  register(env) {\n    let entityTransformer: CatalogCollatorEntityTransformer | undefined;\n\n    env.registerExtensionPoint(catalogCollatorExtensionPoint, {\n      setEntityTransformer(transformer) {\n        if (entityTransformer) {\n          throw new Error('setEntityTransformer can only be called once');\n        }\n        entityTransformer = transformer;\n      },\n    });\n\n    env.registerInit({\n      deps: {\n        auth: coreServices.auth,\n        config: coreServices.rootConfig,\n        discovery: coreServices.discovery,\n        scheduler: coreServices.scheduler,\n        indexRegistry: searchIndexRegistryExtensionPoint,\n        catalog: catalogServiceRef,\n      },\n      async init({\n        auth,\n        config,\n        discovery,\n        scheduler,\n        indexRegistry,\n        catalog,\n      }) {\n        indexRegistry.addCollator({\n          schedule: scheduler.createScheduledTaskRunner(\n            readScheduleConfigOptions(config),\n          ),\n          factory: DefaultCatalogCollatorFactory.fromConfig(config, {\n            auth,\n            entityTransformer,\n            discovery,\n            catalogClient: catalog,\n          }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","searchIndexRegistryExtensionPoint","catalogServiceRef","config","readScheduleConfigOptions","DefaultCatalogCollatorFactory"],"mappings":";;;;;;;;;;AAoDO,MAAM,gCACXA,qCAAoD,CAAA;AAAA,EAClD,EAAI,EAAA,kCAAA;AACN,CAAC,EAAA;AAOH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,kBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA,CAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,6BAA+B,EAAA;AAAA,MACxD,qBAAqB,WAAa,EAAA;AAChC,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,8CAA8C,CAAA,CAAA;AAAA,SAChE;AACA,QAAoB,iBAAA,GAAA,WAAA,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAMC,6BAAa,CAAA,IAAA;AAAA,QACnB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,aAAe,EAAAC,uCAAA;AAAA,QACf,OAAS,EAAAC,yBAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,IAAA;AAAA,gBACAC,QAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,OACC,EAAA;AACD,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,UAAU,SAAU,CAAA,yBAAA;AAAA,YAClBC,iCAA0BD,QAAM,CAAA;AAAA,WAClC;AAAA,UACA,OAAA,EAASE,8DAA8B,CAAA,UAAA,CAAWF,QAAQ,EAAA;AAAA,YACxD,IAAA;AAAA,YACA,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,WAChB,CAAA;AAAA,SACF,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-module-catalog",
-  "version": "0.2.3-next.1",
+  "version": "0.2.3",
   "description": "A module for the search backend that exports catalog modules",
   "backstage": {
     "role": "backend-plugin-module",
@@ -19,6 +19,7 @@
   "license": "Apache-2.0",
   "exports": {
     ".": {
+      "backstage": "@backstage/BackendFeature",
       "require": "./dist/index.cjs.js",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.cjs.js"
@@ -49,21 +50,21 @@
   },
   "dependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-plugin-api": "1.0.1-next.0",
-    "@backstage/catalog-client": "1.7.0",
-    "@backstage/catalog-model": "1.7.0",
-    "@backstage/config": "1.2.0",
-    "@backstage/errors": "1.2.4",
-    "@backstage/plugin-catalog-common": "1.1.0",
-    "@backstage/plugin-catalog-node": "1.13.1-next.0",
-    "@backstage/plugin-permission-common": "0.8.1",
-    "@backstage/plugin-search-backend-node": "1.3.3-next.1",
-    "@backstage/plugin-search-common": "1.2.14"
+    "@backstage/backend-plugin-api": "^1.0.1",
+    "@backstage/catalog-client": "^1.7.1",
+    "@backstage/catalog-model": "^1.7.0",
+    "@backstage/config": "^1.2.0",
+    "@backstage/errors": "^1.2.4",
+    "@backstage/plugin-catalog-common": "^1.1.0",
+    "@backstage/plugin-catalog-node": "^1.13.1",
+    "@backstage/plugin-permission-common": "^0.8.1",
+    "@backstage/plugin-search-backend-node": "^1.3.3",
+    "@backstage/plugin-search-common": "^1.2.14"
   },
   "devDependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-test-utils": "1.0.1-next.1",
-    "@backstage/cli": "0.28.0-next.1",
+    "@backstage/backend-test-utils": "^1.0.1",
+    "@backstage/cli": "^0.28.0",
     "msw": "^1.0.0"
   },
   "configSchema": "config.d.ts"

package/dist/cjs/config-BgngnqUm.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"config-BgngnqUm.cjs.js","sources":["../../src/collators/config.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  SchedulerServiceTaskScheduleDefinition,\n  readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport { EntityFilterQuery } from '@backstage/catalog-client';\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\n\nconst configKey = 'search.collators.catalog';\n\nexport const defaults = {\n  schedule: {\n    frequency: { minutes: 10 },\n    timeout: { minutes: 15 },\n    initialDelay: { seconds: 3 },\n  },\n  collatorOptions: {\n    locationTemplate: '/catalog/:namespace/:kind/:name',\n    filter: undefined,\n    batchSize: 500,\n  },\n};\n\nexport function readScheduleConfigOptions(\n  configRoot: Config,\n): SchedulerServiceTaskScheduleDefinition {\n  let schedule: SchedulerServiceTaskScheduleDefinition | undefined = undefined;\n\n  const config = configRoot.getOptionalConfig(configKey);\n  if (config) {\n    const scheduleConfig = config.getOptionalConfig('schedule');\n    if (scheduleConfig) {\n      try {\n        schedule =\n          readSchedulerServiceTaskScheduleDefinitionFromConfig(scheduleConfig);\n      } catch (error) {\n        throw new InputError(`Invalid schedule at ${configKey}, ${error}`);\n      }\n    }\n  }\n\n  return schedule ?? defaults.schedule;\n}\n\nexport function readCollatorConfigOptions(configRoot: Config): {\n  locationTemplate: string;\n  filter: EntityFilterQuery | undefined;\n  batchSize: number;\n} {\n  const config = configRoot.getOptionalConfig(configKey);\n  if (!config) {\n    return defaults.collatorOptions;\n  }\n\n  return {\n    locationTemplate:\n      config.getOptionalString('locationTemplate') ??\n      defaults.collatorOptions.locationTemplate,\n    filter:\n      config.getOptionalConfig('filter')?.get<EntityFilterQuery>() ??\n      defaults.collatorOptions.filter,\n    batchSize:\n      config.getOptionalNumber('batchSize') ??\n      defaults.collatorOptions.batchSize,\n  };\n}\n"],"names":["readSchedulerServiceTaskScheduleDefinitionFromConfig","InputError"],"mappings":";;;;;AAwBA,MAAM,SAAY,GAAA,0BAAA,CAAA;AAEX,MAAM,QAAW,GAAA;AAAA,EACtB,QAAU,EAAA;AAAA,IACR,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,IACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,IACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,GAC7B;AAAA,EACA,eAAiB,EAAA;AAAA,IACf,gBAAkB,EAAA,iCAAA;AAAA,IAClB,MAAQ,EAAA,KAAA,CAAA;AAAA,IACR,SAAW,EAAA,GAAA;AAAA,GACb;AACF,CAAA,CAAA;AAEO,SAAS,0BACd,UACwC,EAAA;AACxC,EAAA,IAAI,QAA+D,GAAA,KAAA,CAAA,CAAA;AAEnE,EAAM,MAAA,MAAA,GAAS,UAAW,CAAA,iBAAA,CAAkB,SAAS,CAAA,CAAA;AACrD,EAAA,IAAI,MAAQ,EAAA;AACV,IAAM,MAAA,cAAA,GAAiB,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA,CAAA;AAC1D,IAAA,IAAI,cAAgB,EAAA;AAClB,MAAI,IAAA;AACF,QAAA,QAAA,GACEA,sEAAqD,cAAc,CAAA,CAAA;AAAA,eAC9D,KAAO,EAAA;AACd,QAAA,MAAM,IAAIC,iBAAW,CAAA,CAAA,oBAAA,EAAuB,SAAS,CAAA,EAAA,EAAK,KAAK,CAAE,CAAA,CAAA,CAAA;AAAA,OACnE;AAAA,KACF;AAAA,GACF;AAEA,EAAA,OAAO,YAAY,QAAS,CAAA,QAAA,CAAA;AAC9B,CAAA;AAEO,SAAS,0BAA0B,UAIxC,EAAA;AACA,EAAM,MAAA,MAAA,GAAS,UAAW,CAAA,iBAAA,CAAkB,SAAS,CAAA,CAAA;AACrD,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAA,OAAO,QAAS,CAAA,eAAA,CAAA;AAAA,GAClB;AAEA,EAAO,OAAA;AAAA,IACL,kBACE,MAAO,CAAA,iBAAA,CAAkB,kBAAkB,CAAA,IAC3C,SAAS,eAAgB,CAAA,gBAAA;AAAA,IAC3B,MAAA,EACE,OAAO,iBAAkB,CAAA,QAAQ,GAAG,GAAuB,EAAA,IAC3D,SAAS,eAAgB,CAAA,MAAA;AAAA,IAC3B,WACE,MAAO,CAAA,iBAAA,CAAkB,WAAW,CAAA,IACpC,SAAS,eAAgB,CAAA,SAAA;AAAA,GAC7B,CAAA;AACF;;;;;"}