@hatchet-dev/typescript-sdk 0.1.20 → 0.1.23

package/clients/dispatcher/action-listener.d.ts

@@ -14,6 +14,7 @@ export interface Action {
     actionPayload: string;
     workflowRunId: string;
     getGroupKeyRunId: string;
+    stepName: string;
 }
 export declare class ActionListener {
     config: ClientConfig;

package/clients/dispatcher/dispatcher-client.d.ts

@@ -1,5 +1,5 @@
 import { Channel, ClientFactory } from 'nice-grpc';
-import { DispatcherClient as PbDispatcherClient, StepActionEvent, GroupKeyActionEvent } from '../../protoc/dispatcher';
+import { DispatcherClient as PbDispatcherClient, StepActionEvent, GroupKeyActionEvent, OverridesData, DeepPartial } from '../../protoc/dispatcher';
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
 import { ActionListener } from './action-listener';
@@ -17,5 +17,6 @@ export declare class DispatcherClient {
     getActionListener(options: GetActionListenerOptions): Promise<ActionListener>;
     sendStepActionEvent(in_: StepActionEvent): Promise<import("../../protoc/dispatcher").ActionEventResponse>;
     sendGroupKeyActionEvent(in_: GroupKeyActionEvent): Promise<import("../../protoc/dispatcher").ActionEventResponse>;
+    putOverridesData(in_: DeepPartial<OverridesData>): Promise<import("../../protoc/dispatcher").OverridesDataResponse>;
 }
 export {};

package/clients/dispatcher/dispatcher-client.js

@@ -51,5 +51,15 @@ class DispatcherClient {
             }
         });
     }
+    putOverridesData(in_) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () { return this.client.putOverridesData(in_); }), this.logger);
+            }
+            catch (e) {
+                throw new hatchet_error_1.default(e.message);
+            }
+        });
+    }
 }
 exports.DispatcherClient = DispatcherClient;

package/clients/worker/worker.js

