ai 5.0.0-beta.24 → 5.0.0-beta.26

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { ModelMessage, Tool, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, ReasoningPart, Schema, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, InferSchema, FlexibleSchema, DataContent, Validator, StandardSchemaV1, ToolCall, Resolvable, FetchFunction } from '@ai-sdk/provider-utils';
+import { ModelMessage, Tool, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, ReasoningPart, Schema, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, InferSchema, FlexibleSchema, DataContent, Validator, StandardSchemaV1, Resolvable, FetchFunction } from '@ai-sdk/provider-utils';
 export { AssistantContent, AssistantModelMessage, DataContent, FilePart, IdGenerator, ImagePart, InferToolInput, InferToolOutput, ModelMessage, Schema, SystemModelMessage, TextPart, Tool, ToolCallOptions, ToolCallPart, ToolContent, ToolExecuteFunction, ToolModelMessage, ToolResultPart, UserContent, UserModelMessage, asSchema, createIdGenerator, generateId, jsonSchema, tool } from '@ai-sdk/provider-utils';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { EmbeddingModelV2, EmbeddingModelV2Embedding, ImageModelV2, ImageModelV2CallWarning, ImageModelV2ProviderMetadata, JSONValue as JSONValue$1, LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2CallWarning, LanguageModelV2Source, SharedV2ProviderMetadata, SpeechModelV2, SpeechModelV2CallWarning, TranscriptionModelV2, TranscriptionModelV2CallWarning, LanguageModelV2Usage, LanguageModelV2CallOptions, AISDKError, LanguageModelV2ToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2Middleware, ProviderV2, NoSuchModelError, JSONObject } from '@ai-sdk/provider';
@@ -1018,7 +1018,7 @@ Callback that is set using the `onChunk` option.
  */
 type StreamTextOnChunkCallback<TOOLS extends ToolSet> = (event: {
     chunk: Extract<TextStreamPart<TOOLS>, {
-        type: 'text' | 'reasoning' | 'source' | 'tool-call' | 'tool-input-start' | 'tool-input-delta' | 'tool-result' | 'raw';
+        type: 'text-delta' | 'reasoning-delta' | 'source' | 'tool-call' | 'tool-input-start' | 'tool-input-delta' | 'tool-result' | 'raw';
     }>;
 }) => PromiseLike<void> | void;
 /**
@@ -1383,6 +1383,12 @@ declare function isToolUIPart<TOOLS extends UITools>(part: UIMessagePart<UIDataT
 declare function getToolName<TOOLS extends UITools>(part: ToolUIPart<TOOLS>): keyof TOOLS;
 type InferUIMessageMetadata<T extends UIMessage> = T extends UIMessage<infer METADATA> ? METADATA : unknown;
 type InferUIMessageData<T extends UIMessage> = T extends UIMessage<unknown, infer DATA_TYPES> ? DATA_TYPES : UIDataTypes;
+type InferUIMessageTools<T extends UIMessage> = T extends UIMessage<unknown, UIDataTypes, infer TOOLS> ? TOOLS : UITools;
+type InferUIMessageToolCall<UI_MESSAGE extends UIMessage> = ValueOf<{
+    [NAME in keyof InferUIMessageTools<UI_MESSAGE>]: ToolCall<NAME & string, InferUIMessageTools<UI_MESSAGE>[NAME] extends {
+        input: infer INPUT;
+    } ? INPUT : never>;
+}>;
 
 type DataUIMessageChunk<DATA_TYPES extends UIDataTypes> = ValueOf<{
     [NAME in keyof DATA_TYPES & string]: {
@@ -1767,7 +1773,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     id: string;
     providerMetadata?: ProviderMetadata;
 } | {
-    type: 'text';
+    type: 'text-delta';
     id: string;
     providerMetadata?: ProviderMetadata;
     text: string;
@@ -1780,7 +1786,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     id: string;
     providerMetadata?: ProviderMetadata;
 } | {
-    type: 'reasoning';
+    type: 'reasoning-delta';
     providerMetadata?: ProviderMetadata;
     id: string;
     text: string;
@@ -3647,13 +3653,17 @@ declare function pipeUIMessageStreamToResponse({ response, status, statusText, h
  *
  * @param options.message - The last assistant message to use as a starting point when the conversation is resumed. Otherwise undefined.
  * @param options.stream - The stream of `UIMessageChunk`s to read.
+ * @param options.terminateOnError - Whether to terminate the stream if an error occurs.
+ * @param options.onError - A function that is called when an error occurs.
  *
  * @returns An `AsyncIterableStream` of `UIMessage`s. Each stream part is a different state of the same message
  * as it is being completed.
  */
