@hatchet-dev/typescript-sdk 1.27.0 → 1.28.0

package/v1/examples/e2e-worker.js

@@ -37,13 +37,14 @@ const workflow_16 = require("./on_event/workflow");
 const workflow_17 = require("./return_exceptions/workflow");
 const workflow_18 = require("./run_details/workflow");
 const e2e_workflows_1 = require("./simple/e2e-workflows");
-const workflow_19 = require("./streaming/workflow");
-const workflow_20 = require("./timeout/workflow");
-const workflow_21 = require("./webhooks/workflow");
-const workflow_22 = require("./child_index/workflow");
-const workflow_23 = require("./support_agent/workflow");
-const workflow_24 = require("./welcome_email/workflow");
-const workflow_25 = require("./pdf_pipeline/workflow");
+const workflow_19 = require("./batch_assign/workflow");
+const workflow_20 = require("./streaming/workflow");
+const workflow_21 = require("./timeout/workflow");
+const workflow_22 = require("./webhooks/workflow");
+const workflow_23 = require("./child_index/workflow");
+const workflow_24 = require("./support_agent/workflow");
+const workflow_25 = require("./welcome_email/workflow");
+const workflow_26 = require("./pdf_pipeline/workflow");
 const workflows = [
     workflow_1.bulkChild,
     workflow_1.bulkParentWorkflow,
@@ -94,20 +95,33 @@ const workflows = [
     workflow_18.runDetailTestWorkflow,
     e2e_workflows_1.helloWorld,
     e2e_workflows_1.helloWorldDurable,
-    workflow_19.streamingTask,
-    workflow_20.timeoutTask,
-    workflow_20.refreshTimeoutTask,
-    workflow_21.webhookWorkflow,
-    workflow_22.childIndexChild,
-    workflow_22.childIndexParent,
-    workflow_22.scenarioTask,
-    workflow_22.orchestratorTask,
-    workflow_23.supportAgent,
-    workflow_23.triageTicket,
-    workflow_23.generateReply,
-    workflow_23.escalateTicket,
-    workflow_24.welcomeEmail,
-    workflow_25.pdfPipeline,
+    workflow_20.streamingTask,
+    workflow_21.timeoutTask,
+    workflow_21.refreshTimeoutTask,
+    workflow_22.webhookWorkflow,
+    workflow_23.childIndexChild,
+    workflow_23.childIndexParent,
+    workflow_23.scenarioTask,
+    workflow_23.orchestratorTask,
+    workflow_24.supportAgent,
+    workflow_24.triageTicket,
+    workflow_24.generateReply,
+    workflow_24.escalateTicket,
+    workflow_25.welcomeEmail,
+    workflow_26.pdfPipeline,
+    workflow_19.batchSimple,
+    workflow_19.batchKeyed,
+    workflow_19.batchKeyedFailable,
+    workflow_19.batchKeyedInterval,
+    workflow_19.batchLarge,
+    workflow_19.batchSingle,
+    workflow_19.batchOrdered,
+    workflow_19.batchBroadcast,
+    workflow_19.batchCancel,
+    workflow_19.child,
+    workflow_19.childBatch,
+    workflow_19.batchChildSpawn,
+    workflow_19.batchChildBatchSpawn,
 ];
 function main() {
     return __awaiter(this, void 0, void 0, function* () {

package/v1/task.d.ts

@@ -77,6 +77,48 @@ export declare class NonRetryableError extends Error {
 }
 export type TaskFn<I extends InputType = UnknownInputType, O extends OutputType = void, C = Context<I>> = (input: I, ctx: C) => O | Promise<O>;
 export type DurableTaskFn<I extends InputType = UnknownInputType, O extends OutputType = void> = TaskFn<I, O, DurableContext<I>>;
+/**
+ * Configures a task as a batch task: concurrent runs are buffered and dispatched together
+ * as a single execution once maxSize is reached, maxInterval elapses, or (if groupKey is
+ * set) once groupMaxRuns concurrent batches per group are exceeded.
+ *
+ * Preview: batch tasks are in beta and may change in future releases.
+ */
+export type BatchTaskConfig = {
+    /**
+     * Maximum number of items buffered before the batch is flushed. Must be positive.
+     */
+    maxSize: number;
+    /**
+     * (optional) maximum time to wait before flushing a partially-filled batch.
+     * go duration format (e.g., "1s", "5m", "1h").
+     */
+    maxInterval?: Duration;
+    /**
+     * (optional) CEL expression evaluated against each item's input to partition items into
+     * independent batches, e.g. "input.group". When unset, all items buffered for the task
+     * share a single batch.
+     */
+    groupKey?: string;
+    /**
+     * (optional) maximum number of concurrent batches per group.
+     */
+    groupMaxRuns?: number;
+    /**
+     * (optional) when true, the handler returns a single value that is broadcast as the
+     * result to every member of the batch, instead of a Record keyed by batch member id.
+     *
+     * default: false
+     */
+    broadcastOutput?: boolean;
+};
+/**
+ * The function signature for a batch task's handler. `input` maps each buffered run's
+ * task-run external id (its "batch member id") to that run's input. Unless
+ * `batch.broadcastOutput` is set, the handler must return a Record with the exact same
+ * key set, mapping each id to that run's output.
+ */
+export type BatchTaskFn<I extends InputType = UnknownInputType, O extends OutputType = void> = (input: Record<string, I>, ctx: Context<Record<string, I>>) => O | Promise<O>;
 /**
  * Options for creating a hatchet task which is an atomic unit of work in a workflow.
  * @template I The input type for the task function.
@@ -168,6 +210,13 @@ export type CreateBaseTaskOpts<I extends InputType = UnknownInputType, O extends
     slotCost?: number;
     /** @internal */
     slotRequests?: Record<string, number>;
+    /**
+     * (optional) configures this task as a batch task. Not available on durable tasks.
+     * retries is always forced to 0 when batch is set.
+     *
+     * Preview: batch tasks are in beta and may change in future releases.
+     */
+    batch?: BatchTaskConfig;
 };
 export type CreateWorkflowTaskOpts<I extends InputType = UnknownInputType, O extends OutputType = void, C extends TaskFn<I, O> | DurableTaskFn<I, O> = TaskFn<I, O>> = CreateBaseTaskOpts<I, O, C> & {
     /**
@@ -233,7 +282,7 @@ export type CreateWorkflowTaskOpts<I extends InputType = UnknownInputType, O ext
  * @template I The input type for the task function.
  * @template O The return type of the task function (can be inferred from the return value of fn).
  */
-export type CreateWorkflowDurableTaskOpts<I extends InputType = UnknownInputType, O extends OutputType = void, C extends DurableTaskFn<I, O> = DurableTaskFn<I, O>> = Omit<CreateWorkflowTaskOpts<I, O, C>, 'slotCost'> & {
+export type CreateWorkflowDurableTaskOpts<I extends InputType = UnknownInputType, O extends OutputType = void, C extends DurableTaskFn<I, O> = DurableTaskFn<I, O>> = Omit<CreateWorkflowTaskOpts<I, O, C>, 'slotCost' | 'batch'> & {
     /**
      * Eviction policy for the durable task. Controls TTL-based eviction and capacity-based eviction.
      * Defaults to the built-in eviction policy when omitted or `undefined`.

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.27.0";
+export declare const HATCHET_VERSION = "1.28.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.27.0';
+exports.HATCHET_VERSION = '1.28.0';