@hatchet-dev/typescript-sdk 1.0.0-alpha0 → 1.0.0-alpha1

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

@@ -6,7 +6,7 @@ import { Workflow as V0Workflow } from '../../workflow';
 import { V0Worker, WorkerOpts } from '../worker';
 import { AxiosRequestConfig } from 'axios';
 import { Logger } from '../../util/logger';
-import { Workflow as V1Workflow } from '../../v1/workflow';
+import { WorkflowDeclaration as V1Workflow } from '../../v1/workflow';
 import { ClientConfig } from './client-config';
 import { ListenerClient } from '../listener/listener-client';
 import { Api } from '../rest/generated/Api';

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HatchetLogger = exports.DEFAULT_LOGGER = void 0;
+/* eslint-disable no-console */
 const logger_1 = require("../../util/logger");
 const DEFAULT_LOGGER = (context, logLevel) => new HatchetLogger(context, logLevel);
 exports.DEFAULT_LOGGER = DEFAULT_LOGGER;
@@ -19,8 +20,22 @@ class HatchetLogger {
                 minute: '2-digit',
                 second: '2-digit',
             });
+            // eslint-disable-next-line prefer-destructuring
+            let print = console.log;
+            if (level === 'ERROR') {
+                print = console.error;
+            }
+            if (level === 'WARN') {
+                print = console.warn;
+            }
+            if (level === 'INFO') {
+                print = console.info;
+            }
+            if (level === 'DEBUG') {
+                print = console.debug;
+            }
             // eslint-disable-next-line no-console
-            console.log(`🪓 ${process.pid} | ${time} ${color && `\x1b[${color || ''}m`} [${level}/${this.context}] ${message}\x1b[0m`);
+            print(`🪓 ${process.pid} | ${time} ${color && `\x1b[${color || ''}m`} [${level}/${this.context}] ${message}\x1b[0m`);
         }
     }
     debug(message) {

package/clients/worker/worker.js

@@ -187,8 +187,6 @@ class V0Worker {
                         // Send the action event to the dispatcher
                         const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_COMPLETED, result || null);
                         yield this.client.dispatcher.sendStepActionEvent(event);
-                        // delete the run from the futures
-                        delete this.futures[action.stepRunId];
                     }
                     catch (actionEventError) {
                         this.logger.error(`Could not send completed action event: ${actionEventError.message || actionEventError}`);
@@ -202,6 +200,11 @@ class V0Worker {
                         }
                         this.logger.error(`Could not send action event: ${actionEventError.message || actionEventError}`);
                     }
+                    finally {
+                        // delete the run from the futures
+                        delete this.futures[action.stepRunId];
+                        delete this.contexts[action.stepRunId];
+                    }
                 });
                 const failure = (error) => __awaiter(this, void 0, void 0, function* () {
                     this.logger.error(`Step run ${action.stepRunId} failed: ${error.message}`);
@@ -215,12 +218,15 @@ class V0Worker {
                             stack: error === null || error === void 0 ? void 0 : error.stack,
                         });
                         yield this.client.dispatcher.sendStepActionEvent(event);
-                        // delete the run from the futures
-                        delete this.futures[action.stepRunId];
                     }
                     catch (e) {
                         this.logger.error(`Could not send action event: ${e.message}`);
                     }