-declare function readUIMessageStream<UI_MESSAGE extends UIMessage>({ message, stream, }: {
+declare function readUIMessageStream<UI_MESSAGE extends UIMessage>({ message, stream, onError, terminateOnError, }: {
     message?: UI_MESSAGE;
     stream: ReadableStream<UIMessageChunk>;
+    onError?: (error: unknown) => void;
+    terminateOnError?: boolean;
 }): AsyncIterableStream<UI_MESSAGE>;
 
 declare const UI_MESSAGE_STREAM_HEADERS: {
@@ -3670,7 +3680,7 @@ interface ChatTransport<UI_MESSAGE extends UIMessage> {
         messages: UI_MESSAGE[];
         abortSignal: AbortSignal | undefined;
     } & {
-        trigger: 'submit-user-message' | 'submit-tool-result' | 'regenerate-assistant-message';
+        trigger: 'submit-message' | 'regenerate-message';
         messageId: string | undefined;
     } & ChatRequestOptions) => Promise<ReadableStream<UIMessageChunk>>;
     reconnectToStream: (options: {
@@ -3711,9 +3721,9 @@ interface ChatState<UI_MESSAGE extends UIMessage> {
     snapshot: <T>(thing: T) => T;
 }
 type ChatOnErrorCallback = (error: Error) => void;
-type ChatOnToolCallCallback = ({ toolCall, }: {
-    toolCall: ToolCall<string, unknown>;
-}) => void | Promise<unknown> | unknown;
+type ChatOnToolCallCallback<UI_MESSAGE extends UIMessage = UIMessage> = (options: {
+    toolCall: InferUIMessageToolCall<UI_MESSAGE>;
+}) => void | PromiseLike<void>;
 type ChatOnDataCallback<UI_MESSAGE extends UIMessage> = (dataPart: DataUIPart<InferUIMessageData<UI_MESSAGE>>) => void;
 type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
     message: UI_MESSAGE;
@@ -3733,7 +3743,6 @@ interface ChatInit<UI_MESSAGE extends UIMessage> {
      */
     generateId?: IdGenerator;
     transport?: ChatTransport<UI_MESSAGE>;
-    maxSteps?: number;
     /**
      * Callback function to be called when an error is encountered.
      */
@@ -3745,7 +3754,7 @@ interface ChatInit<UI_MESSAGE extends UIMessage> {
     You can optionally return a result for the tool call,
     either synchronously or asynchronously.
        */
-    onToolCall?: ChatOnToolCallCallback;
+    onToolCall?: ChatOnToolCallCallback<UI_MESSAGE>;
     /**
      * Optional callback function that is called when the assistant message is finished streaming.
      *
@@ -3766,14 +3775,13 @@ declare abstract class AbstractChat<UI_MESSAGE extends UIMessage> {
     private messageMetadataSchema;
     private dataPartSchemas;
     private readonly transport;
-    private maxSteps;
     private onError?;
     private onToolCall?;
     private onFinish?;
     private onData?;
     private activeResponse;
     private jobExecutor;
-    constructor({ generateId, id, transport, maxSteps, messageMetadataSchema, dataPartSchemas, state, onError, onToolCall, onFinish, onData, }: Omit<ChatInit<UI_MESSAGE>, 'messages'> & {
+    constructor({ generateId, id, transport, messageMetadataSchema, dataPartSchemas, state, onError, onToolCall, onFinish, onData, }: Omit<ChatInit<UI_MESSAGE>, 'messages'> & {
         state: ChatState<UI_MESSAGE>;
     });
     /**
@@ -3799,7 +3807,7 @@ declare abstract class AbstractChat<UI_MESSAGE extends UIMessage> {
      *
      * If a messageId is provided, the message will be replaced.
      */
-    sendMessage: (message: (CreateUIMessage<UI_MESSAGE> & {
+    sendMessage: (message?: (CreateUIMessage<UI_MESSAGE> & {
         text?: never;
         files?: never;
         messageId?: string;
@@ -3826,10 +3834,18 @@ declare abstract class AbstractChat<UI_MESSAGE extends UIMessage> {
      * Attempt to resume an ongoing streaming response.
      */
     resumeStream: (options?: ChatRequestOptions) => Promise<void>;
-    addToolResult: ({ toolCallId, output, }: {
+    addToolResult: <TOOL extends keyof InferUIMessageTools<UI_MESSAGE>>({ tool, toolCallId, output, }: {
+        tool: TOOL;
         toolCallId: string;
-        output: unknown;
+        output: InferUIMessageTools<UI_MESSAGE>[TOOL]["output"];
     }) => Promise<void>;
+    /**
+     * Checks if the assistant message can be submitted, i.e. if it
+     * has tool calls and all tool calls have results.
+     *
+     * @returns {boolean} True if the assistant message can be submitted, false otherwise.
+     */
+    canAssistantMessageBeSubmitted: () => boolean;
     /**
      * Abort the current request immediately, keep the generated tokens if any.
      */
@@ -3865,7 +3881,7 @@ type PrepareSendMessagesRequest<UI_MESSAGE extends UIMessage> = (options: {
     headers: HeadersInit | undefined;
     api: string;
 } & {
-    trigger: 'submit-user-message' | 'submit-tool-result' | 'regenerate-assistant-message';
+    trigger: 'submit-message' | 'regenerate-message';
     messageId: string | undefined;
 }) => {
     body: object;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ModelMessage, Tool, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, ReasoningPart, Schema, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, InferSchema, FlexibleSchema, DataContent, Validator, StandardSchemaV1, ToolCall, Resolvable, FetchFunction } from '@ai-sdk/provider-utils';
+import { ModelMessage, Tool, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, ReasoningPart, Schema, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, InferSchema, FlexibleSchema, DataContent, Validator, StandardSchemaV1, Resolvable, FetchFunction } from '@ai-sdk/provider-utils';
 export { AssistantContent, AssistantModelMessage, DataContent, FilePart, IdGenerator, ImagePart, InferToolInput, InferToolOutput, ModelMessage, Schema, SystemModelMessage, TextPart, Tool, ToolCallOptions, ToolCallPart, ToolContent, ToolExecuteFunction, ToolModelMessage, ToolResultPart, UserContent, UserModelMessage, asSchema, createIdGenerator, generateId, jsonSchema, tool } from '@ai-sdk/provider-utils';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { EmbeddingModelV2, EmbeddingModelV2Embedding, ImageModelV2, ImageModelV2CallWarning, ImageModelV2ProviderMetadata, JSONValue as JSONValue$1, LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2CallWarning, LanguageModelV2Source, SharedV2ProviderMetadata, SpeechModelV2, SpeechModelV2CallWarning, TranscriptionModelV2, TranscriptionModelV2CallWarning, LanguageModelV2Usage, LanguageModelV2CallOptions, AISDKError, LanguageModelV2ToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2Middleware, ProviderV2, NoSuchModelError, JSONObject } from '@ai-sdk/provider';
@@ -1018,7 +1018,7 @@ Callback that is set using the `onChunk` option.
  */
 type StreamTextOnChunkCallback<TOOLS extends ToolSet> = (event: {
     chunk: Extract<TextStreamPart<TOOLS>, {
-        type: 'text' | 'reasoning' | 'source' | 'tool-call' | 'tool-input-start' | 'tool-input-delta' | 'tool-result' | 'raw';
+        type: 'text-delta' | 'reasoning-delta' | 'source' | 'tool-call' | 'tool-input-start' | 'tool-input-delta' | 'tool-result' | 'raw';
     }>;
 }) => PromiseLike<void> | void;
 /**
@@ -1383,6 +1383,12 @@ declare function isToolUIPart<TOOLS extends UITools>(part: UIMessagePart<UIDataT
 declare function getToolName<TOOLS extends UITools>(part: ToolUIPart<TOOLS>): keyof TOOLS;
 type InferUIMessageMetadata<T extends UIMessage> = T extends UIMessage<infer METADATA> ? METADATA : unknown;
 type InferUIMessageData<T extends UIMessage> = T extends UIMessage<unknown, infer DATA_TYPES> ? DATA_TYPES : UIDataTypes;
+type InferUIMessageTools<T extends UIMessage> = T extends UIMessage<unknown, UIDataTypes, infer TOOLS> ? TOOLS : UITools;
+type InferUIMessageToolCall<UI_MESSAGE extends UIMessage> = ValueOf<{
+    [NAME in keyof InferUIMessageTools<UI_MESSAGE>]: ToolCall<NAME & string, InferUIMessageTools<UI_MESSAGE>[NAME] extends {
+        input: infer INPUT;
+    } ? INPUT : never>;
+}>;
 
 type DataUIMessageChunk<DATA_TYPES extends UIDataTypes> = ValueOf<{
     [NAME in keyof DATA_TYPES & string]: {
@@ -1767,7 +1773,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     id: string;
     providerMetadata?: ProviderMetadata;
 } | {
-    type: 'text';
+    type: 'text-delta';
     id: string;
     providerMetadata?: ProviderMetadata;
     text: string;
@@ -1780,7 +1786,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     id: string;
     providerMetadata?: ProviderMetadata;
 } | {
-    type: 'reasoning';
+    type: 'reasoning-delta';
     providerMetadata?: ProviderMetadata;
     id: string;
     text: string;
@@ -3647,13 +3653,17 @@ declare function pipeUIMessageStreamToResponse({ response, status, statusText, h
  *
  * @param options.message - The last assistant message to use as a starting point when the conversation is resumed. Otherwise undefined.
  * @param options.stream - The stream of `UIMessageChunk`s to read.
+ * @param options.terminateOnError - Whether to terminate the stream if an error occurs.
+ * @param options.onError - A function that is called when an error occurs.
  *
  * @returns An `AsyncIterableStream` of `UIMessage`s. Each stream part is a different state of the same message
  * as it is being completed.
  */
-declare function readUIMessageStream<UI_MESSAGE extends UIMessage>({ message, stream, }: {
+declare function readUIMessageStream<UI_MESSAGE extends UIMessage>({ message, stream, onError, terminateOnError, }: {
     message?: UI_MESSAGE;
     stream: ReadableStream<UIMessageChunk>;
+    onError?: (error: unknown) => void;
+    terminateOnError?: boolean;
 }): AsyncIterableStream<UI_MESSAGE>;
 
 declare const UI_MESSAGE_STREAM_HEADERS: {
@@ -3670,7 +3680,7 @@ interface ChatTransport<UI_MESSAGE extends UIMessage> {
         messages: UI_MESSAGE[];
         abortSignal: AbortSignal | undefined;
     } & {
-        trigger: 'submit-user-message' | 'submit-tool-result' | 'regenerate-assistant-message';
+        trigger: 'submit-message' | 'regenerate-message';
         messageId: string | undefined;
     } & ChatRequestOptions) => Promise<ReadableStream<UIMessageChunk>>;
     reconnectToStream: (options: {
@@ -3711,9 +3721,9 @@ interface ChatState<UI_MESSAGE extends UIMessage> {
     snapshot: <T>(thing: T) => T;
 }
 type ChatOnErrorCallback = (error: Error) => void;
-type ChatOnToolCallCallback = ({ toolCall, }: {
-    toolCall: ToolCall<string, unknown>;
-}) => void | Promise<unknown> | unknown;
+type ChatOnToolCallCallback<UI_MESSAGE extends UIMessage = UIMessage> = (options: {
+    toolCall: InferUIMessageToolCall<UI_MESSAGE>;
+}) => void | PromiseLike<void>;
 type ChatOnDataCallback<UI_MESSAGE extends UIMessage> = (dataPart: DataUIPart<InferUIMessageData<UI_MESSAGE>>) => void;
 type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
     message: UI_MESSAGE;
@@ -3733,7 +3743,6 @@ interface ChatInit<UI_MESSAGE extends UIMessage> {
      */
     generateId?: IdGenerator;
     transport?: ChatTransport<UI_MESSAGE>;
-    maxSteps?: number;
     /**
      * Callback function to be called when an error is encountered.
      */
@@ -3745,7 +3754,7 @@ interface ChatInit<UI_MESSAGE extends UIMessage> {
     You can optionally return a result for the tool call,
     either synchronously or asynchronously.
        */
-    onToolCall?: ChatOnToolCallCallback;
+    onToolCall?: ChatOnToolCallCallback<UI_MESSAGE>;
     /**
      * Optional callback function that is called when the assistant message is finished streaming.
      *
@@ -3766,14 +3775,13 @@ declare abstract class AbstractChat<UI_MESSAGE extends UIMessage> {
     private messageMetadataSchema;
     private dataPartSchemas;
     private readonly transport;
-    private maxSteps;
     private onError?;
     private onToolCall?;
     private onFinish?;
     private onData?;
     private activeResponse;
     private jobExecutor;
-    constructor({ generateId, id, transport, maxSteps, messageMetadataSchema, dataPartSchemas, state, onError, onToolCall, onFinish, onData, }: Omit<ChatInit<UI_MESSAGE>, 'messages'> & {
+    constructor({ generateId, id, transport, messageMetadataSchema, dataPartSchemas, state, onError, onToolCall, onFinish, onData, }: Omit<ChatInit<UI_MESSAGE>, 'messages'> & {
         state: ChatState<UI_MESSAGE>;
     });
     /**
@@ -3799,7 +3807,7 @@ declare abstract class AbstractChat<UI_MESSAGE extends UIMessage> {
      *
      * If a messageId is provided, the message will be replaced.
      */
-    sendMessage: (message: (CreateUIMessage<UI_MESSAGE> & {
+    sendMessage: (message?: (CreateUIMessage<UI_MESSAGE> & {
         text?: never;
         files?: never;
         messageId?: string;
@@ -3826,10 +3834,18 @@ declare abstract class AbstractChat<UI_MESSAGE extends UIMessage> {
      * Attempt to resume an ongoing streaming response.
      */
     resumeStream: (options?: ChatRequestOptions) => Promise<void>;
-    addToolResult: ({ toolCallId, output, }: {
+    addToolResult: <TOOL extends keyof InferUIMessageTools<UI_MESSAGE>>({ tool, toolCallId, output, }: {
+        tool: TOOL;
         toolCallId: string;
-        output: unknown;
+        output: InferUIMessageTools<UI_MESSAGE>[TOOL]["output"];
     }) => Promise<void>;
+    /**
+     * Checks if the assistant message can be submitted, i.e. if it
+     * has tool calls and all tool calls have results.
+     *
+     * @returns {boolean} True if the assistant message can be submitted, false otherwise.
+     */
+    canAssistantMessageBeSubmitted: () => boolean;
     /**
      * Abort the current request immediately, keep the generated tokens if any.
      */
@@ -3865,7 +3881,7 @@ type PrepareSendMessagesRequest<UI_MESSAGE extends UIMessage> = (options: {
     headers: HeadersInit | undefined;
     api: string;
 } & {
-    trigger: 'submit-user-message' | 'submit-tool-result' | 'regenerate-assistant-message';
+    trigger: 'submit-message' | 'regenerate-message';
     messageId: string | undefined;
 }) => {
     body: object;