@hatchet-dev/typescript-sdk 0.8.1 → 0.9.0

package/clients/admin/admin-client.d.ts

@@ -2,8 +2,10 @@ import { Channel, ClientFactory } from 'nice-grpc';
 import { CreateWorkflowVersionOpts, RateLimitDuration, WorkflowServiceClient } from '../../protoc/workflows';
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
+import WorkflowRunRef from '../../util/workflow-run-ref';
 import { Api } from '../rest';
 import { WorkflowRunStatus, WorkflowRunStatusList } from '../rest/generated/data-contracts';
+import { ListenerClient } from '../listener/listener-client';
 type WorkflowMetricsQuery = {
     workflowId?: string;
     workflowName?: string;
@@ -32,7 +34,8 @@ export declare class AdminClient {
     api: Api;
     tenantId: string;
     logger: Logger;
-    constructor(config: ClientConfig, channel: Channel, factory: ClientFactory, api: Api, tenantId: string);
+    listenerClient: ListenerClient;
+    constructor(config: ClientConfig, channel: Channel, factory: ClientFactory, api: Api, tenantId: string, listenerClient: ListenerClient);
     /**
      * @deprecated use putWorkflow instead
      */
@@ -57,7 +60,7 @@ export declare class AdminClient {
         childIndex?: number | undefined;
         childKey?: string | undefined;
         additionalMetadata?: Record<string, string> | undefined;
-    }): Promise<string>;
+    }): Promise<WorkflowRunRef<object>>;
     /**
      * Run a new instance of a workflow with the given input. This will create a new workflow run and return the ID of the
      * new run.
@@ -66,13 +69,13 @@ export declare class AdminClient {
      * @param options an object containing the options to run the workflow
      * @returns the ID of the new workflow run
      */
-    runWorkflow<T = object>(workflowName: string, input: T, options?: {
+    runWorkflow<Q = object, P = object>(workflowName: string, input: Q, options?: {
         parentId?: string | undefined;
         parentStepRunId?: string | undefined;
         childIndex?: number | undefined;
         childKey?: string | undefined;
         additionalMetadata?: Record<string, string> | undefined;
-    }): Promise<string>;
+    }): WorkflowRunRef<P>;
     /**
      * @deprecated use listWorkflows instead
      */
