ai 3.3.33 → 3.3.35

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # ai
 
+## 3.3.35
+
+### Patch Changes
+
+- 14210d5: feat (ai/core): add sendUsage information to streamText data stream methods
+- Updated dependencies [14210d5]
+  - @ai-sdk/ui-utils@0.0.42
+  - @ai-sdk/react@0.0.57
+  - @ai-sdk/solid@0.0.45
+  - @ai-sdk/svelte@0.0.47
+  - @ai-sdk/vue@0.0.47
+
+## 3.3.34
+
+### Patch Changes
+
+- a0403d6: feat (react): support sending attachments using append
+- 678449a: feat (ai/core): export test helpers
+- ff22fac: fix (ai/rsc): streamUI onFinish is called when tool calls have finished
+- Updated dependencies [a0403d6]
+  - @ai-sdk/react@0.0.56
+
 ## 3.3.33
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { Schema, DeepPartial, ToolInvocation, Attachment, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
-export { AssistantMessage, AssistantStatus, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseStreamPart, processDataProtocolResponse, readDataStream } from '@ai-sdk/ui-utils';
+export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseStreamPart, processDataProtocolResponse, readDataStream } from '@ai-sdk/ui-utils';
 import { AttributeValue } from '@opentelemetry/api';
 import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, LanguageModelV1CallOptions, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1Prompt, LanguageModelV1StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
@@ -1619,12 +1619,14 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
     @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.
+    @param sendUsage whether to send the usage information to the client. Defaults to true.
   
     @return A data stream.
        */
     toDataStream(options?: {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
+        sendUsage?: boolean;
     }): ReadableStream<Uint8Array>;
     /**
     Writes stream data output to a Node.js response-like object.
@@ -1651,6 +1653,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         init?: ResponseInit;
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
+        sendUsage?: boolean;
     }): void;
     /**
     Writes text delta output to a Node.js response-like object.
@@ -1689,6 +1692,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         init?: ResponseInit;
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
+        sendUsage?: boolean;
     }): Response;
     /**
     Creates a simple text stream response.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Schema, DeepPartial, ToolInvocation, Attachment, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
-export { AssistantMessage, AssistantStatus, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseStreamPart, processDataProtocolResponse, readDataStream } from '@ai-sdk/ui-utils';
+export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseStreamPart, processDataProtocolResponse, readDataStream } from '@ai-sdk/ui-utils';
 import { AttributeValue } from '@opentelemetry/api';
 import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, LanguageModelV1CallOptions, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1Prompt, LanguageModelV1StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
@@ -1619,12 +1619,14 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
     @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.
+    @param sendUsage whether to send the usage information to the client. Defaults to true.
   
     @return A data stream.
        */
     toDataStream(options?: {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
+        sendUsage?: boolean;
     }): ReadableStream<Uint8Array>;
     /**
     Writes stream data output to a Node.js response-like object.
@@ -1651,6 +1653,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         init?: ResponseInit;
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
+        sendUsage?: boolean;
     }): void;
     /**
     Writes text delta output to a Node.js response-like object.
@@ -1689,6 +1692,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         init?: ResponseInit;
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
+        sendUsage?: boolean;
     }): Response;
     /**
     Creates a simple text stream response.

package/dist/index.js

@@ -4185,8 +4185,9 @@ var DefaultStreamTextResult = class {
   }
   toDataStreamInternal({
     callbacks = {},
-    getErrorMessage: getErrorMessage4 = () => ""
+    getErrorMessage: getErrorMessage4 = () => "",
     // mask error messages for safety by default
+    sendUsage = true
   } = {}) {
     let aggregatedResponse = "";
     const callbackTransformer = new TransformStream({
@@ -4261,10 +4262,10 @@ var DefaultStreamTextResult = class {
             controller.enqueue(
               (0, import_ui_utils10.formatStreamPart)("finish_roundtrip", {
                 finishReason: chunk.finishReason,
-                usage: {
+                usage: sendUsage ? {
                   promptTokens: chunk.usage.promptTokens,
                   completionTokens: chunk.usage.completionTokens
-                }
+                } : void 0
               })
             );
             break;
@@ -4272,10 +4273,10 @@ var DefaultStreamTextResult = class {
             controller.enqueue(
               (0, import_ui_utils10.formatStreamPart)("finish_message", {
                 finishReason: chunk.finishReason,
-                usage: {
+                usage: sendUsage ? {
                   promptTokens: chunk.usage.promptTokens,
                   completionTokens: chunk.usage.completionTokens
-                }
+                } : void 0
               })
             );
             break;
@@ -4299,6 +4300,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 sendUsage = options == null ? void 0 : "sendUsage" in options ? options.sendUsage : void 0;
     writeToServerResponse({
       response,
       status: init == null ? void 0 : init.status,
@@ -4307,7 +4309,7 @@ var DefaultStreamTextResult = class {
         contentType: "text/plain; charset=utf-8",
         dataStreamVersion: "v1"
       }),
-      stream: this.toDataStream({ data, getErrorMessage: getErrorMessage4 })
+      stream: this.toDataStream({ data, getErrorMessage: getErrorMessage4, sendUsage })
     });
   }
   pipeTextStreamToResponse(response, init) {
@@ -4326,7 +4328,8 @@ var DefaultStreamTextResult = class {
   }
   toDataStream(options) {
     const stream = this.toDataStreamInternal({
-      getErrorMessage: options == null ? void 0 : options.getErrorMessage
+      getErrorMessage: options == null ? void 0 : options.getErrorMessage,
+      sendUsage: options == null ? void 0 : options.sendUsage
     });
     return (options == null ? void 0 : options.data) ? mergeStreams(options == null ? void 0 : options.data.stream, stream) : stream;
   }
@@ -4339,14 +4342,18 @@ 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;
-    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, {
-        contentType: "text/plain; charset=utf-8",
-        dataStreamVersion: "v1"
-      })
-    });
+    const sendUsage = options == null ? void 0 : "sendUsage" in options ? options.sendUsage : void 0;
+    return new Response(
+      this.toDataStream({ data, getErrorMessage: getErrorMessage4, sendUsage }),
+      {
+        status: (_a11 = init == null ? void 0 : init.status) != null ? _a11 : 200,
+        statusText: init == null ? void 0 : init.statusText,
+        headers: prepareResponseHeaders(init, {
+          contentType: "text/plain; charset=utf-8",
+          dataStreamVersion: "v1"
+        })
+      }
+    );
   }
   toTextStreamResponse(init) {
     var _a11;