@hatchet-dev/typescript-sdk 1.23.1 → 1.24.0

package/package.json

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

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/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.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.23.1';
+exports.HATCHET_VERSION = '1.24.0';