ai 4.1.34 → 4.1.35

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # ai
 
+## 4.1.35
+
+### Patch Changes
+
+- 166e09e: feat (ai/ui): forward source parts to useChat
+- Updated dependencies [166e09e]
+  - @ai-sdk/ui-utils@1.1.12
+  - @ai-sdk/react@1.1.12
+
 ## 4.1.34
 
 ### Patch Changes

package/dist/index.d.mts

@@ -2089,6 +2089,23 @@ declare class StreamData {
     appendMessageAnnotation(value: JSONValue$1): void;
 }
 
+type DataStreamOptions = {
+    /**
+     * Send usage parts to the client.
+     * Default to true.
+     */
+    sendUsage?: boolean;
+    /**
+     * Send reasoning parts to the client.
+     * Default to false.
+     */
+    sendReasoning?: boolean;
+    /**
+     * Send source parts to the client.
+     * Default to false.
+     */
+    sendSources?: boolean;
+};
 /**
 A result object for accessing different stream types and additional information.
  */
@@ -2211,9 +2228,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
     toDataStream(options?: {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
-        sendUsage?: boolean;
-        sendReasoning?: boolean;
-    }): ReadableStream<Uint8Array>;
+    } & DataStreamOptions): ReadableStream<Uint8Array>;
     /**
      * Merges the result as a data stream into another data stream.
      *
@@ -2221,10 +2236,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
      * @param options.sendUsage Whether to send the usage information to the client. Defaults to true.
      * @param options.sendReasoning Whether to send the reasoning information to the client. Defaults to false.
      */
-    mergeIntoDataStream(dataStream: DataStreamWriter, options?: {
-        sendUsage?: boolean;
-        sendReasoning?: boolean;
-    }): void;
+    mergeIntoDataStream(dataStream: DataStreamWriter, options?: DataStreamOptions): void;
     /**
     Writes data stream output to a Node.js response-like object.
   
@@ -2240,9 +2252,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
     pipeDataStreamToResponse(response: ServerResponse, options?: ResponseInit & {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
-        sendUsage?: boolean;
-        sendReasoning?: boolean;
-    }): void;
+    } & DataStreamOptions): void;
     /**
     Writes text delta output to a Node.js response-like object.
     It sets a `Content-Type` header to `text/plain; charset=utf-8` and
@@ -2269,9 +2279,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
     toDataStreamResponse(options?: ResponseInit & {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
-        sendUsage?: boolean;
-        sendReasoning?: boolean;
-    }): Response;
+    } & DataStreamOptions): Response;
     /**
     Creates a simple text stream response.
     Each text delta is encoded as UTF-8 and sent as a separate chunk.
@@ -3050,4 +3058,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, customProvider, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, customProvider, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };

package/dist/index.d.ts

@@ -2089,6 +2089,23 @@ declare class StreamData {
     appendMessageAnnotation(value: JSONValue$1): void;
 }
 
+type DataStreamOptions = {
+    /**
+     * Send usage parts to the client.
+     * Default to true.
+     */
+    sendUsage?: boolean;
+    /**
+     * Send reasoning parts to the client.
+     * Default to false.
+     */
+    sendReasoning?: boolean;
+    /**
+     * Send source parts to the client.
+     * Default to false.
+     */
+    sendSources?: boolean;
+};
 /**
 A result object for accessing different stream types and additional information.
  */
@@ -2211,9 +2228,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
     toDataStream(options?: {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
-        sendUsage?: boolean;
-        sendReasoning?: boolean;
-    }): ReadableStream<Uint8Array>;
+    } & DataStreamOptions): ReadableStream<Uint8Array>;
     /**
      * Merges the result as a data stream into another data stream.
      *
@@ -2221,10 +2236,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
      * @param options.sendUsage Whether to send the usage information to the client. Defaults to true.
      * @param options.sendReasoning Whether to send the reasoning information to the client. Defaults to false.
      */
