@hatchet-dev/typescript-sdk 1.20.1 → 1.21.0

package/package.json

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

package/v1/declaration.d.ts

@@ -65,6 +65,10 @@ export type RunOpts = {
         comparator?: WorkerLabelComparator;
     }>;
 };
+export type RunManyOpt<I extends InputType = UnknownInputType> = {
+    input: I;
+    opts?: RunOpts;
+};
 /**
  * Helper type to safely extract output types from task results
  * @hidden
@@ -263,6 +267,13 @@ export declare class BaseWorkflowDeclaration<I extends InputType = UnknownInputT
      */
     runNoWait(input: I, options?: RunOpts, _standaloneTaskName?: string): Promise<WorkflowRunRef<O>>;
     runNoWait(input: I[], options?: RunOpts, _standaloneTaskName?: string): Promise<WorkflowRunRef<O>[]>;
+    /**
+     * Synchronously trigger multiple workflow runs without waiting for completion.
+     * @param runs A list of run requests containing input and per-run options.
+     * @returns WorkflowRunRef values in the same order as input runs.
+     * @throws Error if the workflow is not bound to a Hatchet client.
+     */
+    runManyNoWait(runs: RunManyOpt<I>[], _standaloneTaskName?: string): Promise<WorkflowRunRef<O>[]>;
     /**
      * @alias run
      * Triggers a workflow run and waits for the result.
@@ -283,6 +294,12 @@ export declare class BaseWorkflowDeclaration<I extends InputType = UnknownInputT
      */
     run(input: I, options?: RunOpts, _standaloneTaskName?: string): Promise<O>;
     run(input: I[], options?: RunOpts, _standaloneTaskName?: string): Promise<O[]>;
+    /**
+     * Executes many workflow runs and waits for all results.
+     * @param runs A list of run requests containing input and per-run options.
+     * @returns Results in the same order as input runs.
+     */
+    runMany(runs: RunManyOpt<I>[], _standaloneTaskName?: string): Promise<O[]>;
     /**
      * Schedules a workflow to run at a specific date and time in the future.
      * @param enqueueAt The date when the workflow should be triggered.
@@ -376,6 +393,7 @@ export declare class BaseWorkflowDeclaration<I extends InputType = UnknownInputT
  * - Scheduled execution with `schedule()`
  * - Cron-based recurring execution with `cron()`
  * - Bulk execution by passing an array input to `run()` and `runNoWait()`
+ * - Per-run bulk execution options with `runMany()` and `runManyNoWait()`
  *
  * Tasks within workflows can be defined with `workflow.task()` or
  * `workflow.durableTask()` and arranged into complex dependency patterns.
@@ -484,6 +502,18 @@ export declare class TaskWorkflowDeclaration<I extends InputType = UnknownInputT
      */
     runNoWait(input: I & GlobalInput, options?: RunOpts): Promise<WorkflowRunRef<O & Resolved<GlobalOutput, MiddlewareAfter>>>;
     runNoWait(input: (I & GlobalInput)[], options?: RunOpts): Promise<WorkflowRunRef<O & Resolved<GlobalOutput, MiddlewareAfter>>[]>;
+    /**
+     * Triggers many task runs and waits for all results.
+     * @param runs - The list of inputs and optional per-run options.
+     * @returns A promise that resolves with ordered task outputs.
+     */
+    runMany(runs: RunManyOpt<I & GlobalInput>[]): Promise<(O & Resolved<GlobalOutput, MiddlewareAfter>)[]>;
+    /**
+     * Triggers many task runs without waiting for completion.
+     * @param runs - The list of inputs and optional per-run options.
+     * @returns WorkflowRunRef values for each scheduled run.
+     */
+    runManyNoWait(runs: RunManyOpt<I & GlobalInput>[]): Promise<WorkflowRunRef<O & Resolved<GlobalOutput, MiddlewareAfter>>[]>;
     /**
      * Schedules the task to run at a specific date and time.
      * @param enqueueAt - The date when the task should be triggered.

package/v1/declaration.js

@@ -15,6 +15,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TaskWorkflowDeclaration = exports.WorkflowDeclaration = exports.BaseWorkflowDeclaration = exports.StickyStrategy = exports.Priority = void 0;
 exports.CreateTaskWorkflow = CreateTaskWorkflow;
@@ -117,6 +128,59 @@ class BaseWorkflowDeclaration {
             return res;
         });
     }
+    /**
+     * Synchronously trigger multiple workflow runs without waiting for completion.
+     * @param runs A list of run requests containing input and per-run options.
+     * @returns WorkflowRunRef values in the same order as input runs.
+     * @throws Error if the workflow is not bound to a Hatchet client.
+     */
+    runManyNoWait(runs, _standaloneTaskName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.client) {
+                throw UNBOUND_ERR;
+            }
+            const parentRunContext = parent_run_context_vars_1.parentRunContextManager.getContext();
+            const hasChildKeyOrSticky = runs.some((run) => { var _a, _b; return ((_a = run.opts) === null || _a === void 0 ? void 0 : _a.childKey) || ((_b = run.opts) === null || _b === void 0 ? void 0 : _b.sticky); });
+            if (!parentRunContext && hasChildKeyOrSticky) {
+                this.client.admin.logger.warn('ignoring childKey or sticky because run is not being spawned from a parent task');
+            }
+            const inheritedSignal = parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.signal;
+            (0, abort_error_1.throwIfAborted)(inheritedSignal, {
+                isTrigger: true,
+                context: (parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentTaskRunExternalId)
+                    ? `task run ${parentRunContext.parentTaskRunExternalId}`
+                    : undefined,
+                warn: (message) => this.client.admin.logger.warn(message),
+            });
+            parent_run_context_vars_1.parentRunContextManager.incrementChildIndex(runs.length);
+            const baseOpts = {
+                parentId: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentId,
+                parentTaskRunExternalId: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentTaskRunExternalId,
+                childIndex: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.childIndex,
+            };
+            let resp = [];
+            for (let i = 0; i < runs.length; i += 500) {
+                const batch = runs.slice(i, i + 500);
+                const batchResp = yield this.client.admin.runWorkflows(batch.map((run, batchIndex) => {
+                    var _a, _b, _c;
+                    const _d = (_a = run.opts) !== null && _a !== void 0 ? _a : {}, { sticky } = _d, restOpts = __rest(_d, ["sticky"]);
+                    return {
+                        workflowName: this.definition.name,
+                        input: run.input,
+                        options: Object.assign(Object.assign(Object.assign({}, baseOpts), restOpts), { childIndex: ((_b = baseOpts.childIndex) !== null && _b !== void 0 ? _b : 0) + i + batchIndex, desiredWorkerId: sticky ? parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.desiredWorkerId : undefined, childKey: (_c = run.opts) === null || _c === void 0 ? void 0 : _c.childKey }),
+                    };
+                }));
+                resp = resp.concat(batchResp);
+            }
+            resp.forEach((ref) => {
+                if (_standaloneTaskName) {
+                    ref._standaloneTaskName = _standaloneTaskName;
+                }
+                ref.defaultSignal = inheritedSignal;
+            });
+            return resp;
+        });
+    }
     runAndWait(input, options, _standaloneTaskName) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.client) {
@@ -162,6 +226,43 @@ class BaseWorkflowDeclaration {
             return res.result();
         });
     }
