ai 5.0.0-canary.22 → 5.0.0-canary.23

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { ToolResultContent, Schema, ToolCall, ToolResult, IdGenerator, FetchFunction } from '@ai-sdk/provider-utils';
+import { ToolResultContent, Schema, ToolCall, ToolResult, FetchFunction, IdGenerator } from '@ai-sdk/provider-utils';
 export { IdGenerator, Schema, ToolCall, ToolResult, asSchema, createIdGenerator, generateId, jsonSchema } from '@ai-sdk/provider-utils';
 import { AISDKError, SharedV2ProviderMetadata, SharedV2ProviderOptions, EmbeddingModelV2, EmbeddingModelV2Embedding, ImageModelV2, ImageModelV2CallWarning, ImageModelV2ProviderMetadata, JSONValue as JSONValue$1, LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2CallWarning, LanguageModelV2Source, SpeechModelV1, SpeechModelV1CallWarning, TranscriptionModelV1, TranscriptionModelV1CallWarning, LanguageModelV2Usage, JSONObject, LanguageModelV2ToolCall, JSONSchema7, LanguageModelV2CallOptions, JSONParseError, TypeValidationError, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, JSONSchema7, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
@@ -2287,273 +2287,6 @@ declare function appendClientMessage({ messages, message, }: {
     message: UIMessage;
 }): UIMessage<unknown>[];
 
-type ChatRequestOptions = {
-    /**
-    Additional headers that should be to be passed to the API endpoint.
-     */
-    headers?: Record<string, string> | Headers;
-    /**
-    Additional body JSON properties that should be sent to the API endpoint.
-     */
-    body?: object;
-};
-type UseChatOptions<MESSAGE_METADATA = unknown> = {
-    /**
-     * Schema for the message metadata. Validates the message metadata.
-     * Message metadata can be undefined or must match the schema.
-     */
-    messageMetadataSchema?: Schema<MESSAGE_METADATA>;
-    /**
-     * The API endpoint that accepts a `{ messages: Message[] }` object and returns
-     * a stream of tokens of the AI chat response. Defaults to `/api/chat`.
-     */
-    api?: string;
-    /**
-     * A unique identifier for the chat. If not provided, a random one will be
-     * generated. When provided, the `useChat` hook with the same `id` will
-     * have shared states across components.
-     */
-    id?: string;
-    /**
-     * Initial messages of the chat. Useful to load an existing chat history.
-     */
-    initialMessages?: UIMessage<NoInfer<MESSAGE_METADATA>>[];
-    /**
-     * Initial input of the chat.
-     */
-    initialInput?: string;
-    /**
-    Optional callback function that is invoked when a tool call is received.
-    Intended for automatic client-side tool execution.
-  
-    You can optionally return a result for the tool call,
-    either synchronously or asynchronously.
-       */
-    onToolCall?: ({ toolCall, }: {
-        toolCall: ToolCall<string, unknown>;
-    }) => void | Promise<unknown> | unknown;
-    /**
-     * Optional callback function that is called when the assistant message is finished streaming.
-     *
-     * @param message The message that was streamed.
-     */
-    onFinish?: (options: {
-        message: UIMessage<NoInfer<MESSAGE_METADATA>>;
-    }) => void;
-    /**
-     * Callback function to be called when an error is encountered.
-     */
-    onError?: (error: Error) => void;
-    /**
-     * A way to provide a function that is going to be used for ids for messages and the chat.
-     * If not provided the default AI SDK `generateId` is used.
-     */
-    generateId?: IdGenerator;
-    /**
-     * The credentials mode to be used for the fetch request.
-     * Possible values are: 'omit', 'same-origin', 'include'.
-     * Defaults to 'same-origin'.
-     */
-    credentials?: RequestCredentials;
-    /**
-     * HTTP headers to be sent with the API request.
-     */
-    headers?: Record<string, string> | Headers;
-    /**
-     * Extra body object to be sent with the API request.
-     * @example
-     * Send a `sessionId` to the API along with the messages.
-     * ```js
-     * useChat({
-     *   body: {
-     *     sessionId: '123',
-     *   }
-     * })
-     * ```
-     */
-    body?: object;
-    /**
-    Streaming protocol that is used. Defaults to `ui-message`.
-       */
-    streamProtocol?: 'ui-message' | 'text';
-    /**
-    Custom fetch implementation. You can use it as a middleware to intercept requests,
-    or to provide a custom fetch implementation for e.g. testing.
-        */
-    fetch?: FetchFunction;
-    /**
-    Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
-    Must be at least 1.
-  
-    A maximum number is required to prevent infinite loops in the case of misconfigured tools.
-  
-    By default, it's set to 1, which means that only a single LLM call is made.
-     */
-    maxSteps?: number;
-};
-
-declare const getOriginalFetch$1: () => typeof fetch;
-declare function callChatApi<MESSAGE_METADATA>({ api, body, streamProtocol, credentials, headers, abortController, onUpdate, onFinish, onToolCall, generateId, fetch, lastMessage, requestType, messageMetadataSchema, }: {
-    api: string;
-    body: Record<string, any>;
-    streamProtocol: 'ui-message' | 'text' | undefined;
-    credentials: RequestCredentials | undefined;
-    headers: HeadersInit | undefined;
-    abortController: (() => AbortController | null) | undefined;
-    onUpdate: (options: {
-        message: UIMessage<MESSAGE_METADATA>;
-    }) => void;
-    onFinish: UseChatOptions<MESSAGE_METADATA>['onFinish'];
-    onToolCall: UseChatOptions<MESSAGE_METADATA>['onToolCall'];
-    generateId: IdGenerator;
-    fetch: ReturnType<typeof getOriginalFetch$1> | undefined;
-    lastMessage: UIMessage<MESSAGE_METADATA> | undefined;
-    requestType?: 'generate' | 'resume';
-    messageMetadataSchema?: Schema<MESSAGE_METADATA>;
-}): Promise<void>;
-
-declare const getOriginalFetch: () => typeof fetch;
-declare function callCompletionApi({ api, prompt, credentials, headers, body, streamProtocol, setCompletion, setLoading, setError, setAbortController, onFinish, onError, fetch, }: {
-    api: string;
-    prompt: string;
-    credentials: RequestCredentials | undefined;
-    headers: HeadersInit | undefined;
-    body: Record<string, any>;
-    streamProtocol: 'data' | 'text' | undefined;
-    setCompletion: (completion: string) => void;
-    setLoading: (loading: boolean) => void;
-    setError: (error: Error | undefined) => void;
-    setAbortController: (abortController: AbortController | null) => void;
-    onFinish: ((prompt: string, completion: string) => void) | undefined;
-    onError: ((error: Error) => void) | undefined;
-    fetch: ReturnType<typeof getOriginalFetch> | undefined;
-}): Promise<string | null | undefined>;
-
-declare function convertFileListToFileUIParts(files: FileList | undefined): Promise<Array<FileUIPart>>;
-
-/**
-Converts an array of messages from useChat into an array of CoreMessages that can be used
-with the AI core functions (e.g. `streamText`).
- */
-declare function convertToModelMessages<TOOLS extends ToolSet = never>(messages: Array<Omit<UIMessage, 'id'>>, options?: {
-    tools?: TOOLS;
-}): ModelMessage[];
-/**
-@deprecated Use `convertToModelMessages` instead.
- */
-declare const convertToCoreMessages: typeof convertToModelMessages;
-
-declare function extractMaxToolInvocationStep(toolInvocations: ToolInvocation[] | undefined): number | undefined;
-
-declare function getToolInvocations(message: UIMessage): ToolInvocation[];
-
-declare function processTextStream({ stream, onTextPart, }: {
-    stream: ReadableStream<Uint8Array>;
-    onTextPart: (chunk: string) => Promise<void> | void;
-}): Promise<void>;
-
-declare function shouldResubmitMessages({ originalMaxToolInvocationStep, originalMessageCount, maxSteps, messages, }: {
-    originalMaxToolInvocationStep: number | undefined;
-    originalMessageCount: number;
-    maxSteps: number;
-    messages: UIMessage[];
-}): boolean;
-/**
-Check if the message is an assistant message with completed tool calls.
-The last step of the message must have at least one tool invocation and
-all tool invocations must have a result.
- */
-declare function isAssistantMessageWithCompletedToolCalls(message: UIMessage): message is UIMessage & {
-    role: 'assistant';
-};
-
-/**
- * Updates the result of a specific tool invocation in the last message of the given messages array.
- *
- * @param {object} params - The parameters object.
- * @param {UIMessage[]} params.messages - An array of messages, from which the last one is updated.
- * @param {string} params.toolCallId - The unique identifier for the tool invocation to update.
- * @param {unknown} params.toolResult - The result object to attach to the tool invocation.
- * @returns {void} This function does not return anything.
- */
-declare function updateToolCallResult({ messages, toolCallId, toolResult: result, }: {
-    messages: UIMessage[];
-    toolCallId: string;
-    toolResult: unknown;
-}): void;
-
-type CompletionRequestOptions = {
-    /**
-    An optional object of headers to be passed to the API endpoint.
-     */
-    headers?: Record<string, string> | Headers;
-    /**
-    An optional object to be passed to the API endpoint.
-       */
-    body?: object;
-};
-type UseCompletionOptions = {
-    /**
-     * The API endpoint that accepts a `{ prompt: string }` object and returns
-     * a stream of tokens of the AI completion response. Defaults to `/api/completion`.
-     */
-    api?: string;
-    /**
-     * An unique identifier for the chat. If not provided, a random one will be
-     * generated. When provided, the `useChat` hook with the same `id` will
-     * have shared states across components.
-     */
-    id?: string;
-    /**
-     * Initial prompt input of the completion.
-     */
-    initialInput?: string;
-    /**
-     * Initial completion result. Useful to load an existing history.
-     */
-    initialCompletion?: string;
-    /**
-     * Callback function to be called when the completion is finished streaming.
-     */
-    onFinish?: (prompt: string, completion: string) => void;
-    /**
-     * Callback function to be called when an error is encountered.
-     */
-    onError?: (error: Error) => void;
-    /**
-     * The credentials mode to be used for the fetch request.
-     * Possible values are: 'omit', 'same-origin', 'include'.
-     * Defaults to 'same-origin'.
-     */
-    credentials?: RequestCredentials;
-    /**
-     * HTTP headers to be sent with the API request.
-     */
-    headers?: Record<string, string> | Headers;
-    /**
-     * Extra body object to be sent with the API request.
-     * @example
-     * Send a `sessionId` to the API along with the prompt.
-     * ```js
-     * useChat({
-     *   body: {
-     *     sessionId: '123',
-     *   }
-     * })
-     * ```
-     */
-    body?: object;
-    /**
-    Streaming protocol that is used. Defaults to `data`.
-       */
-    streamProtocol?: 'data' | 'text';
-    /**
-    Custom fetch implementation. You can use it as a middleware to intercept requests,
-    or to provide a custom fetch implementation for e.g. testing.
-        */
-    fetch?: FetchFunction;
-};
-
 declare const uiMessageStreamPartSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     type: z.ZodLiteral<"text">;
     value: z.ZodString;
@@ -2882,40 +2615,702 @@ declare const uiMessageStreamPartSchema: z.ZodDiscriminatedUnion<"type", [z.ZodO
 }>]>;
 type UIMessageStreamPart = z.infer<typeof uiMessageStreamPartSchema>;
 
