@sprucelabs/mercury-chunking-emitter 1.1.0 → 1.1.2

package/build/esm/chunkingEmitter/ChunkingEmitter.js

@@ -0,0 +1,81 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { assertOptions } from '@sprucelabs/schema';
+import { buildLog } from '@sprucelabs/spruce-skill-utils';
+export default class ChunkingEmitterImpl {
+    constructor(options) {
+        this.log = buildLog('ChunkingEmitter');
+        this.totalErrors = 0;
+        const { client, chunkSize } = assertOptions(options, ['client']);
+        this.client = client;
+        this.chunkSize = chunkSize !== null && chunkSize !== void 0 ? chunkSize : 10;
+    }
+    static Emitter(options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            assertOptions(options, ['client']);
+            return new ((_a = this.Class) !== null && _a !== void 0 ? _a : this)(options);
+        });
+    }
+    emit(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { eventName, items, payloadKey, target } = assertOptions(options, [
+                'eventName',
+                'items',
+                'payloadKey',
+            ]);
+            this.totalErrors = 0;
+            const chunks = this.splitItemsIntoChunks(items);
+            let current = 0;
+            for (const chunk of chunks) {
+                try {
+                    let targetAndPayload = {
+                        payload: {
+                            [payloadKey]: chunk,
+                            chunk: {
+                                current: current++,
+                                total: chunks.length,
+                            },
+                        },
+                    };
+                    if (target) {
+                        targetAndPayload.target = target;
+                    }
+                    yield this.client.emitAndFlattenResponses(eventName, targetAndPayload);
+                }
+                catch (err) {
+                    this.log.error('Failed to emit chunk', err);
+                    this.totalErrors++;
+                }
+            }
+        });
+    }
+    static reset() {
+        this.Class = undefined;
+    }
+    splitItemsIntoChunks(items) {
+        const chunks = [];
+        let index = 0;
+        for (const item of items) {
+            if (!chunks[index]) {
+                chunks[index] = [];
+            }
+            if (chunks[index].length === this.chunkSize) {
+                index++;
+                chunks[index] = [];
+            }
+            chunks[index].push(item);
+        }
+        return chunks;
+    }
+    getTotalErrors() {
+        return this.totalErrors;
+    }
+}

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

@@ -0,0 +1,23 @@
+import { EventName } from '@sprucelabs/mercury-types';
+import { ChunkingEmitter } from './ChunkingEmitter';
+export default class MockChunkingEmitter implements ChunkingEmitter {
+    private didEmit;
+    private emittedEventName?;
+    private emittedItems?;
+    private emittedPayloadKey?;
+    static lastInstance?: MockChunkingEmitter;
+    constructor();
+    static getLastInstance(): MockChunkingEmitter;
+    static reset(): void;
+    emit(options: {
+        eventName: EventName;
+        items: Record<string, unknown>[];
+        payloadKey: string;
+    }): Promise<void>;
+    assertDidEmitPayloadKey(payloadKey: string): void;
+    getTotalErrors(): number;
+    assertEmittedItems(items: Record<string, any>[]): void;
+    assertDidEmit(): void;
+    assertDidEmitEventNamed(fqen: EventName): void;
+    assertEventHonorsChunkingSignature(fqen: EventName): void;
+}

package/build/esm/chunkingEmitter/MockChunkingEmitter.js