+    /**
+     * Executes many workflow runs and waits for all results.
+     * @param runs A list of run requests containing input and per-run options.
+     * @returns Results in the same order as input runs.
+     */
+    runMany(runs, _standaloneTaskName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            if (!this.client) {
+                throw UNBOUND_ERR;
+            }
+            const durableCtx = (_a = parent_run_context_vars_1.parentRunContextManager.getContext()) === null || _a === void 0 ? void 0 : _a.durableContext;
+            if (durableCtx) {
+                return durableCtx.spawnChildren(runs.map((run) => ({
+                    workflow: this,
+                    input: run.input,
+                    options: run.opts,
+                })));
+            }
+            const refs = yield this.runManyNoWait(runs, _standaloneTaskName);
+            const returnExceptions = runs.some((run) => { var _a; return (_a = run.opts) === null || _a === void 0 ? void 0 : _a.returnExceptions; });
+            if (returnExceptions) {
+                const settled = yield Promise.allSettled(refs.map((ref) => ref.result()));
+                return settled.map((s) => {
+                    if (s.status === 'fulfilled') {
+                        return s.value;
+                    }
+                    const { reason } = s;
+                    if (reason instanceof Error) {
+                        return reason;
+                    }
+                    return new Error(Array.isArray(reason) ? reason.join('; ') : String(reason));
+                });
+            }
+            return Promise.all(refs.map((ref) => ref.result()));
+        });
+    }
     /**
      * Schedules a workflow to run at a specific date and time in the future.
      * @param enqueueAt The date when the workflow should be triggered.
@@ -344,6 +445,7 @@ exports.BaseWorkflowDeclaration = BaseWorkflowDeclaration;
  * - Scheduled execution with `schedule()`
  * - Cron-based recurring execution with `cron()`
  * - Bulk execution by passing an array input to `run()` and `runNoWait()`
+ * - Per-run bulk execution options with `runMany()` and `runManyNoWait()`
  *
  * Tasks within workflows can be defined with `workflow.task()` or
  * `workflow.durableTask()` and arranged into complex dependency patterns.
@@ -492,6 +594,32 @@ class TaskWorkflowDeclaration extends BaseWorkflowDeclaration {
                 : _super.runNoWait.call(this, input, options, this._standalone_task_name);
         });
     }
+    /**
+     * Triggers many task runs and waits for all results.
+     * @param runs - The list of inputs and optional per-run options.
+     * @returns A promise that resolves with ordered task outputs.
+     */
+    runMany(runs) {
+        const _super = Object.create(null, {
+            runMany: { get: () => super.runMany }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.runMany.call(this, runs, this._standalone_task_name);
+        });
+    }
+    /**
+     * Triggers many task runs without waiting for completion.
+     * @param runs - The list of inputs and optional per-run options.
+     * @returns WorkflowRunRef values for each scheduled run.
+     */
+    runManyNoWait(runs) {
+        const _super = Object.create(null, {
+            runManyNoWait: { get: () => super.runManyNoWait }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.runManyNoWait.call(this, runs, this._standalone_task_name);
+        });
+    }
     /**
      * Schedules the task to run at a specific date and time.
      * @param enqueueAt - The date when the task should be triggered.

package/v1/examples/simple/bulk.js

@@ -26,6 +26,25 @@ function main() {
         console.log(res[0].TransformedMessage);
         console.log(res[1].TransformedMessage);
         // !!
+        // > Bulk Run a Task with runMany
+        const runManyRes = yield workflow_1.simple.runMany([
+            {
+                input: {
+                    Message: 'HeLlO WoRlD',
+                },
+            },
+            {
+                input: {
+                    Message: 'Hello MoOn',
+                },
+                opts: {
+                    priority: 3,
+                },
+            },
+        ]);
+        console.log(runManyRes[0].TransformedMessage);
+        console.log(runManyRes[1].TransformedMessage);
+        // !!
         // > Bulk Run Tasks from within a Task
         const parent = hatchet_client_1.hatchet.task({
             name: 'simple',

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.20.1";
+export declare const HATCHET_VERSION = "1.21.0";

package/version.js

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