@sprucelabs/mercury-chunking-emitter 1.5.3 → 2.0.1

package/build/chunkingEmitter/ChunkingEmitter.d.ts

@@ -21,10 +21,10 @@ interface ChunkingEmitterOptions {
 export type ChunkingEmitterEmitOptions = {
     eventName: EventName;
     items?: Record<string, any>[];
-    cursor?: BatchCursor<Record<string, any>>;
+    batchCursor?: BatchCursor<Record<string, any>>;
     payloadKey: string;
     target?: Record<string, any>;
-    /** will stop any running operations that match the key */
+    /** will kill any running operations that match the key */
     uniqueKey?: string;
 };
 export interface ChunkingEmitter {

package/build/chunkingEmitter/ChunkingEmitter.js

@@ -21,13 +21,20 @@ class ChunkingEmitterImpl {
         return new ((_a = this.Class) !== null && _a !== void 0 ? _a : this)(options);
     }
     async emit(options) {
-        const { items, cursor, uniqueKey: unqiueKey, } = (0, schema_1.assertOptions)(options, ['eventName', 'payloadKey']);
+        const { items, batchCursor: cursor, uniqueKey: unqiueKey, } = (0, schema_1.assertOptions)(options, ['eventName', 'payloadKey']);
         this.totalErrors = 0;
         if (!items && !cursor) {
             throw new schema_1.SchemaError({
                 code: 'MISSING_PARAMETERS',
-                parameters: ['items', 'cursor'],
-                friendlyMessage: `You have to pass either 'items' or a 'cursor' to emit.`,
+                parameters: ['items', 'batchCursor'],
+                friendlyMessage: `You have to pass either 'items' or a 'batchCursor' to emit.`,
+            });
+        }
+        else if (items && cursor) {
+            throw new schema_1.SchemaError({
+                code: 'INVALID_PARAMETERS',
+                parameters: ['items', 'batchCursor'],
+                friendlyMessage: `You can only pass either 'items' or a 'batchCursor' to emit, not both.`,
             });
         }
         const match = this.emitters.find((e) => unqiueKey && e.matchesKey(unqiueKey));

package/build/chunkingEmitter/MockChunkingEmitter.d.ts

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

package/build/chunkingEmitter/MockChunkingEmitter.js

@@ -16,12 +16,13 @@ class MockChunkingEmitter {
         this.lastInstance = undefined;
     }
     async emit(options) {
-        const { eventName, items, payloadKey, target } = options;
+        const { eventName, items, payloadKey, target, batchCursor: cursor, } = options;
         this.didEmit = true;
         this.emittedEventName = eventName;
         this.emittedItems = items;
         this.emittedPayloadKey = payloadKey;
         this.emittedTarget = target;
+        this.emittedCursor = cursor;
     }
     assertDidEmitTarget(target) {
         test_utils_1.assert.isEqualDeep(this.emittedTarget, target, 'You did not chunkingEmitter.emit(...) the expected target!');
@@ -30,6 +31,9 @@ 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'}`);
     }
+    assertDidReceiveCursor() {
+        test_utils_1.assert.isTruthy(this.emittedCursor, 'You did not chunkingEmitter.emit(...) the expected batch cursor!');
+    }
     getTotalErrors() {
         return 0;
     }

package/build/chunkingEmitter/SingleChunkEmitter.d.ts

@@ -24,7 +24,7 @@ export default class SingleChunkEmitter {
     private Cursor;
 }
 interface SingleChunkEmitterOptions {
-    cursor?: BatchCursor<Record<string, any>>;
+    batchCursor?: BatchCursor<Record<string, any>>;
     items?: Record<string, any>[];
     payloadKey: string;
     target?: Record<string, any>;

package/build/chunkingEmitter/SingleChunkEmitter.js

@@ -12,7 +12,7 @@ class SingleChunkEmitter {
     constructor(options) {
         this.totalErrors = 0;
         this.isKilled = false;
-        const { cursor, items, payloadKey, target, eventName, chunkSize, client, uniqueKey, log, } = options;
+        const { batchCursor: cursor, items, payloadKey, target, eventName, chunkSize, client, uniqueKey, log, } = options;
         this.cursor = cursor;
         this.uniqueKey = uniqueKey;
         this.items = items;

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

@@ -21,10 +21,10 @@ interface ChunkingEmitterOptions {
 export type ChunkingEmitterEmitOptions = {
     eventName: EventName;
     items?: Record<string, any>[];
-    cursor?: BatchCursor<Record<string, any>>;
+    batchCursor?: BatchCursor<Record<string, any>>;
     payloadKey: string;
     target?: Record<string, any>;
-    /** will stop any running operations that match the key */
+    /** will kill any running operations that match the key */
     uniqueKey?: string;
 };
 export interface ChunkingEmitter {

package/build/esm/chunkingEmitter/ChunkingEmitter.js

@@ -28,13 +28,20 @@ export default class ChunkingEmitterImpl {
     }
     emit(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { items, cursor, uniqueKey: unqiueKey, } = assertOptions(options, ['eventName', 'payloadKey']);
+            const { items, batchCursor: cursor, uniqueKey: unqiueKey, } = assertOptions(options, ['eventName', 'payloadKey']);
             this.totalErrors = 0;
             if (!items && !cursor) {
                 throw new SchemaError({
                     code: 'MISSING_PARAMETERS',
-                    parameters: ['items', 'cursor'],
-                    friendlyMessage: `You have to pass either 'items' or a 'cursor' to emit.`,
+                    parameters: ['items', 'batchCursor'],
+                    friendlyMessage: `You have to pass either 'items' or a 'batchCursor' to emit.`,
+                });
+            }
+            else if (items && cursor) {
+                throw new SchemaError({
+                    code: 'INVALID_PARAMETERS',
+                    parameters: ['items', 'batchCursor'],
+                    friendlyMessage: `You can only pass either 'items' or a 'batchCursor' to emit, not both.`,
                 });
             }
             const match = this.emitters.find((e) => unqiueKey && e.matchesKey(unqiueKey));

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

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

package/build/esm/chunkingEmitter/MockChunkingEmitter.js

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

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

@@ -24,7 +24,7 @@ export default class SingleChunkEmitter {
     private Cursor;
 }
 interface SingleChunkEmitterOptions {
-    cursor?: BatchCursor<Record<string, any>>;
+    batchCursor?: BatchCursor<Record<string, any>>;
     items?: Record<string, any>[];
     payloadKey: string;
     target?: Record<string, any>;

package/build/esm/chunkingEmitter/SingleChunkEmitter.js

@@ -19,7 +19,7 @@ export default class SingleChunkEmitter {
     constructor(options) {
         this.totalErrors = 0;
         this.isKilled = false;
-        const { cursor, items, payloadKey, target, eventName, chunkSize, client, uniqueKey, log, } = options;
+        const { batchCursor: cursor, items, payloadKey, target, eventName, chunkSize, client, uniqueKey, log, } = options;
         this.cursor = cursor;
         this.uniqueKey = uniqueKey;
         this.items = items;

package/package.json

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