ai 5.0.0-alpha.14 → 5.0.0-alpha.15

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # ai
 
+## 5.0.0-alpha.15
+
+### Major Changes
+
+- 04d5063: chore (ai): rename default provider global to AI_SDK_DEFAULT_PROVIDER
+- b4b4bb2: chore (ui): rename experimental_resume to resumeStream
+- d884051: feat (ai): simplify default provider setup
+- 954aa73: feat (ui): extended regenerate support
+- 60e2c56: feat (ai): restructure chat transports
+
+### Patch Changes
+
+- b1e3abd: feat (ai): expose ui message stream headers
+- 142576e: feat (ui): support message replacement in chat via messageId param on sendMessage
+- 395c85e: feat (ai): add consumeSseStream option to UI message stream responses
+- Updated dependencies [48d257a]
+- Updated dependencies [8ba77a7]
+- Updated dependencies [c145d62]
+  - @ai-sdk/provider@2.0.0-alpha.15
+  - @ai-sdk/provider-utils@3.0.0-alpha.15
+  - @ai-sdk/gateway@1.0.0-alpha.15
+
 ## 5.0.0-alpha.14
 
 ### Major Changes

package/dist/index.d.mts

@@ -1934,8 +1934,6 @@ type Prompt = {
     messages?: Array<ModelMessage>;
 };
 
-declare const GLOBAL_DEFAULT_PROVIDER: unique symbol;
-
 /**
  * A function that attempts to repair a tool call that failed to parse.
  *
@@ -2482,26 +2480,45 @@ originalMessages, onFinish, generateId, }: {
     generateId?: IdGenerator;
 }): ReadableStream<InferUIMessageStreamPart<UI_MESSAGE>>;
 
-declare function createUIMessageStreamResponse({ status, statusText, headers, stream, }: ResponseInit & {
-    stream: ReadableStream<UIMessageStreamPart>;
-}): Response;
+type UIMessageStreamResponseInit = ResponseInit & {
+    consumeSseStream?: (options: {
+        stream: ReadableStream<string>;
+    }) => PromiseLike<void> | void;
+};
 
-declare function pipeUIMessageStreamToResponse({ response, status, statusText, headers, stream, }: {
-    response: ServerResponse;
+declare function createUIMessageStreamResponse({ status, statusText, headers, stream, consumeSseStream, }: UIMessageStreamResponseInit & {
     stream: ReadableStream<UIMessageStreamPart>;
-} & ResponseInit): void;
+}): Response;
 
 declare class JsonToSseTransformStream extends TransformStream<unknown, string> {
     constructor();
 }
 
+declare function pipeUIMessageStreamToResponse({ response, status, statusText, headers, stream, consumeSseStream, }: {
+    response: ServerResponse;
+    stream: ReadableStream<UIMessageStreamPart>;
+} & UIMessageStreamResponseInit): void;
+
+declare const UI_MESSAGE_STREAM_HEADERS: {
+    'content-type': string;
+    'cache-control': string;
+    connection: string;
+    'x-vercel-ai-ui-message-stream': string;
+    'x-accel-buffering': string;
+};
+
 interface ChatTransport<UI_MESSAGE extends UIMessage> {
-    submitMessages: (options: {
+    sendMessages: (options: {
         chatId: string;
         messages: UI_MESSAGE[];
         abortSignal: AbortSignal | undefined;
-        requestType: 'generate' | 'resume';
+    } & {
+        trigger: 'submit-user-message' | 'submit-tool-result' | 'regenerate-assistant-message';
+        messageId: string | undefined;
     } & ChatRequestOptions) => Promise<ReadableStream<UIMessageStreamPart>>;
+    reconnectToStream: (options: {
+        chatId: string;
+    } & ChatRequestOptions) => Promise<ReadableStream<UIMessageStreamPart> | null>;
 }
 
 type CreateUIMessage<UI_MESSAGE extends UIMessage> = Omit<UI_MESSAGE, 'id' | 'role'> & {
@@ -2608,32 +2625,39 @@ declare abstract class AbstractChat<UI_MESSAGE extends UIMessage> {
     get messages(): UI_MESSAGE[];
     get lastMessage(): UI_MESSAGE | undefined;
     set messages(messages: UI_MESSAGE[]);
-    removeAssistantResponse: () => void;
     /**
-     * Append a user message to the chat list. This triggers the API call to fetch
+     * Appends or replaces a user message to the chat list. This triggers the API call to fetch
      * the assistant's response.
+     *
+     * If a messageId is provided, the message will be replaced.
      */
     sendMessage: (message: (CreateUIMessage<UI_MESSAGE> & {
         text?: never;
         files?: never;
+        messageId?: string;
     }) | {
         text: string;
         files?: FileList | FileUIPart[];
         metadata?: InferUIMessageMetadata<UI_MESSAGE>;
         parts?: never;
+        messageId?: string;
     } | {
         files: FileList | FileUIPart[];
         metadata?: InferUIMessageMetadata<UI_MESSAGE>;
         parts?: never;
+        messageId?: string;
     }, options?: ChatRequestOptions) => Promise<void>;
     /**
-     * Regenerate the last assistant message.
+     * Regenerate the assistant message with the provided message id.
+     * If no message id is provided, the last assistant message will be regenerated.
      */
