ai 5.0.268 → 5.0.270

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # ai
 
+## 5.0.270
+
+### Patch Changes
+
+- 1849a5f: fix(ai): preserve hydrated partial static tool input across stream resumptions
+- 5381c08: fix(ai): keep idle UI message streams open with optional SSE heartbeats
+- 06e8d1c: 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.
+- 58d303f: 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.
+- 430ae0a: 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 [07e394b]
+- Updated dependencies [b6cf409]
+  - @ai-sdk/gateway@2.0.161
+
+## 5.0.269
+
+### Patch Changes
+
+- 11f5cda: Preserve provider metadata on corresponding `smoothStream` chunks without carrying it into subsequent metadata-free deltas.
+
 ## 5.0.268
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1632,6 +1632,13 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
     state: 'input-streaming';
     input: DeepPartial<asUITool<TOOL>['input']> | undefined;
     providerExecuted?: boolean;
+    /**
+     * 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;
 } | {
@@ -1681,6 +1688,13 @@ type DynamicToolUIPart = {
 } & ({
     state: 'input-streaming';
     input: unknown | 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;
 } | {
@@ -1896,6 +1910,12 @@ type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
 }) => PromiseLike<void> | void;
 
 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;
     consumeSseStream?: (options: {
         stream: ReadableStream<string>;
     }) => PromiseLike<void> | void;
@@ -3926,7 +3946,7 @@ originalMessages, onFinish, generateId, }: {
     generateId?: IdGenerator;
 }): ReadableStream<InferUIMessageChunk<UI_MESSAGE>>;
 
-declare function createUIMessageStreamResponse({ status, statusText, headers, stream, consumeSseStream, }: UIMessageStreamResponseInit & {
+declare function createUIMessageStreamResponse({ status, statusText, headers, stream, keepAliveMs, consumeSseStream, }: UIMessageStreamResponseInit & {
     stream: ReadableStream<UIMessageChunk>;
 }): Response;
 
@@ -3934,7 +3954,7 @@ declare class JsonToSseTransformStream extends TransformStream<unknown, string>
     constructor();
 }
 
-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>;
@@ -4392,9 +4412,11 @@ declare class DefaultChatTransport<UI_MESSAGE extends UIMessage> extends HttpCha
 }
 
 /**
-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.
+ * 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. 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[];

package/dist/index.d.ts

@@ -1632,6 +1632,13 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
     state: 'input-streaming';
     input: DeepPartial<asUITool<TOOL>['input']> | undefined;
     providerExecuted?: boolean;
+    /**
+     * 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;
 } | {
@@ -1681,6 +1688,13 @@ type DynamicToolUIPart = {
 } & ({
     state: 'input-streaming';
     input: unknown | 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;
 } | {
@@ -1896,6 +1910,12 @@ type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
 }) => PromiseLike<void> | void;
 
 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;
     consumeSseStream?: (options: {
         stream: ReadableStream<string>;
     }) => PromiseLike<void> | void;
@@ -3926,7 +3946,7 @@ originalMessages, onFinish, generateId, }: {
     generateId?: IdGenerator;
 }): ReadableStream<InferUIMessageChunk<UI_MESSAGE>>;
 
-declare function createUIMessageStreamResponse({ status, statusText, headers, stream, consumeSseStream, }: UIMessageStreamResponseInit & {
+declare function createUIMessageStreamResponse({ status, statusText, headers, stream, keepAliveMs, consumeSseStream, }: UIMessageStreamResponseInit & {
     stream: ReadableStream<UIMessageChunk>;
 }): Response;
 
@@ -3934,7 +3954,7 @@ declare class JsonToSseTransformStream extends TransformStream<unknown, string>
     constructor();
 }
 
-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>;
@@ -4392,9 +4412,11 @@ declare class DefaultChatTransport<UI_MESSAGE extends UIMessage> extends HttpCha
 }
 
 /**
-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.
+ * 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. 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[];

package/dist/index.js

@@ -816,7 +816,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "5.0.268" : "0.0.0-test";
+var VERSION = true ? "5.0.270" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({
@@ -3070,6 +3070,75 @@ function pipeTextStreamToResponse({
   });
 }
 
+// src/ui-message-stream/create-sse-stream-with-keep-alive.ts
+var STREAM_OPEN_COMMENT = ": stream-open\n\n";
+var KEEP_ALIVE_COMMENT = ": keep-alive\n\n";
+function createSseStreamWithKeepAlive({
+  stream,
+  keepAliveMs
+}) {
+  if (keepAliveMs == null) {
+    return stream;
+  }
+  if (!Number.isFinite(keepAliveMs) || keepAliveMs <= 0 || keepAliveMs > 2147483647) {
+    throw new Error(
+      "keepAliveMs must be a positive finite timer duration no greater than 2147483647"
+    );
+  }
+  const reader = stream.getReader();
+  let keepAliveTimeout;
+  let isCancelled = false;
+  const clearKeepAliveTimeout = () => {
+    clearTimeout(keepAliveTimeout);
+    keepAliveTimeout = void 0;
+  };
+  const scheduleKeepAlive = (controller) => {
+    clearKeepAliveTimeout();
+    keepAliveTimeout = setTimeout(() => {
+      if (isCancelled) {
+        return;
+      }
+      if (controller.desiredSize != null && controller.desiredSize > 0) {
+        controller.enqueue(KEEP_ALIVE_COMMENT);
+      }
+      scheduleKeepAlive(controller);
+    }, keepAliveMs);
+  };
+  return new ReadableStream({
+    start(controller) {
+      controller.enqueue(STREAM_OPEN_COMMENT);
+      scheduleKeepAlive(controller);
+    },
+    pull(controller) {
+      return reader.read().then(
+        (result) => {
+          clearKeepAliveTimeout();
+          if (isCancelled) {
+            return;
+          }
+          if (result.done) {
+            controller.close();
+          } else {
+            controller.enqueue(result.value);
+            scheduleKeepAlive(controller);
+          }
+        },
+        (error) => {
+          clearKeepAliveTimeout();
+          if (!isCancelled) {
+            throw error;
+          }
+        }
+      );
+    },
+    async cancel(reason) {
+      isCancelled = true;
+      clearKeepAliveTimeout();
+      await reader.cancel(reason);
+    }
+  });
+}
+
 // src/ui-message-stream/json-to-sse-transform-stream.ts
 var JsonToSseTransformStream = class extends TransformStream {
   constructor() {
@@ -3102,9 +3171,13 @@ function createUIMessageStreamResponse({
   statusText,
   headers,
   stream,
+  keepAliveMs,
   consumeSseStream
 }) {
-  let sseStream = stream.pipeThrough(new JsonToSseTransformStream());
+  let sseStream = createSseStreamWithKeepAlive({
+    stream: stream.pipeThrough(new JsonToSseTransformStream()),
+    keepAliveMs
+  });
   if (consumeSseStream) {
     const [stream1, stream2] = sseStream.tee();
     sseStream = stream1;
@@ -3700,16 +3773,41 @@ function createStreamingUIMessageState({
   lastMessage,
   messageId
 }) {
+  var _a16;
+  const message = (lastMessage == null ? void 0 : lastMessage.role) === "assistant" ? lastMessage : {
+    id: messageId,
+    metadata: void 0,
+    role: "assistant",
+    parts: []
+  };
+  const partialToolCalls = createIdMap();
+  const lastStepStartIndex = message.parts.findLastIndex(
+    (part) => part.type === "step-start"
+  );
+  let staticToolIndex = 0;
+  for (const part of message.parts.slice(lastStepStartIndex + 1)) {
+    if (!isToolOrDynamicToolUIPart(part)) {
+      continue;
+    }
+    const index = staticToolIndex;
+    if (isToolUIPart(part)) {
+      staticToolIndex++;
+    }
+    if (part.state !== "input-streaming") {
+      continue;
+    }
+    partialToolCalls[part.toolCallId] = {
+      text: (_a16 = part.rawInput) != null ? _a16 : "",
+      index,
+      toolName: isDynamicToolUIPart(part) ? part.toolName : getToolName(part),
+      dynamic: isDynamicToolUIPart(part)
+    };
+  }
   return {
-    message: (lastMessage == null ? void 0 : lastMessage.role) === "assistant" ? lastMessage : {
-      id: messageId,
-      metadata: void 0,
-      role: "assistant",
-      parts: []
-    },
+    message,
     activeTextParts: createIdMap(),
     activeReasoningParts: createIdMap(),
-    partialToolCalls: createIdMap()
+    partialToolCalls
   };
 }
 function processUIMessageStream({
@@ -3817,7 +3915,7 @@ function processUIMessageStream({
             }
           }
           function updateDynamicToolPart(options, existingPart) {
-            var _a17, _b2;
+            var _a17;
             const part = existingPart != null ? existingPart : getCurrentStepParts().find(
               (part2) => part2.type === "dynamic-tool" && part2.toolCallId === options.toolCallId
             );
@@ -3829,9 +3927,9 @@ function processUIMessageStream({
               anyPart.input = anyOptions.input;
               anyPart.output = anyOptions.output;
               anyPart.errorText = anyOptions.errorText;
-              anyPart.rawInput = (_a17 = anyOptions.rawInput) != null ? _a17 : anyPart.rawInput;
+              anyPart.rawInput = anyOptions.rawInput;
               anyPart.preliminary = anyOptions.preliminary;
-              anyPart.providerExecuted = (_b2 = anyOptions.providerExecuted) != null ? _b2 : part.providerExecuted;
+              anyPart.providerExecuted = (_a17 = anyOptions.providerExecuted) != null ? _a17 : part.providerExecuted;
               if (anyOptions.providerMetadata != null && part.state === "input-available") {
                 part.callProviderMetadata = anyOptions.providerMetadata;
               }
@@ -3989,14 +4087,16 @@ function processUIMessageStream({
                   toolCallId: chunk.toolCallId,
                   toolName: partialToolCall.toolName,
                   state: "input-streaming",
-                  input: partialArgs
+                  input: partialArgs,
+                  rawInput: partialToolCall.text
                 });
               } else {
                 updateToolPart({
                   toolCallId: chunk.toolCallId,
                   toolName: partialToolCall.toolName,
                   state: "input-streaming",
-                  input: partialArgs
+                  input: partialArgs,
+                  rawInput: partialToolCall.text
                 });
               }
               write();
@@ -4310,9 +4410,13 @@ function pipeUIMessageStreamToResponse({
   statusText,
   headers,
   stream,
+  keepAliveMs,
   consumeSseStream
 }) {
-  let sseStream = stream.pipeThrough(new JsonToSseTransformStream());
+  let sseStream = createSseStreamWithKeepAlive({
+    stream: stream.pipeThrough(new JsonToSseTransformStream()),
+    keepAliveMs
+  });
   if (consumeSseStream) {
     const [stream1, stream2] = sseStream.tee();
     sseStream = stream1;
@@ -6636,6 +6740,21 @@ var DefaultEmbedResult = class {
   }
 };
 
+// src/util/get-own.ts
+function getOwn(obj, key) {
+  return obj != null && Object.hasOwn(obj, key) ? obj[key] : void 0;
+}
+
+// src/util/set-own.ts
+function setOwn(object2, key, value) {
+  Object.defineProperty(object2, key, {
+    value,
+    enumerable: true,
+    configurable: true,
+    writable: true
+  });
+}
+
 // src/embed/embed-many.ts
 var import_provider_utils18 = require("@ai-sdk/provider-utils");
 
@@ -6861,10 +6980,10 @@ async function embedMany({
               for (const [providerName, metadata] of Object.entries(
                 result.providerMetadata
               )) {
-                providerMetadata[providerName] = {
-                  ...providerMetadata[providerName],
+                setOwn(providerMetadata, providerName, {
+                  ...getOwn(providerMetadata, providerName),
                   ...metadata
-                };
+                });
               }
             }
           }
@@ -7042,10 +7161,13 @@ async function generateImage({
             delete providerMetadata[providerName].images;
           }
         } else {
-          (_b = providerMetadata[providerName]) != null ? _b : providerMetadata[providerName] = { images: [] };
-          providerMetadata[providerName].images.push(
+          const currentEntry = (_b = getOwn(providerMetadata, providerName)) != null ? _b : {
+            images: []
+          };
+          currentEntry.images.push(
             ...result.providerMetadata[providerName].images
           );
+          setOwn(providerMetadata, providerName, currentEntry);
         }
       }
     }
@@ -8810,28 +8932,51 @@ function smoothStream({
   return () => {
     let buffer = "";
     let id = "";
+    let providerMetadata;
+    function flushBuffer(controller) {
+      if (buffer.length > 0 || providerMetadata != null) {
+        controller.enqueue({
+          type: "text-delta",
+          text: buffer,
+          id,
+          ...providerMetadata != null ? { providerMetadata } : {}
+        });
+        buffer = "";
+        providerMetadata = void 0;
+      }
+    }
     return new TransformStream({
       async transform(chunk, controller) {
         if (chunk.type !== "text-delta") {
-          if (buffer.length > 0) {
-            controller.enqueue({ type: "text-delta", text: buffer, id });
-            buffer = "";
-          }
+          flushBuffer(controller);
+          controller.enqueue(chunk);
+          return;
+        }
+        if (chunk.text.length === 0 && chunk.providerMetadata != null) {
+          flushBuffer(controller);
           controller.enqueue(chunk);
           return;
         }
-        if (chunk.id !== id && buffer.length > 0) {
-          controller.enqueue({ type: "text-delta", text: buffer, id });
-          buffer = "";
+        if (buffer.length > 0 && (chunk.id !== id || providerMetadata != null || chunk.providerMetadata != null)) {
+          flushBuffer(controller);
         }
         buffer += chunk.text;
         id = chunk.id;
+        providerMetadata = chunk.providerMetadata;
         let match;
         while ((match = detectChunk(buffer)) != null) {
-          controller.enqueue({ type: "text-delta", text: match, id });
+          controller.enqueue({
+            type: "text-delta",
+            text: match,
+            id,
+            ...providerMetadata != null ? { providerMetadata } : {}
+          });
           buffer = buffer.slice(match.length);
           await delay2(isDocumentHidden() ? null : delayInMs);
         }
+        if (buffer.length === 0) {
+          providerMetadata = void 0;
+        }
       }
     });
   };
@@ -9275,7 +9420,7 @@ var DefaultProviderRegistry = class {
     separator,
     languageModelMiddleware
   }) {
-    this.providers = {};
+    this.providers = /* @__PURE__ */ Object.create(null);
     this.separator = separator;
     this.languageModelMiddleware = languageModelMiddleware;
   }