@@ -0,0 +1,62 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { MercuryTestClient } from '@sprucelabs/mercury-client';
+import { assert } from '@sprucelabs/test-utils';
+import { chunkFieldDefinition } from './chunkFieldDefinition.js';
+export default class MockChunkingEmitter {
+    constructor() {
+        this.didEmit = false;
+        MockChunkingEmitter.lastInstance = this;
+    }
+    static getLastInstance() {
+        assert.isTruthy(this.lastInstance, 'You have not constructed a ChunkingEmitter! Try ChunkingEmitterImpl.Emitter({})');
+        return this.lastInstance;
+    }
+    static reset() {
+        this.lastInstance = undefined;
+    }
+    emit(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { eventName, items, payloadKey } = options;
+            this.didEmit = true;
+            this.emittedEventName = eventName;
+            this.emittedItems = items;
+            this.emittedPayloadKey = payloadKey;
+        });
+    }
+    assertDidEmitPayloadKey(payloadKey) {
+        this.assertDidEmit();
+        assert.isEqual(this.emittedPayloadKey, payloadKey, `I expected chunkingEmitter.emit() with payloadKey '${payloadKey}'! But you emitted ${this.emittedPayloadKey || 'nothing'}`);
+    }
+    getTotalErrors() {
+        return 0;
+    }
+    assertEmittedItems(items) {
+        this.assertDidEmit();
+        assert.isEqualDeep(this.emittedItems, items, 'You did not chunkingEmitter.emit(...) the expected items!!');
+    }
+    assertDidEmit() {
+        assert.isTrue(this.didEmit, `You did not ever call chunkingEmitter.emit(...). That is your next step!`);
+    }
+    assertDidEmitEventNamed(fqen) {
+        this.assertDidEmit();
+        assert.isEqual(this.emittedEventName, fqen, `I expected chunkingEmitter to emit '${fqen}'! But you emitted ${this.emittedEventName || 'nothing'}`);
+    }
+    assertEventHonorsChunkingSignature(fqen) {
+        var _a, _b, _c, _d, _e, _f;
+        const emitter = MercuryTestClient.getInternalEmitter();
+        const contract = emitter.getContract();
+        const payload = (_b = (_a = contract.eventSignatures[fqen]) === null || _a === void 0 ? void 0 : _a.emitPayloadSchema) === null || _b === void 0 ? void 0 : _b.fields;
+        // @ts-ignore
+        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;
+        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()');
+        assert.isEqualDeep(chunkField, chunkFieldDefinition(), 'Your chunk field is there but not properly formed. Use chunkFieldDefinition() to define it.');
+    }
+}

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

@@ -0,0 +1,2 @@
+import { FieldDefinitions } from '@sprucelabs/schema';
+export declare function chunkFieldDefinition(): FieldDefinitions;

package/build/esm/chunkingEmitter/chunkFieldDefinition.js

@@ -0,0 +1,10 @@
+import chunkPagingSchema from './../.spruce/schemas/chunkingEmitter/v2023_10_21/chunkPaging.schema.js';
+export function chunkFieldDefinition() {
+    return {
+        type: 'schema',
+        isRequired: true,
+        options: {
+            schema: chunkPagingSchema,
+        },
+    };
+}

package/{src/index.ts → build/esm/index.d.ts}

@@ -1,3 +1,3 @@
-import { ChunkingEmitter } from './chunkingEmitter/ChunkingEmitter'
-export default ChunkingEmitter
-export { default as MockChunkingEmitter } from './chunkingEmitter/MockChunkingEmitter'
+import { ChunkingEmitter } from './chunkingEmitter/ChunkingEmitter';
+export default ChunkingEmitter;
+export { default as MockChunkingEmitter } from './chunkingEmitter/MockChunkingEmitter';

package/build/esm/index.js

@@ -0,0 +1 @@
+export { default as MockChunkingEmitter } from './chunkingEmitter/MockChunkingEmitter.js';

package/build/esm/schemas/v2023_10_21/chunkPaging.builder.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    id: string;
+    name: string;
+    fields: {
+        total: {
+            type: "number";
+            isRequired: true;
+        };
+        current: {
+            type: "number";
+            isRequired: true;
+        };
+    };
+};
+export default _default;

package/build/esm/schemas/v2023_10_21/chunkPaging.builder.js

@@ -0,0 +1,15 @@
+import { buildSchema } from '@sprucelabs/schema';
+export default buildSchema({
+    id: 'chunkPaging',
+    name: 'Chunk Paging',
+    fields: {
+        total: {
+            type: 'number',
+            isRequired: true,
+        },
+        current: {
+            type: 'number',
+            isRequired: true,
+        },
+    },
+});

package/build/index.d.ts

@@ -0,0 +1,3 @@
+import { ChunkingEmitter } from './chunkingEmitter/ChunkingEmitter';
+export default ChunkingEmitter;
+export { default as MockChunkingEmitter } from './chunkingEmitter/MockChunkingEmitter';

package/build/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockChunkingEmitter = void 0;
+var MockChunkingEmitter_1 = require("./chunkingEmitter/MockChunkingEmitter");
+Object.defineProperty(exports, "MockChunkingEmitter", { enumerable: true, get: function () { return __importDefault(MockChunkingEmitter_1).default; } });

