ai 4.1.44 → 4.1.45

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 4.1.45
+
+### Patch Changes
+
+- 93bd5a0: feat (ai/ui): add writeSource to createDataStream
+
 ## 4.1.44
 
 ### Patch Changes

package/dist/index.d.mts

@@ -2,13 +2,61 @@ import { IDGenerator } from '@ai-sdk/provider-utils';
 export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
 import { DataStreamString, Message, Schema, DeepPartial, JSONValue as JSONValue$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UIMessage, UseAssistantOptions, formatAssistantStreamPart, formatDataStreamPart, jsonSchema, parseAssistantStreamPart, parseDataStreamPart, processDataStream, processTextStream, zodSchema } from '@ai-sdk/ui-utils';
-import { JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1Source, LanguageModelV1ProviderMetadata, JSONParseError, TypeValidationError, LanguageModelV1CallOptions, AISDKError, LanguageModelV1FunctionToolCall, JSONSchema7, ProviderV1, NoSuchModelError } from '@ai-sdk/provider';
+import { LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONParseError, TypeValidationError, LanguageModelV1CallOptions, AISDKError, LanguageModelV1FunctionToolCall, JSONSchema7, ProviderV1, NoSuchModelError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1Prompt, LanguageModelV1StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { ServerResponse } from 'node:http';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { z } from 'zod';
 import { ServerResponse as ServerResponse$1 } from 'http';
 
+/**
+Language model that is used by the AI SDK Core functions.
+*/
+type LanguageModel = LanguageModelV1;
+/**
+Reason why a language model finished generating a response.
+
+Can be one of the following:
+- `stop`: model generated stop sequence
+- `length`: model generated maximum number of tokens
+- `content-filter`: content filter violation stopped the model
+- `tool-calls`: model triggered tool calls
+- `error`: model stopped because of an error
+- `other`: model stopped for other reasons
+*/
+type FinishReason = LanguageModelV1FinishReason;
+/**
+Log probabilities for each token and its top log probabilities.
+
+@deprecated Will become a provider extension in the future.
+ */
+type LogProbs = LanguageModelV1LogProbs;
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+*/
+type CallWarning = LanguageModelV1CallWarning;
+/**
+A source that has been used as input to generate the response.
+*/
+type Source = LanguageModelV1Source;
+/**
+Tool choice for the generation. It supports the following settings:
+
+- `auto` (default): the model can choose whether and which tools to call.
+- `required`: the model must call a tool. It can choose which tool to call.
+- `none`: the model must not call tools
+- `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
+ */
+type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
+    type: 'tool';
+    toolName: keyof TOOLS;
+};
+/**
+ * @deprecated Use `ToolChoice` instead.
+ */
+type CoreToolChoice<TOOLS extends Record<string, unknown>> = ToolChoice<TOOLS>;
+
 interface DataStreamWriter {
     /**
      * Appends a data part to the stream.
@@ -22,6 +70,10 @@ interface DataStreamWriter {
      * Appends a message annotation to the stream.
      */
     writeMessageAnnotation(value: JSONValue): void;
+    /**
+     * Appends a source part to the stream.
+     */
+    writeSource(source: Source): void;
     /**
      * Merges the contents of another stream to this stream.
      */
@@ -119,54 +171,6 @@ type ImageModelResponseMetadata = {
     headers?: Record<string, string>;
 };
 
-/**
-Language model that is used by the AI SDK Core functions.
-*/
-type LanguageModel = LanguageModelV1;
-/**
-Reason why a language model finished generating a response.
-
-Can be one of the following:
-- `stop`: model generated stop sequence
-- `length`: model generated maximum number of tokens
-- `content-filter`: content filter violation stopped the model
-- `tool-calls`: model triggered tool calls
-- `error`: model stopped because of an error
-- `other`: model stopped for other reasons
-*/
-type FinishReason = LanguageModelV1FinishReason;
-/**
-Log probabilities for each token and its top log probabilities.
-
-@deprecated Will become a provider extension in the future.
- */
-type LogProbs = LanguageModelV1LogProbs;
-/**
-Warning from the model provider for this call. The call will proceed, but e.g.
-some settings might not be supported, which can lead to suboptimal results.
-*/
-type CallWarning = LanguageModelV1CallWarning;
-/**
-A source that has been used as input to generate the response.
-*/
-type Source = LanguageModelV1Source;
-/**
-Tool choice for the generation. It supports the following settings:
-
-- `auto` (default): the model can choose whether and which tools to call.
-- `required`: the model must call a tool. It can choose which tool to call.
-- `none`: the model must not call tools
-- `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
- */
-type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
-    type: 'tool';
-    toolName: keyof TOOLS;
-};
-/**
- * @deprecated Use `ToolChoice` instead.
- */
-type CoreToolChoice<TOOLS extends Record<string, unknown>> = ToolChoice<TOOLS>;
-
 type LanguageModelRequestMetadata = {
     /**
     Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).

package/dist/index.d.ts

@@ -2,13 +2,61 @@ import { IDGenerator } from '@ai-sdk/provider-utils';
 export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
 import { DataStreamString, Message, Schema, DeepPartial, JSONValue as JSONValue$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UIMessage, UseAssistantOptions, formatAssistantStreamPart, formatDataStreamPart, jsonSchema, parseAssistantStreamPart, parseDataStreamPart, processDataStream, processTextStream, zodSchema } from '@ai-sdk/ui-utils';
-import { JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1Source, LanguageModelV1ProviderMetadata, JSONParseError, TypeValidationError, LanguageModelV1CallOptions, AISDKError, LanguageModelV1FunctionToolCall, JSONSchema7, ProviderV1, NoSuchModelError } from '@ai-sdk/provider';
+import { LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONParseError, TypeValidationError, LanguageModelV1CallOptions, AISDKError, LanguageModelV1FunctionToolCall, JSONSchema7, ProviderV1, NoSuchModelError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1Prompt, LanguageModelV1StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { ServerResponse } from 'node:http';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { z } from 'zod';
 import { ServerResponse as ServerResponse$1 } from 'http';
 
+/**
+Language model that is used by the AI SDK Core functions.
+*/
+type LanguageModel = LanguageModelV1;
+/**
+Reason why a language model finished generating a response.
+
+Can be one of the following:
+- `stop`: model generated stop sequence
+- `length`: model generated maximum number of tokens
+- `content-filter`: content filter violation stopped the model
+- `tool-calls`: model triggered tool calls
+- `error`: model stopped because of an error
+- `other`: model stopped for other reasons
+*/
+type FinishReason = LanguageModelV1FinishReason;
+/**
+Log probabilities for each token and its top log probabilities.
+
+@deprecated Will become a provider extension in the future.
+ */
+type LogProbs = LanguageModelV1LogProbs;
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+*/
+type CallWarning = LanguageModelV1CallWarning;
+/**
+A source that has been used as input to generate the response.
+*/
+type Source = LanguageModelV1Source;
+/**
+Tool choice for the generation. It supports the following settings:
+
+- `auto` (default): the model can choose whether and which tools to call.
+- `required`: the model must call a tool. It can choose which tool to call.
+- `none`: the model must not call tools
+- `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
+ */
+type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
+    type: 'tool';
+    toolName: keyof TOOLS;
+};
+/**
+ * @deprecated Use `ToolChoice` instead.
+ */
+type CoreToolChoice<TOOLS extends Record<string, unknown>> = ToolChoice<TOOLS>;
+
 interface DataStreamWriter {
     /**
      * Appends a data part to the stream.
@@ -22,6 +70,10 @@ interface DataStreamWriter {
      * Appends a message annotation to the stream.
      */
     writeMessageAnnotation(value: JSONValue): void;
+    /**
+     * Appends a source part to the stream.
+     */
+    writeSource(source: Source): void;
     /**
      * Merges the contents of another stream to this stream.
      */
@@ -119,54 +171,6 @@ type ImageModelResponseMetadata = {
     headers?: Record<string, string>;
 };
 
-/**
-Language model that is used by the AI SDK Core functions.
-*/
-type LanguageModel = LanguageModelV1;
-/**
-Reason why a language model finished generating a response.
-
-Can be one of the following:
-- `stop`: model generated stop sequence
-- `length`: model generated maximum number of tokens
-- `content-filter`: content filter violation stopped the model
-- `tool-calls`: model triggered tool calls
-- `error`: model stopped because of an error
-- `other`: model stopped for other reasons
-*/
-type FinishReason = LanguageModelV1FinishReason;
-/**
-Log probabilities for each token and its top log probabilities.
-
-@deprecated Will become a provider extension in the future.
- */
-type LogProbs = LanguageModelV1LogProbs;
-/**
-Warning from the model provider for this call. The call will proceed, but e.g.
-some settings might not be supported, which can lead to suboptimal results.
-*/
-type CallWarning = LanguageModelV1CallWarning;
-/**
-A source that has been used as input to generate the response.
-*/
-type Source = LanguageModelV1Source;
-/**
-Tool choice for the generation. It supports the following settings:
-
-- `auto` (default): the model can choose whether and which tools to call.
-- `required`: the model must call a tool. It can choose which tool to call.
-- `none`: the model must not call tools
-- `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
- */
-type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
-    type: 'tool';
-    toolName: keyof TOOLS;
-};
-/**
- * @deprecated Use `ToolChoice` instead.
- */
-type CoreToolChoice<TOOLS extends Record<string, unknown>> = ToolChoice<TOOLS>;
-
 type LanguageModelRequestMetadata = {
     /**
     Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).

package/dist/index.js

@@ -126,6 +126,9 @@ function createDataStream({
       writeMessageAnnotation(annotation) {
         safeEnqueue((0, import_ui_utils.formatDataStreamPart)("message_annotations", [annotation]));
       },
+      writeSource(source) {
+        safeEnqueue((0, import_ui_utils.formatDataStreamPart)("source", source));
+      },
       merge(streamArg) {
         ongoingStreamPromises.push(
           (async () => {