@hatchet-dev/typescript-sdk 0.12.3 → 0.12.5

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

@@ -39,13 +39,13 @@ export declare class AdminClient {
     /**
      * @deprecated use putWorkflow instead
      */
-    put_workflow(opts: CreateWorkflowVersionOpts): Promise<void>;
+    put_workflow(opts: CreateWorkflowVersionOpts): Promise<import("../../protoc/workflows").WorkflowVersion>;
     /**
      * Creates a new workflow or updates an existing workflow. If the workflow already exists, Hatchet will automatically
      * determine if the workflow definition has changed and create a new version if necessary.
      * @param workflow a workflow definition to create
      */
-    putWorkflow(workflow: CreateWorkflowVersionOpts): Promise<void>;
+    putWorkflow(workflow: CreateWorkflowVersionOpts): Promise<import("../../protoc/workflows").WorkflowVersion>;
     /**
      * @deprecated use putRateLimit instead
      */

package/clients/admin/admin-client.js

@@ -59,7 +59,7 @@ class AdminClient {
     putWorkflow(workflow) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () { return this.client.putWorkflow({ opts: workflow }); }), this.logger);
+                return yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () { return this.client.putWorkflow({ opts: workflow }); }), this.logger);
             }
             catch (e) {
                 throw new hatchet_error_1.default(e.message);

package/clients/dispatcher/action-listener.js

@@ -19,7 +19,7 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
 var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
     if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
     var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
     function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
     function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
     function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }

package/clients/hatchet-client/hatchet-client.js

@@ -24,7 +24,7 @@ var __asyncDelegator = (this && this.__asyncDelegator) || function (o) {
 var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
     if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
     var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
     function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
     function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
     function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }

package/clients/listener/child-listener-client.js

@@ -12,7 +12,7 @@ var __await = (this && this.__await) || function (v) { return this instanceof __
 var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
     if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
     var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
     function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
     function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
     function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }

package/clients/listener/listener-client.js

@@ -19,7 +19,7 @@ var __await = (this && this.__await) || function (v) { return this instanceof __
 var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
     if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
     var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
     function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
     function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
     function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }

package/examples/fanout-worker.js

@@ -29,7 +29,7 @@ const parentWorkflow = {
             timeout: '10s',
             run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
                 ctx.putStream('spawning children');
-                const promises = Array.from({ length: 7 }, (_, i) => ctx.spawnWorkflow('child-workflow', { input: `child-input-${i}` }).result());
+                const promises = Array.from({ length: 7 }, (_, i) => ctx.spawnWorkflow('child-workflow', { input: `child-input-${i}` }, { additionalMetadata: { childKey: "childValue" } }).result());
                 const results = yield Promise.all(promises);
                 console.log('spawned workflow results:', results);
                 console.log('number of spawned workflows:', results.length);

package/package.json

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

package/step.d.ts

@@ -167,6 +167,7 @@ export declare class Context<T, K = {}> {
     spawnWorkflow<Q = JsonValue, P = JsonValue>(workflow: string | Workflow, input: Q, options?: string | {
         key?: string;
         sticky?: boolean;
+        additionalMetadata?: Record<string, string>;
     }): WorkflowRunRef<P>;
     additionalMetadata(): Record<string, string>;
     childIndex(): number | undefined;

package/step.js

@@ -225,6 +225,7 @@ class Context {
         const name = this.client.config.namespace + workflowName;
         let key = '';
         let sticky = false;
+        let metadata = undefined;
         if (typeof options === 'string') {
             this.logger.warn('Using key param is deprecated and will be removed in a future release. Use options.key instead.');
             key = options;
@@ -232,6 +233,7 @@ class Context {
         else {
             key = options === null || options === void 0 ? void 0 : options.key;
             sticky = options === null || options === void 0 ? void 0 : options.sticky;
+            metadata = options === null || options === void 0 ? void 0 : options.additionalMetadata;
         }
         if (sticky && !this.worker.hasWorkflow(name)) {
             throw new hatchet_error_1.default(`cannot run with sticky: workflow ${name} is not registered on the worker`);
@@ -243,6 +245,7 @@ class Context {
                 childKey: key,
                 childIndex: this.spawnIndex,
                 desiredWorkerId: sticky ? this.worker.id() : undefined,
+                additionalMetadata: metadata,
             });
             this.spawnIndex += 1;
             return resp;