ai 6.0.295 → 6.0.297

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # ai
 
+## 6.0.297
+
+### Patch Changes
+
+- 8349396: fix(ai): preserve hydrated partial static tool input across stream resumptions
+- ab0b94b: fix(ai): keep idle UI message streams open with optional SSE heartbeats
+- ce660b0: Clarify that provider-executed tool execution errors bypass the UI stream's `onError` callback to preserve provider error data. Stream errors and invalid tool calls still use the callback. Runtime behavior is unchanged.
+- 850d4d5: Encode chat IDs in default stream reconnection URLs so slashes, query delimiters, and fragments stay within the ID. Reject standalone `.` and `..` IDs before fetching. Custom URLs returned by `prepareReconnectToStreamRequest` remain unchanged.
+- cdc5b56: Preserve prototype-named tools, providers, and provider metadata as own properties without changing lookup object prototypes. Prevent inherited names from resolving as registered providers or causing image metadata aggregation to fail.
+- d4203d2: Prevent automatic chat resumption when completed tool output is followed by terminal text without a completed stream state, while preserving resumption after completed model text.
+- Updated dependencies [4972874]
+- Updated dependencies [03e5a25]
+  - @ai-sdk/gateway@3.0.206
+
+## 6.0.296
+
+### Patch Changes
+
+- 0741da8: fix(ai): allow agent UI streams to use original messages as input
+- a63fa9b: fix(ai): preserve tool metadata from tool output chunks
+- a61bea9: Preserve provider metadata on corresponding `smoothStream` chunks without carrying it into subsequent metadata-free deltas.
+
 ## 6.0.295
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1736,6 +1736,13 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
 } & ({
     state: 'input-streaming';
     input?: DeepPartial<asUITool<TOOL>['input']> | undefined;
+    /**
+     * The raw tool input text received so far.
+     *
+     * This is used to continue input streaming when a message is persisted
+     * and later resumed.
+     */
+    rawInput?: string;
     output?: never;
     errorText?: never;
     callProviderMetadata?: ProviderMetadata;
@@ -1846,6 +1853,13 @@ type DynamicToolUIPart = {
 } & ({
     state: 'input-streaming';
     input?: unknown;
+    /**
+     * The raw tool input text received so far.
+     *
+     * This is used to continue input streaming when a message is persisted
+     * and later resumed.
+     */
+    rawInput?: string;
     output?: never;
     errorText?: never;
     callProviderMetadata?: ProviderMetadata;
@@ -2188,6 +2202,12 @@ type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
  * Extends the standard `ResponseInit` with additional streaming options.
  */
 type UIMessageStreamResponseInit = ResponseInit & {
+    /**
+     * Optional interval in milliseconds for sending SSE keep-alive comments.
+     * When set, an opening comment is sent immediately and additional comments
+     * are sent after the stream has been idle for the configured interval.
+     */
+    keepAliveMs?: number;
     /**
      * Optional callback to consume a copy of the SSE stream independently.
      * This is useful for logging, debugging, or processing the stream in parallel.
@@ -2255,6 +2275,11 @@ type UIMessageStreamOptions<UI_MESSAGE extends UIMessage> = {
     /**
      * Process an error, e.g. to log it. Default to `() => 'An error occurred.'`.
      *
+     * Tool execution errors marked `providerExecuted: true` bypass this callback.
+     * Their strings pass through unchanged; other values are JSON-stringified to
+     * preserve provider error data for model-message round trips. Stream errors
+     * and invalid tool calls still use it.
+     *
      * @returns error message to include in the data stream.
      */
     onError?: (error: unknown) => string;
@@ -3564,7 +3589,7 @@ type InferAgentUIMessage<AGENT, MESSAGE_METADATA = unknown> = UIMessage<MESSAGE_
  * Runs the agent and returns a response object with a UI message stream.
  *
  * @param agent - The agent to run.
- * @param uiMessages - The input UI messages.
+ * @param uiMessages - The input UI messages. Defaults to originalMessages.
  * @param abortSignal - Abort signal. Optional.
  * @param timeout - Timeout in milliseconds. Optional.
  * @param options - The options for the agent. Optional.
@@ -3573,13 +3598,14 @@ type InferAgentUIMessage<AGENT, MESSAGE_METADATA = unknown> = UIMessage<MESSAGE_
  * @param headers - Additional headers for the response. Optional.
  * @param status - The status code for the response. Optional.
  * @param statusText - The status text for the response. Optional.
+ * @param keepAliveMs - Optional interval for sending SSE keep-alive comments.
  * @param consumeSseStream - Whether to consume the SSE stream. Optional.
  *
  * @returns The response object.
  */
-declare function createAgentUIStreamResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ headers, status, statusText, consumeSseStream, ...options }: {
+declare function createAgentUIStreamResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ headers, status, statusText, keepAliveMs, consumeSseStream, ...options }: {
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
-    uiMessages: unknown[];
+    uiMessages?: unknown[];
     abortSignal?: AbortSignal;
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;
@@ -4120,7 +4146,9 @@ declare function lastAssistantMessageIsCompleteWithApprovalResponses({ messages,
 /**
  * Check if the last 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.
+ * all tool invocations must have a result. Completed model text may follow
+ * the tool invocation because client-side tool results update parts in place,
+ * but trailing text without a completed stream state prevents resubmission.
  */
 declare function lastAssistantMessageIsCompleteWithToolCalls({ messages, }: {
     messages: UIMessage[];
@@ -4303,11 +4331,12 @@ originalMessages, onStepFinish, onFinish, generateId, }: {
  * @param options.statusText - The HTTP status text for the response.
  * @param options.headers - Additional HTTP headers to include in the response.
  * @param options.stream - The UI message chunk stream to send.
+ * @param options.keepAliveMs - Optional interval for sending SSE keep-alive comments.
  * @param options.consumeSseStream - Optional callback to consume a copy of the SSE stream independently.
  *
  * @returns A `Response` object with the UI message stream as the body.
  */
-declare function createUIMessageStreamResponse({ status, statusText, headers, stream, consumeSseStream, }: UIMessageStreamResponseInit & {
+declare function createUIMessageStreamResponse({ status, statusText, headers, stream, keepAliveMs, consumeSseStream, }: UIMessageStreamResponseInit & {
     stream: ReadableStream<UIMessageChunk>;
 }): Response;
 
@@ -4329,10 +4358,11 @@ declare class JsonToSseTransformStream extends TransformStream<unknown, string>
  * @param options.statusText - The HTTP status text for the response.
  * @param options.headers - Additional HTTP headers to include in the response.
  * @param options.stream - The UI message chunk stream to send.
+ * @param options.keepAliveMs - Optional interval for sending SSE keep-alive comments.
  * @param options.consumeSseStream - Optional callback to consume a copy of the SSE stream independently.
  * @returns A promise that resolves when the stream has been written.
  */
-declare function pipeUIMessageStreamToResponse({ response, status, statusText, headers, stream, consumeSseStream, }: {
+declare function pipeUIMessageStreamToResponse({ response, status, statusText, headers, stream, keepAliveMs, consumeSseStream, }: {
     response: ServerResponse;
     stream: ReadableStream<UIMessageChunk>;
 } & UIMessageStreamResponseInit): Promise<void>;
@@ -4367,7 +4397,7 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
  * Runs the agent and stream the output as a UI message stream.
  *
  * @param agent - The agent to run.
- * @param uiMessages - The input UI messages.
+ * @param uiMessages - The input UI messages. Defaults to originalMessages.
  * @param abortSignal - The abort signal. Optional.
  * @param timeout - Timeout in milliseconds. Optional.
  * @param options - The options for the agent.
@@ -4378,7 +4408,7 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
  */
 declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, uiMessages, options, abortSignal, timeout, experimental_transform, onStepFinish, ...uiMessageStreamOptions }: {
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
-    uiMessages: unknown[];
+    uiMessages?: unknown[];
     abortSignal?: AbortSignal;
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;
@@ -4391,7 +4421,7 @@ declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet
  *
  * @param response - The Node.js ServerResponse object to pipe to.
  * @param agent - The agent to run.
- * @param uiMessages - The input UI messages.
+ * @param uiMessages - The input UI messages. Defaults to originalMessages.
  * @param abortSignal - Abort signal. Optional.
  * @param timeout - Timeout in milliseconds. Optional.
  * @param options - The options for the agent. Optional.
@@ -4400,12 +4430,13 @@ declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet
  * @param headers - Additional headers for the response. Optional.
  * @param status - The status code for the response. Optional.
  * @param statusText - The status text for the response. Optional.
+ * @param keepAliveMs - Optional interval for sending SSE keep-alive comments.
  * @param consumeSseStream - Whether to consume the SSE stream. Optional.
  */
-declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ response, headers, status, statusText, consumeSseStream, ...options }: {
+declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ response, headers, status, statusText, keepAliveMs, consumeSseStream, ...options }: {
     response: ServerResponse;
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
-    uiMessages: unknown[];
+    uiMessages?: unknown[];
     abortSignal?: AbortSignal;
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;

package/dist/index.d.ts

@@ -1736,6 +1736,13 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
 } & ({
     state: 'input-streaming';
     input?: DeepPartial<asUITool<TOOL>['input']> | undefined;
+    /**
+     * The raw tool input text received so far.
+     *
+     * This is used to continue input streaming when a message is persisted
+     * and later resumed.
+     */
+    rawInput?: string;
     output?: never;
     errorText?: never;
     callProviderMetadata?: ProviderMetadata;
@@ -1846,6 +1853,13 @@ type DynamicToolUIPart = {
 } & ({
     state: 'input-streaming';
     input?: unknown;
+    /**
+     * The raw tool input text received so far.
+     *
+     * This is used to continue input streaming when a message is persisted
+     * and later resumed.
+     */
+    rawInput?: string;
     output?: never;
     errorText?: never;
     callProviderMetadata?: ProviderMetadata;
@@ -2188,6 +2202,12 @@ type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
  * Extends the standard `ResponseInit` with additional streaming options.
  */
 type UIMessageStreamResponseInit = ResponseInit & {
+    /**
+     * Optional interval in milliseconds for sending SSE keep-alive comments.
+     * When set, an opening comment is sent immediately and additional comments
+     * are sent after the stream has been idle for the configured interval.
+     */
+    keepAliveMs?: number;
     /**
      * Optional callback to consume a copy of the SSE stream independently.
      * This is useful for logging, debugging, or processing the stream in parallel.
@@ -2255,6 +2275,11 @@ type UIMessageStreamOptions<UI_MESSAGE extends UIMessage> = {
     /**
      * Process an error, e.g. to log it. Default to `() => 'An error occurred.'`.
      *
+     * Tool execution errors marked `providerExecuted: true` bypass this callback.
+     * Their strings pass through unchanged; other values are JSON-stringified to
+     * preserve provider error data for model-message round trips. Stream errors
+     * and invalid tool calls still use it.
+     *
      * @returns error message to include in the data stream.
      */
     onError?: (error: unknown) => string;
@@ -3564,7 +3589,7 @@ type InferAgentUIMessage<AGENT, MESSAGE_METADATA = unknown> = UIMessage<MESSAGE_
  * Runs the agent and returns a response object with a UI message stream.
  *
  * @param agent - The agent to run.
- * @param uiMessages - The input UI messages.
+ * @param uiMessages - The input UI messages. Defaults to originalMessages.
  * @param abortSignal - Abort signal. Optional.
  * @param timeout - Timeout in milliseconds. Optional.
  * @param options - The options for the agent. Optional.
@@ -3573,13 +3598,14 @@ type InferAgentUIMessage<AGENT, MESSAGE_METADATA = unknown> = UIMessage<MESSAGE_
  * @param headers - Additional headers for the response. Optional.
  * @param status - The status code for the response. Optional.
  * @param statusText - The status text for the response. Optional.
+ * @param keepAliveMs - Optional interval for sending SSE keep-alive comments.
  * @param consumeSseStream - Whether to consume the SSE stream. Optional.
  *
  * @returns The response object.
  */
-declare function createAgentUIStreamResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ headers, status, statusText, consumeSseStream, ...options }: {
+declare function createAgentUIStreamResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ headers, status, statusText, keepAliveMs, consumeSseStream, ...options }: {
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
-    uiMessages: unknown[];
+    uiMessages?: unknown[];
     abortSignal?: AbortSignal;
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;
@@ -4120,7 +4146,9 @@ declare function lastAssistantMessageIsCompleteWithApprovalResponses({ messages,
 /**
  * Check if the last 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.
+ * all tool invocations must have a result. Completed model text may follow
+ * the tool invocation because client-side tool results update parts in place,
+ * but trailing text without a completed stream state prevents resubmission.
  */
 declare function lastAssistantMessageIsCompleteWithToolCalls({ messages, }: {
     messages: UIMessage[];
@@ -4303,11 +4331,12 @@ originalMessages, onStepFinish, onFinish, generateId, }: {
  * @param options.statusText - The HTTP status text for the response.
  * @param options.headers - Additional HTTP headers to include in the response.
  * @param options.stream - The UI message chunk stream to send.
+ * @param options.keepAliveMs - Optional interval for sending SSE keep-alive comments.
  * @param options.consumeSseStream - Optional callback to consume a copy of the SSE stream independently.
  *
  * @returns A `Response` object with the UI message stream as the body.
  */
-declare function createUIMessageStreamResponse({ status, statusText, headers, stream, consumeSseStream, }: UIMessageStreamResponseInit & {
+declare function createUIMessageStreamResponse({ status, statusText, headers, stream, keepAliveMs, consumeSseStream, }: UIMessageStreamResponseInit & {
     stream: ReadableStream<UIMessageChunk>;
 }): Response;
 
@@ -4329,10 +4358,11 @@ declare class JsonToSseTransformStream extends TransformStream<unknown, string>
  * @param options.statusText - The HTTP status text for the response.
  * @param options.headers - Additional HTTP headers to include in the response.
  * @param options.stream - The UI message chunk stream to send.
+ * @param options.keepAliveMs - Optional interval for sending SSE keep-alive comments.
  * @param options.consumeSseStream - Optional callback to consume a copy of the SSE stream independently.
  * @returns A promise that resolves when the stream has been written.
  */
-declare function pipeUIMessageStreamToResponse({ response, status, statusText, headers, stream, consumeSseStream, }: {
+declare function pipeUIMessageStreamToResponse({ response, status, statusText, headers, stream, keepAliveMs, consumeSseStream, }: {
     response: ServerResponse;
     stream: ReadableStream<UIMessageChunk>;
 } & UIMessageStreamResponseInit): Promise<void>;
@@ -4367,7 +4397,7 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
  * Runs the agent and stream the output as a UI message stream.
  *
  * @param agent - The agent to run.
- * @param uiMessages - The input UI messages.
+ * @param uiMessages - The input UI messages. Defaults to originalMessages.
  * @param abortSignal - The abort signal. Optional.
  * @param timeout - Timeout in milliseconds. Optional.
  * @param options - The options for the agent.
@@ -4378,7 +4408,7 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
  */
 declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, uiMessages, options, abortSignal, timeout, experimental_transform, onStepFinish, ...uiMessageStreamOptions }: {
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
-    uiMessages: unknown[];
+    uiMessages?: unknown[];
     abortSignal?: AbortSignal;
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;
@@ -4391,7 +4421,7 @@ declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet
  *
  * @param response - The Node.js ServerResponse object to pipe to.
  * @param agent - The agent to run.
- * @param uiMessages - The input UI messages.
+ * @param uiMessages - The input UI messages. Defaults to originalMessages.
  * @param abortSignal - Abort signal. Optional.
  * @param timeout - Timeout in milliseconds. Optional.
  * @param options - The options for the agent. Optional.
@@ -4400,12 +4430,13 @@ declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet
  * @param headers - Additional headers for the response. Optional.
  * @param status - The status code for the response. Optional.
  * @param statusText - The status text for the response. Optional.
+ * @param keepAliveMs - Optional interval for sending SSE keep-alive comments.
  * @param consumeSseStream - Whether to consume the SSE stream. Optional.
  */
-declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ response, headers, status, statusText, consumeSseStream, ...options }: {
+declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ response, headers, status, statusText, keepAliveMs, consumeSseStream, ...options }: {
     response: ServerResponse;
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
-    uiMessages: unknown[];
+    uiMessages?: unknown[];
     abortSignal?: AbortSignal;
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;