@hatchet-dev/typescript-sdk 1.6.3 → 1.8.0

package/v1/client/client.js

@@ -21,6 +21,7 @@ const rest_1 = __importDefault(require("../../clients/rest"));
 const config_loader_1 = require("../../util/config-loader");
 const hatchet_logger_1 = require("../../clients/hatchet-client/hatchet-logger");
 const zod_1 = require("zod");
+const event_client_1 = require("../../clients/event/event-client");
 const declaration_1 = require("../declaration");
 const worker_1 = require("./worker/worker");
 const metrics_1 = require("./features/metrics");
@@ -32,6 +33,7 @@ const admin_1 = require("./admin");
 const filters_1 = require("./features/filters");
 const schedules_1 = require("./features/schedules");
 const crons_1 = require("./features/crons");
+const tenant_1 = require("./features/tenant");
 /**
  * HatchetV1 implements the main client interface for interacting with the Hatchet workflow engine.
  * It provides methods for creating and executing workflows, as well as managing workers.
@@ -75,6 +77,23 @@ class HatchetClient {
             }
             throw e;
         }
+        try {
+            this.tenant
+                .get()
+                .then((tenant) => {
+                if (tenant.version !== 'V1') {
+                    this.config
+                        .logger('client-init', event_client_1.LogLevel.INFO)
+                        .warn('🚨⚠️‼️ YOU ARE USING A V0 ENGINE WITH A V1 SDK, WHICH IS NOT SUPPORTED. PLEASE UPGRADE YOUR ENGINE TO V1.🚨⚠️‼️');
+                }
+            })
+                .catch((error) => {
+                // Do nothing here
+            });
+        }
+        catch (e) {
+            // Do nothing here
+        }
     }
     /**
      * Static factory method to create a new Hatchet client instance.
@@ -243,6 +262,16 @@ class HatchetClient {
         }
         return this._filters;
     }
+    /**
+     * Get the tenant client for managing tenants
+     * @returns A tenant client instance
+     */
+    get tenant() {
+        if (!this._tenant) {
+            this._tenant = new tenant_1.TenantClient(this);
+        }
+        return this._tenant;
+    }
     /**
      * Get the rate limits client for creating and managing rate limits
      * @returns A rate limits client instance

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

@@ -18,4 +18,5 @@ export declare class FiltersClient {
     get(filterId: Parameters<typeof this.api.v1FilterGet>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
     create(opts: Parameters<typeof this.api.v1FilterCreate>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
     delete(filterId: Parameters<typeof this.api.v1FilterDelete>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
+    update(filterId: Parameters<typeof this.api.v1FilterDelete>[1], updates: Parameters<typeof this.api.v1FilterUpdate>[2]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
 }

package/v1/client/features/filters.js

@@ -55,5 +55,11 @@ class FiltersClient {
             return data;
         });
     }
+    update(filterId, updates) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.api.v1FilterUpdate(this.tenantId, filterId, updates);
+            return data;
+        });
+    }
 }
 exports.FiltersClient = FiltersClient;

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

@@ -62,6 +62,7 @@ export declare class RunsClient {
     workflows: WorkflowsClient;
     constructor(client: HatchetClient);
     get<T = any>(run: string | WorkflowRunRef<T>): Promise<import("../../../clients/rest/generated/data-contracts").V1WorkflowRunDetails>;
+    get_status<T = any>(run: string | WorkflowRunRef<T>): Promise<V1TaskStatus>;
     list(opts?: Partial<ListRunsOpts>): Promise<import("../../../clients/rest/generated/data-contracts").V1TaskSummaryList>;
     cancel(opts: CancelRunOpts): Promise<import("axios").AxiosResponse<void, any>>;
     replay(opts: ReplayRunOpts): Promise<import("axios").AxiosResponse<void, any>>;

package/v1/client/features/runs.js

@@ -26,6 +26,13 @@ class RunsClient {
             return data;
         });
     }
+    get_status(run) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const runId = typeof run === 'string' ? run : yield run.getWorkflowRunId();
+            const { data } = yield this.api.v1WorkflowRunGetStatus(runId);
+            return data;
+        });
+    }
     list(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.v1WorkflowRunList(this.tenantId, Object.assign({}, (yield this.prepareListFilter(opts || {}))));

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

@@ -0,0 +1,15 @@
+import { Tenant } from '../../../clients/rest/generated/data-contracts';
+import { HatchetClient } from '../client';
+/**
+ * Client for managing Tenants
+ */
+export declare class TenantClient {
+    api: HatchetClient['api'];
+    tenantId: string;
+    constructor(client: HatchetClient);
+    /**
+     * Retrieves the current tenant.
+     * @returns The Tenant object.
+     */
+    get(): Promise<Tenant>;
+}

