@hatchet-dev/typescript-sdk 1.0.1 → 1.0.3

package/package.json

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

package/v1/client/client.d.ts

@@ -51,7 +51,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 JsonObject = any, K extends JsonObject = any>(options: CreateWorkflowOpts): WorkflowDeclaration<T, K>;
+    workflow<T extends JsonObject | unknown = unknown, K extends JsonObject | unknown = unknown>(options: CreateWorkflowOpts): WorkflowDeclaration<T, K>;
     /**
      * Creates a new task workflow.
      * Types can be explicitly specified as generics or inferred from the function signature.
@@ -60,14 +60,14 @@ export declare class HatchetClient implements IHatchetClient {
      * @param options Task configuration options
      * @returns A TaskWorkflowDeclaration instance
      */
-    task<T extends JsonObject, K extends JsonObject>(options: CreateTaskWorkflowOpts<T, K>): TaskWorkflowDeclaration<T, K>;
+    task<T extends JsonObject | unknown, K extends JsonObject | unknown>(options: CreateTaskWorkflowOpts<T, K>): TaskWorkflowDeclaration<T, K>;
     /**
      * Creates a new task workflow with types inferred from the function parameter.
      * @template Fn The type of the task function with input and output extending JsonObject
      * @param options Task configuration options with function that defines types
      * @returns A TaskWorkflowDeclaration instance with inferred types
      */
