@modelrelay/sdk 1.3.0 → 1.3.2

package/README.md

@@ -113,7 +113,7 @@ const req = customer.responses
 const stream = await customer.responses.streamJSON<z.infer<typeof schema>>(req);
 for await (const event of stream) {
   if (event.type === "completion") {
-    console.log(event.value);
+    console.log(event.payload);
   }
 }
 ```

package/dist/index.cjs

@@ -818,7 +818,7 @@ function isTokenReusable(token) {
 // package.json
 var package_default = {
   name: "@modelrelay/sdk",
-  version: "1.3.0",
+  version: "1.3.2",
   description: "TypeScript SDK for the ModelRelay API",
   type: "module",
   main: "dist/index.cjs",
@@ -850,6 +850,9 @@ var package_default = {
   ],
   author: "Shane Vitarana",
   license: "Apache-2.0",
+  dependencies: {
+    "fast-json-patch": "^3.1.1"
+  },
   devDependencies: {
     "openapi-typescript": "^7.4.4",
     tsup: "^8.2.4",
@@ -2042,8 +2045,11 @@ function mapNDJSONResponseEvent(line, requestId) {
   const model = normalizeModelId(parsed.model);
   const stopReason = normalizeStopReason(parsed.stop_reason);
   let textDelta;
-  if (isRecord(parsed.payload) && typeof parsed.payload.content === "string") {
-    textDelta = parsed.payload.content;
+  if (recordType2 === "update" && typeof parsed.delta === "string") {
+    textDelta = parsed.delta;
+  }
+  if (recordType2 === "completion" && typeof parsed.content === "string") {
+    textDelta = parsed.content;
   }
   const toolCallDelta = extractToolCallDelta(parsed, type);
   const toolCalls = extractToolCalls(parsed, type);
@@ -2143,6 +2149,7 @@ function normalizeToolCalls(toolCalls) {
 }
 
 // src/responses_stream.ts
+var import_fast_json_patch = require("fast-json-patch");
 var ResponsesStream = class {
   constructor(response, requestId, context, metrics, trace, timeouts = {}, startedAtMs = Date.now()) {
     this.firstTokenEmitted = false;
@@ -2269,6 +2276,9 @@ var ResponsesStream = class {
       if (evt.type === "message_stop") {
         stopReason = evt.stopReason;
         usage = evt.usage;
+        if (evt.textDelta) {
+          text = evt.textDelta;
+        }
         const raw2 = isRecord(evt.data) ? evt.data : {};
         citations = normalizeCitations(raw2.citations) ?? citations;
       }
@@ -2344,6 +2354,7 @@ var StructuredJSONStream = class {
     this.closed = false;
     this.sawTerminal = false;
     this.firstContentSeen = false;
+    this.currentPayload = {};
     if (!response.body) {
       throw new ConfigError("streaming response is missing a body");
     }
@@ -2487,9 +2498,36 @@ var StructuredJSONStream = class {
     }
     this.firstContentSeen = true;
     const completeFieldsArray = Array.isArray(parsed.complete_fields) ? parsed.complete_fields.filter((f) => typeof f === "string") : [];
+    let payload;
+    if (rawType === "update") {
+      const patch = Array.isArray(parsed.patch) ? parsed.patch : null;
+      if (!patch) {
+        throw new TransportError("structured stream update missing patch", {
+          kind: "request"
+        });
+      }
+      try {
+        const applied = (0, import_fast_json_patch.applyPatch)(this.currentPayload, patch, false, true);
+        this.currentPayload = applied.newDocument;
+        payload = this.currentPayload;
+      } catch (err) {
+        throw new TransportError("failed to apply structured patch", {
+          kind: "request",
+          cause: err
+        });
+      }
+    } else {
+      if (parsed.payload === void 0) {
+        throw new TransportError("structured stream completion missing payload", {
+          kind: "request"
+        });
+      }
+      this.currentPayload = parsed.payload;
+      payload = this.currentPayload;
+    }
     return {
       type: rawType,
-      payload: parsed.payload,
+      payload,
       requestId: this.requestId,
       completeFields: new Set(completeFieldsArray)
     };
@@ -2599,6 +2637,7 @@ async function readWithTimeout(readPromise, next, onTimeout) {
 }
 
 // src/responses_client.ts
+var RESPONSES_STREAM_ACCEPT = 'application/x-ndjson; profile="responses-stream/v2"';
 var ResponsesClient = class {
   constructor(http, auth, cfg = {}) {
     this.http = http;
@@ -2638,24 +2677,16 @@ var ResponsesClient = class {
     const stream = await this.stream(req, options);
     return {
       async *[Symbol.asyncIterator]() {
-        let accumulated = "";
+        let sawDelta = false;
         try {
           for await (const evt of stream) {
-            if ((evt.type === "message_delta" || evt.type === "message_stop") && evt.textDelta) {
-              const next = evt.textDelta;
-              let delta = "";
-              if (next.startsWith(accumulated)) {
-                delta = next.slice(accumulated.length);
-                accumulated = next;
-              } else if (accumulated.startsWith(next)) {
-                accumulated = next;
-              } else {
-                delta = next;
-                accumulated += next;
-              }
-              if (delta) {
-                yield delta;
-              }
+            if (evt.type === "message_delta" && evt.textDelta) {
+              sawDelta = true;
+              yield evt.textDelta;
+            }
+            if (evt.type === "message_stop" && evt.textDelta && !sawDelta) {
+              sawDelta = true;
+              yield evt.textDelta;
             }
           }
         } finally {
@@ -2673,24 +2704,16 @@ var ResponsesClient = class {
     const stream = await this.stream(req, args.options ?? options);
     return {
       async *[Symbol.asyncIterator]() {
-        let accumulated = "";
+        let sawDelta = false;
         try {
           for await (const evt of stream) {
-            if ((evt.type === "message_delta" || evt.type === "message_stop") && evt.textDelta) {
-              const next = evt.textDelta;
-              let delta = "";
-              if (next.startsWith(accumulated)) {
-                delta = next.slice(accumulated.length);
-                accumulated = next;
-              } else if (accumulated.startsWith(next)) {
-                accumulated = next;
-              } else {
-                delta = next;
-                accumulated += next;
-              }
-              if (delta) {
-                yield delta;
-              }
+            if (evt.type === "message_delta" && evt.textDelta) {
+              sawDelta = true;
+              yield evt.textDelta;
+            }
+            if (evt.type === "message_stop" && evt.textDelta && !sawDelta) {
+              sawDelta = true;
+              yield evt.textDelta;
             }
           }
         } finally {
@@ -2789,7 +2812,7 @@ var ResponsesClient = class {
       headers,
       apiKey: authHeaders.apiKey,
       accessToken: authHeaders.accessToken,
-      accept: "application/x-ndjson",
+      accept: RESPONSES_STREAM_ACCEPT,
       raw: true,
       signal: merged.signal,
       timeoutMs: merged.timeoutMs ?? 0,
@@ -2869,7 +2892,7 @@ var ResponsesClient = class {
       headers,
       apiKey: authHeaders.apiKey,
       accessToken: authHeaders.accessToken,
-      accept: "application/x-ndjson",
+      accept: RESPONSES_STREAM_ACCEPT,
       raw: true,
       signal: merged.signal,
       timeoutMs: merged.timeoutMs ?? 0,

package/dist/index.d.cts

@@ -1668,6 +1668,7 @@ declare class StructuredJSONStream<T> implements AsyncIterable<StructuredJSONEve
     private closed;
     private sawTerminal;
     private firstContentSeen;
+    private currentPayload;
     constructor(response: globalThis.Response, requestId: string | undefined, context: RequestContext, _metrics?: MetricsCallbacks, trace?: TraceCallbacks, timeouts?: StreamTimeoutsMs, startedAtMs?: number);
     cancel(reason?: unknown): Promise<void>;
     [Symbol.asyncIterator](): AsyncIterator<StructuredJSONEvent<T>>;
@@ -3405,9 +3406,25 @@ interface components {
             /** @description Sources from web search results */
             citations?: components["schemas"]["Citation"][];
         };
+        JSONPatchOperation: {
+            /** @enum {string} */
+            op: "add" | "remove" | "replace" | "move" | "copy" | "test";
+            path: string;
+            from?: string;
+            value?: {
+                [key: string]: unknown;
+            };
+        };
         ResponsesStreamEnvelope: {
             /** @enum {string} */
             type: "start" | "update" | "completion" | "error" | "keepalive" | "tool_use_start" | "tool_use_delta" | "tool_use_stop";
+            /** @enum {string} */
+            stream_mode?: "text-delta" | "structured-patch";
+            /** @enum {string} */
+            stream_version?: "v2";
+            delta?: string;
+            content?: string;
+            patch?: components["schemas"]["JSONPatchOperation"][];
             payload?: {
                 [key: string]: unknown;
             };
@@ -3702,7 +3719,7 @@ interface components {
          * @description Workflow-critical model capability identifier.
          * @enum {string}
          */
-        ModelCapability: "tools" | "vision" | "web_search" | "computer_use" | "code_execution";
+        ModelCapability: "tools" | "vision" | "web_search" | "web_fetch" | "computer_use" | "code_execution";
         Model: {
             model_id: components["schemas"]["ModelId"];
             provider: components["schemas"]["ProviderId"];

package/dist/index.d.ts

@@ -1668,6 +1668,7 @@ declare class StructuredJSONStream<T> implements AsyncIterable<StructuredJSONEve
     private closed;
     private sawTerminal;
     private firstContentSeen;
+    private currentPayload;
     constructor(response: globalThis.Response, requestId: string | undefined, context: RequestContext, _metrics?: MetricsCallbacks, trace?: TraceCallbacks, timeouts?: StreamTimeoutsMs, startedAtMs?: number);
     cancel(reason?: unknown): Promise<void>;
     [Symbol.asyncIterator](): AsyncIterator<StructuredJSONEvent<T>>;
@@ -3405,9 +3406,25 @@ interface components {
             /** @description Sources from web search results */
             citations?: components["schemas"]["Citation"][];
         };
+        JSONPatchOperation: {
+            /** @enum {string} */
+            op: "add" | "remove" | "replace" | "move" | "copy" | "test";
+            path: string;
+            from?: string;
+            value?: {
+                [key: string]: unknown;
+            };
+        };
         ResponsesStreamEnvelope: {
             /** @enum {string} */
             type: "start" | "update" | "completion" | "error" | "keepalive" | "tool_use_start" | "tool_use_delta" | "tool_use_stop";
+            /** @enum {string} */
+            stream_mode?: "text-delta" | "structured-patch";
+            /** @enum {string} */
+            stream_version?: "v2";
+            delta?: string;
+            content?: string;
+            patch?: components["schemas"]["JSONPatchOperation"][];
             payload?: {
                 [key: string]: unknown;
             };
@@ -3702,7 +3719,7 @@ interface components {
          * @description Workflow-critical model capability identifier.
          * @enum {string}
          */
-        ModelCapability: "tools" | "vision" | "web_search" | "computer_use" | "code_execution";
+        ModelCapability: "tools" | "vision" | "web_search" | "web_fetch" | "computer_use" | "code_execution";
         Model: {
             model_id: components["schemas"]["ModelId"];
             provider: components["schemas"]["ProviderId"];

package/dist/index.js

@@ -688,7 +688,7 @@ function isTokenReusable(token) {
 // package.json
 var package_default = {
   name: "@modelrelay/sdk",
-  version: "1.3.0",
+  version: "1.3.2",
   description: "TypeScript SDK for the ModelRelay API",
   type: "module",
   main: "dist/index.cjs",
@@ -720,6 +720,9 @@ var package_default = {
   ],
   author: "Shane Vitarana",
   license: "Apache-2.0",
+  dependencies: {
+    "fast-json-patch": "^3.1.1"
+  },
   devDependencies: {
     "openapi-typescript": "^7.4.4",
     tsup: "^8.2.4",
@@ -1912,8 +1915,11 @@ function mapNDJSONResponseEvent(line, requestId) {
   const model = normalizeModelId(parsed.model);
   const stopReason = normalizeStopReason(parsed.stop_reason);
   let textDelta;
-  if (isRecord(parsed.payload) && typeof parsed.payload.content === "string") {
-    textDelta = parsed.payload.content;
+  if (recordType2 === "update" && typeof parsed.delta === "string") {
+    textDelta = parsed.delta;
+  }
+  if (recordType2 === "completion" && typeof parsed.content === "string") {
+    textDelta = parsed.content;
   }
   const toolCallDelta = extractToolCallDelta(parsed, type);
   const toolCalls = extractToolCalls(parsed, type);
@@ -2013,6 +2019,7 @@ function normalizeToolCalls(toolCalls) {
 }
 
 // src/responses_stream.ts
+import { applyPatch } from "fast-json-patch";
 var ResponsesStream = class {
   constructor(response, requestId, context, metrics, trace, timeouts = {}, startedAtMs = Date.now()) {
     this.firstTokenEmitted = false;
@@ -2139,6 +2146,9 @@ var ResponsesStream = class {
       if (evt.type === "message_stop") {
         stopReason = evt.stopReason;
         usage = evt.usage;
+        if (evt.textDelta) {
+          text = evt.textDelta;
+        }
         const raw2 = isRecord(evt.data) ? evt.data : {};
         citations = normalizeCitations(raw2.citations) ?? citations;
       }
@@ -2214,6 +2224,7 @@ var StructuredJSONStream = class {
     this.closed = false;
     this.sawTerminal = false;
     this.firstContentSeen = false;
+    this.currentPayload = {};
     if (!response.body) {
       throw new ConfigError("streaming response is missing a body");
     }
@@ -2357,9 +2368,36 @@ var StructuredJSONStream = class {
     }
     this.firstContentSeen = true;
     const completeFieldsArray = Array.isArray(parsed.complete_fields) ? parsed.complete_fields.filter((f) => typeof f === "string") : [];
+    let payload;
+    if (rawType === "update") {
+      const patch = Array.isArray(parsed.patch) ? parsed.patch : null;
+      if (!patch) {
+        throw new TransportError("structured stream update missing patch", {
+          kind: "request"
+        });
+      }
+      try {
+        const applied = applyPatch(this.currentPayload, patch, false, true);
+        this.currentPayload = applied.newDocument;
+        payload = this.currentPayload;
+      } catch (err) {
+        throw new TransportError("failed to apply structured patch", {
+          kind: "request",
+          cause: err
+        });
+      }
+    } else {
+      if (parsed.payload === void 0) {
+        throw new TransportError("structured stream completion missing payload", {
+          kind: "request"
+        });
+      }
+      this.currentPayload = parsed.payload;
+      payload = this.currentPayload;
+    }
     return {
       type: rawType,
-      payload: parsed.payload,
+      payload,
       requestId: this.requestId,
       completeFields: new Set(completeFieldsArray)
     };
@@ -2469,6 +2507,7 @@ async function readWithTimeout(readPromise, next, onTimeout) {
 }
 
 // src/responses_client.ts
+var RESPONSES_STREAM_ACCEPT = 'application/x-ndjson; profile="responses-stream/v2"';
 var ResponsesClient = class {
   constructor(http, auth, cfg = {}) {
     this.http = http;
@@ -2508,24 +2547,16 @@ var ResponsesClient = class {
     const stream = await this.stream(req, options);
     return {
       async *[Symbol.asyncIterator]() {
-        let accumulated = "";
+        let sawDelta = false;
         try {
           for await (const evt of stream) {
-            if ((evt.type === "message_delta" || evt.type === "message_stop") && evt.textDelta) {
-              const next = evt.textDelta;
-              let delta = "";
-              if (next.startsWith(accumulated)) {
-                delta = next.slice(accumulated.length);
-                accumulated = next;
-              } else if (accumulated.startsWith(next)) {
-                accumulated = next;
-              } else {
-                delta = next;
-                accumulated += next;
-              }
-              if (delta) {
-                yield delta;
-              }
+            if (evt.type === "message_delta" && evt.textDelta) {
+              sawDelta = true;
+              yield evt.textDelta;
+            }
+            if (evt.type === "message_stop" && evt.textDelta && !sawDelta) {
+              sawDelta = true;
+              yield evt.textDelta;
             }
           }
         } finally {
@@ -2543,24 +2574,16 @@ var ResponsesClient = class {
     const stream = await this.stream(req, args.options ?? options);
     return {
       async *[Symbol.asyncIterator]() {
-        let accumulated = "";
+        let sawDelta = false;
         try {
           for await (const evt of stream) {
-            if ((evt.type === "message_delta" || evt.type === "message_stop") && evt.textDelta) {
-              const next = evt.textDelta;
-              let delta = "";
-              if (next.startsWith(accumulated)) {
-                delta = next.slice(accumulated.length);
-                accumulated = next;
-              } else if (accumulated.startsWith(next)) {
-                accumulated = next;
-              } else {
-                delta = next;
-                accumulated += next;
-              }
-              if (delta) {
-                yield delta;
-              }
+            if (evt.type === "message_delta" && evt.textDelta) {
+              sawDelta = true;
+              yield evt.textDelta;
+            }
+            if (evt.type === "message_stop" && evt.textDelta && !sawDelta) {
+              sawDelta = true;
+              yield evt.textDelta;
             }
           }
         } finally {
@@ -2659,7 +2682,7 @@ var ResponsesClient = class {
       headers,
       apiKey: authHeaders.apiKey,
       accessToken: authHeaders.accessToken,
-      accept: "application/x-ndjson",
+      accept: RESPONSES_STREAM_ACCEPT,
       raw: true,
       signal: merged.signal,
       timeoutMs: merged.timeoutMs ?? 0,
@@ -2739,7 +2762,7 @@ var ResponsesClient = class {
       headers,
       apiKey: authHeaders.apiKey,
       accessToken: authHeaders.accessToken,
-      accept: "application/x-ndjson",
+      accept: RESPONSES_STREAM_ACCEPT,
       raw: true,
       signal: merged.signal,
       timeoutMs: merged.timeoutMs ?? 0,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@modelrelay/sdk",
-  "version": "1.3.0",
+  "version": "1.3.2",
 	"description": "TypeScript SDK for the ModelRelay API",
 	"type": "module",
 	"main": "dist/index.cjs",
@@ -32,6 +32,9 @@
 	],
 	"author": "Shane Vitarana",
 	"license": "Apache-2.0",
+	"dependencies": {
+		"fast-json-patch": "^3.1.1"
+	},
 	"devDependencies": {
 		"openapi-typescript": "^7.4.4",
 		"tsup": "^8.2.4",