@hatchet-dev/typescript-sdk 0.5.7 → 0.6.0

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

@@ -52,6 +52,7 @@ export declare class AdminClient {
         parentStepRunId?: string | undefined;
         childIndex?: number | undefined;
         childKey?: string | undefined;
+        additionalMetadata?: Record<string, string> | undefined;
     }): Promise<string>;
     /**
      * List workflows in the tenant associated with the API token.

package/clients/admin/admin-client.js

@@ -83,7 +83,9 @@ class AdminClient {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const inputStr = JSON.stringify(input);
-                const resp = yield this.client.triggerWorkflow(Object.assign({ name: workflowName, input: inputStr }, options));
+                const resp = yield this.client.triggerWorkflow(Object.assign(Object.assign({ name: workflowName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
+                        ? JSON.stringify(options === null || options === void 0 ? void 0 : options.additionalMetadata)
+                        : undefined }));
                 return resp.workflowRunId;
             }
             catch (e) {

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

@@ -8,12 +8,15 @@ export declare enum LogLevel {
     ERROR = "ERROR",
     DEBUG = "DEBUG"
 }
+export interface PushEventOptions {
+    additionalMetadata?: Record<string, string>;
+}
 export declare class EventClient {
     config: ClientConfig;
     client: EventsServiceClient;
     logger: Logger;
     constructor(config: ClientConfig, channel: Channel, factory: ClientFactory);
-    push<T>(type: string, input: T): Promise<import("../../protoc/events/events").Event>;
+    push<T>(type: string, input: T, options?: PushEventOptions): Promise<import("../../protoc/events/events").Event>;
     putLog(stepRunId: string, log: string, level?: LogLevel): void;
     putStream(stepRunId: string, data: string | Uint8Array): void;
 }

package/clients/event/event-client.js

@@ -31,13 +31,16 @@ class EventClient {
         this.client = factory.create(events_1.EventsServiceDefinition, channel);
         this.logger = new logger_1.Logger(`Dispatcher`, config.log_level);
     }
-    push(type, input) {
+    push(type, input, options = {}) {
         var _a;
         const namespacedType = `${(_a = this.config.namespace) !== null && _a !== void 0 ? _a : ''}${type}`;
         const req = {
             key: namespacedType,
             payload: JSON.stringify(input),
             eventTimestamp: new Date(),
+            additionalMetadata: options.additionalMetadata
+                ? JSON.stringify(options.additionalMetadata)
+                : undefined,
         };
         try {
             const e = this.client.push(req);

package/clients/worker/worker.js

@@ -49,7 +49,7 @@ class Worker {
         });
     }
     register_workflow(initWorkflow) {
-        var _a, _b;
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             const workflow = Object.assign(Object.assign({}, initWorkflow), { id: this.client.config.namespace + initWorkflow.id });
             try {
@@ -60,6 +60,24 @@ class Worker {
                         limitStrategy: workflow.concurrency.limitStrategy || workflows_1.ConcurrencyLimitStrategy.CANCEL_IN_PROGRESS,
                     }
                     : undefined;
+                const onFailureJob = workflow.onFailure
+                    ? {
+                        name: `${workflow.id}-on-failure`,
+                        description: workflow.description,
+                        steps: [
+                            {
+                                readableId: workflow.onFailure.name,
+                                action: `${workflow.id}-on-failure:${workflow.onFailure.name}`,
+                                timeout: workflow.onFailure.timeout || '60s',
+                                inputs: '{}',
+                                parents: [],
+                                userData: '{}',
+                                retries: workflow.onFailure.retries || 0,
+                                rateLimits: (_b = workflow.onFailure.rate_limits) !== null && _b !== void 0 ? _b : [],
+                            },
+                        ],
+                    }
+                    : undefined;
                 const registeredWorkflow = this.client.admin.put_workflow({
                     name: workflow.id,
                     description: workflow.description,
@@ -69,6 +87,7 @@ class Worker {
                     scheduledTriggers: [],
                     concurrency,
                     scheduleTimeout: workflow.scheduleTimeout,
+                    onFailureJob,
                     jobs: [
                         {
                             name: workflow.id,
@@ -99,8 +118,13 @@ class Worker {
                 acc[`${workflow.id}:${step.name}`] = step.run;
                 return acc;
             }, {});
-            this.action_registry = Object.assign(Object.assign({}, this.action_registry), newActions);
-            this.action_registry = ((_b = workflow.concurrency) === null || _b === void 0 ? void 0 : _b.name)
+            const onFailureAction = workflow.onFailure
+                ? {
+                    [`${workflow.id}-on-failure:${workflow.onFailure.name}`]: workflow.onFailure.run,
+                }
+                : {};
+            this.action_registry = Object.assign(Object.assign(Object.assign({}, this.action_registry), newActions), onFailureAction);
+            this.action_registry = ((_c = workflow.concurrency) === null || _c === void 0 ? void 0 : _c.name)
                 ? Object.assign(Object.assign({}, this.action_registry), { [`${workflow.id}:${workflow.concurrency.name}`]: workflow.concurrency.key }) : Object.assign({}, this.action_registry);
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.5.7",
+  "version": "0.6.0",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -38,6 +38,7 @@
     "example:rate": "npm run exec -- ./examples/rate-limit/events.ts",
     "worker:fanout": "npm run exec -- ./examples/fanout-worker.ts",
     "worker:simple": "npm run exec -- ./examples/simple-worker.ts",
+    "worker:on-failure": "npm run exec -- ./examples/on-failure.ts",
     "manual:trigger": "npm run exec -- ./examples/manual-trigger.ts",
     "worker:dag": "npm run exec -- ./examples/dag-worker.ts",
     "worker:concurrency": "npm run exec -- ./examples/concurrency/cancel-in-progress/concurrency-worker.ts",

package/protoc/events/events.d.ts

@@ -12,6 +12,8 @@ export interface Event {
     payload: string;
     /** when the event was generated */
     eventTimestamp: Date | undefined;