-interface UIMessageStreamWriter {
+type Job = () => Promise<void>;
+
+declare class SerialJobExecutor {
+    private queue;
+    private isProcessing;
+    private processQueue;
+    run(job: Job): Promise<void>;
+}
+
+interface UIMessageStreamWriter {
+    /**
+     * Appends a data stream part to the stream.
+     */
+    write(part: UIMessageStreamPart): void;
+    /**
+     * Merges the contents of another stream to this stream.
+     */
+    merge(stream: ReadableStream<UIMessageStreamPart>): void;
+    /**
+     * Error handler that is used by the data stream writer.
+     * This is intended for forwarding when merging streams
+     * to prevent duplicated error masking.
+     */
+    onError: ((error: unknown) => string) | undefined;
+}
+
+declare function createUIMessageStream({ execute, onError, }: {
+    execute: (writer: UIMessageStreamWriter) => Promise<void> | void;
+    onError?: (error: unknown) => string;
+}): ReadableStream<UIMessageStreamPart>;
+
+declare function createUIMessageStreamResponse({ status, statusText, headers, stream, }: ResponseInit & {
+    stream: ReadableStream<UIMessageStreamPart>;
+}): Response;
+
+declare function pipeUIMessageStreamToResponse({ response, status, statusText, headers, stream, }: {
+    response: ServerResponse;
+    stream: ReadableStream<UIMessageStreamPart>;
+} & ResponseInit): void;
+
+declare class JsonToSseTransformStream extends TransformStream<unknown, string> {
+    constructor();
+}
+
+interface ChatTransport<MESSAGE_METADATA> {
+    submitMessages: (options: {
+        chatId: string;
+        messages: UIMessage<MESSAGE_METADATA>[];
+        abortController: AbortController;
+        body?: object;
+        headers?: Record<string, string> | Headers;
+        requestType: 'generate' | 'resume';
+    }) => Promise<ReadableStream<UIMessageStreamPart>>;
+}
+declare class DefaultChatTransport<MESSAGE_METADATA> implements ChatTransport<MESSAGE_METADATA> {
+    private api;
+    private credentials?;
+    private headers?;
+    private body?;
+    private streamProtocol?;
+    private fetch?;
+    private prepareRequestBody?;
+    constructor({ api, credentials, headers, body, streamProtocol, fetch, prepareRequestBody, }: {
+        api: string;
+        /**
+         * The credentials mode to be used for the fetch request.
+         * Possible values are: 'omit', 'same-origin', 'include'.
+         * Defaults to 'same-origin'.
+         */
+        credentials?: RequestCredentials;
+        /**
+         * HTTP headers to be sent with the API request.
+         */
+        headers?: Record<string, string> | Headers;
+        /**
+         * Extra body object to be sent with the API request.
+         * @example
+         * Send a `sessionId` to the API along with the messages.
+         * ```js
+         * useChat({
+         *   body: {
+         *     sessionId: '123',
+         *   }
+         * })
+         * ```
+         */
+        body?: object;
+        /**
+      Streaming protocol that is used. Defaults to `ui-message`.
+         */
+        streamProtocol?: 'ui-message' | 'text';
+        /**
+      Custom fetch implementation. You can use it as a middleware to intercept requests,
+      or to provide a custom fetch implementation for e.g. testing.
+          */
+        fetch?: FetchFunction;
+        /**
+         * When a function is provided, it will be used
+         * to prepare the request body for the chat API. This can be useful for
+         * customizing the request body based on the messages and data in the chat.
+         *
+         * @param id The id of the chat.
+         * @param messages The current messages in the chat.
+         * @param requestBody The request body object passed in the chat request.
+         */
+        prepareRequestBody?: (options: {
+            id: string;
+            messages: UIMessage<MESSAGE_METADATA>[];
+            requestBody?: object;
+        }) => unknown;
+    });
+    submitMessages({ chatId, messages, abortController, body, headers, requestType, }: Parameters<ChatTransport<MESSAGE_METADATA>['submitMessages']>[0]): Promise<ReadableStream<{
+        value: string;
+        type: "text";
+    } | {
+        value: string;
+        type: "error";
+    } | {
+        value: {
+            toolName: string;
+            toolCallId: string;
+            args?: unknown;
+        };
+        type: "tool-call";
+    } | {
+        value: {
+            toolCallId: string;
+            result?: unknown;
+            providerMetadata?: any;
+        };
+        type: "tool-result";
+    } | {
+        value: {
+            toolName: string;
+            toolCallId: string;
+        };
+        type: "tool-call-streaming-start";
+    } | {
+        value: {
+            toolCallId: string;
+            argsTextDelta: string;
+        };
+        type: "tool-call-delta";
+    } | {
+        value: {
+            text: string;
+            providerMetadata?: Record<string, any> | undefined;
+        };
+        type: "reasoning";
+    } | {
+        value: {
+            type: "source";
+            id: string;
+            url: string;
+            sourceType: "url";
+            providerMetadata?: any;
+            title?: string | undefined;
+        };
+        type: "source";
+    } | {
+        value: {
+            mediaType: string;
+            url: string;
+        };
+        type: "file";
+    } | {
+        value: {
+            metadata?: unknown;
+        };
+        type: "metadata";
+    } | {
+        value: {
+            metadata?: unknown;
+        };
+        type: "start-step";
+    } | {
+        value: {
+            metadata?: unknown;
+        };
+        type: "finish-step";
+    } | {
+        value: {
+            metadata?: unknown;
+            messageId?: string | undefined;
+        };
+        type: "start";
+    } | {
+        value: {
+            metadata?: unknown;
+        };
+        type: "finish";
+    } | {
+        value: null;
+        type: "reasoning-part-finish";
+    }>>;
+}
+
+type StreamingUIMessageState<MESSAGE_METADATA = unknown> = {
+    message: UIMessage<MESSAGE_METADATA>;
+    activeTextPart: TextUIPart | undefined;
+    activeReasoningPart: ReasoningUIPart | undefined;
+    partialToolCalls: Record<string, {
+        text: string;
+        step: number;
+        index: number;
+        toolName: string;
+    }>;
+    step: number;
+};
+
+interface ChatStoreSubscriber {
+    onChatChanged: (event: ChatStoreEvent) => void;
+}
+interface ChatStoreEvent {
+    type: 'chat-messages-changed' | 'chat-status-changed';
+    chatId: number | string;
+    error?: Error;
+}
+type ChatStatus = 'submitted' | 'streaming' | 'ready' | 'error';
+interface Chat<MESSAGE_METADATA> {
+    status: ChatStatus;
+    messages: UIMessage<MESSAGE_METADATA>[];
+    error?: Error;
+    activeResponse?: {
+        state: StreamingUIMessageState<MESSAGE_METADATA>;
+        abortController?: AbortController;
+    };
+    jobExecutor: SerialJobExecutor;
+}
+type ExtendedCallOptions<MESSAGE_METADATA> = ChatRequestOptions & {
+    onError?: (error: Error) => void;
+    /**
+  Optional callback function that is invoked when a tool call is received.
+  Intended for automatic client-side tool execution.
+  
+  You can optionally return a result for the tool call,
+  either synchronously or asynchronously.
+     */
+    onToolCall?: ({ toolCall, }: {
+        toolCall: ToolCall<string, unknown>;
+    }) => void | Promise<unknown> | unknown;
+    /**
+     * Optional callback function that is called when the assistant message is finished streaming.
+     *
+     * @param message The message that was streamed.
+     */
+    onFinish?: (options: {
+        message: UIMessage<NoInfer<MESSAGE_METADATA>>;
+    }) => void;
+};
+declare class ChatStore<MESSAGE_METADATA> {
+    private chats;
+    private subscribers;
+    private generateId;
+    private messageMetadataSchema;
+    private transport;
+    private maxSteps;
+    constructor({ chats, generateId, messageMetadataSchema, transport, maxSteps, }: {
+        chats?: {
+            [id: string]: {
+                messages: UIMessage<MESSAGE_METADATA>[];
+            };
+        };
+        generateId?: UseChatOptions['generateId'];
+        messageMetadataSchema?: Schema<MESSAGE_METADATA>;
+        transport: ChatTransport<MESSAGE_METADATA>;
+        maxSteps?: number;
+    });
+    hasChat(id: string): boolean;
+    addChat(id: string, messages: UIMessage<MESSAGE_METADATA>[]): void;
+    getChats(): [string, Chat<MESSAGE_METADATA>][];
+    get chatCount(): number;
+    getStatus(id: string): ChatStatus;
+    setStatus({ id, status, error, }: {
+        id: string;
+        status: Chat<MESSAGE_METADATA>['status'];
+        error?: Error;
+    }): void;
+    getError(id: string): Error | undefined;
+    getMessages(id: string): UIMessage<MESSAGE_METADATA>[];
+    getLastMessage(id: string): UIMessage<MESSAGE_METADATA>;
+    subscribe(subscriber: ChatStoreSubscriber): () => void;
+    setMessages({ id, messages, }: {
+        id: string;
+        messages: UIMessage<MESSAGE_METADATA>[];
+    }): void;
+    appendMessage({ id, message, }: {
+        id: string;
+        message: UIMessage<MESSAGE_METADATA>;
+    }): void;
+    removeAssistantResponse(id: string): void;
+    submitMessage({ chatId, message, headers, body, onError, onToolCall, onFinish, }: ExtendedCallOptions<MESSAGE_METADATA> & {
+        chatId: string;
+        message: CreateUIMessage<MESSAGE_METADATA>;
+    }): Promise<void>;
+    resubmitLastUserMessage({ chatId, headers, body, onError, onToolCall, onFinish, }: ExtendedCallOptions<MESSAGE_METADATA> & {
+        chatId: string;
+    }): Promise<null | undefined>;
+    resumeStream({ chatId, headers, body, onError, onToolCall, onFinish, }: ExtendedCallOptions<MESSAGE_METADATA> & {
+        chatId: string;
+    }): Promise<null | undefined>;
+    addToolResult({ chatId, toolCallId, result, }: {
+        chatId: string;
+        toolCallId: string;
+        result: unknown;
+    }): Promise<void>;
+    stopStream({ chatId }: {
+        chatId: string;
+    }): Promise<void>;
+    private emit;
+    private getChat;
+    private triggerRequest;
+}
+
+type ChatRequestOptions = {
+    /**
+    Additional headers that should be to be passed to the API endpoint.
+     */
+    headers?: Record<string, string> | Headers;
+    /**
+    Additional body JSON properties that should be sent to the API endpoint.
+     */
+    body?: object;
+};
+type UseChatOptions<MESSAGE_METADATA = unknown> = {
+    /**
+     * A unique identifier for the chat. If not provided, a random one will be
+     * generated. When provided, the `useChat` hook with the same `id` will
+     * have shared states across components.
+     */
+    id?: string;
+    /**
+     * Initial input of the chat.
+     */
+    initialInput?: string;
+    /**
+    Optional callback function that is invoked when a tool call is received.
+    Intended for automatic client-side tool execution.
+  
+    You can optionally return a result for the tool call,
+    either synchronously or asynchronously.
+       */
+    onToolCall?: ({ toolCall, }: {
+        toolCall: ToolCall<string, unknown>;
+    }) => void | Promise<unknown> | unknown;
+    /**
+     * Optional callback function that is called when the assistant message is finished streaming.
+     *
+     * @param message The message that was streamed.
+     */
+    onFinish?: (options: {
+        message: UIMessage<NoInfer<MESSAGE_METADATA>>;
+    }) => void;
+    /**
+     * Callback function to be called when an error is encountered.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * A way to provide a function that is going to be used for ids for messages and the chat.
+     * If not provided the default AI SDK `generateId` is used.
+     */
+    generateId?: IdGenerator;
+    /**
+     * Optional chat store. Default is used when not provided.
+     */
+    chatStore?: ChatStore<MESSAGE_METADATA>;
+};
+type OriginalUseChatOptions<MESSAGE_METADATA = unknown> = {
+    /**
+     * Schema for the message metadata. Validates the message metadata.
+     * Message metadata can be undefined or must match the schema.
+     */
+    messageMetadataSchema?: Schema<MESSAGE_METADATA>;
+    /**
+     * The API endpoint that accepts a `{ messages: Message[] }` object and returns
+     * a stream of tokens of the AI chat response. Defaults to `/api/chat`.
+     */
+    api?: string;
+    /**
+     * A unique identifier for the chat. If not provided, a random one will be
+     * generated. When provided, the `useChat` hook with the same `id` will
+     * have shared states across components.
+     */
+    id?: string;
+    /**
+     * Initial messages of the chat. Useful to load an existing chat history.
+     */
+    initialMessages?: UIMessage<NoInfer<MESSAGE_METADATA>>[];
+    /**
+     * Initial input of the chat.
+     */
+    initialInput?: string;
+    /**
+    Optional callback function that is invoked when a tool call is received.
+    Intended for automatic client-side tool execution.
+  
+    You can optionally return a result for the tool call,
+    either synchronously or asynchronously.
+       */
+    onToolCall?: ({ toolCall, }: {
+        toolCall: ToolCall<string, unknown>;
+    }) => void | Promise<unknown> | unknown;
+    /**
+     * Optional callback function that is called when the assistant message is finished streaming.
+     *
+     * @param message The message that was streamed.
+     */
+    onFinish?: (options: {
+        message: UIMessage<NoInfer<MESSAGE_METADATA>>;
+    }) => void;
+    /**
+     * Callback function to be called when an error is encountered.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * A way to provide a function that is going to be used for ids for messages and the chat.
+     * If not provided the default AI SDK `generateId` is used.
+     */
+    generateId?: IdGenerator;
+    /**
+     * The credentials mode to be used for the fetch request.
+     * Possible values are: 'omit', 'same-origin', 'include'.
+     * Defaults to 'same-origin'.
+     */
+    credentials?: RequestCredentials;
+    /**
+     * HTTP headers to be sent with the API request.
+     */
+    headers?: Record<string, string> | Headers;
+    /**
+     * Extra body object to be sent with the API request.
+     * @example
+     * Send a `sessionId` to the API along with the messages.
+     * ```js
+     * useChat({
+     *   body: {
+     *     sessionId: '123',
+     *   }
+     * })
+     * ```
+     */
+    body?: object;
+    /**
+    Streaming protocol that is used. Defaults to `ui-message`.
+       */
+    streamProtocol?: 'ui-message' | 'text';
+    /**
+    Custom fetch implementation. You can use it as a middleware to intercept requests,
+    or to provide a custom fetch implementation for e.g. testing.
+        */
+    fetch?: FetchFunction;
+    /**
+    Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
+    Must be at least 1.
+  
+    A maximum number is required to prevent infinite loops in the case of misconfigured tools.
+  
+    By default, it's set to 1, which means that only a single LLM call is made.
+     */
+    maxSteps?: number;
+};
+
+declare const getOriginalFetch$1: () => typeof fetch;
+declare function callChatApi<MESSAGE_METADATA>({ api, body, streamProtocol, credentials, headers, abortController, onUpdate, onFinish, onToolCall, generateId, fetch, lastMessage, requestType, messageMetadataSchema, }: {
+    api: string;
+    body: Record<string, any>;
+    streamProtocol: 'ui-message' | 'text' | undefined;
+    credentials: RequestCredentials | undefined;
+    headers: HeadersInit | undefined;
+    abortController: (() => AbortController | null) | undefined;
+    onUpdate: (options: {
+        message: UIMessage<MESSAGE_METADATA>;
+    }) => void;
+    onFinish: UseChatOptions<MESSAGE_METADATA>['onFinish'];
+    onToolCall: UseChatOptions<MESSAGE_METADATA>['onToolCall'];
+    generateId: IdGenerator;
+    fetch: ReturnType<typeof getOriginalFetch$1> | undefined;
+    lastMessage: UIMessage<MESSAGE_METADATA> | undefined;
+    requestType?: 'generate' | 'resume';
+    messageMetadataSchema?: Schema<MESSAGE_METADATA>;
+}): Promise<void>;
+
+declare const getOriginalFetch: () => typeof fetch;
+declare function callCompletionApi({ api, prompt, credentials, headers, body, streamProtocol, setCompletion, setLoading, setError, setAbortController, onFinish, onError, fetch, }: {
+    api: string;
+    prompt: string;
+    credentials: RequestCredentials | undefined;
+    headers: HeadersInit | undefined;
+    body: Record<string, any>;
+    streamProtocol: 'data' | 'text' | undefined;
+    setCompletion: (completion: string) => void;
+    setLoading: (loading: boolean) => void;
+    setError: (error: Error | undefined) => void;
+    setAbortController: (abortController: AbortController | null) => void;
+    onFinish: ((prompt: string, completion: string) => void) | undefined;
+    onError: ((error: Error) => void) | undefined;
+    fetch: ReturnType<typeof getOriginalFetch> | undefined;
+}): Promise<string | null | undefined>;
+
+declare function convertFileListToFileUIParts(files: FileList | undefined): Promise<Array<FileUIPart>>;
+
+/**
+Converts an array of messages from useChat into an array of CoreMessages that can be used
+with the AI core functions (e.g. `streamText`).
+ */
+declare function convertToModelMessages<TOOLS extends ToolSet = never>(messages: Array<Omit<UIMessage, 'id'>>, options?: {
+    tools?: TOOLS;
+}): ModelMessage[];
+/**
+@deprecated Use `convertToModelMessages` instead.
+ */
+declare const convertToCoreMessages: typeof convertToModelMessages;
+
+declare function defaultChatStore<MESSAGE_METADATA>({ api, fetch, streamProtocol, credentials, headers, body, prepareRequestBody, generateId, messageMetadataSchema, maxSteps, chats, }: {
     /**
-     * Appends a data stream part to the stream.
+     * Schema for the message metadata. Validates the message metadata.
+     * Message metadata can be undefined or must match the schema.
      */
-    write(part: UIMessageStreamPart): void;
+    messageMetadataSchema?: Schema<MESSAGE_METADATA>;
     /**
-     * Merges the contents of another stream to this stream.
+     * The API endpoint that accepts a `{ messages: Message[] }` object and returns
+     * a stream of tokens of the AI chat response.
      */
-    merge(stream: ReadableStream<UIMessageStreamPart>): void;
+    api: string;
     /**
-     * Error handler that is used by the data stream writer.
-     * This is intended for forwarding when merging streams
-     * to prevent duplicated error masking.
+     * A way to provide a function that is going to be used for ids for messages and the chat.
+     * If not provided the default AI SDK `generateId` is used.
      */
-    onError: ((error: unknown) => string) | undefined;
-}
+    generateId?: IdGenerator;
+    /**
+     * The credentials mode to be used for the fetch request.
+     * Possible values are: 'omit', 'same-origin', 'include'.
+     * Defaults to 'same-origin'.
+     */
+    credentials?: RequestCredentials;
+    /**
+     * HTTP headers to be sent with the API request.
+     */
+    headers?: Record<string, string> | Headers;
+    /**
+     * Extra body object to be sent with the API request.
+     * @example
+     * Send a `sessionId` to the API along with the messages.
+     * ```js
+     * useChat({
+     *   body: {
+     *     sessionId: '123',
+     *   }
+     * })
+     * ```
+     */
+    body?: object;
+    /**
+      Streaming protocol that is used. Defaults to `ui-message`.
+         */
+    streamProtocol?: 'ui-message' | 'text';
+    /**
+      Custom fetch implementation. You can use it as a middleware to intercept requests,
+      or to provide a custom fetch implementation for e.g. testing.
+          */
+    fetch?: FetchFunction;
+    /**
+      Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
+      Must be at least 1.
+  
+      A maximum number is required to prevent infinite loops in the case of misconfigured tools.
+  
+      By default, it's set to 1, which means that only a single LLM call is made.
+       */
+    maxSteps?: number;
+    /**
+     * When a function is provided, it will be used
+     * to prepare the request body for the chat API. This can be useful for
+     * customizing the request body based on the messages and data in the chat.
+     *
+     * @param id The id of the chat.
+     * @param messages The current messages in the chat.
+     * @param requestBody The request body object passed in the chat request.
+     */
+    prepareRequestBody?: (options: {
+        id: string;
+        messages: UIMessage<MESSAGE_METADATA>[];
+        requestBody?: object;
+    }) => unknown;
+    chats?: {
+        [id: string]: {
+            messages: UIMessage<MESSAGE_METADATA>[];
+        };
+    };
+}): ChatStore<MESSAGE_METADATA>;
 