package/v1/client/features/tenant.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 });
+exports.TenantClient = void 0;
+/**
+ * Client for managing Tenants
+ */
+class TenantClient {
+    constructor(client) {
+        this.api = client.api;
+        this.tenantId = client.tenantId;
+    }
+    /**
+     * Retrieves the current tenant.
+     * @returns The Tenant object.
+     */
+    get() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.api.tenantGet(this.tenantId)).data;
+        });
+    }
+}
+exports.TenantClient = TenantClient;

package/v1/client/worker/worker-internal.js

@@ -31,6 +31,7 @@ const transformer_1 = require("../../conditions/transformer");
 const step_1 = require("../../../step");
 const apply_namespace_1 = require("../../../util/apply-namespace");
 const context_1 = require("./context");
+const parent_run_context_vars_1 = require("../../parent-run-context-vars");
 class V1Worker {
     constructor(client, options) {
         this.workflow_registry = [];
@@ -116,7 +117,7 @@ class V1Worker {
     }
     registerWorkflowV1(initWorkflow_1) {
         return __awaiter(this, arguments, void 0, function* (initWorkflow, durable = false) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
             // patch the namespace
             const workflow = Object.assign(Object.assign({}, initWorkflow.definition), { name: (0, apply_namespace_1.applyNamespace)(initWorkflow.definition.name, this.client.config.namespace).toLowerCase() });
             try {
@@ -240,6 +241,11 @@ class V1Worker {
                         });
                     }),
                     concurrency: concurrencySolo,
+                    defaultFilters: (_x = (_w = workflow.defaultFilters) === null || _w === void 0 ? void 0 : _w.map((f) => ({
+                        scope: f.scope,
+                        expression: f.expression,
+                        payload: f.payload ? JSON.stringify(f.payload) : undefined,
+                    }))) !== null && _x !== void 0 ? _x : [],
                 });
                 this.registeredWorkflowPromises.push(registeredWorkflow);
                 yield registeredWorkflow;
