@hatchet-dev/typescript-sdk 0.1.12 → 0.1.14

package/clients/rest/generated/http-client.js

@@ -0,0 +1,99 @@
+"use strict";
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+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 __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpClient = exports.ContentType = void 0;
+const axios_1 = __importDefault(require("axios"));
+var ContentType;
+(function (ContentType) {
+    ContentType["Json"] = "application/json";
+    ContentType["FormData"] = "multipart/form-data";
+    ContentType["UrlEncoded"] = "application/x-www-form-urlencoded";
+    ContentType["Text"] = "text/plain";
+})(ContentType || (exports.ContentType = ContentType = {}));
+class HttpClient {
+    constructor(_a = {}) {
+        var { securityWorker, secure, format } = _a, axiosConfig = __rest(_a, ["securityWorker", "secure", "format"]);
+        this.securityData = null;
+        this.setSecurityData = (data) => {
+            this.securityData = data;
+        };
+        this.request = (_b) => __awaiter(this, void 0, void 0, function* () {
+            var { secure, path, type, query, format, body } = _b, params = __rest(_b, ["secure", "path", "type", "query", "format", "body"]);
+            const secureParams = ((typeof secure === 'boolean' ? secure : this.secure) &&
+                this.securityWorker &&
+                (yield this.securityWorker(this.securityData))) ||
+                {};
+            const requestParams = this.mergeRequestParams(params, secureParams);
+            const responseFormat = format || this.format || undefined;
+            if (type === ContentType.FormData && body && body !== null && typeof body === 'object') {
+                body = this.createFormData(body);
+            }
+            if (type === ContentType.Text && body && body !== null && typeof body !== 'string') {
+                body = JSON.stringify(body);
+            }
+            return this.instance.request(Object.assign(Object.assign({}, requestParams), { headers: Object.assign(Object.assign({}, (requestParams.headers || {})), (type && type !== ContentType.FormData ? { 'Content-Type': type } : {})), params: query, responseType: responseFormat, data: body, url: path }));
+        });
+        this.instance = axios_1.default.create(Object.assign(Object.assign({}, axiosConfig), { baseURL: axiosConfig.baseURL || '' }));
+        this.secure = secure;
+        this.format = format;
+        this.securityWorker = securityWorker;
+    }
+    mergeRequestParams(params1, params2) {
+        const method = params1.method || (params2 && params2.method);
+        return Object.assign(Object.assign(Object.assign(Object.assign({}, this.instance.defaults), params1), (params2 || {})), { headers: Object.assign(Object.assign(Object.assign({}, ((method &&
+                this.instance.defaults.headers[method.toLowerCase()]) ||
+                {})), (params1.headers || {})), ((params2 && params2.headers) || {})) });
+    }
+    stringifyFormItem(formItem) {
+        if (typeof formItem === 'object' && formItem !== null) {
+            return JSON.stringify(formItem);
+        }
+        else {
+            return `${formItem}`;
+        }
+    }
+    createFormData(input) {
+        return Object.keys(input || {}).reduce((formData, key) => {
+            const property = input[key];
+            const propertyContent = property instanceof Array ? property : [property];
+            for (const formItem of propertyContent) {
+                const isFileType = formItem instanceof Blob || formItem instanceof File;
+                formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
+            }
+            return formData;
+        }, new FormData());
+    }
+}
+exports.HttpClient = HttpClient;

package/clients/rest/index.d.ts

@@ -0,0 +1,8 @@
+import api from './api';
+import { Api } from './generated/Api';
+import { Worker as _Worker, Workflow as _Workflow } from './generated/data-contracts';
+import * as APIContracts from './generated/data-contracts';
+type ApiWorker = _Worker;
+type ApiWorkflow = _Workflow;
+export { ApiWorker, ApiWorkflow, APIContracts, Api };
+export default api;

package/clients/rest/index.js

@@ -0,0 +1,35 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Api = exports.APIContracts = void 0;
+const api_1 = __importDefault(require("./api"));
+const Api_1 = require("./generated/Api");
+Object.defineProperty(exports, "Api", { enumerable: true, get: function () { return Api_1.Api; } });
+const APIContracts = __importStar(require("./generated/data-contracts"));
+exports.APIContracts = APIContracts;
+exports.default = api_1.default;

