@hatchet-dev/typescript-sdk 0.10.1 → 0.12.1

package/examples/on-failure.js

@@ -0,0 +1,53 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = __importDefault(require("../sdk"));
+const hatchet = sdk_1.default.init({
+    log_level: 'OFF',
+});
+const sleep = (ms) => new Promise((resolve) => {
+    setTimeout(resolve, ms);
+});
+const workflow = {
+    id: 'on-failure-example',
+    description: 'test',
+    on: {
+        event: 'user:create',
+    },
+    steps: [
+        {
+            name: 'dag-step1',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                console.log('Starting Step 1!');
+                yield sleep(1000);
+                throw new Error('Step 1 failed');
+            }),
+        },
+    ],
+    onFailure: {
+        name: 'on-failure-step',
+        run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+            console.log('Starting On Failure Step!');
+            return { onFailure: 'step' };
+        }),
+    },
+};
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet.worker('example-worker', 1);
+        yield worker.registerWorkflow(workflow);
+        worker.start();
+    });
+}
+main();

package/examples/playground.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/playground.js

@@ -0,0 +1,39 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = __importDefault(require("../sdk"));
+const hatchet = sdk_1.default.init();
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet.worker('test-playground');
+        yield worker.registerWorkflow({
+            id: 'playground-ts',
+            description: 'desc',
+            on: {
+                event: 'test1',
+            },
+            steps: [
+                {
+                    name: 'test1-step1',
+                    run: (ctx) => {
+                        const playground = ctx.playground('test1', 'default');
+                        return { step1: playground, name: ctx.stepName(), workflowRunId: ctx.workflowRunId() };
+                    },
+                },
+            ],
+        });
+        yield worker.start();
+    });
+}
+main();

package/examples/rate-limit/events.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/rate-limit/events.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = __importDefault(require("../../sdk"));
+const hatchet = sdk_1.default.init();
+hatchet.event.push('rate-limit:create', {
+    test: '1',
+});
+hatchet.event.push('rate-limit:create', {
+    test: '2',
+});
+hatchet.event.push('rate-limit:create', {
+    test: '3',
+});

package/examples/rate-limit/worker.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/rate-limit/worker.js

@@ -0,0 +1,43 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const workflows_1 = require("../../protoc/workflows");
+const sdk_1 = __importDefault(require("../../sdk"));
+const hatchet = sdk_1.default.init();
+const workflow = {
+    id: 'rate-limit-workflow',
+    description: 'test',
+    on: {
+        event: 'rate-limit:create',
+    },
+    steps: [
+        {
+            name: 'step1',
+            rate_limits: [{ key: 'test-limit', units: 1 }],
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                console.log('starting step1 with the following input', ctx.workflowInput());
+                return { step1: 'step1 results!' };
+            }),
+        },
+    ],
+};
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield hatchet.admin.putRateLimit('test-limit', 1, workflows_1.RateLimitDuration.MINUTE);
+        const worker = yield hatchet.worker('example-worker');
+        yield worker.registerWorkflow(workflow);
+        worker.start();
+    });
+}
+main();

package/examples/retries-worker.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/retries-worker.js

@@ -0,0 +1,60 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = __importDefault(require("../sdk"));
+const hatchet = sdk_1.default.init();
+const sleep = (ms) => new Promise((resolve) => {
+    setTimeout(resolve, ms);
+});
+let numRetries = 0;
+const workflow = {
+    id: 'retries-workflow',
+    description: 'test',
+    on: {
+        event: 'user:create',
+    },
+    steps: [
+        {
+            name: 'step1',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                if (numRetries < 3) {
+                    numRetries += 1;
+                    throw new Error('step1 failed');
+                }
+                console.log('starting step1 with the following input', ctx.workflowInput());
+                console.log('waiting 5 seconds...');
+                yield sleep(5000);
+                console.log('executed step1!');
+                return { step1: 'step1 results!' };
+            }),
+            retries: 3,
+        },
+        {
+            name: 'step2',
+            parents: ['step1'],
+            run: (ctx) => {
+                console.log('executed step2 after step1 returned ', ctx.stepOutput('step1'));
+                return { step2: 'step2 results!' };
+            },
+        },
+    ],
+};
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet.worker('example-worker');
+        yield worker.registerWorkflow(workflow);
+        worker.start();
+    });
+}
+main();

package/examples/simple-worker.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/simple-worker.js

