@ai-sdk/react 1.0.0-canary.0 → 1.0.0-canary.2

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @ai-sdk/react
 
+## 1.0.0-canary.2
+
+### Major Changes
+
+- e117b54: chore (ui): remove deprecated useChat roundtrip options
+- 7814c4b: chore (ui): remove streamMode setting from useChat & useCompletion
+
+### Patch Changes
+
+- Updated dependencies [b469a7e]
+- Updated dependencies [7814c4b]
+- Updated dependencies [db46ce5]
+  - @ai-sdk/provider-utils@2.0.0-canary.0
+  - @ai-sdk/ui-utils@1.0.0-canary.2
+
+## 1.0.0-canary.1
+
+### Major Changes
+
+- 8bf5756: chore: remove legacy function/tool calling
+
+### Patch Changes
+
+- Updated dependencies [8bf5756]
+  - @ai-sdk/ui-utils@1.0.0-canary.1
+
 ## 1.0.0-canary.0
 
 ### Major Changes

package/dist/index.d.mts

@@ -112,17 +112,9 @@ type UseChatHelpers = {
     /** Set the data of the chat. You can use this to transform or clear the chat data. */
     setData: (data: JSONValue[] | undefined | ((data: JSONValue[] | undefined) => JSONValue[] | undefined)) => void;
 };
-declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, onToolCall, experimental_prepareRequestBody, experimental_maxAutomaticRoundtrips, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, streamMode, streamProtocol, onResponse, onFinish, onError, credentials, headers, body, generateId, fetch, keepLastMessageOnError, experimental_throttle: throttleWaitMs, }?: UseChatOptions & {
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, onToolCall, experimental_prepareRequestBody, maxSteps, streamProtocol, onResponse, onFinish, onError, credentials, headers, body, generateId, fetch, keepLastMessageOnError, experimental_throttle: throttleWaitMs, }?: UseChatOptions & {
     key?: string;
     /**
-  @deprecated Use `maxToolRoundtrips` instead.
-     */
-    experimental_maxAutomaticRoundtrips?: number;
-    /**
-  @deprecated Use `maxToolRoundtrips` instead.
-     */
-    maxAutomaticRoundtrips?: number;
-    /**
      * Experimental (React only). 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.
@@ -142,21 +134,6 @@ declare function useChat({ api, id, initialMessages, initialInput, sendExtraMess
      */
     experimental_throttle?: number;
     /**
-  Maximum number of automatic roundtrips for tool calls.
-  
-  An automatic tool call roundtrip is a call to the server with the
-  tool call results when all tool calls in the last assistant
-  message have results.
-  
-  A maximum number is required to prevent infinite loops in the
-  case of misconfigured tools.
-  
-  By default, it's set to 0, which will disable the feature.
-  
-  @deprecated Use `maxSteps` instead (which is `maxToolRoundtrips` + 1).
-       */
-    maxToolRoundtrips?: number;
-    /**
   Maximum number of sequential LLM calls (steps), e.g. when you use tool calls. Must be at least 1.
   
   A maximum number is required to prevent infinite loops in the case of misconfigured tools.
@@ -224,7 +201,7 @@ type UseCompletionHelpers = {
     /** Additional data added on the server via StreamData */
     data?: JSONValue[];
 };
-declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, streamMode, streamProtocol, fetch, onResponse, onFinish, onError, experimental_throttle: throttleWaitMs, }?: UseCompletionOptions & {
+declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, streamProtocol, fetch, onResponse, onFinish, onError, experimental_throttle: throttleWaitMs, }?: UseCompletionOptions & {
     /**
      * Custom throttle wait in ms for the completion and data updates.
      * Default is undefined, which disables throttling.

package/dist/index.d.ts

@@ -112,17 +112,9 @@ type UseChatHelpers = {
     /** Set the data of the chat. You can use this to transform or clear the chat data. */
     setData: (data: JSONValue[] | undefined | ((data: JSONValue[] | undefined) => JSONValue[] | undefined)) => void;
 };
-declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, onToolCall, experimental_prepareRequestBody, experimental_maxAutomaticRoundtrips, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, streamMode, streamProtocol, onResponse, onFinish, onError, credentials, headers, body, generateId, fetch, keepLastMessageOnError, experimental_throttle: throttleWaitMs, }?: UseChatOptions & {
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, onToolCall, experimental_prepareRequestBody, maxSteps, streamProtocol, onResponse, onFinish, onError, credentials, headers, body, generateId, fetch, keepLastMessageOnError, experimental_throttle: throttleWaitMs, }?: UseChatOptions & {
     key?: string;
     /**
-  @deprecated Use `maxToolRoundtrips` instead.
-     */
-    experimental_maxAutomaticRoundtrips?: number;
-    /**
-  @deprecated Use `maxToolRoundtrips` instead.
-     */
-    maxAutomaticRoundtrips?: number;
-    /**
      * Experimental (React only). 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.
@@ -142,21 +134,6 @@ declare function useChat({ api, id, initialMessages, initialInput, sendExtraMess
      */
     experimental_throttle?: number;
     /**
-  Maximum number of automatic roundtrips for tool calls.
-  
-  An automatic tool call roundtrip is a call to the server with the
-  tool call results when all tool calls in the last assistant
-  message have results.
-  
-  A maximum number is required to prevent infinite loops in the
-  case of misconfigured tools.
-  
-  By default, it's set to 0, which will disable the feature.
-  
-  @deprecated Use `maxSteps` instead (which is `maxToolRoundtrips` + 1).
-       */
-    maxToolRoundtrips?: number;
-    /**
   Maximum number of sequential LLM calls (steps), e.g. when you use tool calls. Must be at least 1.
   
   A maximum number is required to prevent infinite loops in the case of misconfigured tools.
@@ -224,7 +201,7 @@ type UseCompletionHelpers = {
     /** Additional data added on the server via StreamData */
     data?: JSONValue[];
 };
-declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, streamMode, streamProtocol, fetch, onResponse, onFinish, onError, experimental_throttle: throttleWaitMs, }?: UseCompletionOptions & {
+declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, streamProtocol, fetch, onResponse, onFinish, onError, experimental_throttle: throttleWaitMs, }?: UseCompletionOptions & {
     /**
      * Custom throttle wait in ms for the completion and data updates.
      * Default is undefined, which disables throttling.

package/dist/index.js

@@ -223,7 +223,7 @@ function throttle(fn, waitMs) {
 }
 
 // src/use-chat.ts
-var getStreamedResponse = async (api, chatRequest, mutate, mutateStreamData, existingDataRef, extraMetadataRef, messagesRef, abortControllerRef, generateId2, streamProtocol, onFinish, onResponse, onToolCall, sendExtraMessageFields, experimental_prepareRequestBody, fetch2, keepLastMessageOnError) => {
+var processResponseStream = async (api, chatRequest, mutate, mutateStreamData, existingDataRef, extraMetadataRef, messagesRef, abortControllerRef, generateId2, streamProtocol, onFinish, onResponse, onToolCall, sendExtraMessageFields, experimental_prepareRequestBody, fetch2, keepLastMessageOnError) => {
   var _a;
   const previousMessages = messagesRef.current;
   mutate(chatRequest.messages, false);
@@ -232,27 +232,18 @@ var getStreamedResponse = async (api, chatRequest, mutate, mutateStreamData, exi
       role,
       content,
       experimental_attachments,
-      name,
       data,
       annotations,
-      toolInvocations,
-      function_call,
-      tool_calls,
-      tool_call_id
+      toolInvocations
     }) => ({
       role,
       content,
       ...experimental_attachments !== void 0 && {
         experimental_attachments
       },
-      ...name !== void 0 && { name },
       ...data !== void 0 && { data },
       ...annotations !== void 0 && { annotations },
-      ...toolInvocations !== void 0 && { toolInvocations },
-      // outdated function/tool call handling (TODO deprecate):
-      tool_call_id,
-      ...function_call !== void 0 && { function_call },
-      ...tool_calls !== void 0 && { tool_calls }
+      ...toolInvocations !== void 0 && { toolInvocations }
     })
   );
   const existingData = existingDataRef.current;
@@ -266,19 +257,7 @@ var getStreamedResponse = async (api, chatRequest, mutate, mutateStreamData, exi
       messages: constructedMessagesPayload,
       data: chatRequest.data,
       ...extraMetadataRef.current.body,
-      ...chatRequest.body,
-      ...chatRequest.functions !== void 0 && {
-        functions: chatRequest.functions
-      },
-      ...chatRequest.function_call !== void 0 && {
-        function_call: chatRequest.function_call
-      },
-      ...chatRequest.tools !== void 0 && {
-        tools: chatRequest.tools
-      },
-      ...chatRequest.tool_choice !== void 0 && {
-        tool_choice: chatRequest.tool_choice
-      }
+      ...chatRequest.body
     },
     streamProtocol,
     credentials: extraMetadataRef.current.credentials,
@@ -309,16 +288,10 @@ function useChat({
   initialMessages,
   initialInput = "",
   sendExtraMessageFields,
-  experimental_onFunctionCall,
-  experimental_onToolCall,
   onToolCall,
   experimental_prepareRequestBody,
-  experimental_maxAutomaticRoundtrips = 0,
-  maxAutomaticRoundtrips = experimental_maxAutomaticRoundtrips,
-  maxToolRoundtrips = maxAutomaticRoundtrips,
-  maxSteps = maxToolRoundtrips != null ? maxToolRoundtrips + 1 : 1,
-  streamMode,
-  streamProtocol,
+  maxSteps = 1,
+  streamProtocol = "data",
   onResponse,
   onFinish,
   onError,
@@ -330,9 +303,6 @@ function useChat({
   keepLastMessageOnError = false,
   experimental_throttle: throttleWaitMs
 } = {}) {
-  if (streamMode) {
-    streamProtocol != null ? streamProtocol : streamProtocol = streamMode === "text" ? "text" : void 0;
-  }
   const hookId = (0, import_react2.useId)();
   const idKey = id != null ? id : hookId;
   const chatKey = typeof api === "string" ? [api, idKey] : idKey;
@@ -377,34 +347,26 @@ function useChat({
         setError(void 0);
         const abortController = new AbortController();
         abortControllerRef.current = abortController;
-        await (0, import_ui_utils2.processChatStream)({
-          getStreamedResponse: () => getStreamedResponse(
-            api,
-            chatRequest,
-            // throttle streamed ui updates:
-            throttle(mutate, throttleWaitMs),
-            throttle(mutateStreamData, throttleWaitMs),
-            streamDataRef,
-            extraMetadataRef,
-            messagesRef,
-            abortControllerRef,
-            generateId2,
-            streamProtocol,
-            onFinish,
-            onResponse,
-            onToolCall,
-            sendExtraMessageFields,
-            experimental_prepareRequestBody,
-            fetch2,
-            keepLastMessageOnError
-          ),
-          experimental_onFunctionCall,
-          experimental_onToolCall,
-          updateChatRequest: (chatRequestParam) => {
-            chatRequest = chatRequestParam;
-          },
-          getCurrentMessages: () => messagesRef.current
-        });
+        await processResponseStream(
+          api,
+          chatRequest,
+          // throttle streamed ui updates:
+          throttle(mutate, throttleWaitMs),
+          throttle(mutateStreamData, throttleWaitMs),
+          streamDataRef,
+          extraMetadataRef,
+          messagesRef,
+          abortControllerRef,
+          generateId2,
+          streamProtocol,
+          onFinish,
+          onResponse,
+          onToolCall,
+          sendExtraMessageFields,
+          experimental_prepareRequestBody,
+          fetch2,
+          keepLastMessageOnError
+        );
         abortControllerRef.current = null;
       } catch (err) {
         if (err.name === "AbortError") {
@@ -444,8 +406,6 @@ function useChat({
       streamDataRef,
       streamProtocol,
       sendExtraMessageFields,
-      experimental_onFunctionCall,
-      experimental_onToolCall,
       experimental_prepareRequestBody,
       onToolCall,
       maxSteps,
@@ -459,11 +419,6 @@ function useChat({
   );
   const append = (0, import_react2.useCallback)(
     async (message, {
-      options,
-      functions,
-      function_call,
-      tools,
-      tool_choice,
       data,
       headers: headers2,
       body: body2,
@@ -476,75 +431,29 @@ function useChat({
       const attachmentsForRequest = await prepareAttachmentsForRequest(
         experimental_attachments
       );
-      const requestOptions = {
-        headers: headers2 != null ? headers2 : options == null ? void 0 : options.headers,
-        body: body2 != null ? body2 : options == null ? void 0 : options.body
-      };
       const messages2 = messagesRef.current.concat({
         ...message,
         id: (_a = message.id) != null ? _a : generateId2(),
         createdAt: (_b = message.createdAt) != null ? _b : /* @__PURE__ */ new Date(),
         experimental_attachments: attachmentsForRequest.length > 0 ? attachmentsForRequest : void 0
       });
