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

package/v1/examples/deep/workflow.js

@@ -0,0 +1,110 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parent = exports.child5 = exports.child4 = exports.child3 = exports.child2 = exports.child1 = void 0;
+const sleep_1 = __importDefault(require("../../../util/sleep"));
+const client_1 = require("../client");
+exports.child1 = client_1.hatchet.workflow({
+    name: 'child1',
+});
+exports.child1.task({
+    name: 'transformer',
+    fn: () => {
+        (0, sleep_1.default)(15);
+        return {
+            Sum: 1,
+        };
+    },
+});
+exports.child2 = client_1.hatchet.workflow({
+    name: 'child2',
+});
+exports.child2.task({
+    name: 'transformer',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        const count = input.N;
+        const promises = Array(count)
+            .fill(null)
+            .map(() => ({ workflow: exports.child1, input }));
+        const results = yield ctx.bulkRunChildren(promises);
+        (0, sleep_1.default)(15);
+        return {
+            Sum: results.reduce((acc, r) => acc + r.transformer.Sum, 0),
+        };
+    }),
+});
+exports.child3 = client_1.hatchet.workflow({
+    name: 'child3',
+});
+exports.child3.task({
+    name: 'transformer',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        const count = input.N;
+        const promises = Array(count)
+            .fill(null)
+            .map(() => ({ workflow: exports.child2, input }));
+        const results = yield ctx.bulkRunChildren(promises);
+        return {
+            Sum: results.reduce((acc, r) => acc + r.transformer.Sum, 0),
+        };
+    }),
+});
+exports.child4 = client_1.hatchet.workflow({
+    name: 'child4',
+});
+exports.child4.task({
+    name: 'transformer',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        const count = input.N;
+        const promises = Array(count)
+            .fill(null)
+            .map(() => ({ workflow: exports.child3, input }));
+        const results = yield ctx.bulkRunChildren(promises);
+        return {
+            Sum: results.reduce((acc, r) => acc + r.transformer.Sum, 0),
+        };
+    }),
+});
+exports.child5 = client_1.hatchet.workflow({
+    name: 'child5',
+});
+exports.child5.task({
+    name: 'transformer',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        const count = input.N;
+        const promises = Array(count)
+            .fill(null)
+            .map(() => ({ workflow: exports.child4, input }));
+        const results = yield ctx.bulkRunChildren(promises);
+        return {
+            Sum: results.reduce((acc, r) => acc + r.transformer.Sum, 0),
+        };
+    }),
+});
+exports.parent = client_1.hatchet.workflow({
+    name: 'parent',
+});
+exports.parent.task({
+    name: 'parent',
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        const count = input.N; // Random number between 2-4
+        const promises = Array(count)
+            .fill(null)
+            .map(() => ({ workflow: exports.child5, input }));
+        const results = yield ctx.bulkRunChildren(promises);
+        return {
+            Sum: results.reduce((acc, r) => acc + r.transformer.Sum, 0),
+        };
+    }),
+});

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

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

package/v1/examples/legacy/run.js

@@ -0,0 +1,25 @@
+"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 res = yield client_1.hatchet.run(workflow_1.simple, {
+            Message: 'hello',
+        });
+        // eslint-disable-next-line no-console
+        console.log(res.step2);
+    });
+}
+if (require.main === module) {
+    main();
+}

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

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

package/v1/examples/legacy/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('legacy-worker', {
+            workflows: [workflow_1.simple],
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}

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

@@ -0,0 +1,2 @@
+import { Workflow } from '../../../workflow';
+export declare const simple: Workflow;

package/v1/examples/legacy/workflow.js

@@ -0,0 +1,36 @@
+"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 });
+exports.simple = void 0;
+exports.simple = {
+    id: 'legacy-workflow',
+    description: 'test',
+    on: {
+        event: 'user:create',
+    },
+    steps: [
+        {
+            name: 'step1',
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                const input = ctx.workflowInput();
+                return { step1: `original input: ${input.Message}` };
+            }),
+        },
+        {
+            name: 'step2',
+            parents: ['step1'],
+            run: (ctx) => {
+                const step1Output = ctx.stepOutput('step1');
+                return { step2: `step1 output: ${step1Output.step1}` };
+            },
+        },
+    ],
+};

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

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

package/v1/examples/on_event/event.js

@@ -0,0 +1,25 @@
+"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 res = yield client_1.hatchet.event.push(workflow_1.SIMPLE_EVENT, {
+            Message: 'hello',
+        });
+        // eslint-disable-next-line no-console
+        console.log(res.eventId);
+    });
+}
+if (require.main === module) {
+    main();
+}

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

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

