@backstage/plugin-catalog-backend 1.7.2-next.0 → 1.7.2-next.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/plugin-catalog-backend
 
+## 1.7.2-next.1
+
+### Patch Changes
+
+- 2380506364: The process of adding or modifying fields in the software-catalog search index has been simplified. For more details, see [how to customize fields in the Software Catalog index](https://backstage.io/docs/features/search/how-to-guides#how-to-customize-fields-in-the-software-catalog-index).
+- 9573651919: The previous migration that adds the `search.original_value` column may leave some of the entities not updated. Add a migration script to trigger a reprocessing of the entities.
+- fc73f6aae5: Switched the order of reprocessing statements retroactively in migrations. This only improves the experience for those who at a later time perform a large upgrade of an old Backstage installation.
+- Updated dependencies
+  - @backstage/backend-common@0.18.2-next.1
+  - @backstage/backend-plugin-api@0.3.2-next.1
+  - @backstage/catalog-client@1.3.1-next.0
+  - @backstage/catalog-model@1.1.6-next.0
+  - @backstage/config@1.0.6
+  - @backstage/errors@1.1.4
+  - @backstage/integration@1.4.2
+  - @backstage/types@1.0.2
+  - @backstage/plugin-catalog-common@1.0.11-next.0
+  - @backstage/plugin-catalog-node@1.3.3-next.1
+  - @backstage/plugin-permission-common@0.7.3
+  - @backstage/plugin-permission-node@0.7.5-next.1
+  - @backstage/plugin-scaffolder-common@1.2.5-next.0
+  - @backstage/plugin-search-common@1.2.1
+
 ## 1.7.2-next.0
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend",
-  "version": "1.7.2-next.0",
+  "version": "1.7.2-next.1",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -338,6 +338,9 @@ export declare class CatalogBuilder {
     private checkMissingExternalProcessors;
 }
 
+/** @public */
+export declare type CatalogCollatorEntityTransformer = (entity: Entity) => Omit<CatalogEntityDocument, 'location' | 'authorization'>;
+
 /**
  * These conditions are used when creating conditional decisions for catalog
  * entities that are returned by authorization policies.
@@ -524,20 +527,24 @@ export declare class DefaultCatalogCollator {
     execute(): Promise<CatalogEntityDocument[]>;
 }
 
+/** @public */
+export declare const defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer;
+
 /** @public */
 export declare class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
-    readonly type: string;
+    readonly type = "software-catalog";
     readonly visibilityPermission: Permission;
     private locationTemplate;
     private filter?;
     private batchSize;
     private readonly catalogClient;
     private tokenManager;
+    private entityTransformer;
     static fromConfig(_config: Config, options: DefaultCatalogCollatorFactoryOptions): DefaultCatalogCollatorFactory;
     private constructor();
     getCollator(): Promise<Readable>;
-    private applyArgsToFormat;
     private execute;
+    private applyArgsToFormat;
 }
 
 /** @public */
@@ -548,6 +555,7 @@ export declare type DefaultCatalogCollatorFactoryOptions = {
     filter?: GetEntitiesRequest['filter'];
     batchSize?: number;
     catalogClient?: CatalogApi;
+    entityTransformer?: CatalogCollatorEntityTransformer;
 };
 
 export { DeferredEntity }

package/dist/index.beta.d.ts

@@ -330,6 +330,9 @@ export declare class CatalogBuilder {
     private checkMissingExternalProcessors;
 }
 
+/** @public */
+export declare type CatalogCollatorEntityTransformer = (entity: Entity) => Omit<CatalogEntityDocument, 'location' | 'authorization'>;
+
 /* Excluded from this release type: catalogConditions */
 
 /** @public */
@@ -439,20 +442,24 @@ export declare class DefaultCatalogCollator {
     execute(): Promise<CatalogEntityDocument[]>;
 }
 
+/** @public */
+export declare const defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer;
+
 /** @public */
 export declare class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
-    readonly type: string;
+    readonly type = "software-catalog";
     readonly visibilityPermission: Permission;
     private locationTemplate;
     private filter?;
     private batchSize;
     private readonly catalogClient;
     private tokenManager;
+    private entityTransformer;
     static fromConfig(_config: Config, options: DefaultCatalogCollatorFactoryOptions): DefaultCatalogCollatorFactory;
     private constructor();
     getCollator(): Promise<Readable>;
-    private applyArgsToFormat;
     private execute;