-    task<Fn extends (input: I, ctx?: any) => O | Promise<O>, I extends JsonObject = Parameters<Fn>[0], O extends JsonObject = ReturnType<Fn> extends Promise<infer P> ? P extends JsonObject ? P : never : ReturnType<Fn> extends JsonObject ? ReturnType<Fn> : never>(options: {
+    task<Fn extends (input: I, ctx?: any) => O | Promise<O>, I extends JsonObject | unknown = Parameters<Fn>[0], O extends JsonObject | unknown = ReturnType<Fn> extends Promise<infer P> ? P extends JsonObject ? P : never : ReturnType<Fn> extends JsonObject ? ReturnType<Fn> : never>(options: {
         fn: Fn;
     } & Omit<CreateTaskWorkflowOpts<I, O>, 'fn'>): TaskWorkflowDeclaration<I, O>;
     /**

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,20 +54,8 @@ 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>>;
+export type CreateTaskWorkflowOpts<T extends JsonObject | unknown = unknown, K extends JsonObject | unknown = unknown> = CreateBaseWorkflowOpts & CreateBaseTaskOpts<T, K, TaskFn<T, K>>;
 /**
  * Options for creating a new workflow.
  */
@@ -138,13 +126,25 @@ 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.
  * @template T The input type for the workflow.
  * @template K The return type of the workflow.
  */
-export declare class BaseWorkflowDeclaration<T extends JsonObject, K extends JsonObject> {
+export declare class BaseWorkflowDeclaration<T extends JsonObject | unknown, K extends JsonObject | unknown> {
     /**
      * The Hatchet client instance used to execute the workflow.
      */
@@ -242,7 +242,7 @@ export declare class BaseWorkflowDeclaration<T extends JsonObject, K extends Jso
      */
     get name(): string;
 }
-export declare class WorkflowDeclaration<T extends JsonObject, K extends JsonObject> extends BaseWorkflowDeclaration<T, K> {
+export declare class WorkflowDeclaration<T extends JsonObject | unknown = unknown, K extends JsonObject | unknown = unknown> extends BaseWorkflowDeclaration<T, K> {
     /**
      * Adds a task to the workflow.
      * The return type will be either the property on K that corresponds to the task name,
@@ -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,
@@ -270,7 +292,7 @@ export declare class WorkflowDeclaration<T extends JsonObject, K extends JsonObj
         fn: (input: T, ctx: DurableContext<T>) => TaskOutputType<K, Name, L> | Promise<TaskOutputType<K, Name, L>>;
     }): CreateWorkflowDurableTaskOpts<T, TaskOutputType<K, Name, L>>;
 }
-export declare class TaskWorkflowDeclaration<T extends JsonObject, K extends JsonObject> extends BaseWorkflowDeclaration<T, K> {
+export declare class TaskWorkflowDeclaration<T extends JsonObject | unknown = unknown, K extends JsonObject | unknown = unknown> extends BaseWorkflowDeclaration<T, K> {
     private _standalone_task_name;
     constructor(options: CreateTaskWorkflowOpts<T, K>, client?: IHatchetClient);
     run(input: T, options?: RunOpts): Promise<K>;
@@ -284,7 +306,7 @@ export declare class TaskWorkflowDeclaration<T extends JsonObject, K extends Jso
  * @param client Optional Hatchet client instance.
  * @returns A new TaskWorkflowDeclaration with inferred types.
  */
-export declare function CreateTaskWorkflow<Fn extends (input: I, ctx?: any) => O | Promise<O>, I extends JsonObject = Parameters<Fn>[0], O extends JsonObject = ReturnType<Fn> extends Promise<infer P> ? P extends JsonObject ? P : never : ReturnType<Fn> extends JsonObject ? ReturnType<Fn> : never>(options: {
+export declare function CreateTaskWorkflow<Fn extends (input: I, ctx?: any) => O | Promise<O>, I extends JsonObject | unknown = Parameters<Fn>[0], O extends JsonObject | unknown = ReturnType<Fn> extends Promise<infer P> ? P extends JsonObject ? P : never : ReturnType<Fn> extends JsonObject ? ReturnType<Fn> : never>(options: {
     fn: Fn;
 } & Omit<CreateTaskWorkflowOpts<I, O>, 'fn'>, client?: IHatchetClient): TaskWorkflowDeclaration<I, O>;
 /**
@@ -295,7 +317,7 @@ export declare function CreateTaskWorkflow<Fn extends (input: I, ctx?: any) => O
  * @param client Optional Hatchet client instance.
  * @returns A new Workflow instance.
  */
-export declare function CreateWorkflow<T extends JsonObject = any, K extends JsonObject = any>(options: CreateWorkflowOpts, client?: IHatchetClient): WorkflowDeclaration<T, K>;
+export declare function CreateWorkflow<T extends JsonObject | unknown = unknown, K extends JsonObject | unknown = unknown>(options: CreateWorkflowOpts, client?: IHatchetClient): WorkflowDeclaration<T, K>;
 /**
  * Creates a new durable task workflow declaration with types inferred from the function parameter.
  * @template Fn The type of the durable task function

package/v1/declaration.js

@@ -81,7 +81,7 @@ class BaseWorkflowDeclaration {
             }
             const scheduled = this.client._v0.schedule.create(this.definition.name, {
                 triggerAt: enqueueAt,
-                input,
+                input: input,
                 additionalMetadata: options === null || options === void 0 ? void 0 : options.additionalMetadata,
             });
             return scheduled;
@@ -118,7 +118,7 @@ class BaseWorkflowDeclaration {
             }
             const cronDef = this.client._v0.cron.create(this.definition.name, {
                 expression,
-                input,
+                input: input,
                 additionalMetadata: options === null || options === void 0 ? void 0 : options.additionalMetadata,
                 name,
             });
@@ -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,
@@ -242,7 +288,7 @@ class TaskWorkflowDeclaration extends BaseWorkflowDeclaration {
             run: { get: () => super.run }
         });
         return __awaiter(this, void 0, void 0, function* () {
-            const res = yield _super.run.call(this, input, options);
+            const res = (yield _super.run.call(this, input, options));
             if (Array.isArray(res)) {
                 return res.map((r) => r[this._standalone_task_name]);
             }

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

@@ -1,3 +1,3 @@
-export declare const cancellation: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, {
-    Completed: true;
+export declare const cancellation: import("../..").TaskWorkflowDeclaration<unknown, {
+    Completed: boolean;
 }>;

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

@@ -15,14 +15,16 @@ const hatchet_client_1 = require("../hatchet-client");
 const sleep = (ms) => new Promise((resolve) => {
     setTimeout(resolve, ms);
 });
+// ❓ Concurrency Strategy With Key
 exports.simpleConcurrency = hatchet_client_1.hatchet.workflow({
     name: 'simple-concurrency',
     concurrency: {
-        maxRuns: 100,
+        maxRuns: 1,
         limitStrategy: workflow_1.ConcurrencyLimitStrategy.GROUP_ROUND_ROBIN,
         expression: 'input.GroupKey',
     },
 });
+// !!
 exports.simpleConcurrency.task({
     name: 'to-lower',
     fn: (input) => __awaiter(void 0, void 0, void 0, function* () {

package/v1/examples/durable-sleep/workflow.d.ts

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

package/v1/examples/durable-sleep/workflow.js

@@ -23,7 +23,7 @@ exports.durableSleep.durableTask({
         console.log('sleeping for 5s');
         const sleepRes = yield ctx.sleepFor('5s');
         console.log('done sleeping for 5s', sleepRes);
-        // wait for an event or a sleep
+        // wait for either an event or a sleep
         const res = yield ctx.waitFor((0, conditions_1.Or)({
             eventKey: 'user:event',
         }, {

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<unknown, unknown>;

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>;
+export declare const onSuccessDag: import("../..").WorkflowDeclaration<unknown, unknown>;

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/rate_limit/run.d.ts

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

package/v1/examples/rate_limit/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.rateLimitWorkflow.run({ userId: 'abc' });
+            console.log(res);
+        }
+        catch (e) {
+            console.log('error', e);
+        }
+    });
+}
+if (require.main === module) {
+    main()
+        .catch(console.error)
+        .finally(() => process.exit(0));
+}

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

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

package/v1/examples/rate_limit/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 hatchet_client_1 = require("../hatchet-client");
+const workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet_client_1.hatchet.worker('rate-limit-worker', {
+            workflows: [workflow_1.rateLimitWorkflow],
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}

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

@@ -0,0 +1,5 @@
+type RateLimitInput = {
+    userId: string;
+};
+export declare const rateLimitWorkflow: import("../..").WorkflowDeclaration<RateLimitInput, unknown>;
+export {};

package/v1/examples/rate_limit/workflow.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rateLimitWorkflow = void 0;
+const workflows_1 = require("../../../protoc/v1/workflows");
+const hatchet_client_1 = require("../hatchet-client");
+exports.rateLimitWorkflow = hatchet_client_1.hatchet.workflow({
+    name: 'RateLimitWorkflow',
+});
+// !!
+// ❓ Static
+const RATE_LIMIT_KEY = 'test-limit';
+const task1 = exports.rateLimitWorkflow.task({
+    name: 'task1',
+    fn: (input) => {
+        console.log('executed task1');
+    },
+    rateLimits: [
+        {
+            staticKey: RATE_LIMIT_KEY,
+            units: 1,
+        },
+    ],
+});
+// !!
+// ❓ Dynamic
+const task2 = exports.rateLimitWorkflow.task({
+    name: 'task2',
+    fn: (input) => {
+        console.log('executed task2 for user: ', input.userId);
+    },
+    rateLimits: [
+        {
+            dynamicKey: 'input.userId',
+            units: 1,
+            limit: 10,
+            duration: workflows_1.RateLimitDuration.MINUTE,
+        },
+    ],
+});
+// !!

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

@@ -1,5 +1,5 @@
-export declare const retries: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, never>;
-export declare const retriesWithCount: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, {
+export declare const retries: import("../..").TaskWorkflowDeclaration<unknown, never>;
+export declare const retriesWithCount: import("../..").TaskWorkflowDeclaration<unknown, {
     message: string;
 }>;
-export declare const withBackoff: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, never>;
+export declare const withBackoff: import("../..").TaskWorkflowDeclaration<unknown, never>;

package/v1/examples/retries/workflow.js

@@ -21,7 +21,7 @@ exports.retries = hatchet_client_1.hatchet.task({
     }),
 });
 // !!
-// ❓ Step Retries with Count
+// ❓ Retries with Count
 exports.retriesWithCount = hatchet_client_1.hatchet.task({
     name: 'retriesWithCount',
     retries: 3,
@@ -38,13 +38,16 @@ exports.retriesWithCount = hatchet_client_1.hatchet.task({
     }),
 });
 // !!
-// ❓ Step Retries with Backoff
+// ❓ Retries with Backoff
 exports.withBackoff = hatchet_client_1.hatchet.task({
     name: 'withBackoff',
-    retries: 3,
+    retries: 10,
     backoff: {
-        factor: 2,
+        // 👀 Maximum number of seconds to wait between retries
         maxSeconds: 10,
+        // 👀 Factor to increase the wait time between retries.
+        // This sequence will be 2s, 4s, 8s, 10s, 10s, 10s... due to the maxSeconds limit
+        factor: 2,
     },
     fn: () => __awaiter(void 0, void 0, void 0, function* () {
         throw new Error('intentional failure');

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/examples/simple/run.js

@@ -10,16 +10,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable no-console */
-// ❓ Running a Task with Results
 const workflow_1 = require("./workflow");
-// ...
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
-        // 👀 Run the workflow with results
+        // ❓ Running a Task
         const res = yield workflow_1.simple.run({
             Message: 'HeLlO WoRlD',
         });
-        // 👀 Access the results of the workflow
+        // 👀 Access the results of the Task
         console.log(res.TransformedMessage);
         // !!
     });

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

@@ -1,4 +1,4 @@
-export declare const sticky: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, {
+export declare const sticky: import("../..").TaskWorkflowDeclaration<unknown, {
     result: {
         Value: number;
     };

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

@@ -1,3 +1,3 @@
-export declare const cancellation: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, {
-    Completed: true;
+export declare const cancellation: import("../..").TaskWorkflowDeclaration<unknown, {
+    Completed: boolean;
 }>;

package/v1/index.d.ts

@@ -3,3 +3,4 @@ export * from './client/features';
 export * from './client/worker';
 export * from './declaration';
 export * from './conditions';
+export * from './client/duration';

package/v1/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./client/features"), exports);
 __exportStar(require("./client/worker"), exports);
 __exportStar(require("./declaration"), exports);
 __exportStar(require("./conditions"), exports);
+__exportStar(require("./client/duration"), exports);

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.3";

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.3';