@sprucelabs/mercury-chunking-emitter 2.1.0 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,12 +8,14 @@ export default class MockChunkingEmitter implements ChunkingEmitter {
8
8
  static lastInstance?: MockChunkingEmitter;
9
9
  private emittedTarget?;
10
10
  private emittedCursor?;
11
+ private emittedPayload?;
11
12
  constructor();
12
13
  static getLastInstance(): MockChunkingEmitter;
13
14
  static reset(): void;
14
15
  emit(options: ChunkingEmitterEmitOptions): Promise<void>;
15
16
  assertDidEmitTarget(target: Record<string, any>): void;
16
17
  assertDidEmitPayloadKey(payloadKey: string): void;
18
+ assertEmittedPayloadIncludes(payload: Record<string, any>): void;
17
19
  assertDidReceiveCursor(): void;
18
20
  getTotalErrors(): number;
19
21
  assertEmittedItems(items: Record<string, any>[]): void;
@@ -1,8 +1,11 @@
1
1
  "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
2
5
  Object.defineProperty(exports, "__esModule", { value: true });
3
6
  const mercury_client_1 = require("@sprucelabs/mercury-client");
4
7
  const test_utils_1 = require("@sprucelabs/test-utils");
5
- const chunkFieldDefinition_1 = require("./chunkFieldDefinition");
8
+ const chunkFieldDefinition_1 = __importDefault(require("./chunkFieldDefinition"));
6
9
  class MockChunkingEmitter {
7
10
  constructor() {
8
11
  this.didEmit = false;
@@ -16,13 +19,14 @@ class MockChunkingEmitter {
16
19
  this.lastInstance = undefined;
17
20
  }
18
21
  async emit(options) {
19
- const { eventName, items, payloadKey, target, batchCursor: cursor, } = options;
22
+ const { eventName, items, payloadKey, target, batchCursor: cursor, payload, } = options;
20
23
  this.didEmit = true;
21
24
  this.emittedEventName = eventName;
22
25
  this.emittedItems = items;
23
26
  this.emittedPayloadKey = payloadKey;
24
27
  this.emittedTarget = target;
25
28
  this.emittedCursor = cursor;
29
+ this.emittedPayload = payload;
26
30
  }
27
31
  assertDidEmitTarget(target) {
28
32
  test_utils_1.assert.isEqualDeep(this.emittedTarget, target, 'You did not chunkingEmitter.emit(...) the expected target!');
@@ -31,6 +35,10 @@ class MockChunkingEmitter {
31
35
  this.assertDidEmit();
32
36
  test_utils_1.assert.isEqual(this.emittedPayloadKey, payloadKey, `I expected chunkingEmitter.emit() with payloadKey '${payloadKey}'! But you emitted ${this.emittedPayloadKey || 'nothing'}`);
33
37
  }
38
+ assertEmittedPayloadIncludes(payload) {
39
+ this.assertDidEmit();
40
+ test_utils_1.assert.doesInclude(this.emittedPayload, payload);
41
+ }
34
42
  assertDidReceiveCursor() {
35
43
  test_utils_1.assert.isTruthy(this.emittedCursor, 'You did not chunkingEmitter.emit(...) the expected batch cursor!');
36
44
  }
@@ -56,7 +64,7 @@ class MockChunkingEmitter {
56
64
  // @ts-ignore
57
65
  const chunkField = (_f = (_e = (_d = (_c = payload === null || payload === void 0 ? void 0 : payload.payload) === null || _c === void 0 ? void 0 : _c.options) === null || _d === void 0 ? void 0 : _d.schema) === null || _e === void 0 ? void 0 : _e.fields) === null || _f === void 0 ? void 0 : _f.chunk;
58
66
  test_utils_1.assert.isTruthy(chunkField, 'Your event does not conform to the chunking signature. Please add a chunk field to your event payload. Add a field to your payload called chunk: chunkFieldDefinition()');
59
- test_utils_1.assert.isEqualDeep(chunkField, (0, chunkFieldDefinition_1.chunkFieldDefinition)(), 'Your chunk field is there but not properly formed. Use chunkFieldDefinition() to define it.');
67
+ test_utils_1.assert.isEqualDeep(chunkField, (0, chunkFieldDefinition_1.default)(), 'Your chunk field is there but not properly formed. Use chunkFieldDefinition() to define it.');
60
68
  }
61
69
  assertDidNotEmit() {
62
70
  test_utils_1.assert.isFalse(this.didEmit, `You called chunkingEmitter.emit(...) but you should not have!`);
@@ -1,2 +1,2 @@
1
1
  import { SchemaFieldFieldDefinition } from '@sprucelabs/schema';
2
- export declare function chunkFieldDefinition(): SchemaFieldFieldDefinition;
2
+ export default function chunkFieldDefinition(): SchemaFieldFieldDefinition;
@@ -3,7 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.chunkFieldDefinition = void 0;
7
6
  const chunkPaging_schema_1 = __importDefault(require("./../.spruce/schemas/mercuryChunkingEmitter/v2023_10_21/chunkPaging.schema"));
8
7
  function chunkFieldDefinition() {
9
8
  return {
@@ -14,4 +13,4 @@ function chunkFieldDefinition() {
14
13
  },
15
14
  };
16
15
  }
17
- exports.chunkFieldDefinition = chunkFieldDefinition;
16
+ exports.default = chunkFieldDefinition;
@@ -8,12 +8,14 @@ export default class MockChunkingEmitter implements ChunkingEmitter {
8
8
  static lastInstance?: MockChunkingEmitter;
9
9
  private emittedTarget?;
10
10
  private emittedCursor?;
11
+ private emittedPayload?;
11
12
  constructor();
12
13
  static getLastInstance(): MockChunkingEmitter;
13
14
  static reset(): void;
14
15
  emit(options: ChunkingEmitterEmitOptions): Promise<void>;
15
16
  assertDidEmitTarget(target: Record<string, any>): void;
16
17
  assertDidEmitPayloadKey(payloadKey: string): void;
18
+ assertEmittedPayloadIncludes(payload: Record<string, any>): void;
17
19
  assertDidReceiveCursor(): void;
18
20
  getTotalErrors(): number;
19
21
  assertEmittedItems(items: Record<string, any>[]): void;
@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
9
9
  };
10
10
  import { MercuryTestClient } from '@sprucelabs/mercury-client';
11
11
  import { assert } from '@sprucelabs/test-utils';
12
- import { chunkFieldDefinition } from './chunkFieldDefinition.js';
12
+ import chunkFieldDefinition from './chunkFieldDefinition.js';
13
13
  export default class MockChunkingEmitter {
14
14
  constructor() {
15
15
  this.didEmit = false;
@@ -24,13 +24,14 @@ export default class MockChunkingEmitter {
24
24
  }
25
25
  emit(options) {
26
26
  return __awaiter(this, void 0, void 0, function* () {
27
- const { eventName, items, payloadKey, target, batchCursor: cursor, } = options;
27
+ const { eventName, items, payloadKey, target, batchCursor: cursor, payload, } = options;
28
28
  this.didEmit = true;
29
29
  this.emittedEventName = eventName;
30
30
  this.emittedItems = items;
31
31
  this.emittedPayloadKey = payloadKey;
32
32
  this.emittedTarget = target;
33
33
  this.emittedCursor = cursor;
34
+ this.emittedPayload = payload;
34
35
  });
35
36
  }
36
37
  assertDidEmitTarget(target) {
@@ -40,6 +41,10 @@ export default class MockChunkingEmitter {
40
41
  this.assertDidEmit();
41
42
  assert.isEqual(this.emittedPayloadKey, payloadKey, `I expected chunkingEmitter.emit() with payloadKey '${payloadKey}'! But you emitted ${this.emittedPayloadKey || 'nothing'}`);
42
43
  }
44
+ assertEmittedPayloadIncludes(payload) {
45
+ this.assertDidEmit();
46
+ assert.doesInclude(this.emittedPayload, payload);
47
+ }
43
48
  assertDidReceiveCursor() {
44
49
  assert.isTruthy(this.emittedCursor, 'You did not chunkingEmitter.emit(...) the expected batch cursor!');
45
50
  }
@@ -1,2 +1,2 @@
1
1
  import { SchemaFieldFieldDefinition } from '@sprucelabs/schema';
2
- export declare function chunkFieldDefinition(): SchemaFieldFieldDefinition;
2
+ export default function chunkFieldDefinition(): SchemaFieldFieldDefinition;
@@ -1,5 +1,5 @@
1
1
  import chunkPagingSchema from './../.spruce/schemas/mercuryChunkingEmitter/v2023_10_21/chunkPaging.schema.js';
2
- export function chunkFieldDefinition() {
2
+ export default function chunkFieldDefinition() {
3
3
  return {
4
4
  type: 'schema',
5
5
  isRequired: true,
@@ -2,3 +2,4 @@ import { default as ChunkingEmitterImpl } from './chunkingEmitter/ChunkingEmitte
2
2
  export default ChunkingEmitterImpl;
3
3
  export { ChunkingEmitter } from './chunkingEmitter/ChunkingEmitter';
4
4
  export { default as MockChunkingEmitter } from './chunkingEmitter/MockChunkingEmitter';
5
+ export { default as chunkFieldDefinition } from './chunkingEmitter/chunkFieldDefinition';
@@ -1,3 +1,4 @@
1
1
  import { default as ChunkingEmitterImpl } from './chunkingEmitter/ChunkingEmitter.js';
2
2
  export default ChunkingEmitterImpl;
3
3
  export { default as MockChunkingEmitter } from './chunkingEmitter/MockChunkingEmitter.js';
4
+ export { default as chunkFieldDefinition } from './chunkingEmitter/chunkFieldDefinition.js';
package/build/index.d.ts CHANGED
@@ -2,3 +2,4 @@ import { default as ChunkingEmitterImpl } from './chunkingEmitter/ChunkingEmitte
2
2
  export default ChunkingEmitterImpl;
3
3
  export { ChunkingEmitter } from './chunkingEmitter/ChunkingEmitter';
4
4
  export { default as MockChunkingEmitter } from './chunkingEmitter/MockChunkingEmitter';
5
+ export { default as chunkFieldDefinition } from './chunkingEmitter/chunkFieldDefinition';
package/build/index.js CHANGED
@@ -3,8 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.MockChunkingEmitter = void 0;
6
+ exports.chunkFieldDefinition = exports.MockChunkingEmitter = void 0;
7
7
  const ChunkingEmitter_1 = __importDefault(require("./chunkingEmitter/ChunkingEmitter"));
8
8
  exports.default = ChunkingEmitter_1.default;
9
9
  var MockChunkingEmitter_1 = require("./chunkingEmitter/MockChunkingEmitter");
10
10
  Object.defineProperty(exports, "MockChunkingEmitter", { enumerable: true, get: function () { return __importDefault(MockChunkingEmitter_1).default; } });
11
+ var chunkFieldDefinition_1 = require("./chunkingEmitter/chunkFieldDefinition");
12
+ Object.defineProperty(exports, "chunkFieldDefinition", { enumerable: true, get: function () { return __importDefault(chunkFieldDefinition_1).default; } });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sprucelabs/mercury-chunking-emitter",
3
- "version": "2.1.0",
3
+ "version": "2.2.1",
4
4
  "files": [
5
5
  "build/**/*",
6
6
  "!build/__tests__",