@hatchet-dev/typescript-sdk 0.8.0-alpha.2 → 0.8.0-alpha.4

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 { WebhookWorkerCreateRequest, WorkflowRunStatus } 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,72 +34,138 @@ 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
+     */
+    put_workflow(opts: CreateWorkflowVersionOpts): Promise<void>;
     /**
      * Creates a new workflow or updates an existing workflow. If the workflow already exists, Hatchet will automatically
      * determine if the workflow definition has changed and create a new version if necessary.
      * @param workflow a workflow definition to create
      */
-    put_workflow(workflow: CreateWorkflowVersionOpts): Promise<void>;
-    put_rate_limit(key: string, limit: number, duration?: RateLimitDuration): Promise<void>;
-    webhook_create(data: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WebhookWorker, any>>;
+    putWorkflow(workflow: CreateWorkflowVersionOpts): Promise<void>;
+    /**
+     * @deprecated use putRateLimit instead
+     */
+    put_rate_limit(key: string, limit: number, duration: RateLimitDuration): Promise<void>;
+    putRateLimit(key: string, limit: number, duration?: RateLimitDuration): Promise<void>;
+    webhook_create(data: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WebhookWorkerCreated, any>>;
+    /**
+     * @deprecated use runWorkflow instead
+     */
+    run_workflow<T = object>(workflowName: string, input: T, options?: {
+        parentId?: string | undefined;
+        parentStepRunId?: string | undefined;
+        childIndex?: number | undefined;
+        childKey?: string | undefined;
+        additionalMetadata?: Record<string, string> | undefined;
+    }): 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.
      * @param workflowName the name of the workflow to run
      * @param input an object containing the input to the workflow
+     * @param options an object containing the options to run the workflow
      * @returns the ID of the new workflow run
      */
-    run_workflow<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
+     */
+    list_workflows(): Promise<import("../rest/generated/data-contracts").WorkflowList>;
     /**
      * List workflows in the tenant associated with the API token.
      * @returns a list of all workflows in the tenant
      */
-    list_workflows(): Promise<import("../rest/generated/data-contracts").WorkflowList>;
+    listWorkflows(): Promise<import("../rest/generated/data-contracts").WorkflowList>;
+    /**
+     * @deprecated use getWorkflow instead
+     */
+    get_workflow(workflowId: string): Promise<import("../rest/generated/data-contracts").Workflow>;
     /**
      * Get a workflow by its ID.
      * @param workflowId the workflow ID (**note:** this is not the same as the workflow version id)
      * @returns
      */
-    get_workflow(workflowId: string): Promise<import("../rest/generated/data-contracts").Workflow>;
+    getWorkflow(workflowId: string): Promise<import("../rest/generated/data-contracts").Workflow>;
+    /**
+     * @deprecated use getWorkflowVersion instead
+     */
+    get_workflow_version(workflowId: string, version?: string): Promise<import("../rest/generated/data-contracts").WorkflowVersion>;
     /**
      * Get a workflow version.
      * @param workflowId the workflow ID
      * @param version the version of the workflow to get. If not provided, the latest version will be returned.
      * @returns the workflow version
      */
-    get_workflow_version(workflowId: string, version?: string): Promise<import("../rest/generated/data-contracts").WorkflowVersion>;
+    getWorkflowVersion(workflowId: string, version?: string): Promise<import("../rest/generated/data-contracts").WorkflowVersion>;
+    /**
+     * @deprecated use getWorkflowRun instead
+     */
+    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
      */
-    get_workflow_run(workflowRunId: string): Promise<import("../rest/generated/data-contracts").WorkflowRun>;
+    getWorkflowRun(workflowRunId: string): Promise<WorkflowRunRef<unknown>>;
+    /**
+     * @deprecated use listWorkflowRuns instead
+     */
+    list_workflow_runs(query: {
+        offset?: number | undefined;
+        limit?: number | undefined;
+        eventId?: string | undefined;
+        workflowId?: string | undefined;
+        parentWorkflowRunId?: string | undefined;
+        parentStepRunId?: string | undefined;
+        statuses?: WorkflowRunStatusList | undefined;
+        additionalMetadata?: string[] | undefined;
+    }): Promise<import("../rest/generated/data-contracts").WorkflowRunList>;
     /**
      * List workflow runs in the tenant associated with the API token.
      * @param query the query to filter the list of workflow runs
      * @returns
      */
-    list_workflow_runs(query: {
+    listWorkflowRuns(query: {
         offset?: number | undefined;
         limit?: number | undefined;
         eventId?: string | undefined;
         workflowId?: string | undefined;
+        parentWorkflowRunId?: string | undefined;
+        parentStepRunId?: string | undefined;
+        statuses?: WorkflowRunStatusList | undefined;
+        additionalMetadata?: string[] | undefined;
     }): Promise<import("../rest/generated/data-contracts").WorkflowRunList>;
+    /**
+     * @deprecated use scheduleWorkflow instead
+     */
+    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
      */
-    schedule_workflow(name: string, options?: {
+    scheduleWorkflow(name: string, options?: {
         schedules?: Date[];
+        input?: object;
     }): void;
+    /**
+     * @deprecated use getWorkflowMetrics instead
+     */
+    get_workflow_metrics(data: WorkflowMetricsQuery): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WorkflowMetrics, any>>;
     /**
      * Get the metrics for a workflow.
      *
@@ -105,6 +173,6 @@ export declare class AdminClient {
      * @param workflowName the name of the workflow to get metrics for
      * @param query an object containing query parameters to filter the metrics
      */
-    get_workflow_metrics({ workflowId, workflowName, status, groupKey }: WorkflowMetricsQuery): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WorkflowMetrics, any>>;
+    getWorkflowMetrics({ workflowId, workflowName, status, groupKey }: WorkflowMetricsQuery): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WorkflowMetrics, any>>;
 }
 export {};

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,19 +35,28 @@ 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
+     */
+    put_workflow(opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.putWorkflow(opts);
+        });
     }
     /**
      * Creates a new workflow or updates an existing workflow. If the workflow already exists, Hatchet will automatically
      * determine if the workflow definition has changed and create a new version if necessary.
      * @param workflow a workflow definition to create
      */
-    put_workflow(workflow) {
+    putWorkflow(workflow) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () { return this.client.putWorkflow({ opts: workflow }); }), this.logger);
@@ -56,7 +66,15 @@ class AdminClient {
             }
         });
     }