package/build/schemas/v2023_10_21/chunkPaging.builder.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    id: string;
+    name: string;
+    fields: {
+        total: {
+            type: "number";
+            isRequired: true;
+        };
+        current: {
+            type: "number";
+            isRequired: true;
+        };
+    };
+};
+export default _default;

package/build/schemas/v2023_10_21/chunkPaging.builder.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+exports.default = (0, schema_1.buildSchema)({
+    id: 'chunkPaging',
+    name: 'Chunk Paging',
+    fields: {
+        total: {
+            type: 'number',
+            isRequired: true,
+        },
+        current: {
+            type: 'number',
+            isRequired: true,
+        },
+    },
+});

package/package.json

@@ -1,6 +1,11 @@
 {
   "name": "@sprucelabs/mercury-chunking-emitter",
-  "version": "1.1.0",
+  "version": "1.1.2",
+  "files": [
+    "build/**/*",
+    "!build/__tests__",
+    "!build/esm/__tests__"
+  ],
   "scripts": {
     "build.ci": "yarn build.tsc && yarn build.resolve-paths && yarn lint",
     "build.dev": "yarn build.tsc --sourceMap ; yarn resolve-paths.lint",
@@ -81,4 +86,4 @@
     "@sprucelabs/spruce-permission-plugin": "^30.0.206",
     "@sprucelabs/spruce-skill-utils": "^30.0.54"
   }
-}
+}

package/.circleci/config.yml

@@ -1,71 +0,0 @@
-version: 2.1
-orbs:
-  spruce: sprucelabsai/orb@1
-jobs:
-  test:
-    docker:
-      - image: cimg/node:lts
-    working_directory: /mnt/ramdisk
-    steps:
-      - add_ssh_keys:
-          fingerprints:
-            - "ec:9f:2e:aa:1f:c9:ab:49:57:8f:c0:cd:2e:5b:f3:b0"
-      - checkout
-      - spruce/check_and_skip_if_npm_publish
-      - spruce/create_env_from_base64_env
-      - spruce/install_rsync
-      - spruce/install_deps_build_ci_test
-      - spruce/exit_if_not_auto_upgrade
-      - spruce/merge_auto_upgrade
-  npm_publish:
-    docker:
-      - image: cimg/node:lts
-    working_directory: /mnt/ramdisk
-    steps:
-      - add_ssh_keys:
-          fingerprints:
-            - "ec:9f:2e:aa:1f:c9:ab:49:57:8f:c0:cd:2e:5b:f3:b0"
-      - checkout
-      - spruce/check_and_skip_if_npm_publish
-      - spruce/install_rsync
-      - spruce/install_deps_build_dist_release
-  upgrade:
-    docker:
-      - image: cimg/node:lts
-    working_directory: /mnt/ramdisk
-    steps:
-      - spruce/check_for_autoupgrade_dns
-      - add_ssh_keys:
-          fingerprints:
-            - "ec:9f:2e:aa:1f:c9:ab:49:57:8f:c0:cd:2e:5b:f3:b0"
-      - spruce/check_for_ssh_keys_env
-      - spruce/setup_ct_npm_cache
-      - checkout
-      - spruce/set_target_branch_env
-      - spruce/install_rsync
-      - spruce/install_cli
-      - spruce/upgrade_check_for_major
-      - spruce/check_for_newline_only_diff
-      - spruce/create_pr
-workflows:
-  version: 2.1
-  do_build:
-    jobs:
-      - test:
-          context: public_package_publish
-      - npm_publish:
-          requires:
-            - test
-          context: public_package_publish
-          filters:
-            branches:
-              only:
-                - master
-  upgrade:
-    jobs:
-      - upgrade:
-          context: public_package_publish
-          filters:
-            branches:
-              only:
-                - never_run_only_for_cron

package/.eslintignore

@@ -1,3 +0,0 @@
-build
-esm
-node_modules

package/.eslintrc.js

@@ -1,3 +0,0 @@
-module.exports = {
-	extends: 'spruce',
-}

package/.githooks/pre-push

@@ -1,17 +0,0 @@
-#!/bin/bash
-
-CMD="CI=true yarn fix.lint"
-protected_branch='master'
-
-current_branch=$(git symbolic-ref HEAD | sed -e 's,.*/\(.*\),\1,')
-
-eval $CMD
-RESULT=$?
-
-if [[ $current_branch = $protected_branch ]]; then
-    if [ $RESULT -ne 0 ]; then
-        echo "failed $CMD"
-        exit 1
-    fi
-fi
-exit 0