@@ -9630,6 +9775,10 @@ var import_provider_utils31 = require("@ai-sdk/provider-utils");
 
 // src/ui/http-chat-transport.ts
 var import_provider_utils30 = require("@ai-sdk/provider-utils");
+function appendPathToUrl(url, path) {
+  const queryOrFragmentStart = url.search(/[?#]/);
+  return queryOrFragmentStart === -1 ? `${url}${path}` : `${url.slice(0, queryOrFragmentStart)}${path}${url.slice(queryOrFragmentStart)}`;
+}
 var HttpChatTransport = class {
   constructor({
     api = "/api/chat",
@@ -9704,7 +9853,7 @@ var HttpChatTransport = class {
     return this.processResponseStream(response.body);
   }
   async reconnectToStream(options) {
-    var _a16, _b, _c, _d, _e;
+    var _a16, _b, _c, _d;
     const resolvedBody = await (0, import_provider_utils30.resolve)(this.body);
     const resolvedHeaders = await (0, import_provider_utils30.resolve)(this.headers);
     const resolvedCredentials = await (0, import_provider_utils30.resolve)(this.credentials);
@@ -9720,10 +9869,23 @@ var HttpChatTransport = class {
       credentials: resolvedCredentials,
       requestMetadata: options.metadata
     }));
-    const api = (_b = preparedRequest == null ? void 0 : preparedRequest.api) != null ? _b : `${this.api}/${options.chatId}/stream`;
+    let api = preparedRequest == null ? void 0 : preparedRequest.api;
+    if (api == null) {
+      if (options.chatId === "." || options.chatId === "..") {
+        throw new InvalidArgumentError({
+          parameter: "chatId",
+          value: options.chatId,
+          message: 'Chat IDs must not be "." or ".." when using the default reconnect URL.'
+        });
+      }
+      api = appendPathToUrl(
+        this.api,
+        `/${encodeURIComponent(options.chatId)}/stream`
+      );
+    }
     const headers = (preparedRequest == null ? void 0 : preparedRequest.headers) !== void 0 ? (0, import_provider_utils30.normalizeHeaders)(preparedRequest.headers) : baseHeaders;
-    const credentials = (_c = preparedRequest == null ? void 0 : preparedRequest.credentials) != null ? _c : resolvedCredentials;
-    const fetch2 = (_d = this.fetch) != null ? _d : globalThis.fetch;
+    const credentials = (_b = preparedRequest == null ? void 0 : preparedRequest.credentials) != null ? _b : resolvedCredentials;
+    const fetch2 = (_c = this.fetch) != null ? _c : globalThis.fetch;
     const response = await fetch2(api, {
       method: "GET",
       headers,
@@ -9735,7 +9897,7 @@ var HttpChatTransport = class {
     }
     if (!response.ok) {
       throw new Error(
-        (_e = await response.text()) != null ? _e : "Failed to fetch the chat response."
+        (_d = await response.text()) != null ? _d : "Failed to fetch the chat response."
       );
     }
     if (!response.body) {
@@ -9997,6 +10159,9 @@ var AbstractChat = class {
     };
     this.setStatus({ status: "submitted", error: void 0 });
     const lastMessage = this.lastMessage;
+    const resumableResponseMessage = trigger === "resume-stream" && (lastMessage == null ? void 0 : lastMessage.role) === "assistant" && lastMessage.parts.some(
+      (part) => isToolOrDynamicToolUIPart(part) && part.state === "input-streaming"
+    ) ? this.state.snapshot(lastMessage) : void 0;
     let isAbort = false;
     let isDisconnect = false;
     let isError = false;
@@ -10004,7 +10169,7 @@ var AbstractChat = class {
     try {
       const response = {
         state: trigger === "resume-stream" && this.resumableStreamState != null ? this.resumableStreamState : createStreamingUIMessageState({
-          lastMessage: trigger === "resume-stream" ? void 0 : this.state.snapshot(lastMessage),
+          lastMessage: trigger === "resume-stream" ? resumableResponseMessage : this.state.snapshot(lastMessage),
           messageId: this.generateId()
         }),
         abortController
@@ -10185,8 +10350,13 @@ function lastAssistantMessageIsCompleteWithToolCalls({
   const lastStepStartIndex = message.parts.reduce((lastIndex, part, index) => {
     return part.type === "step-start" ? index : lastIndex;
   }, -1);
-  const lastStepToolInvocations = message.parts.slice(lastStepStartIndex + 1).filter(isToolOrDynamicToolUIPart).filter((part) => !part.providerExecuted);
-  return lastStepToolInvocations.length > 0 && lastStepToolInvocations.every(
+  const lastStepParts = message.parts.slice(lastStepStartIndex + 1);
+  const lastStepToolInvocations = lastStepParts.filter(isToolOrDynamicToolUIPart).filter((part) => !part.providerExecuted);
+  const lastToolInvocationIndex = lastStepParts.reduce(
+    (lastIndex, part, index) => isToolOrDynamicToolUIPart(part) && !part.providerExecuted ? index : lastIndex,
+    -1
+  );
+  return lastStepToolInvocations.length > 0 && !lastStepParts.slice(lastToolInvocationIndex + 1).some((part) => part.type === "text" && part.state !== "done") && lastStepToolInvocations.every(
     (part) => part.state === "output-available" || part.state === "output-error"
   );
 }
@@ -10315,6 +10485,7 @@ var uiMessagesSchema = (0, import_provider_utils33.lazyValidator)(
               toolCallId: import_v48.z.string(),
               state: import_v48.z.literal("input-streaming"),
               input: import_v48.z.unknown().optional(),
+              rawInput: import_v48.z.string().optional(),
               providerExecuted: import_v48.z.boolean().optional(),
               output: import_v48.z.never().optional(),
               errorText: import_v48.z.never().optional()
@@ -10360,6 +10531,7 @@ var uiMessagesSchema = (0, import_provider_utils33.lazyValidator)(
               state: import_v48.z.literal("input-streaming"),
               providerExecuted: import_v48.z.boolean().optional(),
               input: import_v48.z.unknown().optional(),
+              rawInput: import_v48.z.string().optional(),
               output: import_v48.z.never().optional(),
               errorText: import_v48.z.never().optional(),
               approval: import_v48.z.never().optional()