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

package/v1/examples/landing_page/durable-excution.js

@@ -0,0 +1,40 @@
+"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 @typescript-eslint/no-unused-vars */
+const conditions_1 = require("../../conditions");
+const hatchet_client_1 = require("../hatchet-client");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // ❓ Declaring a Durable Task
+        const simple = hatchet_client_1.hatchet.durableTask({
+            name: 'simple',
+            fn: (input, ctx) => __awaiter(this, void 0, void 0, function* () {
+                yield ctx.waitFor((0, conditions_1.Or)({
+                    eventKey: 'user:pay',
+                    expression: 'input.Status == "PAID"',
+                }, {
+                    sleepFor: '24h',
+                }));
+                return {
+                    TransformedMessage: input.Message.toLowerCase(),
+                };
+            }),
+        });
+        // !!
+        // ❓ Running a Task
+        const result = yield simple.run({ Message: 'Hello, World!' });
+        // !!
+    });
+}
+if (require.main === module) {
+    main();
+}

package/v1/examples/landing_page/event-signaling.d.ts

@@ -0,0 +1,6 @@
+export type SimpleInput = {
+    Message: string;
+};
+export declare const simple: import("../..").TaskWorkflowDeclaration<SimpleInput, {
+    TransformedMessage: string;
+}>;

package/v1/examples/landing_page/event-signaling.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simple = void 0;
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ Trigger on an event
+exports.simple = hatchet_client_1.hatchet.task({
+    name: 'simple',
+    onEvents: ['user:created'],
+    fn: (input) => {
+        // ...
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});
+// !!

package/v1/examples/landing_page/flow-control.d.ts

@@ -0,0 +1,6 @@
+export type SimpleInput = {
+    Message: string;
+};
+export declare const simple: import("../..").TaskWorkflowDeclaration<SimpleInput, {
+    TransformedMessage: string;
+}>;

package/v1/examples/landing_page/flow-control.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simple = void 0;
+const workflows_1 = require("../../../protoc/v1/workflows");
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ Process what you can handle
+exports.simple = hatchet_client_1.hatchet.task({
+    name: 'simple',
+    concurrency: {
+        expression: 'input.user_id',
+        limitStrategy: workflows_1.ConcurrencyLimitStrategy.GROUP_ROUND_ROBIN,
+        maxRuns: 1,
+    },
+    rateLimits: [
+        {
+            key: 'api_throttle',
+            units: 1,
+        },
+    ],
+    fn: (input) => {
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});
+// !!

package/v1/examples/landing_page/queues.d.ts

@@ -0,0 +1,3 @@
+export type SimpleInput = {
+    Message: string;
+};

package/v1/examples/landing_page/queues.js

@@ -0,0 +1,33 @@
+"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 @typescript-eslint/no-unused-vars */
+const hatchet_client_1 = require("../hatchet-client");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // ❓ Declaring a Task
+        const simple = hatchet_client_1.hatchet.task({
+            name: 'simple',
+            fn: (input) => {
+                return {
+                    TransformedMessage: input.Message.toLowerCase(),
+                };
+            },
+        });
+        // !!
+        // ❓ Running a Task
+        const result = yield simple.run({ Message: 'Hello, World!' });
+        // !!
+    });
+}
+if (require.main === module) {
+    main();
+}

package/v1/examples/landing_page/scheduling.d.ts

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

package/v1/examples/landing_page/scheduling.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const flow_control_1 = require("./flow-control");
+// ❓ Schedules and Crons
+const tomorrow = new Date(Date.now() + 1000 * 60 * 60 * 24);
+const scheduled = flow_control_1.simple.schedule(tomorrow, {
+    Message: 'Hello, World!',
+});
+const cron = flow_control_1.simple.cron('every-day', '0 0 * * *', {
+    Message: 'Hello, World!',
+});
+// !!

package/v1/examples/landing_page/task-routing.d.ts

@@ -0,0 +1,6 @@
+export type SimpleInput = {
+    Message: string;
+};
+export declare const simple: import("../..").TaskWorkflowDeclaration<SimpleInput, {
+    TransformedMessage: string;
+}>;

