@backstage/plugin-catalog-backend 1.30.0-next.1 → 1.30.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-catalog-backend
 
+## 1.30.0
+
+### Patch Changes
+
+- d9d62ef: Remove some internal usages of the backend-common package
+- 8379bf4: Remove usages of `PluginDatabaseManager` and `PluginEndpointDiscovery` and replace with their equivalent service types
+- be0aae7: Improved concurrency of the `entities` endpoint when using the streamed query mode behind the `catalog.disableRelationsCompatibility` flag.
+- dd515e3: Internalize the deprecated collator types since they were removed from the collator itself during new-backend-system migration.
+- 3d475a0: Updated condition in `resolveCodeOwner` to fix a bug where `normalizeCodeOwner` could potentially be called with an invalid argument causing an error in `CodeOwnersProcessor`
+- Updated dependencies
+  - @backstage/plugin-search-backend-module-catalog@0.3.0
+  - @backstage/types@1.2.1
+  - @backstage/plugin-permission-node@0.8.7
+  - @backstage/integration@1.16.1
+  - @backstage/backend-openapi-utils@0.4.1
+  - @backstage/backend-plugin-api@1.1.1
+  - @backstage/catalog-client@1.9.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/plugin-catalog-common@1.1.3
+  - @backstage/plugin-catalog-node@1.15.1
+  - @backstage/plugin-events-node@0.4.7
+  - @backstage/plugin-permission-common@0.8.4
+  - @backstage/plugin-search-common@1.2.17
+
 ## 1.30.0-next.1
 
 ### Patch Changes

package/dist/deprecated.cjs.js

@@ -1,13 +1,150 @@
 '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 pluginCatalogNode = require('@backstage/plugin-catalog-node');
 var pluginSearchBackendModuleCatalog = require('@backstage/plugin-search-backend-module-catalog');
+var stream = require('stream');
 
 const locationSpecToMetadataName = pluginCatalogNode.locationSpecToMetadataName;
 const locationSpecToLocationEntity = pluginCatalogNode.locationSpecToLocationEntity;
 const processingResult = pluginCatalogNode.processingResult;
+var search;
+((search2) => {
+  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
+    }
+  };
+  search2.readCollatorConfigOptions = (configRoot) => {
+    const config = configRoot.getOptionalConfig(configKey);
+    if (!config) {
+      return defaults.collatorOptions;
+    }
+    return {
+      locationTemplate: config.getOptionalString("locationTemplate") ?? defaults.collatorOptions.locationTemplate,
+      filter: config.getOptional("filter") ?? defaults.collatorOptions.filter,
+      batchSize: config.getOptionalNumber("batchSize") ?? defaults.collatorOptions.batchSize
+    };
+  };
+  search2.getDocumentText = (entity) => {
+    const documentTexts = [];
+    if (entity.metadata.description) {
+      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(" : ");
+  };
+})(search || (search = {}));
 const defaultCatalogCollatorEntityTransformer = pluginSearchBackendModuleCatalog.defaultCatalogCollatorEntityTransformer;
+class DefaultCatalogCollatorFactory {
+  type = "software-catalog";
+  visibilityPermission = alpha.catalogEntityReadPermission;
+  locationTemplate;
+  filter;
+  batchSize;
+  catalogClient;
+  entityTransformer;
+  auth;
+  static fromConfig(configRoot, options) {
+    const configOptions = search.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 cursor = void 0;
+    do {
+      const { token } = await this.auth.getPluginRequestToken({
+        onBehalfOf: await this.auth.getOwnServiceCredentials(),
+        targetPluginId: "catalog"
+      });
+      const response = await this.catalogClient.queryEntities(
+        {
+          filter: this.filter,
+          limit: this.batchSize,
+          ...cursor ? { cursor } : {}
+        },
+        { token }
+      );
+      cursor = response.pageInfo.nextCursor;
+      entitiesRetrieved += response.items.length;
+      for (const entity of response.items) {
+        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
+          })
+        };
+      }
+    } while (cursor);
+  }
+  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.locationSpecToLocationEntity = locationSpecToLocationEntity;
 exports.locationSpecToMetadataName = locationSpecToMetadataName;

