@hatchet-dev/typescript-sdk 1.23.1 → 1.24.1

package/clients/listeners/durable-listener/durable-listener-client.d.ts

@@ -37,6 +37,8 @@ export interface DurableTaskEventLogEntryResult {
     durableTaskExternalId: string;
     nodeId: number;
     payload: Record<string, unknown> | undefined;
+    isFailure: boolean;
+    errorMessage: string | undefined;
 }
 export interface WaitForEvent {
     kind: 'waitFor';

package/clients/listeners/durable-listener/durable-listener-client.js

@@ -95,13 +95,15 @@ const WORKER_STATUS_POLL_INTERVAL_MS = 1000;
 function eventLogEntryResultFromProto(proto) {
     var _a, _b, _c, _d;
     let payload;
-    if (proto.payload && proto.payload.length > 0) {
+    if (!proto.isFailure && proto.payload && proto.payload.length > 0) {
         payload = JSON.parse(new TextDecoder().decode(proto.payload));
     }
     return {
         durableTaskExternalId: (_b = (_a = proto.ref) === null || _a === void 0 ? void 0 : _a.durableTaskExternalId) !== null && _b !== void 0 ? _b : '',
         nodeId: (_d = (_c = proto.ref) === null || _c === void 0 ? void 0 : _c.nodeId) !== null && _d !== void 0 ? _d : 0,
         payload,
+        isFailure: proto.isFailure,
+        errorMessage: proto.errorMessage,
     };
 }
 function ackKey(taskExtId, invocationCount) {

package/package.json

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

package/protoc/dispatcher/dispatcher.js

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

package/protoc/events/events.js

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

package/protoc/google/protobuf/timestamp.js

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

package/protoc/v1/dispatcher.d.ts

@@ -43,6 +43,8 @@ export interface DurableTaskEventWaitForAckResponse {
 export interface DurableTaskEventLogEntryCompletedResponse {
     ref: DurableEventLogEntryRef | undefined;
     payload: Uint8Array;
+    isFailure: boolean;
+    errorMessage?: string | undefined;
 }
 export interface DurableTaskEvictInvocationRequest {
     invocationCount: number;

package/protoc/v1/dispatcher.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: v1/dispatcher.proto
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -619,7 +619,7 @@ exports.DurableTaskEventWaitForAckResponse = {
     },
 };
 function createBaseDurableTaskEventLogEntryCompletedResponse() {
-    return { ref: undefined, payload: new Uint8Array(0) };
+    return { ref: undefined, payload: new Uint8Array(0), isFailure: false, errorMessage: undefined };
 }
 exports.DurableTaskEventLogEntryCompletedResponse = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -629,6 +629,12 @@ exports.DurableTaskEventLogEntryCompletedResponse = {
         if (message.payload.length !== 0) {
             writer.uint32(18).bytes(message.payload);
         }
+        if (message.isFailure !== false) {
+            writer.uint32(24).bool(message.isFailure);
+        }
+        if (message.errorMessage !== undefined) {
+            writer.uint32(34).string(message.errorMessage);
+        }
         return writer;
     },
     decode(input, length) {
@@ -652,6 +658,20 @@ exports.DurableTaskEventLogEntryCompletedResponse = {
                     message.payload = reader.bytes();
                     continue;
                 }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.isFailure = reader.bool();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.errorMessage = reader.string();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -664,6 +684,16 @@ exports.DurableTaskEventLogEntryCompletedResponse = {
         return {
             ref: isSet(object.ref) ? exports.DurableEventLogEntryRef.fromJSON(object.ref) : undefined,
             payload: isSet(object.payload) ? bytesFromBase64(object.payload) : new Uint8Array(0),
+            isFailure: isSet(object.isFailure)
+                ? globalThis.Boolean(object.isFailure)
+                : isSet(object.is_failure)
+                    ? globalThis.Boolean(object.is_failure)
+                    : false,
+            errorMessage: isSet(object.errorMessage)
+                ? globalThis.String(object.errorMessage)
+                : isSet(object.error_message)
+                    ? globalThis.String(object.error_message)
+                    : undefined,
         };
     },
     toJSON(message) {
@@ -674,19 +704,27 @@ exports.DurableTaskEventLogEntryCompletedResponse = {
         if (message.payload.length !== 0) {
             obj.payload = base64FromBytes(message.payload);
         }
+        if (message.isFailure !== false) {
+            obj.isFailure = message.isFailure;
+        }
+        if (message.errorMessage !== undefined) {
+            obj.errorMessage = message.errorMessage;
+        }
         return obj;
     },
     create(base) {
         return exports.DurableTaskEventLogEntryCompletedResponse.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a;
+        var _a, _b, _c;
         const message = createBaseDurableTaskEventLogEntryCompletedResponse();
         message.ref =
             object.ref !== undefined && object.ref !== null
                 ? exports.DurableEventLogEntryRef.fromPartial(object.ref)
                 : undefined;
         message.payload = (_a = object.payload) !== null && _a !== void 0 ? _a : new Uint8Array(0);
+        message.isFailure = (_b = object.isFailure) !== null && _b !== void 0 ? _b : false;
+        message.errorMessage = (_c = object.errorMessage) !== null && _c !== void 0 ? _c : undefined;
         return message;
     },
 };

package/protoc/v1/shared/condition.js

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

package/protoc/v1/shared/trigger.js

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

package/protoc/v1/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.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: v1/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });

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.6
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               v3.19.1
 // source: workflows/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -3,6 +3,24 @@ import { V1TaskStatus } from '../../../clients/rest/generated/data-contracts';
 import { RunListenerClient } from '../../../clients/listeners/run-listener/child-listener-client';
 import { WorkflowsClient } from './workflows';
 import { HatchetClient } from '../client';
+import { runStatusToJSON } from '../../../protoc/v1/workflows';
+export type RunDetail = {
+    status: V1TaskStatus;
+    done: boolean;
+    input: unknown;
+    additionalMetadata: unknown;
+    isEvicted: boolean;
+    taskRuns: Record<string, TaskRunDetail>;
+};
+export type TaskRunDetail = {
+    externalId: string;
+    readableId: string;
+    status: V1TaskStatus;
+    output: unknown;
+    error?: string;
+    isEvicted: boolean;
+};
+export { runStatusToJSON };
 export type RunFilter = {
     since?: Date;
     until?: Date;
@@ -72,7 +90,10 @@ export declare class RunsClient {
     tenantId: string;
     workflows: WorkflowsClient;
     listener: RunListenerClient;
+    private _config;
+    private _adminGrpc;
     constructor(client: HatchetClient);
+    private get adminGrpc();
     /**
      * Gets a task or workflow run by its ID.
      * @param run - The ID of the run to get.
@@ -85,6 +106,12 @@ export declare class RunsClient {
      * @returns A promise that resolves to the status of the run.
      */
     get_status<T = any>(run: string | WorkflowRunRef<T>): Promise<V1TaskStatus>;
+    /**
+     * Gets run details
+     * @param run - The workflow run ID (string) or a WorkflowRunRef.
+     * @returns A promise resolving to GetRunDetailsResponse with task run statuses and outputs.
+     */
+    getDetails<T = any>(run: string | WorkflowRunRef<T>): Promise<RunDetail>;
     /**
      * Lists all task and workflow runs for the current tenant.
      * @param opts - The options for the list operation.

package/v1/client/features/runs.js

@@ -32,9 +32,57 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RunsClient = void 0;
+exports.RunsClient = exports.runStatusToJSON = void 0;
 const workflow_run_ref_1 = __importDefault(require("../../../util/workflow-run-ref"));
+const data_contracts_1 = require("../../../clients/rest/generated/data-contracts");
 const child_listener_client_1 = require("../../../clients/listeners/run-listener/child-listener-client");
+const workflows_1 = require("../../../protoc/v1/workflows");
+Object.defineProperty(exports, "runStatusToJSON", { enumerable: true, get: function () { return workflows_1.runStatusToJSON; } });
+const grpc_helpers_1 = require("../../../util/grpc-helpers");
+// EVICTED is not in V1TaskStatus; treat as RUNNING per the proto comment.
+const PROTO_STATUS_MAP = {
+    [workflows_1.RunStatus.QUEUED]: data_contracts_1.V1TaskStatus.QUEUED,
+    [workflows_1.RunStatus.RUNNING]: data_contracts_1.V1TaskStatus.RUNNING,
+    [workflows_1.RunStatus.COMPLETED]: data_contracts_1.V1TaskStatus.COMPLETED,
+    [workflows_1.RunStatus.FAILED]: data_contracts_1.V1TaskStatus.FAILED,
+    [workflows_1.RunStatus.CANCELLED]: data_contracts_1.V1TaskStatus.CANCELLED,
+    [workflows_1.RunStatus.EVICTED]: data_contracts_1.V1TaskStatus.RUNNING,
+    [workflows_1.RunStatus.UNRECOGNIZED]: data_contracts_1.V1TaskStatus.RUNNING,
+};
+function decodeBytes(b) {
+    if (!(b === null || b === void 0 ? void 0 : b.length))
+        return null;
+    try {
+        return JSON.parse(new TextDecoder().decode(b));
+    }
+    catch (_a) {
+        return null;
+    }
+}
+function toRunDetail(raw) {
+    var _a;
+    return {
+        status: (_a = PROTO_STATUS_MAP[raw.status]) !== null && _a !== void 0 ? _a : data_contracts_1.V1TaskStatus.RUNNING,
+        done: raw.done,
+        input: decodeBytes(raw.input),
+        additionalMetadata: decodeBytes(raw.additionalMetadata),
+        isEvicted: raw.isEvicted,
+        taskRuns: Object.fromEntries(Object.entries(raw.taskRuns).map(([id, tr]) => {
+            var _a;
+            return [
+                id,
+                {
+                    externalId: tr.externalId,
+                    readableId: tr.readableId,
+                    status: (_a = PROTO_STATUS_MAP[tr.status]) !== null && _a !== void 0 ? _a : data_contracts_1.V1TaskStatus.RUNNING,
+                    output: decodeBytes(tr.output),
+                    error: tr.error,
+                    isEvicted: tr.isEvicted,
+                },
+            ];
+        })),
+    };
+}
 /**
  * The runs client is a client for interacting with task and workflow runs within Hatchet.
  */
@@ -44,6 +92,14 @@ class RunsClient {
         this.tenantId = client.tenantId;
         this.workflows = client.workflows;
         this.listener = client._listener;
+        this._config = client.config;
+    }
+    get adminGrpc() {
+        if (!this._adminGrpc) {
+            const { client } = (0, grpc_helpers_1.createGrpcClient)(this._config, workflows_1.AdminServiceDefinition);
+            this._adminGrpc = client;
+        }
+        return this._adminGrpc;
     }
     /**
      * Gets a task or workflow run by its ID.
@@ -69,6 +125,17 @@ class RunsClient {
             return data;
         });
     }
+    /**
+     * Gets run details
+     * @param run - The workflow run ID (string) or a WorkflowRunRef.
+     * @returns A promise resolving to GetRunDetailsResponse with task run statuses and outputs.
+     */
+    getDetails(run) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const runId = typeof run === 'string' ? run : yield run.getWorkflowRunId();
+            return toRunDetail(yield this.adminGrpc.getRunDetails({ externalId: runId }));
+        });
+    }
     /**
      * Lists all task and workflow runs for the current tenant.
      * @param opts - The options for the list operation.

package/v1/client/worker/context.js

@@ -894,6 +894,9 @@ class DurableContext extends Context {
             });
             const results = yield Promise.all(ack.runEntries.map((entry) => this.withEvictionWait('runChild', `workflow:bulk-child`, () => __awaiter(this, void 0, void 0, function* () {
                 const result = yield this._durableListener.waitForCallback(this.action.taskRunExternalId, this.invocationCount, entry.branchId, entry.nodeId, { signal: this.abortController.signal });
+                if (result.isFailure) {
+                    throw new hatchet_error_1.default(result.errorMessage || 'child task failed');
+                }
                 return (result.payload || {});
             }))));
             return results;

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

@@ -82,6 +82,17 @@ export declare const memoNowCaching: import("../..").TaskWorkflowDeclaration<imp
     start_time: string;
 }, {}, {}, {}, {}>;
 export declare const dagChildWorkflow: import("../..").WorkflowDeclaration<import("../..").UnknownInputType, {}, {}>;
+export declare const errorRaisingTask: import("../..").TaskWorkflowDeclaration<{
+    error_message: string;
+}, never, {}, {}, {}, {}>;
+export declare const errorRaisingDurableParent: import("../..").TaskWorkflowDeclaration<{
+    error_message: string;
+}, {
+    child_raised: boolean;
+    child_error_str: string | null;
+    child_run_external_id: string;
+    parent_run_external_id: string;
+}, {}, {}, {}, {}>;
 export declare const durableSpawnDag: import("../..").TaskWorkflowDeclaration<import("../..").JsonObject, {
     sleep_duration: number;
     sleep_duration_ms: number;

package/v1/examples/durable/workflow.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.durableSpawnDag = exports.dagChildWorkflow = exports.memoNowCaching = exports.waitForTwoEventsSecondPushedFirst = exports.waitForOrEventLookback = exports.waitForEventLookback = exports.LOOKBACK_WINDOW = exports.durableReplayReset = exports.REPLAY_RESET_MEMOIZED_MAX_SECONDS = exports.REPLAY_RESET_SLEEP_SECONDS = exports.durableNonDeterminism = exports.durableWithExplicitSpawn = exports.durableSleepEventSpawn = exports.durableWithBulkSpawn = exports.durableWithSpawn = exports.spawnChildTask = exports.waitForSleepTwice = exports.durableWorkflow = exports.SLEEP_TIME = exports.SLEEP_TIME_SECONDS = exports.EVENT_KEY = void 0;
+exports.durableSpawnDag = exports.errorRaisingDurableParent = exports.errorRaisingTask = exports.dagChildWorkflow = exports.memoNowCaching = exports.waitForTwoEventsSecondPushedFirst = exports.waitForOrEventLookback = exports.waitForEventLookback = exports.LOOKBACK_WINDOW = exports.durableReplayReset = exports.REPLAY_RESET_MEMOIZED_MAX_SECONDS = exports.REPLAY_RESET_SLEEP_SECONDS = exports.durableNonDeterminism = exports.durableWithExplicitSpawn = exports.durableSleepEventSpawn = exports.durableWithBulkSpawn = exports.durableWithSpawn = exports.spawnChildTask = exports.waitForSleepTwice = exports.durableWorkflow = exports.SLEEP_TIME = exports.SLEEP_TIME_SECONDS = exports.EVENT_KEY = void 0;
 const v4_1 = require("zod/v4");
 const conditions_1 = require("../../conditions");
 const non_determinism_error_1 = require("../../../util/errors/non-determinism-error");
@@ -301,6 +301,35 @@ exports.dagChildWorkflow.task({
         return { result: 'child2' };
     }),
 });
+// --- Error propagation test ---
+exports.errorRaisingTask = hatchet_client_1.hatchet.task({
+    name: 'error-raising-task',
+    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+        throw new Error(input.error_message);
+    }),
+});
+exports.errorRaisingDurableParent = hatchet_client_1.hatchet.durableTask({
+    name: 'error-raising-durable-parent',
+    executionTimeout: '30s',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        let childRaised = false;
+        let childErrorStr = null;
+        const ref = yield exports.errorRaisingTask.runNoWait(input);
+        try {
+            yield ref.output;
+        }
+        catch (e) {
+            childRaised = true;
+            childErrorStr = e instanceof Error ? e.message : String(e);
+        }
+        return {
+            child_raised: childRaised,
+            child_error_str: childErrorStr,
+            child_run_external_id: yield ref.runId,
+            parent_run_external_id: ctx.workflowRunId(),
+        };
+    }),
+});
 exports.durableSpawnDag = hatchet_client_1.hatchet.durableTask({
     name: 'durable-spawn-dag',
     executionTimeout: '10s',

package/v1/examples/e2e-worker.js

@@ -70,6 +70,8 @@ const workflows = [
     workflow_8.waitForEventLookback,
     workflow_8.waitForOrEventLookback,
     workflow_8.waitForTwoEventsSecondPushedFirst,
+    workflow_8.errorRaisingTask,
+    workflow_8.errorRaisingDurableParent,
     workflow_9.durableEvent,
     workflow_9.durableEventWithFilter,
     workflow_11.durableSleep,

package/v1/index.d.ts

@@ -1,5 +1,6 @@
 export * from './client/client';
 export * from './client/features';
+export type { RunDetail, TaskRunDetail } from './client/features/runs';
 export * from './client/worker/worker';
 export * from './declaration';
 export * from './conditions';

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.23.1";
+export declare const HATCHET_VERSION = "1.24.1";

package/version.js

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