ai 3.3.28 → 3.3.30

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # ai
 
+## 3.3.30
+
+### Patch Changes
+
+- 6ee1f8e: feat (ai/core): add toDataStream to streamText result
+
+## 3.3.29
+
+### Patch Changes
+
+- 1e3dfd2: feat (ai/core): enhance pipeToData/TextStreamResponse methods
+
 ## 3.3.28
 
 ### Patch Changes

package/dist/index.d.mts

@@ -870,19 +870,16 @@ interface StreamObjectResult<PARTIAL, RESULT, ELEMENT_STREAM> {
     writes each text delta as a separate chunk.
   
     @param response A Node.js response-like object (ServerResponse).
-    @param init Optional headers and status code.
+    @param init Optional headers, status code, and status text.
        */
-    pipeTextStreamToResponse(response: ServerResponse, init?: {
-        headers?: Record<string, string>;
-        status?: number;
-    }): void;
+    pipeTextStreamToResponse(response: ServerResponse, init?: ResponseInit): void;
     /**
     Creates a simple text stream response.
     The response has a `Content-Type` header set to `text/plain; charset=utf-8`.
     Each text delta is encoded as UTF-8 and sent as a separate chunk.
     Non-text-delta events are ignored.
   
-    @param init Optional headers and status code.
+    @param init Optional headers, status code, and status text.
        */
     toTextStreamResponse(init?: ResponseInit): Response;
 }
@@ -1522,10 +1519,22 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
     @returns A data stream.
   
-    @deprecated Use `toDataStreamResponse` instead.
+    @deprecated Use `toDataStream` instead.
        */
     toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<Uint8Array>;
     /**
+    Converts the result to a data stream.
+  
+    @param data an optional StreamData object that will be merged into the stream.
+    @param getErrorMessage an optional function that converts an error to an error message.
+  
+    @return A data stream.
+       */
+    toDataStream(options?: {
+        data?: StreamData;
+        getErrorMessage?: (error: unknown) => string;
+    }): ReadableStream<Uint8Array>;
+    /**
     Writes stream data output to a Node.js response-like object.
     It sets a `Content-Type` header to `text/plain; charset=utf-8` and
     writes each stream data part as a separate chunk.
@@ -1541,15 +1550,15 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     }): void;
     /**
     Writes data stream output to a Node.js response-like object.
-    It sets a `Content-Type` header to `text/plain; charset=utf-8` and
-    writes each data stream part as a separate chunk.
   
     @param response A Node.js response-like object (ServerResponse).
-    @param init Optional headers and status code.
+    @param options An object with an init property (ResponseInit) and a data property.
+    You can also pass in a ResponseInit directly (deprecated).
        */
