@hatchet-dev/typescript-sdk 0.18.0 → 0.19.0

package/examples/on-failure.js

@@ -40,6 +40,8 @@ const workflow = {
         run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
             // 👀 we can do things like perform cleanup logic
             // or notify a user here
+            // 👀 you can access the error from the failed step(s) like this
+            console.log(ctx.stepRunErrors());
             return { onFailure: 'step' };
         }),
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -42,7 +42,7 @@
     "worker:affinity": "npm run exec -- ./src/examples/affinity-workers.ts",
     "worker:sticky": "npm run exec -- ./src/examples/sticky-worker.ts",
     "worker:sticky-with-check": "npm run exec -- ./src/examples/sticky-worker-with-check.ts",
-    "trigger:sticky": "npm run exec -- ./src/examples/sticky-trigger.ts", 
+    "trigger:sticky": "npm run exec -- ./src/examples/sticky-trigger.ts",
     "worker:on-failure": "npm run exec -- ./src/examples/on-failure.ts",
     "manual:trigger": "npm run exec -- ./src/examples/manual-trigger.ts",
     "manual:meta": "npm run exec -- ./src/examples/stream-by-additional-meta.ts",

package/step.d.ts

@@ -162,6 +162,7 @@ interface ContextData<T, K> {
     parents: Record<string, any>;
     triggered_by: string;
     user_data: K;
+    step_run_errors: Record<string, string>;
 }
 export declare class ContextWorker {
     private worker;
@@ -183,6 +184,7 @@ export declare class Context<T, K = {}> {
     spawnIndex: number;
     constructor(action: Action, client: HatchetClient, worker: Worker);
     stepOutput(step: string): NextStep;
+    stepRunErrors(): Record<string, string>;
     triggeredByEvent(): boolean;
     workflowInput(): T;
     workflowName(): string;

package/step.js

@@ -143,6 +143,13 @@ class Context {
         }
         return this.data.parents[step];
     }
+    stepRunErrors() {
+        const errors = this.data.step_run_errors || {};
+        if (Object.keys(errors).length === 0) {
+            this.logger.error('No step run errors found. `ctx.stepRunErrors` is intended to be run in an on-failure step, and will only work on engine versions more recent than v0.53.10');
+        }
+        return errors;
+    }
     triggeredByEvent() {
         var _a;
         return ((_a = this.data) === null || _a === void 0 ? void 0 : _a.triggered_by) === 'event';

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "0.18.0";
+export declare const HATCHET_VERSION = "0.19.0";

package/version.js

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