ai 5.0.28 → 5.0.29

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 5.0.29
+
+### Patch Changes
+
+- e0e9449: feat(ui): sent isAbort, isDisconnect, isError in useChat onFinish callback
+
 ## 5.0.28
 
 ### Patch Changes

package/README.md

@@ -56,11 +56,17 @@ npm install @ai-sdk/react
 ```tsx
 'use client';
 
+import { useState } from 'react';
 import { useChat } from '@ai-sdk/react';
 
 export default function Page() {
-  const { messages, input, handleSubmit, handleInputChange, status } =
-    useChat();
+  const { messages, status, sendMessage } = useChat();
+  const [input, setInput] = useState('');
+  const handleSubmit = e => {
+    e.preventDefault();
+    sendMessage({ text: input });
+    setInput('');
+  };
 
   return (
     <div>
@@ -82,7 +88,7 @@ export default function Page() {
         <input
           value={input}
           placeholder="Send a message..."
-          onChange={handleInputChange}
+          onChange={e => setInput(e.target.value)}
           disabled={status !== 'ready'}
         />
       </form>

package/dist/index.d.mts

@@ -4049,9 +4049,22 @@ type ChatOnToolCallCallback<UI_MESSAGE extends UIMessage = UIMessage> = (options
     toolCall: InferUIMessageToolCall<UI_MESSAGE>;
 }) => void | PromiseLike<void>;
 type ChatOnDataCallback<UI_MESSAGE extends UIMessage> = (dataPart: DataUIPart<InferUIMessageData<UI_MESSAGE>>) => void;
+/**
+ * Function that is called when the assistant response has finished streaming.
+ *
+ * @param message The assistant message that was streamed.
+ * @param messages The full chat history, including the assistant message.
+ *
+ * @param isAbort Indicates whether the request has been aborted.
+ * @param isDisconnect Indicates whether the request has been ended by a network error.
+ * @param isError Indicates whether the request has been ended by an error.
+ */
 type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
     message: UI_MESSAGE;
     messages: UI_MESSAGE[];
+    isAbort: boolean;
+    isDisconnect: boolean;
+    isError: boolean;
 }) => void;
 interface ChatInit<UI_MESSAGE extends UIMessage> {
     /**
@@ -4081,9 +4094,7 @@ interface ChatInit<UI_MESSAGE extends UIMessage> {
        */
     onToolCall?: ChatOnToolCallCallback<UI_MESSAGE>;
     /**
-     * Optional callback function that is called when the assistant message is finished streaming.
-     *
-     * @param message The message that was streamed.
+     * Function that is called when the assistant response has finished streaming.
      */
     onFinish?: ChatOnFinishCallback<UI_MESSAGE>;
     /**

package/dist/index.d.ts

@@ -4049,9 +4049,22 @@ type ChatOnToolCallCallback<UI_MESSAGE extends UIMessage = UIMessage> = (options
     toolCall: InferUIMessageToolCall<UI_MESSAGE>;
 }) => void | PromiseLike<void>;
 type ChatOnDataCallback<UI_MESSAGE extends UIMessage> = (dataPart: DataUIPart<InferUIMessageData<UI_MESSAGE>>) => void;
+/**
+ * Function that is called when the assistant response has finished streaming.
+ *
+ * @param message The assistant message that was streamed.
+ * @param messages The full chat history, including the assistant message.
+ *
+ * @param isAbort Indicates whether the request has been aborted.
+ * @param isDisconnect Indicates whether the request has been ended by a network error.
+ * @param isError Indicates whether the request has been ended by an error.
+ */
 type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
     message: UI_MESSAGE;
     messages: UI_MESSAGE[];
+    isAbort: boolean;
+    isDisconnect: boolean;
+    isError: boolean;
 }) => void;
 interface ChatInit<UI_MESSAGE extends UIMessage> {
     /**
@@ -4081,9 +4094,7 @@ interface ChatInit<UI_MESSAGE extends UIMessage> {
        */
     onToolCall?: ChatOnToolCallCallback<UI_MESSAGE>;
     /**
-     * Optional callback function that is called when the assistant message is finished streaming.
-     *
-     * @param message The message that was streamed.
+     * Function that is called when the assistant response has finished streaming.
      */
     onFinish?: ChatOnFinishCallback<UI_MESSAGE>;
     /**

package/dist/index.js

@@ -9517,6 +9517,9 @@ var AbstractChat = class {
     var _a17, _b, _c;
     this.setStatus({ status: "submitted", error: void 0 });
     const lastMessage = this.lastMessage;
+    let isAbort = false;
+    let isDisconnect = false;
+    let isError = false;
     try {
       const activeResponse = {
         state: createStreamingUIMessageState({
@@ -9525,6 +9528,9 @@ var AbstractChat = class {
         }),
         abortController: new AbortController()
       };
+      activeResponse.abortController.signal.addEventListener("abort", () => {
+        isAbort = true;
+      });
       this.activeResponse = activeResponse;
       let stream;
       if (trigger === "resume-stream") {
@@ -9588,21 +9594,33 @@ var AbstractChat = class {
           throw error;
         }
       });
-      (_a17 = this.onFinish) == null ? void 0 : _a17.call(this, {
-        message: activeResponse.state.message,
-        messages: this.state.messages
-      });
       this.setStatus({ status: "ready" });
     } catch (err) {
-      if (err.name === "AbortError") {
+      if (isAbort || err.name === "AbortError") {
+        isAbort = true;
         this.setStatus({ status: "ready" });
         return null;
       }
+      isError = true;
+      if (err instanceof TypeError && (err.message.toLowerCase().includes("fetch") || err.message.toLowerCase().includes("network"))) {
+        isDisconnect = true;
+      }
       if (this.onError && err instanceof Error) {
         this.onError(err);
       }
       this.setStatus({ status: "error", error: err });
     } finally {
+      try {
+        (_a17 = this.onFinish) == null ? void 0 : _a17.call(this, {
+          message: this.activeResponse.state.message,
+          messages: this.state.messages,
+          isAbort,
+          isDisconnect,
+          isError
+        });
+      } catch (err) {
+        console.error(err);
+      }
       this.activeResponse = void 0;
     }
     if ((_b = this.sendAutomaticallyWhen) == null ? void 0 : _b.call(this, { messages: this.state.messages })) {