package/dist/deprecated.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"deprecated.cjs.js","sources":["../src/deprecated.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  type AnalyzeLocationEntityField as _AnalyzeLocationEntityField,\n  type AnalyzeLocationExistingEntity as _AnalyzeLocationExistingEntity,\n  type AnalyzeLocationGenerateEntity as _AnalyzeLocationGenerateEntity,\n  type AnalyzeLocationRequest as _AnalyzeLocationRequest,\n  type AnalyzeLocationResponse as _AnalyzeLocationResponse,\n  type LocationSpec as _LocationSpec,\n} from '@backstage/plugin-catalog-common';\nimport {\n  locationSpecToMetadataName as _locationSpecToMetadataName,\n  locationSpecToLocationEntity as _locationSpecToLocationEntity,\n  processingResult as _processingResult,\n  type EntitiesSearchFilter as _EntitiesSearchFilter,\n  type EntityFilter as _EntityFilter,\n  type DeferredEntity as _DeferredEntity,\n  type EntityRelationSpec as _EntityRelationSpec,\n  type CatalogProcessor as _CatalogProcessor,\n  type CatalogProcessorParser as _CatalogProcessorParser,\n  type CatalogProcessorCache as _CatalogProcessorCache,\n  type CatalogProcessorEmit as _CatalogProcessorEmit,\n  type CatalogProcessorLocationResult as _CatalogProcessorLocationResult,\n  type CatalogProcessorEntityResult as _CatalogProcessorEntityResult,\n  type CatalogProcessorRelationResult as _CatalogProcessorRelationResult,\n  type CatalogProcessorErrorResult as _CatalogProcessorErrorResult,\n  type CatalogProcessorRefreshKeysResult as _CatalogProcessorRefreshKeysResult,\n  type CatalogProcessorResult as _CatalogProcessorResult,\n  type EntityProvider as _EntityProvider,\n  type EntityProviderConnection as _EntityProviderConnection,\n  type EntityProviderMutation as _EntityProviderMutation,\n  type AnalyzeOptions as _AnalyzeOptions,\n  type PlaceholderResolver as _PlaceholderResolver,\n  type PlaceholderResolverParams as _PlaceholderResolverParams,\n  type PlaceholderResolverRead as _PlaceholderResolverRead,\n  type PlaceholderResolverResolveUrl as _PlaceholderResolverResolveUrl,\n  type LocationAnalyzer as _LocationAnalyzer,\n  type ScmLocationAnalyzer as _ScmLocationAnalyzer,\n} from '@backstage/plugin-catalog-node';\nimport {\n  defaultCatalogCollatorEntityTransformer as _defaultCatalogCollatorEntityTransformer,\n  type CatalogCollatorEntityTransformer as _CatalogCollatorEntityTransformer,\n} from '@backstage/plugin-search-backend-module-catalog';\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport const locationSpecToMetadataName = _locationSpecToMetadataName;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport const locationSpecToLocationEntity = _locationSpecToLocationEntity;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport const processingResult = _processingResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntitiesSearchFilter = _EntitiesSearchFilter;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntityFilter = _EntityFilter;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type DeferredEntity = _DeferredEntity;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntityRelationSpec = _EntityRelationSpec;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessor = _CatalogProcessor;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorParser = _CatalogProcessorParser;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorCache = _CatalogProcessorCache;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorEmit = _CatalogProcessorEmit;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorLocationResult = _CatalogProcessorLocationResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorEntityResult = _CatalogProcessorEntityResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorRelationResult = _CatalogProcessorRelationResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorErrorResult = _CatalogProcessorErrorResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorRefreshKeysResult =\n  _CatalogProcessorRefreshKeysResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorResult = _CatalogProcessorResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntityProvider = _EntityProvider;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntityProviderConnection = _EntityProviderConnection;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntityProviderMutation = _EntityProviderMutation;\n\n/**\n * Holds the entity location information.\n *\n * @remarks\n *\n *  `presence` flag: when using repo importer plugin, location is being created before the component yaml file is merged to the main branch.\n *  This flag is then set to indicate that the file can be not present.\n *  default value: 'required'.\n *\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type LocationSpec = _LocationSpec;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type AnalyzeOptions = _AnalyzeOptions;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type LocationAnalyzer = _LocationAnalyzer;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type ScmLocationAnalyzer = _ScmLocationAnalyzer;\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type PlaceholderResolver = _PlaceholderResolver;\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type PlaceholderResolverParams = _PlaceholderResolverParams;\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type PlaceholderResolverRead = _PlaceholderResolverRead;\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type PlaceholderResolverResolveUrl = _PlaceholderResolverResolveUrl;\n\n/**\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type AnalyzeLocationRequest = _AnalyzeLocationRequest;\n/**\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type AnalyzeLocationResponse = _AnalyzeLocationResponse;\n\n/**\n * If the folder pointed to already contained catalog info yaml files, they are\n * read and emitted like this so that the frontend can inform the user that it\n * located them and can make sure to register them as well if they weren't\n * already\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type AnalyzeLocationExistingEntity = _AnalyzeLocationExistingEntity;\n/**\n * This is some form of representation of what the analyzer could deduce.\n * We should probably have a chat about how this can best be conveyed to\n * the frontend. It'll probably contain a (possibly incomplete) entity, plus\n * enough info for the frontend to know what form data to show to the user\n * for overriding/completing the info.\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type AnalyzeLocationGenerateEntity = _AnalyzeLocationGenerateEntity;\n\n/**\n *\n * This is where I get really vague. Something like this perhaps? Or it could be\n * something like a json-schema that contains enough info for the frontend to\n * be able to present a form and explanations\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type AnalyzeLocationEntityField = _AnalyzeLocationEntityField;\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-search-backend-module-catalog` instead\n */\nexport const defaultCatalogCollatorEntityTransformer =\n  _defaultCatalogCollatorEntityTransformer;\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-search-backend-module-catalog` instead\n */\nexport type CatalogCollatorEntityTransformer =\n  _CatalogCollatorEntityTransformer;\n"],"names":["_locationSpecToMetadataName","_locationSpecToLocationEntity","_processingResult","_defaultCatalogCollatorEntityTransformer"],"mappings":";;;;;AA8DO,MAAM,0BAA6B,GAAAA;AAKnC,MAAM,4BAA+B,GAAAC;AAKrC,MAAM,gBAAmB,GAAAC;AA0LzB,MAAM,uCACX,GAAAC;;;;;;;"}
+{"version":3,"file":"deprecated.cjs.js","sources":["../src/deprecated.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  TokenManager,\n  createLegacyAuthAdapters,\n} from '@backstage/backend-common';\nimport { AuthService, DiscoveryService } from '@backstage/backend-plugin-api';\nimport {\n  CatalogApi,\n  CatalogClient,\n  EntityFilterQuery,\n  GetEntitiesRequest,\n} from '@backstage/catalog-client';\nimport {\n  Entity,\n  isGroupEntity,\n  isUserEntity,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport {\n  CatalogEntityDocument,\n  type AnalyzeLocationEntityField as _AnalyzeLocationEntityField,\n  type AnalyzeLocationExistingEntity as _AnalyzeLocationExistingEntity,\n  type AnalyzeLocationGenerateEntity as _AnalyzeLocationGenerateEntity,\n  type AnalyzeLocationRequest as _AnalyzeLocationRequest,\n  type AnalyzeLocationResponse as _AnalyzeLocationResponse,\n  type LocationSpec as _LocationSpec,\n} from '@backstage/plugin-catalog-common';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport {\n  locationSpecToMetadataName as _locationSpecToMetadataName,\n  locationSpecToLocationEntity as _locationSpecToLocationEntity,\n  processingResult as _processingResult,\n  type EntitiesSearchFilter as _EntitiesSearchFilter,\n  type EntityFilter as _EntityFilter,\n  type DeferredEntity as _DeferredEntity,\n  type EntityRelationSpec as _EntityRelationSpec,\n  type CatalogProcessor as _CatalogProcessor,\n  type CatalogProcessorParser as _CatalogProcessorParser,\n  type CatalogProcessorCache as _CatalogProcessorCache,\n  type CatalogProcessorEmit as _CatalogProcessorEmit,\n  type CatalogProcessorLocationResult as _CatalogProcessorLocationResult,\n  type CatalogProcessorEntityResult as _CatalogProcessorEntityResult,\n  type CatalogProcessorRelationResult as _CatalogProcessorRelationResult,\n  type CatalogProcessorErrorResult as _CatalogProcessorErrorResult,\n  type CatalogProcessorRefreshKeysResult as _CatalogProcessorRefreshKeysResult,\n  type CatalogProcessorResult as _CatalogProcessorResult,\n  type EntityProvider as _EntityProvider,\n  type EntityProviderConnection as _EntityProviderConnection,\n  type EntityProviderMutation as _EntityProviderMutation,\n  type AnalyzeOptions as _AnalyzeOptions,\n  type PlaceholderResolver as _PlaceholderResolver,\n  type PlaceholderResolverParams as _PlaceholderResolverParams,\n  type PlaceholderResolverRead as _PlaceholderResolverRead,\n  type PlaceholderResolverResolveUrl as _PlaceholderResolverResolveUrl,\n  type LocationAnalyzer as _LocationAnalyzer,\n  type ScmLocationAnalyzer as _ScmLocationAnalyzer,\n} from '@backstage/plugin-catalog-node';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport {\n  defaultCatalogCollatorEntityTransformer as _defaultCatalogCollatorEntityTransformer,\n  type CatalogCollatorEntityTransformer as _CatalogCollatorEntityTransformer,\n} from '@backstage/plugin-search-backend-module-catalog';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { Readable } from 'stream';\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport const locationSpecToMetadataName = _locationSpecToMetadataName;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport const locationSpecToLocationEntity = _locationSpecToLocationEntity;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport const processingResult = _processingResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntitiesSearchFilter = _EntitiesSearchFilter;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntityFilter = _EntityFilter;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type DeferredEntity = _DeferredEntity;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntityRelationSpec = _EntityRelationSpec;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessor = _CatalogProcessor;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorParser = _CatalogProcessorParser;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorCache = _CatalogProcessorCache;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorEmit = _CatalogProcessorEmit;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorLocationResult = _CatalogProcessorLocationResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorEntityResult = _CatalogProcessorEntityResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorRelationResult = _CatalogProcessorRelationResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorErrorResult = _CatalogProcessorErrorResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorRefreshKeysResult =\n  _CatalogProcessorRefreshKeysResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type CatalogProcessorResult = _CatalogProcessorResult;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntityProvider = _EntityProvider;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntityProviderConnection = _EntityProviderConnection;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type EntityProviderMutation = _EntityProviderMutation;\n\n/**\n * Holds the entity location information.\n *\n * @remarks\n *\n *  `presence` flag: when using repo importer plugin, location is being created before the component yaml file is merged to the main branch.\n *  This flag is then set to indicate that the file can be not present.\n *  default value: 'required'.\n *\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type LocationSpec = _LocationSpec;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type AnalyzeOptions = _AnalyzeOptions;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type LocationAnalyzer = _LocationAnalyzer;\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type ScmLocationAnalyzer = _ScmLocationAnalyzer;\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type PlaceholderResolver = _PlaceholderResolver;\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type PlaceholderResolverParams = _PlaceholderResolverParams;\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type PlaceholderResolverRead = _PlaceholderResolverRead;\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-catalog-node` instead\n */\nexport type PlaceholderResolverResolveUrl = _PlaceholderResolverResolveUrl;\n\n/**\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type AnalyzeLocationRequest = _AnalyzeLocationRequest;\n/**\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type AnalyzeLocationResponse = _AnalyzeLocationResponse;\n\n/**\n * If the folder pointed to already contained catalog info yaml files, they are\n * read and emitted like this so that the frontend can inform the user that it\n * located them and can make sure to register them as well if they weren't\n * already\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type AnalyzeLocationExistingEntity = _AnalyzeLocationExistingEntity;\n/**\n * This is some form of representation of what the analyzer could deduce.\n * We should probably have a chat about how this can best be conveyed to\n * the frontend. It'll probably contain a (possibly incomplete) entity, plus\n * enough info for the frontend to know what form data to show to the user\n * for overriding/completing the info.\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type AnalyzeLocationGenerateEntity = _AnalyzeLocationGenerateEntity;\n\n/**\n *\n * This is where I get really vague. Something like this perhaps? Or it could be\n * something like a json-schema that contains enough info for the frontend to\n * be able to present a form and explanations\n * @public\n * @deprecated use the same type from `@backstage/plugin-catalog-common` instead\n */\nexport type AnalyzeLocationEntityField = _AnalyzeLocationEntityField;\n\nnamespace search {\n  const configKey = 'search.collators.catalog';\n\n  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\n  export const readCollatorConfigOptions = (\n    configRoot: Config,\n  ): {\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.getOptional<EntityFilterQuery>('filter') ??\n        defaults.collatorOptions.filter,\n      batchSize:\n        config.getOptionalNumber('batchSize') ??\n        defaults.collatorOptions.batchSize,\n    };\n  };\n\n  export const getDocumentText = (entity: Entity): string => {\n    const documentTexts: string[] = [];\n    if (entity.metadata.description) {\n      documentTexts.push(entity.metadata.description);\n    }\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\n/**\n * @public\n * @deprecated import from `@backstage/plugin-search-backend-module-catalog` instead\n */\nexport const defaultCatalogCollatorEntityTransformer =\n  _defaultCatalogCollatorEntityTransformer;\n\n/**\n * @public\n * @deprecated This is no longer supported since the new backend system migration\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 = search.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 cursor: string | undefined = undefined;\n\n    do {\n      const { token } = await this.auth.getPluginRequestToken({\n        onBehalfOf: await this.auth.getOwnServiceCredentials(),\n        targetPluginId: 'catalog',\n      });\n      const response = await this.catalogClient.queryEntities(\n        {\n          filter: this.filter,\n          limit: this.batchSize,\n          ...(cursor ? { cursor } : {}),\n        },\n        { token },\n      );\n      cursor = response.pageInfo.nextCursor;\n      entitiesRetrieved += response.items.length;\n\n      for (const entity of response.items) {\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    } while (cursor);\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\n/**\n * @public\n * @deprecated This is no longer supported since the new backend system migration\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  // TODO(freben): Change to required CatalogService instead when fully migrated to the new backend system.\n  catalogClient?: CatalogApi;\n  /**\n   * Allows you to customize how entities are shaped into documents.\n   */\n  entityTransformer?: CatalogCollatorEntityTransformer;\n};\n\n/**\n * @public\n * @deprecated import from `@backstage/plugin-search-backend-module-catalog` instead\n */\nexport type CatalogCollatorEntityTransformer =\n  _CatalogCollatorEntityTransformer;\n"],"names":["_locationSpecToMetadataName","_locationSpecToLocationEntity","_processingResult","search","isUserEntity","isGroupEntity","_defaultCatalogCollatorEntityTransformer","catalogEntityReadPermission","createLegacyAuthAdapters","catalogClient","CatalogClient","Readable","stringifyEntityRef"],"mappings":";;;;;;;;;;AAqFO,MAAM,0BAA6B,GAAAA;AAKnC,MAAM,4BAA+B,GAAAC;AAKrC,MAAM,gBAAmB,GAAAC;AAsLhC,IAAU,MAAA;AAAA,CAAV,CAAUC,OAAV,KAAA;AACE,EAAA,MAAM,SAAY,GAAA,0BAAA;AAElB,EAAA,MAAM,QAAW,GAAA;AAAA,IACf,QAAU,EAAA;AAAA,MACR,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,MACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,MACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE;AAAA,KAC7B;AAAA,IACA,eAAiB,EAAA;AAAA,MACf,gBAAkB,EAAA,iCAAA;AAAA,MAClB,MAAQ,EAAA,KAAA,CAAA;AAAA,MACR,SAAW,EAAA;AAAA;AACb,GACF;AAEO,EAAMA,OAAAA,CAAA,yBAA4B,GAAA,CACvC,UAKG,KAAA;AACH,IAAM,MAAA,MAAA,GAAS,UAAW,CAAA,iBAAA,CAAkB,SAAS,CAAA;AACrD,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAA,OAAO,QAAS,CAAA,eAAA;AAAA;AAGlB,IAAO,OAAA;AAAA,MACL,kBACE,MAAO,CAAA,iBAAA,CAAkB,kBAAkB,CAAA,IAC3C,SAAS,eAAgB,CAAA,gBAAA;AAAA,MAC3B,QACE,MAAO,CAAA,WAAA,CAA+B,QAAQ,CAAA,IAC9C,SAAS,eAAgB,CAAA,MAAA;AAAA,MAC3B,WACE,MAAO,CAAA,iBAAA,CAAkB,WAAW,CAAA,IACpC,SAAS,eAAgB,CAAA;AAAA,KAC7B;AAAA,GACF;AAEO,EAAMA,OAAAA,CAAA,eAAkB,GAAA,CAAC,MAA2B,KAAA;AACzD,IAAA,MAAM,gBAA0B,EAAC;AACjC,IAAI,IAAA,MAAA,CAAO,SAAS,WAAa,EAAA;AAC/B,MAAc,aAAA,CAAA,IAAA,CAAK,MAAO,CAAA,QAAA,CAAS,WAAW,CAAA;AAAA;AAGhD,IAAA,IAAIC,yBAAa,CAAA,MAAM,CAAK,IAAAC,0BAAA,CAAc,MAAM,CAAG,EAAA;AACjD,MAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,WAAa,EAAA;AACrC,QAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,WAAW,CAAA;AAAA;AACpD;AAGF,IAAI,IAAAD,yBAAA,CAAa,MAAM,CAAG,EAAA;AACxB,MAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,KAAO,EAAA;AAC/B,QAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,KAAK,CAAA;AAAA;AAC9C;AAGF,IAAO,OAAA,aAAA,CAAc,KAAK,KAAK,CAAA;AAAA,GACjC;AAAA,CA5DQ,EAAA,MAAA,KAAA,MAAA,GAAA,EAAA,CAAA,CAAA;AAmEH,MAAM,uCACX,GAAAE;AAMK,MAAM,6BAAiE,CAAA;AAAA,EAC5D,IAAO,GAAA,kBAAA;AAAA,EACP,oBACd,GAAAC,iCAAA;AAAA,EAEM,gBAAA;AAAA,EACA,MAAA;AAAA,EACA,SAAA;AAAA,EACS,aAAA;AAAA,EACT,iBAAA;AAAA,EACA,IAAA;AAAA,EAER,OAAO,UACL,CAAA,UAAA,EACA,OACA,EAAA;AACA,IAAM,MAAA,aAAA,GAAgB,MAAO,CAAA,yBAAA,CAA0B,UAAU,CAAA;AACjE,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;AAAA,KACvB,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,KACxB,CAAA;AAAA;AACH,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;AAAA,KACE,GAAA,OAAA;AAEJ,IAAA,IAAA,CAAK,gBAAmB,GAAA,gBAAA;AACxB,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA;AACd,IAAA,IAAA,CAAK,SAAY,GAAA,SAAA;AACjB,IAAA,IAAA,CAAK,gBACHA,eAAiB,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,WAAW,CAAA;AAChE,IAAA,IAAA,CAAK,oBACH,iBAAqB,IAAA,uCAAA;AACvB,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA;AAAA;AACd,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA;AAAA;AACrC,EAEA,OAAe,OAAiD,GAAA;AAC9D,IAAA,IAAI,iBAAoB,GAAA,CAAA;AACxB,IAAA,IAAI,MAA6B,GAAA,KAAA,CAAA;AAEjC,IAAG,GAAA;AACD,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;AAAA,OACjB,CAAA;AACD,MAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,aAAc,CAAA,aAAA;AAAA,QACxC;AAAA,UACE,QAAQ,IAAK,CAAA,MAAA;AAAA,UACb,OAAO,IAAK,CAAA,SAAA;AAAA,UACZ,GAAI,MAAA,GAAS,EAAE,MAAA,KAAW;AAAC,SAC7B;AAAA,QACA,EAAE,KAAM;AAAA,OACV;AACA,MAAA,MAAA,GAAS,SAAS,QAAS,CAAA,UAAA;AAC3B,MAAA,iBAAA,IAAqB,SAAS,KAAM,CAAA,MAAA;AAEpC,MAAW,KAAA,MAAA,MAAA,IAAU,SAAS,KAAO,EAAA;AACnC,QAAM,MAAA;AAAA,UACJ,GAAG,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAAA,UAChC,aAAe,EAAA;AAAA,YACb,WAAA,EAAaC,gCAAmB,MAAM;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;AAAA,WACvB;AAAA,SACH;AAAA;AACF,KACO,QAAA,MAAA;AAAA;AACX,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA;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;AAAA;AAGhD,IAAA,OAAO,UAAU,WAAY,EAAA;AAAA;AAEjC;;;;;;;;"}

