@hatchet-dev/typescript-sdk 1.1.0 → 1.1.2

package/README.md

@@ -102,7 +102,7 @@ pnpm test
 
 ## Contributing
 
-We welcome contributions! Please check out our [contributing guidelines](https://docs.hatchet.run/contributing) and join our [Discord community](https://discord.gg/ZMeUafwH89) for discussions and support.
+We welcome contributions! Please check out our [contributing guidelines](https://docs.hatchet.run/contributing) and join our [Discord community](https://hatchet.run/discord) for discussions and support.
 
 ## License
 

package/clients/worker/worker.d.ts

@@ -51,7 +51,7 @@ export declare class V0Worker {
     registerAction<T, K>(actionId: string, action: StepRunFunction<T, K>): void;
     handleStartStepRun(action: Action): Promise<void>;
     handleStartGroupKeyRun(action: Action): Promise<void>;
-    getStepActionEvent(action: Action, eventType: StepActionEventType, shouldNotRetry: boolean, payload?: any): StepActionEvent;
+    getStepActionEvent(action: Action, eventType: StepActionEventType, shouldNotRetry: boolean, payload?: any, retryCount?: number): StepActionEvent;
     getGroupKeyActionEvent(action: Action, eventType: GroupKeyActionEventType, payload?: any): GroupKeyActionEvent;
     handleCancelStepRun(action: Action): Promise<void>;
     stop(): Promise<void>;

package/clients/worker/worker.js

@@ -346,13 +346,13 @@ class V0Worker {
                     this.logger.info(`Step run ${action.stepRunId} succeeded`);
                     try {
                         // Send the action event to the dispatcher
-                        const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_COMPLETED, false, result || null);
+                        const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_COMPLETED, false, result || null, action.retryCount);
                         yield this.client.dispatcher.sendStepActionEvent(event);
                     }
                     catch (actionEventError) {
                         this.logger.error(`Could not send completed action event: ${actionEventError.message || actionEventError}`);
                         // send a failure event
-                        const failureEvent = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_FAILED, false, actionEventError.message);
+                        const failureEvent = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_FAILED, false, actionEventError.message, action.retryCount);
                         try {
                             yield this.client.dispatcher.sendStepActionEvent(failureEvent);
                         }
@@ -378,7 +378,7 @@ class V0Worker {
                         const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_FAILED, shouldNotRetry, {
                             message: error === null || error === void 0 ? void 0 : error.message,
                             stack: error === null || error === void 0 ? void 0 : error.stack,
-                        });
+                        }, action.retryCount);
                         yield this.client.dispatcher.sendStepActionEvent(event);
                     }
                     catch (e) {
@@ -403,7 +403,7 @@ class V0Worker {
                 }))());
                 this.futures[action.stepRunId] = future;
                 // Send the action event to the dispatcher
-                const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_STARTED, false);
+                const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_STARTED, false, undefined, action.retryCount);
                 this.client.dispatcher.sendStepActionEvent(event).catch((e) => {
                     this.logger.error(`Could not send action event: ${e.message}`);
                 });
@@ -489,7 +489,7 @@ class V0Worker {
             }
         });
     }