+    /** the payload for the event */
+    additionalMetadata?: string | undefined;
 }
 export interface PutLogRequest {
     /** the step run id for the request */
@@ -46,6 +48,8 @@ export interface PushEventRequest {
     payload: string;
     /** when the event was generated */
     eventTimestamp: Date | undefined;
+    /** metadata for the event */
+    additionalMetadata?: string | undefined;
 }
 export interface ReplayEventRequest {
     /** the event id to replay */

package/protoc/events/events.js

@@ -28,7 +28,14 @@ const _m0 = __importStar(require("protobufjs/minimal"));
 const timestamp_1 = require("../google/protobuf/timestamp");
 exports.protobufPackage = '';
 function createBaseEvent() {
-    return { tenantId: '', eventId: '', key: '', payload: '', eventTimestamp: undefined };
+    return {
+        tenantId: '',
+        eventId: '',
+        key: '',
+        payload: '',
+        eventTimestamp: undefined,
+        additionalMetadata: undefined,
+    };
 }
 exports.Event = {
     encode(message, writer = _m0.Writer.create()) {
@@ -47,6 +54,9 @@ exports.Event = {
         if (message.eventTimestamp !== undefined) {
             timestamp_1.Timestamp.encode(toTimestamp(message.eventTimestamp), writer.uint32(42).fork()).ldelim();
         }
+        if (message.additionalMetadata !== undefined) {
+            writer.uint32(50).string(message.additionalMetadata);
+        }
         return writer;
     },
     decode(input, length) {
@@ -86,6 +96,12 @@ exports.Event = {
                     }
                     message.eventTimestamp = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
                     continue;
+                case 6:
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.additionalMetadata = reader.string();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -103,6 +119,9 @@ exports.Event = {
             eventTimestamp: isSet(object.eventTimestamp)
                 ? fromJsonTimestamp(object.eventTimestamp)
                 : undefined,
+            additionalMetadata: isSet(object.additionalMetadata)
+                ? globalThis.String(object.additionalMetadata)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -122,19 +141,23 @@ exports.Event = {
         if (message.eventTimestamp !== undefined) {
             obj.eventTimestamp = message.eventTimestamp.toISOString();
         }
+        if (message.additionalMetadata !== undefined) {
+            obj.additionalMetadata = message.additionalMetadata;
+        }
         return obj;
     },
     create(base) {
         return exports.Event.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         const message = createBaseEvent();
         message.tenantId = (_a = object.tenantId) !== null && _a !== void 0 ? _a : '';
         message.eventId = (_b = object.eventId) !== null && _b !== void 0 ? _b : '';
         message.key = (_c = object.key) !== null && _c !== void 0 ? _c : '';
         message.payload = (_d = object.payload) !== null && _d !== void 0 ? _d : '';
         message.eventTimestamp = (_e = object.eventTimestamp) !== null && _e !== void 0 ? _e : undefined;
+        message.additionalMetadata = (_f = object.additionalMetadata) !== null && _f !== void 0 ? _f : undefined;
         return message;
     },
 };
@@ -417,7 +440,7 @@ exports.PutStreamEventResponse = {
     },
 };
 function createBasePushEventRequest() {
-    return { key: '', payload: '', eventTimestamp: undefined };
+    return { key: '', payload: '', eventTimestamp: undefined, additionalMetadata: undefined };
 }
 exports.PushEventRequest = {
     encode(message, writer = _m0.Writer.create()) {
@@ -430,6 +453,9 @@ exports.PushEventRequest = {
         if (message.eventTimestamp !== undefined) {
             timestamp_1.Timestamp.encode(toTimestamp(message.eventTimestamp), writer.uint32(26).fork()).ldelim();
         }
+        if (message.additionalMetadata !== undefined) {
+            writer.uint32(34).string(message.additionalMetadata);
+        }
         return writer;
     },
     decode(input, length) {
@@ -457,6 +483,12 @@ exports.PushEventRequest = {
                     }
                     message.eventTimestamp = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
                     continue;
+                case 4:
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.additionalMetadata = reader.string();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -472,6 +504,9 @@ exports.PushEventRequest = {
             eventTimestamp: isSet(object.eventTimestamp)
                 ? fromJsonTimestamp(object.eventTimestamp)
                 : undefined,
+            additionalMetadata: isSet(object.additionalMetadata)
+                ? globalThis.String(object.additionalMetadata)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -485,17 +520,21 @@ exports.PushEventRequest = {
         if (message.eventTimestamp !== undefined) {
             obj.eventTimestamp = message.eventTimestamp.toISOString();
         }
+        if (message.additionalMetadata !== undefined) {
+            obj.additionalMetadata = message.additionalMetadata;
+        }
         return obj;
     },
     create(base) {
         return exports.PushEventRequest.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         const message = createBasePushEventRequest();
         message.key = (_a = object.key) !== null && _a !== void 0 ? _a : '';
         message.payload = (_b = object.payload) !== null && _b !== void 0 ? _b : '';
         message.eventTimestamp = (_c = object.eventTimestamp) !== null && _c !== void 0 ? _c : undefined;
+        message.additionalMetadata = (_d = object.additionalMetadata) !== null && _d !== void 0 ? _d : undefined;
         return message;
     },
 };

package/protoc/workflows/workflows.d.ts

@@ -43,6 +43,8 @@ export interface CreateWorkflowVersionOpts {
     scheduleTimeout?: string | undefined;
     /** (optional) the input for the cron trigger */
     cronInput?: string | undefined;
+    /** (optional) the job to run on failure */
+    onFailureJob?: CreateWorkflowJobOpts | undefined;
 }
 export interface WorkflowConcurrencyOpts {
     /** (required) the action id for getting the concurrency group */
@@ -148,6 +150,8 @@ export interface TriggerWorkflowRequest {
      * child index/key match an existing workflow run.
      */
     childKey?: string | undefined;
+    /** (optional) additional metadata for the workflow */
+    additionalMetadata?: string | undefined;
 }
 export interface TriggerWorkflowResponse {
     workflowRunId: string;

package/protoc/workflows/workflows.js

@@ -178,6 +178,7 @@ function createBaseCreateWorkflowVersionOpts() {
         concurrency: undefined,
         scheduleTimeout: undefined,
         cronInput: undefined,
+        onFailureJob: undefined,
     };
 }
 exports.CreateWorkflowVersionOpts = {
@@ -212,6 +213,9 @@ exports.CreateWorkflowVersionOpts = {
         if (message.cronInput !== undefined) {
             writer.uint32(82).string(message.cronInput);
         }
+        if (message.onFailureJob !== undefined) {
+            exports.CreateWorkflowJobOpts.encode(message.onFailureJob, writer.uint32(90).fork()).ldelim();
+        }
         return writer;
     },
     decode(input, length) {
@@ -281,6 +285,12 @@ exports.CreateWorkflowVersionOpts = {
                     }
                     message.cronInput = reader.string();
                     continue;
+                case 11:
+                    if (tag !== 90) {
+                        break;
+                    }
+                    message.onFailureJob = exports.CreateWorkflowJobOpts.decode(reader, reader.uint32());
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -313,6 +323,9 @@ exports.CreateWorkflowVersionOpts = {
                 ? globalThis.String(object.scheduleTimeout)
                 : undefined,
             cronInput: isSet(object.cronInput) ? globalThis.String(object.cronInput) : undefined,
+            onFailureJob: isSet(object.onFailureJob)
+                ? exports.CreateWorkflowJobOpts.fromJSON(object.onFailureJob)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -348,6 +361,9 @@ exports.CreateWorkflowVersionOpts = {
         if (message.cronInput !== undefined) {
             obj.cronInput = message.cronInput;
         }
+        if (message.onFailureJob !== undefined) {
+            obj.onFailureJob = exports.CreateWorkflowJobOpts.toJSON(message.onFailureJob);
+        }
         return obj;
     },
     create(base) {
@@ -369,6 +385,10 @@ exports.CreateWorkflowVersionOpts = {
                 : undefined;
         message.scheduleTimeout = (_h = object.scheduleTimeout) !== null && _h !== void 0 ? _h : undefined;
         message.cronInput = (_j = object.cronInput) !== null && _j !== void 0 ? _j : undefined;
+        message.onFailureJob =
+            object.onFailureJob !== undefined && object.onFailureJob !== null
+                ? exports.CreateWorkflowJobOpts.fromPartial(object.onFailureJob)
+                : undefined;
         return message;
     },
 };
@@ -1230,6 +1250,7 @@ function createBaseTriggerWorkflowRequest() {
         parentStepRunId: undefined,
         childIndex: undefined,
         childKey: undefined,
+        additionalMetadata: undefined,
     };
 }
 exports.TriggerWorkflowRequest = {
@@ -1252,6 +1273,9 @@ exports.TriggerWorkflowRequest = {
         if (message.childKey !== undefined) {
             writer.uint32(50).string(message.childKey);
         }
+        if (message.additionalMetadata !== undefined) {
+            writer.uint32(58).string(message.additionalMetadata);
+        }
         return writer;
     },
     decode(input, length) {
@@ -1297,6 +1321,12 @@ exports.TriggerWorkflowRequest = {
                     }
                     message.childKey = reader.string();
                     continue;
+                case 7:
+                    if (tag !== 58) {
+                        break;
+                    }
+                    message.additionalMetadata = reader.string();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1315,6 +1345,9 @@ exports.TriggerWorkflowRequest = {
                 : undefined,
             childIndex: isSet(object.childIndex) ? globalThis.Number(object.childIndex) : undefined,
             childKey: isSet(object.childKey) ? globalThis.String(object.childKey) : undefined,
+            additionalMetadata: isSet(object.additionalMetadata)
+                ? globalThis.String(object.additionalMetadata)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -1337,13 +1370,16 @@ exports.TriggerWorkflowRequest = {
         if (message.childKey !== undefined) {
             obj.childKey = message.childKey;
         }
+        if (message.additionalMetadata !== undefined) {
+            obj.additionalMetadata = message.additionalMetadata;
+        }
         return obj;
     },
     create(base) {
         return exports.TriggerWorkflowRequest.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 = createBaseTriggerWorkflowRequest();
         message.name = (_a = object.name) !== null && _a !== void 0 ? _a : '';
         message.input = (_b = object.input) !== null && _b !== void 0 ? _b : '';
@@ -1351,6 +1387,7 @@ exports.TriggerWorkflowRequest = {
         message.parentStepRunId = (_d = object.parentStepRunId) !== null && _d !== void 0 ? _d : undefined;
         message.childIndex = (_e = object.childIndex) !== null && _e !== void 0 ? _e : undefined;
         message.childKey = (_f = object.childKey) !== null && _f !== void 0 ? _f : undefined;
+        message.additionalMetadata = (_g = object.additionalMetadata) !== null && _g !== void 0 ? _g : undefined;
         return message;
     },
 };

package/workflow.d.ts

@@ -56,6 +56,9 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
     description: z.ZodString;
     version: z.ZodOptional<z.ZodString>;
     scheduleTimeout: z.ZodOptional<z.ZodString>;
+    /**
+     * @deprecated Workflow timeout is deprecated. Use step timeouts instead.
+     */
     timeout: z.ZodOptional<z.ZodString>;
     on: z.ZodUnion<[z.ZodObject<{
         cron: z.ZodString;
@@ -110,6 +113,40 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
             units: number;
         }[] | undefined;
     }>, "many">;
+    onFailure: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        parents: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        timeout: z.ZodOptional<z.ZodString>;
+        retries: z.ZodOptional<z.ZodNumber>;
+        rate_limits: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            units: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            key: string;
+            units: number;
+        }, {
+            key: string;
+            units: number;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        parents?: string[] | undefined;
+        timeout?: string | undefined;
+        retries?: number | undefined;
+        rate_limits?: {
+            key: string;
+            units: number;
+        }[] | undefined;
+    }, {
+        name: string;
+        parents?: string[] | undefined;
+        timeout?: string | undefined;
+        retries?: number | undefined;
+        rate_limits?: {
+            key: string;
+            units: number;
+        }[] | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     description: string;
     steps: {
@@ -133,6 +170,16 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
     version?: string | undefined;
     scheduleTimeout?: string | undefined;
     timeout?: string | undefined;
+    onFailure?: {
+        name: string;
+        parents?: string[] | undefined;
+        timeout?: string | undefined;
+        retries?: number | undefined;
+        rate_limits?: {
+            key: string;
+            units: number;
+        }[] | undefined;
+    } | undefined;
 }, {
     description: string;
     steps: {
@@ -156,11 +203,22 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
     version?: string | undefined;
     scheduleTimeout?: string | undefined;
     timeout?: string | undefined;
+    onFailure?: {
+        name: string;
+        parents?: string[] | undefined;
+        timeout?: string | undefined;
+        retries?: number | undefined;
+        rate_limits?: {
+            key: string;
+            units: number;
+        }[] | undefined;
+    } | undefined;
 }>;
 export interface Workflow extends z.infer<typeof CreateWorkflowSchema> {
     concurrency?: z.infer<typeof WorkflowConcurrency> & {
         key: (ctx: any) => string;
     };
     steps: CreateStep<any, any>[];
+    onFailure?: CreateStep<any, any>;
 }
 export {};

package/workflow.js

@@ -49,7 +49,11 @@ exports.CreateWorkflowSchema = z.object({
     description: z.string(),
     version: z.string().optional(),
     scheduleTimeout: z.string().optional(),
+    /**
+     * @deprecated Workflow timeout is deprecated. Use step timeouts instead.
+     */
     timeout: exports.HatchetTimeoutSchema.optional(),
     on: OnConfigSchema,
     steps: StepsSchema,
+    onFailure: step_1.CreateStepSchema === null || step_1.CreateStepSchema === void 0 ? void 0 : step_1.CreateStepSchema.optional(),
 });