-      const chatRequest = {
-        messages: messages2,
-        options: requestOptions,
-        headers: requestOptions.headers,
-        body: requestOptions.body,
-        data,
-        ...functions !== void 0 && { functions },
-        ...function_call !== void 0 && { function_call },
-        ...tools !== void 0 && { tools },
-        ...tool_choice !== void 0 && { tool_choice }
-      };
-      return triggerRequest(chatRequest);
+      return triggerRequest({ messages: messages2, headers: headers2, body: body2, data });
     },
     [triggerRequest, generateId2]
   );
   const reload = (0, import_react2.useCallback)(
-    async ({
-      options,
-      functions,
-      function_call,
-      tools,
-      tool_choice,
-      data,
-      headers: headers2,
-      body: body2
-    } = {}) => {
-      if (messagesRef.current.length === 0)
+    async ({ data, headers: headers2, body: body2 } = {}) => {
+      const messages2 = messagesRef.current;
+      if (messages2.length === 0) {
         return null;
-      const requestOptions = {
-        headers: headers2 != null ? headers2 : options == null ? void 0 : options.headers,
-        body: body2 != null ? body2 : options == null ? void 0 : options.body
-      };
-      const lastMessage = messagesRef.current[messagesRef.current.length - 1];
-      if (lastMessage.role === "assistant") {
-        const chatRequest2 = {
-          messages: messagesRef.current.slice(0, -1),
-          options: requestOptions,
-          headers: requestOptions.headers,
-          body: requestOptions.body,
-          data,
-          ...functions !== void 0 && { functions },
-          ...function_call !== void 0 && { function_call },
-          ...tools !== void 0 && { tools },
-          ...tool_choice !== void 0 && { tool_choice }
-        };
-        return triggerRequest(chatRequest2);
       }
-      const chatRequest = {
-        messages: messagesRef.current,
-        options: requestOptions,
-        headers: requestOptions.headers,
-        body: requestOptions.body,
-        data,
-        ...functions !== void 0 && { functions },
-        ...function_call !== void 0 && { function_call },
-        ...tools !== void 0 && { tools },
-        ...tool_choice !== void 0 && { tool_choice }
-      };
-      return triggerRequest(chatRequest);
+      const lastMessage = messages2[messages2.length - 1];
+      return triggerRequest({
+        messages: lastMessage.role === "assistant" ? messages2.slice(0, -1) : messages2,
+        headers: headers2,
+        body: body2,
+        data
+      });
     },
     [triggerRequest]
   );
@@ -577,7 +486,7 @@ function useChat({
   const [input, setInput] = (0, import_react2.useState)(initialInput);
   const handleSubmit = (0, import_react2.useCallback)(
     async (event, options = {}, metadata) => {
-      var _a, _b, _c, _d, _e;
+      var _a;
       (_a = event == null ? void 0 : event.preventDefault) == null ? void 0 : _a.call(event);
       if (!input && !options.allowEmptySubmit)
         return;
@@ -590,10 +499,6 @@ function useChat({
       const attachmentsForRequest = await prepareAttachmentsForRequest(
         options.experimental_attachments
       );
-      const requestOptions = {
-        headers: (_c = options.headers) != null ? _c : (_b = options.options) == null ? void 0 : _b.headers,
-        body: (_e = options.body) != null ? _e : (_d = options.options) == null ? void 0 : _d.body
-      };
       const messages2 = !input && !attachmentsForRequest.length && options.allowEmptySubmit ? messagesRef.current : messagesRef.current.concat({
         id: generateId2(),
         createdAt: /* @__PURE__ */ new Date(),
@@ -603,9 +508,8 @@ function useChat({
       });
       const chatRequest = {
         messages: messages2,
-        options: requestOptions,
-        headers: requestOptions.headers,
-        body: requestOptions.body,
+        headers: options.headers,
+        body: options.body,
         data: options.data
       };
       triggerRequest(chatRequest);
@@ -712,17 +616,13 @@ function useCompletion({
   credentials,
   headers,
   body,
-  streamMode,
-  streamProtocol,
+  streamProtocol = "data",
   fetch: fetch2,
   onResponse,
   onFinish,
   onError,
   experimental_throttle: throttleWaitMs
 } = {}) {
-  if (streamMode) {
-    streamProtocol != null ? streamProtocol : streamProtocol = streamMode === "text" ? "text" : void 0;
-  }
   const hookId = (0, import_react3.useId)();
   const completionId = id || hookId;
   const { data, mutate } = (0, import_swr2.default)([api, completionId], null, {