package/.nvmrc

@@ -1 +0,0 @@
-lts/*

package/.vscode/launch.json

@@ -1,58 +0,0 @@
-{
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"type": "node",
-			"request": "attach",
-			"name": "attach.tests",
-			"port": 5200,
-			"restart": true,
-			"timeout": 10000
-		},
-		{
-			"type": "node",
-			"request": "launch",
-			"name": "test.file",
-			"runtimeExecutable": "node",
-			"runtimeArgs": [
-				"--inspect-brk",
-				"--trace-warnings",
-				"${workspaceFolder}/node_modules/.bin/jest",
-				"${fileBasenameNoExtension}",
-				"--detectOpenHandles"
-			],
-			"cwd": "${workspaceFolder}",
-			"console": "integratedTerminal",
-			"internalConsoleOptions": "neverOpen"
-		},
-		{
-			"type": "node",
-			"request": "launch",
-			"name": "test.all",
-			"runtimeExecutable": "node",
-			"runtimeArgs": [
-				"--inspect-brk",
-				"--trace-warnings",
-				"${workspaceFolder}/node_modules/.bin/jest"
-			],
-			"cwd": "${workspaceFolder}",
-			"console": "integratedTerminal",
-			"internalConsoleOptions": "neverOpen"
-		},
-		{
-			"type": "node",
-			"request": "launch",
-			"name": "boot",
-			"runtimeExecutable": "yarn",
-			"runtimeArgs": [
-				"run",
-				"--inspect-brk",
-				"--trace-warnings",
-				"boot"
-			],
-			"cwd": "${workspaceFolder}",
-			"console": "integratedTerminal",
-			"internalConsoleOptions": "neverOpen"
-		}
-	]
-}

package/.vscode/settings.json

@@ -1,70 +0,0 @@
-{
-	"debug.node.autoAttach": "on",
-	"git.ignoreLimitWarning": true,
-	"javascript.validate.enable": false,
-	"editor.formatOnSave": true,
-	"files.watcherExclude": {
-		"**/.git/objects/**": true,
-		"**/.git/subtree-cache/**": true,
-		"**/build/**": true,
-		"**/node_modules/**": true,
-	},
-	"search.exclude": {
-		"**/build/**": true,
-		"**/node_modules/**": true,
-		"**/.next/**": true
-	},
-	"editor.maxTokenizationLineLength": 20000000,
-	"eslint.enable": true,
-	"eslint.validate": [
-		"javascript",
-		"javascriptreact",
-		"typescript",
-		"typescriptreact"
-	],
-	"[javascript]": {
-		"editor.formatOnSave": false
-	},
-	"[javascriptreact]": {
-		"editor.formatOnSave": false
-	},
-	"[typescript]": {
-		"editor.formatOnSave": false
-	},
-	"[typescriptreact]": {
-		"editor.formatOnSave": false
-	},
-	"[handlebars]": {
-		"editor.formatOnSave": false
-	},
-	"eslint.options": {
-		"extensions": [
-			".js",
-			".jsx",
-			".ts",
-			".tsx"
-		]
-	},
-	"typescript.tsdk": "node_modules/typescript/lib",
-	"editor.codeActionsOnSave": {
-		"source.fixAll.eslint": true
-	},
-	"cSpell.ignorePaths": [
-		"**/package-lock.json",
-		"**/node_modules/**",
-		"**/build/**",
-		"**/vscode-extension/**",
-		"**/.git/objects/**",
-		".vscode",
-		".spruce"
-	],
-	"cSpell.words": [
-		"arkit",
-		"autogenerated",
-		"scrollable",
-		"serializable"
-	],
-	"debug.javascript.unmapMissingSources": true,
-	"javascript.preferences.importModuleSpecifier": "relative",
-	"typescript.preferences.importModuleSpecifier": "relative"
-}

package/.vscode/tasks.json