@@ -100,7 +100,7 @@ class Worker {
     handleStartStepRun(action) {
         const { actionId } = action;
         try {
-            const context = new step_1.Context(action);
+            const context = new step_1.Context(action, this.client.dispatcher);
             this.contexts[action.stepRunId] = context;
             const step = this.action_registry[actionId];
             if (!step) {
@@ -149,7 +149,7 @@ class Worker {
     handleStartGroupKeyRun(action) {
         const { actionId } = action;
         try {
-            const context = new step_1.Context(action);
+            const context = new step_1.Context(action, this.client.dispatcher);
             const key = action.getGroupKeyRunId;
             this.contexts[key] = context;
             this.logger.debug(`Starting group key run ${key}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.1.20",
+  "version": "0.1.23",
   "description": "Background task orchestration & visibility for developers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -35,6 +35,7 @@
     "event:concurrency": "npm run exec -- ./examples/concurrency/cancel-in-progress/concurrency-event.ts",
     "worker:concurrency:rr": "npm run exec -- ./examples/concurrency/group-round-robin/concurrency-worker.ts",
     "event:concurrency:rr": "npm run exec -- ./examples/concurrency/group-round-robin/concurrency-event.ts",
+    "worker:playground": "npm run exec -- ./examples/playground.ts",
     "worker:retries": "npm run exec -- ./examples/retries-worker.ts",
     "worker:multi-workflow": "npm run exec -- ./examples/multi-workflow.ts",
     "api": "npm run exec -- ./examples/api.ts",
@@ -48,7 +49,6 @@
   "devDependencies": {
     "@types/node": "^20.11.16",
     "@types/jest": "^29.5.11",
-    "@types/node": "^20.11.16",
     "@typescript-eslint/eslint-plugin": "^6.4.0",
     "autoprefixer": "^10.4.16",
     "dotenv-cli": "^7.3.0",

package/protoc/dispatcher/dispatcher.d.ts

@@ -87,6 +87,8 @@ export interface AssignedAction {
     actionType: ActionType;
     /** the action payload */
     actionPayload: string;
+    /** the step name */
+    stepName: string;
 }
 export interface WorkerListenRequest {
     /** the id of the worker */

package/protoc/dispatcher/dispatcher.js

@@ -442,6 +442,7 @@ function createBaseAssignedAction() {
         actionId: "",
         actionType: 0,
         actionPayload: "",
+        stepName: "",
     };
 }
 exports.AssignedAction = {
@@ -479,6 +480,9 @@ exports.AssignedAction = {
         if (message.actionPayload !== "") {
             writer.uint32(90).string(message.actionPayload);
         }
+        if (message.stepName !== "") {
+            writer.uint32(98).string(message.stepName);
+        }
         return writer;
     },
     decode(input, length) {
@@ -554,6 +558,12 @@ exports.AssignedAction = {
                     }
                     message.actionPayload = reader.string();
                     continue;
+                case 12:
+                    if (tag !== 98) {
+                        break;
+                    }
+                    message.stepName = reader.string();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -575,6 +585,7 @@ exports.AssignedAction = {
             actionId: isSet(object.actionId) ? globalThis.String(object.actionId) : "",
             actionType: isSet(object.actionType) ? actionTypeFromJSON(object.actionType) : 0,
             actionPayload: isSet(object.actionPayload) ? globalThis.String(object.actionPayload) : "",
+            stepName: isSet(object.stepName) ? globalThis.String(object.stepName) : "",
         };
     },
     toJSON(message) {
@@ -612,13 +623,16 @@ exports.AssignedAction = {
         if (message.actionPayload !== "") {
             obj.actionPayload = message.actionPayload;
         }
+        if (message.stepName !== "") {
+            obj.stepName = message.stepName;
+        }
         return obj;
     },
     create(base) {
         return exports.AssignedAction.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         const message = createBaseAssignedAction();
         message.tenantId = (_a = object.tenantId) !== null && _a !== void 0 ? _a : "";
         message.workflowRunId = (_b = object.workflowRunId) !== null && _b !== void 0 ? _b : "";
@@ -631,6 +645,7 @@ exports.AssignedAction = {
         message.actionId = (_j = object.actionId) !== null && _j !== void 0 ? _j : "";
         message.actionType = (_k = object.actionType) !== null && _k !== void 0 ? _k : 0;
         message.actionPayload = (_l = object.actionPayload) !== null && _l !== void 0 ? _l : "";
+        message.stepName = (_m = object.stepName) !== null && _m !== void 0 ? _m : "";
         return message;
     },
 };

package/step.d.ts

@@ -1,5 +1,6 @@
 import * as z from 'zod';
 import { Action } from './clients/dispatcher/action-listener';
+import { DispatcherClient } from './clients/dispatcher/dispatcher-client';
 export declare const CreateStepSchema: z.ZodObject<{
     name: z.ZodString;
     parents: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -16,7 +17,7 @@ export declare const CreateStepSchema: z.ZodObject<{
     timeout?: string | undefined;
     retries?: number | undefined;
 }>;
-type JSONPrimitive = string | number | boolean | null;
+type JSONPrimitive = string | number | boolean | null | Array<JSONPrimitive>;
 export type NextStep = {
     [key: string]: NextStep | JSONPrimitive;
 };
@@ -30,11 +31,17 @@ export declare class Context<T, K> {
     data: ContextData<T, K>;
     input: T;
     controller: AbortController;
-    constructor(action: Action);
-    stepOutput(step: string): string;
+    action: Action;
+    client: DispatcherClient;
+    overridesData: Record<string, any>;
+    constructor(action: Action, client: DispatcherClient);
+    stepOutput(step: string): NextStep;
     triggeredByEvent(): boolean;
     workflowInput(): T;
     userData(): K;
+    stepName(): string;
+    workflowRunId(): string;
+    playground(name: string, defaultValue?: string): string;
 }
 export type StepRunFunction<T, K> = (ctx: Context<T, K>) => Promise<NextStep> | NextStep | void;
 export interface CreateStep<T, K> extends z.infer<typeof CreateStepSchema> {

package/step.js

@@ -37,11 +37,14 @@ exports.CreateStepSchema = z.object({
     retries: z.number().optional(),
 });
 class Context {
-    constructor(action) {
+    constructor(action, client) {
         this.controller = new AbortController();
+        this.overridesData = {};
         try {
             const data = JSON.parse(JSON.parse(action.actionPayload));
             this.data = data;
+            this.action = action;
+            this.client = client;
             // if this is a getGroupKeyRunId, the data is the workflow input
             if (action.getGroupKeyRunId !== '') {
                 this.input = data;
@@ -49,6 +52,7 @@ class Context {
             else {
                 this.input = data.input;
             }
+            this.overridesData = data.overrides || {};
         }
         catch (e) {
             throw new hatchet_error_1.default(`Could not parse payload: ${e.message}`);
@@ -74,5 +78,22 @@ class Context {
         var _a;
         return (_a = this.data) === null || _a === void 0 ? void 0 : _a.user_data;
     }
+    stepName() {
+        return this.action.stepName;
+    }
+    workflowRunId() {
+        return this.action.workflowRunId;
+    }
+    playground(name, defaultValue = '') {
+        if (name in this.overridesData) {
+            return this.overridesData[name];
+        }
+        this.client.putOverridesData({
+            stepRunId: this.action.stepRunId,
+            path: name,
+            value: JSON.stringify(defaultValue),
+        });
+        return defaultValue;
+    }
 }
 exports.Context = Context;