-    pipeDataStreamToResponse(response: ServerResponse$1, init?: {
-        headers?: Record<string, string>;
-        status?: number;
+    pipeDataStreamToResponse(response: ServerResponse$1, options?: ResponseInit | {
+        init?: ResponseInit;
+        data?: StreamData;
+        getErrorMessage?: (error: unknown) => string;
     }): void;
     /**
     Writes text delta output to a Node.js response-like object.
@@ -1557,12 +1566,9 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     writes each text delta as a separate chunk.
   
     @param response A Node.js response-like object (ServerResponse).
-    @param init Optional headers and status code.
+    @param init Optional headers, status code, and status text.
        */
-    pipeTextStreamToResponse(response: ServerResponse$1, init?: {
-        headers?: Record<string, string>;
-        status?: number;
-    }): void;
+    pipeTextStreamToResponse(response: ServerResponse$1, init?: ResponseInit): void;
     /**
     Converts the result to a streamed response object with a stream data part stream.
     It can be used with the `useChat` and `useCompletion` hooks.
@@ -1597,7 +1603,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     Each text delta is encoded as UTF-8 and sent as a separate chunk.
     Non-text-delta events are ignored.
   
-    @param init Optional headers and status code.
+    @param init Optional headers, status code, and status text.
        */
     toTextStreamResponse(init?: ResponseInit): Response;
 }
@@ -2938,6 +2944,8 @@ declare function ReplicateStream(res: Prediction, cb?: AIStreamCallbacksAndOptio
 
 /**
  * A utility function to stream a ReadableStream to a Node.js response-like object.
+ *
+ * @deprecated Use `pipeDataStreamToResponse` (part of `StreamTextResult`) instead.
  */
 declare function streamToResponse(res: ReadableStream, response: ServerResponse$1, init?: {
     headers?: Record<string, string>;

package/dist/index.d.ts

@@ -870,19 +870,16 @@ interface StreamObjectResult<PARTIAL, RESULT, ELEMENT_STREAM> {
     writes each text delta as a separate chunk.
   
     @param response A Node.js response-like object (ServerResponse).
-    @param init Optional headers and status code.
+    @param init Optional headers, status code, and status text.
        */
-    pipeTextStreamToResponse(response: ServerResponse, init?: {
-        headers?: Record<string, string>;
-        status?: number;
-    }): void;
+    pipeTextStreamToResponse(response: ServerResponse, init?: ResponseInit): void;
     /**
     Creates a simple text stream response.
     The response has a `Content-Type` header set to `text/plain; charset=utf-8`.
     Each text delta is encoded as UTF-8 and sent as a separate chunk.
     Non-text-delta events are ignored.
   
-    @param init Optional headers and status code.
+    @param init Optional headers, status code, and status text.
        */
     toTextStreamResponse(init?: ResponseInit): Response;
 }
@@ -1522,10 +1519,22 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
     @returns A data stream.
   
-    @deprecated Use `toDataStreamResponse` instead.
+    @deprecated Use `toDataStream` instead.
        */
     toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<Uint8Array>;
     /**
+    Converts the result to a data stream.
+  
+    @param data an optional StreamData object that will be merged into the stream.
+    @param getErrorMessage an optional function that converts an error to an error message.
+  
+    @return A data stream.
+       */
+    toDataStream(options?: {
+        data?: StreamData;
+        getErrorMessage?: (error: unknown) => string;
+    }): ReadableStream<Uint8Array>;
+    /**
     Writes stream data output to a Node.js response-like object.
     It sets a `Content-Type` header to `text/plain; charset=utf-8` and
     writes each stream data part as a separate chunk.
@@ -1541,15 +1550,15 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     }): void;
     /**
     Writes data stream output to a Node.js response-like object.
-    It sets a `Content-Type` header to `text/plain; charset=utf-8` and
-    writes each data stream part as a separate chunk.
   
     @param response A Node.js response-like object (ServerResponse).
-    @param init Optional headers and status code.
+    @param options An object with an init property (ResponseInit) and a data property.
+    You can also pass in a ResponseInit directly (deprecated).
        */
-    pipeDataStreamToResponse(response: ServerResponse$1, init?: {
-        headers?: Record<string, string>;
-        status?: number;
+    pipeDataStreamToResponse(response: ServerResponse$1, options?: ResponseInit | {
+        init?: ResponseInit;
+        data?: StreamData;
+        getErrorMessage?: (error: unknown) => string;
     }): void;
     /**
     Writes text delta output to a Node.js response-like object.
@@ -1557,12 +1566,9 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     writes each text delta as a separate chunk.
   
     @param response A Node.js response-like object (ServerResponse).
-    @param init Optional headers and status code.
+    @param init Optional headers, status code, and status text.
        */
-    pipeTextStreamToResponse(response: ServerResponse$1, init?: {
-        headers?: Record<string, string>;
-        status?: number;
-    }): void;
+    pipeTextStreamToResponse(response: ServerResponse$1, init?: ResponseInit): void;
     /**
     Converts the result to a streamed response object with a stream data part stream.
     It can be used with the `useChat` and `useCompletion` hooks.
@@ -1597,7 +1603,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     Each text delta is encoded as UTF-8 and sent as a separate chunk.
     Non-text-delta events are ignored.
   
-    @param init Optional headers and status code.
+    @param init Optional headers, status code, and status text.
        */
     toTextStreamResponse(init?: ResponseInit): Response;
 }
@@ -2938,6 +2944,8 @@ declare function ReplicateStream(res: Prediction, cb?: AIStreamCallbacksAndOptio
 
 /**
  * A utility function to stream a ReadableStream to a Node.js response-like object.
+ *
+ * @deprecated Use `pipeDataStreamToResponse` (part of `StreamTextResult`) instead.
  */
 declare function streamToResponse(res: ReadableStream, response: ServerResponse$1, init?: {
     headers?: Record<string, string>;

package/dist/index.js

@@ -2152,6 +2152,55 @@ function now() {
 
 // core/generate-object/stream-object.ts
 var import_provider_utils7 = require("@ai-sdk/provider-utils");
+
+// core/util/prepare-outgoing-http-headers.ts
+function prepareOutgoingHttpHeaders(init, {
+  contentType,
+  dataStreamVersion
+}) {
+  const headers = {};
+  if ((init == null ? void 0 : init.headers) != null) {
+    for (const [key, value] of Object.entries(init.headers)) {
+      headers[key] = value;
+    }
+  }
+  if (headers["Content-Type"] == null) {
+    headers["Content-Type"] = contentType;
+  }
+  if (dataStreamVersion !== void 0) {
+    headers["X-Vercel-AI-Data-Stream"] = dataStreamVersion;
+  }
+  return headers;
+}
+
+// core/util/write-to-server-response.ts
+function writeToServerResponse({
+  response,
+  status,
+  statusText,
+  headers,
+  stream
+}) {
+  response.writeHead(status != null ? status : 200, statusText, headers);
+  const reader = stream.getReader();
+  const read = async () => {
+    try {
+      while (true) {
+        const { done, value } = await reader.read();
+        if (done)
+          break;
+        response.write(value);
+      }
+    } catch (error) {
+      throw error;
+    } finally {
+      response.end();
+    }
+  };
+  read();
+}
+
+// core/generate-object/stream-object.ts
 var originalGenerateId2 = (0, import_provider_utils7.createIdGenerator)({ prefix: "aiobj-", length: 24 });
 async function streamObject({
   model,
@@ -2630,27 +2679,15 @@ var DefaultStreamObjectResult = class {
     });
   }
   pipeTextStreamToResponse(response, init) {
-    var _a11;
-    response.writeHead((_a11 = init == null ? void 0 : init.status) != null ? _a11 : 200, {
-      "Content-Type": "text/plain; charset=utf-8",
-      ...init == null ? void 0 : init.headers
+    writeToServerResponse({
+      response,
+      status: init == null ? void 0 : init.status,
+      statusText: init == null ? void 0 : init.statusText,
+      headers: prepareOutgoingHttpHeaders(init, {
+        contentType: "text/plain; charset=utf-8"
+      }),
+      stream: this.textStream.pipeThrough(new TextEncoderStream())
     });
-    const reader = this.textStream.pipeThrough(new TextEncoderStream()).getReader();
-    const read = async () => {
-      try {
-        while (true) {
-          const { done, value } = await reader.read();
-          if (done)
-            break;
-          response.write(value);
-        }
-      } catch (error) {
-        throw error;
-      } finally {
-        response.end();
-      }
-    };
-    read();
   }
   toTextStreamResponse(init) {
     var _a11;
@@ -4019,9 +4056,9 @@ var DefaultStreamTextResult = class {
     });
   }
   toAIStream(callbacks = {}) {
-    return this.toDataStream({ callbacks });
+    return this.toDataStreamInternal({ callbacks });
   }
-  toDataStream({
+  toDataStreamInternal({
     callbacks = {},
     getErrorMessage: getErrorMessage4 = () => ""
     // mask error messages for safety by default
@@ -4129,55 +4166,45 @@ var DefaultStreamTextResult = class {
   pipeAIStreamToResponse(response, init) {
     return this.pipeDataStreamToResponse(response, init);
   }
-  pipeDataStreamToResponse(response, init) {
-    var _a11;
-    response.writeHead((_a11 = init == null ? void 0 : init.status) != null ? _a11 : 200, {
-      "Content-Type": "text/plain; charset=utf-8",
-      ...init == null ? void 0 : init.headers
-    });
-    const reader = this.toDataStream().getReader();
-    const read = async () => {
-      try {
-        while (true) {
-          const { done, value } = await reader.read();
-          if (done)
-            break;
-          response.write(value);
-        }
-      } catch (error) {
-        throw error;
-      } finally {
-        response.end();
-      }
+  pipeDataStreamToResponse(response, options) {
+    const init = options == null ? void 0 : "init" in options ? options.init : {
+      headers: "headers" in options ? options.headers : void 0,
+      status: "status" in options ? options.status : void 0,
+      statusText: "statusText" in options ? options.statusText : void 0
     };
-    read();
+    const data = options == null ? void 0 : "data" in options ? options.data : void 0;
+    const getErrorMessage4 = options == null ? void 0 : "getErrorMessage" in options ? options.getErrorMessage : void 0;
+    writeToServerResponse({
+      response,
+      status: init == null ? void 0 : init.status,
+      statusText: init == null ? void 0 : init.statusText,
+      headers: prepareOutgoingHttpHeaders(init, {
+        contentType: "text/plain; charset=utf-8",
+        dataStreamVersion: "v1"
+      }),
+      stream: this.toDataStream({ data, getErrorMessage: getErrorMessage4 })
+    });
   }
   pipeTextStreamToResponse(response, init) {
-    var _a11;
-    response.writeHead((_a11 = init == null ? void 0 : init.status) != null ? _a11 : 200, {
-      "Content-Type": "text/plain; charset=utf-8",
-      ...init == null ? void 0 : init.headers
+    writeToServerResponse({
+      response,
+      status: init == null ? void 0 : init.status,
+      statusText: init == null ? void 0 : init.statusText,
+      headers: prepareOutgoingHttpHeaders(init, {
+        contentType: "text/plain; charset=utf-8"
+      }),
+      stream: this.textStream.pipeThrough(new TextEncoderStream())
     });
-    const reader = this.textStream.pipeThrough(new TextEncoderStream()).getReader();
-    const read = async () => {
-      try {
-        while (true) {
-          const { done, value } = await reader.read();
-          if (done)
-            break;
-          response.write(value);
-        }
-      } catch (error) {
-        throw error;
-      } finally {
-        response.end();
-      }
-    };
-    read();
   }
   toAIStreamResponse(options) {
     return this.toDataStreamResponse(options);
   }
+  toDataStream(options) {
+    const stream = this.toDataStreamInternal({
+      getErrorMessage: options == null ? void 0 : options.getErrorMessage
+    });
+    return (options == null ? void 0 : options.data) ? mergeStreams(options == null ? void 0 : options.data.stream, stream) : stream;
+  }
   toDataStreamResponse(options) {
     var _a11;
     const init = options == null ? void 0 : "init" in options ? options.init : {
@@ -4187,8 +4214,7 @@ var DefaultStreamTextResult = class {
     };
     const data = options == null ? void 0 : "data" in options ? options.data : void 0;
     const getErrorMessage4 = options == null ? void 0 : "getErrorMessage" in options ? options.getErrorMessage : void 0;
-    const stream = data ? mergeStreams(data.stream, this.toDataStream({ getErrorMessage: getErrorMessage4 })) : this.toDataStream({ getErrorMessage: getErrorMessage4 });
-    return new Response(stream, {
+    return new Response(this.toDataStream({ data, getErrorMessage: getErrorMessage4 }), {
       status: (_a11 = init == null ? void 0 : init.status) != null ? _a11 : 200,
       statusText: init == null ? void 0 : init.statusText,
       headers: prepareResponseHeaders(init, {