-declare function createUIMessageStream({ execute, onError, }: {
-    execute: (writer: UIMessageStreamWriter) => Promise<void> | void;
-    onError?: (error: unknown) => string;
-}): ReadableStream<UIMessageStreamPart>;
+declare function extractMaxToolInvocationStep(toolInvocations: ToolInvocation[] | undefined): number | undefined;
 
-declare function createUIMessageStreamResponse({ status, statusText, headers, stream, }: ResponseInit & {
-    stream: ReadableStream<UIMessageStreamPart>;
-}): Response;
+declare function getToolInvocations(message: UIMessage): ToolInvocation[];
 
-declare function pipeUIMessageStreamToResponse({ response, status, statusText, headers, stream, }: {
-    response: ServerResponse;
-    stream: ReadableStream<UIMessageStreamPart>;
-} & ResponseInit): void;
+declare function shouldResubmitMessages({ originalMaxToolInvocationStep, originalMessageCount, maxSteps, messages, }: {
+    originalMaxToolInvocationStep: number | undefined;
+    originalMessageCount: number;
+    maxSteps: number;
+    messages: UIMessage[];
+}): boolean;
+/**
+Check if the message is an assistant message with completed tool calls.
+The last step of the message must have at least one tool invocation and
+all tool invocations must have a result.
+ */
+declare function isAssistantMessageWithCompletedToolCalls(message: UIMessage): message is UIMessage & {
+    role: 'assistant';
+};
 
