@backstage/plugin-search-backend-module-catalog 0.1.4-next.2 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/plugin-search-backend-module-catalog
 
+## 0.1.4
+
+### Patch Changes
+
+- 629cbd194a87: Use `coreServices.rootConfig` instead of `coreService.config`
+- 29f77f923c71: Ensure that all services are dependency injected into the module instead of taken from options
+- 12a8c94eda8d: Add package repository and homepage metadata
+- ec1032129e47: Breaking change in the alpha export `searchModuleCatalogCollator`: Moved collator settings from module options into app-config. You are now expected to set up the catalog collator under the `search.collators.catalog` configuration key. There is also a new `catalogCollatorExtensionPoint` extension point for the module, wherein you can set custom transformers.
+- d4f19a16bd52: Add User Entity email to the search index so that users can be found by their email.
+- Updated dependencies
+  - @backstage/backend-common@0.19.2
+  - @backstage/backend-plugin-api@0.6.0
+  - @backstage/plugin-search-backend-node@1.2.4
+  - @backstage/plugin-catalog-node@1.4.1
+  - @backstage/backend-tasks@0.5.5
+  - @backstage/catalog-client@1.4.3
+  - @backstage/catalog-model@1.4.1
+  - @backstage/config@1.0.8
+  - @backstage/errors@1.2.1
+  - @backstage/plugin-catalog-common@1.0.15
+  - @backstage/plugin-permission-common@0.7.7
+  - @backstage/plugin-search-common@1.2.5
+
 ## 0.1.4-next.2
 
 ### Patch Changes

package/README.md

@@ -2,11 +2,18 @@
 
 > 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.
+This package exports a module that extends the search backend to also indexing the entities of your catalog.
 
-## Example
+## Installation
 
-### Use default schedule
+Add the module package as a dependency:
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-search-backend-module-catalog
+```
+
+Add the collator to your backend instance, along with the search plugin itself:
 
 ```tsx
 // packages/backend-next/src/index.ts
@@ -20,22 +27,50 @@ backend.add(searchModuleCatalogCollator());
 backend.start();
 ```
 
-### Use custom schedule
+You may also want to add configuration parameters to your app-config, for example for controlling the scheduled indexing interval. These parameters should be placed under the `search.collators.catalog` key. See [the config definition file](https://github.com/backstage/backstage/blob/master/plugins/search-backend-module-catalog/config.d.ts) for more details.
+
+## Advanced Customizations
+
+This module also has an extension point, which lets you inject advanced customizations. Here's an example of how to leverage that extension point to tweak the transformer used for building the search indexer documents:
 
 ```tsx
 // packages/backend-next/src/index.ts
 import { createBackend } from '@backstage/backend-defaults';
+import { createBackendModule } from '@backstage/backend-plugin-api';
 import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
-import { searchModuleCatalogCollator } from '@backstage/plugin-search-backend-module-catalog/alpha';
+import { CatalogCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-catalog';
+import {
+  searchModuleCatalogCollator,
+  catalogCollatorExtensionPoint,
+} from '@backstage/plugin-search-backend-module-catalog/alpha';
 
-const schedule = {
-  frequency: { minutes: 10 },
-  timeout: { minutes: 15 },
-  initialDelay: { seconds: 3 },
-};
+const customTransformer: CatalogCollatorEntityTransformer = entity => ({
+  title: entity.metadata.title || entity.metadata.name,
+  text: entity.metadata.description || '',
+  componentType: entity.spec?.type?.toString() || 'other',
+  type: entity.spec?.type?.toString() || 'other',
+  namespace: entity.metadata.namespace || 'default',
+  kind: entity.kind,
+  lifecycle: (entity.spec?.lifecycle as string) || '',
+  owner: (entity.spec?.owner as string) || '',
+});
 
 const backend = createBackend();
 backend.add(searchPlugin());
-backend.add(searchModuleCatalogCollator({ schedule }));
+backend.add(searchModuleCatalogCollator());
+backend.add(
+  createBackendModule({
+    pluginId: 'search',
+    moduleId: 'myCatalogCollatorOptions',
+    register(reg) {
+      reg.registerInit({
+        deps: { collator: catalogCollatorExtensionPoint },
+        init({ collator }) {
+          collator.setEntityTransformer(customTransformer);
+        },
+      });
+    },
+  })(),
+);
 backend.start();
 ```

package/alpha/package.json

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

package/config.d.ts

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TaskScheduleDefinitionConfig } from '@backstage/backend-tasks';
+
+export interface Config {
+  search?: {
+    collators?: {
+      /**
+       * Configuration options for `@backstage/plugin-search-backend-module-catalog`
+       */
+      catalog?: {
+        /**
+         * A templating string with placeholders, to form the final location of
+         * the entity.
+         *
+         * Defaults to '/catalog/:namespace/:kind/:name'
+         */
+        locationTemplate?: string;
+        /**
+         * A filter expression passed to the catalog client, to select what
+         * entities to collate.
+         *
+         * Defaults to no filter, ie indexing all entities.
+         */
+        filter?: object;
+        /**
+         * The number of entities to process at a time. Keep this at a
+         * reasonable number to avoid overloading either the catalog or the
+         * search backend.
+         *
+         * Defaults to 500
+         */
+        batchSize?: number;
+        /**
+         * The schedule for how often to run the collation job.
+         */
+        schedule?: TaskScheduleDefinitionConfig;
+      };
+    };
+  };
+}

package/dist/alpha.cjs.js

@@ -3,54 +3,62 @@
 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');
 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('./cjs/config-6c7298b0.cjs.js');
+require('@backstage/backend-tasks');
+require('@backstage/errors');
 
-const searchModuleCatalogCollator = backendPluginApi.createBackendModule(
-  (options) => ({
-    moduleId: "catalogCollator",
-    pluginId: "search",
-    register(env) {
-      env.registerInit({
-        deps: {
-          config: backendPluginApi.coreServices.rootConfig,
-          discovery: backendPluginApi.coreServices.discovery,
-          tokenManager: backendPluginApi.coreServices.tokenManager,
-          scheduler: backendPluginApi.coreServices.scheduler,
-          indexRegistry: alpha.searchIndexRegistryExtensionPoint,
-          catalog: alpha$1.catalogServiceRef
-        },
-        async init({
-          config,
-          discovery,
-          tokenManager,
-          scheduler,
-          indexRegistry,
-          catalog
-        }) {
-          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,
-              catalogClient: catalog
-            })
-          });
+const catalogCollatorExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "search.catalogCollator.extension"
+});
+const searchModuleCatalogCollator = backendPluginApi.createBackendModule({
+  moduleId: "catalogCollator",
+  pluginId: "search",
+  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: {
+        config: backendPluginApi.coreServices.rootConfig,
+        discovery: backendPluginApi.coreServices.discovery,
+        tokenManager: backendPluginApi.coreServices.tokenManager,
+        scheduler: backendPluginApi.coreServices.scheduler,
+        indexRegistry: alpha.searchIndexRegistryExtensionPoint,
+        catalog: alpha$1.catalogServiceRef
+      },
+      async init({
+        config: config$1,
+        discovery,
+        tokenManager,
+        scheduler,
+        indexRegistry,
+        catalog
+      }) {
+        indexRegistry.addCollator({
+          schedule: scheduler.createScheduledTaskRunner(
+            config.readScheduleConfigOptions(config$1)
+          ),
+          factory: pluginSearchBackendModuleCatalog.DefaultCatalogCollatorFactory.fromConfig(config$1, {
+            entityTransformer,
+            discovery,
+            tokenManager,
+            catalogClient: catalog
+          })
+        });
+      }
+    });
+  }
+});
 
+exports.catalogCollatorExtensionPoint = catalogCollatorExtensionPoint;
 exports.searchModuleCatalogCollator = searchModuleCatalogCollator;
 //# 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} 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';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\n\n/**\n * @alpha\n * Options for {@link searchModuleCatalogCollator}.\n */\nexport type SearchModuleCatalogCollatorOptions = Omit<\n  DefaultCatalogCollatorFactoryOptions,\n  'discovery' | 'tokenManager' | 'catalogClient'\n> & {\n  schedule?: TaskScheduleDefinition;\n};\n\n/**\n * Search backend module for the Catalog index.\n *\n * @alpha\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.rootConfig,\n          discovery: coreServices.discovery,\n          tokenManager: coreServices.tokenManager,\n          scheduler: coreServices.scheduler,\n          indexRegistry: searchIndexRegistryExtensionPoint,\n          catalog: catalogServiceRef,\n        },\n        async init({\n          config,\n          discovery,\n          tokenManager,\n          scheduler,\n          indexRegistry,\n          catalog,\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              catalogClient: catalog,\n            }),\n          });\n        },\n      });\n    },\n  }),\n);\n"],"names":["createBackendModule","coreServices","searchIndexRegistryExtensionPoint","catalogServiceRef","DefaultCatalogCollatorFactory"],"mappings":";;;;;;;;;AAkDO,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,UAAA;AAAA,UACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,UACxB,cAAcA,6BAAa,CAAA,YAAA;AAAA,UAC3B,WAAWA,6BAAa,CAAA,SAAA;AAAA,UACxB,aAAe,EAAAC,uCAAA;AAAA,UACf,OAAS,EAAAC,yBAAA;AAAA,SACX;AAAA,QACA,MAAM,IAAK,CAAA;AAAA,UACT,MAAA;AAAA,UACA,SAAA;AAAA,UACA,YAAA;AAAA,UACA,SAAA;AAAA,UACA,aAAA;AAAA,UACA,OAAA;AAAA,SACC,EAAA;AAvEX,UAAA,IAAA,EAAA,CAAA;AAwEU,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,cACA,aAAe,EAAA,OAAA;AAAA,aAChB,CAAA;AAAA,WACF,CAAA,CAAA;AAAA,SACH;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;;;"}
+{"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, when using\n * {@link searchModuleCatalogCollator}.\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 const searchModuleCatalogCollator = createBackendModule({\n  moduleId: 'catalogCollator',\n  pluginId: 'search',\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        config: coreServices.rootConfig,\n        discovery: coreServices.discovery,\n        tokenManager: coreServices.tokenManager,\n        scheduler: coreServices.scheduler,\n        indexRegistry: searchIndexRegistryExtensionPoint,\n        catalog: catalogServiceRef,\n      },\n      async init({\n        config,\n        discovery,\n        tokenManager,\n        scheduler,\n        indexRegistry,\n        catalog,\n      }) {\n        indexRegistry.addCollator({\n          schedule: scheduler.createScheduledTaskRunner(\n            readScheduleConfigOptions(config),\n          ),\n          factory: DefaultCatalogCollatorFactory.fromConfig(config, {\n            entityTransformer,\n            discovery,\n            tokenManager,\n            catalogClient: catalog,\n          }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","searchIndexRegistryExtensionPoint","catalogServiceRef","config","readScheduleConfigOptions","DefaultCatalogCollatorFactory"],"mappings":";;;;;;;;;;;;AAqDO,MAAM,gCACXA,qCAAoD,CAAA;AAAA,EAClD,EAAI,EAAA,kCAAA;AACN,CAAC,EAAA;AAOI,MAAM,8BAA8BC,oCAAoB,CAAA;AAAA,EAC7D,QAAU,EAAA,iBAAA;AAAA,EACV,QAAU,EAAA,QAAA;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,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,cAAcA,6BAAa,CAAA,YAAA;AAAA,QAC3B,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,aAAe,EAAAC,uCAAA;AAAA,QACf,OAAS,EAAAC,yBAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,gBACTC,QAAA;AAAA,QACA,SAAA;AAAA,QACA,YAAA;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,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,YAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,WAChB,CAAA;AAAA,SACF,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/alpha.d.ts

@@ -1,19 +1,30 @@
 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';
+import { CatalogCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-catalog';
 
 /**
+ * Options for {@link catalogCollatorExtensionPoint}.
+ *
  * @alpha
- * Options for {@link searchModuleCatalogCollator}.
  */
-type SearchModuleCatalogCollatorOptions = Omit<DefaultCatalogCollatorFactoryOptions, 'discovery' | 'tokenManager' | 'catalogClient'> & {
-    schedule?: TaskScheduleDefinition;
+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, when using
+ * {@link searchModuleCatalogCollator}.
+ *
+ * @alpha
+ */
+declare const catalogCollatorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogCollatorExtensionPoint>;
 /**
  * Search backend module for the Catalog index.
  *
  * @alpha
  */
-declare const searchModuleCatalogCollator: (options?: SearchModuleCatalogCollatorOptions | undefined) => _backstage_backend_plugin_api.BackendFeature;
+declare const searchModuleCatalogCollator: () => _backstage_backend_plugin_api.BackendFeature;
 
-export { SearchModuleCatalogCollatorOptions, searchModuleCatalogCollator };
+export { CatalogCollatorExtensionPoint, catalogCollatorExtensionPoint, searchModuleCatalogCollator };

package/dist/cjs/config-6c7298b0.cjs.js

@@ -0,0 +1,49 @@
+'use strict';
+
+var backendTasks = require('@backstage/backend-tasks');
+var errors = require('@backstage/errors');
+
+const configKey = "search.collators.catalog";
+const defaults = {
+  schedule: {
+    frequency: { minutes: 10 },
+    timeout: { minutes: 15 },
+    initialDelay: { seconds: 3 }
+  },
+  collatorOptions: {
+    locationTemplate: "/catalog/:namespace/:kind/:name",
+    filter: void 0,
+    batchSize: 500
+  }
+};
+function readScheduleConfigOptions(configRoot) {
+  let schedule = void 0;
+  const config = configRoot.getOptionalConfig(configKey);
+  if (config) {
+    const scheduleConfig = config.getOptionalConfig("schedule");
+    if (scheduleConfig) {
+      try {
+        schedule = backendTasks.readTaskScheduleDefinitionFromConfig(scheduleConfig);
+      } catch (error) {
+        throw new errors.InputError(`Invalid schedule at ${configKey}, ${error}`);
+      }
+    }
+  }
+  return schedule != null ? schedule : defaults.schedule;
+}
+function readCollatorConfigOptions(configRoot) {
+  var _a, _b, _c, _d;
+  const config = configRoot.getOptionalConfig(configKey);
+  if (!config) {
+    return defaults.collatorOptions;
+  }
+  return {
+    locationTemplate: (_a = config.getOptionalString("locationTemplate")) != null ? _a : defaults.collatorOptions.locationTemplate,
+    filter: (_c = (_b = config.getOptionalConfig("filter")) == null ? void 0 : _b.get()) != null ? _c : defaults.collatorOptions.filter,
+    batchSize: (_d = config.getOptionalNumber("batchSize")) != null ? _d : defaults.collatorOptions.batchSize
+  };
+}
+
+exports.readCollatorConfigOptions = readCollatorConfigOptions;
+exports.readScheduleConfigOptions = readScheduleConfigOptions;
+//# sourceMappingURL=config-6c7298b0.cjs.js.map

package/dist/cjs/config-6c7298b0.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-6c7298b0.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  readTaskScheduleDefinitionFromConfig,\n  TaskScheduleDefinition,\n} from '@backstage/backend-tasks';\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): TaskScheduleDefinition {\n  let schedule: TaskScheduleDefinition | 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 = readTaskScheduleDefinitionFromConfig(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":["readTaskScheduleDefinitionFromConfig","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,UACwB,EAAA;AACxB,EAAA,IAAI,QAA+C,GAAA,KAAA,CAAA,CAAA;AAEnD,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,GAAWA,kDAAqC,cAAc,CAAA,CAAA;AAAA,eACvD,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,8BAAY,QAAS,CAAA,QAAA,CAAA;AAC9B,CAAA;AAEO,SAAS,0BAA0B,UAIxC,EAAA;AA/DF,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAgEE,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,mBACE,EAAO,GAAA,MAAA,CAAA,iBAAA,CAAkB,kBAAkB,CAA3C,KAAA,IAAA,GAAA,EAAA,GACA,SAAS,eAAgB,CAAA,gBAAA;AAAA,IAC3B,MAAA,EAAA,CACE,kBAAO,iBAAkB,CAAA,QAAQ,MAAjC,IAAoC,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,GAAA,EAAA,KAApC,IACA,GAAA,EAAA,GAAA,QAAA,CAAS,eAAgB,CAAA,MAAA;AAAA,IAC3B,YACE,EAAO,GAAA,MAAA,CAAA,iBAAA,CAAkB,WAAW,CAApC,KAAA,IAAA,GAAA,EAAA,GACA,SAAS,eAAgB,CAAA,SAAA;AAAA,GAC7B,CAAA;AACF;;;;;"}

package/dist/index.cjs.js

@@ -3,12 +3,15 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 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 catalogModel = require('@backstage/catalog-model');
+var config = require('./cjs/config-6c7298b0.cjs.js');
+require('@backstage/backend-tasks');
+require('@backstage/errors');
 
 const getDocumentText = (entity) => {
-  var _a, _b;
+  var _a, _b, _c, _d;
   const documentTexts = [];
   documentTexts.push(entity.metadata.description || "");
   if (catalogModel.isUserEntity(entity) || catalogModel.isGroupEntity(entity)) {
@@ -16,6 +19,11 @@ const getDocumentText = (entity) => {
       documentTexts.push(entity.spec.profile.displayName);
     }
   }
+  if (catalogModel.isUserEntity(entity)) {
+    if ((_d = (_c = entity.spec) == null ? void 0 : _c.profile) == null ? void 0 : _d.email) {
+      documentTexts.push(entity.spec.profile.email);
+    }
+  }
   return documentTexts.join(" : ");
 };
 const defaultCatalogCollatorEntityTransformer = (entity) => {
@@ -57,15 +65,25 @@ class DefaultCatalogCollatorFactory {
       tokenManager,
       entityTransformer
     } = options;
-    this.locationTemplate = locationTemplate || "/catalog/:namespace/:kind/:name";
+    this.locationTemplate = locationTemplate;
     this.filter = filter;
-    this.batchSize = batchSize || 500;
+    this.batchSize = batchSize;
     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);
+  static fromConfig(configRoot, options) {
+    var _a, _b, _c;
+    const configOptions = config.readCollatorConfigOptions(configRoot);
+    return new DefaultCatalogCollatorFactory({
+      locationTemplate: (_a = options.locationTemplate) != null ? _a : configOptions.locationTemplate,
+      filter: (_b = options.filter) != null ? _b : configOptions.filter,
+      batchSize: (_c = options.batchSize) != null ? _c : configOptions.batchSize,
+      entityTransformer: options.entityTransformer,
+      discovery: options.discovery,
+      tokenManager: options.tokenManager,
+      catalogClient: options.catalogClient
+    });
   }
   async getCollator() {
     return stream.Readable.from(this.execute());

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  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,aAAA,CAAA,IAAA,EAAgB,MAAO,EAAA,kBAAA,CAAA,CAAA;AACvB,IAAA,aAAA,CAAA,IAAA,EAAgB,sBACd,EAAAC,iCAAA,CAAA,CAAA;AAEF,IAAQ,aAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACR,IAAiB,aAAA,CAAA,IAAA,EAAA,eAAA,CAAA,CAAA;AACjB,IAAQ,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,mBAAA,CAAA,CAAA;AAUN,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,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":["../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  PluginEndpointDiscovery,\n  TokenManager,\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';\n\n/** @public */\nexport type DefaultCatalogCollatorFactoryOptions = {\n  discovery: PluginEndpointDiscovery;\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 */\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    configRoot: Config,\n    options: DefaultCatalogCollatorFactoryOptions,\n  ) {\n    const configOptions = readCollatorConfigOptions(configRoot);\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      discovery: options.discovery,\n      tokenManager: options.tokenManager,\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    discovery: PluginEndpointDiscovery;\n    tokenManager: TokenManager;\n    catalogClient?: CatalogApi;\n  }) {\n    const {\n      batchSize,\n      discovery,\n      locationTemplate,\n      filter,\n      catalogClient,\n      tokenManager,\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.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","readCollatorConfigOptions","Readable","stringifyEntityRef"],"mappings":";;;;;;;;;;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAA2B,KAAA;AAnBpD,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,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,EAAI,IAAAD,yBAAA,CAAa,MAAM,CAAG,EAAA;AACxB,IAAA,IAAA,CAAI,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,KAAb,mBAAsB,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;AAxCtB,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAyCI,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;;;;;;;;ACaK,MAAM,6BAAiE,CAAA;AAAA,EA6BpE,YAAY,OAQjB,EAAA;AApCH,IAAA,aAAA,CAAA,IAAA,EAAgB,MAAO,EAAA,kBAAA,CAAA,CAAA;AACvB,IAAA,aAAA,CAAA,IAAA,EAAgB,sBACd,EAAAE,iCAAA,CAAA,CAAA;AAEF,IAAQ,aAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACR,IAAiB,aAAA,CAAA,IAAA,EAAA,eAAA,CAAA,CAAA;AACjB,IAAQ,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,mBAAA,CAAA,CAAA;AA4BN,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,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,YAAe,GAAA,YAAA,CAAA;AACpB,IAAA,IAAA,CAAK,oBACH,iBAAqB,IAAA,IAAA,GAAA,iBAAA,GAAA,uCAAA,CAAA;AAAA,GACzB;AAAA,EA5CA,OAAO,UACL,CAAA,UAAA,EACA,OACA,EAAA;AA/EJ,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAgFI,IAAM,MAAA,aAAA,GAAgBC,iCAA0B,UAAU,CAAA,CAAA;AAC1D,IAAA,OAAO,IAAI,6BAA8B,CAAA;AAAA,MACvC,gBACE,EAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,gBAAR,KAAA,IAAA,GAAA,EAAA,GAA4B,aAAc,CAAA,gBAAA;AAAA,MAC5C,MAAQ,EAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,MAAR,KAAA,IAAA,GAAA,EAAA,GAAkB,aAAc,CAAA,MAAA;AAAA,MACxC,SAAW,EAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,SAAR,KAAA,IAAA,GAAA,EAAA,GAAqB,aAAc,CAAA,SAAA;AAAA,MAC9C,mBAAmB,OAAQ,CAAA,iBAAA;AAAA,MAC3B,WAAW,OAAQ,CAAA,SAAA;AAAA,MACnB,cAAc,OAAQ,CAAA,YAAA;AAAA,MACtB,eAAe,OAAQ,CAAA,aAAA;AAAA,KACxB,CAAA,CAAA;AAAA,GACH;AAAA,EA+BA,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,GAAG,IAAI,KAAK,CAAA,CAAA;AAAA,KAChD;AAEA,IAAA,OAAO,UAAU,WAAY,EAAA,CAAA;AAAA,GAC/B;AACF;;;;;"}

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 /// <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 { Config } from '@backstage/config';
 import { Permission } from '@backstage/plugin-permission-common';
+import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
 import { Readable } from 'stream';
 import { Entity } from '@backstage/catalog-model';
 import { CatalogEntityDocument } from '@backstage/plugin-catalog-common';
@@ -15,13 +15,29 @@ type CatalogCollatorEntityTransformer = (entity: Entity) => Omit<CatalogEntityDo
 type DefaultCatalogCollatorFactoryOptions = {
     discovery: PluginEndpointDiscovery;
     tokenManager: TokenManager;
+    /**
+     * @deprecated Use the config key `search.collators.catalog.locationTemplate` instead.
+     */
     locationTemplate?: string;
+    /**
+     * @deprecated Use the config key `search.collators.catalog.filter` instead.
+     */
     filter?: GetEntitiesRequest['filter'];
+    /**
+     * @deprecated Use the config key `search.collators.catalog.batchSize` instead.
+     */
     batchSize?: number;
     catalogClient?: CatalogApi;
+    /**
+     * Allows you to customize how entities are shaped into documents.
+     */
     entityTransformer?: CatalogCollatorEntityTransformer;
 };
-/** @public */
+/**
+ * Collates entities from the Catalog into documents for the search backend.
+ *
+ * @public
+ */
 declare class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
     readonly type = "software-catalog";
     readonly visibilityPermission: Permission;
@@ -31,7 +47,7 @@ declare class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
     private readonly catalogClient;
     private tokenManager;
     private entityTransformer;
-    static fromConfig(_config: Config, options: DefaultCatalogCollatorFactoryOptions): DefaultCatalogCollatorFactory;
+    static fromConfig(configRoot: Config, options: DefaultCatalogCollatorFactoryOptions): DefaultCatalogCollatorFactory;
     private constructor();
     getCollator(): Promise<Readable>;
     private execute;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-search-backend-module-catalog",
   "description": "A module for the search backend that exports catalog modules",
-  "version": "0.1.4-next.2",
+  "version": "0.1.4",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
@@ -40,26 +40,29 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.19.2-next.2",
-    "@backstage/backend-plugin-api": "^0.6.0-next.2",
-    "@backstage/backend-tasks": "^0.5.5-next.2",
+    "@backstage/backend-common": "^0.19.2",
+    "@backstage/backend-plugin-api": "^0.6.0",
+    "@backstage/backend-tasks": "^0.5.5",
     "@backstage/catalog-client": "^1.4.3",
     "@backstage/catalog-model": "^1.4.1",
     "@backstage/config": "^1.0.8",
+    "@backstage/errors": "^1.2.1",
     "@backstage/plugin-catalog-common": "^1.0.15",
-    "@backstage/plugin-catalog-node": "^1.4.1-next.2",
+    "@backstage/plugin-catalog-node": "^1.4.1",
     "@backstage/plugin-permission-common": "^0.7.7",
-    "@backstage/plugin-search-backend-node": "^1.2.4-next.2",
+    "@backstage/plugin-search-backend-node": "^1.2.4",
     "@backstage/plugin-search-common": "^1.2.5"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.19.2-next.2",
-    "@backstage/backend-test-utils": "^0.2.0-next.2",
-    "@backstage/cli": "^0.22.10-next.1",
+    "@backstage/backend-common": "^0.19.2",
+    "@backstage/backend-test-utils": "^0.2.0",
+    "@backstage/cli": "^0.22.10",
     "msw": "^1.0.0"
   },
   "files": [
     "dist",
+    "config.d.ts",
     "alpha"
-  ]
+  ],
+  "configSchema": "config.d.ts"
 }