ai 5.0.91 → 5.0.92

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 5.0.92
+
+### Patch Changes
+
+- 250edbd: Added finishReason on useChat onFinish callbck
+
 ## 5.0.91
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1751,6 +1751,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazyValidator<{
     messageMetadata?: unknown;
 } | {
     type: "finish";
+    finishReason?: "other" | "length" | "unknown" | "error" | "stop" | "content-filter" | "tool-calls" | undefined;
     messageMetadata?: unknown;
 } | {
     type: "abort";
@@ -1863,6 +1864,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     messageMetadata?: METADATA;
 } | {
     type: 'finish';
+    finishReason?: FinishReason;
     messageMetadata?: METADATA;
 } | {
     type: 'abort';
@@ -1891,6 +1893,10 @@ type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
      * (including the original message if it was extended).
      */
     responseMessage: UI_MESSAGE;
+    /**
+     * The reason why the generation finished.
+     */
+    finishReason?: FinishReason;
 }) => PromiseLike<void> | void;
 
 type UIMessageStreamResponseInit = ResponseInit & {
@@ -4071,6 +4077,7 @@ type ChatOnDataCallback<UI_MESSAGE extends UIMessage> = (dataPart: DataUIPart<In
  * @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.
+ * @param finishReason The reason why the generation finished.
  */
 type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
     message: UI_MESSAGE;
@@ -4078,6 +4085,7 @@ type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
     isAbort: boolean;
     isDisconnect: boolean;
     isError: boolean;
+    finishReason?: FinishReason;
 }) => void;
 interface ChatInit<UI_MESSAGE extends UIMessage> {
     /**

package/dist/index.d.ts

@@ -1751,6 +1751,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazyValidator<{
     messageMetadata?: unknown;
 } | {
     type: "finish";
+    finishReason?: "other" | "length" | "unknown" | "error" | "stop" | "content-filter" | "tool-calls" | undefined;
     messageMetadata?: unknown;
 } | {
     type: "abort";
@@ -1863,6 +1864,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     messageMetadata?: METADATA;
 } | {
     type: 'finish';
+    finishReason?: FinishReason;
     messageMetadata?: METADATA;
 } | {
     type: 'abort';
@@ -1891,6 +1893,10 @@ type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
      * (including the original message if it was extended).
      */
     responseMessage: UI_MESSAGE;
+    /**
+     * The reason why the generation finished.
+     */
+    finishReason?: FinishReason;
 }) => PromiseLike<void> | void;
 
 type UIMessageStreamResponseInit = ResponseInit & {
@@ -4071,6 +4077,7 @@ type ChatOnDataCallback<UI_MESSAGE extends UIMessage> = (dataPart: DataUIPart<In
  * @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.
+ * @param finishReason The reason why the generation finished.
  */
 type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
     message: UI_MESSAGE;
@@ -4078,6 +4085,7 @@ type ChatOnFinishCallback<UI_MESSAGE extends UIMessage> = (options: {
     isAbort: boolean;
     isDisconnect: boolean;
     isError: boolean;
+    finishReason?: FinishReason;
 }) => void;
 interface ChatInit<UI_MESSAGE extends UIMessage> {
     /**

package/dist/index.js

@@ -764,7 +764,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "5.0.91" : "0.0.0-test";
+var VERSION = true ? "5.0.92" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -3057,6 +3057,15 @@ var uiMessageChunkSchema = (0, import_provider_utils11.lazyValidator)(
       }),
       import_v47.z.strictObject({
         type: import_v47.z.literal("finish"),
+        finishReason: import_v47.z.enum([
+          "stop",
+          "length",
+          "content-filter",
+          "tool-calls",
+          "error",
+          "other",
+          "unknown"
+        ]).optional(),
         messageMetadata: import_v47.z.unknown().optional()
       }),
       import_v47.z.strictObject({
@@ -3877,6 +3886,9 @@ function processUIMessageStream({
               break;
             }
             case "finish": {
+              if (chunk.finishReason != null) {
+                state.finishReason = chunk.finishReason;
+              }
               await updateMessageMetadata(chunk.messageMetadata);
               if (chunk.messageMetadata != null) {
                 write();
@@ -3984,7 +3996,8 @@ function handleUIMessageStreamFinish({
       messages: [
         ...isContinuation ? originalMessages.slice(0, -1) : originalMessages,
         state.message
-      ]
+      ],
+      finishReason: state.finishReason
     });
   };
   return processUIMessageStream({
@@ -5716,6 +5729,7 @@ var DefaultStreamTextResult = class {
               if (sendFinish) {
                 controller.enqueue({
                   type: "finish",
+                  finishReason: part.finishReason,
                   ...messageMetadataValue != null ? { messageMetadata: messageMetadataValue } : {}
                 });
               }
@@ -9364,7 +9378,7 @@ var AbstractChat = class {
     body,
     messageId
   }) {
-    var _a16, _b, _c;
+    var _a16, _b, _c, _d;
     this.setStatus({ status: "submitted", error: void 0 });
     const lastMessage = this.lastMessage;
     let isAbort = false;
@@ -9461,22 +9475,23 @@ var AbstractChat = class {
       this.setStatus({ status: "error", error: err });
     } finally {
       try {
-        (_a16 = this.onFinish) == null ? void 0 : _a16.call(this, {
+        (_b = this.onFinish) == null ? void 0 : _b.call(this, {
           message: this.activeResponse.state.message,
           messages: this.state.messages,
           isAbort,
           isDisconnect,
-          isError
+          isError,
+          finishReason: (_a16 = this.activeResponse) == null ? void 0 : _a16.state.finishReason
         });
       } catch (err) {
         console.error(err);
       }
       this.activeResponse = void 0;
     }
-    if (((_b = this.sendAutomaticallyWhen) == null ? void 0 : _b.call(this, { messages: this.state.messages })) && !isError) {
+    if (((_c = this.sendAutomaticallyWhen) == null ? void 0 : _c.call(this, { messages: this.state.messages })) && !isError) {
       await this.makeRequest({
         trigger: "submit-message",
-        messageId: (_c = this.lastMessage) == null ? void 0 : _c.id,
+        messageId: (_d = this.lastMessage) == null ? void 0 : _d.id,
         metadata,
         headers,
         body