+    private applyArgsToFormat;
 }
 
 /** @public */
@@ -463,6 +470,7 @@ export declare type DefaultCatalogCollatorFactoryOptions = {
     filter?: GetEntitiesRequest['filter'];
     batchSize?: number;
     catalogClient?: CatalogApi;
+    entityTransformer?: CatalogCollatorEntityTransformer;
 };
 
 export { DeferredEntity }

package/dist/index.cjs.js

@@ -952,7 +952,7 @@ function createRandomProcessingInterval(options) {
   };
 }
 
-function getDocumentText(entity) {
+const getDocumentText = (entity) => {
   var _a, _b;
   const documentTexts = [];
   documentTexts.push(entity.metadata.description || "");
@@ -962,7 +962,20 @@ function getDocumentText(entity) {
     }
   }
   return documentTexts.join(" : ");
-}
+};
+const defaultCatalogCollatorEntityTransformer = (entity) => {
+  var _a, _b, _c, _d, _e, _f, _g;
+  return {
+    title: (_a = entity.metadata.title) != null ? _a : entity.metadata.name,
+    text: getDocumentText(entity),
+    componentType: ((_c = (_b = entity.spec) == null ? void 0 : _b.type) == null ? void 0 : _c.toString()) || "other",
+    type: ((_e = (_d = entity.spec) == null ? void 0 : _d.type) == null ? void 0 : _e.toString()) || "other",
+    namespace: entity.metadata.namespace || "default",
+    kind: entity.kind,
+    lifecycle: ((_f = entity.spec) == null ? void 0 : _f.lifecycle) || "",
+    owner: ((_g = entity.spec) == null ? void 0 : _g.owner) || ""
+  };
+};
 
 class DefaultCatalogCollatorFactory {
   constructor(options) {
@@ -974,13 +987,15 @@ class DefaultCatalogCollatorFactory {
       locationTemplate,
       filter,
       catalogClient: catalogClient$1,
-      tokenManager
+      tokenManager,
+      entityTransformer
     } = options;
     this.locationTemplate = locationTemplate || "/catalog/:namespace/:kind/:name";
     this.filter = filter;
     this.batchSize = batchSize || 500;
     this.catalogClient = catalogClient$1 || new catalogClient.CatalogClient({ discoveryApi: discovery });
     this.tokenManager = tokenManager;
+    this.entityTransformer = entityTransformer != null ? entityTransformer : defaultCatalogCollatorEntityTransformer;
   }
   static fromConfig(_config, options) {
     return new DefaultCatalogCollatorFactory(options);
@@ -988,15 +1003,7 @@ class DefaultCatalogCollatorFactory {
   async getCollator() {
     return stream.Readable.from(this.execute());
   }
-  applyArgsToFormat(format, args) {
-    let formatted = format;
-    for (const [key, value] of Object.entries(args)) {
-      formatted = formatted.replace(`:${key}`, value);
-    }
-    return formatted.toLowerCase();
-  }
   async *execute() {
-    var _a, _b, _c, _d, _e, _f, _g;
     const { token } = await this.tokenManager.getToken();
     let entitiesRetrieved = 0;
     let moreEntitiesToGet = true;
@@ -1013,26 +1020,26 @@ class DefaultCatalogCollatorFactory {
       entitiesRetrieved += entities.length;
       for (const entity of entities) {
         yield {
-          title: (_a = entity.metadata.title) != null ? _a : entity.metadata.name,
+          ...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
-          }),
-          text: getDocumentText(entity),
-          componentType: ((_c = (_b = entity.spec) == null ? void 0 : _b.type) == null ? void 0 : _c.toString()) || "other",
-          type: ((_e = (_d = entity.spec) == null ? void 0 : _d.type) == null ? void 0 : _e.toString()) || "other",
-          namespace: entity.metadata.namespace || "default",
-          kind: entity.kind,
-          lifecycle: ((_f = entity.spec) == null ? void 0 : _f.lifecycle) || "",
-          owner: ((_g = entity.spec) == null ? void 0 : _g.owner) || "",
-          authorization: {
-            resourceRef: catalogModel.stringifyEntityRef(entity)
-          }
+          })
         };
       }
     }
   }
+  applyArgsToFormat(format, args) {
+    let formatted = format;
+    for (const [key, value] of Object.entries(args)) {
+      formatted = formatted.replace(`:${key}`, value);
+    }
+    return formatted.toLowerCase();
+  }
 }
 
 class DefaultCatalogCollator {