package/clients/worker/worker.d.ts

@@ -4,7 +4,7 @@ import { StepActionEvent, StepActionEventType, GroupKeyActionEvent, GroupKeyActi
 import HatchetPromise from '../../util/hatchet-promise/hatchet-promise';
 import { Workflow } from '../../workflow';
 import { Logger } from '../../util/logger';
-import { Context } from '../../step';
+import { Context, StepRunFunction } from '../../step';
 export type ActionRegistry = Record<Action['actionId'], Function>;
 export declare class Worker {
     serviceName: string;
@@ -15,13 +15,14 @@ export declare class Worker {
     action_registry: ActionRegistry;
     listener: ActionListener | undefined;
     futures: Record<Action['stepRunId'], HatchetPromise<any>>;
-    contexts: Record<Action['stepRunId'], Context<any>>;
+    contexts: Record<Action['stepRunId'], Context<any, any>>;
     logger: Logger;
     constructor(client: HatchetClient, options: {
         name: string;
         handleKill?: boolean;
     });
     registerWorkflow(workflow: Workflow): Promise<void>;
+    registerAction<T, K>(actionId: string, action: StepRunFunction<T, K>): void;
     handleStartStepRun(action: Action): void;
     handleStartGroupKeyRun(action: Action): void;
     getStepActionEvent(action: Action, eventType: StepActionEventType, payload?: any): StepActionEvent;

package/clients/worker/worker.js

@@ -73,6 +73,8 @@ class Worker {
                                     timeout: step.timeout || '60s',
                                     inputs: '{}',
                                     parents: (_a = step.parents) !== null && _a !== void 0 ? _a : [],
+                                    userData: '{}',
+                                    retries: step.retries || 0,
                                 });
                             }),
                         },
@@ -90,6 +92,9 @@ class Worker {
                 ? Object.assign(Object.assign({}, this.action_registry), { [`${this.serviceName}:${workflow.concurrency.name}`]: workflow.concurrency.key }) : Object.assign({}, this.action_registry);
         });
     }
+    registerAction(actionId, action) {
+        this.action_registry[actionId] = action;
+    }
     handleStartStepRun(action) {
         const { actionId } = action;
         const context = new step_1.Context(action.actionPayload);

package/index.d.ts

@@ -2,4 +2,6 @@ import { HatchetClient as Hatchet } from './clients/hatchet-client';
 export * from './workflow';
 export * from './step';
 export * from './clients/worker';
+export * from './clients/rest';
+export * from './clients/admin';
 export default Hatchet;

package/index.js

@@ -18,4 +18,6 @@ const hatchet_client_1 = require("./clients/hatchet-client");
 __exportStar(require("./workflow"), exports);
 __exportStar(require("./step"), exports);
 __exportStar(require("./clients/worker"), exports);
+__exportStar(require("./clients/rest"), exports);
+__exportStar(require("./clients/admin"), exports);
 exports.default = hatchet_client_1.HatchetClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "description": "Background task orchestration & visibility for developers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,14 +33,19 @@
     "worker:dag": "npm run exec -- ./examples/dag-worker.ts",
     "worker:concurrency": "npm run exec -- ./examples/concurrency/concurrency-worker.ts",
     "event:concurrency": "npm run exec -- ./examples/concurrency/concurrency-event.ts",
+    "worker:retries": "npm run exec -- ./examples/retries-worker.ts",
+    "api": "npm run exec -- ./examples/api.ts",
     "prepublish": "cp package.json dist/package.json;",
-    "publish:ci": "rm -rf ./dist && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks"
+    "publish:ci": "rm -rf ./dist && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks",
+    "generate-docs": "typedoc"
   },
   "keywords": [],
   "author": "",
   "license": "MIT",
   "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",
@@ -62,13 +67,18 @@
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
     "ts-proto": "^1.167.0",