package/dist/index.cjs.js

@@ -34,6 +34,7 @@ exports.transformLegacyPolicyToProcessor = transformLegacyPolicyToProcessor.tran
 exports.createRandomProcessingInterval = refresh.createRandomProcessingInterval;
 exports.DefaultCatalogCollator = DefaultCatalogCollator.DefaultCatalogCollator;
 exports.CatalogBuilder = CatalogBuilder.CatalogBuilder;
+exports.DefaultCatalogCollatorFactory = deprecated.DefaultCatalogCollatorFactory;
 exports.defaultCatalogCollatorEntityTransformer = deprecated.defaultCatalogCollatorEntityTransformer;
 exports.locationSpecToLocationEntity = deprecated.locationSpecToLocationEntity;
 exports.locationSpecToMetadataName = deprecated.locationSpecToMetadataName;

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { LoggerService, UrlReaderService, DiscoveryService, DatabaseService, RootConfigService, PermissionsService, SchedulerService, AuthService, HttpAuthService } from '@backstage/backend-plugin-api';
-import * as _backstage_catalog_model from '@backstage/catalog-model';
 import { Entity, EntityPolicy, Validators } from '@backstage/catalog-model';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { LocationSpec as LocationSpec$1, CatalogEntityDocument, AnalyzeLocationRequest as AnalyzeLocationRequest$1, AnalyzeLocationResponse as AnalyzeLocationResponse$1, AnalyzeLocationExistingEntity as AnalyzeLocationExistingEntity$1, AnalyzeLocationGenerateEntity as AnalyzeLocationGenerateEntity$1, AnalyzeLocationEntityField as AnalyzeLocationEntityField$1 } from '@backstage/plugin-catalog-common';
