@backstage/plugin-search-backend-module-catalog 0.0.0-nightly-20230323021924

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# @backstage/plugin-search-backend-module-catalog
+
+## 0.0.0-nightly-20230323021924
+
+### Minor Changes
+
+- 01ae205352e: Package introduced to export search backend modules that can be used with the new backend system to extend search with plugin specific functionality, such as collators. For documentation on how to migrate, check out the [how to migrate to the new backend system guide](../docs/features/search/how-to-guides.md#how-to-migrate-to-use-search-together-with-the-new-backend-system).
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.0.0-nightly-20230323021924
+  - @backstage/plugin-search-backend-node@0.0.0-nightly-20230323021924
+  - @backstage/backend-plugin-api@0.0.0-nightly-20230323021924
+  - @backstage/backend-tasks@0.0.0-nightly-20230323021924
+  - @backstage/catalog-client@1.4.0
+  - @backstage/catalog-model@1.2.1
+  - @backstage/config@1.0.7
+  - @backstage/plugin-catalog-common@1.0.12
+  - @backstage/plugin-permission-common@0.7.4
+  - @backstage/plugin-search-common@1.2.2

package/README.md

@@ -0,0 +1,41 @@
+# search-backend-module-catalog
+
+> DISCLAIMER: The new backend system is in alpha, and so are the search backend module support for the new backend system. We don't recommend you to migrate your backend installations to the new system yet. But if you want to experiment, you can find getting started guides below.
+
+This package exports catalog backend modules responsible for extending search.
+
+## Example
+
+### Use default schedule
+
+```tsx
+// packages/backend-next/src/index.ts
+import { createBackend } from '@backstage/backend-defaults';
+import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
+import { searchModuleCatalogCollator } from '@backstage/plugin-search-backend-module-catalog/alpha';
+
+const backend = createBackend();
+backend.add(searchPlugin());
+backend.add(searchModuleCatalogCollator());
+backend.start();
+```
+
+### Use custom schedule
+
+```tsx
+// packages/backend-next/src/index.ts
+import { createBackend } from '@backstage/backend-defaults';
+import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
+import { searchModuleCatalogCollator } from '@backstage/plugin-search-backend-module-catalog/alpha';
+
+const schedule = {
+  frequency: { minutes: 10 },
+  timeout: { minutes: 15 },
+  initialDelay: { seconds: 3 },
+};
+
+const backend = createBackend();
+backend.add(searchPlugin());
+backend.add(searchModuleCatalogCollator({ schedule }));
+backend.start();
+```

package/alpha/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/plugin-search-backend-module-catalog",
+  "version": "0.0.0-nightly-20230323021924",
+  "main": "../dist/alpha.cjs.js",
+  "types": "../dist/alpha.d.ts"
+}

package/dist/alpha.cjs.js

