@metagptx/web-sdk 0.0.39 → 0.0.40

package/README.md

@@ -384,6 +384,69 @@ const response = await client.apiCall.invoke({
 });
 ```
 
+#### Stream Response Type (Browser Only)
+
+When making API calls in a browser environment with `responseType: 'stream'`, the SDK automatically uses the native `fetch` API instead of axios to handle streaming responses more efficiently. This avoids potential performance issues with axios interceptors when processing streaming data.
+
+**Behavior:**
+- **Browser environment** + `responseType: 'stream'`: Uses `fetch` API
+- **Non-browser environment** or other `responseType` values: Uses axios (default behavior)
+
+**Automatic Configuration:**
+When using `fetch` for streaming:
+- Automatically includes `Authorization` header from `localStorage.token` (if available)
+- Automatically includes `Content-Type: application/json` header
+- Automatically includes `App-Host` header with current origin
+- Automatically handles `baseURL` from axios instance configuration
+- Merges custom headers from `options.headers`
+- Automatically serializes request body for POST/PUT/PATCH methods
+
+**Return Value:**
+- When using `fetch` (stream responseType in browser): Returns a native `Response` object
+- When using axios (default): Returns an `AxiosResponse` object
+
+**Example - Streaming Response:**
+```typescript
+// Stream response in browser - returns Response object
+const response = await client.apiCall.invoke({
+  url: '/api/v1/files/download',
+  method: 'GET',
+  options: {
+    responseType: 'stream',
+  },
+});
+
+// Access the ReadableStream from response.body
+const reader = response.body?.getReader();
+if (reader) {
+  while (true) {
+    const { done, value } = await reader.read();
+    if (done) break;
+    // Process chunk: value is a Uint8Array
+    console.log('Received chunk:', value);
+  }
+}
+
+// Or convert to blob
+const blob = await response.blob();
+const url = URL.createObjectURL(blob);
+```
+
+**Example - Regular Response (uses axios):**
+```typescript
+// Regular response - returns AxiosResponse object
+const response = await client.apiCall.invoke({
+  url: '/api/v1/custom/endpoint',
+  method: 'GET',
+  // responseType defaults to 'json' or undefined
+});
+
+// Access data via response.data (axios format)
+console.log(response.data);
+```
+
+**Note:** In non-browser environments (e.g., Node.js), even with `responseType: 'stream'`, the SDK will use axios to maintain consistency across environments.
+
 ---
 
 ### Integrations Module

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@metagptx/web-sdk",
   "type": "module",
-  "version": "0.0.39",
+  "version": "0.0.40",
   "packageManager": "pnpm@10.15.0+sha512.486ebc259d3e999a4e8691ce03b5cac4a71cbeca39372a9b762cb500cfdf0873e2cb16abe3d951b1ee2cf012503f027b98b6584e4df22524e0c7450d9ec7aa7b",
   "description": "TypeScript SDK for interacting with FuncSea API",
   "author": "MetaGPTX",