@@ -106,13 +109,13 @@ export declare class AdminClient {
     /**
      * @deprecated use getWorkflowRun instead
      */
-    get_workflow_run(workflowRunId: string): Promise<import("../rest/generated/data-contracts").WorkflowRun>;
+    get_workflow_run(workflowRunId: string): Promise<WorkflowRunRef<unknown>>;
     /**
      * Get a workflow run.
      * @param workflowRunId the id of the workflow run to get
      * @returns the workflow run
      */
-    getWorkflowRun(workflowRunId: string): Promise<import("../rest/generated/data-contracts").WorkflowRun>;
+    getWorkflowRun(workflowRunId: string): Promise<WorkflowRunRef<unknown>>;
     /**
      * @deprecated use listWorkflowRuns instead
      */
@@ -146,14 +149,17 @@ export declare class AdminClient {
      */
     schedule_workflow(name: string, options?: {
         schedules?: Date[];
+        input?: object;
     }): Promise<void>;
     /**
      * Schedule a workflow to run at a specific time or times.
      * @param name the name of the workflow to schedule
      * @param options an object containing the schedules to set
+     * @param input an object containing the input to the workflow
      */
     scheduleWorkflow(name: string, options?: {
         schedules?: Date[];
+        input?: object;
     }): void;
     /**
      * @deprecated use getWorkflowMetrics instead

package/clients/admin/admin-client.js

@@ -17,6 +17,7 @@ const workflows_1 = require("../../protoc/workflows");
 const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error"));
 const logger_1 = require("../../util/logger");
 const retrier_1 = require("../../util/retrier");
+const workflow_run_ref_1 = __importDefault(require("../../util/workflow-run-ref"));
 /**
  * AdminClient is a client for interacting with the Hatchet Admin API. This allows you to configure, trigger,
  * and monitor workflows.
@@ -34,12 +35,13 @@ const retrier_1 = require("../../util/retrier");
  * ```
  */
 class AdminClient {
-    constructor(config, channel, factory, api, tenantId) {
+    constructor(config, channel, factory, api, tenantId, listenerClient) {
         this.config = config;
         this.client = factory.create(workflows_1.WorkflowServiceDefinition, channel);
         this.api = api;
         this.tenantId = tenantId;
         this.logger = new logger_1.Logger(`Admin`, config.log_level);
+        this.listenerClient = listenerClient;
     }
     /**
      * @deprecated use putWorkflow instead
@@ -105,22 +107,20 @@ class AdminClient {
      * @returns the ID of the new workflow run
      */
     runWorkflow(workflowName, input, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let computedName = workflowName;
-            try {
-                if (this.config.namespace && !workflowName.startsWith(this.config.namespace)) {
-                    computedName = this.config.namespace + workflowName;
-                }
-                const inputStr = JSON.stringify(input);
-                const resp = yield this.client.triggerWorkflow(Object.assign(Object.assign({ name: computedName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
-                        ? JSON.stringify(options === null || options === void 0 ? void 0 : options.additionalMetadata)
-                        : undefined }));
-                return resp.workflowRunId;
-            }
-            catch (e) {
-                throw new hatchet_error_1.default(e.message);
+        let computedName = workflowName;
+        try {
+            if (this.config.namespace && !workflowName.startsWith(this.config.namespace)) {
+                computedName = this.config.namespace + workflowName;
             }
-        });
+            const inputStr = JSON.stringify(input);
+            const resp = this.client.triggerWorkflow(Object.assign(Object.assign({ name: computedName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
+                    ? JSON.stringify(options === null || options === void 0 ? void 0 : options.additionalMetadata)
+                    : undefined }));
+            return new workflow_run_ref_1.default(resp, this.listenerClient, options === null || options === void 0 ? void 0 : options.parentId);
+        }
+        catch (e) {
+            throw new hatchet_error_1.default(e.message);
+        }
     }
     /**
      * @deprecated use listWorkflows instead
@@ -196,8 +196,7 @@ class AdminClient {
      */
     getWorkflowRun(workflowRunId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const res = yield this.api.workflowRunGet(this.tenantId, workflowRunId);
-            return res.data;
+            return new workflow_run_ref_1.default(workflowRunId, this.listenerClient);
         });
     }
     /**
@@ -231,12 +230,18 @@ class AdminClient {
      * Schedule a workflow to run at a specific time or times.
      * @param name the name of the workflow to schedule
      * @param options an object containing the schedules to set
+     * @param input an object containing the input to the workflow
      */
     scheduleWorkflow(name, options) {
         try {
+            let input;
+            if (options === null || options === void 0 ? void 0 : options.input) {
+                input = JSON.stringify(options.input);
+            }
             this.client.scheduleWorkflow({
                 name,
                 schedules: options === null || options === void 0 ? void 0 : options.schedules,
+                input,
             });
         }
         catch (e) {

package/clients/dispatcher/heartbeat/heartbeat-controller.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Logger } from '../../../util/logger';
 import { DispatcherClient as PbDispatcherClient } from '../../../protoc/dispatcher';
 import { Worker } from 'worker_threads';

package/clients/hatchet-client/hatchet-client.js

@@ -111,8 +111,8 @@ class HatchetClient {
         this.api = (0, rest_1.default)(this.config.api_url, this.config.token, axiosOpts);
         this.event = new event_client_1.EventClient(this.config, (0, exports.channelFactory)(this.config, this.credentials), clientFactory);
         this.dispatcher = new dispatcher_client_1.DispatcherClient(this.config, (0, exports.channelFactory)(this.config, this.credentials), clientFactory);
-        this.admin = new admin_client_1.AdminClient(this.config, (0, exports.channelFactory)(this.config, this.credentials), clientFactory, this.api, this.tenantId);
         this.listener = new listener_client_1.ListenerClient(this.config, (0, exports.channelFactory)(this.config, this.credentials), clientFactory, this.api);
+        this.admin = new admin_client_1.AdminClient(this.config, (0, exports.channelFactory)(this.config, this.credentials), clientFactory, this.api, this.tenantId, this.listener);
         this.logger = new logger_1.default('HatchetClient', this.config.log_level);
         this.logger.info(`Initialized HatchetClient`);
     }

package/clients/listener/child-listener-client.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from 'events';
 import { WorkflowRunEvent, SubscribeToWorkflowRunsRequest } from '../../protoc/dispatcher';
 import { ListenerClient } from './listener-client';

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

@@ -1,7 +1,6 @@
-/// <reference types="node" />
 import { Channel, ClientFactory } from 'nice-grpc';
 import { EventEmitter } from 'events';
-import { DispatcherClient as PbDispatcherClient } from '../../protoc/dispatcher';
+import { DispatcherClient as PbDispatcherClient, DispatcherClient } from '../../protoc/dispatcher';
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
 import { Api } from '../rest';
@@ -23,21 +22,15 @@ export interface StepRunEvent {
     type: RunEventType;
     payload: string;
 }
-export declare class PollingAsyncListener {
-    client: ListenerClient;
+export declare class RunEventListener {
+    client: DispatcherClient;
     q: Array<StepRunEvent>;
     eventEmitter: EventEmitter<[never]>;
     pollInterval: any;
-    constructor(workflowRunid: string, client: ListenerClient);
+    constructor(workflowRunid: string, client: DispatcherClient);
     emit(event: StepRunEvent): void;
     listen(workflowRunId: string): Promise<void>;
     retrySubscribe(workflowRunId: string): Promise<AsyncIterable<import("../../protoc/dispatcher").WorkflowEvent>>;
-    getWorkflowRun(workflowRunId: string): Promise<{
-        type: RunEventType;
-        payload: string;
-    } | undefined>;
-    polling(workflowRunId: string): Promise<void>;
-    close(): void;
     stream(): AsyncGenerator<StepRunEvent, void, unknown>;
 }
 export declare class ListenerClient {
@@ -45,9 +38,8 @@ export declare class ListenerClient {
     client: PbDispatcherClient;
     logger: Logger;
     api: Api;
-    childListeners: Record<string, GrpcPooledListener>;
+    pooledListener: GrpcPooledListener | undefined;
     constructor(config: ClientConfig, channel: Channel, factory: ClientFactory, api: Api);
-    getChildListener(workflowRunId: string, parentWorkflowRunId: string): import("./child-listener-client").Streamable;
-    get(workflowRunId: string): PollingAsyncListener;
+    get(workflowRunId: string): import("./child-listener-client").Streamable;
     stream(workflowRunId: string): Promise<AsyncGenerator<StepRunEvent, void, unknown>>;
 }

package/clients/listener/listener-client.js

@@ -32,7 +32,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListenerClient = exports.PollingAsyncListener = exports.RunEventType = void 0;
+exports.ListenerClient = exports.RunEventListener = exports.RunEventType = void 0;
 // eslint-disable-next-line max-classes-per-file
 const nice_grpc_1 = require("nice-grpc");
 const events_1 = require("events");
@@ -94,13 +94,12 @@ const workflowStatusMap = {
     [data_contracts_1.WorkflowRunStatus.RUNNING]: undefined,
     [data_contracts_1.WorkflowRunStatus.QUEUED]: undefined,
 };
-class PollingAsyncListener {
+class RunEventListener {
     constructor(workflowRunid, client) {
         this.q = [];
         this.eventEmitter = new events_1.EventEmitter();
         this.client = client;
         this.listen(workflowRunid);
-        this.polling(workflowRunid);
     }
     emit(event) {
         this.q.push(event);
@@ -110,14 +109,9 @@ class PollingAsyncListener {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, e_1, _b, _c;
             var _d;
-            let listener = this.client.client.subscribeToWorkflowEvents({
+            let listener = this.client.subscribeToWorkflowEvents({
                 workflowRunId,
             });
-            const res = yield this.getWorkflowRun(workflowRunId);
-            if (res) {
-                this.emit(res);
-                this.close();
-            }
             try {
                 try {
                     for (var _e = true, listener_1 = __asyncValues(listener), listener_1_1; listener_1_1 = yield listener_1.next(), _a = listener_1_1.done, !_a; _e = true) {
@@ -126,19 +120,10 @@ class PollingAsyncListener {
                         const workflowEvent = _c;
                         const eventType = (_d = resourceTypeMap[workflowEvent.resourceType]) === null || _d === void 0 ? void 0 : _d[workflowEvent.eventType];
                         if (eventType) {
-                            if (eventType === RunEventType.WORKFLOW_RUN_EVENT_TYPE_COMPLETED) {
-                                // OPTIMZATION - consider including the workflow run data in the event?
-                                const data = yield this.getWorkflowRun(workflowRunId);
-                                if (data) {
-                                    this.emit(data);
-                                }
-                            }
-                            else {
-                                this.emit({
-                                    type: eventType,
-                                    payload: workflowEvent.eventPayload,
-                                });
-                            }
+                            this.emit({
+                                type: eventType,
+                                payload: workflowEvent.eventPayload,
+                            });
                         }
                     }
                 }
@@ -158,7 +143,6 @@ class PollingAsyncListener {
                     listener = yield this.retrySubscribe(workflowRunId);
                 }
             }
-            setTimeout(() => this.close(), DEFAULT_EVENT_LISTENER_POLL_INTERVAL * 5);
         });
     }
     retrySubscribe(workflowRunId) {
@@ -167,7 +151,7 @@ class PollingAsyncListener {
             while (retries < DEFAULT_EVENT_LISTENER_RETRY_COUNT) {
                 try {
                     yield (0, sleep_1.default)(DEFAULT_EVENT_LISTENER_RETRY_INTERVAL);
-                    const listener = this.client.client.subscribeToWorkflowEvents({
+                    const listener = this.client.subscribeToWorkflowEvents({
                         workflowRunId,
                     });
                     return listener;
@@ -179,54 +163,6 @@ class PollingAsyncListener {
             throw new hatchet_error_1.default(`Could not subscribe to the worker after ${DEFAULT_EVENT_LISTENER_RETRY_COUNT} retries`);
         });
     }
-    getWorkflowRun(workflowRunId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            try {
-                const res = yield this.client.api.workflowRunGet(this.client.config.tenant_id, workflowRunId);
-                const stepRuns = (_c = (_b = (_a = res.data.jobRuns) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.stepRuns) !== null && _c !== void 0 ? _c : [];
-                const stepRunOutput = stepRuns.reduce((acc, stepRun) => {
-                    var _a;
-                    acc[((_a = stepRun.step) === null || _a === void 0 ? void 0 : _a.readableId) || ''] = JSON.parse(stepRun.output || '{}');
-                    return acc;
-                }, {});
-                if (Object.keys(workflowStatusMap).includes(res.data.status)) {
-                    const type = workflowStatusMap[res.data.status];
-                    if (!type)
-                        return undefined;
-                    return {
-                        type,
-                        payload: JSON.stringify(stepRunOutput),
-                    };
-                }
-                return undefined;
-            }
-            catch (e) {
-                throw new hatchet_error_1.default(e.message);
-            }
-        });
-    }
-    polling(workflowRunId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.pollInterval = setInterval(() => __awaiter(this, void 0, void 0, function* () {
-                try {
-                    const result = yield this.getWorkflowRun(workflowRunId);
-                    if (result) {
-                        this.emit(result);
-                        this.close();
-                    }
-                }
-                catch (e) {
-                    // TODO error handling
-                }
-            }), DEFAULT_EVENT_LISTENER_POLL_INTERVAL);
-        });
-    }
-    close() {
-        if (this.pollInterval) {
-            clearInterval(this.pollInterval);
-        }
-    }
     stream() {
         return __asyncGenerator(this, arguments, function* stream_1() {
             var _a, e_2, _b, _c;
@@ -253,33 +189,28 @@ class PollingAsyncListener {
         });
     }
 }
-exports.PollingAsyncListener = PollingAsyncListener;
+exports.RunEventListener = RunEventListener;
 class ListenerClient {
     constructor(config, channel, factory, api) {
-        this.childListeners = {};
         this.config = config;
         this.client = factory.create(dispatcher_1.DispatcherDefinition, channel);
         this.logger = new logger_1.Logger(`Listener`, config.log_level);
         this.api = api;
     }
-    getChildListener(workflowRunId, parentWorkflowRunId) {
-        if (!this.childListeners[parentWorkflowRunId]) {
-            this.childListeners[parentWorkflowRunId] = new child_listener_client_1.GrpcPooledListener(this, () => {
-                // cleanup listener when all children are done
-                delete this.childListeners[parentWorkflowRunId];
+    get(workflowRunId) {
+        if (!this.pooledListener) {
+            this.pooledListener = new child_listener_client_1.GrpcPooledListener(this, () => {
+                this.pooledListener = undefined;
             });
         }
-        return this.childListeners[parentWorkflowRunId].subscribe({
+        return this.pooledListener.subscribe({
             workflowRunId,
         });
     }
-    get(workflowRunId) {
-        const listener = new PollingAsyncListener(workflowRunId, this);
-        return listener;
-    }
     stream(workflowRunId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.get(workflowRunId).stream();
+            const listener = new RunEventListener(workflowRunId, this.client);
+            return listener.stream();
         });
     }
 }

package/clients/rest/generated/Api.d.ts

@@ -535,7 +535,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     workflowRunCancel: (tenant: string, data: WorkflowRunsCancelRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<{
-        workflowRunIds?: string[] | undefined;
+        workflowRunIds?: string[];
     }, any>>;
     /**
      * @description Get a workflow for a tenant

package/clients/rest/generated/http-client.js

@@ -49,8 +49,8 @@ class HttpClient {
         this.setSecurityData = (data) => {
             this.securityData = data;
         };
-        this.request = (_b) => __awaiter(this, void 0, void 0, function* () {
-            var { secure, path, type, query, format, body } = _b, params = __rest(_b, ["secure", "path", "type", "query", "format", "body"]);
+        this.request = (_a) => __awaiter(this, void 0, void 0, function* () {
+            var { secure, path, type, query, format, body } = _a, params = __rest(_a, ["secure", "path", "type", "query", "format", "body"]);
             const secureParams = ((typeof secure === 'boolean' ? secure : this.secure) &&
                 this.securityWorker &&
                 (yield this.securityWorker(this.securityData))) ||

package/index.d.ts

@@ -4,4 +4,5 @@ export * from './step';
 export * from './clients/worker';
 export * from './clients/rest';
 export * from './clients/admin';
+export * from './util/workflow-run-ref';
 export default Hatchet;

package/index.js

@@ -20,4 +20,5 @@ __exportStar(require("./step"), exports);
 __exportStar(require("./clients/worker"), exports);
 __exportStar(require("./clients/rest"), exports);
 __exportStar(require("./clients/admin"), exports);
+__exportStar(require("./util/workflow-run-ref"), exports);
 exports.default = hatchet_client_1.HatchetClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -84,7 +84,7 @@
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
     "ts-proto": "^1.167.0",
-    "typedoc": "^0.25.7",
+    "typedoc": "^0.26.2",
     "typedoc-plugin-markdown": "^4.0.2",
     "typescript": "^5.3.3"
   },

package/protoc/dispatcher/dispatcher.js

@@ -28,7 +28,19 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DispatcherDefinition = exports.ReleaseSlotResponse = exports.ReleaseSlotRequest = exports.RefreshTimeoutResponse = exports.RefreshTimeoutRequest = exports.HeartbeatResponse = exports.HeartbeatRequest = exports.OverridesDataResponse = exports.OverridesData = exports.StepRunResult = exports.WorkflowRunEvent = exports.WorkflowEvent = exports.SubscribeToWorkflowRunsRequest = exports.SubscribeToWorkflowEventsRequest = exports.ActionEventResponse = exports.StepActionEvent = exports.GroupKeyActionEvent = exports.WorkerUnsubscribeResponse = exports.WorkerUnsubscribeRequest = exports.WorkerListenRequest = exports.AssignedAction = exports.WorkerRegisterResponse = exports.WorkerRegisterRequest = exports.workflowRunEventTypeToJSON = exports.workflowRunEventTypeFromJSON = exports.WorkflowRunEventType = exports.resourceEventTypeToJSON = exports.resourceEventTypeFromJSON = exports.ResourceEventType = exports.resourceTypeToJSON = exports.resourceTypeFromJSON = exports.ResourceType = exports.stepActionEventTypeToJSON = exports.stepActionEventTypeFromJSON = exports.StepActionEventType = exports.groupKeyActionEventTypeToJSON = exports.groupKeyActionEventTypeFromJSON = exports.GroupKeyActionEventType = exports.actionTypeToJSON = exports.actionTypeFromJSON = exports.ActionType = exports.protobufPackage = void 0;
+exports.DispatcherDefinition = exports.ReleaseSlotResponse = exports.ReleaseSlotRequest = exports.RefreshTimeoutResponse = exports.RefreshTimeoutRequest = exports.HeartbeatResponse = exports.HeartbeatRequest = exports.OverridesDataResponse = exports.OverridesData = exports.StepRunResult = exports.WorkflowRunEvent = exports.WorkflowEvent = exports.SubscribeToWorkflowRunsRequest = exports.SubscribeToWorkflowEventsRequest = exports.ActionEventResponse = exports.StepActionEvent = exports.GroupKeyActionEvent = exports.WorkerUnsubscribeResponse = exports.WorkerUnsubscribeRequest = exports.WorkerListenRequest = exports.AssignedAction = exports.WorkerRegisterResponse = exports.WorkerRegisterRequest = exports.WorkflowRunEventType = exports.ResourceEventType = exports.ResourceType = exports.StepActionEventType = exports.GroupKeyActionEventType = exports.ActionType = exports.protobufPackage = void 0;
+exports.actionTypeFromJSON = actionTypeFromJSON;
+exports.actionTypeToJSON = actionTypeToJSON;
+exports.groupKeyActionEventTypeFromJSON = groupKeyActionEventTypeFromJSON;
+exports.groupKeyActionEventTypeToJSON = groupKeyActionEventTypeToJSON;
+exports.stepActionEventTypeFromJSON = stepActionEventTypeFromJSON;
+exports.stepActionEventTypeToJSON = stepActionEventTypeToJSON;
+exports.resourceTypeFromJSON = resourceTypeFromJSON;
+exports.resourceTypeToJSON = resourceTypeToJSON;
+exports.resourceEventTypeFromJSON = resourceEventTypeFromJSON;
+exports.resourceEventTypeToJSON = resourceEventTypeToJSON;
+exports.workflowRunEventTypeFromJSON = workflowRunEventTypeFromJSON;
+exports.workflowRunEventTypeToJSON = workflowRunEventTypeToJSON;
 const _m0 = __importStar(require("protobufjs/minimal"));
 const timestamp_1 = require("../google/protobuf/timestamp");
 exports.protobufPackage = '';
@@ -56,7 +68,6 @@ function actionTypeFromJSON(object) {
             return ActionType.UNRECOGNIZED;
     }
 }
-exports.actionTypeFromJSON = actionTypeFromJSON;
 function actionTypeToJSON(object) {
     switch (object) {
         case ActionType.START_STEP_RUN:
@@ -70,7 +81,6 @@ function actionTypeToJSON(object) {
             return 'UNRECOGNIZED';
     }
 }
-exports.actionTypeToJSON = actionTypeToJSON;
 var GroupKeyActionEventType;
 (function (GroupKeyActionEventType) {
     GroupKeyActionEventType[GroupKeyActionEventType["GROUP_KEY_EVENT_TYPE_UNKNOWN"] = 0] = "GROUP_KEY_EVENT_TYPE_UNKNOWN";
@@ -99,7 +109,6 @@ function groupKeyActionEventTypeFromJSON(object) {
             return GroupKeyActionEventType.UNRECOGNIZED;
     }
 }
-exports.groupKeyActionEventTypeFromJSON = groupKeyActionEventTypeFromJSON;
 function groupKeyActionEventTypeToJSON(object) {
     switch (object) {
         case GroupKeyActionEventType.GROUP_KEY_EVENT_TYPE_UNKNOWN:
@@ -115,7 +124,6 @@ function groupKeyActionEventTypeToJSON(object) {
             return 'UNRECOGNIZED';
     }
 }
-exports.groupKeyActionEventTypeToJSON = groupKeyActionEventTypeToJSON;
 var StepActionEventType;
 (function (StepActionEventType) {
     StepActionEventType[StepActionEventType["STEP_EVENT_TYPE_UNKNOWN"] = 0] = "STEP_EVENT_TYPE_UNKNOWN";
@@ -144,7 +152,6 @@ function stepActionEventTypeFromJSON(object) {
             return StepActionEventType.UNRECOGNIZED;
     }
 }
-exports.stepActionEventTypeFromJSON = stepActionEventTypeFromJSON;
 function stepActionEventTypeToJSON(object) {
     switch (object) {
         case StepActionEventType.STEP_EVENT_TYPE_UNKNOWN:
@@ -160,7 +167,6 @@ function stepActionEventTypeToJSON(object) {
             return 'UNRECOGNIZED';
     }
 }
-exports.stepActionEventTypeToJSON = stepActionEventTypeToJSON;
 var ResourceType;
 (function (ResourceType) {
     ResourceType[ResourceType["RESOURCE_TYPE_UNKNOWN"] = 0] = "RESOURCE_TYPE_UNKNOWN";
@@ -185,7 +191,6 @@ function resourceTypeFromJSON(object) {
             return ResourceType.UNRECOGNIZED;
     }
 }
-exports.resourceTypeFromJSON = resourceTypeFromJSON;
 function resourceTypeToJSON(object) {
     switch (object) {
         case ResourceType.RESOURCE_TYPE_UNKNOWN:
@@ -199,7 +204,6 @@ function resourceTypeToJSON(object) {
             return 'UNRECOGNIZED';
     }
 }
-exports.resourceTypeToJSON = resourceTypeToJSON;
 var ResourceEventType;
 (function (ResourceEventType) {
     ResourceEventType[ResourceEventType["RESOURCE_EVENT_TYPE_UNKNOWN"] = 0] = "RESOURCE_EVENT_TYPE_UNKNOWN";
@@ -240,7 +244,6 @@ function resourceEventTypeFromJSON(object) {
             return ResourceEventType.UNRECOGNIZED;
     }
 }
-exports.resourceEventTypeFromJSON = resourceEventTypeFromJSON;
 function resourceEventTypeToJSON(object) {
     switch (object) {
         case ResourceEventType.RESOURCE_EVENT_TYPE_UNKNOWN:
@@ -262,7 +265,6 @@ function resourceEventTypeToJSON(object) {
             return 'UNRECOGNIZED';
     }
 }
-exports.resourceEventTypeToJSON = resourceEventTypeToJSON;
 var WorkflowRunEventType;
 (function (WorkflowRunEventType) {
     WorkflowRunEventType[WorkflowRunEventType["WORKFLOW_RUN_EVENT_TYPE_FINISHED"] = 0] = "WORKFLOW_RUN_EVENT_TYPE_FINISHED";
@@ -279,7 +281,6 @@ function workflowRunEventTypeFromJSON(object) {
             return WorkflowRunEventType.UNRECOGNIZED;
     }
 }
-exports.workflowRunEventTypeFromJSON = workflowRunEventTypeFromJSON;
 function workflowRunEventTypeToJSON(object) {
     switch (object) {
         case WorkflowRunEventType.WORKFLOW_RUN_EVENT_TYPE_FINISHED:
@@ -289,7 +290,6 @@ function workflowRunEventTypeToJSON(object) {
             return 'UNRECOGNIZED';
     }
 }
-exports.workflowRunEventTypeToJSON = workflowRunEventTypeToJSON;
 function createBaseWorkerRegisterRequest() {
     return { workerName: '', actions: [], services: [], maxRuns: undefined };
 }

package/protoc/workflows/workflows.js

@@ -28,7 +28,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowServiceDefinition = exports.PutRateLimitResponse = exports.PutRateLimitRequest = exports.TriggerWorkflowResponse = exports.TriggerWorkflowRequest = exports.WorkflowTriggerCronRef = exports.WorkflowTriggerEventRef = exports.WorkflowVersion = exports.ScheduleWorkflowRequest = exports.ListWorkflowsRequest = exports.CreateStepRateLimit = exports.CreateWorkflowStepOpts = exports.CreateWorkflowJobOpts = exports.WorkflowConcurrencyOpts = exports.CreateWorkflowVersionOpts = exports.PutWorkflowRequest = exports.rateLimitDurationToJSON = exports.rateLimitDurationFromJSON = exports.RateLimitDuration = exports.concurrencyLimitStrategyToJSON = exports.concurrencyLimitStrategyFromJSON = exports.ConcurrencyLimitStrategy = exports.protobufPackage = void 0;
+exports.WorkflowServiceDefinition = exports.PutRateLimitResponse = exports.PutRateLimitRequest = exports.TriggerWorkflowResponse = exports.TriggerWorkflowRequest = exports.WorkflowTriggerCronRef = exports.WorkflowTriggerEventRef = exports.WorkflowVersion = exports.ScheduleWorkflowRequest = exports.ListWorkflowsRequest = exports.CreateStepRateLimit = exports.CreateWorkflowStepOpts = exports.CreateWorkflowJobOpts = exports.WorkflowConcurrencyOpts = exports.CreateWorkflowVersionOpts = exports.PutWorkflowRequest = exports.RateLimitDuration = exports.ConcurrencyLimitStrategy = exports.protobufPackage = void 0;
+exports.concurrencyLimitStrategyFromJSON = concurrencyLimitStrategyFromJSON;
+exports.concurrencyLimitStrategyToJSON = concurrencyLimitStrategyToJSON;
+exports.rateLimitDurationFromJSON = rateLimitDurationFromJSON;
+exports.rateLimitDurationToJSON = rateLimitDurationToJSON;
 const _m0 = __importStar(require("protobufjs/minimal"));
 const timestamp_1 = require("../google/protobuf/timestamp");
 exports.protobufPackage = '';
@@ -60,7 +64,6 @@ function concurrencyLimitStrategyFromJSON(object) {
             return ConcurrencyLimitStrategy.UNRECOGNIZED;
     }
 }
-exports.concurrencyLimitStrategyFromJSON = concurrencyLimitStrategyFromJSON;
 function concurrencyLimitStrategyToJSON(object) {
     switch (object) {
         case ConcurrencyLimitStrategy.CANCEL_IN_PROGRESS:
@@ -76,7 +79,6 @@ function concurrencyLimitStrategyToJSON(object) {
             return 'UNRECOGNIZED';
     }
 }
-exports.concurrencyLimitStrategyToJSON = concurrencyLimitStrategyToJSON;
 var RateLimitDuration;
 (function (RateLimitDuration) {
     RateLimitDuration[RateLimitDuration["SECOND"] = 0] = "SECOND";
@@ -117,7 +119,6 @@ function rateLimitDurationFromJSON(object) {
             return RateLimitDuration.UNRECOGNIZED;
     }
 }
-exports.rateLimitDurationFromJSON = rateLimitDurationFromJSON;
 function rateLimitDurationToJSON(object) {
     switch (object) {
         case RateLimitDuration.SECOND:
@@ -139,7 +140,6 @@ function rateLimitDurationToJSON(object) {
             return 'UNRECOGNIZED';
     }
 }
-exports.rateLimitDurationToJSON = rateLimitDurationToJSON;
 function createBasePutWorkflowRequest() {
     return { opts: undefined };
 }

package/step.d.ts

@@ -3,7 +3,7 @@ import { Action } from './clients/dispatcher/action-listener';
 import { LogLevel } from './clients/event/event-client';
 import { Logger } from './util/logger';
 import { HatchetClient } from './clients/hatchet-client';
-import { WorkflowRunEvent } from './protoc/dispatcher';
+import WorkflowRunRef from './util/workflow-run-ref';
 export declare const CreateRateLimitSchema: z.ZodObject<{
     key: z.ZodString;
     units: z.ZodNumber;
@@ -48,9 +48,16 @@ export declare const CreateStepSchema: z.ZodObject<{
         units: number;
     }[] | undefined;
 }>;
-type JSONPrimitive = string | number | boolean | null | Array<JSONPrimitive>;
+export type JsonObject = {
+    [Key in string]: JsonValue;
+} & {
+    [Key in string]?: JsonValue | undefined;
+};
+export type JsonArray = JsonValue[] | readonly JsonValue[];
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
 export type NextStep = {
-    [key: string]: NextStep | JSONPrimitive | Array<NextStep>;
+    [key: string]: JsonValue;
 };
 interface ContextData<T, K> {
     input: T;
@@ -58,15 +65,6 @@ interface ContextData<T, K> {
     triggered_by: string;
     user_data: K;
 }
-declare class ChildWorkflowRef<T> {
-    workflowRunId: Promise<string>;
-    parentWorkflowRunId: string;
-    client: HatchetClient;
-    constructor(workflowRunId: Promise<string>, parentWorkflowRunId: string, client: HatchetClient);
-    stream(): Promise<AsyncGenerator<WorkflowRunEvent, void, unknown>>;
-    result(): Promise<T>;
-    toJSON(): Promise<string>;
-}
 export declare class Context<T, K = {}> {
     data: ContextData<T, K>;
     input: T;
@@ -96,7 +94,7 @@ export declare class Context<T, K = {}> {
     refreshTimeout(incrementBy: string): Promise<void>;
     releaseSlot(): Promise<void>;
     putStream(data: string | Uint8Array): Promise<void>;
-    spawnWorkflow<P = unknown, Q = unknown>(workflowName: string, input: Q, key?: string): ChildWorkflowRef<P>;
+    spawnWorkflow<Q = JsonValue, P = JsonValue>(workflowName: string, input: Q, key?: string): WorkflowRunRef<P>;
 }
 export type StepRunFunction<T, K> = (ctx: Context<T, K>) => Promise<NextStep | void> | NextStep | void;
 export interface CreateStep<T, K> extends z.infer<typeof CreateStepSchema> {

package/step.js

@@ -31,13 +31,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __asyncValues = (this && this.__asyncValues) || function (o) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var m = o[Symbol.asyncIterator], i;
-    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
-    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
-    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -49,7 +42,6 @@ const z = __importStar(require("zod"));
 const workflow_1 = require("./workflow");
 const logger_1 = require("./util/logger");
 const parse_1 = require("./util/parse");
-const dispatcher_1 = require("./protoc/dispatcher");
 exports.CreateRateLimitSchema = z.object({
     key: z.string(),
     units: z.number().min(1),
@@ -61,60 +53,6 @@ exports.CreateStepSchema = z.object({
     retries: z.number().optional(),
     rate_limits: z.array(exports.CreateRateLimitSchema).optional(),
 });
-class ChildWorkflowRef {
-    constructor(workflowRunId, parentWorkflowRunId, client) {
-        this.workflowRunId = workflowRunId;
-        this.parentWorkflowRunId = parentWorkflowRunId;
-        this.client = client;
-    }
-    stream() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const workflowRunId = yield this.workflowRunId;
-            const listener = yield this.client.listener.getChildListener(workflowRunId, this.parentWorkflowRunId);
-            return listener.stream();
-        });
-    }
-    result() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const listener = yield this.stream();
-            return new Promise((resolve, reject) => {
-                (() => __awaiter(this, void 0, void 0, function* () {
-                    var _a, e_1, _b, _c;
-                    try {
-                        for (var _d = true, _e = __asyncValues(yield listener), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
-                            _c = _f.value;
-                            _d = false;
-                            const event = _c;
-                            if (event.eventType === dispatcher_1.WorkflowRunEventType.WORKFLOW_RUN_EVENT_TYPE_FINISHED) {
-                                if (event.results.some((r) => !!r.error)) {
-                                    reject(event.results);
-                                    return;
-                                }
-                                const result = event.results.reduce((acc, r) => (Object.assign(Object.assign({}, acc), { [r.stepReadableId]: JSON.parse(r.output || '{}') })), {});
-                                resolve(result);
-                                return;
-                            }
-                        }
-                    }
-                    catch (e_1_1) { e_1 = { error: e_1_1 }; }
-                    finally {
-                        try {
-                            if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
-                        }
-                        finally { if (e_1) throw e_1.error; }
-                    }
-                }))();
-            });
-        });
-    }
-    toJSON() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return JSON.stringify({
-                workflowRunId: yield this.workflowRunId,
-            });
-        });
-    }
-}
 class Context {
     constructor(action, client) {
         this.controller = new AbortController();
@@ -229,14 +167,19 @@ class Context {
     spawnWorkflow(workflowName, input, key) {
         const { workflowRunId, stepRunId } = this.action;
         const name = this.client.config.namespace + workflowName;
-        const childWorkflowRunIdPromise = this.client.admin.runWorkflow(name, input, {
-            parentId: workflowRunId,
-            parentStepRunId: stepRunId,
-            childKey: key,
-            childIndex: this.spawnIndex,
-        });
-        this.spawnIndex += 1;
-        return new ChildWorkflowRef(childWorkflowRunIdPromise, workflowRunId, this.client);
+        try {
+            const resp = this.client.admin.runWorkflow(name, input, {
+                parentId: workflowRunId,
+                parentStepRunId: stepRunId,
+                childKey: key,
+                childIndex: this.spawnIndex,
+            });
+            this.spawnIndex += 1;
+            return resp;
+        }
+        catch (e) {
+            throw new hatchet_error_1.default(e.message);
+        }
     }
 }
 exports.Context = Context;

package/util/config-loader/token.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAddressesFromJWT = exports.getTenantIdFromJWT = void 0;
+exports.getTenantIdFromJWT = getTenantIdFromJWT;
+exports.getAddressesFromJWT = getAddressesFromJWT;
 function getTenantIdFromJWT(token) {
     const claims = extractClaimsFromJWT(token);
     return claims.sub;
 }
-exports.getTenantIdFromJWT = getTenantIdFromJWT;
 function getAddressesFromJWT(token) {
     const claims = extractClaimsFromJWT(token);
     return {
@@ -13,7 +13,6 @@ function getAddressesFromJWT(token) {
         grpcBroadcastAddress: claims.grpc_broadcast_address,
     };
 }
-exports.getAddressesFromJWT = getAddressesFromJWT;
 function extractClaimsFromJWT(token) {
     const parts = token.split('.');
     if (parts.length !== 3) {

package/util/parse.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseJSON = void 0;
+exports.parseJSON = parseJSON;
 function parseJSON(json) {
     try {
         const firstParse = JSON.parse(json);
@@ -17,4 +17,3 @@ function parseJSON(json) {
         throw new Error(`Could not parse JSON: ${e.message}`);
     }
 }
-exports.parseJSON = parseJSON;

package/util/retrier.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.retrier = void 0;
+exports.retrier = retrier;
 const sleep_1 = __importDefault(require("./sleep"));
 const DEFAULT_RETRY_INTERVAL = 5; // seconds
 const DEFAULT_RETRY_COUNT = 5;
@@ -33,4 +33,3 @@ function retrier(fn_1, logger_1) {
         throw lastError;
     });
 }
-exports.retrier = retrier;

package/util/thread-helper.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="node" />
 import { Worker, WorkerOptions } from 'worker_threads';
 export declare function runThreaded(scriptPath: string, options: WorkerOptions): Worker;

package/util/thread-helper.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runThreaded = void 0;
+exports.runThreaded = runThreaded;
 const worker_threads_1 = require("worker_threads");
 const path_1 = __importDefault(require("path"));
 function runThreaded(scriptPath, options) {
@@ -32,5 +32,4 @@ function runThreaded(scriptPath, options) {
         : resolvedPath;
     return new worker_threads_1.Worker(ex, Object.assign(Object.assign({}, options), { eval: isTs ? true : undefined }));
 }
-exports.runThreaded = runThreaded;
 // execArgv:  ? ['--require', 'ts-node/register'] : undefined,

package/util/workflow-run-ref.d.ts

@@ -0,0 +1,17 @@
+import { ListenerClient, StepRunEvent } from '../clients/listener/listener-client';
+type EventualWorkflowRunId = string | Promise<string> | Promise<{
+    workflowRunId: string;
+}>;
+export default class WorkflowRunRef<T> {
+    workflowRunId: EventualWorkflowRunId;
+    parentWorkflowRunId?: string;
+    private client;
+    constructor(workflowRunId: string | Promise<string> | Promise<{
+        workflowRunId: string;
+    }>, client: ListenerClient, parentWorkflowRunId?: string);
+    getWorkflowRunId(): Promise<string>;
+    stream(): Promise<AsyncGenerator<StepRunEvent, void, unknown>>;
+    result(): Promise<T>;
+    toJSON(): Promise<string>;
+}
+export {};

package/util/workflow-run-ref.js

@@ -0,0 +1,94 @@
+"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());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const dispatcher_1 = require("../protoc/dispatcher");
+function getWorkflowRunId(workflowRunId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (typeof workflowRunId === 'string') {
+            return workflowRunId;
+        }
+        if (workflowRunId instanceof Promise) {
+            const resolved = yield workflowRunId;
+            if (typeof resolved === 'string') {
+                return resolved;
+            }
+            return resolved.workflowRunId;
+        }
+        throw new Error('Invalid workflowRunId');
+    });
+}
+class WorkflowRunRef {
+    constructor(workflowRunId, client, parentWorkflowRunId) {
+        this.workflowRunId = workflowRunId;
+        this.parentWorkflowRunId = parentWorkflowRunId;
+        this.client = client;
+    }
+    getWorkflowRunId() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return getWorkflowRunId(this.workflowRunId);
+        });
+    }
+    stream() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const workflowRunId = yield getWorkflowRunId(this.workflowRunId);
+            return this.client.stream(workflowRunId);
+        });
+    }
+    result() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const workflowRunId = yield getWorkflowRunId(this.workflowRunId);
+            const streamable = yield this.client.get(workflowRunId);
+            return new Promise((resolve, reject) => {
+                (() => __awaiter(this, void 0, void 0, function* () {
+                    var _a, e_1, _b, _c;
+                    try {
+                        for (var _d = true, _e = __asyncValues(streamable.stream()), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
+                            _c = _f.value;
+                            _d = false;
+                            const event = _c;
+                            if (event.eventType === dispatcher_1.WorkflowRunEventType.WORKFLOW_RUN_EVENT_TYPE_FINISHED) {
+                                if (event.results.some((r) => !!r.error)) {
+                                    reject(event.results);
+                                    return;
+                                }
+                                const result = event.results.reduce((acc, r) => (Object.assign(Object.assign({}, acc), { [r.stepReadableId]: JSON.parse(r.output || '{}') })), {});
+                                resolve(result);
+                                return;
+                            }
+                        }
+                    }
+                    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                    finally {
+                        try {
+                            if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+                        }
+                        finally { if (e_1) throw e_1.error; }
+                    }
+                }))();
+            });
+        });
+    }
+    toJSON() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return JSON.stringify({
+                workflowRunId: yield this.workflowRunId,
+            });
+        });
+    }
+}
+exports.default = WorkflowRunRef;