@@ -14,6 +13,8 @@ import { Router } from 'express';
 import { PermissionRule } from '@backstage/plugin-permission-node';
 import { EventBroker, EventsService } from '@backstage/plugin-events-node';
 import { CatalogCollatorEntityTransformer as CatalogCollatorEntityTransformer$1 } from '@backstage/plugin-search-backend-module-catalog';
+import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
+import { Readable } from 'stream';
 
 /**
  * Catalog plugin
@@ -455,7 +456,7 @@ declare const processingResult: Readonly<{
     readonly inputError: (atLocation: LocationSpec$1, message: string) => CatalogProcessorResult$1;
     readonly generalError: (atLocation: LocationSpec$1, message: string) => CatalogProcessorResult$1;
     readonly location: (newLocation: LocationSpec$1) => CatalogProcessorResult$1;
-    readonly entity: (atLocation: LocationSpec$1, newEntity: _backstage_catalog_model.Entity) => CatalogProcessorResult$1;
+    readonly entity: (atLocation: LocationSpec$1, newEntity: Entity) => CatalogProcessorResult$1;
     readonly relation: (spec: EntityRelationSpec$1) => CatalogProcessorResult$1;
     readonly refresh: (key: string) => CatalogProcessorResult$1;
 }>;
@@ -635,6 +636,51 @@ type AnalyzeLocationEntityField = AnalyzeLocationEntityField$1;
  * @deprecated import from `@backstage/plugin-search-backend-module-catalog` instead
  */
 declare const defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer$1;