@@ -0,0 +1,52 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-search-backend-node/alpha');
+var pluginSearchBackendModuleCatalog = require('@backstage/plugin-search-backend-module-catalog');
+
+const searchModuleCatalogCollator = backendPluginApi.createBackendModule(
+  (options) => ({
+    moduleId: "catalogCollator",
+    pluginId: "search",
+    register(env) {
+      env.registerInit({
+        deps: {
+          config: backendPluginApi.coreServices.config,
+          discovery: backendPluginApi.coreServices.discovery,
+          tokenManager: backendPluginApi.coreServices.tokenManager,
+          scheduler: backendPluginApi.coreServices.scheduler,
+          indexRegistry: alpha.searchIndexRegistryExtensionPoint
+        },
+        async init({
+          config,
+          discovery,
+          tokenManager,
+          scheduler,
+          indexRegistry
+        }) {
+          var _a;
+          const defaultSchedule = {
+            frequency: { minutes: 10 },
+            timeout: { minutes: 15 },
+            initialDelay: { seconds: 3 }
+          };
+          indexRegistry.addCollator({
+            schedule: scheduler.createScheduledTaskRunner(
+              (_a = options == null ? void 0 : options.schedule) != null ? _a : defaultSchedule
+            ),
+            factory: pluginSearchBackendModuleCatalog.DefaultCatalogCollatorFactory.fromConfig(config, {
+              ...options,
+              discovery,
+              tokenManager
+            })
+          });
+        }
+      });
+    }
+  })
+);
+
+exports.searchModuleCatalogCollator = searchModuleCatalogCollator;
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +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} from '@backstage/backend-plugin-api';\nimport { TaskScheduleDefinition } from '@backstage/backend-tasks';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\n\nimport {\n  DefaultCatalogCollatorFactory,\n  DefaultCatalogCollatorFactoryOptions,\n} from '@backstage/plugin-search-backend-module-catalog';\n\n/**\n * @alpha\n * Options for {@link searchModuleCatalogCollator}.\n */\nexport type SearchModuleCatalogCollatorOptions = Omit<\n  DefaultCatalogCollatorFactoryOptions,\n  'discovery' | 'tokenManager'\n> & {\n  schedule?: TaskScheduleDefinition;\n};\n\n/**\n * @alpha\n * Search backend module for the Catalog index.\n */\nexport const searchModuleCatalogCollator = createBackendModule(\n  (options?: SearchModuleCatalogCollatorOptions) => ({\n    moduleId: 'catalogCollator',\n    pluginId: 'search',\n    register(env) {\n      env.registerInit({\n        deps: {\n          config: coreServices.config,\n          discovery: coreServices.discovery,\n          tokenManager: coreServices.tokenManager,\n          scheduler: coreServices.scheduler,\n          indexRegistry: searchIndexRegistryExtensionPoint,\n        },\n        async init({\n          config,\n          discovery,\n          tokenManager,\n          scheduler,\n          indexRegistry,\n        }) {\n          const defaultSchedule = {\n            frequency: { minutes: 10 },\n            timeout: { minutes: 15 },\n            initialDelay: { seconds: 3 },\n          };\n\n          indexRegistry.addCollator({\n            schedule: scheduler.createScheduledTaskRunner(\n              options?.schedule ?? defaultSchedule,\n            ),\n            factory: DefaultCatalogCollatorFactory.fromConfig(config, {\n              ...options,\n              discovery,\n              tokenManager,\n            }),\n          });\n        },\n      });\n    },\n  }),\n);\n"],"names":["createBackendModule","coreServices","searchIndexRegistryExtensionPoint","DefaultCatalogCollatorFactory"],"mappings":";;;;;;;;AAgDO,MAAM,2BAA8B,GAAAA,oCAAA;AAAA,EACzC,CAAC,OAAkD,MAAA;AAAA,IACjD,QAAU,EAAA,iBAAA;AAAA,IACV,QAAU,EAAA,QAAA;AAAA,IACV,SAAS,GAAK,EAAA;AACZ,MAAA,GAAA,CAAI,YAAa,CAAA;AAAA,QACf,IAAM,EAAA;AAAA,UACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,UACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,UACxB,cAAcA,6BAAa,CAAA,YAAA;AAAA,UAC3B,WAAWA,6BAAa,CAAA,SAAA;AAAA,UACxB,aAAe,EAAAC,uCAAA;AAAA,SACjB;AAAA,QACA,MAAM,IAAK,CAAA;AAAA,UACT,MAAA;AAAA,UACA,SAAA;AAAA,UACA,YAAA;AAAA,UACA,SAAA;AAAA,UACA,aAAA;AAAA,SACC,EAAA;AAnEX,UAAA,IAAA,EAAA,CAAA;AAoEU,UAAA,MAAM,eAAkB,GAAA;AAAA,YACtB,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,YACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,YACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,WAC7B,CAAA;AAEA,UAAA,aAAA,CAAc,WAAY,CAAA;AAAA,YACxB,UAAU,SAAU,CAAA,yBAAA;AAAA,cAClB,CAAA,EAAA,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,aAAT,IAAqB,GAAA,EAAA,GAAA,eAAA;AAAA,aACvB;AAAA,YACA,OAAA,EAASC,8DAA8B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,cACxD,GAAG,OAAA;AAAA,cACH,SAAA;AAAA,cACA,YAAA;AAAA,aACD,CAAA;AAAA,WACF,CAAA,CAAA;AAAA,SACH;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,18 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { TaskScheduleDefinition } from '@backstage/backend-tasks';
+import { DefaultCatalogCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-catalog';
+
+/**
+ * @alpha
+ * Options for {@link searchModuleCatalogCollator}.
+ */
+declare type SearchModuleCatalogCollatorOptions = Omit<DefaultCatalogCollatorFactoryOptions, 'discovery' | 'tokenManager'> & {
+    schedule?: TaskScheduleDefinition;
+};
+/**
+ * @alpha
+ * Search backend module for the Catalog index.
+ */
+declare const searchModuleCatalogCollator: (options?: SearchModuleCatalogCollatorOptions | undefined) => _backstage_backend_plugin_api.BackendFeature;
+
+export { SearchModuleCatalogCollatorOptions, searchModuleCatalogCollator };

package/dist/index.cjs.js

@@ -0,0 +1,102 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var catalogClient = require('@backstage/catalog-client');
+var alpha = require('@backstage/plugin-catalog-common/alpha');
+var stream = require('stream');
+var catalogModel = require('@backstage/catalog-model');
+
+const getDocumentText = (entity) => {
+  var _a, _b;
+  const documentTexts = [];
+  documentTexts.push(entity.metadata.description || "");
+  if (catalogModel.isUserEntity(entity) || catalogModel.isGroupEntity(entity)) {
+    if ((_b = (_a = entity.spec) == null ? void 0 : _a.profile) == null ? void 0 : _b.displayName) {
+      documentTexts.push(entity.spec.profile.displayName);
+    }
+  }
+  return documentTexts.join(" : ");
+};
+const defaultCatalogCollatorEntityTransformer = (entity) => {
+  var _a, _b, _c, _d, _e, _f, _g;
+  return {
+    title: (_a = entity.metadata.title) != null ? _a : entity.metadata.name,
+    text: getDocumentText(entity),
+    componentType: ((_c = (_b = entity.spec) == null ? void 0 : _b.type) == null ? void 0 : _c.toString()) || "other",
+    type: ((_e = (_d = entity.spec) == null ? void 0 : _d.type) == null ? void 0 : _e.toString()) || "other",
+    namespace: entity.metadata.namespace || "default",
+    kind: entity.kind,
+    lifecycle: ((_f = entity.spec) == null ? void 0 : _f.lifecycle) || "",
+    owner: ((_g = entity.spec) == null ? void 0 : _g.owner) || ""
+  };
+};
+
+class DefaultCatalogCollatorFactory {
+  constructor(options) {
+    this.type = "software-catalog";
+    this.visibilityPermission = alpha.catalogEntityReadPermission;
+    const {
+      batchSize,
+      discovery,
+      locationTemplate,
+      filter,
+      catalogClient: catalogClient$1,
+      tokenManager,
+      entityTransformer
+    } = options;
+    this.locationTemplate = locationTemplate || "/catalog/:namespace/:kind/:name";
+    this.filter = filter;
+    this.batchSize = batchSize || 500;
+    this.catalogClient = catalogClient$1 || new catalogClient.CatalogClient({ discoveryApi: discovery });
+    this.tokenManager = tokenManager;
+    this.entityTransformer = entityTransformer != null ? entityTransformer : defaultCatalogCollatorEntityTransformer;
+  }
+  static fromConfig(_config, options) {
+    return new DefaultCatalogCollatorFactory(options);
+  }
+  async getCollator() {
+    return stream.Readable.from(this.execute());
+  }
+  async *execute() {
+    const { token } = await this.tokenManager.getToken();
+    let entitiesRetrieved = 0;
+    let moreEntitiesToGet = true;
+    while (moreEntitiesToGet) {
+      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;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +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  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 { Config } from '@backstage/config';\nimport {\n  PluginEndpointDiscovery,\n  TokenManager,\n} from '@backstage/backend-common';\nimport {\n  CatalogApi,\n  CatalogClient,\n  GetEntitiesRequest,\n} from '@backstage/catalog-client';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport { CatalogEntityDocument } from '@backstage/plugin-catalog-common';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { Readable } from 'stream';\nimport { CatalogCollatorEntityTransformer } from './CatalogCollatorEntityTransformer';\nimport { defaultCatalogCollatorEntityTransformer } from './defaultCatalogCollatorEntityTransformer';\nimport { stringifyEntityRef } from '@backstage/catalog-model';\n\n/** @public */\nexport type DefaultCatalogCollatorFactoryOptions = {\n  discovery: PluginEndpointDiscovery;\n  tokenManager: TokenManager;\n  locationTemplate?: string;\n  filter?: GetEntitiesRequest['filter'];\n  batchSize?: number;\n  catalogClient?: CatalogApi;\n  entityTransformer?: CatalogCollatorEntityTransformer;\n};\n\n/** @public */\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 tokenManager: TokenManager;\n  private entityTransformer: CatalogCollatorEntityTransformer;\n\n  static fromConfig(\n    _config: Config,\n    options: DefaultCatalogCollatorFactoryOptions,\n  ) {\n    return new DefaultCatalogCollatorFactory(options);\n  }\n\n  private constructor(options: DefaultCatalogCollatorFactoryOptions) {\n    const {\n      batchSize,\n      discovery,\n      locationTemplate,\n      filter,\n      catalogClient,\n      tokenManager,\n      entityTransformer,\n    } = options;\n\n    this.locationTemplate =\n      locationTemplate || '/catalog/:namespace/:kind/:name';\n    this.filter = filter;\n    this.batchSize = batchSize || 500;\n    this.catalogClient =\n      catalogClient || new CatalogClient({ discoveryApi: discovery });\n    this.tokenManager = tokenManager;\n    this.entityTransformer =\n      entityTransformer ?? defaultCatalogCollatorEntityTransformer;\n  }\n\n  async getCollator(): Promise<Readable> {\n    return Readable.from(this.execute());\n  }\n\n  private async *execute(): AsyncGenerator<CatalogEntityDocument> {\n    const { token } = await this.tokenManager.getToken();\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 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","catalogClient","CatalogClient","Readable","stringifyEntityRef"],"mappings":";;;;;;;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAA2B,KAAA;AAnBpD,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAoBE,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,IAAA,IAAA,CAAI,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,KAAb,mBAAsB,WAAa,EAAA;AACrC,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,WAAW,CAAA,CAAA;AAAA,KACpD;AAAA,GACF;AAEA,EAAO,OAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACjC,CAAA,CAAA;AAGa,MAAA,uCAAA,GACX,CAAC,MAAmB,KAAA;AAlCtB,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAmCI,EAAO,OAAA;AAAA,IACL,QAAO,EAAO,GAAA,MAAA,CAAA,QAAA,CAAS,KAAhB,KAAA,IAAA,GAAA,EAAA,GAAyB,OAAO,QAAS,CAAA,IAAA;AAAA,IAChD,IAAA,EAAM,gBAAgB,MAAM,CAAA;AAAA,IAC5B,iBAAe,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,KAAb,mBAAmB,QAAc,EAAA,KAAA,OAAA;AAAA,IAChD,QAAM,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,KAAb,mBAAmB,QAAc,EAAA,KAAA,OAAA;AAAA,IACvC,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,IACxC,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,SAAY,EAAA,CAAA,CAAA,EAAA,GAAA,MAAA,CAAO,IAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAa,SAAwB,KAAA,EAAA;AAAA,IACjD,KAAQ,EAAA,CAAA,CAAA,EAAA,GAAA,MAAA,CAAO,IAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAa,KAAoB,KAAA,EAAA;AAAA,GAC3C,CAAA;AACF;;ACEK,MAAM,6BAAiE,CAAA;AAAA,EAmBpE,YAAY,OAA+C,EAAA;AAlBnE,IAAA,IAAA,CAAgB,IAAO,GAAA,kBAAA,CAAA;AACvB,IAAA,IAAA,CAAgB,oBACd,GAAAC,iCAAA,CAAA;AAiBA,IAAM,MAAA;AAAA,MACJ,SAAA;AAAA,MACA,SAAA;AAAA,MACA,gBAAA;AAAA,MACA,MAAA;AAAA,qBACAC,eAAA;AAAA,MACA,YAAA;AAAA,MACA,iBAAA;AAAA,KACE,GAAA,OAAA,CAAA;AAEJ,IAAA,IAAA,CAAK,mBACH,gBAAoB,IAAA,iCAAA,CAAA;AACtB,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,YAAY,SAAa,IAAA,GAAA,CAAA;AAC9B,IAAA,IAAA,CAAK,gBACHA,eAAiB,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,WAAW,CAAA,CAAA;AAChE,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA,CAAA;AACpB,IAAA,IAAA,CAAK,oBACH,iBAAqB,IAAA,IAAA,GAAA,iBAAA,GAAA,uCAAA,CAAA;AAAA,GACzB;AAAA,EA3BA,OAAO,UACL,CAAA,OAAA,EACA,OACA,EAAA;AACA,IAAO,OAAA,IAAI,8BAA8B,OAAO,CAAA,CAAA;AAAA,GAClD;AAAA,EAwBA,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,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,aAAa,QAAS,EAAA,CAAA;AACnD,IAAA,IAAI,iBAAoB,GAAA,CAAA,CAAA;AACxB,IAAA,IAAI,iBAAoB,GAAA,IAAA,CAAA;AAKxB,IAAA,OAAO,iBAAmB,EAAA;AACxB,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,GAAA,CAAA,CAAA,EAAO,KAAK,CAAA,CAAA;AAAA,KAChD;AAEA,IAAA,OAAO,UAAU,WAAY,EAAA,CAAA;AAAA,GAC/B;AACF;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="node" />
+import { Config } from '@backstage/config';
+import { PluginEndpointDiscovery, TokenManager } from '@backstage/backend-common';
+import { GetEntitiesRequest, CatalogApi } from '@backstage/catalog-client';
+import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
+import { Permission } from '@backstage/plugin-permission-common';
+import { Readable } from 'stream';
+import { Entity } from '@backstage/catalog-model';
+import { CatalogEntityDocument } from '@backstage/plugin-catalog-common';
+
+/** @public */
+declare type CatalogCollatorEntityTransformer = (entity: Entity) => Omit<CatalogEntityDocument, 'location' | 'authorization'>;
+
+/** @public */
+declare type DefaultCatalogCollatorFactoryOptions = {
+    discovery: PluginEndpointDiscovery;
+    tokenManager: TokenManager;
+    locationTemplate?: string;
+    filter?: GetEntitiesRequest['filter'];
+    batchSize?: number;
+    catalogClient?: CatalogApi;
+    entityTransformer?: CatalogCollatorEntityTransformer;
+};
+/** @public */
+declare class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
+    readonly type = "software-catalog";
+    readonly visibilityPermission: Permission;
+    private locationTemplate;
+    private filter?;
+    private batchSize;
+    private readonly catalogClient;
+    private tokenManager;
+    private entityTransformer;
+    static fromConfig(_config: Config, options: DefaultCatalogCollatorFactoryOptions): DefaultCatalogCollatorFactory;
+    private constructor();
+    getCollator(): Promise<Readable>;
+    private execute;
+    private applyArgsToFormat;
+}
+
+/** @public */
+declare const defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer;
+
+export { CatalogCollatorEntityTransformer, DefaultCatalogCollatorFactory, DefaultCatalogCollatorFactoryOptions, defaultCatalogCollatorEntityTransformer };

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@backstage/plugin-search-backend-module-catalog",
+  "description": "A module for the search backend that exports catalog modules",
+  "version": "0.0.0-nightly-20230323021924",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./alpha": {
+      "require": "./dist/alpha.cjs.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "clean": "backstage-cli package clean"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20230323021924",
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20230323021924",
+    "@backstage/backend-tasks": "^0.0.0-nightly-20230323021924",
+    "@backstage/catalog-client": "^1.4.0",
+    "@backstage/catalog-model": "^1.2.1",
+    "@backstage/config": "^1.0.7",
+    "@backstage/plugin-catalog-common": "^1.0.12",
+    "@backstage/plugin-permission-common": "^0.7.4",
+    "@backstage/plugin-search-backend-node": "^0.0.0-nightly-20230323021924",
+    "@backstage/plugin-search-common": "^1.2.2"
+  },
+  "devDependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20230323021924",
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20230323021924",
+    "@backstage/cli": "^0.0.0-nightly-20230323021924",
+    "msw": "^1.0.0"
+  },
+  "files": [
+    "dist",
+    "alpha"
+  ]
+}