+    "typedoc": "^0.25.7",
+    "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "^5.3.3"
   },
   "dependencies": {
+    "@types/qs": "^6.9.11",
+    "axios": "^1.6.7",
     "long": "^5.2.3",
     "nice-grpc": "^2.1.7",
     "nice-grpc-common": "^2.0.2",
     "protobufjs": "^7.2.6",
+    "qs": "^6.11.2",
     "yaml": "^2.3.4",
     "zod": "^3.22.4"
   }

package/protoc/dispatcher/dispatcher.d.ts

@@ -152,6 +152,23 @@ export interface WorkflowEvent {
     eventTimestamp: Date | undefined;
     /** the event payload */
     eventPayload: string;
+    /**
+     * whether this is the last event for the workflow run - server
+     * will hang up the connection but clients might want to case
+     */
+    hangup: boolean;
+}
+export interface OverridesData {
+    /** the step run id */
+    stepRunId: string;
+    /** the path of the data to set */
+    path: string;
+    /** the value to set */
+    value: string;
+    /** the filename of the caller */
+    callerFilename: string;
+}
+export interface OverridesDataResponse {
 }
 export declare const WorkerRegisterRequest: {
     encode(message: WorkerRegisterRequest, writer?: _m0.Writer): _m0.Writer;
@@ -241,6 +258,22 @@ export declare const WorkflowEvent: {
     create(base?: DeepPartial<WorkflowEvent>): WorkflowEvent;
     fromPartial(object: DeepPartial<WorkflowEvent>): WorkflowEvent;
 };
+export declare const OverridesData: {
+    encode(message: OverridesData, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): OverridesData;
+    fromJSON(object: any): OverridesData;
+    toJSON(message: OverridesData): unknown;
+    create(base?: DeepPartial<OverridesData>): OverridesData;
+    fromPartial(object: DeepPartial<OverridesData>): OverridesData;
+};
+export declare const OverridesDataResponse: {
+    encode(_: OverridesDataResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): OverridesDataResponse;
+    fromJSON(_: any): OverridesDataResponse;
+    toJSON(_: OverridesDataResponse): unknown;
+    create(base?: DeepPartial<OverridesDataResponse>): OverridesDataResponse;
+    fromPartial(_: DeepPartial<OverridesDataResponse>): OverridesDataResponse;
+};
 export type DispatcherDefinition = typeof DispatcherDefinition;
 export declare const DispatcherDefinition: {
     readonly name: "Dispatcher";
@@ -356,6 +389,28 @@ export declare const DispatcherDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly putOverridesData: {
+            readonly name: "PutOverridesData";
+            readonly requestType: {
+                encode(message: OverridesData, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): OverridesData;
+                fromJSON(object: any): OverridesData;
+                toJSON(message: OverridesData): unknown;
+                create(base?: DeepPartial<OverridesData>): OverridesData;
+                fromPartial(object: DeepPartial<OverridesData>): OverridesData;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(_: OverridesDataResponse, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): OverridesDataResponse;
+                fromJSON(_: any): OverridesDataResponse;
+                toJSON(_: OverridesDataResponse): unknown;
+                create(base?: DeepPartial<OverridesDataResponse>): OverridesDataResponse;
+                fromPartial(_: DeepPartial<OverridesDataResponse>): OverridesDataResponse;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly unsubscribe: {
             readonly name: "Unsubscribe";
             readonly requestType: {
@@ -386,6 +441,7 @@ export interface DispatcherServiceImplementation<CallContextExt = {}> {
     subscribeToWorkflowEvents(request: SubscribeToWorkflowEventsRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<WorkflowEvent>>;
     sendStepActionEvent(request: StepActionEvent, context: CallContext & CallContextExt): Promise<DeepPartial<ActionEventResponse>>;
     sendGroupKeyActionEvent(request: GroupKeyActionEvent, context: CallContext & CallContextExt): Promise<DeepPartial<ActionEventResponse>>;
+    putOverridesData(request: OverridesData, context: CallContext & CallContextExt): Promise<DeepPartial<OverridesDataResponse>>;
     unsubscribe(request: WorkerUnsubscribeRequest, context: CallContext & CallContextExt): Promise<DeepPartial<WorkerUnsubscribeResponse>>;
 }
 export interface DispatcherClient<CallOptionsExt = {}> {
@@ -394,6 +450,7 @@ export interface DispatcherClient<CallOptionsExt = {}> {
     subscribeToWorkflowEvents(request: DeepPartial<SubscribeToWorkflowEventsRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<WorkflowEvent>;
     sendStepActionEvent(request: DeepPartial<StepActionEvent>, options?: CallOptions & CallOptionsExt): Promise<ActionEventResponse>;
     sendGroupKeyActionEvent(request: DeepPartial<GroupKeyActionEvent>, options?: CallOptions & CallOptionsExt): Promise<ActionEventResponse>;
+    putOverridesData(request: DeepPartial<OverridesData>, options?: CallOptions & CallOptionsExt): Promise<OverridesDataResponse>;
     unsubscribe(request: DeepPartial<WorkerUnsubscribeRequest>, options?: CallOptions & CallOptionsExt): Promise<WorkerUnsubscribeResponse>;
 }
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;

package/protoc/dispatcher/dispatcher.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DispatcherDefinition = exports.WorkflowEvent = exports.SubscribeToWorkflowEventsRequest = exports.ActionEventResponse = exports.StepActionEvent = exports.GroupKeyActionEvent = exports.WorkerUnsubscribeResponse = exports.WorkerUnsubscribeRequest = exports.WorkerListenRequest = exports.AssignedAction = exports.WorkerRegisterResponse = exports.WorkerRegisterRequest = exports.resourceEventTypeToJSON = exports.resourceEventTypeFromJSON = exports.ResourceEventType = exports.resourceTypeToJSON = exports.resourceTypeFromJSON = exports.ResourceType = exports.stepActionEventTypeToJSON = exports.stepActionEventTypeFromJSON = exports.StepActionEventType = exports.groupKeyActionEventTypeToJSON = exports.groupKeyActionEventTypeFromJSON = exports.GroupKeyActionEventType = exports.actionTypeToJSON = exports.actionTypeFromJSON = exports.ActionType = exports.protobufPackage = void 0;
+exports.DispatcherDefinition = exports.OverridesDataResponse = exports.OverridesData = exports.WorkflowEvent = exports.SubscribeToWorkflowEventsRequest = exports.ActionEventResponse = exports.StepActionEvent = exports.GroupKeyActionEvent = exports.WorkerUnsubscribeResponse = exports.WorkerUnsubscribeRequest = exports.WorkerListenRequest = exports.AssignedAction = exports.WorkerRegisterResponse = exports.WorkerRegisterRequest = exports.resourceEventTypeToJSON = exports.resourceEventTypeFromJSON = exports.ResourceEventType = exports.resourceTypeToJSON = exports.resourceTypeFromJSON = exports.ResourceType = exports.stepActionEventTypeToJSON = exports.stepActionEventTypeFromJSON = exports.StepActionEventType = exports.groupKeyActionEventTypeToJSON = exports.groupKeyActionEventTypeFromJSON = exports.GroupKeyActionEventType = exports.actionTypeToJSON = exports.actionTypeFromJSON = exports.ActionType = exports.protobufPackage = void 0;
 const _m0 = __importStar(require("protobufjs/minimal"));
 const timestamp_1 = require("../google/protobuf/timestamp");
 exports.protobufPackage = "";
@@ -1235,6 +1235,7 @@ function createBaseWorkflowEvent() {
         resourceId: "",
         eventTimestamp: undefined,
         eventPayload: "",
+        hangup: false,
     };
 }
 exports.WorkflowEvent = {
@@ -1257,6 +1258,9 @@ exports.WorkflowEvent = {
         if (message.eventPayload !== "") {
             writer.uint32(50).string(message.eventPayload);
         }
+        if (message.hangup === true) {
+            writer.uint32(56).bool(message.hangup);
+        }
         return writer;
     },
     decode(input, length) {
@@ -1302,6 +1306,12 @@ exports.WorkflowEvent = {
                     }
                     message.eventPayload = reader.string();
                     continue;
+                case 7:
+                    if (tag !== 56) {
+                        break;
+                    }
+                    message.hangup = reader.bool();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1318,6 +1328,7 @@ exports.WorkflowEvent = {
             resourceId: isSet(object.resourceId) ? globalThis.String(object.resourceId) : "",
             eventTimestamp: isSet(object.eventTimestamp) ? fromJsonTimestamp(object.eventTimestamp) : undefined,
             eventPayload: isSet(object.eventPayload) ? globalThis.String(object.eventPayload) : "",
+            hangup: isSet(object.hangup) ? globalThis.Boolean(object.hangup) : false,
         };
     },
     toJSON(message) {
@@ -1340,13 +1351,16 @@ exports.WorkflowEvent = {
         if (message.eventPayload !== "") {
             obj.eventPayload = message.eventPayload;
         }
+        if (message.hangup === true) {
+            obj.hangup = message.hangup;
+        }
         return obj;
     },
     create(base) {
         return exports.WorkflowEvent.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         const message = createBaseWorkflowEvent();
         message.workflowRunId = (_a = object.workflowRunId) !== null && _a !== void 0 ? _a : "";
         message.resourceType = (_b = object.resourceType) !== null && _b !== void 0 ? _b : 0;
@@ -1354,6 +1368,139 @@ exports.WorkflowEvent = {
         message.resourceId = (_d = object.resourceId) !== null && _d !== void 0 ? _d : "";
         message.eventTimestamp = (_e = object.eventTimestamp) !== null && _e !== void 0 ? _e : undefined;
         message.eventPayload = (_f = object.eventPayload) !== null && _f !== void 0 ? _f : "";
+        message.hangup = (_g = object.hangup) !== null && _g !== void 0 ? _g : false;
+        return message;
+    },
+};
+function createBaseOverridesData() {
+    return { stepRunId: "", path: "", value: "", callerFilename: "" };
+}
+exports.OverridesData = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.stepRunId !== "") {
+            writer.uint32(10).string(message.stepRunId);
+        }
+        if (message.path !== "") {
+            writer.uint32(18).string(message.path);
+        }
+        if (message.value !== "") {
+            writer.uint32(26).string(message.value);
+        }
+        if (message.callerFilename !== "") {
+            writer.uint32(34).string(message.callerFilename);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseOverridesData();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.stepRunId = reader.string();
+                    continue;
+                case 2:
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.path = reader.string();
+                    continue;
+                case 3:
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.value = reader.string();
+                    continue;
+                case 4:
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.callerFilename = reader.string();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            stepRunId: isSet(object.stepRunId) ? globalThis.String(object.stepRunId) : "",
+            path: isSet(object.path) ? globalThis.String(object.path) : "",
+            value: isSet(object.value) ? globalThis.String(object.value) : "",
+            callerFilename: isSet(object.callerFilename) ? globalThis.String(object.callerFilename) : "",
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.stepRunId !== "") {
+            obj.stepRunId = message.stepRunId;
+        }
+        if (message.path !== "") {
+            obj.path = message.path;
+        }
+        if (message.value !== "") {
+            obj.value = message.value;
+        }
+        if (message.callerFilename !== "") {
+            obj.callerFilename = message.callerFilename;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.OverridesData.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b, _c, _d;
+        const message = createBaseOverridesData();
+        message.stepRunId = (_a = object.stepRunId) !== null && _a !== void 0 ? _a : "";
+        message.path = (_b = object.path) !== null && _b !== void 0 ? _b : "";
+        message.value = (_c = object.value) !== null && _c !== void 0 ? _c : "";
+        message.callerFilename = (_d = object.callerFilename) !== null && _d !== void 0 ? _d : "";
+        return message;
+    },
+};
+function createBaseOverridesDataResponse() {
+    return {};
+}
+exports.OverridesDataResponse = {
+    encode(_, writer = _m0.Writer.create()) {
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseOverridesDataResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(_) {
+        return {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.OverridesDataResponse.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(_) {
+        const message = createBaseOverridesDataResponse();
         return message;
     },
 };
@@ -1401,6 +1548,14 @@ exports.DispatcherDefinition = {
             responseStream: false,
             options: {},
         },
+        putOverridesData: {
+            name: "PutOverridesData",
+            requestType: exports.OverridesData,
+            requestStream: false,
+            responseType: exports.OverridesDataResponse,
+            responseStream: false,
+            options: {},
+        },
         unsubscribe: {
             name: "Unsubscribe",
             requestType: exports.WorkerUnsubscribeRequest,

package/protoc/workflows/workflows.d.ts

@@ -62,6 +62,10 @@ export interface CreateWorkflowStepOpts {
     inputs: string;
     /** (optional) the step parents. if none are passed in, this is a root step */
     parents: string[];
+    /** (optional) the custom step user data, assuming string representation of JSON */
+    userData: string;
+    /** (optional) the number of retries for the step, default 0 */
+    retries: number;
 }
 /** ListWorkflowsRequest is the request for ListWorkflows. */
 export interface ListWorkflowsRequest {

package/protoc/workflows/workflows.js

@@ -470,7 +470,7 @@ exports.CreateWorkflowJobOpts = {
     },
 };
 function createBaseCreateWorkflowStepOpts() {
-    return { readableId: "", action: "", timeout: "", inputs: "", parents: [] };
+    return { readableId: "", action: "", timeout: "", inputs: "", parents: [], userData: "", retries: 0 };
 }
 exports.CreateWorkflowStepOpts = {
     encode(message, writer = _m0.Writer.create()) {
@@ -489,6 +489,12 @@ exports.CreateWorkflowStepOpts = {
         for (const v of message.parents) {
             writer.uint32(42).string(v);
         }
+        if (message.userData !== "") {
+            writer.uint32(50).string(message.userData);
+        }
+        if (message.retries !== 0) {
+            writer.uint32(56).int32(message.retries);
+        }
         return writer;
     },
     decode(input, length) {
@@ -528,6 +534,18 @@ exports.CreateWorkflowStepOpts = {
                     }
                     message.parents.push(reader.string());
                     continue;
+                case 6:
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.userData = reader.string();
+                    continue;
+                case 7:
+                    if (tag !== 56) {
+                        break;
+                    }
+                    message.retries = reader.int32();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -543,6 +561,8 @@ exports.CreateWorkflowStepOpts = {
             timeout: isSet(object.timeout) ? globalThis.String(object.timeout) : "",
             inputs: isSet(object.inputs) ? globalThis.String(object.inputs) : "",
             parents: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.parents) ? object.parents.map((e) => globalThis.String(e)) : [],
+            userData: isSet(object.userData) ? globalThis.String(object.userData) : "",
+            retries: isSet(object.retries) ? globalThis.Number(object.retries) : 0,
         };
     },
     toJSON(message) {
@@ -563,19 +583,27 @@ exports.CreateWorkflowStepOpts = {
         if ((_a = message.parents) === null || _a === void 0 ? void 0 : _a.length) {
             obj.parents = message.parents;
         }
+        if (message.userData !== "") {
+            obj.userData = message.userData;
+        }
+        if (message.retries !== 0) {
+            obj.retries = Math.round(message.retries);
+        }
         return obj;
     },
     create(base) {
         return exports.CreateWorkflowStepOpts.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f, _g;
         const message = createBaseCreateWorkflowStepOpts();
         message.readableId = (_a = object.readableId) !== null && _a !== void 0 ? _a : "";
         message.action = (_b = object.action) !== null && _b !== void 0 ? _b : "";
         message.timeout = (_c = object.timeout) !== null && _c !== void 0 ? _c : "";
         message.inputs = (_d = object.inputs) !== null && _d !== void 0 ? _d : "";
         message.parents = ((_e = object.parents) === null || _e === void 0 ? void 0 : _e.map((e) => e)) || [];
+        message.userData = (_f = object.userData) !== null && _f !== void 0 ? _f : "";
+        message.retries = (_g = object.retries) !== null && _g !== void 0 ? _g : 0;
         return message;
     },
 };