package/v1/examples/on_event/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('on-event-worker', {
+            workflows: [workflow_1.lower, workflow_1.upper],
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}

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

@@ -0,0 +1,17 @@
+export declare const SIMPLE_EVENT = "simple-event:create";
+type Input = {
+    Message: string;
+};
+type LowerOutput = {
+    lower: {
+        TransformedMessage: string;
+    };
+};
+export declare const lower: import("../../workflow").Workflow<Input, LowerOutput>;
+type UpperOutput = {
+    upper: {
+        TransformedMessage: string;
+    };
+};
+export declare const upper: import("../../workflow").Workflow<Input, UpperOutput>;
+export {};

package/v1/examples/on_event/workflow.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upper = exports.lower = exports.SIMPLE_EVENT = void 0;
+const client_1 = require("../client");
+exports.SIMPLE_EVENT = 'simple-event:create';
+exports.lower = client_1.hatchet.workflow({
+    name: 'lower',
+    on: {
+        event: exports.SIMPLE_EVENT,
+    },
+});
+exports.lower.task({
+    name: 'lower',
+    fn: (input) => {
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});
+exports.upper = client_1.hatchet.workflow({
+    name: 'upper',
+    on: {
+        event: exports.SIMPLE_EVENT,
+    },
+});
+exports.upper.task({
+    name: 'upper',
+    fn: (input) => {
+        return {
+            TransformedMessage: input.Message.toUpperCase(),
+        };
+    },
+});

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

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

package/v1/examples/simple/cron.js

@@ -0,0 +1,26 @@
+"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 cron = yield workflow_1.simple.cron('simple-daily', '0 0 * * *', {
+            Message: 'hello',
+        });
+        // eslint-disable-next-line no-console
+        console.log(cron.metadata.id);
+        yield client_1.hatchet.cron.delete(cron);
+    });
+}
+if (require.main === module) {
+    main();
+}

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

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

package/v1/examples/simple/delay.js

@@ -0,0 +1,27 @@
+"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 tomorrow = 24 * 60 * 60; // 1 day
+        const scheduled = yield workflow_1.simple.delay(tomorrow, {
+            Message: 'hello',
+        });
+        // eslint-disable-next-line no-console
+        console.log(scheduled.metadata.id);
+        yield client_1.hatchet.schedule.delete(scheduled);
+    });
+}
+if (require.main === module) {
+    main();
+}

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

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

package/v1/examples/simple/run.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 workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const res = yield workflow_1.simple.run({
+            Message: 'hello',
+        });
+        // eslint-disable-next-line no-console
+        console.log(res.step2);
+    });
+}
+if (require.main === module) {
+    main();
+}

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

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

package/v1/examples/simple/schedule.js

@@ -0,0 +1,27 @@
+"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 runAt = new Date(Date.now() + 1000 * 60 * 60 * 24);
+        const scheduled = yield workflow_1.simple.schedule(runAt, {
+            Message: 'hello',
+        });
+        // eslint-disable-next-line no-console
+        console.log(scheduled.metadata.id);
+        yield client_1.hatchet.schedule.delete(scheduled);
+    });
+}
+if (require.main === module) {
+    main();
+}

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

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

package/v1/examples/simple/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('simple-worker', {
+            workflows: [workflow_1.simple],
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}

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

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

package/v1/examples/simple/workflow.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simple = void 0;
+const client_1 = require("../client");
+exports.simple = client_1.hatchet.workflow({
+    name: 'simple',
+});
+exports.simple.task({
+    name: 'to-lower',
+    fn: (input) => {
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});

package/v1/index.js

@@ -0,0 +1 @@
+"use strict";

package/v1/task.d.ts

@@ -0,0 +1,51 @@
+import { Context, CreateStep } from '../step';
+/**
+ * Options for creating a hatchet task which is an atomic unit of work in a workflow.
+ * @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 CreateTaskOpts<T, K> = {
+    /**
+     * The name of the task.
+     */
+    name: string;
+    /**
+     * The function to execute when the task runs.
+     * @param input The input data for the workflow invocation.
+     * @param ctx The execution context for the task.
+     * @returns The result of the task execution.
+     */
+    fn: (input: T, ctx: Context<T>) => K | Promise<K>;
+    /**
+     * Parent tasks that must complete before this task runs.
+     * Used to define the directed acyclic graph (DAG) of the workflow.
+     */
+    parents?: CreateTaskOpts<T, any>[];
+    /**
+     * Timeout duration for the task in Go duration format (e.g., "1s", "5m", "1h").
+     */
+    timeout?: CreateStep<T, K>['timeout'];
+    /**
+     * Optional retry configuration for the task.
+     */
+    retries?: CreateStep<T, K>['retries'];
+    /**
+     * Backoff strategy configuration for retries.
+     * - factor: Multiplier for exponential backoff
+     * - maxSeconds: Maximum backoff duration in seconds
+     */
+    backoff?: CreateStep<T, K>['backoff'];
+    /**
+     * Optional rate limiting configuration for the task.
+     */
+    rateLimits?: CreateStep<T, K>['rate_limits'];
+    /**
+     * Worker labels for task routing and scheduling.
+     * Each label can be a simple string/number value or an object with additional configuration:
+     * - value: The label value (string or number)
+     * - required: Whether the label is required for worker matching
+     * - weight: Priority weight for worker selection
+     * - comparator: Custom comparison logic for label matching
+     */
+    workerLabels?: CreateStep<T, K>['worker_labels'];
+};

package/v1/task.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });