ai 7.0.31 → 7.0.32

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # ai
 
+## 7.0.32
+
+### Patch Changes
+
+- 6cd7c74: fix: correct the `onToolCall` callback result documentation
+- e35bcae: Allow UI message chunks to include fields added by newer server versions.
+- a4eb3f3: Propagate abort reasons when generation is cancelled during tool execution.
+- Updated dependencies [cefa3b1]
+- Updated dependencies [8fbb89c]
+  - @ai-sdk/gateway@4.0.24
+
 ## 7.0.31
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-import * as _ai_sdk_provider from '@ai-sdk/provider';
 import { EmbeddingModelV4, EmbeddingModelV3, EmbeddingModelV2, EmbeddingModelV4Embedding, EmbeddingModelV4Middleware, ImageModelV4, ImageModelV3, ImageModelV2, ImageModelV4ProviderMetadata, ImageModelV2ProviderMetadata, ImageModelV4Middleware, JSONValue as JSONValue$1, LanguageModelV4, LanguageModelV3, LanguageModelV2, SharedV4Warning, LanguageModelV4Source, LanguageModelV4Middleware, RerankingModelV4, RerankingModelV3, SharedV4ProviderMetadata, SharedV4ProviderReference, SpeechModelV4, SpeechModelV3, SpeechModelV2, TranscriptionModelV4, TranscriptionModelV3, TranscriptionModelV2, JSONObject, ImageModelV4Usage, LanguageModelV4CallOptions, LanguageModelV4Prompt, AISDKError, LanguageModelV4ToolCall, JSONSchema7, ProviderV4, ProviderV3, ProviderV2, SharedV4Headers, JSONParseError, TypeValidationError, Experimental_VideoModelV4, Experimental_VideoModelV3, Experimental_VideoModelV4FrameType, EmbeddingModelV4CallOptions, Experimental_RealtimeFactoryV4, Experimental_RealtimeFactoryV4GetTokenOptions, Experimental_RealtimeFactoryV4GetTokenResult, Experimental_RealtimeModelV4, Experimental_RealtimeModelV4ClientEvent, Experimental_RealtimeModelV4ServerEvent, Experimental_RealtimeModelV4SessionConfig, Experimental_RealtimeModelV4ToolDefinition, FilesV4, SkillsV4, NoSuchModelError, FilesV4UploadFileCallOptions, SkillsV4UploadSkillResult, SkillsV4UploadSkillCallOptions, SkillsV4File } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, JSONSchema7, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, NoSuchProviderReferenceError, TooManyEmbeddingValuesForCallError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { GatewayModelId } from '@ai-sdk/gateway';
@@ -2243,153 +2242,7 @@ type InferUIMessageToolCall<UI_MESSAGE extends UIMessage> = ValueOf<{
     dynamic: true;
 });
 
-declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
-    type: "text-start";
-    id: string;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "text-delta";
-    id: string;
-    delta: string;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "text-end";
-    id: string;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "error";
-    errorText: string;
-} | {
-    type: "tool-input-start";
-    toolCallId: string;
-    toolName: string;
-    providerExecuted?: boolean | undefined;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-    toolMetadata?: JSONObject | undefined;
-    dynamic?: boolean | undefined;
-    title?: string | undefined;
-} | {
-    type: "tool-input-delta";
-    toolCallId: string;
-    inputTextDelta: string;
-} | {
-    type: "tool-input-available";
-    toolCallId: string;
-    toolName: string;
-    input: unknown;
-    providerExecuted?: boolean | undefined;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-    toolMetadata?: JSONObject | undefined;
-    dynamic?: boolean | undefined;
-    title?: string | undefined;
-} | {
-    type: "tool-input-error";
-    toolCallId: string;
-    toolName: string;
-    input: unknown;
-    errorText: string;
-    providerExecuted?: boolean | undefined;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-    toolMetadata?: JSONObject | undefined;
-    dynamic?: boolean | undefined;
-    title?: string | undefined;
-} | {
-    type: "tool-approval-request";
-    approvalId: string;
-    toolCallId: string;
-    isAutomatic?: boolean | undefined;
-    signature?: string | undefined;
-} | {
-    type: "tool-approval-response";
-    approvalId: string;
-    approved: boolean;
-    reason?: string | undefined;
-    providerExecuted?: boolean | undefined;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "tool-output-available";
-    toolCallId: string;
-    output: unknown;
-    providerExecuted?: boolean | undefined;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-    toolMetadata?: JSONObject | undefined;
-    dynamic?: boolean | undefined;
-    preliminary?: boolean | undefined;
-} | {
-    type: "tool-output-error";
-    toolCallId: string;
-    errorText: string;
-    providerExecuted?: boolean | undefined;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-    toolMetadata?: JSONObject | undefined;
-    dynamic?: boolean | undefined;
-} | {
-    type: "tool-output-denied";
-    toolCallId: string;
-} | {
-    type: "reasoning-start";
-    id: string;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "reasoning-delta";
-    id: string;
-    delta: string;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "reasoning-end";
-    id: string;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "custom";
-    kind: `${string}.${string}`;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "source-url";
-    sourceId: string;
-    url: string;
-    title?: string | undefined;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "source-document";
-    sourceId: string;
-    mediaType: string;
-    title: string;
-    filename?: string | undefined;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "file";
-    url: string;
-    mediaType: string;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: "reasoning-file";
-    url: string;
-    mediaType: string;
-    providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
-} | {
-    type: `data-${string}`;
-    data: unknown;
-    id?: string | undefined;
-    transient?: boolean | undefined;
-} | {
-    type: "start-step";
-} | {
-    type: "finish-step";
-} | {
-    type: "start";
-    messageId?: string | undefined;
-    messageMetadata?: unknown;
-} | {
-    type: "finish";
-    finishReason?: "length" | "error" | "stop" | "content-filter" | "tool-calls" | "other" | undefined;
-    messageMetadata?: unknown;
-} | {
-    type: "abort";
-    reason?: string | undefined;
-} | {
-    type: "message-metadata";
-    messageMetadata: unknown;
-}>;
+declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<UIMessageChunk<unknown, UIDataTypes>>;
 type DataUIMessageChunk<DATA_TYPES extends UIDataTypes> = ValueOf<{
     [NAME in keyof DATA_TYPES & string]: {
         type: `data-${NAME}`;
@@ -5552,8 +5405,8 @@ interface ChatInit<UI_MESSAGE extends UIMessage> {
      * Optional callback function that is invoked when a tool call is received.
      * Intended for automatic client-side tool execution.
      *
-     * You can optionally return a result for the tool call,
-     * either synchronously or asynchronously.
+     * To add the tool output, call `addToolOutput` without awaiting it inside
+     * this callback. The callback's return value is not used.
      */
     onToolCall?: ChatOnToolCallCallback<UI_MESSAGE>;
     /**

package/dist/index.js

@@ -1089,7 +1089,7 @@ import {
 } from "@ai-sdk/provider-utils";
 
 // src/version.ts
-var VERSION = true ? "7.0.31" : "0.0.0-test";
+var VERSION = true ? "7.0.32" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({
@@ -5223,6 +5223,9 @@ async function generateText({
       ];
       const pendingDeferredToolCalls = /* @__PURE__ */ new Map();
       do {
+        if (steps.length > 0) {
+          mergedAbortSignal == null ? void 0 : mergedAbortSignal.throwIfAborted();
+        }
         const stepTimeoutId = setAbortTimeout({
           abortController: stepAbortController,
           label: "Step",
@@ -6254,27 +6257,27 @@ var toolMetadataSchema = z6.record(
 var uiMessageChunkSchema = lazySchema(
   () => zodSchema(
     z6.union([
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("text-start"),
         id: z6.string(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("text-delta"),
         id: z6.string(),
         delta: z6.string(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("text-end"),
         id: z6.string(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("error"),
         errorText: z6.string()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("tool-input-start"),
         toolCallId: z6.string(),
         toolName: z6.string(),
@@ -6284,12 +6287,12 @@ var uiMessageChunkSchema = lazySchema(
         dynamic: z6.boolean().optional(),
         title: z6.string().optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("tool-input-delta"),
         toolCallId: z6.string(),
         inputTextDelta: z6.string()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("tool-input-available"),
         toolCallId: z6.string(),
         toolName: z6.string(),
@@ -6300,7 +6303,7 @@ var uiMessageChunkSchema = lazySchema(
         dynamic: z6.boolean().optional(),
         title: z6.string().optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("tool-input-error"),
         toolCallId: z6.string(),
         toolName: z6.string(),
@@ -6312,14 +6315,14 @@ var uiMessageChunkSchema = lazySchema(
         errorText: z6.string(),
         title: z6.string().optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("tool-approval-request"),
         approvalId: z6.string(),
         toolCallId: z6.string(),
         isAutomatic: z6.boolean().optional(),
         signature: z6.string().optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("tool-approval-response"),
         approvalId: z6.string(),
         approved: z6.boolean(),
@@ -6327,7 +6330,7 @@ var uiMessageChunkSchema = lazySchema(
         providerExecuted: z6.boolean().optional(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("tool-output-available"),
         toolCallId: z6.string(),
         output: z6.unknown(),
@@ -6337,7 +6340,7 @@ var uiMessageChunkSchema = lazySchema(
         dynamic: z6.boolean().optional(),
         preliminary: z6.boolean().optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("tool-output-error"),
         toolCallId: z6.string(),
         errorText: z6.string(),
@@ -6346,39 +6349,39 @@ var uiMessageChunkSchema = lazySchema(
         toolMetadata: toolMetadataSchema.optional(),
         dynamic: z6.boolean().optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("tool-output-denied"),
         toolCallId: z6.string()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("reasoning-start"),
         id: z6.string(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("reasoning-delta"),
         id: z6.string(),
         delta: z6.string(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("reasoning-end"),
         id: z6.string(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("custom"),
         kind: z6.string().transform((value) => value),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("source-url"),
         sourceId: z6.string(),
         url: z6.string(),
         title: z6.string().optional(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("source-document"),
         sourceId: z6.string(),
         mediaType: z6.string(),
@@ -6386,19 +6389,19 @@ var uiMessageChunkSchema = lazySchema(
         filename: z6.string().optional(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("file"),
         url: z6.string(),
         mediaType: z6.string(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("reasoning-file"),
         url: z6.string(),
         mediaType: z6.string(),
         providerMetadata: providerMetadataSchema.optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.custom(
           (value) => typeof value === "string" && value.startsWith("data-"),
           { message: 'Type must start with "data-"' }
@@ -6407,18 +6410,18 @@ var uiMessageChunkSchema = lazySchema(
         data: z6.unknown(),
         transient: z6.boolean().optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("start-step")
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("finish-step")
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("start"),
         messageId: z6.string().optional(),
         messageMetadata: z6.unknown().optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("finish"),
         finishReason: z6.enum([
           "stop",
@@ -6430,11 +6433,11 @@ var uiMessageChunkSchema = lazySchema(
         ]).optional(),
         messageMetadata: z6.unknown().optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("abort"),
         reason: z6.string().optional()
       }),
-      z6.strictObject({
+      z6.looseObject({
         type: z6.literal("message-metadata"),
         messageMetadata: z6.unknown()
       })