@hatchet-dev/typescript-sdk 1.9.0 → 1.9.1

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

@@ -27,7 +27,7 @@ export declare class LegacyHatchetClient {
     tenantId: string;
     durableListener: DurableListenerClient;
     logger: Logger;
-    constructor(config?: Partial<ClientConfig>, options?: HatchetClientOptions, axiosOpts?: AxiosRequestConfig, runs?: RunsClient);
+    constructor(config?: Partial<ClientConfig>, options?: HatchetClientOptions, axiosOpts?: AxiosRequestConfig, runs?: RunsClient, listener?: RunListenerClient);
     static init(config?: Partial<ClientConfig>, options?: HatchetClientOptions, axiosConfig?: AxiosRequestConfig): LegacyHatchetClient;
     run(workflow: string | V0Workflow): Promise<V0Worker>;
     worker(workflow: string | V0Workflow, opts?: Omit<WorkerOpts, 'name'> | number): Promise<V0Worker>;

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

@@ -27,7 +27,7 @@ const child_listener_client_1 = require("../listeners/run-listener/child-listene
 const rest_1 = __importDefault(require("../rest"));
 const durable_listener_client_1 = require("../listeners/durable-listener/durable-listener-client");
 class LegacyHatchetClient {
-    constructor(config, options, axiosOpts, runs) {
+    constructor(config, options, axiosOpts, runs, listener) {
         // Initializes a new Client instance.
         // Loads config in the following order: config param > yaml file > env vars
         var _a;
@@ -56,7 +56,9 @@ class LegacyHatchetClient {
         this.api = (0, rest_1.default)(this.config.api_url, this.config.token, axiosOpts);
         this.event = new event_client_1.EventClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory, this);
         this.dispatcher = new dispatcher_client_1.DispatcherClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory);
-        this.listener = new child_listener_client_1.RunListenerClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory, this.api);
+        this.listener =
+            listener ||
+                new child_listener_client_1.RunListenerClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory, this.api);
         this.admin = new admin_client_1.AdminClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory, this.api, this.tenantId, this.listener, this.runs);
         this.durableListener = new durable_listener_client_1.DurableListenerClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory, this.api);
         this.logger = this.config.logger('HatchetClient', this.config.log_level);

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

@@ -149,9 +149,11 @@ class RunEventListener {
                     }
                     finally { if (e_1) throw e_1.error; }
                 }
