@voiceflow/sdk-runtime 1.11.0 → 1.12.0

package/build/cjs/main.d.ts

@@ -1,4 +1,5 @@
 export * from './runtime';
 export * from './sdk';
 export * from './trace';
+export * from './v2/runtime.client';
 //# sourceMappingURL=main.d.ts.map

package/build/cjs/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}

package/build/cjs/main.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./runtime"), exports);
 __exportStar(require("./sdk"), exports);
 __exportStar(require("./trace"), exports);
+__exportStar(require("./v2/runtime.client"), exports);

package/build/cjs/v2/interact-trace.stream.d.ts

@@ -0,0 +1,8 @@
+import type { EventSourceMessage } from 'eventsource-parser';
+import type { TraceService } from './trace.service';
+export declare class InteractTraceStream<T> extends TransformStream<EventSourceMessage, T> {
+    private readonly createContext;
+    private readonly trace;
+    constructor(createContext: () => T, trace: TraceService<T>);
+}
+//# sourceMappingURL=interact-trace.stream.d.ts.map

package/build/cjs/v2/interact-trace.stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interact-trace.stream.d.ts","sourceRoot":"","sources":["../../../src/v2/interact-trace.stream.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAE7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,qBAAa,mBAAmB,CAAC,CAAC,CAAE,SAAQ,eAAe,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAE9E,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,KAAK;gBADL,aAAa,EAAE,MAAM,CAAC,EACtB,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;CAY1C"}

package/build/cjs/v2/interact-trace.stream.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InteractTraceStream = void 0;
+class InteractTraceStream extends TransformStream {
+    constructor(createContext, trace) {
+        super({
+            transform: async (chunk, controller) => {
+                const data = JSON.parse(chunk.data);
+                const trace = await this.trace.processTrace(this.createContext(), data);
+                if (!trace)
+                    return;
+                controller.enqueue(trace);
+            },
+        });
+        this.createContext = createContext;
+        this.trace = trace;
+    }
+}
+exports.InteractTraceStream = InteractTraceStream;

package/build/cjs/v2/runtime.client.d.ts

@@ -0,0 +1,20 @@
+import type { RuntimeAction } from '../runtime';
+import type { TraceOptions } from '../trace';
+import { TraceService } from './trace.service';
+export interface RuntimeClientOptions<T> extends TraceOptions<T> {
+    baseURL: string;
+}
+export interface InteractStreamRequest {
+    projectID: string;
+    userID: string;
+    environment?: string;
+    action: RuntimeAction;
+}
+export declare class RuntimeClient<T> {
+    private readonly options;
+    private readonly trace;
+    private readonly fetch;
+    constructor(options: RuntimeClientOptions<T>, trace?: TraceService<T>);
+    interactStream(createContext: () => T, { projectID, userID, environment, action }: InteractStreamRequest): Promise<ReadableStream<T>>;
+}
+//# sourceMappingURL=runtime.client.d.ts.map

package/build/cjs/v2/runtime.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.client.d.ts","sourceRoot":"","sources":["../../../src/v2/runtime.client.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAG5C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,WAAW,oBAAoB,CAAC,CAAC,CAAE,SAAQ,YAAY,CAAC,CAAC,CAAC;IAC9D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,MAAM,EAAE,aAAa,CAAC;CACvB;AAED,qBAAa,aAAa,CAAC,CAAC;IAIxB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAJxB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsD;gBAGzD,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAChC,KAAK,kBAA+C;IAGjE,cAAc,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,qBAAqB;CAqB/G"}

package/build/cjs/v2/runtime.client.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuntimeClient = void 0;
+const fetch_1 = require("@voiceflow/fetch");
+const stream_1 = require("eventsource-parser/stream");
+const interact_trace_stream_1 = require("./interact-trace.stream");
+const trace_service_1 = require("./trace.service");
+class RuntimeClient {
+    constructor(options, trace = new trace_service_1.TraceService({ traces: options.traces })) {
+        this.options = options;
+        this.trace = trace;
+        this.fetch = new fetch_1.FetchClient({ baseURL: this.options.baseURL });
+    }
+    async interactStream(createContext, { projectID, userID, environment, action }) {
+        const result = await this.fetch.post(`/v2/public/project/${projectID}/user/${encodeURIComponent(userID)}/interact/stream`, {
+            query: new URLSearchParams({
+                completion_events: String(true),
+                ...(environment && { environment }),
+            }),
+            json: { action },
+        });
+        if (!result.body) {
+            throw new Error('interact stream body is empty');
+        }
+        return result.body
+            .pipeThrough(new TextDecoderStream())
+            .pipeThrough(new stream_1.EventSourceParserStream())
+            .pipeThrough(new interact_trace_stream_1.InteractTraceStream(createContext, this.trace));
+    }
+}
+exports.RuntimeClient = RuntimeClient;

