ai 5.0.0-alpha.4 → 5.0.0-alpha.5

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # ai
 
+## 5.0.0-alpha.5
+
+### Major Changes
+
+- ef256ed: chore (ai): refactor and use chatstore in svelte
+- 1ed0287: chore (ai): stable sendStart/sendFinish options
+
+### Patch Changes
+
+- 655cf3c: feat (ui): add onFinish to createUIMessageStream
+- 1675396: fix: avoid job executor deadlock when adding tool result
+- cf9af6e: feat (ai): allow sync prepareStep
+- 825e8d7: release alpha.5
+- 7324c21: fix (ai/telemetry): Avoid JSON.stringify on Uint8Arrays for telemetry
+
 ## 5.0.0-alpha.4
 
 ### Major Changes

package/dist/index.d.mts

@@ -2693,6 +2693,31 @@ declare namespace output {
   };
 }
 
+/**
+Function that you can use to provide different settings for a step.
+
+@param options - The options for the step.
+@param options.steps - The steps that have been executed so far.
+@param options.stepNumber - The number of the step that is being executed.
+@param options.model - The model that is being used.
+
+@returns An object that contains the settings for the step.
+If you return undefined (or for undefined settings), the settings from the outer level will be used.
+    */
+type PrepareStepFunction<TOOLS extends Record<string, Tool> = Record<string, Tool>> = (options: {
+    steps: Array<StepResult<NoInfer<TOOLS>>>;
+    stepNumber: number;
+    model: LanguageModel;
+}) => PromiseLike<{
+    model?: LanguageModel;
+    toolChoice?: ToolChoice<NoInfer<TOOLS>>;
+    activeTools?: Array<keyof NoInfer<TOOLS>>;
+} | undefined> | {
+    model?: LanguageModel;
+    toolChoice?: ToolChoice<NoInfer<TOOLS>>;
+    activeTools?: Array<keyof NoInfer<TOOLS>>;
+} | undefined;
+
 type StopCondition<TOOLS extends ToolSet> = (options: {
     steps: Array<StepResult<TOOLS>>;
 }) => PromiseLike<boolean> | boolean;
@@ -2797,35 +2822,11 @@ Optional specification for parsing structured outputs from the LLM response.
     /**
      * @deprecated Use `prepareStep` instead.
      */
-    experimental_prepareStep?: (options: {
-        steps: Array<StepResult<NoInfer<TOOLS>>>;
-        stepNumber: number;
-        model: LanguageModel;
-    }) => PromiseLike<{
-        model?: LanguageModel;
-        toolChoice?: ToolChoice<NoInfer<TOOLS>>;
-        activeTools?: Array<keyof NoInfer<TOOLS>>;
-    } | undefined>;
+    experimental_prepareStep?: PrepareStepFunction<NoInfer<TOOLS>>;
     /**
 Optional function that you can use to provide different settings for a step.
-
-@param options - The options for the step.
-@param options.steps - The steps that have been executed so far.
-@param options.stepNumber - The number of the step that is being executed.
-@param options.model - The model that is being used.
-
-@returns An object that contains the settings for the step.
-If you return undefined (or for undefined settings), the settings from the outer level will be used.
     */
-    prepareStep?: (options: {
-        steps: Array<StepResult<NoInfer<TOOLS>>>;
-        stepNumber: number;
-        model: LanguageModel;
-    }) => PromiseLike<{
-        model?: LanguageModel;
-        toolChoice?: ToolChoice<NoInfer<TOOLS>>;
-        activeTools?: Array<keyof NoInfer<TOOLS>>;
-    } | undefined>;
+    prepareStep?: PrepareStepFunction<NoInfer<TOOLS>>;
     /**
 A function that attempts to repair a tool call that failed to parse.
      */
