From c01b1f0ac527f4f76da29acca8b98846d09f00be Mon Sep 17 00:00:00 2001
From: Damon Kaswell <damon.kaswell1@hp.com>
Date: Fri, 13 Jan 2023 08:33:46 -0800
Subject: [PATCH] Rename 'deltaMapper' to 'onEvent'

Signed-off-by: Damon Kaswell <damon.kaswell1@hp.com>
---
 .../api-report.md                                    | 12 ++++++------
 .../src/engine/IncrementalIngestionEngine.ts         |  4 ++--
 .../src/types.ts                                     |  9 ++++++---
 3 files changed, 14 insertions(+), 11 deletions(-)

diff --git a/plugins/catalog-backend-module-incremental-ingestion/api-report.md b/plugins/catalog-backend-module-incremental-ingestion/api-report.md
index c79d07ad26..1052afda74 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/api-report.md
+++ b/plugins/catalog-backend-module-incremental-ingestion/api-report.md
@@ -50,7 +50,12 @@ export class IncrementalCatalogBuilder {
 // @public
 export interface IncrementalEntityProvider<TCursor, TContext> {
   around(burst: (context: TContext) => Promise<void>): Promise<void>;
-  deltaMapper?: (payload: unknown) => {
+  getProviderName(): string;
+  next(
+    context: TContext,
+    cursor?: TCursor,
+  ): Promise<EntityIteratorResult<TCursor>>;
+  onEvent?: (payload: unknown) => {
     delta:
       | {
           added: DeferredEntity[];
@@ -60,11 +65,6 @@ export interface IncrementalEntityProvider<TCursor, TContext> {
         }
       | undefined;
   };
-  getProviderName(): string;
-  next(
-    context: TContext,
-    cursor?: TCursor,
-  ): Promise<EntityIteratorResult<TCursor>>;
 }
 
 // @public (undocumented)
diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts b/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts
index 311af0f6de..a21092a838 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts
+++ b/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts
@@ -347,11 +347,11 @@ export class IncrementalIngestionEngine
       `incremental-engine: Received ${this.providerEventTopic} event`,
     );
 
-    if (!provider.deltaMapper) {
+    if (!provider.onEvent) {
       return;
     }
 
-    const update = provider.deltaMapper(eventPayload);
+    const update = provider.onEvent(eventPayload);
 
     if (update.delta) {
       if (update.delta.added.length > 0) {
diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/types.ts b/plugins/catalog-backend-module-incremental-ingestion/src/types.ts
index 24919e2647..315757d88a 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/src/types.ts
+++ b/plugins/catalog-backend-module-incremental-ingestion/src/types.ts
@@ -77,10 +77,13 @@ export interface IncrementalEntityProvider<TCursor, TContext> {
   around(burst: (context: TContext) => Promise<void>): Promise<void>;
 
   /**
-   * If present, this method maps incoming payloads to apply updates
-   * outside of the incremental ingestion schedule.
+   * If present, this method accepts an incoming event, and maps the
+   * payload to an object containing a delta mutation.
+   *
+   * If a delta is present, the incremental entity provider will apply
+   * it automatically.
    */
-  deltaMapper?: (payload: unknown) => {
+  onEvent?: (payload: unknown) => {
     delta:
       | {
           added: DeferredEntity[];