package/build/cjs/v2/trace.service.d.ts

@@ -0,0 +1,9 @@
+import { Trace } from '@voiceflow/base-types';
+import type { TraceDeclaration, TraceOptions } from '../trace';
+export declare class TraceService<T = unknown> {
+    private readonly traces;
+    constructor(options?: TraceOptions<T>);
+    registerTrace(step: TraceDeclaration<T, any>): this;
+    processTrace(context: T, data: Trace.AnyTrace): Promise<T | null>;
+}
+//# sourceMappingURL=trace.service.d.ts.map

package/build/cjs/v2/trace.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trace.service.d.ts","sourceRoot":"","sources":["../../../src/v2/trace.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAE9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE9D,qBAAa,YAAY,CAAC,CAAC,GAAG,OAAO;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkC;gBAEtC,OAAO,GAAE,YAAY,CAAC,CAAC,CAAM;IAIzC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI;IAK7C,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;CAM/E"}

package/build/cjs/v2/trace.service.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TraceService = void 0;
+class TraceService {
+    constructor(options = {}) {
+        this.traces = [];
+        this.traces = options.traces ?? [];
+    }
+    registerTrace(step) {
+        this.traces.push(step);
+        return this;
+    }
+    async processTrace(context, data) {
+        const trace = this.traces.find((trace) => trace.canHandle(data));
+        if (!trace)
+            return null;
+        return trace.handle({ context }, data);
+    }
+}
+exports.TraceService = TraceService;

package/build/esm/main.d.ts

@@ -1,4 +1,5 @@
 export * from './runtime/index.js';
 export * from './sdk/index.js';
 export * from './trace/index.js';
+export * from './v2/runtime.client.js';
 //# sourceMappingURL=main.d.ts.map

package/build/esm/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}

package/build/esm/main.js

@@ -1,3 +1,4 @@
 export * from './runtime/index.js';
 export * from './sdk/index.js';
 export * from './trace/index.js';
+export * from './v2/runtime.client.js';

package/build/esm/v2/interact-trace.stream.d.ts

@@ -0,0 +1,8 @@
+import type { EventSourceMessage } from 'eventsource-parser';
+import type { TraceService } from './trace.service.js';
+export declare class InteractTraceStream<T> extends TransformStream<EventSourceMessage, T> {
+    private readonly createContext;
+    private readonly trace;
+    constructor(createContext: () => T, trace: TraceService<T>);
+}
+//# sourceMappingURL=interact-trace.stream.d.ts.map

package/build/esm/v2/interact-trace.stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interact-trace.stream.d.ts","sourceRoot":"","sources":["../../../src/v2/interact-trace.stream.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAE7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,qBAAa,mBAAmB,CAAC,CAAC,CAAE,SAAQ,eAAe,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAE9E,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,KAAK;gBADL,aAAa,EAAE,MAAM,CAAC,EACtB,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;CAY1C"}

package/build/esm/v2/interact-trace.stream.js

@@ -0,0 +1,15 @@
+export class InteractTraceStream extends TransformStream {
+    constructor(createContext, trace) {
+        super({
+            transform: async (chunk, controller) => {
+                const data = JSON.parse(chunk.data);
+                const trace = await this.trace.processTrace(this.createContext(), data);
+                if (!trace)
+                    return;
+                controller.enqueue(trace);
+            },
+        });
+        this.createContext = createContext;
+        this.trace = trace;
+    }
+}

package/build/esm/v2/runtime.client.d.ts

@@ -0,0 +1,20 @@
+import type { RuntimeAction } from '../runtime/index.js';
+import type { TraceOptions } from '../trace/index.js';
+import { TraceService } from './trace.service.js';
+export interface RuntimeClientOptions<T> extends TraceOptions<T> {
+    baseURL: string;
+}
+export interface InteractStreamRequest {
+    projectID: string;
+    userID: string;
+    environment?: string;
+    action: RuntimeAction;
+}
+export declare class RuntimeClient<T> {
+    private readonly options;
+    private readonly trace;
+    private readonly fetch;
+    constructor(options: RuntimeClientOptions<T>, trace?: TraceService<T>);
+    interactStream(createContext: () => T, { projectID, userID, environment, action }: InteractStreamRequest): Promise<ReadableStream<T>>;
+}
+//# sourceMappingURL=runtime.client.d.ts.map