@@ -351,6 +357,12 @@ class V1Worker {
                     return;
                 }
                 const run = () => __awaiter(this, void 0, void 0, function* () {
+                    parent_run_context_vars_1.parentRunContextManager.setContext({
+                        parentId: action.workflowRunId,
+                        parentRunId: action.stepRunId,
+                        childIndex: 0,
+                        desiredWorkerId: this.workerId || '',
+                    });
                     return step(context);
                 });
                 const success = (result) => __awaiter(this, void 0, void 0, function* () {

package/v1/declaration.d.ts

@@ -1,5 +1,5 @@
 import WorkflowRunRef from '../util/workflow-run-ref';
-import { CronWorkflows, ScheduledWorkflows } from '../clients/rest/generated/data-contracts';
+import { CronWorkflows, ScheduledWorkflows, V1CreateFilterRequest } from '../clients/rest/generated/data-contracts';
 import { Workflow as WorkflowV0 } from '../workflow';
 import { IHatchetClient } from './client/client.interface';
 import { CreateWorkflowTaskOpts, CreateOnFailureTaskOpts, TaskFn, CreateWorkflowDurableTaskOpts, CreateBaseTaskOpts, CreateOnSuccessTaskOpts, Concurrency, DurableTaskFn } from './task';
@@ -30,6 +30,16 @@ export type RunOpts = {
      * values: Priority.LOW, Priority.MEDIUM, Priority.HIGH (1, 2, or 3 )
      */
     priority?: Priority;
+    /**
+     * (optional) if the task run should be run on the same worker.
+     * only used if spawned from within a parent task.
+     */
+    sticky?: boolean;
+    /**
+     * (optional) the child key for the workflow run.
+     * only used if spawned from within a parent task.
+     */
+    childKey?: string;
 };
 /**
  * Helper type to safely extract output types from task results
@@ -39,6 +49,7 @@ export type TaskOutput<O, Key extends string, Fallback> = O extends Record<Key,
  * Extracts a property from an object type based on task name, or falls back to inferred type
  */
 export type TaskOutputType<O, TaskName extends string, InferredType extends OutputType> = TaskName extends keyof O ? O[TaskName] extends OutputType ? O[TaskName] : InferredType : InferredType;
+type DefaultFilter = Omit<V1CreateFilterRequest, 'workflowId'>;
 export type CreateBaseWorkflowOpts = {
     /**
      * The name of the workflow.
@@ -78,6 +89,7 @@ export type CreateBaseWorkflowOpts = {
      * values: Priority.LOW, Priority.MEDIUM, Priority.HIGH (1, 2, or 3 )
      */
     defaultPriority?: Priority;
+    defaultFilters?: DefaultFilter[];
 };
 export type CreateTaskWorkflowOpts<I extends InputType = UnknownInputType, O extends OutputType = void> = CreateBaseWorkflowOpts & CreateBaseTaskOpts<I, O, TaskFn<I, O>>;
 export type CreateDurableTaskWorkflowOpts<I extends InputType = UnknownInputType, O extends OutputType = void> = CreateBaseWorkflowOpts & CreateBaseTaskOpts<I, O, DurableTaskFn<I, O>>;

package/v1/declaration.js

@@ -13,6 +13,7 @@ exports.TaskWorkflowDeclaration = exports.WorkflowDeclaration = exports.BaseWork
 exports.CreateTaskWorkflow = CreateTaskWorkflow;
 exports.CreateWorkflow = CreateWorkflow;
 exports.CreateDurableTaskWorkflow = CreateDurableTaskWorkflow;
+const parent_run_context_vars_1 = require("./parent-run-context-vars");
 const UNBOUND_ERR = new Error('workflow unbound to hatchet client, hint: use client.run instead');
 // eslint-disable-next-line no-shadow
 var Priority;
@@ -41,15 +42,25 @@ class BaseWorkflowDeclaration {
             if (!this.client) {
                 throw UNBOUND_ERR;
             }
+            // set the parent run context
+            const parentRunContext = parent_run_context_vars_1.parentRunContextManager.getContext();
+            parent_run_context_vars_1.parentRunContextManager.incrementChildIndex(Array.isArray(input) ? input.length : 1);
+            if (!parentRunContext && ((options === null || options === void 0 ? void 0 : options.childKey) || (options === null || options === void 0 ? void 0 : options.sticky))) {
+                this.client.admin.logger.warn('ignoring childKey or sticky because run is not being spawned from a parent task');
+            }
+            const runOpts = Object.assign(Object.assign({}, options), { parentId: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentId, parentStepRunId: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.parentRunId, childIndex: parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.childIndex, sticky: (options === null || options === void 0 ? void 0 : options.sticky) ? parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.desiredWorkerId : undefined, childKey: options === null || options === void 0 ? void 0 : options.childKey });
             if (Array.isArray(input)) {
                 let resp = [];
                 for (let i = 0; i < input.length; i += 500) {
                     const batch = input.slice(i, i + 500);
-                    const batchResp = yield this.client.admin.runWorkflows(batch.map((inp) => ({
-                        workflowName: this.definition.name,
-                        input: inp,
-                        options,
-                    })));
+                    const batchResp = yield this.client.admin.runWorkflows(batch.map((inp) => {
+                        var _a;
+                        return ({
+                            workflowName: this.definition.name,
+                            input: inp,
+                            options: Object.assign(Object.assign({}, runOpts), { childIndex: ((_a = runOpts.childIndex) !== null && _a !== void 0 ? _a : 0) + i }),
+                        });
+                    }));
                     resp = resp.concat(batchResp);
                 }
                 const res = [];
@@ -67,7 +78,7 @@ class BaseWorkflowDeclaration {
                 });
                 return res;
             }
-            const res = yield this.client.admin.runWorkflow(this.definition.name, input, options);
+            const res = yield this.client.admin.runWorkflow(this.definition.name, input, runOpts);
             if (_standaloneTaskName) {
                 res._standaloneTaskName = _standaloneTaskName;
             }

package/v1/examples/cancellations/workflow.js

@@ -19,9 +19,9 @@ const hatchet_client_1 = require("../hatchet-client");
 // > Declaring a Task
 exports.cancellation = hatchet_client_1.hatchet.task({
     name: 'cancellation',
-    fn: (_1, _a) => __awaiter(void 0, [_1, _a], void 0, function* (_, { cancelled }) {
+    fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, sleep_1.default)(10 * 1000);
-        if (cancelled) {
+        if (ctx.cancelled) {
             throw new Error('Task was cancelled');
         }
         return {

package/v1/examples/child_workflows/workflow.js

@@ -27,7 +27,7 @@ exports.parent = hatchet_client_1.hatchet.task({
         const n = input.N;
         const promises = [];
         for (let i = 0; i < n; i++) {
-            promises.push(ctx.runChild(exports.child, { N: i }));
+            promises.push(exports.child.run({ N: i }));
         }
         const childRes = yield Promise.all(promises);
         const sum = childRes.reduce((acc, curr) => acc + curr.Value, 0);

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

@@ -9,6 +9,7 @@ type LowerOutput = {
     };
 };
 export declare const lower: import("../..").WorkflowDeclaration<Input, LowerOutput>;
+export declare const lowerWithFilter: import("../..").WorkflowDeclaration<Input, LowerOutput>;
 type UpperOutput = {
     upper: {
         TransformedMessage: string;

package/v1/examples/on_event/workflow.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.upper = exports.lower = exports.SIMPLE_EVENT = void 0;
+exports.upper = exports.lowerWithFilter = exports.lower = exports.SIMPLE_EVENT = void 0;
 const hatchet_client_1 = require("../hatchet-client");
 exports.SIMPLE_EVENT = 'simple-event:create';
 // > Run workflow on event
@@ -10,6 +10,24 @@ exports.lower = hatchet_client_1.hatchet.workflow({
     onEvents: ['simple-event:create'],
 });
 // !!
+// > Workflow with filter
+exports.lowerWithFilter = hatchet_client_1.hatchet.workflow({
+    name: 'lower',
+    // 👀 Declare the event that will trigger the workflow
+    onEvents: ['simple-event:create'],
+    defaultFilters: [
+        {
+            expression: 'true',
+            scope: 'example-scope',
+            payload: {
+                mainCharacter: 'Anna',
+                supportingCharacter: 'Stiva',
+                location: 'Moscow',
+            },
+        },
+    ],
+});
+// !!
 exports.lower.task({
     name: 'lower',
     fn: (input) => {
@@ -32,3 +50,11 @@ exports.upper.task({
         };
     },
 });
+// > Accessing the filter payload
+exports.lowerWithFilter.task({
+    name: 'lowerWithFilter',
+    fn: (input, ctx) => {
+        console.log(ctx.filterPayload());
+    },
+});
+// !!

package/v1/examples/simple/run.js

@@ -13,10 +13,11 @@ exports.extra = extra;
 /* eslint-disable no-console */
 const hatchet_client_1 = require("../hatchet-client");
 const workflow_1 = require("./workflow");
+const workflow_with_child_1 = require("./workflow-with-child");
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         // > Running a Task
-        const res = yield workflow_1.simple.run({
+        const res = yield workflow_with_child_1.parent.run({
             Message: 'HeLlO WoRlD',
         }, {
             additionalMetadata: {
@@ -42,11 +43,11 @@ function extra() {
         console.log(results[1].TransformedMessage);
         // !!
         // > Spawning Tasks from within a Task
-        const parent = hatchet_client_1.hatchet.task({
+        const parentTask = hatchet_client_1.hatchet.task({
             name: 'parent',
             fn: (input, ctx) => __awaiter(this, void 0, void 0, function* () {
-                // Simply call ctx.runChild with the task you want to run
-                const child = yield ctx.runChild(workflow_1.simple, {
+                // Simply the task and it will be spawned from the parent task
+                const child = yield workflow_1.simple.run({
                     Message: 'HeLlO WoRlD',
                 });
                 return {
@@ -58,5 +59,9 @@ function extra() {
     });
 }
 if (require.main === module) {
-    main();
+    main()
+        .catch(console.error)
+        .finally(() => {
+        process.exit(0);
+    });
 }

package/v1/examples/sticky/workflow.js

@@ -21,7 +21,7 @@ exports.sticky = hatchet_client_1.hatchet.task({
     sticky: workflows_1.StickyStrategy.SOFT,
     fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         // specify a child workflow to run on the same worker
-        const result = yield ctx.runChild(workflow_1.child, {
+        const result = yield workflow_1.child.run({
             N: 1,
         }, { sticky: true });
         return {

package/v1/parent-run-context-vars.d.ts

@@ -0,0 +1,15 @@
+export interface ParentRunContext {
+    parentId: string;
+    parentRunId: string;
+    desiredWorkerId: string;
+    childIndex?: number;
+}
+export declare class ParentRunContextManager {
+    private storage;
+    constructor();
+    setContext(opts: ParentRunContext): void;
+    setParentRunIdAndIncrementChildIndex(opts: ParentRunContext): void;
+    incrementChildIndex(n: number): void;
+    getContext(): ParentRunContext | undefined;
+}
+export declare const parentRunContextManager: ParentRunContextManager;

package/v1/parent-run-context-vars.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parentRunContextManager = exports.ParentRunContextManager = void 0;
+const async_hooks_1 = require("async_hooks");
+class ParentRunContextManager {
+    constructor() {
+        this.storage = new async_hooks_1.AsyncLocalStorage();
+    }
+    setContext(opts) {
+        this.storage.enterWith(Object.assign({}, opts));
+    }
+    setParentRunIdAndIncrementChildIndex(opts) {
+        var _a;
+        const parentRunContext = this.getContext();
+        if (parentRunContext) {
+            parentRunContext.parentId = opts.parentId;
+            parentRunContext.childIndex = ((_a = parentRunContext.childIndex) !== null && _a !== void 0 ? _a : 0) + 1;
+            this.setContext(parentRunContext);
+        }
+    }
+    incrementChildIndex(n) {
+        var _a;
+        const parentRunContext = this.getContext();
+        if (parentRunContext) {
+            parentRunContext.childIndex = ((_a = parentRunContext.childIndex) !== null && _a !== void 0 ? _a : 0) + n;
+            this.setContext(parentRunContext);
+        }
+    }
+    getContext() {
+        return this.storage.getStore();
+    }
+}
+exports.ParentRunContextManager = ParentRunContextManager;
+// Export a default instance for backward compatibility and convenience
+exports.parentRunContextManager = new ParentRunContextManager();

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.6.3";
+export declare const HATCHET_VERSION = "1.8.0";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HATCHET_VERSION = void 0;
-exports.HATCHET_VERSION = '1.6.3';
+exports.HATCHET_VERSION = '1.8.0';