ai 5.0.0-beta.32 → 5.0.0-beta.34

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # ai
 
+## 5.0.0-beta.34
+
+### Patch Changes
+
+- 53569b8: feat (ai): add experimental repairText function to streamObject
+- 88a8ee5: fix (ai): support abort during retry waits
+- f2c7f19: feat (ui): add Chat.clearError()
+- Updated dependencies [721775e]
+- Updated dependencies [88a8ee5]
+  - @ai-sdk/gateway@1.0.0-beta.19
+  - @ai-sdk/provider-utils@3.0.0-beta.10
+
+## 5.0.0-beta.33
+
+### Patch Changes
+
+- 48378b9: fix (ai): send null as tool output when tools return undefined
+- 93d53a1: chore (ai): remove cli
+- 27deb4d: feat (provider/gateway): Add providerMetadata to embeddings response
+- Updated dependencies [27deb4d]
+  - @ai-sdk/gateway@1.0.0-beta.18
+  - @ai-sdk/provider@2.0.0-beta.2
+  - @ai-sdk/provider-utils@3.0.0-beta.9
+
 ## 5.0.0-beta.32
 
 ### Patch Changes

package/dist/index.d.mts

@@ -2060,6 +2060,10 @@ interface EmbedResult<VALUE> {
       */
     readonly usage: EmbeddingModelUsage;
     /**
+    Optional provider-specific metadata.
+       */
+    readonly providerMetadata?: ProviderMetadata;
+    /**
     Optional response data.
        */
     readonly response?: {
@@ -2140,6 +2144,10 @@ interface EmbedManyResult<VALUE> {
       */
     readonly usage: EmbeddingModelUsage;
     /**
+    Optional provider-specific metadata.
+       */
+    readonly providerMetadata?: ProviderMetadata;
+    /**
     Optional raw response data.
        */
     readonly responses?: Array<{
@@ -2643,7 +2651,7 @@ interface GenerateObjectResult<OBJECT> {
 }
 
 /**
-A function that attempts to repair the raw output of the mode
+A function that attempts to repair the raw output of the model
 to enable JSON parsing.
 
 Should return the repaired text or null if the text cannot be repaired.
@@ -2652,6 +2660,7 @@ type RepairTextFunction = (options: {
     text: string;
     error: JSONParseError | TypeValidationError;
 }) => Promise<string | null>;
+
 /**
 Generate a structured, typed object for a given prompt and schema using a language model.
 
@@ -2704,7 +2713,7 @@ via tool or schema description.
 - 'enum': The output is an enum.
 - 'no-schema': The output is not a schema.
 
-@param experimental_repairText - A function that attempts to repair the raw output of the mode
+@param experimental_repairText - A function that attempts to repair the raw output of the model
 to enable JSON parsing.
 
 @param experimental_telemetry - Optional telemetry configuration (experimental).
@@ -2761,7 +2770,7 @@ The language model to use.
      */
     model: LanguageModel;
     /**
-A function that attempts to repair the raw output of the mode
+A function that attempts to repair the raw output of the model
 to enable JSON parsing.
      */
     experimental_repairText?: RepairTextFunction;
@@ -3099,6 +3108,11 @@ The language model to use.
    */
     model: LanguageModel;
     /**
+A function that attempts to repair the raw output of the model
+to enable JSON parsing.
+     */
+    experimental_repairText?: RepairTextFunction;
+    /**
 Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
@@ -3761,16 +3775,77 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
     'x-accel-buffering': string;
 };
 
+/**
+ * Transport interface for handling chat message communication and streaming.
+ *
+ * The `ChatTransport` interface provides fine-grained control over how messages
+ * are sent to API endpoints and how responses are processed. This enables
+ * alternative communication protocols like WebSockets, custom authentication
+ * patterns, or specialized backend integrations.
+ *
+ * @template UI_MESSAGE - The UI message type extending UIMessage
+ */
 interface ChatTransport<UI_MESSAGE extends UIMessage> {
+    /**
+     * Sends messages to the chat API endpoint and returns a streaming response.
+     *
+     * This method handles both new message submission and message regeneration.
+     * It supports real-time streaming of responses through UIMessageChunk events.
+     *
+     * @param options - Configuration object containing:
+     * @param options.trigger - The type of message submission:
+     *   - `'submit-message'`: Submitting a new user message
+     *   - `'regenerate-message'`: Regenerating an assistant response
+     * @param options.chatId - Unique identifier for the chat session
+     * @param options.messageId - ID of the message to regenerate (for regenerate-message trigger) or undefined for new messages
+     * @param options.messages - Array of UI messages representing the conversation history
+     * @param options.abortSignal - Signal to abort the request if needed
+     * @param options.headers - Additional HTTP headers to include in the request
+     * @param options.body - Additional JSON properties to include in the request body
+     * @param options.metadata - Custom metadata to attach to the request
+     *
+     * @returns Promise resolving to a ReadableStream of UIMessageChunk objects.
+     *   The stream emits various chunk types like:
+     *   - `text-start`, `text-delta`, `text-end`: For streaming text content
+     *   - `tool-input-start`, `tool-input-delta`, `tool-input-available`: For tool calls
+     *   - `data-part-start`, `data-part-delta`, `data-part-available`: For data parts
+     *   - `error`: For error handling
+     *
+     * @throws Error when the API request fails or response is invalid
+     */
     sendMessages: (options: {
+        /** The type of message submission - either new message or regeneration */
+        trigger: 'submit-message' | 'regenerate-message';
+        /** Unique identifier for the chat session */
         chatId: string;
+        /** ID of the message to regenerate, or undefined for new messages */
+        messageId: string | undefined;
+        /** Array of UI messages representing the conversation history */
         messages: UI_MESSAGE[];
+        /** Signal to abort the request if needed */
         abortSignal: AbortSignal | undefined;
-    } & {
-        trigger: 'submit-message' | 'regenerate-message';
-        messageId: string | undefined;
     } & ChatRequestOptions) => Promise<ReadableStream<UIMessageChunk>>;
+    /**
+     * Reconnects to an existing streaming response for the specified chat session.
+     *
+     * This method is used to resume streaming when a connection is interrupted
+     * or when resuming a chat session. It's particularly useful for maintaining
+     * continuity in long-running conversations or recovering from network issues.
+     *
+     * @param options - Configuration object containing:
+     * @param options.chatId - Unique identifier for the chat session to reconnect to
+     * @param options.headers - Additional HTTP headers to include in the reconnection request
+     * @param options.body - Additional JSON properties to include in the request body
+     * @param options.metadata - Custom metadata to attach to the request
+     *
+     * @returns Promise resolving to:
+     *   - `ReadableStream<UIMessageChunk>`: If an active stream is found and can be resumed
+     *   - `null`: If no active stream exists for the specified chat session (e.g., response already completed)
+     *
+     * @throws Error when the reconnection request fails or response is invalid
+     */
     reconnectToStream: (options: {
+        /** Unique identifier for the chat session to reconnect to */
         chatId: string;
     } & ChatRequestOptions) => Promise<ReadableStream<UIMessageChunk> | null>;
 }
@@ -3929,6 +4004,10 @@ declare abstract class AbstractChat<UI_MESSAGE extends UIMessage> {
      * Attempt to resume an ongoing streaming response.
      */
     resumeStream: (options?: ChatRequestOptions) => Promise<void>;
+    /**
+     * Clear the error state and set the status to ready if the chat is in an error state.
+     */
+    clearError: () => void;
     addToolResult: <TOOL extends keyof InferUIMessageTools<UI_MESSAGE>>({ tool, toolCallId, output, }: {
         tool: TOOL;
         toolCallId: string;

package/dist/index.d.ts

@@ -2060,6 +2060,10 @@ interface EmbedResult<VALUE> {
       */
     readonly usage: EmbeddingModelUsage;
     /**
+    Optional provider-specific metadata.
+       */
+    readonly providerMetadata?: ProviderMetadata;
+    /**
     Optional response data.
        */
     readonly response?: {
@@ -2140,6 +2144,10 @@ interface EmbedManyResult<VALUE> {
       */
     readonly usage: EmbeddingModelUsage;
     /**
+    Optional provider-specific metadata.
+       */
+    readonly providerMetadata?: ProviderMetadata;
+    /**
     Optional raw response data.
        */
     readonly responses?: Array<{
@@ -2643,7 +2651,7 @@ interface GenerateObjectResult<OBJECT> {
 }
 
 /**
-A function that attempts to repair the raw output of the mode
+A function that attempts to repair the raw output of the model
 to enable JSON parsing.
 
 Should return the repaired text or null if the text cannot be repaired.
@@ -2652,6 +2660,7 @@ type RepairTextFunction = (options: {
     text: string;
     error: JSONParseError | TypeValidationError;
 }) => Promise<string | null>;
+
 /**
 Generate a structured, typed object for a given prompt and schema using a language model.
 
@@ -2704,7 +2713,7 @@ via tool or schema description.
 - 'enum': The output is an enum.
 - 'no-schema': The output is not a schema.
 
-@param experimental_repairText - A function that attempts to repair the raw output of the mode
+@param experimental_repairText - A function that attempts to repair the raw output of the model
 to enable JSON parsing.
 
 @param experimental_telemetry - Optional telemetry configuration (experimental).
@@ -2761,7 +2770,7 @@ The language model to use.
      */
     model: LanguageModel;
     /**
-A function that attempts to repair the raw output of the mode
+A function that attempts to repair the raw output of the model
 to enable JSON parsing.
      */
     experimental_repairText?: RepairTextFunction;
@@ -3099,6 +3108,11 @@ The language model to use.
    */
     model: LanguageModel;
     /**
+A function that attempts to repair the raw output of the model
+to enable JSON parsing.
+     */
+    experimental_repairText?: RepairTextFunction;
+    /**
 Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
@@ -3761,16 +3775,77 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
     'x-accel-buffering': string;
 };
 
+/**
+ * Transport interface for handling chat message communication and streaming.
+ *
+ * The `ChatTransport` interface provides fine-grained control over how messages
+ * are sent to API endpoints and how responses are processed. This enables
+ * alternative communication protocols like WebSockets, custom authentication
+ * patterns, or specialized backend integrations.
+ *
+ * @template UI_MESSAGE - The UI message type extending UIMessage
+ */
 interface ChatTransport<UI_MESSAGE extends UIMessage> {
+    /**
+     * Sends messages to the chat API endpoint and returns a streaming response.
+     *
+     * This method handles both new message submission and message regeneration.
+     * It supports real-time streaming of responses through UIMessageChunk events.
+     *
+     * @param options - Configuration object containing:
+     * @param options.trigger - The type of message submission:
+     *   - `'submit-message'`: Submitting a new user message
+     *   - `'regenerate-message'`: Regenerating an assistant response
+     * @param options.chatId - Unique identifier for the chat session
+     * @param options.messageId - ID of the message to regenerate (for regenerate-message trigger) or undefined for new messages
+     * @param options.messages - Array of UI messages representing the conversation history
+     * @param options.abortSignal - Signal to abort the request if needed
+     * @param options.headers - Additional HTTP headers to include in the request
+     * @param options.body - Additional JSON properties to include in the request body
+     * @param options.metadata - Custom metadata to attach to the request
+     *
+     * @returns Promise resolving to a ReadableStream of UIMessageChunk objects.
+     *   The stream emits various chunk types like:
+     *   - `text-start`, `text-delta`, `text-end`: For streaming text content
+     *   - `tool-input-start`, `tool-input-delta`, `tool-input-available`: For tool calls
+     *   - `data-part-start`, `data-part-delta`, `data-part-available`: For data parts
+     *   - `error`: For error handling
+     *
+     * @throws Error when the API request fails or response is invalid
+     */
     sendMessages: (options: {
+        /** The type of message submission - either new message or regeneration */
+        trigger: 'submit-message' | 'regenerate-message';
+        /** Unique identifier for the chat session */
         chatId: string;
+        /** ID of the message to regenerate, or undefined for new messages */
+        messageId: string | undefined;
+        /** Array of UI messages representing the conversation history */
         messages: UI_MESSAGE[];
+        /** Signal to abort the request if needed */
         abortSignal: AbortSignal | undefined;
-    } & {
-        trigger: 'submit-message' | 'regenerate-message';
-        messageId: string | undefined;
     } & ChatRequestOptions) => Promise<ReadableStream<UIMessageChunk>>;
+    /**
+     * Reconnects to an existing streaming response for the specified chat session.
+     *
+     * This method is used to resume streaming when a connection is interrupted
+     * or when resuming a chat session. It's particularly useful for maintaining
+     * continuity in long-running conversations or recovering from network issues.
+     *
+     * @param options - Configuration object containing:
+     * @param options.chatId - Unique identifier for the chat session to reconnect to
+     * @param options.headers - Additional HTTP headers to include in the reconnection request
+     * @param options.body - Additional JSON properties to include in the request body
+     * @param options.metadata - Custom metadata to attach to the request
+     *
+     * @returns Promise resolving to:
+     *   - `ReadableStream<UIMessageChunk>`: If an active stream is found and can be resumed
+     *   - `null`: If no active stream exists for the specified chat session (e.g., response already completed)
+     *
+     * @throws Error when the reconnection request fails or response is invalid
+     */
     reconnectToStream: (options: {
+        /** Unique identifier for the chat session to reconnect to */
         chatId: string;
     } & ChatRequestOptions) => Promise<ReadableStream<UIMessageChunk> | null>;
 }
@@ -3929,6 +4004,10 @@ declare abstract class AbstractChat<UI_MESSAGE extends UIMessage> {
      * Attempt to resume an ongoing streaming response.
      */
     resumeStream: (options?: ChatRequestOptions) => Promise<void>;
+    /**
+     * Clear the error state and set the status to ready if the chat is in an error state.
+     */
+    clearError: () => void;
     addToolResult: <TOOL extends keyof InferUIMessageTools<UI_MESSAGE>>({ tool, toolCallId, output, }: {
         tool: TOOL;
         toolCallId: string;