@@ -0,0 +1,55 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = __importDefault(require("../sdk"));
+const hatchet = sdk_1.default.init();
+const sleep = (ms) => new Promise((resolve) => {
+    setTimeout(resolve, ms);
+});
+const workflow = {
+    id: 'simple-workflow',
+    description: 'test',
+    on: {
+        event: 'user:create',
+    },
+    steps: [
+        {
+            name: 'step1',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                console.log('starting step1 with the following input', ctx.workflowInput());
+                console.log('waiting 5 seconds...');
+                yield sleep(5000);
+                ctx.putStream('step1 stream');
+                console.log('executed step1!');
+                return { step1: 'step1 results!' };
+            }),
+        },
+        {
+            name: 'step2',
+            parents: ['step1'],
+            run: (ctx) => {
+                console.log('executed step2 after step1 returned ', ctx.stepOutput('step1'));
+                return { step2: 'step2 results!' };
+            },
+        },
+    ],
+};
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet.worker('example-worker');
+        yield worker.registerWorkflow(workflow);
+        worker.start();
+    });
+}
+main();

package/examples/sticky-worker.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/sticky-worker.js

@@ -0,0 +1,73 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = __importDefault(require("../sdk"));
+const workflow_1 = require("../workflow");
+const hatchet = sdk_1.default.init();
+const workflow = {
+    id: 'sticky-workflow',
+    description: 'test',
+    steps: [
+        {
+            name: 'step1',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                const results = [];
+                // eslint-disable-next-line no-plusplus
+                for (let i = 0; i < 50; i++) {
+                    const result = yield ctx.spawnWorkflow(childWorkflow, {}, { sticky: true });
+                    results.push(result.result());
+                }
+                console.log('Spawned 50 child workflows');
+                console.log('Results:', yield Promise.all(results));
+                return { step1: 'step1 results!' };
+            }),
+        },
+    ],
+};
+const childWorkflow = {
+    id: 'child-sticky-workflow',
+    description: 'test',
+    sticky: workflow_1.StickyStrategy.HARD,
+    steps: [
+        {
+            name: 'child-step1',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                const workerId = ctx.worker.id();
+                console.log(`1: Worker ID: ${workerId}`);
+                return { childStep1: `${workerId}` };
+            }),
+        },
+        {
+            name: 'child-step2',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                const workerId = ctx.worker.id();
+                console.log(`2: Worker ID: ${workerId}`);
+                return { childStep2: `${workerId}` };
+            }),
+        },
+    ],
+};
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker1 = yield hatchet.worker('sticky-worker-1');
+        yield worker1.registerWorkflow(workflow);
+        yield worker1.registerWorkflow(childWorkflow);
+        worker1.start();
+        const worker2 = yield hatchet.worker('sticky-worker-2');
+        yield worker2.registerWorkflow(workflow);
+        yield worker2.registerWorkflow(childWorkflow);
+        worker2.start();
+    });
+}
+main();

package/examples/stream-by-additional-meta.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/stream-by-additional-meta.js

@@ -0,0 +1,55 @@
+"use strict";
+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());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = __importDefault(require("../sdk"));
+const hatchet = sdk_1.default.init();
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, e_1, _b, _c;
+        // Generate a random stream key to use to track all
+        // stream events for this workflow run.
+        const streamKey = 'streamKey';
+        const streamVal = `sk-${Math.random().toString(36).substring(7)}`;
+        // Specify the stream key as additional metadata
+        // when running the workflow.
+        // This key gets propagated to all child workflows
+        // and can have an arbitrary property name.
+        yield hatchet.admin.runWorkflow('parent-workflow', {}, { additionalMetadata: { [streamKey]: streamVal } });
+        // Stream all events for the additional meta key value
+        const stream = yield hatchet.listener.streamByAdditionalMeta(streamKey, streamVal);
+        try {
+            for (var _d = true, stream_1 = __asyncValues(stream), stream_1_1; stream_1_1 = yield stream_1.next(), _a = stream_1_1.done, !_a; _d = true) {
+                _c = stream_1_1.value;
+                _d = false;
+                const event = _c;
+                console.log('event received', event);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = stream_1.return)) yield _b.call(stream_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    });
+}
+main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.10.1",
+  "version": "0.12.1",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -31,25 +31,28 @@
     "prettier:check": "prettier \"src/**/*.{ts,tsx}\" --list-different",
     "prettier:fix": "prettier \"src/**/*.{ts,tsx}\" --write",
     "exec": "npx dotenv -- ts-node -r tsconfig-paths/register --project tsconfig.json",
