@hatchet-dev/typescript-sdk 1.0.1 → 1.0.2

package/package.json

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

package/v1/client/features/runs.d.ts

@@ -1,7 +1,7 @@
 import WorkflowRunRef from '../../../util/workflow-run-ref';
 import { V1TaskStatus } from '../../../clients/rest/generated/data-contracts';
-import { HatchetClient } from '../client';
 import { WorkflowsClient } from './workflows';
+import { HatchetClient } from '../client';
 export type RunFilter = {
     since: Date;
     until?: Date;

package/v1/client/features/runs.js

@@ -19,7 +19,6 @@ class RunsClient {
         this.tenantId = client.tenantId;
         this.workflows = client.workflows;
     }
-    // TODO expose streaming methods?
     get(run) {
         return __awaiter(this, void 0, void 0, function* () {
             const runId = typeof run === 'string' ? run : yield run.getWorkflowRunId();

package/v1/declaration.d.ts

@@ -54,18 +54,6 @@ export type CreateBaseWorkflowOpts = {
      */
     onEvents?: string[];
     concurrency?: TaskConcurrency;
-    /**
-     * (optional) onFailure handler for the workflow.
-     * Invoked when any task in the workflow fails.
-     * @param ctx The context of the workflow.
-     */
-    onFailure?: TaskFn<any, any> | CreateOnFailureTaskOpts<any, any>;
-    /**
-     * (optional) onSuccess handler for the workflow.
-     * Invoked when all tasks in the workflow complete successfully.
-     * @param ctx The context of the workflow.
-     */
-    onSuccess?: TaskFn<any, any> | CreateOnSuccessTaskOpts<any, any>;
 };
 export type CreateTaskWorkflowOpts<T extends JsonObject = any, K extends JsonObject = any> = CreateBaseWorkflowOpts & CreateBaseTaskOpts<T, K, TaskFn<T, K>>;
 /**
@@ -138,6 +126,18 @@ export type WorkflowDefinition = CreateWorkflowOpts & {
      * The durable tasks that make up this workflow.
      */
     _durableTasks: CreateWorkflowDurableTaskOpts<any, any>[];
+    /**
+     * (optional) onFailure handler for the workflow.
+     * Invoked when any task in the workflow fails.
+     * @param ctx The context of the workflow.
+     */
+    onFailure?: TaskFn<any, any> | CreateOnFailureTaskOpts<any, any>;
+    /**
+     * (optional) onSuccess handler for the workflow.
+     * Invoked when all tasks in the workflow complete successfully.
+     * @param ctx The context of the workflow.
+     */
+    onSuccess?: TaskFn<any, any> | CreateOnSuccessTaskOpts<any, any>;
 };
 /**
  * Represents a workflow that can be executed by Hatchet.
@@ -256,6 +256,28 @@ export declare class WorkflowDeclaration<T extends JsonObject, K extends JsonObj
         name: Name;
         fn: (input: T, ctx: Context<T>) => TaskOutputType<K, Name, L> | Promise<TaskOutputType<K, Name, L>>;
     }) | TaskWorkflowDeclaration<any, any>): CreateWorkflowTaskOpts<T, TaskOutputType<K, Name, L>>;
+    /**
+     * Adds an onFailure task to the workflow.
+     * This will only run if any task in the workflow fails.
+     * @template Name The literal string name of the task.
+     * @template L The inferred return type of the task function.
+     * @param options The task configuration options.
+     * @returns The task options that were added.
+     */
+    onFailure<Name extends string, L>(options: (Omit<CreateOnFailureTaskOpts<T, TaskOutputType<K, Name, L>>, 'fn'> & {
+        fn: (input: T, ctx: Context<T>) => TaskOutputType<K, Name, L> | Promise<TaskOutputType<K, Name, L>>;
+    }) | TaskWorkflowDeclaration<any, any>): CreateWorkflowTaskOpts<T, TaskOutputType<K, Name, L>>;
+    /**
+     * Adds an onSuccess task to the workflow.
+     * This will only run if all tasks in the workflow complete successfully.
+     * @template Name The literal string name of the task.
+     * @template L The inferred return type of the task function.
+     * @param options The task configuration options.
+     * @returns The task options that were added.
+     */
+    onSuccess<Name extends string, L>(options: (Omit<CreateOnSuccessTaskOpts<T, TaskOutputType<K, Name, L>>, 'fn'> & {
+        fn: (input: T, ctx: Context<T>) => TaskOutputType<K, Name, L> | Promise<TaskOutputType<K, Name, L>>;
+    }) | TaskWorkflowDeclaration<any, any>): CreateWorkflowTaskOpts<T, TaskOutputType<K, Name, L>>;
     /**
      * Adds a durable task to the workflow.
      * The return type will be either the property on K that corresponds to the task name,

package/v1/declaration.js

@@ -215,6 +215,52 @@ class WorkflowDeclaration extends BaseWorkflowDeclaration {
         this.definition._tasks.push(typedOptions);
         return typedOptions;
     }
+    /**
+     * Adds an onFailure task to the workflow.
+     * This will only run if any task in the workflow fails.
+     * @template Name The literal string name of the task.
+     * @template L The inferred return type of the task function.
+     * @param options The task configuration options.
+     * @returns The task options that were added.
+     */
+    onFailure(options) {
+        var _a;
+        let typedOptions;
+        if (options instanceof TaskWorkflowDeclaration) {
+            typedOptions = options.taskDef;
+        }
+        else {
+            typedOptions = options;
+        }
+        if (this.definition.onFailure) {
+            (_a = this.client) === null || _a === void 0 ? void 0 : _a._v0.logger.warn(`onFailure task will override existing onFailure task`);
+        }
+        this.definition.onFailure = typedOptions;
+        return typedOptions;
+    }
+    /**
+     * Adds an onSuccess task to the workflow.
+     * This will only run if all tasks in the workflow complete successfully.
+     * @template Name The literal string name of the task.
+     * @template L The inferred return type of the task function.
+     * @param options The task configuration options.
+     * @returns The task options that were added.
+     */
+    onSuccess(options) {
+        var _a;
+        let typedOptions;
+        if (options instanceof TaskWorkflowDeclaration) {
+            typedOptions = options.taskDef;
+        }
+        else {
+            typedOptions = options;
+        }
+        if (this.definition.onSuccess) {
+            (_a = this.client) === null || _a === void 0 ? void 0 : _a._v0.logger.warn(`onSuccess task will override existing onSuccess task`);
+        }
+        this.definition.onSuccess = typedOptions;
+        return typedOptions;
+    }
     /**
      * Adds a durable task to the workflow.
      * The return type will be either the property on K that corresponds to the task name,

package/v1/examples/concurrency-rr/workflow.js

@@ -15,6 +15,7 @@ const hatchet_client_1 = require("../hatchet-client");
 const sleep = (ms) => new Promise((resolve) => {
     setTimeout(resolve, ms);
 });
+// ❓ Workflow
 exports.simpleConcurrency = hatchet_client_1.hatchet.workflow({
     name: 'simple-concurrency',
     concurrency: {
@@ -23,6 +24,7 @@ exports.simpleConcurrency = hatchet_client_1.hatchet.workflow({
         expression: 'input.GroupKey',
     },
 });
+// !!
 exports.simpleConcurrency.task({
     name: 'to-lower',
     fn: (input) => __awaiter(void 0, void 0, void 0, function* () {

package/v1/examples/on_failure/run.js

@@ -14,7 +14,7 @@ const workflow_1 = require("./workflow");
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const res = yield workflow_1.alwaysFail.run({});
+            const res = yield workflow_1.failureWorkflow.run({});
             console.log(res);
         }
         catch (e) {

package/v1/examples/on_failure/worker.js

@@ -14,7 +14,7 @@ const workflow_1 = require("./workflow");
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         const worker = yield hatchet_client_1.hatchet.worker('always-fail-worker', {
-            workflows: [workflow_1.alwaysFail],
+            workflows: [workflow_1.failureWorkflow],
         });
         yield worker.start();
     });

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

@@ -1 +1 @@
-export declare const alwaysFail: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, never>;
+export declare const failureWorkflow: import("../..").WorkflowDeclaration<any, any>;

package/v1/examples/on_failure/workflow.js

@@ -9,22 +9,26 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.alwaysFail = void 0;
+exports.failureWorkflow = void 0;
 /* eslint-disable no-console */
 const hatchet_client_1 = require("../hatchet-client");
 // ❓ On Failure Task
-exports.alwaysFail = hatchet_client_1.hatchet.task({
+exports.failureWorkflow = hatchet_client_1.hatchet.workflow({
     name: 'always-fail',
-    // the onFailure function is called when the task fails
-    // note: not guaranteed to be called on the same worker
-    onFailure: (input, ctx) => {
+});
+exports.failureWorkflow.task({
+    name: 'always-fail',
+    fn: () => __awaiter(void 0, void 0, void 0, function* () {
+        throw new Error('intentional failure');
+    }),
+});
+exports.failureWorkflow.onFailure({
+    name: 'on-failure',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         console.log('onFailure for run:', ctx.workflowRunId());
         return {
             'on-failure': 'success',
         };
-    },
-    fn: () => __awaiter(void 0, void 0, void 0, function* () {
-        throw new Error('intentional failure');
     }),
 });
 // !!

package/v1/examples/on_success/run.js

@@ -14,8 +14,6 @@ const workflow_1 = require("./workflow");
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const res = yield workflow_1.onSuccess.run({});
-            console.log(res);
             const res2 = yield workflow_1.onSuccessDag.run({});
             console.log(res2);
         }

package/v1/examples/on_success/worker.js

@@ -14,7 +14,7 @@ const workflow_1 = require("./workflow");
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         const worker = yield hatchet_client_1.hatchet.worker('always-succeed-worker', {
-            workflows: [workflow_1.onSuccessDag, workflow_1.onSuccess],
+            workflows: [workflow_1.onSuccessDag],
         });
         yield worker.start();
     });

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

@@ -1,4 +1 @@
-export declare const onSuccess: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, {
-    'always-succeed': string;
-}>;
 export declare const onSuccessDag: import("../..").WorkflowDeclaration<any, any>;

package/v1/examples/on_success/workflow.js

@@ -9,36 +9,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.onSuccessDag = exports.onSuccess = void 0;
+exports.onSuccessDag = void 0;
 /* eslint-disable no-console */
 const hatchet_client_1 = require("../hatchet-client");
-// ❓ On Success Task
-exports.onSuccess = hatchet_client_1.hatchet.task({
-    name: 'run-on-success',
-    // 👀 onSuccess handler will run if the fn task succeeds
-    onSuccess: (_, ctx) => {
-        console.log('onSuccess for run:', ctx.workflowRunId());
-        return {
-            'on-success': 'success',
-        };
-    },
-    fn: () => __awaiter(void 0, void 0, void 0, function* () {
-        return {
-            'always-succeed': 'success',
-        };
-    }),
-});
-// !!
 // ❓ On Success DAG
 exports.onSuccessDag = hatchet_client_1.hatchet.workflow({
     name: 'on-success-dag',
-    // 👀 onSuccess handler will run if all tasks in the workflow succeed
-    onSuccess: (_, ctx) => {
-        console.log('onSuccess for run:', ctx.workflowRunId());
-        return {
-            'on-success': 'success',
-        };
-    },
 });
 exports.onSuccessDag.task({
     name: 'always-succeed',
@@ -56,4 +32,13 @@ exports.onSuccessDag.task({
         };
     }),
 });
+// 👀 onSuccess handler will run if all tasks in the workflow succeed
+exports.onSuccessDag.onSuccess({
+    fn: (_, ctx) => {
+        console.log('onSuccess for run:', ctx.workflowRunId());
+        return {
+            'on-success': 'success',
+        };
+    },
+});
 // !!

package/v1/examples/simple/client-run.js

@@ -4,11 +4,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const hatchet_client_1 = require("../hatchet-client");
 hatchet_client_1.hatchet.run('simple', { Message: 'Hello, World!' });
 hatchet_client_1.hatchet.runNoWait('simple', { Message: 'Hello, World!' }, {});
-hatchet_client_1.hatchet.schedule.create('simple', {
+hatchet_client_1.hatchet.schedules.create('simple', {
     triggerAt: new Date(Date.now() + 1000 * 60 * 60 * 24),
     input: { Message: 'Hello, World!' },
 });
-hatchet_client_1.hatchet.cron.create('simple', {
+hatchet_client_1.hatchet.crons.create('simple', {
     name: 'my-cron',
     expression: '0 0 * * *',
     input: { Message: 'Hello, World!' },

package/v1/task.d.ts

@@ -172,10 +172,10 @@ export type CreateStandaloneDurableTaskOpts<T, K> = CreateBaseTaskOpts<T, K, Dur
  * @template T The input type for the task function.
  * @template K The return type of the task function (can be inferred from the return value of fn).
  */
-export type CreateOnSuccessTaskOpts<T, K> = CreateBaseTaskOpts<T, K, TaskFn<T, K>>;
+export type CreateOnSuccessTaskOpts<T, K> = Omit<CreateBaseTaskOpts<T, K, TaskFn<T, K>>, 'name'>;
 /**
  * Options for configuring the onFailure task that is invoked when a task fails.
  * @template T The input type for the task function.
  * @template K The return type of the task function (can be inferred from the return value of fn).
  */
-export type CreateOnFailureTaskOpts<T, K> = CreateBaseTaskOpts<T, K, TaskFn<T, K>>;
+export type CreateOnFailureTaskOpts<T, K> = Omit<CreateBaseTaskOpts<T, K, TaskFn<T, K>>, 'name'>;

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.0.1";
+export declare const HATCHET_VERSION = "1.0.2";

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.1';
+exports.HATCHET_VERSION = '1.0.2';