@hatchet-dev/typescript-sdk 1.15.2 → 1.17.0

package/v1/client/client.js

@@ -1,4 +1,10 @@
 "use strict";
+/**
+ * This is the TypeScript SDK reference, documenting methods available for interacting with Hatchet resources.
+ * Check out the [user guide](https://docs.hatchet.run/home/) for an introduction to getting your first tasks running.
+ *
+ * @module Hatchet TypeScript SDK Reference
+ */
 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) {
@@ -13,14 +19,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HatchetClient = void 0;
-/**
- * This is the TypeScript SDK reference, documenting methods available for interacting with Hatchet resources.
- * Check out the [user guide](https://docs.hatchet.run/home/) for an introduction to getting your first tasks running.
- *
- * @module Hatchet TypeScript SDK Reference
- */
-/* eslint-disable no-dupe-class-members */
-/* eslint-disable no-underscore-dangle */
 const hatchet_client_1 = require("../../clients/hatchet-client");
 const rest_1 = __importDefault(require("../../clients/rest"));
 const config_loader_1 = require("../../util/config-loader");
@@ -35,18 +33,8 @@ const nice_grpc_1 = require("nice-grpc");
 const declaration_1 = require("../declaration");
 const legacy_transformer_1 = require("../../legacy/legacy-transformer");
 const worker_1 = require("./worker/worker");
-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");
 const admin_1 = require("./admin");
-const filters_1 = require("./features/filters");
-const schedules_1 = require("./features/schedules");
-const crons_1 = require("./features/crons");
-const cel_1 = require("./features/cel");
-const tenant_1 = require("./features/tenant");
-const webhooks_1 = require("./features/webhooks");
 /**
  * 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.
@@ -102,7 +90,7 @@ class HatchetClient {
         }
         catch (e) {
             if (e instanceof zod_1.z.ZodError) {
-                throw new Error(`Invalid client config: ${e.message}`);
+                throw new Error(`Invalid client config: ${e.message}`, { cause: e });
             }
             throw e;
         }
@@ -120,7 +108,7 @@ class HatchetClient {
                 // Do nothing here
             });
         }
-        catch (e) {
+        catch (_b) {
             // Do nothing here
         }
     }
@@ -148,10 +136,12 @@ class HatchetClient {
     withMiddleware(middleware) {
         const existing = this._config.middleware || {};
         const toArray = (v) => {
-            if (v == null)
+            if (v == null) {
                 return [];
-            if (Array.isArray(v))
+            }
+            if (Array.isArray(v)) {
                 return [...v];
+            }
             return [v];
         };
         this._config.middleware = {
@@ -238,7 +228,7 @@ class HatchetClient {
      */
     get cel() {
         if (!this._cel) {
-            this._cel = new cel_1.CELClient(this);
+            this._cel = new features_1.CELClient(this);
         }
         return this._cel;
     }
@@ -248,7 +238,7 @@ class HatchetClient {
      */
     get crons() {
         if (!this._crons) {
-            this._crons = new crons_1.CronClient(this);
+            this._crons = new features_1.CronClient(this);
         }
         return this._crons;
     }
@@ -267,7 +257,7 @@ class HatchetClient {
      */
     get scheduled() {
         if (!this._scheduled) {
-            this._scheduled = new schedules_1.ScheduleClient(this);
+            this._scheduled = new features_1.ScheduleClient(this);
         }
         return this._scheduled;
     }
@@ -314,7 +304,7 @@ class HatchetClient {
      */
     get durableListener() {
         if (!this._durableListener) {
-            this._durableListener = new durable_listener_client_1.DurableListenerClient(this._config, (0, grpc_helpers_1.channelFactory)(this._config, this._credentials), this._clientFactory, this.api);
+            this._durableListener = new durable_listener_client_1.DurableListenerClient(this._config, (0, grpc_helpers_1.channelFactory)(this._config, this._credentials), this._clientFactory);
         }
         return this._durableListener;
     }
@@ -339,7 +329,7 @@ class HatchetClient {
      */
     get metrics() {
         if (!this._metrics) {
-            this._metrics = new metrics_1.MetricsClient(this);
+            this._metrics = new features_1.MetricsClient(this);
         }
         return this._metrics;
     }
@@ -349,7 +339,7 @@ class HatchetClient {
      */
     get filters() {
         if (!this._filters) {
-            this._filters = new filters_1.FiltersClient(this);
+            this._filters = new features_1.FiltersClient(this);
         }
         return this._filters;
     }
@@ -359,7 +349,7 @@ class HatchetClient {
      */
     get tenant() {
         if (!this._tenant) {
-            this._tenant = new tenant_1.TenantClient(this);
+            this._tenant = new features_1.TenantClient(this);
         }
         return this._tenant;
     }
@@ -369,10 +359,20 @@ class HatchetClient {
      */
     get webhooks() {
         if (!this._webhooks) {
-            this._webhooks = new webhooks_1.WebhooksClient(this);
+            this._webhooks = new features_1.WebhooksClient(this);
         }
         return this._webhooks;
     }
+    /**
+     * Get the logs client for creating and managing logs
+     * @returns A logs client instance
+     */
+    get logs() {
+        if (!this._logs) {
+            this._logs = new features_1.LogsClient(this);
+        }
+        return this._logs;
+    }
     /**
      * Get the rate limits client for creating and managing rate limits
      * @returns A rate limits client instance
@@ -389,7 +389,7 @@ class HatchetClient {
      */
     get runs() {
         if (!this._runs) {
-            this._runs = new runs_1.RunsClient(this);
+            this._runs = new features_1.RunsClient(this);
         }
         return this._runs;
     }
@@ -399,7 +399,7 @@ class HatchetClient {
      */
     get workflows() {
         if (!this._workflows) {
-            this._workflows = new workflows_1.WorkflowsClient(this);
+            this._workflows = new features_1.WorkflowsClient(this);
         }
         return this._workflows;
     }
@@ -416,7 +416,7 @@ class HatchetClient {
      */
     get workers() {
         if (!this._workers) {
-            this._workers = new workers_1.WorkersClient(this);
+            this._workers = new features_1.WorkersClient(this);
         }
         return this._workers;
     }
@@ -445,13 +445,7 @@ class HatchetClient {
      * @returns A promise that resolves with a new HatchetWorker instance
      */
     worker(name, options) {
-        let opts = {};
-        if (typeof options === 'number') {
-            opts = { slots: options };
-        }
-        else {
-            opts = options || {};
-        }
+        const opts = typeof options === 'number' ? { slots: options } : (options !== null && options !== void 0 ? options : {});
         return worker_1.Worker.create(this, name, opts);
     }
     runRef(id) {

package/v1/client/duration.d.ts

@@ -3,5 +3,15 @@ type MinutesDuration = `${number}m`;
 type HoursDuration = `${number}h`;
 type TwoUnitDurations = `${number}h${number}m` | `${number}h${number}s` | `${number}m${number}s`;
 type ThreeUnitDurations = `${number}h${number}m${number}s`;
-export type Duration = SecondsDuration | MinutesDuration | HoursDuration | TwoUnitDurations | ThreeUnitDurations;
+type DurationString = SecondsDuration | MinutesDuration | HoursDuration | TwoUnitDurations | ThreeUnitDurations;
+export interface DurationObject {
+    hours?: number;
+    minutes?: number;
+    seconds?: number;
+}
+/** A number is treated as milliseconds. */
+export type Duration = DurationString | DurationObject | number;
+/** Normalizes a Duration to Go-style string format (e.g. "1h30m5s"). */
+export declare function durationToString(d: Duration): string;
+export declare function durationToMs(d: Duration): number;
 export {};

package/v1/client/duration.js

@@ -1,2 +1,46 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.durationToString = durationToString;
+exports.durationToMs = durationToMs;
+const DURATION_RE = /^(?:(\d+)h)?(?:(\d+)m)?(?:(\d+)s)?$/;
+/** Normalizes a Duration to Go-style string format (e.g. "1h30m5s"). */
+function durationToString(d) {
+    if (typeof d === 'string')
+        return d;
+    if (typeof d === 'number') {
+        const totalSeconds = Math.floor(d / 1000);
+        const h = Math.floor(totalSeconds / 3600);
+        const m = Math.floor((totalSeconds % 3600) / 60);
+        const s = totalSeconds % 60;
+        let out = '';
+        if (h)
+            out += `${h}h`;
+        if (m)
+            out += `${m}m`;
+        if (s || !out)
+            out += `${s}s`;
+        return out;
+    }
+    let s = '';
+    if (d.hours)
+        s += `${d.hours}h`;
+    if (d.minutes)
+        s += `${d.minutes}m`;
+    if (d.seconds)
+        s += `${d.seconds}s`;
+    return s || '0s';
+}
+function durationToMs(d) {
+    var _a, _b, _c;
+    if (typeof d === 'number')
+        return d;
+    if (typeof d === 'object') {
+        return (((_a = d.hours) !== null && _a !== void 0 ? _a : 0) * 3600 + ((_b = d.minutes) !== null && _b !== void 0 ? _b : 0) * 60 + ((_c = d.seconds) !== null && _c !== void 0 ? _c : 0)) * 1000;
+    }
+    const match = d.match(DURATION_RE);
+    if (!match) {
+        throw new Error(`Invalid duration string: "${d}". Expected format like "1h30m5s", "10m", "30s".`);
+    }
+    const [, h, m, s] = match;
+    return ((parseInt(h !== null && h !== void 0 ? h : '0', 10) * 3600 + parseInt(m !== null && m !== void 0 ? m : '0', 10) * 60 + parseInt(s !== null && s !== void 0 ? s : '0', 10)) * 1000);
+}

package/v1/client/features/cel.js

@@ -51,7 +51,7 @@ class CELClient {
             }
             catch (err) {
                 if (err instanceof axios_1.AxiosError) {
-                    throw new Error(JSON.stringify((_a = err.response) === null || _a === void 0 ? void 0 : _a.data.errors));
+                    throw new Error(JSON.stringify((_a = err.response) === null || _a === void 0 ? void 0 : _a.data.errors), { cause: err });
                 }
                 throw err;
             }

package/v1/client/features/crons.js

@@ -84,10 +84,10 @@ class CronClient {
             }
             catch (err) {
                 if (err instanceof zod_1.z.ZodError) {
-                    throw new Error(`Invalid cron input: ${err.message}`);
+                    throw new Error(`Invalid cron input: ${err.message}`, { cause: err });
                 }
                 if (err instanceof axios_1.AxiosError) {
-                    throw new Error(JSON.stringify((_c = err.response) === null || _c === void 0 ? void 0 : _c.data.errors));
+                    throw new Error(JSON.stringify((_c = err.response) === null || _c === void 0 ? void 0 : _c.data.errors), { cause: err });
                 }
                 throw err;
             }

package/v1/client/features/index.d.ts

@@ -5,3 +5,8 @@ export * from './runs';
 export * from './workers';
 export * from './workflows';
 export * from './schedules';
+export * from './logs';
+export * from './filters';
+export * from './tenant';
+export * from './webhooks';
+export * from './cel';

package/v1/client/features/index.js

@@ -21,3 +21,8 @@ __exportStar(require("./runs"), exports);
 __exportStar(require("./workers"), exports);
 __exportStar(require("./workflows"), exports);
 __exportStar(require("./schedules"), exports);
+__exportStar(require("./logs"), exports);
+__exportStar(require("./filters"), exports);
+__exportStar(require("./tenant"), exports);
+__exportStar(require("./webhooks"), exports);
+__exportStar(require("./cel"), exports);

package/v1/client/features/logs.d.ts

@@ -0,0 +1,37 @@
+import { V1LogLineLevel, V1LogLineOrderByDirection } from '../../../clients/rest/generated/data-contracts';
+import { HatchetClient } from '../client';
+/**
+ * The options for the list logs operation.
+ */
+export type ListLogsOpts = {
+    /** The maximum number of log lines to return. */
+    limit?: number;
+    /** Return only logs after this date. */
+    since?: Date;
+    /** Return only logs before this date. */
+    until?: Date;
+    /** Filter logs by a search string. */
+    search?: string;
+    /** Filter logs by log level. */
+    levels?: V1LogLineLevel[];
+    /** The direction to order the logs by. */
+    orderByDirection?: V1LogLineOrderByDirection;
+    /** Filter logs by attempt number. */
+    attempt?: number;
+};
+/**
+ * The logs client is a client for interacting with Hatchet's logs API.
+ */
+export declare class LogsClient {
+    tenantId: string;
+    api: HatchetClient['api'];
+    constructor(client: HatchetClient);
+    /**
+     * Lists the logs for a given task run.
+     * @param taskRunId - The ID of the task run to list logs for.
+     * @param opts - The options filter for the list operation.
+     * @returns A promise that resolves to the list of logs.
+     */
+    list(taskRunId: string, opts?: ListLogsOpts): Promise<import("../../../clients/rest/generated/data-contracts").V1LogLineList>;
+}
+export { V1LogLineLevel, V1LogLineOrderByDirection };

package/v1/client/features/logs.js

@@ -0,0 +1,46 @@
+"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.V1LogLineOrderByDirection = exports.V1LogLineLevel = exports.LogsClient = void 0;
+const data_contracts_1 = require("../../../clients/rest/generated/data-contracts");
+Object.defineProperty(exports, "V1LogLineLevel", { enumerable: true, get: function () { return data_contracts_1.V1LogLineLevel; } });
+Object.defineProperty(exports, "V1LogLineOrderByDirection", { enumerable: true, get: function () { return data_contracts_1.V1LogLineOrderByDirection; } });
+/**
+ * The logs client is a client for interacting with Hatchet's logs API.
+ */
+class LogsClient {
+    constructor(client) {
+        this.api = client.api;
+        this.tenantId = client.tenantId;
+    }
+    /**
+     * Lists the logs for a given task run.
+     * @param taskRunId - The ID of the task run to list logs for.
+     * @param opts - The options filter for the list operation.
+     * @returns A promise that resolves to the list of logs.
+     */
+    list(taskRunId, opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const { data } = yield this.api.v1LogLineList(taskRunId, {
+                limit: opts === null || opts === void 0 ? void 0 : opts.limit,
+                since: (_a = opts === null || opts === void 0 ? void 0 : opts.since) === null || _a === void 0 ? void 0 : _a.toISOString(),
+                until: (_b = opts === null || opts === void 0 ? void 0 : opts.until) === null || _b === void 0 ? void 0 : _b.toISOString(),
+                search: opts === null || opts === void 0 ? void 0 : opts.search,
+                levels: opts === null || opts === void 0 ? void 0 : opts.levels,
+                order_by_direction: opts === null || opts === void 0 ? void 0 : opts.orderByDirection,
+                attempt: opts === null || opts === void 0 ? void 0 : opts.attempt,
+            });
+            return data;
+        });
+    }
+}
+exports.LogsClient = LogsClient;

package/v1/client/features/runs.d.ts

@@ -106,10 +106,23 @@ export declare class RunsClient {
     private prepareFilter;
     private prepareListFilter;
     /**
-     * Creates a run reference for a task or workflow run by its ID.
-     * @param id - The ID of the run to create a reference for.
-     * @returns A promise that resolves to the run reference.
+     * Restore an evicted durable task so it can resume execution.
+     * @param taskExternalId - The external ID of the evicted task.
      */
+    restoreTask(taskExternalId: string): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").V1RestoreTaskResponse, any, {}>>;
+    /**
+     * Fork (reset) a durable task from a specific node, triggering re-execution from that point.
+     * @param taskExternalId - The external ID of the durable task to reset.
+     * @param nodeId - The node ID to replay from.
+     */
+    branchDurableTask(taskExternalId: string, nodeId: number, branchId?: number): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").V1BranchDurableTaskResponse, any, {}>>;
+    /**
+     * Resolve the task external ID for a workflow run. For runs with multiple tasks,
+     * returns the first task's external ID.
+     * @param workflowRunId - The workflow run ID to look up.
+     * @returns The task external ID.
+     */
+    getTaskExternalId(workflowRunId: string): Promise<string>;
     runRef<T extends Record<string, any> = any>(id: string): WorkflowRunRef<T>;
     /**
      * Subscribes to a stream of events for a task or workflow run by its ID.

package/v1/client/features/runs.js

@@ -43,7 +43,6 @@ class RunsClient {
         this.api = client.api;
         this.tenantId = client.tenantId;
         this.workflows = client.workflows;
-        // eslint-disable-next-line no-underscore-dangle
         this.listener = client._listener;
     }
     /**
@@ -148,10 +147,45 @@ class RunsClient {
         });
     }
     /**
-     * Creates a run reference for a task or workflow run by its ID.
-     * @param id - The ID of the run to create a reference for.
-     * @returns A promise that resolves to the run reference.
+     * Restore an evicted durable task so it can resume execution.
+     * @param taskExternalId - The external ID of the evicted task.
      */
+    restoreTask(taskExternalId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.api.v1TaskRestore(taskExternalId);
+        });
+    }
+    /**
+     * Fork (reset) a durable task from a specific node, triggering re-execution from that point.
+     * @param taskExternalId - The external ID of the durable task to reset.
+     * @param nodeId - The node ID to replay from.
+     */
+    branchDurableTask(taskExternalId_1, nodeId_1) {
+        return __awaiter(this, arguments, void 0, function* (taskExternalId, nodeId, branchId = 0) {
+            return this.api.v1DurableTaskBranch(this.tenantId, {
+                taskExternalId,
+                nodeId,
+                branchId,
+            });
+        });
+    }
+    /**
+     * Resolve the task external ID for a workflow run. For runs with multiple tasks,
+     * returns the first task's external ID.
+     * @param workflowRunId - The workflow run ID to look up.
+     * @returns The task external ID.
+     */
+    getTaskExternalId(workflowRunId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const run = yield this.get(workflowRunId);
+            const tasks = run === null || run === void 0 ? void 0 : run.tasks;
+            if (Array.isArray(tasks) && tasks.length > 0 && ((_a = tasks[0]) === null || _a === void 0 ? void 0 : _a.taskExternalId)) {
+                return tasks[0].taskExternalId;
+            }
+            throw new Error(`Could not find task external ID for workflow run ${workflowRunId}`);
+        });
+    }
     runRef(id) {
         return new workflow_run_ref_1.default(id, this.listener, this);
     }

package/v1/client/features/schedules.js

@@ -89,10 +89,10 @@ class ScheduleClient {
             }
             catch (err) {
                 if (err instanceof zod_1.z.ZodError) {
-                    throw new Error(`Invalid cron input: ${err.message}`);
+                    throw new Error(`Invalid cron input: ${err.message}`, { cause: err });
                 }
                 if (err instanceof axios_1.AxiosError) {
-                    throw new Error(JSON.stringify((_c = err.response) === null || _c === void 0 ? void 0 : _c.data.errors));
+                    throw new Error(JSON.stringify((_c = err.response) === null || _c === void 0 ? void 0 : _c.data.errors), { cause: err });
                 }
                 throw err;
             }
@@ -117,10 +117,10 @@ class ScheduleClient {
             }
             catch (err) {
                 if (err instanceof zod_1.z.ZodError) {
-                    throw new Error(`Invalid update input: ${err.message}`);
+                    throw new Error(`Invalid update input: ${err.message}`, { cause: err });
                 }
                 if (err instanceof axios_1.AxiosError) {
-                    throw new Error(JSON.stringify((_a = err.response) === null || _a === void 0 ? void 0 : _a.data.errors));
+                    throw new Error(JSON.stringify((_a = err.response) === null || _a === void 0 ? void 0 : _a.data.errors), { cause: err });
                 }
                 throw err;
             }

package/v1/client/features/webhooks.js

@@ -23,10 +23,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhooksClient = void 0;
 const data_contracts_1 = require("../../../clients/rest/generated/data-contracts");
 function getAuthType(auth) {
-    if ('username' in auth && 'password' in auth)
+    if ('username' in auth && 'password' in auth) {
         return data_contracts_1.V1WebhookAuthType.BASIC;
-    if ('headerName' in auth && 'apiKey' in auth)
+    }
+    if ('headerName' in auth && 'apiKey' in auth) {
         return data_contracts_1.V1WebhookAuthType.API_KEY;
+    }
     if ('signingSecret' in auth &&
         'signatureHeaderName' in auth &&
         'algorithm' in auth &&

package/v1/client/features/workflows.js

@@ -94,7 +94,7 @@ class WorkflowsClient {
                     name,
                 });
                 if (data && data.rows && data.rows.length > 0) {
-                    const wf = data.rows[0];
+                    const [wf] = data.rows;
                     // Cache the result
                     this.workflowCache.set(name, {
                         workflow: wf,