-    put_rate_limit(key_1, limit_1) {
+    /**
+     * @deprecated use putRateLimit instead
+     */
+    put_rate_limit(key, limit, duration) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.putRateLimit(key, limit, duration);
+        });
+    }
+    putRateLimit(key_1, limit_1) {
         return __awaiter(this, arguments, void 0, function* (key, limit, duration = workflows_1.RateLimitDuration.SECOND) {
             try {
                 yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () {
@@ -77,59 +95,90 @@ class AdminClient {
             return this.api.webhookCreate(this.tenantId, data);
         });
     }
+    /**
+     * @deprecated use runWorkflow instead
+     */
+    run_workflow(workflowName, input, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.runWorkflow(workflowName, input, options);
+        });
+    }
     /**
      * 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.
      * @param workflowName the name of the workflow to run
      * @param input an object containing the input to the workflow
+     * @param options an object containing the options to run the workflow
      * @returns the ID of the new workflow run
      */
-    run_workflow(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);
+    runWorkflow(workflowName, input, options) {
+        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
+     */
+    list_workflows() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.listWorkflows();
         });
     }
     /**
      * List workflows in the tenant associated with the API token.
      * @returns a list of all workflows in the tenant
      */
-    list_workflows() {
+    listWorkflows() {
         return __awaiter(this, void 0, void 0, function* () {
             const res = yield this.api.workflowList(this.tenantId);
             return res.data;
         });
     }
+    /**
+     * @deprecated use getWorkflow instead
+     */
+    get_workflow(workflowId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getWorkflow(workflowId);
+        });
+    }
     /**
      * Get a workflow by its ID.
      * @param workflowId the workflow ID (**note:** this is not the same as the workflow version id)
      * @returns
      */