@@ -2899,7 +2900,7 @@ type UIMessageStreamOptions = {
      * that send additional data.
      * Default to true.
      */
-    experimental_sendFinish?: boolean;
+    sendFinish?: boolean;
     /**
      * Send the message start event to the client.
      * Set to false if you are using additional streamText calls
@@ -2911,7 +2912,7 @@ type UIMessageStreamOptions = {
      * streamText calls that send additional data to prevent
      * the message start event from being sent multiple times.
      */
-    experimental_sendStart?: boolean;
+    sendStart?: boolean;
     /**
      * Process an error, e.g. to log it. Default to `() => 'An error occurred.'`.
      *
@@ -3317,15 +3318,7 @@ Optional function that you can use to provide different settings for a step.
 @returns An object that contains the settings for the step.
 If you return undefined (or for undefined settings), the settings from the outer level will be used.
     */
-    prepareStep?: (options: {
-        steps: Array<StepResult<NoInfer<TOOLS>>>;
-        stepNumber: number;
-        model: LanguageModel;
-    }) => PromiseLike<{
-        model?: LanguageModel;
-        toolChoice?: ToolChoice<NoInfer<TOOLS>>;
-        activeTools?: Array<keyof NoInfer<TOOLS>>;
-    } | undefined>;
+    prepareStep?: PrepareStepFunction<NoInfer<TOOLS>>;
     /**
 A function that attempts to repair a tool call that failed to parse.
      */
@@ -3670,6 +3663,20 @@ functionality that can be fully encapsulated in the provider.
     };
 }): Promise<GenerateObjectResult<RESULT>>;
 
+/**
+ * Calculates the cosine similarity between two vectors. This is a useful metric for
+ * comparing the similarity of two vectors such as embeddings.
+ *
+ * @param vector1 - The first vector.
+ * @param vector2 - The second vector.
+ *
+ * @returns The cosine similarity between vector1 and vector2.
+ * @returns 0 if either vector is the zero vector.
+ *
+ * @throws {InvalidArgumentError} If the vectors do not have the same length.
+ */
+declare function cosineSimilarity(vector1: number[], vector2: number[]): number;
+
 /**
  * Converts a data URL of type text/* to a text string.
  */
@@ -3689,19 +3696,14 @@ declare function parsePartialJson(jsonText: string | undefined): Promise<{
     state: 'undefined-input' | 'successful-parse' | 'repaired-parse' | 'failed-parse';
 }>;
 