+                this.eventEmitter.emit('complete');
             }
             catch (e) {
                 if (e.code === nice_grpc_1.Status.CANCELLED) {
+                    this.eventEmitter.emit('complete');
                     return;
                 }
                 if (e.code === nice_grpc_1.Status.UNAVAILABLE) {
@@ -178,6 +180,11 @@ class RunEventListener {
     stream() {
         return __asyncGenerator(this, arguments, function* stream_1() {
             var _a, e_2, _b, _c;
+            let completed = false;
+            this.eventEmitter.once('complete', () => {
+                completed = true;
+                this.eventEmitter.emit('event');
+            });
             try {
                 for (var _d = true, _e = __asyncValues((0, events_1.on)(this.eventEmitter, 'event')), _f; _f = yield __await(_e.next()), _a = _f.done, !_a; _d = true) {
                     _c = _f.value;
@@ -189,6 +196,9 @@ class RunEventListener {
                             yield yield __await(r);
                         }
                     }
+                    if (completed && this.q.length === 0) {
+                        break;
+                    }
                 }
             }
             catch (e_2_1) { e_2 = { error: e_2_1 }; }

package/package.json

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

package/v1/client/client.d.ts

@@ -4,6 +4,7 @@ import WorkflowRunRef from '../../util/workflow-run-ref';
 import { Workflow as V0Workflow } from '../../workflow';
 import { V0DurableContext } from '../../step';
 import { Api } from '../../clients/rest';
+import { RunListenerClient } from '../../clients/listeners/run-listener/child-listener-client';
 import { CreateTaskWorkflowOpts, CreateWorkflowOpts, RunOpts, BaseWorkflowDeclaration, WorkflowDeclaration, TaskWorkflowDeclaration, CreateDurableTaskWorkflowOpts } from '../declaration';
 import { IHatchetClient } from './client.interface';
 import { CreateWorkerOpts, Worker } from './worker/worker';
@@ -26,6 +27,7 @@ export declare class HatchetClient implements IHatchetClient {
     /** The underlying v0 client instance */
     _v0: LegacyHatchetClient;
     _api: Api;
+    _listener: RunListenerClient;
     /**
      * @deprecated v0 client will be removed in a future release, please upgrade to v1
      */

package/v1/client/client.js

@@ -16,12 +16,14 @@ exports.HatchetClient = void 0;
 /* eslint-disable no-dupe-class-members */
 /* eslint-disable no-underscore-dangle */
 const hatchet_client_1 = require("../../clients/hatchet-client");
-const workflow_run_ref_1 = __importDefault(require("../../util/workflow-run-ref"));
 const rest_1 = __importDefault(require("../../clients/rest"));
 const config_loader_1 = require("../../util/config-loader");
 const hatchet_logger_1 = require("../../clients/hatchet-client/hatchet-logger");
 const zod_1 = require("zod");
 const event_client_1 = require("../../clients/event/event-client");
+const child_listener_client_1 = require("../../clients/listeners/run-listener/child-listener-client");
+const grpc_helpers_1 = require("../../util/grpc-helpers");
+const nice_grpc_1 = require("nice-grpc");
 const declaration_1 = require("../declaration");
 const worker_1 = require("./worker/worker");
 const metrics_1 = require("./features/metrics");
@@ -55,6 +57,7 @@ class HatchetClient {
      * @param axiosConfig - Optional Axios configuration for HTTP requests
      */
     constructor(config, options, axiosConfig) {
+        var _a;
         this._isV1 = true;
         try {
             const loaded = config_loader_1.ConfigLoader.loadClientConfig(config, {
@@ -69,7 +72,10 @@ class HatchetClient {
             this._config = clientConfig;
             this.tenantId = clientConfig.tenant_id;
             this._api = (0, rest_1.default)(clientConfig.api_url, clientConfig.token, axiosConfig);
-            this._v0 = new hatchet_client_1.LegacyHatchetClient(clientConfig, options, axiosConfig, this.runs);
+            const clientFactory = (0, nice_grpc_1.createClientFactory)().use((0, grpc_helpers_1.addTokenMiddleware)(this.config.token));
+            const credentials = (_a = options === null || options === void 0 ? void 0 : options.credentials) !== null && _a !== void 0 ? _a : config_loader_1.ConfigLoader.createCredentials(this.config.tls_config);
+            this._listener = new child_listener_client_1.RunListenerClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, credentials), clientFactory, this.api);
+            this._v0 = new hatchet_client_1.LegacyHatchetClient(clientConfig, options, axiosConfig, this.runs, this._listener);
         }
         catch (e) {
             if (e instanceof zod_1.z.ZodError) {
@@ -361,7 +367,7 @@ class HatchetClient {
         return this._v0.webhooks(workflows);
     }
     runRef(id) {
-        return new workflow_run_ref_1.default(id, this.v0.listener, this.runs);
+        return this.runs.runRef(id);
     }
 }
 exports.HatchetClient = HatchetClient;

package/v1/client/features/runs.d.ts

@@ -1,5 +1,6 @@
 import WorkflowRunRef from '../../../util/workflow-run-ref';
 import { V1TaskStatus } from '../../../clients/rest/generated/data-contracts';
+import { RunListenerClient } from '../../../clients/listeners/run-listener/child-listener-client';
 import { WorkflowsClient } from './workflows';
 import { HatchetClient } from '../client';
 export type RunFilter = {
@@ -60,6 +61,7 @@ export declare class RunsClient {
     api: HatchetClient['api'];
     tenantId: string;
     workflows: WorkflowsClient;
+    listener: RunListenerClient;
     constructor(client: HatchetClient);
     get<T = any>(run: string | WorkflowRunRef<T>): Promise<import("../../../clients/rest/generated/data-contracts").V1WorkflowRunDetails>;
     get_status<T = any>(run: string | WorkflowRunRef<T>): Promise<V1TaskStatus>;
@@ -68,4 +70,6 @@ export declare class RunsClient {
     replay(opts: ReplayRunOpts): Promise<import("axios").AxiosResponse<void, any>>;
     private prepareFilter;
     private prepareListFilter;
+    runRef<T extends Record<string, any> = any>(id: string): WorkflowRunRef<T>;
+    subscribeToStream(workflowRunId: string): AsyncIterableIterator<string>;
 }

package/v1/client/features/runs.js

@@ -8,8 +8,33 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+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 = 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); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RunsClient = void 0;
+const workflow_run_ref_1 = __importDefault(require("../../../util/workflow-run-ref"));
+const child_listener_client_1 = require("../../../clients/listeners/run-listener/child-listener-client");
 /**
  * RunsClient is used to list and manage runs
  */
@@ -18,6 +43,8 @@ class RunsClient {
         this.api = client.api;
         this.tenantId = client.tenantId;
         this.workflows = client.workflows;
+        // eslint-disable-next-line no-underscore-dangle
+        this.listener = client._listener;
     }
     get(run) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -89,5 +116,32 @@ class RunsClient {
             };
         });
     }
+    runRef(id) {
+        return new workflow_run_ref_1.default(id, this.listener, this);
+    }
+    subscribeToStream(workflowRunId) {
+        return __asyncGenerator(this, arguments, function* subscribeToStream_1() {
+            var _a, e_1, _b, _c;
+            const ref = this.runRef(workflowRunId);
+            const stream = yield __await(ref.stream());
+            try {
+                for (var _d = true, stream_1 = __asyncValues(stream), stream_1_1; stream_1_1 = yield __await(stream_1.next()), _a = stream_1_1.done, !_a; _d = true) {
+                    _c = stream_1_1.value;
+                    _d = false;
+                    const event = _c;
+                    if (event.type === child_listener_client_1.RunEventType.STEP_RUN_EVENT_TYPE_STREAM) {
+                        yield yield __await(event.payload);
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = stream_1.return)) yield __await(_b.call(stream_1));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
 }
 exports.RunsClient = RunsClient;

package/v1/examples/streaming/nextjs-proxy.d.ts

@@ -0,0 +1 @@
+export declare function GET(): Promise<Response>;

package/v1/examples/streaming/nextjs-proxy.js

@@ -0,0 +1,37 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GET = GET;
+const stream_1 = require("stream");
+const hatchet_client_1 = require("../hatchet-client");
+const workflow_1 = require("./workflow");
+// > NextJS Proxy
+function GET() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const ref = yield workflow_1.streamingTask.runNoWait({});
+            const workflowRunId = yield ref.getWorkflowRunId();
+            const stream = stream_1.Readable.from(hatchet_client_1.hatchet.runs.subscribeToStream(workflowRunId));
+            // @ts-ignore
+            return new Response(stream_1.Readable.toWeb(stream), {
+                headers: {
+                    'Content-Type': 'text/plain',
+                    'Cache-Control': 'no-cache',
+                    Connection: 'keep-alive',
+                },
+            });
+        }
+        catch (error) {
+            return new Response('Internal Server Error', { status: 500 });
+        }
+    });
+}
+// !!

package/v1/examples/streaming/run.js

@@ -17,28 +17,26 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable no-console */
-const child_listener_client_1 = require("../../../clients/listeners/run-listener/child-listener-client");
 const workflow_1 = require("./workflow");
+const hatchet_client_1 = require("../hatchet-client");
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, e_1, _b, _c;
         // > Consume
         const ref = yield workflow_1.streamingTask.runNoWait({});
-        const stream = yield ref.stream();
+        const id = yield ref.getWorkflowRunId();
         try {
-            for (var _d = true, stream_1 = __asyncValues(stream), stream_1_1; stream_1_1 = yield stream_1.next(), _a = stream_1_1.done, !_a; _d = true) {
-                _c = stream_1_1.value;
+            for (var _d = true, _e = __asyncValues(hatchet_client_1.hatchet.runs.subscribeToStream(id)), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
+                _c = _f.value;
                 _d = false;
-                const event = _c;
-                if (event.type === child_listener_client_1.RunEventType.STEP_RUN_EVENT_TYPE_STREAM) {
-                    process.stdout.write(event.payload);
-                }
+                const content = _c;
+                process.stdout.write(content);
             }
         }
         catch (e_1_1) { e_1 = { error: e_1_1 }; }
         finally {
             try {
-                if (!_d && !_a && (_b = stream_1.return)) yield _b.call(stream_1);
+                if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
             }
             finally { if (e_1) throw e_1.error; }
         }

package/v1/examples/streaming/workflow.js

@@ -29,6 +29,7 @@ function* createChunks(content, n) {
 exports.streamingTask = hatchet_client_1.hatchet.task({
     name: 'stream-example',
     fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, sleep_1.default)(2000);
         for (const chunk of createChunks(annaKarenina, 10)) {
             ctx.putStream(chunk);
             yield (0, sleep_1.default)(200);

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.9.0";
+export declare const HATCHET_VERSION = "1.9.1";

package/version.js

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