ai 4.1.18 → 4.1.20

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # ai
 
+## 4.1.20
+
+### Patch Changes
+
+- bcc61d4: feat (ui): introduce message parts for useChat
+- Updated dependencies [bcc61d4]
+  - @ai-sdk/ui-utils@1.1.10
+  - @ai-sdk/react@1.1.10
+
+## 4.1.19
+
+### Patch Changes
+
+- Updated dependencies [6b8cc14]
+  - @ai-sdk/ui-utils@1.1.9
+  - @ai-sdk/react@1.1.9
+
 ## 4.1.18
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { IDGenerator } from '@ai-sdk/provider-utils';
 export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
-import { DataStreamString, ToolInvocation, Attachment, Schema, DeepPartial, Message, JSONValue as JSONValue$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
+import { DataStreamString, Message, Schema, DeepPartial, JSONValue as JSONValue$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UseAssistantOptions, formatAssistantStreamPart, formatDataStreamPart, jsonSchema, parseAssistantStreamPart, parseDataStreamPart, processDataStream, processTextStream } from '@ai-sdk/ui-utils';
 import { JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, LanguageModelV1CallOptions, AISDKError, LanguageModelV1FunctionToolCall, JSONSchema7, ProviderV1, NoSuchModelError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1Prompt, LanguageModelV1StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
@@ -838,13 +838,6 @@ It can be a user message, an assistant message, or a tool message.
 type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
 declare const coreMessageSchema: z.ZodType<CoreMessage>;
 
-type UIMessage = {
-    role: 'system' | 'user' | 'assistant' | 'data';
-    content: string;
-    toolInvocations?: ToolInvocation[];
-    experimental_attachments?: Attachment[];
-};
-
 /**
 Prompt part of the AI function options.
 It contains a system message, a simple text prompt, or a list of messages.
@@ -861,7 +854,7 @@ type Prompt = {
     /**
   A list of messages. You can either use `prompt` or `messages` but not both.
      */
-    messages?: Array<CoreMessage> | Array<UIMessage>;
+    messages?: Array<CoreMessage> | Array<Omit<Message, 'id'>>;
 };
 
 /**
@@ -1711,16 +1704,22 @@ type StepResult<TOOLS extends ToolSet> = {
  *
  * @returns A new Message[] with the response messages appended.
  */
-declare function appendResponseMessages({ messages, responseMessages, }: {
+declare function appendResponseMessages({ messages, responseMessages, _internal: { currentDate }, }: {
     messages: Message[];
     responseMessages: ResponseMessage[];
+    /**
+  Internal. For test use only. May change without notice.
+       */
+    _internal?: {
+        currentDate?: () => Date;
+    };
 }): Message[];
 
 /**
 Converts an array of messages from useChat into an array of CoreMessages that can be used
 with the AI core functions (e.g. `streamText`).
  */
-declare function convertToCoreMessages<TOOLS extends ToolSet = never>(messages: Array<UIMessage>, options?: {
+declare function convertToCoreMessages<TOOLS extends ToolSet = never>(messages: Array<Omit<Message, 'id'>>, options?: {
     tools?: TOOLS;
 }): CoreMessage[];
 
@@ -2750,9 +2749,9 @@ declare class InvalidMessageRoleError extends AISDKError {
 declare const symbol$2: unique symbol;
 declare class MessageConversionError extends AISDKError {
     private readonly [symbol$2];
-    readonly originalMessage: UIMessage;
+    readonly originalMessage: Omit<Message, 'id'>;
     constructor({ originalMessage, message, }: {
-        originalMessage: UIMessage;
+        originalMessage: Omit<Message, 'id'>;
         message: string;
     });
     static isInstance(error: unknown): error is MessageConversionError;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { IDGenerator } from '@ai-sdk/provider-utils';
 export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
-import { DataStreamString, ToolInvocation, Attachment, Schema, DeepPartial, Message, JSONValue as JSONValue$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
+import { DataStreamString, Message, Schema, DeepPartial, JSONValue as JSONValue$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UseAssistantOptions, formatAssistantStreamPart, formatDataStreamPart, jsonSchema, parseAssistantStreamPart, parseDataStreamPart, processDataStream, processTextStream } from '@ai-sdk/ui-utils';
 import { JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, LanguageModelV1CallOptions, AISDKError, LanguageModelV1FunctionToolCall, JSONSchema7, ProviderV1, NoSuchModelError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1Prompt, LanguageModelV1StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
@@ -838,13 +838,6 @@ It can be a user message, an assistant message, or a tool message.
 type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
 declare const coreMessageSchema: z.ZodType<CoreMessage>;
 
-type UIMessage = {
-    role: 'system' | 'user' | 'assistant' | 'data';
-    content: string;
-    toolInvocations?: ToolInvocation[];
-    experimental_attachments?: Attachment[];
-};
-
 /**
 Prompt part of the AI function options.
 It contains a system message, a simple text prompt, or a list of messages.
@@ -861,7 +854,7 @@ type Prompt = {
     /**
   A list of messages. You can either use `prompt` or `messages` but not both.
      */
-    messages?: Array<CoreMessage> | Array<UIMessage>;
+    messages?: Array<CoreMessage> | Array<Omit<Message, 'id'>>;
 };
 
 /**
@@ -1711,16 +1704,22 @@ type StepResult<TOOLS extends ToolSet> = {
  *
  * @returns A new Message[] with the response messages appended.
  */
-declare function appendResponseMessages({ messages, responseMessages, }: {
+declare function appendResponseMessages({ messages, responseMessages, _internal: { currentDate }, }: {
     messages: Message[];
     responseMessages: ResponseMessage[];
+    /**
+  Internal. For test use only. May change without notice.
+       */
+    _internal?: {
+        currentDate?: () => Date;
+    };
 }): Message[];
 
 /**
 Converts an array of messages from useChat into an array of CoreMessages that can be used
 with the AI core functions (e.g. `streamText`).
  */
-declare function convertToCoreMessages<TOOLS extends ToolSet = never>(messages: Array<UIMessage>, options?: {
+declare function convertToCoreMessages<TOOLS extends ToolSet = never>(messages: Array<Omit<Message, 'id'>>, options?: {
     tools?: TOOLS;
 }): CoreMessage[];
 
@@ -2750,9 +2749,9 @@ declare class InvalidMessageRoleError extends AISDKError {
 declare const symbol$2: unique symbol;
 declare class MessageConversionError extends AISDKError {
     private readonly [symbol$2];
-    readonly originalMessage: UIMessage;
+    readonly originalMessage: Omit<Message, 'id'>;
     constructor({ originalMessage, message, }: {
-        originalMessage: UIMessage;
+        originalMessage: Omit<Message, 'id'>;
         message: string;
     });
     static isInstance(error: unknown): error is MessageConversionError;

package/dist/index.js

@@ -1594,13 +1594,13 @@ _a8 = symbol8;
 
 // core/prompt/convert-to-core-messages.ts
 function convertToCoreMessages(messages, options) {
-  var _a15;
+  var _a15, _b;
   const tools = (_a15 = options == null ? void 0 : options.tools) != null ? _a15 : {};
   const coreMessages = [];
   for (let i = 0; i < messages.length; i++) {
     const message = messages[i];
     const isLastMessage = i === messages.length - 1;
-    const { role, content, toolInvocations, experimental_attachments } = message;
+    const { role, content, experimental_attachments } = message;
     switch (role) {
       case "system": {
         coreMessages.push({
@@ -1620,6 +1620,92 @@ function convertToCoreMessages(messages, options) {
         break;
       }
       case "assistant": {
+        if (message.parts != null) {
+          let processBlock2 = function() {
+            coreMessages.push({
+              role: "assistant",
+              content: block.map((part) => {
+                switch (part.type) {
+                  case "text":
+                    return {
+                      type: "text",
+                      text: part.text
+                    };
+                  default:
+                    return {
+                      type: "tool-call",
+                      toolCallId: part.toolInvocation.toolCallId,
+                      toolName: part.toolInvocation.toolName,
+                      args: part.toolInvocation.args
+                    };
+                }
+              })
+            });
+            const stepInvocations = block.filter(
+              (part) => part.type === "tool-invocation"
+            ).map((part) => part.toolInvocation);
+            if (stepInvocations.length > 0) {
+              coreMessages.push({
+                role: "tool",
+                content: stepInvocations.map(
+                  (toolInvocation) => {
+                    if (!("result" in toolInvocation)) {
+                      throw new MessageConversionError({
+                        originalMessage: message,
+                        message: "ToolInvocation must have a result: " + JSON.stringify(toolInvocation)
+                      });
+                    }
+                    const { toolCallId, toolName, result } = toolInvocation;
+                    const tool2 = tools[toolName];
+                    return (tool2 == null ? void 0 : tool2.experimental_toToolResultContent) != null ? {
+                      type: "tool-result",
+                      toolCallId,
+                      toolName,
+                      result: tool2.experimental_toToolResultContent(result),
+                      experimental_content: tool2.experimental_toToolResultContent(result)
+                    } : {
+                      type: "tool-result",
+                      toolCallId,
+                      toolName,
+                      result
+                    };
+                  }
+                )
+              });
+            }
+            block = [];
+            blockHasToolInvocations = false;
+            currentStep++;
+          };
+          var processBlock = processBlock2;
+          let currentStep = 0;
+          let blockHasToolInvocations = false;
+          let block = [];
+          for (const part of message.parts) {
+            switch (part.type) {
+              case "reasoning":
+                break;
+              case "text": {
+                if (blockHasToolInvocations) {
+                  processBlock2();
+                }
+                block.push(part);
+                break;
+              }
+              case "tool-invocation": {
+                if (((_b = part.toolInvocation.step) != null ? _b : 0) !== currentStep) {
+                  processBlock2();
+                }
+                block.push(part);
+                blockHasToolInvocations = true;
+                break;
+              }
+            }
+          }
+          processBlock2();
+          break;
+        }
+        const toolInvocations = message.toolInvocations;
         if (toolInvocations == null || toolInvocations.length === 0) {
           coreMessages.push({ role: "assistant", content });
           break;
@@ -5816,16 +5902,17 @@ function appendClientMessage({
 var import_ui_utils9 = require("@ai-sdk/ui-utils");
 function appendResponseMessages({
   messages,
-  responseMessages
+  responseMessages,
+  _internal: { currentDate = () => /* @__PURE__ */ new Date() } = {}
 }) {
-  var _a15, _b;
+  var _a15, _b, _c, _d;
   const clonedMessages = structuredClone(messages);
   for (const message of responseMessages) {
     const role = message.role;
     const lastMessage = clonedMessages[clonedMessages.length - 1];
     const isLastMessageAssistant = lastMessage.role === "assistant";
     switch (role) {
-      case "assistant": {
+      case "assistant":
         let getToolInvocations2 = function(step) {
           return (typeof message.content === "string" ? [] : message.content.filter((part) => part.type === "tool-call")).map((call) => ({
             state: "call",
@@ -5841,40 +5928,71 @@ function appendResponseMessages({
           const maxStep = (0, import_ui_utils9.extractMaxToolInvocationStep)(
             lastMessage.toolInvocations
           );
+          (_a15 = lastMessage.parts) != null ? _a15 : lastMessage.parts = [];
           lastMessage.content = textContent;
+          if (textContent.length > 0) {
+            lastMessage.parts.push({
+              type: "text",
+              text: textContent
+            });
+          }
           lastMessage.toolInvocations = [
-            ...(_a15 = lastMessage.toolInvocations) != null ? _a15 : [],
+            ...(_b = lastMessage.toolInvocations) != null ? _b : [],
             ...getToolInvocations2(maxStep === void 0 ? 0 : maxStep + 1)
           ];
+          getToolInvocations2(maxStep === void 0 ? 0 : maxStep + 1).map((call) => ({
+            type: "tool-invocation",
+            toolInvocation: call
+          })).forEach((part) => {
+            lastMessage.parts.push(part);
+          });
         } else {
           clonedMessages.push({
             role: "assistant",
             id: message.id,
-            createdAt: /* @__PURE__ */ new Date(),
+            createdAt: currentDate(),
             // generate a createdAt date for the message, will be overridden by the client
             content: textContent,
-            toolInvocations: getToolInvocations2(0)
+            toolInvocations: getToolInvocations2(0),
+            parts: [
+              ...textContent.length > 0 ? [{ type: "text", text: textContent }] : [],
+              ...getToolInvocations2(0).map((call) => ({
+                type: "tool-invocation",
+                toolInvocation: call
+              }))
+            ]
           });
         }
         break;
-      }
       case "tool": {
-        (_b = lastMessage.toolInvocations) != null ? _b : lastMessage.toolInvocations = [];
+        (_c = lastMessage.toolInvocations) != null ? _c : lastMessage.toolInvocations = [];
         if (lastMessage.role !== "assistant") {
           throw new Error(
             `Tool result must follow an assistant message: ${lastMessage.role}`
           );
         }
-        for (const part of message.content) {
+        (_d = lastMessage.parts) != null ? _d : lastMessage.parts = [];
+        for (const contentPart of message.content) {
           const toolCall = lastMessage.toolInvocations.find(
-            (call) => call.toolCallId === part.toolCallId
+            (call) => call.toolCallId === contentPart.toolCallId
+          );
+          const toolCallPart = lastMessage.parts.find(
+            (part) => part.type === "tool-invocation" && part.toolInvocation.toolCallId === contentPart.toolCallId
           );
           if (!toolCall) {
             throw new Error("Tool call not found in previous message");
           }
           toolCall.state = "result";
           const toolResult = toolCall;
-          toolResult.result = part.result;
+          toolResult.result = contentPart.result;
+          if (toolCallPart) {
+            toolCallPart.toolInvocation = toolResult;
+          } else {
+            lastMessage.parts.push({
+              type: "tool-invocation",
+              toolInvocation: toolResult
+            });
+          }
         }
         break;
       }