@backstage/plugin-catalog-node 1.19.0-next.1 → 1.19.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @backstage/plugin-catalog-node
 
+## 1.19.0
+
+### Minor Changes
+
+- 0e9ec44: Introduced new `streamEntities` async generator method for the catalog.
+
+  Catalog API and Catalog Service now includes a `streamEntities` method that allows for streaming entities from the catalog.
+  This method is designed to handle large datasets efficiently by processing entities in a stream rather than loading them
+  all into memory at once. This is useful when you need to fetch a large number of entities but do not want to use pagination
+  or fetch all entities at once.
+
+  Example usage:
+
+  ```ts
+  const pageStream = catalogClient.streamEntities({ pageSize: 100 }, { token });
+  for await (const page of pageStream) {
+    // Handle page of entities
+    for (const entity of page) {
+      console.log(entity);
+    }
+  }
+  ```
+
+### Patch Changes
+
+- 2bbd24f: Order catalog processors by priority.
+
+  This change enables the ordering of catalog processors by their priority,
+  allowing for more control over the catalog processing sequence.
+  The default priority is set to 20, and processors can be assigned a custom
+  priority to influence their execution order. Lower number indicates higher priority.
+  The priority can be set by implementing the `getPriority` method in the processor class
+  or by adding a `catalog.processors.<processorName>.priority` configuration
+  in the `app-config.yaml` file. The configuration takes precedence over the method.
+
+- Updated dependencies
+  - @backstage/catalog-client@1.12.0
+  - @backstage/types@1.2.2
+  - @backstage/backend-plugin-api@1.4.3
+  - @backstage/plugin-permission-node@0.10.4
+
 ## 1.19.0-next.1
 
 ### Minor Changes

package/dist/index.d.ts

@@ -130,6 +130,13 @@ type CatalogProcessor = {
      * @returns The same entity or a modified version of it
      */
     postProcessEntity?(entity: Entity, location: LocationSpec$1, emit: CatalogProcessorEmit, cache: CatalogProcessorCache): Promise<Entity>;
+    /**
+     * Returns a processor priority, which is used to determine the order in which
+     * processors are run. The default priority is 20, and lower value means
+     * that the processor runs earlier.
+     * @returns A number representing the priority of the processor.
+     */
+    getPriority?(): number;
 };
 /**
  * A parser, that is able to take the raw catalog descriptor data and turn it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-node",
-  "version": "1.19.0-next.1",
+  "version": "1.19.0",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
   "backstage": {
     "role": "node-library",
@@ -72,20 +72,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.4.3-next.0",
-    "@backstage/catalog-client": "1.12.0-next.0",
-    "@backstage/catalog-model": "1.7.5",
-    "@backstage/errors": "1.2.7",
-    "@backstage/plugin-catalog-common": "1.1.5",
-    "@backstage/plugin-permission-common": "0.9.1",
-    "@backstage/plugin-permission-node": "0.10.4-next.0",
-    "@backstage/types": "1.2.1",
+    "@backstage/backend-plugin-api": "^1.4.3",
+    "@backstage/catalog-client": "^1.12.0",
+    "@backstage/catalog-model": "^1.7.5",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/plugin-catalog-common": "^1.1.5",
+    "@backstage/plugin-permission-common": "^0.9.1",
+    "@backstage/plugin-permission-node": "^0.10.4",
+    "@backstage/types": "^1.2.2",
     "lodash": "^4.17.21",
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.9.0-next.1",
-    "@backstage/cli": "0.34.2-next.2",
+    "@backstage/backend-test-utils": "^1.9.0",
+    "@backstage/cli": "^0.34.2",
     "msw": "^1.0.0"
   }
 }