-    get_workflow(workflowId) {
+    getWorkflow(workflowId) {
         return __awaiter(this, void 0, void 0, function* () {
             const res = yield this.api.workflowGet(workflowId);
             return res.data;
         });
     }
+    /**
+     * @deprecated use getWorkflowVersion instead
+     */
+    get_workflow_version(workflowId, version) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getWorkflowVersion(workflowId, version);
+        });
+    }
     /**
      * Get a workflow version.
      * @param workflowId the workflow ID
      * @param version the version of the workflow to get. If not provided, the latest version will be returned.
      * @returns the workflow version
      */
-    get_workflow_version(workflowId, version) {
+    getWorkflowVersion(workflowId, version) {
         return __awaiter(this, void 0, void 0, function* () {
             const res = yield this.api.workflowVersionGet(workflowId, {
                 version,
@@ -137,15 +186,30 @@ class AdminClient {
             return res.data;
         });
     }
+    /**
+     * @deprecated use getWorkflowRun instead
+     */
+    get_workflow_run(workflowRunId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getWorkflowRun(workflowRunId);
+        });
+    }
     /**
      * Get a workflow run.
      * @param workflowRunId the id of the workflow run to get
      * @returns the workflow run
      */
-    get_workflow_run(workflowRunId) {
+    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);
+        });
+    }
+    /**
+     * @deprecated use listWorkflowRuns instead
+     */
+    list_workflow_runs(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.listWorkflowRuns(query);
         });
     }
     /**
@@ -153,28 +217,50 @@ class AdminClient {
      * @param query the query to filter the list of workflow runs
      * @returns
      */
-    list_workflow_runs(query) {
+    listWorkflowRuns(query) {
         return __awaiter(this, void 0, void 0, function* () {
             const res = yield this.api.workflowRunList(this.tenantId, query);
             return res.data;
         });
     }
+    /**
+     * @deprecated use scheduleWorkflow instead
+     */
+    schedule_workflow(name, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.scheduleWorkflow(name, options);
+        });
+    }
     /**
      * 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
      */
-    schedule_workflow(name, options) {
+    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) {
             throw new hatchet_error_1.default(e.message);
         }
     }
+    /**
+     * @deprecated use getWorkflowMetrics instead
+     */
+    get_workflow_metrics(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getWorkflowMetrics(data);
+        });
+    }
     /**
      * Get the metrics for a workflow.
      *
@@ -182,13 +268,13 @@ class AdminClient {
      * @param workflowName the name of the workflow to get metrics for
      * @param query an object containing query parameters to filter the metrics
      */
-    get_workflow_metrics({ workflowId, workflowName, status, groupKey }) {
+    getWorkflowMetrics({ workflowId, workflowName, status, groupKey }) {
         const params = {
             status,
             groupKey,
         };
         if (workflowName) {
-            this.list_workflows().then((res) => {
+            this.listWorkflows().then((res) => {
                 var _a;
                 const workflow = (_a = res.rows) === null || _a === void 0 ? void 0 : _a.find((row) => row.name === workflowName);
                 if (workflow) {

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,5 +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(workflow: Workflow): import("../worker/handler").WebhookHandler;
+    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,11 +142,11 @@ class HatchetClient {
             return worker;
         });
     }
-    webhooks(workflow) {
+    webhooks(workflows) {
         const worker = new worker_1.Worker(this, {
-            name: workflow.id,
+            name: 'webhook-worker',
         });
-        return worker.getHandler(workflow);
+        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>>;
 }