-    mergeIntoDataStream(dataStream: DataStreamWriter, options?: {
-        sendUsage?: boolean;
-        sendReasoning?: boolean;
-    }): void;
+    mergeIntoDataStream(dataStream: DataStreamWriter, options?: DataStreamOptions): void;
     /**
     Writes data stream output to a Node.js response-like object.
   
@@ -2240,9 +2252,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
     pipeDataStreamToResponse(response: ServerResponse, options?: ResponseInit & {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
-        sendUsage?: boolean;
-        sendReasoning?: boolean;
-    }): void;
+    } & DataStreamOptions): void;
     /**
     Writes text delta output to a Node.js response-like object.
     It sets a `Content-Type` header to `text/plain; charset=utf-8` and
@@ -2269,9 +2279,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
     toDataStreamResponse(options?: ResponseInit & {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
-        sendUsage?: boolean;
-        sendReasoning?: boolean;
-    }): Response;
+    } & DataStreamOptions): Response;
     /**
     Creates a simple text stream response.
     Each text delta is encoded as UTF-8 and sent as a separate chunk.
@@ -3050,4 +3058,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, customProvider, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, customProvider, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };

package/dist/index.js

@@ -5586,7 +5586,8 @@ var DefaultStreamTextResult = class {
     getErrorMessage: getErrorMessage5 = () => "An error occurred.",
     // mask error messages for safety by default
     sendUsage = true,
-    sendReasoning = false
+    sendReasoning = false,
+    sendSources = false
   }) {
     return this.fullStream.pipeThrough(
       new TransformStream({
@@ -5606,6 +5607,11 @@ var DefaultStreamTextResult = class {
               break;
             }
             case "source": {
+              if (sendSources) {
+                controller.enqueue(
+                  (0, import_ui_utils8.formatDataStreamPart)("source", chunk.source)
+                );
+              }
               break;
             }
             case "tool-call-streaming-start": {
@@ -5700,7 +5706,8 @@ var DefaultStreamTextResult = class {
     data,
     getErrorMessage: getErrorMessage5,
     sendUsage,
-    sendReasoning
+    sendReasoning,
+    sendSources
   } = {}) {
     writeToServerResponse({
       response,
@@ -5714,7 +5721,8 @@ var DefaultStreamTextResult = class {
         data,
         getErrorMessage: getErrorMessage5,
         sendUsage,
-        sendReasoning
+        sendReasoning,
+        sendSources
       })
     });
   }
@@ -5734,7 +5742,8 @@ var DefaultStreamTextResult = class {
     const stream = this.toDataStreamInternal({
       getErrorMessage: options == null ? void 0 : options.getErrorMessage,
       sendUsage: options == null ? void 0 : options.sendUsage,
-      sendReasoning: options == null ? void 0 : options.sendReasoning
+      sendReasoning: options == null ? void 0 : options.sendReasoning,
+      sendSources: options == null ? void 0 : options.sendSources
     }).pipeThrough(new TextEncoderStream());
     return (options == null ? void 0 : options.data) ? mergeStreams(options == null ? void 0 : options.data.stream, stream) : stream;
   }
@@ -5743,7 +5752,8 @@ var DefaultStreamTextResult = class {
       this.toDataStreamInternal({
         getErrorMessage: writer.onError,
         sendUsage: options == null ? void 0 : options.sendUsage,
-        sendReasoning: options == null ? void 0 : options.sendReasoning
+        sendReasoning: options == null ? void 0 : options.sendReasoning,
+        sendSources: options == null ? void 0 : options.sendSources
       })
     );
   }
@@ -5754,10 +5764,17 @@ var DefaultStreamTextResult = class {
     data,
     getErrorMessage: getErrorMessage5,
     sendUsage,
-    sendReasoning
+    sendReasoning,
+    sendSources
   } = {}) {
     return new Response(
-      this.toDataStream({ data, getErrorMessage: getErrorMessage5, sendUsage, sendReasoning }),
+      this.toDataStream({
+        data,
+        getErrorMessage: getErrorMessage5,
+        sendUsage,
+        sendReasoning,
+        sendSources
+      }),
       {
         status,
         statusText,