@@ -1,112 +0,0 @@
-{
-    "version": "2.0.0",
-    "tasks": [
-        {
-            "type": "npm",
-            "script": "watch.build.dev",
-            "group": "build",
-            "label": "watch.build.dev & problem.watcher",
-            "isBackground": true,
-            "runOptions": {
-                "runOn": "folderOpen"
-            },
-            "promptOnClose": false,
-            "presentation": {
-                "focus": false,
-                "reveal": "never"
-            },
-            "problemMatcher": {
-                "base": "$tsc-watch",
-                "applyTo": "allDocuments"
-            }
-        },
-        {
-            "label": "test.file",
-            "command": "spruce",
-            "args": [
-                "test",
-                "--inspect",
-                "5200",
-                "--pattern",
-                "${fileBasenameNoExtension}",
-                "--watchMode",
-                "standard"
-            ],
-            "promptOnClose": false,
-            "group": {
-                "kind": "test",
-                "isDefault": true
-            },
-            "presentation": {
-                "reveal": "always",
-                "panel": "dedicated",
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "test.reporter",
-            "command": "spruce",
-            "args": [
-                "test",
-                "--shouldHoldAtStart",
-                "true",
-                "--watchMode",
-                "smart"
-            ],
-            "promptOnClose": false,
-            "group": "test",
-            "runOptions": {
-                "runOn": "folderOpen"
-            },
-            "presentation": {
-                "panel": "shared",
-                "focus": true,
-                "reveal": "always"
-            }
-        },
-        {
-            "label": "spruce",
-            "type": "shell",
-            "command": "spruce ${input:spruceCommand}",
-            "problemMatcher": [],
-            "presentation": {
-                "reveal": "always",
-                "focus": true,
-                "panel": "new",
-                "clear": false
-            }
-        },
-        {
-            "label": "shell",
-            "type": "shell",
-            "command": "${input:command} ${input:optionsCommand}",
-            "problemMatcher": [],
-            "presentation": {
-                "reveal": "always",
-                "focus": true,
-                "panel": "new",
-                "clear": false
-            }
-        }
-    ],
-    "inputs": [
-        {
-            "id": "spruceCommand",
-            "description": "spruce command",
-            "default": "create.test",
-            "type": "promptString"
-        },
-        {
-            "id": "command",
-            "description": "command",
-            "default": "yarn",
-            "type": "promptString"
-        },
-        {
-            "id": "optionsCommand",
-            "description": "optionsCommand",
-            "default": "add",
-            "type": "promptString"
-        }
-    ]
-}

package/CHANGELOG.md

@@ -1,25 +0,0 @@
-# [1.1.0](https://github.com/sprucelabsai-community/spruce-chunking-emitter/compare/v1.0.5...v1.1.0) (2023-10-21)
-
-
-### Features
-
-* mock chunk fix ([1fdee23](https://github.com/sprucelabsai-community/spruce-chunking-emitter/commit/1fdee23))
-
-## [1.0.5](https://github.com/sprucelabsai-community/spruce-chunking-emitter/compare/v1.0.4...v1.0.5) (2023-10-21)
-
-## [1.0.4](https://github.com/sprucelabsai-community/spruce-chunking-emitter/compare/v1.0.3...v1.0.4) (2023-10-21)
-
-## [1.0.3](https://github.com/sprucelabsai-community/spruce-chunking-emitter/compare/v1.0.2...v1.0.3) (2023-10-21)
-
-## [1.0.2](https://github.com/sprucelabsai-community/spruce-chunking-emitter/compare/v1.0.1...v1.0.2) (2023-10-21)
-
-## [1.0.1](https://github.com/sprucelabsai-community/spruce-chunking-emitter/compare/v1.0.0...v1.0.1) (2023-10-21)
-
-# 1.0.0 (2023-10-21)
-
-
-### Features
-
-* can pass target ([9dfe34a](https://github.com/sprucelabsai-community/spruce-chunking-emitter/commit/9dfe34a))
-* initial commit ([1197525](https://github.com/sprucelabsai-community/spruce-chunking-emitter/commit/1197525))
-* mock chunking emitter ([b076ad1](https://github.com/sprucelabsai-community/spruce-chunking-emitter/commit/b076ad1))

package/release.config.js

@@ -1,7 +0,0 @@
-const spruceSemanticRelease = require('@sprucelabs/semantic-release')
-
-const config = spruceSemanticRelease.default({
-	config: spruceSemanticRelease.ReleaseConfiguration.Package
-})
-
-module.exports = config