@hatchet-dev/typescript-sdk 1.0.2 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "1.0.2",
+  "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/declaration.d.ts

@@ -55,7 +55,7 @@ export type CreateBaseWorkflowOpts = {
     onEvents?: string[];
     concurrency?: TaskConcurrency;
 };
-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.
  */
@@ -144,7 +144,7 @@ export type WorkflowDefinition = CreateWorkflowOpts & {
  * @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,
@@ -292,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>;
@@ -306,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>;
 /**
@@ -317,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,
             });
@@ -288,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,11 +15,11 @@ const hatchet_client_1 = require("../hatchet-client");
 const sleep = (ms) => new Promise((resolve) => {
     setTimeout(resolve, ms);
 });
-// ❓ Workflow
+// ❓ 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',
     },

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

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

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

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

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

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.0.2";
+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.2';
+exports.HATCHET_VERSION = '1.0.3';