-    "example:event": "npm run exec -- ./examples/example-event.ts",
-    "example:event-listen": "npm run exec -- ./examples/example-event-with-results.ts",
-    "worker:namespaced": "npm run exec -- ./examples/namespaced-worker.ts",
-    "worker:rate": "npm run exec -- ./examples/rate-limit/worker.ts",
-    "example:rate": "npm run exec -- ./examples/rate-limit/events.ts",
-    "worker:fanout": "npm run exec -- ./examples/fanout-worker.ts",
-    "worker:simple": "npm run exec -- ./examples/simple-worker.ts",
-    "worker:on-failure": "npm run exec -- ./examples/on-failure.ts",
-    "manual:trigger": "npm run exec -- ./examples/manual-trigger.ts",
-    "worker:dag": "npm run exec -- ./examples/dag-worker.ts",
-    "worker:concurrency": "npm run exec -- ./examples/concurrency/cancel-in-progress/concurrency-worker.ts",
-    "event:concurrency": "npm run exec -- ./examples/concurrency/cancel-in-progress/concurrency-event.ts",
-    "worker:concurrency:rr": "npm run exec -- ./examples/concurrency/group-round-robin/concurrency-worker.ts",
-    "event:concurrency:rr": "npm run exec -- ./examples/concurrency/group-round-robin/concurrency-event.ts",
-    "worker:playground": "npm run exec -- ./examples/playground.ts",
-    "worker:retries": "npm run exec -- ./examples/retries-worker.ts",
-    "worker:multi-workflow": "npm run exec -- ./examples/multi-workflow.ts",
-    "worker:logger": "npm run exec -- ./examples/logger.ts",
-    "api": "npm run exec -- ./examples/api.ts",
+    "example:event": "npm run exec -- ./src/examples/example-event.ts",
+    "example:event-listen": "npm run exec -- ./src/examples/example-event-with-results.ts",
+    "worker:namespaced": "npm run exec -- ./src/examples/namespaced-worker.ts",
+    "worker:rate": "npm run exec -- ./src/examples/rate-limit/worker.ts",
+    "example:rate": "npm run exec -- ./src/examples/rate-limit/events.ts",
+    "worker:fanout": "npm run exec -- ./src/examples/fanout-worker.ts",
+    "worker:simple": "npm run exec -- ./src/examples/simple-worker.ts",
+    "worker:affinity": "npm run exec -- ./src/examples/affinity-workers.ts",
+    "worker:sticky": "npm run exec -- ./src/examples/sticky-worker.ts",
+    "worker:on-failure": "npm run exec -- ./src/examples/on-failure.ts",
+    "manual:trigger": "npm run exec -- ./src/examples/manual-trigger.ts",
+    "manual:meta": "npm run exec -- ./src/examples/stream-by-additional-meta.ts",
+    "worker:dag": "npm run exec -- ./src/examples/dag-worker.ts",
+    "worker:concurrency": "npm run exec -- ./src/examples/concurrency/cancel-in-progress/concurrency-worker.ts",
+    "event:concurrency": "npm run exec -- ./src/examples/concurrency/cancel-in-progress/concurrency-event.ts",
+    "worker:concurrency:rr": "npm run exec -- ./src/examples/concurrency/group-round-robin/concurrency-worker.ts",
+    "event:concurrency:rr": "npm run exec -- ./src/examples/concurrency/group-round-robin/concurrency-event.ts",
+    "worker:playground": "npm run exec -- ./src/examples/playground.ts",
+    "worker:retries": "npm run exec -- ./src/examples/retries-worker.ts",
+    "worker:multi-workflow": "npm run exec -- ./src/examples/multi-workflow.ts",
+    "worker:logger": "npm run exec -- ./src/examples/logger.ts",
+    "api": "npm run exec -- ./src/examples/api.ts",
     "prepublish": "cp package.json dist/package.json;",
     "publish:ci": "rm -rf ./dist && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks",
     "generate-docs": "typedoc"
@@ -59,7 +62,7 @@
   "license": "MIT",
   "devDependencies": {
     "@types/jest": "^29.5.11",
-    "@types/node": "^20.11.16",
+    "@types/node": "^22.0.0",
     "@typescript-eslint/eslint-plugin": "^6.4.0",
     "autoprefixer": "^10.4.16",
     "dotenv-cli": "^7.3.0",
@@ -76,7 +79,7 @@
     "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.6",
-    "eslint-plugin-unused-imports": "^3.0.0",
+    "eslint-plugin-unused-imports": "^4.1.3",
     "grpc-tools": "^1.12.4",
     "jest": "^29.7.0",
     "prettier": "^3.1.1",