-declare class JsonToSseTransformStream extends TransformStream<unknown, string> {
-    constructor();
-}
+/**
+ * Updates the result of a specific tool invocation in the last message of the given messages array.
+ *
+ * @param {object} params - The parameters object.
+ * @param {UIMessage[]} params.messages - An array of messages, from which the last one is updated.
+ * @param {string} params.toolCallId - The unique identifier for the tool invocation to update.
+ * @param {unknown} params.toolResult - The result object to attach to the tool invocation.
+ * @returns {void} This function does not return anything.
+ */
+declare function updateToolCallResult({ messages, toolCallId, toolResult: result, }: {
+    messages: UIMessage[];
+    toolCallId: string;
+    toolResult: unknown;
+}): void;
+
+type CompletionRequestOptions = {
+    /**
+    An optional object of headers to be passed to the API endpoint.
+     */
+    headers?: Record<string, string> | Headers;
+    /**
+    An optional object to be passed to the API endpoint.
+       */
+    body?: object;
+};
+type UseCompletionOptions = {
+    /**
+     * The API endpoint that accepts a `{ prompt: string }` object and returns
+     * a stream of tokens of the AI completion response. Defaults to `/api/completion`.
+     */
+    api?: string;
+    /**
+     * An unique identifier for the chat. If not provided, a random one will be
+     * generated. When provided, the `useChat` hook with the same `id` will
+     * have shared states across components.
+     */
+    id?: string;
+    /**
+     * Initial prompt input of the completion.
+     */
+    initialInput?: string;
+    /**
+     * Initial completion result. Useful to load an existing history.
+     */
+    initialCompletion?: string;
+    /**
+     * Callback function to be called when the completion is finished streaming.
+     */
+    onFinish?: (prompt: string, completion: string) => void;
+    /**
+     * Callback function to be called when an error is encountered.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * The credentials mode to be used for the fetch request.
+     * Possible values are: 'omit', 'same-origin', 'include'.
+     * Defaults to 'same-origin'.
+     */
+    credentials?: RequestCredentials;
+    /**
+     * HTTP headers to be sent with the API request.
+     */
+    headers?: Record<string, string> | Headers;
+    /**
+     * Extra body object to be sent with the API request.
+     * @example
+     * Send a `sessionId` to the API along with the prompt.
+     * ```js
+     * useChat({
+     *   body: {
+     *     sessionId: '123',
+     *   }
+     * })
+     * ```
+     */
+    body?: object;
+    /**
+    Streaming protocol that is used. Defaults to `data`.
+       */
+    streamProtocol?: 'data' | 'text';
+    /**
+    Custom fetch implementation. You can use it as a middleware to intercept requests,
+    or to provide a custom fetch implementation for e.g. testing.
+        */
+    fetch?: FetchFunction;
+};
 
 /**
  * Converts a data URL of type text/* to a text string.
@@ -4894,4 +5289,4 @@ declare function transcribe({ model, audio, providerOptions, maxRetries: maxRetr
     headers?: Record<string, string>;
 }): Promise<TranscriptionResult>;
 
-export { AssistantContent, AssistantModelMessage, CallSettings, CallWarning, ChatRequestOptions, ChunkDetector, CompletionRequestOptions, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataContent, DeepPartial, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, FilePart, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MCPClientError, MCPTransport, MessageConversionError, ModelMessage, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RetryError, SourceUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StepResult, StepStartUIPart, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, SystemModelMessage, TelemetrySettings, TextPart, TextStreamPart, TextUIPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolInvocation, ToolInvocationUIPart, ToolModelMessage, ToolResultPart, ToolResultUnion, ToolSet, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIMessage, UIMessagePart, UIMessageStreamOptions, UIMessageStreamPart, UIMessageStreamWriter, UseChatOptions, UseCompletionOptions, UserContent, UserModelMessage, appendClientMessage, assistantModelMessageSchema, callChatApi, callCompletionApi, convertFileListToFileUIParts, convertToCoreMessages, convertToModelMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, generateSpeech as experimental_generateSpeech, transcribe as experimental_transcribe, extractMaxToolInvocationStep, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolInvocations, isAssistantMessageWithCompletedToolCalls, isDeepEqualData, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, processTextStream, shouldResubmitMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, systemModelMessageSchema, tool, toolModelMessageSchema, updateToolCallResult, userModelMessageSchema, wrapLanguageModel };
+export { AssistantContent, AssistantModelMessage, CallSettings, CallWarning, ChatRequestOptions, ChatStatus, ChatStore, ChatStoreEvent, ChatTransport, ChunkDetector, CompletionRequestOptions, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataContent, DeepPartial, DefaultChatTransport, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, FilePart, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MCPClientError, MCPTransport, MessageConversionError, ModelMessage, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, OriginalUseChatOptions, output as Output, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RetryError, SourceUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StepResult, StepStartUIPart, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, SystemModelMessage, TelemetrySettings, TextPart, TextStreamPart, TextUIPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolInvocation, ToolInvocationUIPart, ToolModelMessage, ToolResultPart, ToolResultUnion, ToolSet, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIMessage, UIMessagePart, UIMessageStreamOptions, UIMessageStreamPart, UIMessageStreamWriter, UseChatOptions, UseCompletionOptions, UserContent, UserModelMessage, appendClientMessage, assistantModelMessageSchema, callChatApi, callCompletionApi, convertFileListToFileUIParts, convertToCoreMessages, convertToModelMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultChatStore, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, generateSpeech as experimental_generateSpeech, transcribe as experimental_transcribe, extractMaxToolInvocationStep, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolInvocations, isAssistantMessageWithCompletedToolCalls, isDeepEqualData, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, shouldResubmitMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, systemModelMessageSchema, tool, toolModelMessageSchema, updateToolCallResult, userModelMessageSchema, wrapLanguageModel };