+                    finally {
+                        // delete the run from the futures
+                        delete this.futures[action.stepRunId];
+                        delete this.contexts[action.stepRunId];
+                    }
                 });
                 const future = new hatchet_promise_1.default((() => __awaiter(this, void 0, void 0, function* () {
                     let result;
@@ -279,12 +285,15 @@ class V0Worker {
                         this.client.dispatcher.sendGroupKeyActionEvent(event).catch((e) => {
                             this.logger.error(`Could not send action event: ${e.message}`);
                         });
-                        // delete the run from the futures
-                        delete this.futures[key];
                     }
                     catch (e) {
                         this.logger.error(`Could not send action event: ${e.message}`);
                     }
+                    finally {
+                        // delete the run from the futures
+                        delete this.futures[key];
+                        delete this.contexts[key];
+                    }
                 };
                 const failure = (error) => {
                     this.logger.error(`Step run ${key} failed: ${error.message}`);
@@ -294,12 +303,15 @@ class V0Worker {
                         this.client.dispatcher.sendGroupKeyActionEvent(event).catch((e) => {
                             this.logger.error(`Could not send action event: ${e.message}`);
                         });
-                        // delete the run from the futures
-                        delete this.futures[key];
                     }
                     catch (e) {
                         this.logger.error(`Could not send action event: ${e.message}`);
                     }
+                    finally {
+                        // delete the run from the futures
+                        delete this.futures[key];
+                        delete this.contexts[key];
+                    }
                 };
                 const future = new hatchet_promise_1.default(run().then(success).catch(failure));
                 this.futures[key] = future;
@@ -344,14 +356,13 @@ class V0Worker {
     }
     handleCancelStepRun(action) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { stepRunId } = action;
             try {
                 this.logger.info(`Cancelling step run ${action.stepRunId}`);
-                const { stepRunId } = action;
                 const future = this.futures[stepRunId];
                 const context = this.contexts[stepRunId];
                 if (context && context.controller) {
                     context.controller.abort('Cancelled by worker');
-                    delete this.contexts[stepRunId];
                 }
                 if (future) {
                     future.promise.catch(() => {
@@ -359,12 +370,15 @@ class V0Worker {
                     });
                     future.cancel('Cancelled by worker');
                     yield future.promise;
-                    delete this.futures[stepRunId];
                 }
             }
             catch (e) {
                 this.logger.error('Could not cancel step run: ', e);
             }
+            finally {
+                delete this.futures[stepRunId];
+                delete this.contexts[stepRunId];
+            }
         });
     }
     stop() {

package/index.d.ts

@@ -7,5 +7,6 @@ export * from './clients/admin';
 export * from './util/workflow-run-ref';
 export * from './v1/client/client';
 export * from './v1/client/worker';
+export * from './v1/workflow';
 export default Hatchet;
 export { Hatchet };

package/index.js

@@ -25,4 +25,5 @@ __exportStar(require("./clients/admin"), exports);
 __exportStar(require("./util/workflow-run-ref"), exports);
 __exportStar(require("./v1/client/client"), exports);
 __exportStar(require("./v1/client/worker"), exports);
+__exportStar(require("./v1/workflow"), exports);
 exports.default = client_1.HatchetClient;

package/package.json

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

package/step.d.ts

@@ -9,7 +9,7 @@ import { V0Worker } from './clients/worker';
 import { WorkerLabels } from './clients/dispatcher/dispatcher-client';
 import { CreateStepRateLimit, RateLimitDuration, WorkerLabelComparator } from './protoc/workflows';
 import { CreateTaskOpts } from './v1/task';
-import { Workflow as WorkflowV1 } from './v1/workflow';
+import { WorkflowDeclaration as WorkflowV1 } from './v1/workflow';
 export declare const CreateRateLimitSchema: z.ZodObject<{
     key: z.ZodOptional<z.ZodString>;
     staticKey: z.ZodOptional<z.ZodString>;
@@ -211,7 +211,7 @@ export declare class Context<T, K = {}> {
      * @param children an array of objects containing the workflow name, input data, and options for each workflow
      * @returns a list of workflow run references to the enqueued runs
      */
-    bulkEnqueueChildren<Q extends Record<string, any> = any, P extends Record<string, any> = any>(children: Array<{
+    bulkEnqueueChildren<Q extends JsonObject = any, P extends JsonObject = any>(children: Array<{
         workflow: string | Workflow | WorkflowV1<Q, P>;
         input: Q;
         options?: {
@@ -225,7 +225,7 @@ export declare class Context<T, K = {}> {
      * @param children an array of objects containing the workflow name, input data, and options for each workflow
      * @returns a list of results from the children workflows
      */
-    bulkRunChildren<Q extends Record<string, any> = any, P extends Record<string, any> = any>(children: Array<{
+    bulkRunChildren<Q extends JsonObject = any, P extends JsonObject = any>(children: Array<{
         workflow: string | Workflow | WorkflowV1<Q, P>;
         input: Q;
         options?: {
@@ -241,7 +241,7 @@ export declare class Context<T, K = {}> {
      * @returns a list of references to the spawned workflow runs
      * @deprecated use bulkEnqueueChildren or bulkRunChildren instead
      */
-    spawnWorkflows<Q extends Record<string, any> = any, P extends Record<string, any> = any>(workflows: Array<{
+    spawnWorkflows<Q extends JsonObject = any, P extends JsonObject = any>(workflows: Array<{
         workflow: string | Workflow | WorkflowV1<Q, P>;
         input: Q;
         options?: {
@@ -260,7 +260,7 @@ export declare class Context<T, K = {}> {
      * @param <P> the type of the output data
      * @return the result of the workflow
      */
-    runChild<Q extends Record<string, any>, P extends Record<string, any>>(workflow: string | Workflow | WorkflowV1<Q, P>, input: Q, options?: string | {
+    runChild<Q extends JsonObject, P extends JsonObject>(workflow: string | Workflow | WorkflowV1<Q, P>, input: Q, options?: string | {
         key?: string;
         sticky?: boolean;
         additionalMetadata?: Record<string, string>;
@@ -278,7 +278,7 @@ export declare class Context<T, K = {}> {
      * @param <P> the type of the output data
      * @return a reference to the spawned workflow run
      */
-    enqueueChild<Q extends Record<string, any>, P extends Record<string, any>>(workflow: string | Workflow | WorkflowV1<Q, P>, input: Q, options?: string | {
+    enqueueChild<Q extends JsonObject, P extends JsonObject>(workflow: string | Workflow | WorkflowV1<Q, P>, input: Q, options?: string | {
         key?: string;
         sticky?: boolean;
         additionalMetadata?: Record<string, string>;
@@ -297,7 +297,7 @@ export declare class Context<T, K = {}> {
      * @return a reference to the spawned workflow run
      * @deprecated use runChild or enqueueChild instead
      */
-    spawnWorkflow<Q extends Record<string, any>, P extends Record<string, any>>(workflow: string | Workflow | WorkflowV1<Q, P>, input: Q, options?: string | {
+    spawnWorkflow<Q extends JsonObject, P extends JsonObject>(workflow: string | Workflow | WorkflowV1<Q, P>, input: Q, options?: string | {
         key?: string;
         sticky?: boolean;
         additionalMetadata?: Record<string, string>;

package/v1/client/client.d.ts

@@ -2,7 +2,8 @@ import { ClientConfig, InternalHatchetClient, HatchetClientOptions } from '../..
 import { AxiosRequestConfig } from 'axios';
 import WorkflowRunRef from '../../util/workflow-run-ref';
 import { Workflow as V0Workflow } from '../../workflow';
-import { CreateWorkflowOpts, RunOpts, Workflow } from '../workflow';
+import { JsonObject } from '../../step';
+import { CreateWorkflowOpts, RunOpts, WorkflowDeclaration } from '../workflow';
 import { IHatchetClient } from './client.interface';
 import { CreateWorkerOpts, Worker } from './worker';
 /**
@@ -37,7 +38,7 @@ export declare class HatchetClient implements IHatchetClient {
      * @returns A new Workflow instance
      * @note It is possible to create an orphaned workflow if no client is available using @hatchet/client CreateWorkflow
      */
-    workflow<T extends Record<string, any> = any, K = any>(options: CreateWorkflowOpts): Workflow<T, K>;
+    workflow<T extends JsonObject = any, K extends JsonObject = any>(options: CreateWorkflowOpts): WorkflowDeclaration<T, K>;
     /**
      * Triggers a workflow run without waiting for completion.
      * @template T - The input type for the workflow
@@ -47,7 +48,7 @@ export declare class HatchetClient implements IHatchetClient {
      * @param options - Configuration options for the workflow run
      * @returns A WorkflowRunRef containing the run ID and methods to interact with the run
      */
-    enqueue<T extends Record<string, any> = any, K = any>(workflow: Workflow<T, K> | string | V0Workflow, input: T, options: RunOpts): WorkflowRunRef<K>;
+    enqueue<T extends JsonObject = any, K extends JsonObject = any>(workflow: WorkflowDeclaration<T, K> | string | V0Workflow, input: T, options: RunOpts): WorkflowRunRef<K>;
     /**
      * Triggers a workflow run and waits for the result.
      * @template T - The input type for the workflow
@@ -57,7 +58,7 @@ export declare class HatchetClient implements IHatchetClient {
      * @param options - Configuration options for the workflow run
      * @returns A promise that resolves with the workflow result
      */
-    run<T extends Record<string, any> = any, K = any>(workflow: Workflow<T, K> | string | V0Workflow, input: T, options?: RunOpts): Promise<K>;
+    run<T extends JsonObject = any, K extends JsonObject = any>(workflow: WorkflowDeclaration<T, K> | string | V0Workflow, input: T, options?: RunOpts): Promise<K>;
     get cron(): import("../../clients/hatchet-client/features/cron-client").CronClient;
     get schedule(): import("../../clients/hatchet-client/features/schedule-client").ScheduleClient;
     get event(): import("../../clients/event/event-client").EventClient;
@@ -77,5 +78,5 @@ export declare class HatchetClient implements IHatchetClient {
      * @param workflows - The workflows to register on the webhooks
      * @returns A promise that resolves when the webhook is registered
      */
-    webhooks(workflows: Workflow<any, any>[] | V0Workflow[]): import("../../clients/worker/handler").WebhookHandler;
+    webhooks(workflows: WorkflowDeclaration<any, any>[] | V0Workflow[]): import("../../clients/worker/handler").WebhookHandler;
 }

package/v1/client/worker.d.ts

@@ -3,7 +3,7 @@ import { InternalHatchetClient } from '../../clients/hatchet-client';
 import { V0Worker } from '../../clients/worker';
 import { Workflow as V0Workflow } from '../../workflow';
 import { WebhookWorkerCreateRequest } from '../../clients/rest/generated/data-contracts';
-import { Workflow } from '../workflow';
+import { WorkflowDeclaration } from '../workflow';
 /**
  * Options for creating a new hatchet worker
  * @interface CreateWorkerOpts
@@ -12,7 +12,7 @@ export interface CreateWorkerOpts {
     /** Maximum number of concurrent runs on this worker */
     slots?: number;
     /** Array of workflows to register */
-    workflows?: Workflow<any, any>[] | V0Workflow[];
+    workflows?: WorkflowDeclaration<any, any>[] | V0Workflow[];
     /** Worker labels for affinity-based assignment */
     labels?: WorkerLabels;
     /** Whether to handle kill signals */
@@ -43,14 +43,14 @@ export declare class Worker {
      * @param workflows - Array of workflows to register
      * @returns Array of registered workflow promises
      */
-    registerWorkflows(workflows?: Array<Workflow<any, any> | V0Workflow>): Promise<void>[] | undefined;
+    registerWorkflows(workflows?: Array<WorkflowDeclaration<any, any> | V0Workflow>): Promise<void[]>;
     /**
      * Registers a single workflow with the worker
      * @param workflow - The workflow to register
      * @returns A promise that resolves when the workflow is registered
      * @deprecated use registerWorkflows instead
      */
-    registerWorkflow(workflow: Workflow<any, any> | V0Workflow): Promise<void>[] | undefined;
+    registerWorkflow(workflow: WorkflowDeclaration<any, any> | V0Workflow): Promise<void[]>;
     /**
      * Starts the worker
      * @returns Promise that resolves when the worker is stopped or killed
@@ -79,4 +79,4 @@ export declare class Worker {
      */
     registerWebhook(webhook: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../../clients/rest/generated/data-contracts").WebhookWorkerCreated, any>>;
 }
-export declare function toV0Workflow(wf: Workflow<any, any> | V0Workflow): V0Workflow;
+export declare function toV0Workflow(wf: WorkflowDeclaration<any, any> | V0Workflow): V0Workflow;

package/v1/client/worker.js

@@ -43,8 +43,10 @@ class Worker {
      * @returns Array of registered workflow promises
      */
     registerWorkflows(workflows) {
-        return workflows === null || workflows === void 0 ? void 0 : workflows.map((wf) => {
-            return this.v0.registerWorkflow(toV0Workflow(wf));
+        return __awaiter(this, void 0, void 0, function* () {
+            return Promise.all((workflows === null || workflows === void 0 ? void 0 : workflows.map((wf) => {
+                return this.v0.registerWorkflow(toV0Workflow(wf));
+            })) || []);
         });
     }
     /**
@@ -96,7 +98,7 @@ class Worker {
 }
 exports.Worker = Worker;
 function toV0Workflow(wf) {
-    if (wf instanceof workflow_1.Workflow) {
+    if (wf instanceof workflow_1.WorkflowDeclaration) {
         const { definition } = wf;
         return {
             id: definition.name,
@@ -106,6 +108,10 @@ function toV0Workflow(wf) {
             scheduleTimeout: definition.scheduleTimeout,
             on: definition.on,
             concurrency: definition.concurrency,
+            onFailure: definition.onFailure && {
+                name: 'on-failure',
+                run: (ctx) => definition.onFailure(ctx),
+            },
             steps: definition.tasks.map((task) => {
                 var _a;
                 return ({

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

@@ -6,7 +6,7 @@ type ChildOutput = {
         Value: number;
     };
 };
-export declare const child: import("../../workflow").Workflow<ChildInput, ChildOutput>;
+export declare const child: import("../../workflow").WorkflowDeclaration<ChildInput, ChildOutput>;
 type ParentInput = {
     N: number;
 };
@@ -15,5 +15,5 @@ type ParentOutput = {
         Result: number;
     };
 };
-export declare const parent: import("../../workflow").Workflow<ParentInput, ParentOutput>;
+export declare const parent: import("../../workflow").WorkflowDeclaration<ParentInput, ParentOutput>;
 export {};

package/v1/examples/concurrency-rr/workflow.d.ts

@@ -7,5 +7,5 @@ type SimpleOutput = {
         TransformedMessage: string;
     };
 };
-export declare const simpleConcurrency: import("../../workflow").Workflow<SimpleInput, SimpleOutput>;
+export declare const simpleConcurrency: import("../../workflow").WorkflowDeclaration<SimpleInput, SimpleOutput>;
 export {};

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

@@ -7,5 +7,5 @@ type DagOutput = {
         Transformed: string;
     };
 };
-export declare const dag: import("../../workflow").Workflow<DagInput, DagOutput>;
+export declare const dag: import("../../workflow").WorkflowDeclaration<DagInput, DagOutput>;
 export {};

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

@@ -7,12 +7,12 @@ type Output = {
         Sum: number;
     };
 };
-export declare const child1: import("../../workflow").Workflow<SimpleInput, Output>;
-export declare const child2: import("../../workflow").Workflow<SimpleInput, Output>;
-export declare const child3: import("../../workflow").Workflow<SimpleInput, Output>;
-export declare const child4: import("../../workflow").Workflow<SimpleInput, Output>;
-export declare const child5: import("../../workflow").Workflow<SimpleInput, Output>;
-export declare const parent: import("../../workflow").Workflow<SimpleInput, {
+export declare const child1: import("../../workflow").WorkflowDeclaration<SimpleInput, Output>;
+export declare const child2: import("../../workflow").WorkflowDeclaration<SimpleInput, Output>;
+export declare const child3: import("../../workflow").WorkflowDeclaration<SimpleInput, Output>;
+export declare const child4: import("../../workflow").WorkflowDeclaration<SimpleInput, Output>;
+export declare const child5: import("../../workflow").WorkflowDeclaration<SimpleInput, Output>;
+export declare const parent: import("../../workflow").WorkflowDeclaration<SimpleInput, {
     parent: Output["transformer"];
 }>;
 export {};

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

@@ -7,11 +7,11 @@ type LowerOutput = {
         TransformedMessage: string;
     };
 };
-export declare const lower: import("../../workflow").Workflow<Input, LowerOutput>;
+export declare const lower: import("../../workflow").WorkflowDeclaration<Input, LowerOutput>;
 type UpperOutput = {
     upper: {
         TransformedMessage: string;
     };
 };
-export declare const upper: import("../../workflow").Workflow<Input, UpperOutput>;
+export declare const upper: import("../../workflow").WorkflowDeclaration<Input, UpperOutput>;
 export {};

package/v1/examples/on_failure/run.d.ts

@@ -0,0 +1 @@
+export {};

package/v1/examples/on_failure/run.js

@@ -0,0 +1,29 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+const workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const res = yield workflow_1.alwaysFail.run({});
+            console.log(res);
+        }
+        catch (e) {
+            console.log('error', e);
+        }
+    });
+}
+if (require.main === module) {
+    main()
+        .catch(console.error)
+        .finally(() => process.exit(0));
+}

package/v1/examples/on_failure/worker.d.ts

@@ -0,0 +1 @@
+export {};

package/v1/examples/on_failure/worker.js

@@ -0,0 +1,24 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_1 = require("../client");
+const workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield client_1.hatchet.worker('always-fail-worker', {
+            workflows: [workflow_1.alwaysFail],
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}

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

@@ -0,0 +1 @@
+export declare const alwaysFail: import("../../workflow").WorkflowDeclaration<any, any>;

package/v1/examples/on_failure/workflow.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.alwaysFail = void 0;
+/* eslint-disable no-console */
+const client_1 = require("../client");
+exports.alwaysFail = client_1.hatchet.workflow({
+    name: 'always-fail',
+    onFailure: (ctx) => {
+        console.log('onFailure for run:', ctx.workflowRunId());
+        return {
+            'on-failure': 'success',
+        };
+    },
+});
+exports.alwaysFail.task({
+    name: 'always-fail',
+    fn: () => {
+        throw new Error('intentional failure');
+    },
+});

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

@@ -1,5 +1,5 @@
 type SimpleInput = {
     Message: string;
 };
-export declare const simple: import("../../workflow").Workflow<SimpleInput, any>;
+export declare const simple: import("../../workflow").WorkflowDeclaration<SimpleInput, any>;
 export {};

package/v1/workflow.d.ts

@@ -1,5 +1,5 @@
 import WorkflowRunRef from '../util/workflow-run-ref';
-import { Context } from '../step';
+import { Context, JsonObject } from '../step';
 import { CronWorkflows, ScheduledWorkflows } from '../clients/rest/generated/data-contracts';
 import { Workflow as WorkflowV0 } from '../workflow';
 import { IHatchetClient } from './client/client.interface';
@@ -30,26 +30,32 @@ export type CreateWorkflowOpts = {
      */
     name: WorkflowV0['id'];
     /**
-     * Optional description of the workflow.
+     * (optional) description of the workflow.
      */
     description?: WorkflowV0['description'];
     /**
-     * Optional version of the workflow.
+     * (optional) version of the workflow.
      */
     version?: WorkflowV0['version'];
     /**
-     * Optional sticky strategy for the workflow.
+     * (optional) sticky strategy for the workflow.
      */
     sticky?: WorkflowV0['sticky'];
     /**
-     * Optional schedule timeout for the workflow.
+     * (optional) schedule timeout for the workflow.
      */
     scheduleTimeout?: WorkflowV0['scheduleTimeout'];
     /**
-     * Optional on config for the workflow.
+     * (optional) on config for the workflow.
      */
     on?: WorkflowV0['on'];
     concurrency?: WorkflowV0['concurrency'];
+    /**
+     * (optional) onFailure handler for the workflow.
+     * Invoked when any task in the workflow fails.
+     * @param ctx The context of the workflow.
+     */
+    onFailure?: (ctx: Context<any>) => void;
 };
 /**
  * Internal definition of a workflow and its tasks.
@@ -65,7 +71,7 @@ type WorkflowDefinition = CreateWorkflowOpts & {
  * @template T The input type for the workflow.
  * @template K The return type of the workflow.
  */
-export declare class Workflow<T extends Record<string, any>, K> {
+export declare class WorkflowDeclaration<T extends JsonObject, K extends JsonObject> {
     /**
      * The Hatchet client instance used to execute the workflow.
      */
@@ -148,5 +154,5 @@ export declare class Workflow<T extends Record<string, any>, K> {
  * @param client Optional Hatchet client instance.
  * @returns A new Workflow instance.
  */
-export declare function CreateWorkflow<T extends Record<string, any> = any, K = any>(options: CreateWorkflowOpts, client?: IHatchetClient): Workflow<T, K>;
+export declare function CreateWorkflow<T extends JsonObject = any, K extends JsonObject = any>(options: CreateWorkflowOpts, client?: IHatchetClient): WorkflowDeclaration<T, K>;
 export {};

package/v1/workflow.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Workflow = void 0;
+exports.WorkflowDeclaration = void 0;
 exports.CreateWorkflow = CreateWorkflow;
 const UNBOUND_ERR = new Error('workflow unbound to hatchet client, hint: use client.run instead');
 /**
@@ -17,7 +17,7 @@ const UNBOUND_ERR = new Error('workflow unbound to hatchet client, hint: use cli
  * @template T The input type for the workflow.
  * @template K The return type of the workflow.
  */
-class Workflow {
+class WorkflowDeclaration {
     /**
      * Creates a new workflow instance.
      * @param options The options for creating the workflow.
@@ -131,7 +131,7 @@ class Workflow {
         return this.definition.name;
     }
 }
-exports.Workflow = Workflow;
+exports.WorkflowDeclaration = WorkflowDeclaration;
 /**
  * Creates a new workflow instance.
  * @template T The input type for the workflow.
@@ -141,5 +141,5 @@ exports.Workflow = Workflow;
  * @returns A new Workflow instance.
  */
 function CreateWorkflow(options, client) {
-    return new Workflow(options, client);
+    return new WorkflowDeclaration(options, client);
 }

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.0.0-alpha0";
+export declare const HATCHET_VERSION = "1.0.0-alpha1";

package/version.js

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