@hatchet-dev/typescript-sdk 1.24.2 → 1.25.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "1.24.2",
+  "version": "1.25.0",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -38,6 +38,7 @@
     "@types/jest": "^29.5.14",
     "@types/node": "^22.13.14",
     "autoprefixer": "^10.4.27",
+    "postcss": "^8.5.10",
     "dotenv-cli": "^7.4.4",
     "eslint": "^10.0.3",
     "eslint-config-prettier": "^10.1.8",
@@ -58,11 +59,11 @@
     "@anthropic-ai/claude-agent-sdk": "^0.3.148",
     "@grpc/grpc-js": "^1.14.3",
     "@modelcontextprotocol/sdk": "^1.29.0",
-    "@openai/agents": "0.11.6",
+    "@openai/agents": "0.12.1",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/core": "^2.0.0",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0.218.0",
-    "@opentelemetry/instrumentation": "^0.218.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.220.0",
+    "@opentelemetry/instrumentation": "^0.220.0",
     "@opentelemetry/sdk-trace-base": "^2.0.0",
     "prom-client": "^15.1.3",
     "typedoc": "^0.28.17",
@@ -90,11 +91,11 @@
     "@anthropic-ai/claude-agent-sdk": "^0.3.148",
     "@grpc/grpc-js": "^1.14.3",
     "@modelcontextprotocol/sdk": "^1.29.0",
-    "@openai/agents": "0.11.6",
+    "@openai/agents": "0.12.1",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/core": "^2.0.0",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0.218.0",
-    "@opentelemetry/instrumentation": "^0.218.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.220.0",
+    "@opentelemetry/instrumentation": "^0.220.0",
     "@opentelemetry/sdk-trace-base": "^2.0.0",
     "prom-client": "^15.1.3"
   },

package/v1/client/client.d.ts

@@ -46,8 +46,6 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
     /** The tenant ID for the Hatchet client */
     tenantId: string;
     logger: Logger;
-    _isV1: boolean | undefined;
-    get isV1(): boolean;
     /**
      * Creates a new Hatchet client instance.
      * @param config - Optional configuration for the client
@@ -132,7 +130,7 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
      * @param options - Configuration options for the workflow run
      * @returns A WorkflowRunRef containing the run ID and methods to interact with the run
      */
