ai 6.0.0-beta.94 → 6.0.0-beta.96

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # ai
 
+## 6.0.0-beta.96
+
+### Patch Changes
+
+- a322efa: Added finishReason on useChat onFinish callbck
+
+## 6.0.0-beta.95
+
+### Patch Changes
+
+- eb8d1cb: fix not catching of empty arrays in validateUIMessage
+
 ## 6.0.0-beta.94
 
 ### Patch Changes

package/README.md

@@ -207,7 +207,7 @@ We've built [templates](https://ai-sdk.dev/docs/introduction#templates) that inc
 
 ## Community
 
-The AI SDK community can be found on [GitHub Discussions](https://github.com/vercel/ai/discussions) where you can ask questions, voice ideas, and share your projects with other people.
+The AI SDK community can be found on [the Vercel Community](https://community.vercel.com/c/ai-sdk/62) where you can ask questions, voice ideas, and share your projects with other people.
 
 ## Contributing
 

package/dist/index.d.mts

@@ -2004,6 +2004,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     messageMetadata?: unknown;
 } | {
     type: "finish";
+    finishReason?: "unknown" | "length" | "error" | "stop" | "content-filter" | "tool-calls" | "other" | undefined;
     messageMetadata?: unknown;
 } | {
     type: "abort";
@@ -2126,6 +2127,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     messageMetadata?: METADATA;
 } | {
     type: 'finish';
+    finishReason?: FinishReason;
     messageMetadata?: METADATA;
 } | {
     type: 'abort';
@@ -2154,6 +2156,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 & {
@@ -2895,6 +2901,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;
@@ -2902,6 +2909,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

@@ -2004,6 +2004,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     messageMetadata?: unknown;
 } | {
     type: "finish";
+    finishReason?: "unknown" | "length" | "error" | "stop" | "content-filter" | "tool-calls" | "other" | undefined;
     messageMetadata?: unknown;
 } | {
     type: "abort";
@@ -2126,6 +2127,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     messageMetadata?: METADATA;
 } | {
     type: 'finish';
+    finishReason?: FinishReason;
     messageMetadata?: METADATA;
 } | {
     type: 'abort';
@@ -2154,6 +2156,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 & {
@@ -2895,6 +2901,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;
@@ -2902,6 +2909,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

@@ -858,7 +858,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.0-beta.94" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.96" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -4135,6 +4135,15 @@ var uiMessageChunkSchema = (0, import_provider_utils14.lazySchema)(
       }),
       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({
@@ -4633,6 +4642,9 @@ function processUIMessageStream({
               break;
             }
             case "finish": {
+              if (chunk.finishReason != null) {
+                state.finishReason = chunk.finishReason;
+              }
               await updateMessageMetadata(chunk.messageMetadata);
               if (chunk.messageMetadata != null) {
                 write();
@@ -4740,7 +4752,8 @@ function handleUIMessageStreamFinish({
       messages: [
         ...isContinuation ? originalMessages.slice(0, -1) : originalMessages,
         state.message
-      ]
+      ],
+      finishReason: state.finishReason
     });
   };
   return processUIMessageStream({
@@ -6542,6 +6555,7 @@ var DefaultStreamTextResult = class {
               if (sendFinish) {
                 controller.enqueue({
                   type: "finish",
+                  finishReason: part.finishReason,
                   ...messageMetadataValue != null ? { messageMetadata: messageMetadataValue } : {}
                 });
               }
@@ -7308,9 +7322,9 @@ var uiMessagesSchema = (0, import_provider_utils20.lazySchema)(
               })
             })
           ])
-        )
+        ).nonempty("Message must contain at least one part")
       })
-    )
+    ).nonempty("Messages array must not be empty")
   )
 );
 async function safeValidateUIMessages({
@@ -11010,7 +11024,7 @@ var AbstractChat = class {
     body,
     messageId
   }) {
-    var _a15, _b, _c;
+    var _a15, _b, _c, _d;
     this.setStatus({ status: "submitted", error: void 0 });
     const lastMessage = this.lastMessage;
     let isAbort = false;
@@ -11107,22 +11121,23 @@ var AbstractChat = class {
       this.setStatus({ status: "error", error: err });
     } finally {
       try {
-        (_a15 = this.onFinish) == null ? void 0 : _a15.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: (_a15 = this.activeResponse) == null ? void 0 : _a15.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