@hatchet-dev/typescript-sdk 0.8.1 → 0.10.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 { WebhookWorkerCreateRequest, 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
      */
@@ -48,6 +51,7 @@ export declare class AdminClient {
      */
     put_rate_limit(key: string, limit: number, duration: RateLimitDuration): Promise<void>;
     putRateLimit(key: string, limit: number, duration?: RateLimitDuration): Promise<void>;
+    registerWebhook(data: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WebhookWorkerCreated, any>>;
     /**
      * @deprecated use runWorkflow instead
      */
@@ -57,7 +61,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 +70,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 +110,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 +150,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
@@ -88,6 +90,11 @@ class AdminClient {
             }
         });
     }
+    registerWebhook(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.api.webhookCreate(this.tenantId, data);
+        });
+    }
     /**
      * @deprecated use runWorkflow instead
      */
@@ -105,22 +112,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 +201,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 +235,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.d.ts

@@ -29,4 +29,5 @@ export declare class HatchetClient {
     static init(config?: Partial<ClientConfig>, options?: HatchetClientOptions, axiosConfig?: AxiosRequestConfig): HatchetClient;
     run(workflow: string | Workflow): Promise<Worker>;
     worker(workflow: string | Workflow, maxRuns?: number): Promise<Worker>;
+    webhooks(workflows: Workflow[]): import("../worker/handler").WebhookHandler;
 }

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`);
     }
@@ -142,5 +142,11 @@ class HatchetClient {
             return worker;
         });
     }
+    webhooks(workflows) {
+        const worker = new worker_1.Worker(this, {
+            name: 'webhook-worker',
+        });
+        return worker.getHandler(workflows);
+    }
 }
 exports.HatchetClient = 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();
         });
     }
 }