-/**
- * Calculates the cosine similarity between two vectors. This is a useful metric for
- * comparing the similarity of two vectors such as embeddings.
- *
- * @param vector1 - The first vector.
- * @param vector2 - The second vector.
- *
- * @returns The cosine similarity between vector1 and vector2.
- * @returns 0 if either vector is the zero vector.
- *
- * @throws {InvalidArgumentError} If the vectors do not have the same length.
- */
-declare function cosineSimilarity(vector1: number[], vector2: number[]): number;
+type Job = () => Promise<void>;
+
+declare class SerialJobExecutor {
+    private queue;
+    private isProcessing;
+    private processQueue;
+    run(job: Job): Promise<void>;
+}
 
 /**
  * Creates a ReadableStream that emits the provided values with an optional delay between each value.
@@ -4379,15 +4381,6 @@ type UIMessageStreamPart = {
     type: 'reasoning-part-finish';
 };
 
-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.
@@ -4405,9 +4398,32 @@ interface UIMessageStreamWriter {
     onError: ((error: unknown) => string) | undefined;
 }
 
-declare function createUIMessageStream({ execute, onError, }: {
-    execute: (writer: UIMessageStreamWriter) => Promise<void> | void;
+declare function createUIMessageStream({ execute, onError, // mask error messages for safety by default
+originalMessages, onFinish, }: {
+    execute: (options: {
+        writer: UIMessageStreamWriter;
+    }) => Promise<void> | void;
     onError?: (error: unknown) => string;
+    /**
+     * The original messages.
+     */
+    originalMessages?: UIMessage[];
+    onFinish?: (options: {
+        /**
+         * The updates list of UI messages.
+         */
+        messages: UIMessage[];
+        /**
+         * Indicates whether the response message is a continuation of the last original message,
+         * or if a new message was created.
+         */
+        isContinuation: boolean;
+        /**
+         * The message that was sent to the client as a response
+         * (including the original message if it was extended).
+         */
+        responseMessage: UIMessage;
+    }) => void;
 }): ReadableStream<UIMessageStreamPart>;
 
 declare function createUIMessageStreamResponse({ status, statusText, headers, stream, }: ResponseInit & {
@@ -4564,16 +4580,10 @@ interface ChatStoreEvent {
     error?: Error;
 }
 type ChatStatus = 'submitted' | 'streaming' | 'ready' | 'error';
-interface Chat<MESSAGE_METADATA, DATA_TYPES extends UIDataTypes> {
-    status: ChatStatus;
-    messages: UIMessage<MESSAGE_METADATA, DATA_TYPES>[];
-    error?: Error;
-    activeResponse?: {
-        state: StreamingUIMessageState<MESSAGE_METADATA>;
-        abortController?: AbortController;
-    };
-    jobExecutor: SerialJobExecutor;
-}
+type ActiveResponse<MESSAGE_METADATA> = {
+    state: StreamingUIMessageState<MESSAGE_METADATA>;
+    abortController: AbortController | undefined;
+};
 type ExtendedCallOptions<MESSAGE_METADATA, DATA_TYPES extends UIDataTypes> = ChatRequestOptions & {
     onError?: (error: Error) => void;
     /**
@@ -4599,15 +4609,47 @@ type UIDataPartSchemas = Record<string, Validator<any> | StandardSchemaV1<any>>;
 type InferUIDataParts<T extends UIDataPartSchemas> = {
     [K in keyof T]: T[K] extends Validator<infer U> ? U : T[K] extends StandardSchemaV1<infer U> ? U : unknown;
 };
-declare class ChatStore<MESSAGE_METADATA, UI_DATA_PART_SCHEMAS extends UIDataPartSchemas> {
+type ChatFactory<MESSAGE_METADATA, DATA_TYPES extends UIDataTypes> = (options: {
+    messages?: UIMessage<MESSAGE_METADATA, DATA_TYPES>[];
+}) => Chat<MESSAGE_METADATA, DATA_TYPES>;
+type ChatStoreOptions<MESSAGE_METADATA, DATA_PART_SCHEMAS extends UIDataPartSchemas> = {
+    chats?: {
+        [id: string]: {
+            messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>[];
+        };
+    };
+    generateId?: UseChatOptions['generateId'];
+    transport: ChatTransport<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>;
+    maxSteps?: number;
+    messageMetadataSchema?: Validator<MESSAGE_METADATA> | StandardSchemaV1<MESSAGE_METADATA>;
+    dataPartSchemas?: DATA_PART_SCHEMAS;
+};
+type ChatStoreFactory<MESSAGE_METADATA, DATA_PART_SCHEMAS extends UIDataPartSchemas> = (options: ChatStoreOptions<MESSAGE_METADATA, DATA_PART_SCHEMAS>) => ChatStore<MESSAGE_METADATA, DATA_PART_SCHEMAS>;
+interface Chat<MESSAGE_METADATA, DATA_TYPES extends UIDataTypes> {
+    readonly status: ChatStatus;
+    readonly messages: UIMessage<MESSAGE_METADATA, DATA_TYPES>[];
+    readonly error: Error | undefined;
+    readonly activeResponse: ActiveResponse<MESSAGE_METADATA> | undefined;
+    readonly jobExecutor: SerialJobExecutor;
+    setStatus: (status: ChatStatus) => void;
+    setError: (error: Error | undefined) => void;
+    setActiveResponse: (activeResponse: ActiveResponse<MESSAGE_METADATA> | undefined) => void;
+    pushMessage: (message: UIMessage<MESSAGE_METADATA, DATA_TYPES>) => void;
+    popMessage: () => void;
+    replaceMessage: (index: number, message: UIMessage<MESSAGE_METADATA, DATA_TYPES>) => void;
+    setMessages: (messages: UIMessage<MESSAGE_METADATA, DATA_TYPES>[]) => void;
+    snapshot?: <T>(thing: T) => T;
+}
+declare class ChatStore<MESSAGE_METADATA = unknown, UI_DATA_PART_SCHEMAS extends UIDataPartSchemas = UIDataPartSchemas> {
     private chats;
+    private readonly createChat;
     private subscribers;
     private generateId;
     private messageMetadataSchema;
     private dataPartSchemas;
     private transport;
     private maxSteps;
-    constructor({ chats, generateId, transport, maxSteps, messageMetadataSchema, dataPartSchemas, }: {
+    constructor({ chats, generateId, transport, maxSteps, messageMetadataSchema, dataPartSchemas, createChat, }: {
         chats?: {
             [id: string]: {
                 messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<UI_DATA_PART_SCHEMAS>>[];
@@ -4618,6 +4660,7 @@ declare class ChatStore<MESSAGE_METADATA, UI_DATA_PART_SCHEMAS extends UIDataPar
         maxSteps?: number;
         messageMetadataSchema?: Validator<MESSAGE_METADATA> | StandardSchemaV1<MESSAGE_METADATA>;
         dataPartSchemas?: UI_DATA_PART_SCHEMAS;
+        createChat: ChatFactory<MESSAGE_METADATA, InferUIDataParts<UI_DATA_PART_SCHEMAS>>;
     });
     hasChat(id: string): boolean;
     addChat(id: string, messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<UI_DATA_PART_SCHEMAS>>[]): void;
@@ -4626,7 +4669,7 @@ declare class ChatStore<MESSAGE_METADATA, UI_DATA_PART_SCHEMAS extends UIDataPar
     getStatus(id: string): ChatStatus;
     setStatus({ id, status, error, }: {
         id: string;
-        status: Chat<MESSAGE_METADATA, InferUIDataParts<UI_DATA_PART_SCHEMAS>>['status'];
+        status: ChatStatus;
         error?: Error;
     }): void;
     getError(id: string): Error | undefined;
@@ -4657,7 +4700,7 @@ declare class ChatStore<MESSAGE_METADATA, UI_DATA_PART_SCHEMAS extends UIDataPar
         chatId: string;
     }): Promise<void>;
     private emit;
-    private getChat;
+    private getChatState;
     private triggerRequest;
 }
 
@@ -4710,9 +4753,21 @@ type UseChatOptions<MESSAGE_METADATA = unknown, DATA_TYPE_SCHEMAS extends UIData
      */
     generateId?: IdGenerator;
     /**
-     * Optional chat store. Default is used when not provided.
+     * Chat store that should be used.
+     * It must not change during the component lifecycle.
+     *
+     * When a ChatStore is provided, it will be used as is.
+     * It should be stable and the stability is guaranteed by the user.
+     *
+     * When a function is provided, it will be called to create a new chat store.
+     * The function will be called when the hook is mounted and the chat store will be
+     * created.
+     * The function will be called with the same arguments as the hook is called with.
+     * The function should return a ChatStoreOptions object.
+     *
+     * When no value is provided, a default chat store will be created.
      */
-    chatStore?: ChatStore<MESSAGE_METADATA, DATA_TYPE_SCHEMAS>;
+    chatStore?: ChatStore<MESSAGE_METADATA, DATA_TYPE_SCHEMAS> | (() => ChatStoreOptions<MESSAGE_METADATA, DATA_TYPE_SCHEMAS>);
 };
 type OriginalUseChatOptions<MESSAGE_METADATA = unknown> = {
     /**
@@ -4860,84 +4915,6 @@ declare function convertToModelMessages<TOOLS extends ToolSet = never>(messages:
  */
 declare const convertToCoreMessages: typeof convertToModelMessages;
 
-declare function defaultChatStore<MESSAGE_METADATA, UI_DATA_PART_SCHEMAS extends UIDataPartSchemas>({ api, fetch, credentials, headers, body, prepareRequestBody, generateId, dataPartSchemas, messageMetadataSchema, maxSteps, chats, }: {
-    /**
-     * Schema for the message metadata. Validates the message metadata.
-     * Message metadata can be undefined or must match the schema.
-     */
-    messageMetadataSchema?: Validator<MESSAGE_METADATA> | StandardSchemaV1<MESSAGE_METADATA>;
-    /**
-     * Schema for the data types. Validates the data types.
-     */
-    dataPartSchemas?: UI_DATA_PART_SCHEMAS;
-    /**
-     * The API endpoint that accepts a `{ messages: Message[] }` object and returns
-     * a stream of tokens of the AI chat response.
-     */
-    api: string;
-    /**
-     * 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;
-    /**
-      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 chatId 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: {
-        chatId: string;
-        messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<UI_DATA_PART_SCHEMAS>>[];
-        requestBody?: object;
-    }) => unknown;
-    chats?: {
-        [id: string]: {
-            messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<UI_DATA_PART_SCHEMAS>>[];
-        };
-    };
-}): ChatStore<MESSAGE_METADATA, UI_DATA_PART_SCHEMAS>;
-
 declare function extractMaxToolInvocationStep(toolInvocations: ToolInvocation[] | undefined): number | undefined;
 
 declare function getToolInvocations(message: UIMessage): ToolInvocation[];
@@ -5044,4 +5021,85 @@ type UseCompletionOptions = {
     fetch?: FetchFunction;
 };
 
-export { AssistantContent, AssistantModelMessage, CallSettings, CallWarning, ChatRequestOptions, ChatStatus, ChatStore, ChatStoreEvent, ChatTransport, ChunkDetector, CompletionRequestOptions, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataContent, DataUIPart, 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, InferUIDataParts as InferUIDataTypes, 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, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, SystemModelMessage, TelemetrySettings, TextPart, TextStreamChatTransport, TextStreamPart, TextUIPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolInvocation, ToolInvocationUIPart, ToolModelMessage, ToolResultPart, ToolResultUnion, ToolSet, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIDataTypes, UIDataPartSchemas as UIDataTypesSchemas, 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, hasToolCall, isAssistantMessageWithCompletedToolCalls, isDeepEqualData, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, shouldResubmitMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, tool, toolModelMessageSchema, updateToolCallResult, userModelMessageSchema, wrapLanguageModel };
+interface DefaultChatStoreOptions<MESSAGE_METADATA = unknown, UI_DATA_PART_SCHEMAS extends UIDataPartSchemas = UIDataPartSchemas> {
+    /**
+     * Schema for the message metadata. Validates the message metadata.
+     * Message metadata can be undefined or must match the schema.
+     */
+    messageMetadataSchema?: Validator<MESSAGE_METADATA> | StandardSchemaV1<MESSAGE_METADATA>;
+    /**
+     * Schema for the data types. Validates the data types.
+     */
+    dataPartSchemas?: UI_DATA_PART_SCHEMAS;
+    /**
+     * 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 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;
+    /**
+      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 chatId 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: {
+        chatId: string;
+        messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<UI_DATA_PART_SCHEMAS>>[];
+        requestBody?: object;
+    }) => unknown;
+    chats?: {
+        [id: string]: {
+            messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<UI_DATA_PART_SCHEMAS>>[];
+        };
+    };
+}
+declare function defaultChatStoreOptions<MESSAGE_METADATA = unknown, UI_DATA_PART_SCHEMAS extends UIDataPartSchemas = UIDataPartSchemas>({ api, fetch, credentials, headers, body, prepareRequestBody, generateId, messageMetadataSchema, maxSteps, dataPartSchemas, chats, }: DefaultChatStoreOptions<MESSAGE_METADATA, UI_DATA_PART_SCHEMAS>): () => ChatStoreOptions<MESSAGE_METADATA, UI_DATA_PART_SCHEMAS>;
+
+export { ActiveResponse, AssistantContent, AssistantModelMessage, CallSettings, CallWarning, Chat, ChatRequestOptions, ChatStatus, ChatStore, ChatStoreEvent, ChatStoreFactory, ChatStoreOptions, ChatTransport, ChunkDetector, CompletionRequestOptions, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataContent, DataUIPart, DeepPartial, DefaultChatStoreOptions, 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, InferUIDataParts, 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, PrepareStepFunction, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RetryError, SerialJobExecutor, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, SystemModelMessage, TelemetrySettings, TextPart, TextStreamChatTransport, TextStreamPart, TextUIPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolInvocation, ToolInvocationUIPart, ToolModelMessage, ToolResultPart, ToolResultUnion, ToolSet, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIDataPartSchemas, UIDataTypes, 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, defaultChatStoreOptions, 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, hasToolCall, isAssistantMessageWithCompletedToolCalls, isDeepEqualData, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, shouldResubmitMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, tool, toolModelMessageSchema, updateToolCallResult, userModelMessageSchema, wrapLanguageModel };