@hatchet-dev/typescript-sdk 1.26.2 → 1.28.0

package/protoc/v1/workflows.d.ts

@@ -33,6 +33,13 @@ export declare enum RunStatus {
 }
 export declare function runStatusFromJSON(object: any): RunStatus;
 export declare function runStatusToJSON(object: RunStatus): string;
+export declare enum IdempotencyMethod {
+    TTL = 0,
+    STATUS = 1,
+    UNRECOGNIZED = -1
+}
+export declare function idempotencyMethodFromJSON(object: any): IdempotencyMethod;
+export declare function idempotencyMethodToJSON(object: IdempotencyMethod): string;
 export declare enum ConcurrencyLimitStrategy {
     CANCEL_IN_PROGRESS = 0,
     /** DROP_NEWEST - deprecated */
@@ -136,12 +143,16 @@ export interface CreateWorkflowVersionRequest {
 export interface IdempotencyConfig {
     /** a CEL expression for determining the idempotency key for workflow runs */
     expression: string;
-    /** time-to-live for idempotency keys in milliseconds */
+    /** time-to-live for idempotency keys in milliseconds. if the method is `STATUS`, this is a "fallback" - the longest the key can live before it's evicted */
     ttlMs: number;
+    /** the method to use for idempotency, defaults to TTL */
+    method?: IdempotencyMethod | undefined;
 }
 export interface IdempotencyCollisionError {
     /** the external ID of the existing workflow run that caused the collision */
     existingRunExternalId: string;
+    /** the external ID of the workflow run that caused the collision */
+    collidingRunExternalId: string;
 }
 export interface BulkTriggerIdempotencyCollisionError {
     /** the external IDs of the successfully triggered workflow runs */
@@ -165,6 +176,18 @@ export interface Concurrency {
     /** (optional) the strategy to use when the concurrency limit is reached, default CANCEL_IN_PROGRESS */
     limitStrategy?: ConcurrencyLimitStrategy | undefined;
 }
+export interface TaskBatchConfig {
+    /** (required) maximum items per batch */
+    batchMaxSize: number;
+    /** (optional) time before batch flushes (milliseconds) */
+    batchMaxIntervalMs?: number | undefined;
+    /** (optional) partition key for fairness (prevents mixing tenants) */
+    batchGroupKey?: string | undefined;
+    /** (optional) concurrent batches per group */
+    batchGroupMaxRuns?: number | undefined;
+    /** (optional) when true, the handler returns one value broadcast to all callers; when false (default), the handler returns a dict keyed by step run id */
+    broadcastOutput?: boolean | undefined;
+}
 /** CreateTaskOpts represents options to create a task. */
 export interface CreateTaskOpts {
     /** (required) the task name */
@@ -201,6 +224,8 @@ export interface CreateTaskOpts {
     slotRequests: {
         [key: string]: number;
     };
+    /** (optional) batch execution configuration */
+    batch?: TaskBatchConfig | undefined;
 }
 export interface CreateTaskOpts_WorkerLabelsEntry {
     key: string;
@@ -283,6 +308,7 @@ export declare const IdempotencyCollisionError: MessageFns<IdempotencyCollisionE
 export declare const BulkTriggerIdempotencyCollisionError: MessageFns<BulkTriggerIdempotencyCollisionError>;
 export declare const DefaultFilter: MessageFns<DefaultFilter>;
 export declare const Concurrency: MessageFns<Concurrency>;
+export declare const TaskBatchConfig: MessageFns<TaskBatchConfig>;
 export declare const CreateTaskOpts: MessageFns<CreateTaskOpts>;
 export declare const CreateTaskOpts_WorkerLabelsEntry: MessageFns<CreateTaskOpts_WorkerLabelsEntry>;
 export declare const CreateTaskOpts_SlotRequestsEntry: MessageFns<CreateTaskOpts_SlotRequestsEntry>;

package/protoc/v1/workflows.js

@@ -1,17 +1,19 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.8
+//   protoc-gen-ts_proto  v2.12.0
 //   protoc               v3.19.1
 // source: v1/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdminServiceDefinition = exports.GetRunDetailsResponse_TaskRunsEntry = exports.GetRunDetailsResponse = exports.TaskRunDetail = exports.GetRunDetailsRequest = exports.CreateWorkflowVersionResponse = exports.CreateTaskRateLimit = exports.CreateTaskOpts_SlotRequestsEntry = exports.CreateTaskOpts_WorkerLabelsEntry = exports.CreateTaskOpts = exports.Concurrency = exports.DefaultFilter = exports.BulkTriggerIdempotencyCollisionError = exports.IdempotencyCollisionError = exports.IdempotencyConfig = exports.CreateWorkflowVersionRequest = exports.BranchDurableTaskResponse = exports.BranchDurableTaskRequest = exports.TriggerWorkflowRunResponse = exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry = exports.TriggerWorkflowRunRequest = exports.ReplayTasksResponse = exports.CancelTasksResponse = exports.TasksFilter = exports.ReplayTasksRequest = exports.CancelTasksRequest = exports.ConcurrencyLimitStrategy = exports.RunStatus = exports.RateLimitDuration = exports.StickyStrategy = exports.protobufPackage = void 0;
+exports.AdminServiceDefinition = exports.GetRunDetailsResponse_TaskRunsEntry = exports.GetRunDetailsResponse = exports.TaskRunDetail = exports.GetRunDetailsRequest = exports.CreateWorkflowVersionResponse = exports.CreateTaskRateLimit = exports.CreateTaskOpts_SlotRequestsEntry = exports.CreateTaskOpts_WorkerLabelsEntry = exports.CreateTaskOpts = exports.TaskBatchConfig = exports.Concurrency = exports.DefaultFilter = exports.BulkTriggerIdempotencyCollisionError = exports.IdempotencyCollisionError = exports.IdempotencyConfig = exports.CreateWorkflowVersionRequest = exports.BranchDurableTaskResponse = exports.BranchDurableTaskRequest = exports.TriggerWorkflowRunResponse = exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry = exports.TriggerWorkflowRunRequest = exports.ReplayTasksResponse = exports.CancelTasksResponse = exports.TasksFilter = exports.ReplayTasksRequest = exports.CancelTasksRequest = exports.ConcurrencyLimitStrategy = exports.IdempotencyMethod = exports.RunStatus = exports.RateLimitDuration = exports.StickyStrategy = exports.protobufPackage = void 0;
 exports.stickyStrategyFromJSON = stickyStrategyFromJSON;
 exports.stickyStrategyToJSON = stickyStrategyToJSON;
 exports.rateLimitDurationFromJSON = rateLimitDurationFromJSON;
 exports.rateLimitDurationToJSON = rateLimitDurationToJSON;
 exports.runStatusFromJSON = runStatusFromJSON;
 exports.runStatusToJSON = runStatusToJSON;
+exports.idempotencyMethodFromJSON = idempotencyMethodFromJSON;
+exports.idempotencyMethodToJSON = idempotencyMethodToJSON;
 exports.concurrencyLimitStrategyFromJSON = concurrencyLimitStrategyFromJSON;
 exports.concurrencyLimitStrategyToJSON = concurrencyLimitStrategyToJSON;
 /* eslint-disable */
@@ -167,6 +169,37 @@ function runStatusToJSON(object) {
             return 'UNRECOGNIZED';
     }
 }
+var IdempotencyMethod;
+(function (IdempotencyMethod) {
+    IdempotencyMethod[IdempotencyMethod["TTL"] = 0] = "TTL";
+    IdempotencyMethod[IdempotencyMethod["STATUS"] = 1] = "STATUS";
+    IdempotencyMethod[IdempotencyMethod["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(IdempotencyMethod || (exports.IdempotencyMethod = IdempotencyMethod = {}));
+function idempotencyMethodFromJSON(object) {
+    switch (object) {
+        case 0:
+        case 'TTL':
+            return IdempotencyMethod.TTL;
+        case 1:
+        case 'STATUS':
+            return IdempotencyMethod.STATUS;
+        case -1:
+        case 'UNRECOGNIZED':
+        default:
+            return IdempotencyMethod.UNRECOGNIZED;
+    }
+}
+function idempotencyMethodToJSON(object) {
+    switch (object) {
+        case IdempotencyMethod.TTL:
+            return 'TTL';
+        case IdempotencyMethod.STATUS:
+            return 'STATUS';
+        case IdempotencyMethod.UNRECOGNIZED:
+        default:
+            return 'UNRECOGNIZED';
+    }
+}
 var ConcurrencyLimitStrategy;
 (function (ConcurrencyLimitStrategy) {
     ConcurrencyLimitStrategy[ConcurrencyLimitStrategy["CANCEL_IN_PROGRESS"] = 0] = "CANCEL_IN_PROGRESS";
@@ -1422,7 +1455,7 @@ exports.CreateWorkflowVersionRequest = {
     },
 };
 function createBaseIdempotencyConfig() {
-    return { expression: '', ttlMs: 0 };
+    return { expression: '', ttlMs: 0, method: undefined };
 }
 exports.IdempotencyConfig = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -1432,6 +1465,9 @@ exports.IdempotencyConfig = {
         if (message.ttlMs !== 0) {
             writer.uint32(16).int64(message.ttlMs);
         }
+        if (message.method !== undefined) {
+            writer.uint32(24).int32(message.method);
+        }
         return writer;
     },
     decode(input, length) {
@@ -1455,6 +1491,13 @@ exports.IdempotencyConfig = {
                     message.ttlMs = longToNumber(reader.int64());
                     continue;
                 }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.method = reader.int32();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1471,6 +1514,7 @@ exports.IdempotencyConfig = {
                 : isSet(object.ttl_ms)
                     ? globalThis.Number(object.ttl_ms)
                     : 0,
+            method: isSet(object.method) ? idempotencyMethodFromJSON(object.method) : undefined,
         };
     },
     toJSON(message) {
@@ -1481,27 +1525,34 @@ exports.IdempotencyConfig = {
         if (message.ttlMs !== 0) {
             obj.ttlMs = Math.round(message.ttlMs);
         }
+        if (message.method !== undefined) {
+            obj.method = idempotencyMethodToJSON(message.method);
+        }
         return obj;
     },
     create(base) {
         return exports.IdempotencyConfig.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b;
+        var _a, _b, _c;
         const message = createBaseIdempotencyConfig();
         message.expression = (_a = object.expression) !== null && _a !== void 0 ? _a : '';
         message.ttlMs = (_b = object.ttlMs) !== null && _b !== void 0 ? _b : 0;
+        message.method = (_c = object.method) !== null && _c !== void 0 ? _c : undefined;
         return message;
     },
 };
 function createBaseIdempotencyCollisionError() {
-    return { existingRunExternalId: '' };
+    return { existingRunExternalId: '', collidingRunExternalId: '' };
 }
 exports.IdempotencyCollisionError = {
     encode(message, writer = new wire_1.BinaryWriter()) {
         if (message.existingRunExternalId !== '') {
             writer.uint32(10).string(message.existingRunExternalId);
         }
+        if (message.collidingRunExternalId !== '') {
+            writer.uint32(18).string(message.collidingRunExternalId);
+        }
         return writer;
     },
     decode(input, length) {
@@ -1518,6 +1569,13 @@ exports.IdempotencyCollisionError = {
                     message.existingRunExternalId = reader.string();
                     continue;
                 }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.collidingRunExternalId = reader.string();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1533,6 +1591,11 @@ exports.IdempotencyCollisionError = {
                 : isSet(object.existing_run_external_id)
                     ? globalThis.String(object.existing_run_external_id)
                     : '',
+            collidingRunExternalId: isSet(object.collidingRunExternalId)
+                ? globalThis.String(object.collidingRunExternalId)
+                : isSet(object.colliding_run_external_id)
+                    ? globalThis.String(object.colliding_run_external_id)
+                    : '',
         };
     },
     toJSON(message) {
@@ -1540,15 +1603,19 @@ exports.IdempotencyCollisionError = {
         if (message.existingRunExternalId !== '') {
             obj.existingRunExternalId = message.existingRunExternalId;
         }
+        if (message.collidingRunExternalId !== '') {
+            obj.collidingRunExternalId = message.collidingRunExternalId;
+        }
         return obj;
     },
     create(base) {
         return exports.IdempotencyCollisionError.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a;
+        var _a, _b;
         const message = createBaseIdempotencyCollisionError();
         message.existingRunExternalId = (_a = object.existingRunExternalId) !== null && _a !== void 0 ? _a : '';
+        message.collidingRunExternalId = (_b = object.collidingRunExternalId) !== null && _b !== void 0 ? _b : '';
         return message;
     },
 };
@@ -1621,12 +1688,12 @@ exports.BulkTriggerIdempotencyCollisionError = {
         return exports.BulkTriggerIdempotencyCollisionError.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d;
+        var _a, _b;
         const message = createBaseBulkTriggerIdempotencyCollisionError();
         message.successfulWorkflowRunExternalIds =
-            (_b = (_a = object.successfulWorkflowRunExternalIds) === null || _a === void 0 ? void 0 : _a.map((e) => e)) !== null && _b !== void 0 ? _b : [];
+            ((_a = object.successfulWorkflowRunExternalIds) === null || _a === void 0 ? void 0 : _a.map((e) => e)) || [];
         message.collisions =
-            (_d = (_c = object.collisions) === null || _c === void 0 ? void 0 : _c.map((e) => exports.IdempotencyCollisionError.fromPartial(e))) !== null && _d !== void 0 ? _d : [];
+            ((_b = object.collisions) === null || _b === void 0 ? void 0 : _b.map((e) => exports.IdempotencyCollisionError.fromPartial(e))) || [];
         return message;
     },
 };
@@ -1806,6 +1873,146 @@ exports.Concurrency = {
         return message;
     },
 };
+function createBaseTaskBatchConfig() {
+    return {
+        batchMaxSize: 0,
+        batchMaxIntervalMs: undefined,
+        batchGroupKey: undefined,
+        batchGroupMaxRuns: undefined,
+        broadcastOutput: undefined,
+    };
+}
+exports.TaskBatchConfig = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.batchMaxSize !== 0) {
+            writer.uint32(8).int32(message.batchMaxSize);
+        }
+        if (message.batchMaxIntervalMs !== undefined) {
+            writer.uint32(16).int32(message.batchMaxIntervalMs);
+        }
+        if (message.batchGroupKey !== undefined) {
+            writer.uint32(26).string(message.batchGroupKey);
+        }
+        if (message.batchGroupMaxRuns !== undefined) {
+            writer.uint32(32).int32(message.batchGroupMaxRuns);
+        }
+        if (message.broadcastOutput !== undefined) {
+            writer.uint32(40).bool(message.broadcastOutput);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseTaskBatchConfig();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.batchMaxSize = reader.int32();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.batchMaxIntervalMs = reader.int32();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.batchGroupKey = reader.string();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 32) {
+                        break;
+                    }
+                    message.batchGroupMaxRuns = reader.int32();
+                    continue;
+                }
+                case 5: {
+                    if (tag !== 40) {
+                        break;
+                    }
+                    message.broadcastOutput = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            batchMaxSize: isSet(object.batchMaxSize)
+                ? globalThis.Number(object.batchMaxSize)
+                : isSet(object.batch_max_size)
+                    ? globalThis.Number(object.batch_max_size)
+                    : 0,
+            batchMaxIntervalMs: isSet(object.batchMaxIntervalMs)
+                ? globalThis.Number(object.batchMaxIntervalMs)
+                : isSet(object.batch_max_interval_ms)
+                    ? globalThis.Number(object.batch_max_interval_ms)
+                    : undefined,
+            batchGroupKey: isSet(object.batchGroupKey)
+                ? globalThis.String(object.batchGroupKey)
+                : isSet(object.batch_group_key)
+                    ? globalThis.String(object.batch_group_key)
+                    : undefined,
+            batchGroupMaxRuns: isSet(object.batchGroupMaxRuns)
+                ? globalThis.Number(object.batchGroupMaxRuns)
+                : isSet(object.batch_group_max_runs)
+                    ? globalThis.Number(object.batch_group_max_runs)
+                    : undefined,
+            broadcastOutput: isSet(object.broadcastOutput)
+                ? globalThis.Boolean(object.broadcastOutput)
+                : isSet(object.broadcast_output)
+                    ? globalThis.Boolean(object.broadcast_output)
+                    : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.batchMaxSize !== 0) {
+            obj.batchMaxSize = Math.round(message.batchMaxSize);
+        }
+        if (message.batchMaxIntervalMs !== undefined) {
+            obj.batchMaxIntervalMs = Math.round(message.batchMaxIntervalMs);
+        }
+        if (message.batchGroupKey !== undefined) {
+            obj.batchGroupKey = message.batchGroupKey;
+        }
+        if (message.batchGroupMaxRuns !== undefined) {
+            obj.batchGroupMaxRuns = Math.round(message.batchGroupMaxRuns);
+        }
+        if (message.broadcastOutput !== undefined) {
+            obj.broadcastOutput = message.broadcastOutput;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.TaskBatchConfig.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b, _c, _d, _e;
+        const message = createBaseTaskBatchConfig();
+        message.batchMaxSize = (_a = object.batchMaxSize) !== null && _a !== void 0 ? _a : 0;
+        message.batchMaxIntervalMs = (_b = object.batchMaxIntervalMs) !== null && _b !== void 0 ? _b : undefined;
+        message.batchGroupKey = (_c = object.batchGroupKey) !== null && _c !== void 0 ? _c : undefined;
+        message.batchGroupMaxRuns = (_d = object.batchGroupMaxRuns) !== null && _d !== void 0 ? _d : undefined;
+        message.broadcastOutput = (_e = object.broadcastOutput) !== null && _e !== void 0 ? _e : undefined;
+        return message;
+    },
+};
 function createBaseCreateTaskOpts() {
     return {
         readableId: '',
@@ -1823,6 +2030,7 @@ function createBaseCreateTaskOpts() {
         scheduleTimeout: undefined,
         isDurable: false,
         slotRequests: {},
+        batch: undefined,
     };
 }
 exports.CreateTaskOpts = {
@@ -1872,6 +2080,9 @@ exports.CreateTaskOpts = {
         globalThis.Object.entries(message.slotRequests).forEach(([key, value]) => {
             exports.CreateTaskOpts_SlotRequestsEntry.encode({ key: key, value }, writer.uint32(122).fork()).join();
         });
+        if (message.batch !== undefined) {
+            exports.TaskBatchConfig.encode(message.batch, writer.uint32(130).fork()).join();
+        }
         return writer;
     },
     decode(input, length) {
@@ -1992,6 +2203,13 @@ exports.CreateTaskOpts = {
                     }
                     continue;
                 }
+                case 16: {
+                    if (tag !== 130) {
+                        break;
+                    }
+                    message.batch = exports.TaskBatchConfig.decode(reader, reader.uint32());
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -2065,6 +2283,7 @@ exports.CreateTaskOpts = {
                         return acc;
                     }, {})
                     : {},
+            batch: isSet(object.batch) ? exports.TaskBatchConfig.fromJSON(object.batch) : undefined,
         };
     },
     toJSON(message) {
@@ -2127,6 +2346,9 @@ exports.CreateTaskOpts = {
                 });
             }
         }
+        if (message.batch !== undefined) {
+            obj.batch = exports.TaskBatchConfig.toJSON(message.batch);
+        }
         return obj;
     },
     create(base) {
@@ -2163,6 +2385,10 @@ exports.CreateTaskOpts = {
             }
             return acc;
         }, {});
+        message.batch =
+            object.batch !== undefined && object.batch !== null
+                ? exports.TaskBatchConfig.fromPartial(object.batch)
+                : undefined;
         return message;
     },
 };

