@backstage/plugin-catalog-backend-module-incremental-ingestion 0.1.2 → 0.2.0-next.1

package/CHANGELOG.md

@@ -1,16 +1,40 @@
 # @backstage/plugin-catalog-backend-module-incremental-ingestion
 
-## 0.1.2
+## 0.2.0-next.1
 
 ### Patch Changes
 
+- b7e36660d5: Return `EventSubscriber` from `addIncrementalEntityProvider` to hook up to `EventsBackend`
 - Updated dependencies
-  - @backstage/backend-common@0.18.1
-  - @backstage/backend-test-utils@0.1.33
-  - @backstage/backend-tasks@0.4.2
-  - @backstage/plugin-catalog-backend@1.7.1
-  - @backstage/plugin-catalog-node@1.3.2
-  - @backstage/backend-plugin-api@0.3.1
+  - @backstage/plugin-catalog-backend@1.7.2-next.1
+  - @backstage/backend-common@0.18.2-next.1
+  - @backstage/backend-plugin-api@0.3.2-next.1
+  - @backstage/backend-tasks@0.4.3-next.1
+  - @backstage/backend-test-utils@0.1.34-next.1
+  - @backstage/catalog-model@1.1.6-next.0
+  - @backstage/config@1.0.6
+  - @backstage/errors@1.1.4
+  - @backstage/plugin-catalog-node@1.3.3-next.1
+  - @backstage/plugin-events-node@0.2.3-next.1
+  - @backstage/plugin-permission-common@0.7.3
+
+## 0.2.0-next.0
+
+### Minor Changes
+
+- 1ba120faa3: Added new mechanism to handle deltas in incremental providers
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@1.1.6-next.0
+  - @backstage/backend-test-utils@0.1.34-next.0
+  - @backstage/backend-common@0.18.2-next.0
+  - @backstage/plugin-catalog-backend@1.7.2-next.0
+  - @backstage/plugin-catalog-node@1.3.3-next.0
+  - @backstage/backend-tasks@0.4.3-next.0
+  - @backstage/backend-plugin-api@0.3.2-next.0
+  - @backstage/plugin-events-node@0.2.3-next.0
 
 ## 0.1.1
 

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -11,6 +11,8 @@ import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
 import type { Config } from '@backstage/config';
 import type { DeferredEntity } from '@backstage/plugin-catalog-backend';
 import type { DurationObjectUnits } from 'luxon';
+import { EventParams } from '@backstage/plugin-events-node';
+import { EventSubscriber } from '@backstage/plugin-events-node';
 import type { Logger } from 'winston';
 import type { PermissionEvaluator } from '@backstage/plugin-permission-common';
 import type { PluginDatabaseManager } from '@backstage/backend-common';
@@ -52,7 +54,7 @@ export declare class IncrementalCatalogBuilder {
     build(): Promise<{
         incrementalAdminRouter: Router;
     }>;
-    addIncrementalEntityProvider<TCursor, TContext>(provider: IncrementalEntityProvider<TCursor, TContext>, options: IncrementalEntityProviderOptions): void;
+    addIncrementalEntityProvider<TCursor, TContext>(provider: IncrementalEntityProvider<TCursor, TContext>, options: IncrementalEntityProviderOptions): EventSubscriber;
 }
 
 /**
@@ -93,6 +95,35 @@ export declare interface IncrementalEntityProvider<TCursor, TContext> {
      * @param burst - a function which performs a series of iterations
      */
     around(burst: (context: TContext) => Promise<void>): Promise<void>;
+    /**
+     * If set, the IncrementalEntityProvider will receive and respond to
+     * events.
+     *
+     * This system acts as a wrapper for the Backstage events bus, and
+     * requires the events backend to function. It does not provide its
+     * own events backend. See {@link https://github.com/backstage/backstage/tree/master/plugins/events-backend}.
+     */
+    eventHandler?: {
+        /**
+         * This method accepts an incoming event for the provider, and
+         * optionally maps the payload to an object containing a delta
+         * mutation.
+         *
+         * If a valid delta is returned by this method, it will be ingested
+         * automatically by the provider.
+         */
+        onEvent: (params: EventParams) => undefined | {
+            added: DeferredEntity[];
+            removed: {
+                entityRef: string;
+            }[];
+        };
+        /**
+         * This method returns an array of topics for the IncrementalEntityProvider
+         * to respond to.
+         */
+        supportsEventTopics: () => string[];
+    };
 }
 
 /** @public */

package/dist/index.beta.d.ts

@@ -11,6 +11,8 @@ import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
 import type { Config } from '@backstage/config';
 import type { DeferredEntity } from '@backstage/plugin-catalog-backend';
 import type { DurationObjectUnits } from 'luxon';
+import { EventParams } from '@backstage/plugin-events-node';
+import { EventSubscriber } from '@backstage/plugin-events-node';
 import type { Logger } from 'winston';
 import type { PermissionEvaluator } from '@backstage/plugin-permission-common';
 import type { PluginDatabaseManager } from '@backstage/backend-common';
@@ -52,7 +54,7 @@ export declare class IncrementalCatalogBuilder {
     build(): Promise<{
         incrementalAdminRouter: Router;
     }>;
-    addIncrementalEntityProvider<TCursor, TContext>(provider: IncrementalEntityProvider<TCursor, TContext>, options: IncrementalEntityProviderOptions): void;
+    addIncrementalEntityProvider<TCursor, TContext>(provider: IncrementalEntityProvider<TCursor, TContext>, options: IncrementalEntityProviderOptions): EventSubscriber;
 }
 
 /**
@@ -93,6 +95,35 @@ export declare interface IncrementalEntityProvider<TCursor, TContext> {
      * @param burst - a function which performs a series of iterations
      */
     around(burst: (context: TContext) => Promise<void>): Promise<void>;
+    /**
+     * If set, the IncrementalEntityProvider will receive and respond to
+     * events.
+     *
+     * This system acts as a wrapper for the Backstage events bus, and
+     * requires the events backend to function. It does not provide its
+     * own events backend. See {@link https://github.com/backstage/backstage/tree/master/plugins/events-backend}.
+     */
+    eventHandler?: {
+        /**
+         * This method accepts an incoming event for the provider, and
+         * optionally maps the payload to an object containing a delta
+         * mutation.
+         *
+         * If a valid delta is returned by this method, it will be ingested
+         * automatically by the provider.
+         */
+        onEvent: (params: EventParams) => undefined | {
+            added: DeferredEntity[];
+            removed: {
+                entityRef: string;
+            }[];
+        };
+        /**
+         * This method returns an array of topics for the IncrementalEntityProvider
+         * to respond to.
+         */
+        supportsEventTopics: () => string[];
+    };
 }
 
 /** @public */