package/v1/examples/landing_page/task-routing.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simple = void 0;
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ Route tasks to workers with matching labels
+exports.simple = hatchet_client_1.hatchet.task({
+    name: 'simple',
+    desiredWorkerLabels: {
+        cpu: {
+            value: '2x',
+        },
+    },
+    fn: (input) => {
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});
+hatchet_client_1.hatchet.worker('task-routing-worker', {
+    workflows: [exports.simple],
+    labels: {
+        cpu: process.env.CPU_LABEL,
+    },
+});
+// !!

package/v1/examples/legacy/run.js

@@ -9,11 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../client");
+const hatchet_client_1 = require("../hatchet-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, {
+        const res = yield hatchet_client_1.hatchet.run(workflow_1.simple, {
             Message: 'hello',
         });
         // eslint-disable-next-line no-console

package/v1/examples/legacy/worker.js

@@ -9,11 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../client");
+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 client_1.hatchet.worker('legacy-worker', {
+        const worker = yield hatchet_client_1.hatchet.worker('legacy-worker', {
             workflows: [workflow_1.simple],
         });
         yield worker.start();

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

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

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

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

@@ -0,0 +1,10 @@
+export type Input = {
+    Message: string;
+};
+type OnCronOutput = {
+    job: {
+        TransformedMessage: string;
+    };
+};
+export declare const onCron: import("../..").WorkflowDeclaration<Input, OnCronOutput>;
+export {};

package/v1/examples/on_cron/workflow.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onCron = void 0;
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ Run Workflow on Cron
+exports.onCron = hatchet_client_1.hatchet.workflow({
+    name: 'on-cron-workflow',
+    on: {
+        // 👀 add a cron expression to run the workflow every 15 minutes
+        cron: '*/15 * * * *',
+    },
+});
+// !!
+exports.onCron.task({
+    name: 'job',
+    fn: (input) => {
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});

package/v1/examples/on_event/event.js

@@ -9,13 +9,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../client");
+const hatchet_client_1 = require("../hatchet-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, {
+        const res = yield hatchet_client_1.hatchet.events.push(workflow_1.SIMPLE_EVENT, {
             Message: 'hello',
         });
+        // !!
         // eslint-disable-next-line no-console
         console.log(res.eventId);
     });

package/v1/examples/on_event/worker.js

@@ -9,11 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../client");
+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 client_1.hatchet.worker('on-event-worker', {
+        const worker = yield hatchet_client_1.hatchet.worker('on-event-worker', {
             workflows: [workflow_1.lower, workflow_1.upper],
         });
         yield worker.start();

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

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

package/v1/examples/on_event/workflow.js

@@ -1,14 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.upper = exports.lower = exports.SIMPLE_EVENT = void 0;
-const client_1 = require("../client");
+const hatchet_client_1 = require("../hatchet-client");
 exports.SIMPLE_EVENT = 'simple-event:create';
-exports.lower = client_1.hatchet.workflow({
+// ❓ Run workflow on event
+exports.lower = hatchet_client_1.hatchet.workflow({
     name: 'lower',
     on: {
+        // 👀 Declare the event that will trigger the workflow
         event: exports.SIMPLE_EVENT,
     },
 });
+// !!
 exports.lower.task({
     name: 'lower',
     fn: (input) => {
@@ -17,7 +20,7 @@ exports.lower.task({
         };
     },
 });
-exports.upper = client_1.hatchet.workflow({
+exports.upper = hatchet_client_1.hatchet.workflow({
     name: 'upper',
     on: {
         event: exports.SIMPLE_EVENT,

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

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

package/v1/examples/on_event copy/event.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 hatchet_client_1 = require("../hatchet-client");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // ❓ Pushing an Event
+        const res = yield hatchet_client_1.hatchet.event.push('simple-event:create', {
+            Message: 'hello',
+        });
+        // !!
+        // eslint-disable-next-line no-console
+        console.log(res.eventId);
+    });
+}
+if (require.main === module) {
+    main();
+}

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

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

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

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

@@ -0,0 +1,16 @@
+export type Input = {
+    Message: string;
+};
+type LowerOutput = {
+    lower: {
+        TransformedMessage: string;
+    };
+};
+export declare const lower: import("../..").WorkflowDeclaration<Input, LowerOutput>;
+type UpperOutput = {
+    upper: {
+        TransformedMessage: string;
+    };
+};
+export declare const upper: import("../..").WorkflowDeclaration<Input, UpperOutput>;
+export {};

package/v1/examples/on_event copy/workflow.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upper = exports.lower = void 0;
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ Run workflow on event
+exports.lower = hatchet_client_1.hatchet.workflow({
+    name: 'lower',
+    on: {
+        // 👀 Declare the event that will trigger the workflow
+        event: 'simple-event:create',
+    },
+});
+// !!
+exports.lower.task({
+    name: 'lower',
+    fn: (input) => {
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});
+exports.upper = hatchet_client_1.hatchet.workflow({
+    name: 'upper',
+    on: {
+        event: 'simple-event:create',
+    },
+});
+exports.upper.task({
+    name: 'upper',
+    fn: (input) => {
+        return {
+            TransformedMessage: input.Message.toUpperCase(),
+        };
+    },
+});

package/v1/examples/on_failure/worker.js

@@ -9,11 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../client");
+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 client_1.hatchet.worker('always-fail-worker', {
+        const worker = yield hatchet_client_1.hatchet.worker('always-fail-worker', {
             workflows: [workflow_1.alwaysFail],
         });
         yield worker.start();

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

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

package/v1/examples/on_failure/workflow.js

@@ -1,20 +1,30 @@
 "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.alwaysFail = void 0;
 /* eslint-disable no-console */
-const client_1 = require("../client");
-exports.alwaysFail = client_1.hatchet.workflow({
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ On Failure Task
+exports.alwaysFail = hatchet_client_1.hatchet.task({
     name: 'always-fail',
-    onFailure: (ctx) => {
+    // the onFailure function is called when the task fails
+    // note: not guaranteed to be called on the same worker
+    onFailure: (input, ctx) => {
         console.log('onFailure for run:', ctx.workflowRunId());
         return {
             'on-failure': 'success',
         };
     },
-});
-exports.alwaysFail.task({
-    name: 'always-fail',
-    fn: () => {
+    fn: () => __awaiter(void 0, void 0, void 0, function* () {
         throw new Error('intentional failure');
-    },
+    }),
 });
+// !!

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

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

package/v1/examples/on_success/run.js

@@ -0,0 +1,31 @@
+"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.onSuccess.run({});
+            console.log(res);
+            const res2 = yield workflow_1.onSuccessDag.run({});
+            console.log(res2);
+        }
+        catch (e) {
+            console.log('error', e);
+        }
+    });
+}
+if (require.main === module) {
+    main()
+        .catch(console.error)
+        .finally(() => process.exit(0));
+}

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

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

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

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

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