package/protoc/workflows/workflows.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.8
+//   protoc-gen-ts_proto  v2.12.0
 //   protoc               v3.19.1
 // source: workflows/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/util/workflow-run-ref.js

@@ -90,17 +90,21 @@ class WorkflowRunRef {
             return new Promise((resolve, reject) => {
                 (() => __awaiter(this, void 0, void 0, function* () {
                     var _a, e_1, _b, _c;
-                    var _d, _e;
+                    var _d, _e, _f;
                     const signal = this.defaultSignal;
                     try {
-                        for (var _f = true, _g = __asyncValues(streamable.stream({ signal })), _h; _h = yield _g.next(), _a = _h.done, !_a; _f = true) {
-                            _c = _h.value;
-                            _f = false;
+                        for (var _g = true, _h = __asyncValues(streamable.stream({ signal })), _j; _j = yield _h.next(), _a = _j.done, !_a; _g = true) {
+                            _c = _j.value;
+                            _g = false;
                             const event = _c;
                             if (event.eventType === dispatcher_1.WorkflowRunEventType.WORKFLOW_RUN_EVENT_TYPE_FINISHED) {
-                                if (event.results.some((r) => r.error !== undefined)) {
-                                    // HACK: this might replace intentional empty errors but this is the more common case
-                                    const errors = event.results.map((r) => r.error !== '' ? r.error : 'task was cancelled');
+                                // A present-but-empty error field is ambiguous (e.g. a batch member that was
+                                // explicitly cancelled via ctx.cancel() and resolved with no further error);
+                                // only a non-empty message is treated as a genuine failure here.
+                                if (event.results.some((r) => r.error !== undefined && r.error !== '')) {
+                                    const errors = event.results
+                                        .filter((r) => r.error !== undefined && r.error !== '')
+                                        .map((r) => r.error);
                                     reject(errors);
                                     return;
                                 }
@@ -111,8 +115,18 @@ class WorkflowRunRef {
                                         reject(new Error('No job runs found'));
                                         return;
                                     }
+                                    // A task run that fails before ever being dispatched (e.g. a batch group-key
+                                    // CEL expression that fails to parse) never gets a StepRunResult in the
+                                    // WORKFLOW_RUN_EVENT_TYPE_FINISHED event, so `event.results` above is empty.
+                                    // Check step statuses here too, or this codepath would resolve as if the run
+                                    // had succeeded.
+                                    const failedStepRun = (_e = mostRecentJobRun.stepRuns) === null || _e === void 0 ? void 0 : _e.find((stepRun) => stepRun.status === 'FAILED' || stepRun.status === 'CANCELLED');
+                                    if (failedStepRun) {
+                                        reject(new Error(failedStepRun.error || failedStepRun.cancelledReason || 'task failed'));
+                                        return;
+                                    }
                                     const outputs = {};
-                                    (_e = mostRecentJobRun.stepRuns) === null || _e === void 0 ? void 0 : _e.forEach((stepRun) => {
+                                    (_f = mostRecentJobRun.stepRuns) === null || _f === void 0 ? void 0 : _f.forEach((stepRun) => {
                                         var _a, _b;
                                         const readable = (_b = (_a = mostRecentJobRun.job) === null || _a === void 0 ? void 0 : _a.steps) === null || _b === void 0 ? void 0 : _b.find((step) => step.metadata.id === stepRun.stepId);
                                         const readableStepName = `${readable === null || readable === void 0 ? void 0 : readable.readableId}`;
@@ -143,7 +157,7 @@ class WorkflowRunRef {
                     catch (e_1_1) { e_1 = { error: e_1_1 }; }
                     finally {
                         try {
-                            if (!_f && !_a && (_b = _g.return)) yield _b.call(_g);
+                            if (!_g && !_a && (_b = _h.return)) yield _b.call(_h);
                         }
                         finally { if (e_1) throw e_1.error; }
                     }

package/v1/client/client.d.ts

@@ -13,7 +13,8 @@ import { DispatcherClient } from '../../clients/dispatcher/dispatcher-client';
 import { Logger } from '../../util/logger';
 import { RunListenerClient } from '../../clients/listeners/run-listener/child-listener-client';
 import { DurableListenerClient } from '../../clients/listeners/durable-listener/durable-listener-client';
-import { CreateTaskWorkflowOpts, CreateWorkflowOpts, RunOpts, BaseWorkflowDeclaration, WorkflowDeclaration, TaskWorkflowDeclaration, CreateDurableTaskWorkflowOpts } from '../declaration';
+import { CreateTaskWorkflowOpts, CreateWorkflowOpts, RunOpts, BaseWorkflowDeclaration, WorkflowDeclaration, TaskWorkflowDeclaration, CreateDurableTaskWorkflowOpts, CreateBatchTaskWorkflowOpts } from '../declaration';
+import { BatchTaskFn } from '../task';
 import type { LegacyWorkflow } from '../../legacy/legacy-transformer';
 import { IHatchetClient } from './client.interface';
 import { CreateWorkerOpts, Worker } from './worker/worker';
@@ -103,6 +104,30 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
     task<Fn extends (input: I, ctx?: any) => O | Promise<O>, I extends InputType = Parameters<Fn>[0] | UnknownInputType, O extends OutputType = ReturnType<Fn> extends Promise<infer P> ? P extends OutputType ? P : void : ReturnType<Fn> extends OutputType ? ReturnType<Fn> : void>(options: {
         fn: Fn;
     } & Omit<CreateTaskWorkflowOpts<I, O>, 'fn'>): TaskWorkflowDeclaration<I, O, GlobalInput, GlobalOutput, MiddlewareBefore, MiddlewareAfter>;
+    /**
+     * Creates a new batch task workflow. Batch tasks buffer concurrent runs until Hatchet
+     * flushes the batch (size reached or flush interval), then invoke the handler once with
+     * all buffered inputs keyed by each run's task-run external id. The handler must return
+     * a Record mapping each id to its output, or set `batch.broadcastOutput` to return the
+     * same result to all callers. retries is always forced to 0 for batch tasks.
+     *
+     * Preview: batch tasks are in beta and may change in future releases.
+     * @template I The input type for the batch task
+     * @template O The output type of the batch task
+     * @param options Batch task configuration options
+     * @returns A TaskWorkflowDeclaration instance
+     */
+    batchTask<I extends InputType = UnknownInputType, O extends OutputType = void>(options: CreateBatchTaskWorkflowOpts<I & Resolved<GlobalInput, MiddlewareBefore>, MergeIfNonEmpty<O, GlobalOutput>>): TaskWorkflowDeclaration<I, O, GlobalInput, GlobalOutput, MiddlewareBefore, MiddlewareAfter>;
+    /**
+     * Creates a new batch task workflow with types inferred from the function parameter.
+     * @template Fn The type of the batch task function
+     * @param options Batch task configuration options with function that defines types
+     * @returns A TaskWorkflowDeclaration instance with inferred types
+     */
+    batchTask<Fn extends BatchTaskFn<I, O>, I extends InputType = Parameters<Fn>[0] extends Record<string, infer II> ? II extends InputType ? II : UnknownInputType : UnknownInputType, O extends OutputType = ReturnType<Fn> extends Promise<infer P> ? P extends OutputType ? P : void : ReturnType<Fn> extends OutputType ? ReturnType<Fn> : void>(options: {
+        fn: Fn;
+        batch: CreateBatchTaskWorkflowOpts<I, O>['batch'];
+    } & Omit<CreateBatchTaskWorkflowOpts<I, O>, 'fn' | 'batch'>): TaskWorkflowDeclaration<I, O, GlobalInput, GlobalOutput, MiddlewareBefore, MiddlewareAfter>;
     /**
      * Creates a new durable task workflow.
      * Types can be explicitly specified as generics or inferred from the function signature.

package/v1/client/client.js

@@ -166,6 +166,12 @@ class HatchetClient {
     task(options) {
         return (0, declaration_1.CreateTaskWorkflow)(options, this);
     }
+    /**
+     * Implementation of the batchTask method.
+     */
+    batchTask(options) {
+        return (0, declaration_1.CreateBatchTaskWorkflow)(options, this);
+    }
     /**
      * Implementation of the durableTask method.
      */

package/v1/client/worker/context.js

@@ -29,6 +29,7 @@ const parse_1 = require("../../../util/parse");
 const conditions_1 = require("../../conditions");
 const transformer_1 = require("../../conditions/transformer");
 const condition_1 = require("../../../protoc/v1/shared/condition");
+const dispatcher_1 = require("../../../protoc/dispatcher");
 const apply_namespace_1 = require("../../../util/apply-namespace");
 const abort_error_1 = require("../../../util/abort-error");
 const parent_run_context_vars_1 = require("../../parent-run-context-vars");
@@ -135,9 +136,28 @@ class Context {
     }
     cancel() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.v1.runs.cancel({
-                ids: [this.action.taskRunExternalId],
-            });
+            var _a, _b;
+            if (this.action.batchId) {
+                // Batch tasks share one context across every buffered member, so there is no single
+                // task-run id to cancel — cancel every member of the batch instead. `this.data` is
+                // the raw batch-items map for a START_BATCH action, keyed by each member's
+                // task-run external id.
+                const memberIds = Object.keys((_a = this.data) !== null && _a !== void 0 ? _a : {});
+                yield this.v1.dispatcher.sendBatchActionEvent({
+                    workerId: (_b = this.worker.id()) !== null && _b !== void 0 ? _b : '',
+                    jobId: this.action.jobId,
+                    actionId: this.action.actionId,
+                    batchId: this.action.batchId,
+                    eventTimestamp: new Date(),
+                    eventType: dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_CANCELLED,
+                    items: memberIds.map((id) => ({ taskRunExternalId: id, eventPayload: '' })),
+                });
+            }
+            else {
+                yield this.v1.runs.cancel({
+                    ids: [this.action.taskRunExternalId],
+                });
+            }
             // optimistically abort the run
             this.controller.abort();
         });