+/**
+ * @public
+ * @deprecated This is no longer supported since the new backend system migration
+ */
+declare class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
+    readonly type = "software-catalog";
+    readonly visibilityPermission: Permission;
+    private locationTemplate;
+    private filter?;
+    private batchSize;
+    private readonly catalogClient;
+    private entityTransformer;
+    private auth;
+    static fromConfig(configRoot: Config, options: DefaultCatalogCollatorFactoryOptions): DefaultCatalogCollatorFactory;
+    private constructor();
+    getCollator(): Promise<Readable>;
+    private execute;
+    private applyArgsToFormat;
+}
+/**
+ * @public
+ * @deprecated This is no longer supported since the new backend system migration
+ */
+type DefaultCatalogCollatorFactoryOptions = {
+    auth?: AuthService;
+    discovery: DiscoveryService;
+    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
  * @deprecated import from `@backstage/plugin-search-backend-module-catalog` instead
@@ -649,4 +695,4 @@ declare const CATALOG_ERRORS_TOPIC = "experimental.catalog.errors";
 /** @public */
 declare function parseEntityYaml(data: Buffer, location: LocationSpec$1): Iterable<CatalogProcessorResult$1>;
 
-export { type AnalyzeLocationEntityField, type AnalyzeLocationExistingEntity, type AnalyzeLocationGenerateEntity, type AnalyzeLocationRequest, type AnalyzeLocationResponse, type AnalyzeOptions, AnnotateLocationEntityProcessor, AnnotateScmSlugEntityProcessor, BuiltinKindsEntityProcessor, CATALOG_CONFLICTS_TOPIC, CATALOG_ERRORS_TOPIC, CatalogBuilder, type CatalogCollatorEntityTransformer, type CatalogEnvironment, type CatalogPermissionRuleInput, type CatalogProcessingEngine, type CatalogProcessor, type CatalogProcessorCache, type CatalogProcessorEmit, type CatalogProcessorEntityResult, type CatalogProcessorErrorResult, type CatalogProcessorLocationResult, type CatalogProcessorParser, type CatalogProcessorRefreshKeysResult, type CatalogProcessorRelationResult, type CatalogProcessorResult, CodeOwnersProcessor, DefaultCatalogCollator, type DeferredEntity, type EntitiesSearchFilter, type EntityFilter, type EntityProvider, type EntityProviderConnection, type EntityProviderMutation, type EntityRelationSpec, FileReaderProcessor, type LocationAnalyzer, LocationEntityProcessor, type LocationEntityProcessorOptions, type LocationSpec, PlaceholderProcessor, type PlaceholderProcessorOptions, type PlaceholderResolver, type PlaceholderResolverParams, type PlaceholderResolverRead, type PlaceholderResolverResolveUrl, type ProcessingIntervalFunction, type ScmLocationAnalyzer, UrlReaderProcessor, createRandomProcessingInterval, catalogPlugin as default, defaultCatalogCollatorEntityTransformer, locationSpecToLocationEntity, locationSpecToMetadataName, parseEntityYaml, processingResult, transformLegacyPolicyToProcessor };
+export { type AnalyzeLocationEntityField, type AnalyzeLocationExistingEntity, type AnalyzeLocationGenerateEntity, type AnalyzeLocationRequest, type AnalyzeLocationResponse, type AnalyzeOptions, AnnotateLocationEntityProcessor, AnnotateScmSlugEntityProcessor, BuiltinKindsEntityProcessor, CATALOG_CONFLICTS_TOPIC, CATALOG_ERRORS_TOPIC, CatalogBuilder, type CatalogCollatorEntityTransformer, type CatalogEnvironment, type CatalogPermissionRuleInput, type CatalogProcessingEngine, type CatalogProcessor, type CatalogProcessorCache, type CatalogProcessorEmit, type CatalogProcessorEntityResult, type CatalogProcessorErrorResult, type CatalogProcessorLocationResult, type CatalogProcessorParser, type CatalogProcessorRefreshKeysResult, type CatalogProcessorRelationResult, type CatalogProcessorResult, CodeOwnersProcessor, DefaultCatalogCollator, DefaultCatalogCollatorFactory, type DefaultCatalogCollatorFactoryOptions, type DeferredEntity, type EntitiesSearchFilter, type EntityFilter, type EntityProvider, type EntityProviderConnection, type EntityProviderMutation, type EntityRelationSpec, FileReaderProcessor, type LocationAnalyzer, LocationEntityProcessor, type LocationEntityProcessorOptions, type LocationSpec, PlaceholderProcessor, type PlaceholderProcessorOptions, type PlaceholderResolver, type PlaceholderResolverParams, type PlaceholderResolverRead, type PlaceholderResolverResolveUrl, type ProcessingIntervalFunction, type ScmLocationAnalyzer, UrlReaderProcessor, createRandomProcessingInterval, catalogPlugin as default, defaultCatalogCollatorEntityTransformer, locationSpecToLocationEntity, locationSpecToMetadataName, parseEntityYaml, processingResult, transformLegacyPolicyToProcessor };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend",
-  "version": "1.30.0-next.1",
+  "version": "1.30.0",
   "description": "The Backstage backend plugin that provides the Backstage catalog",
   "backstage": {
     "role": "backend-plugin",
@@ -72,20 +72,21 @@
   },
   "dependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-openapi-utils": "0.4.1-next.1",
-    "@backstage/backend-plugin-api": "1.1.1-next.1",
-    "@backstage/catalog-client": "1.9.1-next.0",
-    "@backstage/catalog-model": "1.7.3-next.0",
-    "@backstage/config": "1.3.2-next.0",
-    "@backstage/errors": "1.2.7-next.0",
-    "@backstage/integration": "1.16.1-next.0",
-    "@backstage/plugin-catalog-common": "1.1.3-next.0",
-    "@backstage/plugin-catalog-node": "1.15.1-next.1",
-    "@backstage/plugin-events-node": "0.4.7-next.1",
-    "@backstage/plugin-permission-common": "0.8.4-next.0",
-    "@backstage/plugin-permission-node": "0.8.7-next.1",
-    "@backstage/plugin-search-backend-module-catalog": "0.3.0-next.1",
-    "@backstage/types": "1.2.1-next.0",
+    "@backstage/backend-openapi-utils": "^0.4.1",
+    "@backstage/backend-plugin-api": "^1.1.1",
+    "@backstage/catalog-client": "^1.9.1",
+    "@backstage/catalog-model": "^1.7.3",
+    "@backstage/config": "^1.3.2",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/integration": "^1.16.1",
+    "@backstage/plugin-catalog-common": "^1.1.3",
+    "@backstage/plugin-catalog-node": "^1.15.1",
+    "@backstage/plugin-events-node": "^0.4.7",
+    "@backstage/plugin-permission-common": "^0.8.4",
+    "@backstage/plugin-permission-node": "^0.8.7",
+    "@backstage/plugin-search-backend-module-catalog": "^0.3.0",
+    "@backstage/plugin-search-common": "^1.2.17",
+    "@backstage/types": "^1.2.1",
     "@opentelemetry/api": "^1.9.0",
     "@types/express": "^4.17.6",
     "codeowners-utils": "^1.0.2",
@@ -107,11 +108,11 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "0.7.0-next.1",
-    "@backstage/backend-test-utils": "1.2.1-next.1",
-    "@backstage/cli": "0.29.5-next.1",
-    "@backstage/plugin-permission-common": "0.8.4-next.0",
-    "@backstage/repo-tools": "0.12.1-next.1",
+    "@backstage/backend-defaults": "^0.7.0",
+    "@backstage/backend-test-utils": "^1.2.1",
+    "@backstage/cli": "^0.29.5",
+    "@backstage/plugin-permission-common": "^0.8.4",
+    "@backstage/repo-tools": "^0.12.1",
     "@types/core-js": "^2.5.4",
     "@types/git-url-parse": "^9.0.0",
     "@types/glob": "^8.0.0",