@sprucelabs/mercury-chunking-emitter 2.0.3 → 2.2.0

package/build/chunkingEmitter/ChunkingEmitter.d.ts

@@ -23,6 +23,7 @@ export type ChunkingEmitterEmitOptions = {
     items?: Record<string, any>[];
     batchCursor?: BatchCursor<Record<string, any>>;
     payloadKey: string;
+    payload?: Record<string, any>;
     target?: Record<string, any>;
     /** will kill any running operations that match the key */
     uniqueKey?: string;

package/build/chunkingEmitter/MockChunkingEmitter.d.ts

@@ -8,12 +8,14 @@ export default class MockChunkingEmitter implements ChunkingEmitter {
     static lastInstance?: MockChunkingEmitter;
     private emittedTarget?;
     private emittedCursor?;
+    private emittedPayload?;
     constructor();
     static getLastInstance(): MockChunkingEmitter;
     static reset(): void;
     emit(options: ChunkingEmitterEmitOptions): Promise<void>;
     assertDidEmitTarget(target: Record<string, any>): void;
     assertDidEmitPayloadKey(payloadKey: string): void;
+    assertEmittedPayloadIncludes(payload: Record<string, any>): void;
     assertDidReceiveCursor(): void;
     getTotalErrors(): number;
     assertEmittedItems(items: Record<string, any>[]): void;

package/build/chunkingEmitter/MockChunkingEmitter.js

@@ -16,13 +16,14 @@ class MockChunkingEmitter {
         this.lastInstance = undefined;
     }
     async emit(options) {
-        const { eventName, items, payloadKey, target, batchCursor: cursor, } = options;
+        const { eventName, items, payloadKey, target, batchCursor: cursor, payload, } = options;
         this.didEmit = true;
         this.emittedEventName = eventName;
         this.emittedItems = items;
         this.emittedPayloadKey = payloadKey;
         this.emittedTarget = target;
         this.emittedCursor = cursor;
+        this.emittedPayload = payload;
     }
     assertDidEmitTarget(target) {
         test_utils_1.assert.isEqualDeep(this.emittedTarget, target, 'You did not chunkingEmitter.emit(...) the expected target!');
@@ -31,6 +32,10 @@ class MockChunkingEmitter {
         this.assertDidEmit();
         test_utils_1.assert.isEqual(this.emittedPayloadKey, payloadKey, `I expected chunkingEmitter.emit() with payloadKey '${payloadKey}'! But you emitted ${this.emittedPayloadKey || 'nothing'}`);
     }
+    assertEmittedPayloadIncludes(payload) {
+        this.assertDidEmit();
+        test_utils_1.assert.doesInclude(this.emittedPayload, payload);
+    }
     assertDidReceiveCursor() {
         test_utils_1.assert.isTruthy(this.emittedCursor, 'You did not chunkingEmitter.emit(...) the expected batch cursor!');
     }

package/build/chunkingEmitter/SingleChunkEmitter.d.ts

@@ -15,6 +15,7 @@ export default class SingleChunkEmitter {
     private log;
     totalErrors: number;
     private isKilled;
+    private payload?;
     constructor(options: SingleChunkEmitterOptions);
     matchesKey(key: string): boolean;
     getTotalErrors(): number;
@@ -27,6 +28,7 @@ interface SingleChunkEmitterOptions {
     batchCursor?: BatchCursor<Record<string, any>>;
     items?: Record<string, any>[];
     payloadKey: string;
+    payload?: Record<string, any>;
     target?: Record<string, any>;
     eventName: EventName;
     chunkSize: number;

package/build/chunkingEmitter/SingleChunkEmitter.js

@@ -12,7 +12,7 @@ class SingleChunkEmitter {
     constructor(options) {
         this.totalErrors = 0;
         this.isKilled = false;
-        const { batchCursor: cursor, items, payloadKey, target, eventName, chunkSize, client, uniqueKey, log, } = options;
+        const { batchCursor: cursor, items, payloadKey, target, eventName, chunkSize, client, uniqueKey, log, payload, } = options;
         this.cursor = cursor;
         this.uniqueKey = uniqueKey;
         this.items = items;
@@ -21,6 +21,7 @@ class SingleChunkEmitter {
         this.eventName = eventName;
         this.chunkSize = chunkSize;
         this.client = client;
+        this.payload = payload;
         this.log = log.buildLog('Emitter');
     }
     matchesKey(key) {
@@ -70,13 +71,10 @@ class SingleChunkEmitter {
     async emitChunk(options) {
         const { chunk, current } = options;
         let targetAndPayload = {
-            payload: {
-                [this.payloadKey]: chunk,
-                chunk: {
+            payload: Object.assign(Object.assign({ [this.payloadKey]: chunk }, this.payload), { chunk: {
                     current,
                     total: this.total,
-                },
-            },
+                } }),
         };
         if (this.target) {
             targetAndPayload.target = this.target;

package/build/esm/chunkingEmitter/ChunkingEmitter.d.ts

@@ -23,6 +23,7 @@ export type ChunkingEmitterEmitOptions = {
     items?: Record<string, any>[];
     batchCursor?: BatchCursor<Record<string, any>>;
     payloadKey: string;
+    payload?: Record<string, any>;
     target?: Record<string, any>;
     /** will kill any running operations that match the key */
     uniqueKey?: string;

package/build/esm/chunkingEmitter/MockChunkingEmitter.d.ts

@@ -8,12 +8,14 @@ export default class MockChunkingEmitter implements ChunkingEmitter {
     static lastInstance?: MockChunkingEmitter;
     private emittedTarget?;
     private emittedCursor?;
+    private emittedPayload?;
     constructor();
     static getLastInstance(): MockChunkingEmitter;
     static reset(): void;
     emit(options: ChunkingEmitterEmitOptions): Promise<void>;
     assertDidEmitTarget(target: Record<string, any>): void;
     assertDidEmitPayloadKey(payloadKey: string): void;
+    assertEmittedPayloadIncludes(payload: Record<string, any>): void;
     assertDidReceiveCursor(): void;
     getTotalErrors(): number;
     assertEmittedItems(items: Record<string, any>[]): void;

package/build/esm/chunkingEmitter/MockChunkingEmitter.js

@@ -24,13 +24,14 @@ export default class MockChunkingEmitter {
     }
     emit(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { eventName, items, payloadKey, target, batchCursor: cursor, } = options;
+            const { eventName, items, payloadKey, target, batchCursor: cursor, payload, } = options;
             this.didEmit = true;
             this.emittedEventName = eventName;
             this.emittedItems = items;
             this.emittedPayloadKey = payloadKey;
             this.emittedTarget = target;
             this.emittedCursor = cursor;
+            this.emittedPayload = payload;
         });
     }
     assertDidEmitTarget(target) {
@@ -40,6 +41,10 @@ export default class MockChunkingEmitter {
         this.assertDidEmit();
         assert.isEqual(this.emittedPayloadKey, payloadKey, `I expected chunkingEmitter.emit() with payloadKey '${payloadKey}'! But you emitted ${this.emittedPayloadKey || 'nothing'}`);
     }
+    assertEmittedPayloadIncludes(payload) {
+        this.assertDidEmit();
+        assert.doesInclude(this.emittedPayload, payload);
+    }
     assertDidReceiveCursor() {
         assert.isTruthy(this.emittedCursor, 'You did not chunkingEmitter.emit(...) the expected batch cursor!');
     }

package/build/esm/chunkingEmitter/SingleChunkEmitter.d.ts

@@ -15,6 +15,7 @@ export default class SingleChunkEmitter {
     private log;
     totalErrors: number;
     private isKilled;
+    private payload?;
     constructor(options: SingleChunkEmitterOptions);
     matchesKey(key: string): boolean;
     getTotalErrors(): number;
@@ -27,6 +28,7 @@ interface SingleChunkEmitterOptions {
     batchCursor?: BatchCursor<Record<string, any>>;
     items?: Record<string, any>[];
     payloadKey: string;
+    payload?: Record<string, any>;
     target?: Record<string, any>;
     eventName: EventName;
     chunkSize: number;

package/build/esm/chunkingEmitter/SingleChunkEmitter.js

@@ -19,7 +19,7 @@ export default class SingleChunkEmitter {
     constructor(options) {
         this.totalErrors = 0;
         this.isKilled = false;
-        const { batchCursor: cursor, items, payloadKey, target, eventName, chunkSize, client, uniqueKey, log, } = options;
+        const { batchCursor: cursor, items, payloadKey, target, eventName, chunkSize, client, uniqueKey, log, payload, } = options;
         this.cursor = cursor;
         this.uniqueKey = uniqueKey;
         this.items = items;
@@ -28,6 +28,7 @@ export default class SingleChunkEmitter {
         this.eventName = eventName;
         this.chunkSize = chunkSize;
         this.client = client;
+        this.payload = payload;
         this.log = log.buildLog('Emitter');
     }
     matchesKey(key) {
@@ -82,13 +83,10 @@ export default class SingleChunkEmitter {
         return __awaiter(this, void 0, void 0, function* () {
             const { chunk, current } = options;
             let targetAndPayload = {
-                payload: {
-                    [this.payloadKey]: chunk,
-                    chunk: {
+                payload: Object.assign(Object.assign({ [this.payloadKey]: chunk }, this.payload), { chunk: {
                         current,
                         total: this.total,
-                    },
-                },
+                    } }),
             };
             if (this.target) {
                 targetAndPayload.target = this.target;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sprucelabs/mercury-chunking-emitter",
-  "version": "2.0.3",
+  "version": "2.2.0",
   "files": [
     "build/**/*",
     "!build/__tests__",