-    getStepActionEvent(action, eventType, shouldNotRetry, payload = '') {
+    getStepActionEvent(action, eventType, shouldNotRetry, payload = '', retryCount = 0) {
         return {
             workerId: this.name,
             jobId: action.jobId,
@@ -501,6 +501,7 @@ class V0Worker {
             eventType,
             eventPayload: JSON.stringify(payload),
             shouldNotRetry,
+            retryCount,
         };
     }
     getGroupKeyActionEvent(action, eventType, payload = '') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [

package/step.js

@@ -413,7 +413,13 @@ class Context {
                 return resp;
             });
             try {
-                const resp = yield this.client.admin.runWorkflows(workflowRuns);
+                // Batch workflowRuns in groups of 500
+                let resp = [];
+                for (let i = 0; i < workflowRuns.length; i += 500) {
+                    const batch = workflowRuns.slice(i, i + 500);
+                    const batchResp = yield this.client.admin.runWorkflows(batch);
+                    resp = resp.concat(batchResp);
+                }
                 const res = [];
                 resp.forEach((ref, index) => {
                     const wf = workflows[index].workflow;

package/v1/client/client.d.ts

@@ -13,6 +13,7 @@ import { WorkflowsClient } from './features/workflows';
 import { RunsClient } from './features/runs';
 import { CreateStandaloneDurableTaskOpts } from '../task';
 import { InputType, OutputType, UnknownInputType, StrictWorkflowOutputType } from '../types';
+import { RatelimitsClient } from './features';
 /**
  * HatchetV1 implements the main client interface for interacting with the Hatchet workflow engine.
  * It provides methods for creating and executing workflows, as well as managing workers.
@@ -159,6 +160,12 @@ export declare class HatchetClient implements IHatchetClient {
      * @returns A metrics client instance
      */
     get metrics(): MetricsClient;
+    private _ratelimits;
+    /**
+     * Get the rate limits client for creating and managing rate limits
+     * @returns A rate limits client instance
+     */
+    get ratelimits(): RatelimitsClient;
     private _runs;
     /**
      * Get the runs client for creating and managing runs

package/v1/client/client.js

@@ -27,6 +27,7 @@ const metrics_1 = require("./features/metrics");
 const workers_1 = require("./features/workers");
 const workflows_1 = require("./features/workflows");
 const runs_1 = require("./features/runs");
+const features_1 = require("./features");
 /**
  * HatchetV1 implements the main client interface for interacting with the Hatchet workflow engine.
  * It provides methods for creating and executing workflows, as well as managing workers.
@@ -210,6 +211,16 @@ class HatchetClient {
         }
         return this._metrics;
     }
+    /**
+     * Get the rate limits client for creating and managing rate limits
+     * @returns A rate limits client instance
+     */
+    get ratelimits() {
+        if (!this._ratelimits) {
+            this._ratelimits = new features_1.RatelimitsClient(this);
+        }
+        return this._ratelimits;
+    }
     /**
      * Get the runs client for creating and managing runs
      * @returns A runs client instance

package/v1/declaration.js

@@ -63,8 +63,26 @@ class BaseWorkflowDeclaration {
                 throw UNBOUND_ERR;
             }
             if (Array.isArray(input)) {
-                // FIXME use bulk endpoint?
-                return Promise.all(input.map((i) => this.run(i, options, _standaloneTaskName)));
+                let resp = [];
+                for (let i = 0; i < input.length; i += 500) {
+                    const batch = input.slice(i, i + 500);
+                    const batchResp = yield this.client._v0.admin.runWorkflows(batch.map((inp) => ({
+                        workflowName: this.definition.name,
+                        input: inp,
+                        options,
+                    })));
+                    resp = resp.concat(batchResp);
+                }
+                const res = [];
+                resp.forEach((ref, index) => {
+                    const wf = input[index].workflow;
+                    if (wf instanceof TaskWorkflowDeclaration) {
+                        // eslint-disable-next-line no-param-reassign
+                        ref._standalone_task_name = wf._standalone_task_name;
+                    }
+                    res.push(ref.result());
+                });
+                return Promise.all(res);
             }
             const res = this.client._v0.admin.runWorkflow(this.definition.name, input, options);
             if (_standaloneTaskName) {

package/v1/examples/on_event/event.js

@@ -10,10 +10,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const hatchet_client_1 = require("../hatchet-client");
-const workflow_1 = require("./workflow");
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
-        const res = yield hatchet_client_1.hatchet.events.push(workflow_1.SIMPLE_EVENT, {
+        // ❓ Pushing an Event
+        const res = yield hatchet_client_1.hatchet.events.push('simple-event:create', {
             Message: 'hello',
         });
         // !!

package/v1/examples/on_event/workflow.js

@@ -6,10 +6,8 @@ exports.SIMPLE_EVENT = 'simple-event:create';
 // ❓ Run workflow on event
 exports.lower = hatchet_client_1.hatchet.workflow({
     name: 'lower',
-    on: {
-        // 👀 Declare the event that will trigger the workflow
-        event: exports.SIMPLE_EVENT,
-    },
+    // 👀 Declare the event that will trigger the workflow
+    onEvents: ['simple-event:create'],
 });
 // !!
 exports.lower.task({

package/v1/examples/rate_limit/workflow.d.ts

@@ -1,5 +1 @@
-type RateLimitInput = {
-    userId: string;
-};
-export declare const rateLimitWorkflow: import("../..").WorkflowDeclaration<RateLimitInput, {}>;
 export {};

package/v1/examples/rate_limit/workflow.js

@@ -1,29 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rateLimitWorkflow = void 0;
 const workflows_1 = require("../../../protoc/v1/workflows");
 const hatchet_client_1 = require("../hatchet-client");
-exports.rateLimitWorkflow = hatchet_client_1.hatchet.workflow({
-    name: 'RateLimitWorkflow',
+// ❓ Upsert Rate Limit
+hatchet_client_1.hatchet.ratelimits.upsert({
+    key: 'api-service-rate-limit',
+    limit: 10,
+    duration: workflows_1.RateLimitDuration.SECOND,
 });
 // !!
 // ❓ Static
-const RATE_LIMIT_KEY = 'test-limit';
-const task1 = exports.rateLimitWorkflow.task({
+const RATE_LIMIT_KEY = 'api-service-rate-limit';
+const task1 = hatchet_client_1.hatchet.task({
     name: 'task1',
-    fn: (input) => {
-        console.log('executed task1');
-    },
     rateLimits: [
         {
             staticKey: RATE_LIMIT_KEY,
             units: 1,
         },
     ],
+    fn: (input) => {
+        console.log('executed task1');
+    },
 });
 // !!
 // ❓ Dynamic
-const task2 = exports.rateLimitWorkflow.task({
+const task2 = hatchet_client_1.hatchet.task({
     name: 'task2',
     fn: (input) => {
         console.log('executed task2 for user: ', input.userId);

package/v1/examples/simple/bulk.js

@@ -0,0 +1,59 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+const hatchet_client_1 = require("../hatchet-client");
+const workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // ❓ Bulk Run a Task
+        const res = yield workflow_1.simple.run([
+            {
+                Message: 'HeLlO WoRlD',
+            },
+            {
+                Message: 'Hello MoOn',
+            },
+        ]);
+        // 👀 Access the results of the Task
+        console.log(res[0].TransformedMessage);
+        console.log(res[1].TransformedMessage);
+        // !!
+        // ❓ Bulk Run Tasks from within a Task
+        const parent = hatchet_client_1.hatchet.task({
+            name: 'simple',
+            fn: (input, ctx) => __awaiter(this, void 0, void 0, function* () {
+                // Bulk run two tasks in parallel
+                const child = yield ctx.bulkRunChildren([
+                    {
+                        workflow: workflow_1.simple,
+                        input: {
+                            Message: 'Hello, World!',
+                        },
+                    },
+                    {
+                        workflow: workflow_1.simple,
+                        input: {
+                            Message: 'Hello, Moon!',
+                        },
+                    },
+                ]);
+                return {
+                    TransformedMessage: `${child[0].TransformedMessage} ${child[1].TransformedMessage}`,
+                };
+            }),
+        });
+        // !!
+    });
+}
+if (require.main === module) {
+    main();
+}

package/v1/examples/simple/cron.js

@@ -22,7 +22,16 @@ function main() {
         // !!
         // eslint-disable-next-line no-console
         console.log(cron.metadata.id);
-        yield hatchet_client_1.hatchet.crons.delete(cron);
+        // ❓ Delete
+        yield hatchet_client_1.hatchet.crons.delete(cronId);
+        // !!
+        // ❓ List
+        const crons = yield hatchet_client_1.hatchet.crons.list({
+            workflowId: workflow_1.simple.id,
+        });
+        // !!
+        // eslint-disable-next-line no-console
+        console.log(crons);
     });
 }
 if (require.main === module) {

package/v1/examples/simple/run.d.ts

@@ -1 +1 @@
-export {};
+export declare function extra(): Promise<void>;

package/v1/examples/simple/run.js

@@ -9,7 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.extra = extra;
 /* eslint-disable no-console */
+const hatchet_client_1 = require("../hatchet-client");
 const workflow_1 = require("./workflow");
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
@@ -22,6 +24,35 @@ function main() {
         // !!
     });
 }
+function extra() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // ❓ Running Multiple Tasks
+        const res1 = workflow_1.simple.run({
+            Message: 'HeLlO WoRlD',
+        });
+        const res2 = workflow_1.simple.run({
+            Message: 'Hello MoOn',
+        });
+        const results = yield Promise.all([res1, res2]);
+        console.log(results[0].TransformedMessage);
+        console.log(results[1].TransformedMessage);
+        // !!
+        // ❓ Spawning Tasks from within a Task
+        const parent = hatchet_client_1.hatchet.task({
+            name: 'parent',
+            fn: (input, ctx) => __awaiter(this, void 0, void 0, function* () {
+                // Simply call ctx.runChild with the task you want to run
+                const child = yield ctx.runChild(workflow_1.simple, {
+                    Message: 'HeLlO WoRlD',
+                });
+                return {
+                    result: child.TransformedMessage,
+                };
+            }),
+        });
+        // !!
+    });
+}
 if (require.main === module) {
     main();
 }

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.1.0";
+export declare const HATCHET_VERSION = "1.1.2";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HATCHET_VERSION = void 0;
-exports.HATCHET_VERSION = '1.1.0';
+exports.HATCHET_VERSION = '1.1.2';

package/v1/examples/rate_limit/run.js

@@ -1,29 +0,0 @@
-"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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable no-console */
-const workflow_1 = require("./workflow");
-function main() {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const res = yield workflow_1.rateLimitWorkflow.run({ userId: 'abc' });
-            console.log(res);
-        }
-        catch (e) {
-            console.log('error', e);
-        }
-    });
-}
-if (require.main === module) {
-    main()
-        .catch(console.error)
-        .finally(() => process.exit(0));
-}

package/v1/examples/rate_limit/worker.d.ts

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

package/v1/examples/rate_limit/worker.js

@@ -1,24 +0,0 @@
-"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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const hatchet_client_1 = require("../hatchet-client");
-const workflow_1 = require("./workflow");
-function main() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const worker = yield hatchet_client_1.hatchet.worker('rate-limit-worker', {
-            workflows: [workflow_1.rateLimitWorkflow],
-        });
-        yield worker.start();
-    });
-}
-if (require.main === module) {
-    main();
-}