-    runNoWait<I extends InputType = UnknownInputType, O extends OutputType = void>(workflow: BaseWorkflowDeclaration<I, O> | LegacyWorkflow | string, input: I, options: RunOpts): Promise<WorkflowRunRef<O>>;
+    runNoWait<I extends InputType = UnknownInputType, O extends OutputType = void>(workflow: BaseWorkflowDeclaration<I, O> | LegacyWorkflow | string, input: I, options?: RunOpts): Promise<WorkflowRunRef<O>>;
     /**
      * Triggers a workflow run and waits for the result.
      * @template I - The input type for the workflow

package/v1/client/client.js

@@ -54,9 +54,6 @@ class HatchetClient {
         }
         return this._v0;
     }
-    get isV1() {
-        return true;
-    }
     /**
      * Creates a new Hatchet client instance.
      * @param config - Optional configuration for the client
@@ -66,7 +63,6 @@ class HatchetClient {
      */
     constructor(config, options, axiosConfig) {
         var _a;
-        this._isV1 = true;
         try {
             const loaded = config_loader_1.ConfigLoader.loadClientConfig(config, {
                 path: options === null || options === void 0 ? void 0 : options.config_path,
@@ -185,8 +181,8 @@ class HatchetClient {
      * @param options - Configuration options for the workflow run
      * @returns A WorkflowRunRef containing the run ID and methods to interact with the run
      */
-    runNoWait(workflow, input, options) {
-        return __awaiter(this, void 0, void 0, function* () {
+    runNoWait(workflow_1, input_1) {
+        return __awaiter(this, arguments, void 0, function* (workflow, input, options = {}) {
             const name = (0, legacy_transformer_1.getWorkflowName)(workflow);
             return this.admin.runWorkflow(name, input, options);
         });

package/v1/client/worker/worker-internal.d.ts

@@ -87,6 +87,11 @@ export declare class InternalWorker {
     handleAction(action: Action): Promise<void | Error>;
     upsertLabels(labels: WorkerLabels): Promise<WorkerLabels>;
 }
+/** Durable tasks stay on the durable pool; slotCost applies only to the default pool. */
+export declare function mapSlotRequestsPb(task: {
+    slotRequests?: Record<string, number>;
+    slotCost?: number;
+}, isDurable: boolean): Record<string, number>;
 export declare function mapRateLimitPb(limits: CreateWorkflowTaskOpts<any, any>['rateLimits']): CreateStepRateLimit[];
 export declare function resolveExecutionTimeout(task: {
     executionTimeout?: Duration;

package/v1/client/worker/worker-internal.js

@@ -53,6 +53,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalWorker = void 0;
+exports.mapSlotRequestsPb = mapSlotRequestsPb;
 exports.mapRateLimitPb = mapRateLimitPb;
 exports.resolveExecutionTimeout = resolveExecutionTimeout;
 exports.resolveScheduleTimeout = resolveScheduleTimeout;
@@ -206,7 +207,7 @@ class InternalWorker {
                         backoffFactor: ((_g = onFailure.backoff) === null || _g === void 0 ? void 0 : _g.factor) || ((_j = (_h = workflow.taskDefaults) === null || _h === void 0 ? void 0 : _h.backoff) === null || _j === void 0 ? void 0 : _j.factor),
                         backoffMaxSeconds: ((_k = onFailure.backoff) === null || _k === void 0 ? void 0 : _k.maxSeconds) || ((_m = (_l = workflow.taskDefaults) === null || _l === void 0 ? void 0 : _l.backoff) === null || _m === void 0 ? void 0 : _m.maxSeconds),
                         isDurable: false,
-                        slotRequests: { default: 1 },
+                        slotRequests: mapSlotRequestsPb(onFailure, false),
                     };
                 }
                 let onSuccessTask;
@@ -316,7 +317,7 @@ class InternalWorker {
                             backoffMaxSeconds: ((_j = task.backoff) === null || _j === void 0 ? void 0 : _j.maxSeconds) || ((_l = (_k = workflow.taskDefaults) === null || _k === void 0 ? void 0 : _k.backoff) === null || _l === void 0 ? void 0 : _l.maxSeconds),
                             conditions: (0, transformer_1.taskConditionsToPb)(task, this.client.config.namespace),
                             isDurable: durableTaskSet.has(task),
-                            slotRequests: task.slotRequests || (durableTaskSet.has(task) ? { durable: 1 } : { default: 1 }),
+                            slotRequests: mapSlotRequestsPb(task, durableTaskSet.has(task)),
                             concurrency: task.concurrency
                                 ? Array.isArray(task.concurrency)
                                     ? task.concurrency
@@ -863,6 +864,22 @@ function getLeaves(tasks) {
 function isLeafTask(task, allTasks) {
     return !allTasks.some((t) => { var _a; return (_a = t.parents) === null || _a === void 0 ? void 0 : _a.some((p) => p.name === task.name); });
 }
+/** Durable tasks stay on the durable pool; slotCost applies only to the default pool. */
+function mapSlotRequestsPb(task, isDurable) {
+    if (task.slotRequests) {
+        return task.slotRequests;
+    }
+    if (isDurable) {
+        return { durable: 1 };
+    }
+    if (task.slotCost !== undefined) {
+        if (!Number.isInteger(task.slotCost) || task.slotCost <= 0) {
+            throw new Error(`slotCost must be a positive integer, got: ${task.slotCost}`);
+        }
+        return { default: task.slotCost };
+    }
+    return { default: 1 };
+}
 function mapRateLimitPb(limits) {
     if (!limits) {
         return [];

package/v1/declaration.d.ts

@@ -425,7 +425,7 @@ export declare class WorkflowDeclaration<I extends InputType = UnknownInputType,
      * @param options The task configuration options.
      * @returns The task options that were added.
      */
-    task<Name extends string, Fn extends Name extends keyof O ? (input: I & MiddlewareBefore, ctx: Context<I & MiddlewareBefore>) => O[Name] extends OutputType ? O[Name] | Promise<O[Name]> : void : (input: I & MiddlewareBefore, ctx: Context<I & MiddlewareBefore>) => void, FnReturn = ReturnType<Fn> extends Promise<infer P> ? P : ReturnType<Fn>, TO extends OutputType = Name extends keyof O ? O[Name] extends OutputType ? O[Name] : never : FnReturn extends OutputType ? FnReturn : never>(options: (Omit<CreateWorkflowTaskOpts<I, TO>, 'fn'> & {
+    task<Name extends string, Fn extends (Name extends keyof O ? (input: I & MiddlewareBefore, ctx: Context<I & MiddlewareBefore>) => O[Name] extends OutputType ? O[Name] | Promise<O[Name]> : void : (input: I & MiddlewareBefore, ctx: Context<I & MiddlewareBefore>) => void), FnReturn = ReturnType<Fn> extends Promise<infer P> ? P : ReturnType<Fn>, TO extends OutputType = Name extends keyof O ? O[Name] extends OutputType ? O[Name] : never : FnReturn extends OutputType ? FnReturn : never>(options: (Omit<CreateWorkflowTaskOpts<I, TO>, 'fn'> & {
         name: Name;
         fn?: Fn;
     }) | TaskWorkflowDeclaration<I, TO>): CreateWorkflowTaskOpts<I, TO>;
@@ -460,7 +460,7 @@ export declare class WorkflowDeclaration<I extends InputType = UnknownInputType,
      * @param options The task configuration options.
      * @returns The task options that were added.
      */
-    durableTask<Name extends string, Fn extends Name extends keyof O ? (input: I & MiddlewareBefore, ctx: DurableContext<I & MiddlewareBefore>) => O[Name] extends OutputType ? O[Name] | Promise<O[Name]> : void : (input: I & MiddlewareBefore, ctx: DurableContext<I & MiddlewareBefore>) => void, FnReturn = ReturnType<Fn> extends Promise<infer P> ? P : ReturnType<Fn>, TO extends OutputType = Name extends keyof O ? O[Name] extends OutputType ? O[Name] : never : FnReturn extends OutputType ? FnReturn : never>(options: Omit<CreateWorkflowTaskOpts<I, TO>, 'fn'> & {
+    durableTask<Name extends string, Fn extends (Name extends keyof O ? (input: I & MiddlewareBefore, ctx: DurableContext<I & MiddlewareBefore>) => O[Name] extends OutputType ? O[Name] | Promise<O[Name]> : void : (input: I & MiddlewareBefore, ctx: DurableContext<I & MiddlewareBefore>) => void), FnReturn = ReturnType<Fn> extends Promise<infer P> ? P : ReturnType<Fn>, TO extends OutputType = Name extends keyof O ? O[Name] extends OutputType ? O[Name] : never : FnReturn extends OutputType ? FnReturn : never>(options: Omit<CreateWorkflowTaskOpts<I, TO>, 'fn' | 'slotCost'> & {
         name: Name;
         fn: Fn;
     }): CreateWorkflowDurableTaskOpts<I, TO>;

package/v1/examples/bulk_operations/cancel.d.ts

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

package/v1/examples/bulk_operations/cancel.js

@@ -0,0 +1,52 @@
+"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 data_contracts_1 = require("../../../clients/rest/generated/data-contracts");
+const hatchet_client_1 = require("../hatchet-client");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c;
+        // > Setup
+        const workflows = yield hatchet_client_1.hatchet.workflows.list();
+        if (!((_a = workflows.rows) === null || _a === void 0 ? void 0 : _a.length)) {
+            throw new Error('no workflows found');
+        }
+        const [workflow] = workflows.rows;
+        // !!
+        // > List runs
+        const workflowRuns = yield hatchet_client_1.hatchet.runs.list({
+            workflowNames: [workflow.name],
+        });
+        // !!
+        // > Cancel by run ids
+        const runIds = (_c = (_b = workflowRuns.rows) === null || _b === void 0 ? void 0 : _b.map((run) => run.metadata.id)) !== null && _c !== void 0 ? _c : [];
+        // to replay runs by their ids, use `hatchet.runs.replay` instead
+        yield hatchet_client_1.hatchet.runs.cancel({ ids: runIds });
+        // !!
+        // > Cancel by filters
+        // to replay runs matching filters, use `hatchet.runs.replay` instead
+        yield hatchet_client_1.hatchet.runs.cancel({
+            filters: {
+                since: new Date(Date.now() - 24 * 60 * 60 * 1000),
+                until: new Date(),
+                statuses: [data_contracts_1.V1TaskStatus.RUNNING],
+                workflowNames: [workflow.name],
+                additionalMetadata: { key: 'value' },
+            },
+        });
+        // !!
+    });
+}
+if (require.main === module) {
+    main()
+        .catch(console.error)
+        .finally(() => process.exit(0));
+}

package/v1/examples/concurrency_cancel_in_progress/workflow.js

@@ -16,6 +16,7 @@ exports.concurrencyCancelInProgressWorkflow = void 0;
 const sleep_1 = __importDefault(require("../../../util/sleep"));
 const v1_1 = require("../..");
 const hatchet_client_1 = require("../hatchet-client");
+// > Cancel In Progress
 exports.concurrencyCancelInProgressWorkflow = hatchet_client_1.hatchet.workflow({
     name: 'concurrencycancelinprogress',
     concurrency: {
@@ -24,6 +25,7 @@ exports.concurrencyCancelInProgressWorkflow = hatchet_client_1.hatchet.workflow(
         limitStrategy: v1_1.ConcurrencyLimitStrategy.CANCEL_IN_PROGRESS,
     },
 });
+// !!
 const step1 = exports.concurrencyCancelInProgressWorkflow.task({
     name: 'step1',
     fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {

package/v1/examples/concurrency_cancel_newest/workflow.js

@@ -16,6 +16,7 @@ exports.concurrencyCancelNewestWorkflow = void 0;
 const sleep_1 = __importDefault(require("../../../util/sleep"));
 const v1_1 = require("../..");
 const hatchet_client_1 = require("../hatchet-client");
+// > Cancel Newest
 exports.concurrencyCancelNewestWorkflow = hatchet_client_1.hatchet.workflow({
     name: 'concurrencycancelnewest',
     concurrency: {
@@ -24,6 +25,7 @@ exports.concurrencyCancelNewestWorkflow = hatchet_client_1.hatchet.workflow({
         limitStrategy: v1_1.ConcurrencyLimitStrategy.CANCEL_NEWEST,
     },
 });
+// !!
 const step1 = exports.concurrencyCancelNewestWorkflow.task({
     name: 'step1',
     fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {

package/v1/examples/dag_match_condition/complex-workflow.js

@@ -87,6 +87,21 @@ const waitForEvent = exports.taskConditionWorkflow.task({
     },
 });
 // !!
+// > Add multiple or groups
+exports.taskConditionWorkflow.task({
+    name: 'waitForOrGroups',
+    parents: [start],
+    waitFor: [
+        (0, conditions_1.Or)(new parent_condition_1.ParentCondition(start, 'output.randomNumber > 50'), new conditions_1.SleepCondition('30s')),
+        (0, conditions_1.Or)(new parent_condition_1.ParentCondition(start, 'output.randomNumber > 50'), new conditions_1.UserEventCondition('payment:processed', 'true')),
+    ],
+    fn: () => {
+        return {
+            randomNumber: Math.floor(Math.random() * 100) + 1,
+        };
+    },
+});
+// !!
 // > Add sum
 exports.taskConditionWorkflow.task({
     name: 'sum',

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

@@ -0,0 +1,2 @@
+export declare const omega: import("../..").TaskWorkflowDeclaration<import("../..").UnknownInputType, void, {}, {}, {}, {}>;
+export declare const weenie: import("../..").TaskWorkflowDeclaration<import("../..").UnknownInputType, void, {}, {}, {}, {}>;

package/v1/examples/slot_cost/workflow.js

@@ -0,0 +1,29 @@
+"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 });
+exports.weenie = exports.omega = void 0;
+// > Slot cost
+const hatchet_client_1 = require("../hatchet-client");
+exports.omega = hatchet_client_1.hatchet.task({
+    name: 'omega',
+    slotCost: 5,
+    fn: () => __awaiter(void 0, void 0, void 0, function* () {
+        console.log('heavy work');
+    }),
+});
+exports.weenie = hatchet_client_1.hatchet.task({
+    name: 'weenie',
+    slotCost: 1,
+    fn: () => __awaiter(void 0, void 0, void 0, function* () {
+        console.log('light work');
+    }),
+});
+// !!

package/v1/examples/timeout/worker.js

@@ -11,6 +11,7 @@ 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");
+// > Slots
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         const worker = yield hatchet_client_1.hatchet.worker('timeout-worker', {
@@ -20,6 +21,7 @@ function main() {
         yield worker.start();
     });
 }
+// !!
 if (require.main === module) {
     main();
 }

package/v1/task.d.ts

@@ -120,6 +120,16 @@ export type CreateBaseTaskOpts<I extends InputType = UnknownInputType, O extends
      * (optional) the concurrency options for the task
      */
     concurrency?: Concurrency | Concurrency[];
+    /**
+     * (optional) the number of default worker slots this task consumes.
+     *
+     * A worker has a fixed number of slots (default 100), and a normal task consumes one. Set slotCost
+     * higher for a task that needs more memory or CPU, so a worker runs fewer of them at once. A single
+     * worker must have that many free slots to run it. Not available on durable tasks.
+     *
+     * default: 1
+     */
+    slotCost?: number;
     /** @internal */
     slotRequests?: Record<string, number>;
 };
@@ -187,7 +197,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>> = CreateWorkflowTaskOpts<I, O, C> & {
+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'> & {
     /**
      * 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.24.2";
+export declare const HATCHET_VERSION = "1.25.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.24.2';
+exports.HATCHET_VERSION = '1.25.0';