-    reload: (options?: ChatRequestOptions) => Promise<void>;
+    regenerate: ({ messageId, ...options }?: {
+        messageId?: string;
+    } & ChatRequestOptions) => Promise<void>;
     /**
-     * Resume an ongoing chat generation stream. This does not resume an aborted generation.
+     * Attempt to resume an ongoing streaming response.
      */
-    experimental_resume: (options?: ChatRequestOptions) => Promise<void>;
+    resumeStream: (options?: ChatRequestOptions) => Promise<void>;
     addToolResult: ({ toolCallId, output, }: {
         toolCallId: string;
         output: unknown;
@@ -2642,7 +2666,7 @@ declare abstract class AbstractChat<UI_MESSAGE extends UIMessage> {
      * Abort the current request immediately, keep the generated tokens if any.
      */
     stop: () => Promise<void>;
-    private triggerRequest;
+    private makeRequest;
 }
 
 declare function convertFileListToFileUIParts(files: FileList | undefined): Promise<Array<FileUIPart>>;
@@ -2659,119 +2683,99 @@ declare function convertToModelMessages<TOOLS extends ToolSet = never>(messages:
  */
 declare const convertToCoreMessages: typeof convertToModelMessages;
 
-type PrepareRequest<UI_MESSAGE extends UIMessage> = (options: {
+type PrepareSendMessagesRequest<UI_MESSAGE extends UIMessage> = (options: {
     id: string;
     messages: UI_MESSAGE[];
     requestMetadata: unknown;
     body: Record<string, any> | undefined;
     credentials: RequestCredentials | undefined;
     headers: HeadersInit | undefined;
+    api: string;
+} & {
+    trigger: 'submit-user-message' | 'submit-tool-result' | 'regenerate-assistant-message';
+    messageId: string | undefined;
 }) => {
     body: object;
     headers?: HeadersInit;
     credentials?: RequestCredentials;
+    api?: string;
+};
+type PrepareReconnectToStreamRequest = (options: {
+    id: string;
+    requestMetadata: unknown;
+    body: Record<string, any> | undefined;
+    credentials: RequestCredentials | undefined;
+    headers: HeadersInit | undefined;
+    api: string;
+}) => {
+    headers?: HeadersInit;
+    credentials?: RequestCredentials;
+    api?: string;
 };
+type HttpChatTransportInitOptions<UI_MESSAGE extends UIMessage> = {
+    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;
+    /**
+    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.
+     */
+    prepareSendMessagesRequest?: PrepareSendMessagesRequest<UI_MESSAGE>;
+    prepareReconnectToStreamRequest?: PrepareReconnectToStreamRequest;
+};
+declare abstract class HttpChatTransport<UI_MESSAGE extends UIMessage> implements ChatTransport<UI_MESSAGE> {
+    protected api: string;
+    protected credentials?: RequestCredentials;
+    protected headers?: Record<string, string> | Headers;
+    protected body?: object;
+    protected fetch: FetchFunction;
+    protected prepareSendMessagesRequest?: PrepareSendMessagesRequest<UI_MESSAGE>;
+    protected prepareReconnectToStreamRequest?: PrepareReconnectToStreamRequest;
+    constructor({ api, credentials, headers, body, fetch, prepareSendMessagesRequest, prepareReconnectToStreamRequest, }: HttpChatTransportInitOptions<UI_MESSAGE>);
+    sendMessages({ abortSignal, ...options }: Parameters<ChatTransport<UI_MESSAGE>['sendMessages']>[0]): Promise<ReadableStream<UIMessageStreamPart>>;
+    reconnectToStream(options: Parameters<ChatTransport<UI_MESSAGE>['reconnectToStream']>[0]): Promise<ReadableStream<UIMessageStreamPart> | null>;
+    protected abstract processResponseStream(stream: ReadableStream<Uint8Array<ArrayBufferLike>>): ReadableStream<UIMessageStreamPart>;
+}
 
-declare class DefaultChatTransport<UI_MESSAGE extends UIMessage> implements ChatTransport<UI_MESSAGE> {
-    private api;
-    private credentials?;
-    private headers?;
-    private body?;
-    private fetch?;
-    private prepareRequest?;
-    constructor({ api, credentials, headers, body, fetch, prepareRequest, }?: {
-        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;
-        /**
-      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.
-         */
-        prepareRequest?: PrepareRequest<UI_MESSAGE>;
-    });
-    submitMessages({ chatId, messages, abortSignal, metadata, headers, body, requestType, }: Parameters<ChatTransport<UI_MESSAGE>['submitMessages']>[0]): Promise<ReadableStream<UIMessageStreamPart>>;
+declare class DefaultChatTransport<UI_MESSAGE extends UIMessage> extends HttpChatTransport<UI_MESSAGE> {
+    constructor(options?: HttpChatTransportInitOptions<UI_MESSAGE>);
+    protected processResponseStream(stream: ReadableStream<Uint8Array<ArrayBufferLike>>): ReadableStream<UIMessageStreamPart>;
 }
 
-declare class TextStreamChatTransport<UI_MESSAGE extends UIMessage> implements ChatTransport<UI_MESSAGE> {
-    private api;
-    private credentials?;
-    private headers?;
-    private body?;
-    private fetch?;
-    private prepareRequest?;
-    constructor({ api, credentials, headers, body, fetch, prepareRequest, }: {
-        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;
-        /**
-      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.
-         */
-        prepareRequest?: NoInfer<PrepareRequest<UI_MESSAGE>>;
-    });
-    submitMessages({ chatId, messages, abortSignal, metadata, headers, body, requestType, }: Parameters<ChatTransport<UI_MESSAGE>['submitMessages']>[0]): Promise<ReadableStream<UIMessageStreamPart<never, never>>>;
+declare class TextStreamChatTransport<UI_MESSAGE extends UIMessage> extends HttpChatTransport<UI_MESSAGE> {
+    constructor(options?: HttpChatTransportInitOptions<UI_MESSAGE>);
+    protected processResponseStream(stream: ReadableStream<Uint8Array<ArrayBufferLike>>): ReadableStream<UIMessageStreamPart>;
 }
 
 type CompletionRequestOptions = {
@@ -3659,7 +3663,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
     @param options.sendUsage Whether to send the usage information to the client. Defaults to true.
     @param options.sendReasoning Whether to send the reasoning information to the client. Defaults to false.
        */
-    pipeUIMessageStreamToResponse<UI_MESSAGE extends UIMessage>(response: ServerResponse, options?: ResponseInit & UIMessageStreamOptions<UI_MESSAGE>): void;
+    pipeUIMessageStreamToResponse<UI_MESSAGE extends UIMessage>(response: ServerResponse, options?: UIMessageStreamResponseInit & UIMessageStreamOptions<UI_MESSAGE>): void;
     /**
     Writes text delta output to a Node.js response-like object.
     It sets a `Content-Type` header to `text/plain; charset=utf-8` and
@@ -3679,7 +3683,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
     @param options.sendReasoning Whether to send the reasoning information to the client. Defaults to false.
     @return A response object.
        */
-    toUIMessageStreamResponse<UI_MESSAGE extends UIMessage>(options?: ResponseInit & UIMessageStreamOptions<UI_MESSAGE>): Response;
+    toUIMessageStreamResponse<UI_MESSAGE extends UIMessage>(options?: UIMessageStreamResponseInit & UIMessageStreamOptions<UI_MESSAGE>): Response;
     /**
     Creates a simple text stream response.
     Each text delta is encoded as UTF-8 and sent as a separate chunk.
@@ -4842,4 +4846,8 @@ declare function transcribe({ model, audio, providerOptions, maxRetries: maxRetr
     headers?: Record<string, string>;
 }): Promise<TranscriptionResult>;
 
-export { AbstractChat, AssistantContent, AssistantModelMessage, CallSettings, CallWarning, ChatInit, ChatRequestOptions, ChatState, ChatStatus, 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, GLOBAL_DEFAULT_PROVIDER, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, ImagePart, InferUIDataParts, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolInputError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MCPClientError, MCPTransport, MessageConversionError, ModelMessage, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, PrepareStepFunction, PrepareStepResult, 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, ToolCallOptions, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolModelMessage, ToolResultPart, ToolResultUnion, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessagePart, UIMessageStreamOptions, UIMessageStreamPart, UIMessageStreamWriter, UseCompletionOptions, UserContent, UserModelMessage, assistantModelMessageSchema, 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, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolName, hasToolCall, isDeepEqualData, isToolUIPart, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, tool, toolModelMessageSchema, userModelMessageSchema, wrapLanguageModel };
+declare global {
+    var AI_SDK_DEFAULT_PROVIDER: ProviderV2 | undefined;
+}
+
+export { AbstractChat, AssistantContent, AssistantModelMessage, CallSettings, CallWarning, ChatInit, ChatRequestOptions, ChatState, ChatStatus, 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, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolInputError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MCPClientError, MCPTransport, MessageConversionError, ModelMessage, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, PrepareStepFunction, PrepareStepResult, 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, ToolCallOptions, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolModelMessage, ToolResultPart, ToolResultUnion, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessagePart, UIMessageStreamOptions, UIMessageStreamPart, UIMessageStreamWriter, UI_MESSAGE_STREAM_HEADERS, UseCompletionOptions, UserContent, UserModelMessage, assistantModelMessageSchema, 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, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolName, hasToolCall, isDeepEqualData, isToolUIPart, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, tool, toolModelMessageSchema, userModelMessageSchema, wrapLanguageModel };