package/build/esm/v2/runtime.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.client.d.ts","sourceRoot":"","sources":["../../../src/v2/runtime.client.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAG5C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,WAAW,oBAAoB,CAAC,CAAC,CAAE,SAAQ,YAAY,CAAC,CAAC,CAAC;IAC9D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,MAAM,EAAE,aAAa,CAAC;CACvB;AAED,qBAAa,aAAa,CAAC,CAAC;IAIxB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAJxB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsD;gBAGzD,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAChC,KAAK,kBAA+C;IAGjE,cAAc,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,qBAAqB;CAqB/G"}

package/build/esm/v2/runtime.client.js

@@ -0,0 +1,27 @@
+import { FetchClient } from '@voiceflow/fetch';
+import { EventSourceParserStream } from 'eventsource-parser/stream';
+import { InteractTraceStream } from './interact-trace.stream.js';
+import { TraceService } from './trace.service.js';
+export class RuntimeClient {
+    constructor(options, trace = new TraceService({ traces: options.traces })) {
+        this.options = options;
+        this.trace = trace;
+        this.fetch = new FetchClient({ baseURL: this.options.baseURL });
+    }
+    async interactStream(createContext, { projectID, userID, environment, action }) {
+        const result = await this.fetch.post(`/v2/public/project/${projectID}/user/${encodeURIComponent(userID)}/interact/stream`, {
+            query: new URLSearchParams({
+                completion_events: String(true),
+                ...(environment && { environment }),
+            }),
+            json: { action },
+        });
+        if (!result.body) {
+            throw new Error('interact stream body is empty');
+        }
+        return result.body
+            .pipeThrough(new TextDecoderStream())
+            .pipeThrough(new EventSourceParserStream())
+            .pipeThrough(new InteractTraceStream(createContext, this.trace));
+    }
+}

package/build/esm/v2/trace.service.d.ts

@@ -0,0 +1,9 @@
+import { Trace } from '@voiceflow/base-types';
+import type { TraceDeclaration, TraceOptions } from '../trace/index.js';
+export declare class TraceService<T = unknown> {
+    private readonly traces;
+    constructor(options?: TraceOptions<T>);
+    registerTrace(step: TraceDeclaration<T, any>): this;
+    processTrace(context: T, data: Trace.AnyTrace): Promise<T | null>;
+}
+//# sourceMappingURL=trace.service.d.ts.map

package/build/esm/v2/trace.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trace.service.d.ts","sourceRoot":"","sources":["../../../src/v2/trace.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAE9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE9D,qBAAa,YAAY,CAAC,CAAC,GAAG,OAAO;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkC;gBAEtC,OAAO,GAAE,YAAY,CAAC,CAAC,CAAM;IAIzC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI;IAK7C,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;CAM/E"}

package/build/esm/v2/trace.service.js

@@ -0,0 +1,16 @@
+export class TraceService {
+    constructor(options = {}) {
+        this.traces = [];
+        this.traces = options.traces ?? [];
+    }
+    registerTrace(step) {
+        this.traces.push(step);
+        return this;
+    }
+    async processTrace(context, data) {
+        const trace = this.traces.find((trace) => trace.canHandle(data));
+        if (!trace)
+            return null;
+        return trace.handle({ context }, data);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voiceflow/sdk-runtime",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "exports": {
     ".": {
       "import": "./build/esm/main.js",
@@ -27,10 +27,11 @@
   },
   "dependencies": {
     "@voiceflow/base-types": "2.113.1",
+    "eventsource-parser": "3.0.0",
     "http-errors": "2.0.0"
   },
   "devDependencies": {
-    "@types/http-errors": "^1.8.2"
+    "@types/http-errors": "1.8.2"
   },
   "volta": {
     "extends": "../../package.json"
@@ -38,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8f7a30096b299f1f627adcbd760a5f7564684819"
+  "gitHead": "f931229794b4f2f3e103c8cee007fbf7ccfcd7ab"
 }