@hatchet-dev/typescript-sdk 1.6.0 → 1.6.2

package/package.json

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

package/v1/client/worker/context.d.ts

@@ -4,7 +4,7 @@ import { Action } from '../../../clients/dispatcher/action-listener';
 import { Logger, LogLevel } from '../../../util/logger';
 import WorkflowRunRef from '../../../util/workflow-run-ref';
 import { Conditions } from '../../conditions';
-import { CreateWorkflowTaskOpts } from '../../task';
+import { CreateWorkflowDurableTaskOpts, CreateWorkflowTaskOpts } from '../../task';
 import { OutputType } from '../../types';
 import { Workflow } from '../../../workflow';
 import { HatchetClient } from '../..';
@@ -48,7 +48,7 @@ export declare class Context<T, K = {}> {
      * @returns The output of the specified parent task.
      * @throws An error if the task output is not found.
      */
-    parentOutput<L extends OutputType>(parentTask: CreateWorkflowTaskOpts<any, L> | string): Promise<L>;
+    parentOutput<L extends OutputType>(parentTask: CreateWorkflowTaskOpts<any, L> | CreateWorkflowDurableTaskOpts<any, L> | string): Promise<L>;
     /**
      * Returns errors from any task runs in the workflow.
      * @returns A record mapping task names to error messages.
@@ -67,6 +67,11 @@ export declare class Context<T, K = {}> {
      * @returns The triggers for the current workflow.
      */
     triggers(): TriggerData;
+    /**
+     * Gets the payload from the filter that matched when triggering the event.
+     * @returns The payload.
+     */
+    filterPayload(): Record<string, any>;
     /**
      * Determines if the workflow was triggered by an event.
      * @returns True if the workflow was triggered by an event, otherwise false.

package/v1/client/worker/context.js

@@ -112,6 +112,14 @@ class Context {
     triggers() {
         return this.data.triggers;
     }
+    /**
+     * Gets the payload from the filter that matched when triggering the event.
+     * @returns The payload.
+     */
+    filterPayload() {
+        var _a;
+        return ((_a = this.data.triggers) === null || _a === void 0 ? void 0 : _a.filter_payload) || {};
+    }
     /**
      * Determines if the workflow was triggered by an event.
      * @returns True if the workflow was triggered by an event, otherwise false.

package/v1/client/worker/worker-internal.d.ts

@@ -46,7 +46,7 @@ export declare class V1Worker {
     register_workflow(initWorkflow: Workflow): Promise<void>;
     registerDurableActionsV1(workflow: WorkflowDefinition): void;
     private registerActionsV1;
-    registerWorkflowV1(initWorkflow: BaseWorkflowDeclaration<any, any>): Promise<void>;
+    registerWorkflowV1(initWorkflow: BaseWorkflowDeclaration<any, any>, durable?: boolean): Promise<void>;
     registerWorkflow(initWorkflow: Workflow): Promise<void>;
     registerAction<T, K>(actionId: string, action: StepRunFunction<T, K>): void;
     handleStartStepRun(action: Action): Promise<void>;

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

@@ -113,15 +113,15 @@ class V1Worker {
             : {};
         this.action_registry = Object.assign(Object.assign(Object.assign({}, this.action_registry), newActions), onFailureAction);
     }
-    registerWorkflowV1(initWorkflow) {
-        return __awaiter(this, void 0, void 0, function* () {
+    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;
             // patch the namespace
             const workflow = Object.assign(Object.assign({}, initWorkflow.definition), { name: (this.client.config.namespace + initWorkflow.definition.name).toLowerCase() });
             try {
                 const { concurrency } = workflow;
                 let onFailureTask;
-                if (workflow.onFailure && typeof workflow.onFailure === 'function') {
+                if (!durable && workflow.onFailure && typeof workflow.onFailure === 'function') {
                     onFailureTask = {
                         readableId: 'on-failure-task',
                         action: onFailureTaskName(workflow),
@@ -134,7 +134,7 @@ class V1Worker {
                         concurrency: [],
                     };
                 }
-                if (workflow.onFailure && typeof workflow.onFailure === 'object') {
+                if (!durable && workflow.onFailure && typeof workflow.onFailure === 'object') {
                     const onFailure = workflow.onFailure;
                     onFailureTask = {
                         readableId: 'on-failure-task',
@@ -152,8 +152,8 @@ class V1Worker {
                     };
                 }
                 let onSuccessTask;
-                if (workflow.onSuccess && typeof workflow.onSuccess === 'function') {
-                    const parents = getLeaves(workflow._tasks);
+                if (!durable && workflow.onSuccess && typeof workflow.onSuccess === 'function') {
+                    const parents = getLeaves([...workflow._tasks, ...workflow._durableTasks]);
                     onSuccessTask = {
                         name: 'on-success-task',
                         fn: workflow.onSuccess,
@@ -165,9 +165,9 @@ class V1Worker {
                         concurrency: [],
                     };
                 }
-                if (workflow.onSuccess && typeof workflow.onSuccess === 'object') {
+                if (!durable && workflow.onSuccess && typeof workflow.onSuccess === 'object') {
                     const onSuccess = workflow.onSuccess;
-                    const parents = getLeaves(workflow._tasks);
+                    const parents = getLeaves([...workflow._tasks, ...workflow._durableTasks]);
                     onSuccessTask = {
                         name: 'on-success-task',
                         fn: onSuccess.fn,

package/v1/client/worker/worker.js

@@ -58,7 +58,7 @@ class Worker {
                         if (!this.durable) {
                             const opts = Object.assign(Object.assign({ name: `${this.name}-durable` }, this.config), { maxRuns: this.config.durableSlots || DEFAULT_DURABLE_SLOTS });
                             this.durable = new worker_internal_1.V1Worker(this._v1, opts);
-                            yield this.durable.registerWorkflowV1(wf);
+                            yield this.durable.registerWorkflowV1(wf, true);
                         }
                         this.durable.registerDurableActionsV1(wf.definition);
                     }

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

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

package/v1/examples/on_event/filter.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const hatchet_client_1 = require("../hatchet-client");
+const workflow_1 = require("./workflow");
+// > Create a filter
+hatchet_client_1.hatchet.filters.create({
+    workflowId: workflow_1.lower.id,
+    expression: 'input.ShouldSkip == false',
+    scope: 'foobarbaz',
+    payload: {
+        main_character: 'Anna',
+        supporting_character: 'Stiva',
+        location: 'Moscow',
+    },
+});
+// !!
+// > Skip a run
+hatchet_client_1.hatchet.events.push(workflow_1.SIMPLE_EVENT, {
+    Message: 'hello',
+    ShouldSkip: true,
+}, {
+    scope: 'foobarbaz',
+});
+// !!
+// > Trigger a run
+hatchet_client_1.hatchet.events.push(workflow_1.SIMPLE_EVENT, {
+    Message: 'hello',
+    ShouldSkip: false,
+}, {
+    scope: 'foobarbaz',
+});
+// !!

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.6.0";
+export declare const HATCHET_VERSION = "1.6.2";

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.0';
+exports.HATCHET_VERSION = '1.6.2';