ai 5.0.0-canary.4 → 5.0.0-canary.6

package/dist/internal/index.d.mts

@@ -1,19 +1,7 @@
-import { Schema, Message } from '@ai-sdk/ui-utils';
 import { z } from 'zod';
-import { LanguageModelV2ProviderMetadata, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
-
-type ToolResultContent = Array<{
-    type: 'text';
-    text: string;
-} | {
-    type: 'image';
-    data: string;
-    mediaType?: string;
-    /**
-     * @deprecated Use `mediaType` instead.
-     */
-    mimeType?: string;
-}>;
+import { ToolCall, ToolResult, Validator } from '@ai-sdk/provider-utils';
+import { JSONSchema7 } from 'json-schema';
+import { LanguageModelV2ProviderMetadata, LanguageModelV2Source, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
 
 /**
 Tool choice for the generation. It supports the following settings:
@@ -65,6 +53,208 @@ declare function calculateLanguageModelUsage({ promptTokens, completionTokens, }
     completionTokens: number;
 }): LanguageModelUsage;
 
+/**
+Tool invocations are either tool calls or tool results. For each assistant tool call,
+there is one tool invocation. While the call is in progress, the invocation is a tool call.
+Once the call is complete, the invocation is a tool result.
+
+The step is used to track how to map an assistant UI message with many tool invocations
+back to a sequence of LLM assistant/tool result message pairs.
+It is optional for backwards compatibility.
+ */
+type ToolInvocation = ({
+    state: 'partial-call';
+    step?: number;
+} & ToolCall<string, any>) | ({
+    state: 'call';
+    step?: number;
+} & ToolCall<string, any>) | ({
+    state: 'result';
+    step?: number;
+} & ToolResult<string, any, any>);
+/**
+ * An attachment that can be sent along with a message.
+ */
+interface Attachment {
+    /**
+     * The name of the attachment, usually the file name.
+     */
+    name?: string;
+    /**
+     * A string indicating the [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type).
+     * By default, it's extracted from the pathname's extension.
+     */
+    contentType?: string;
+    /**
+     * The URL of the attachment. It can either be a URL to a hosted file or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
+     */
+    url: string;
+}
+/**
+ * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
+ */
+interface Message {
+    /**
+  A unique identifier for the message.
+     */
+    id: string;
+    /**
+  The timestamp of the message.
+     */
+    createdAt?: Date;
+    /**
+  Text content of the message. Use parts when possible.
+     */
+    content: string;
+    /**
+  Reasoning for the message.
+  
+  @deprecated Use `parts` instead.
+     */
+    reasoning?: string;
+    /**
+     * Additional attachments to be sent along with the message.
+     */
+    experimental_attachments?: Attachment[];
+    /**
+  The 'data' role is deprecated.
+     */
+    role: 'system' | 'user' | 'assistant' | 'data';
+    /**
+  For data messages.
+  
+  @deprecated Data messages will be removed.
+     */
+    data?: JSONValue;
+    /**
+     * Additional message-specific information added on the server via StreamData
+     */
+    annotations?: JSONValue[] | undefined;
+    /**
+  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
+  that the assistant made as part of this message.
+  
+  @deprecated Use `parts` instead.
+     */
+    toolInvocations?: Array<ToolInvocation>;
+    /**
+     * The parts of the message. Use this for rendering the message in the UI.
+     *
+     * Assistant messages can have text, reasoning and tool invocation parts.
+     * User messages can have text parts.
+     */
+    parts?: Array<TextUIPart | ReasoningUIPart | ToolInvocationUIPart | SourceUIPart | FileUIPart | StepStartUIPart>;
+}
+/**
+ * A text part of a message.
+ */
+type TextUIPart = {
+    type: 'text';
+    /**
+     * The text content.
+     */
+    text: string;
+};
+/**
+ * A reasoning part of a message.
+ */
+type ReasoningUIPart = {
+    type: 'reasoning';
+    /**
+     * The reasoning text.
+     */
+    reasoning: string;
+    details: Array<{
+        type: 'text';
+        text: string;
+        signature?: string;
+    } | {
+        type: 'redacted';
+        data: string;
+    }>;
+};
+/**
+ * A tool invocation part of a message.
+ */
+type ToolInvocationUIPart = {
+    type: 'tool-invocation';
+    /**
+     * The tool invocation.
+     */
+    toolInvocation: ToolInvocation;
+};
+/**
+ * A source part of a message.
+ */
+type SourceUIPart = {
+    type: 'source';
+    /**
+     * The source.
+     */
+    source: LanguageModelV2Source;
+};
+/**
+ * A file part of a message.
+ */
+type FileUIPart = {
+    type: 'file';
+    /**
+     * IANA media type of the file.
+     *
+     * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+     */
+    mediaType: string;
+    /**
+     * The base64 encoded data.
+     */
+    data: string;
+};
+/**
+ * A step boundary part of a message.
+ */
+type StepStartUIPart = {
+    type: 'step-start';
+};
+/**
+A JSON value can be a string, number, boolean, object, array, or null.
+JSON values can be serialized and deserialized by the JSON.stringify and JSON.parse methods.
+ */
+type JSONValue = null | string | number | boolean | {
+    [value: string]: JSONValue;
+} | Array<JSONValue>;
+
+/**
+ * Used to mark schemas so we can support both Zod and custom schemas.
+ */
+declare const schemaSymbol: unique symbol;
+type Schema<OBJECT = unknown> = Validator<OBJECT> & {
+    /**
+     * Used to mark schemas so we can support both Zod and custom schemas.
+     */
+    [schemaSymbol]: true;
+    /**
+     * Schema type for inference.
+     */
+    _type: OBJECT;
+    /**
+     * The JSON Schema for the schema. It is passed to the providers.
+     */
+    readonly jsonSchema: JSONSchema7;
+};
+
+type ToolResultContent = Array<{
+    type: 'text';
+    text: string;
+} | {
+    type: 'image';
+    data: string;
+    mediaType?: string;
+    /**
+     * @deprecated Use `mediaType` instead.
+     */
+    mimeType?: string;
+}>;
+
 /**
 Data content. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.
  */

package/dist/internal/index.d.ts

@@ -1,19 +1,7 @@
-import { Schema, Message } from '@ai-sdk/ui-utils';
 import { z } from 'zod';
-import { LanguageModelV2ProviderMetadata, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
-
-type ToolResultContent = Array<{
-    type: 'text';
-    text: string;
-} | {
-    type: 'image';
-    data: string;
-    mediaType?: string;
-    /**
-     * @deprecated Use `mediaType` instead.
-     */
-    mimeType?: string;
-}>;
+import { ToolCall, ToolResult, Validator } from '@ai-sdk/provider-utils';
+import { JSONSchema7 } from 'json-schema';
+import { LanguageModelV2ProviderMetadata, LanguageModelV2Source, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
 
 /**
 Tool choice for the generation. It supports the following settings:
@@ -65,6 +53,208 @@ declare function calculateLanguageModelUsage({ promptTokens, completionTokens, }
     completionTokens: number;
 }): LanguageModelUsage;
 
+/**
+Tool invocations are either tool calls or tool results. For each assistant tool call,
+there is one tool invocation. While the call is in progress, the invocation is a tool call.
+Once the call is complete, the invocation is a tool result.
+
+The step is used to track how to map an assistant UI message with many tool invocations
+back to a sequence of LLM assistant/tool result message pairs.
+It is optional for backwards compatibility.
+ */
+type ToolInvocation = ({
+    state: 'partial-call';
+    step?: number;
+} & ToolCall<string, any>) | ({
+    state: 'call';
+    step?: number;
+} & ToolCall<string, any>) | ({
+    state: 'result';
+    step?: number;
+} & ToolResult<string, any, any>);
+/**
+ * An attachment that can be sent along with a message.
+ */
+interface Attachment {
+    /**
+     * The name of the attachment, usually the file name.
+     */
+    name?: string;
+    /**
+     * A string indicating the [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type).
+     * By default, it's extracted from the pathname's extension.
+     */
+    contentType?: string;
+    /**
+     * The URL of the attachment. It can either be a URL to a hosted file or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
+     */
+    url: string;
+}
+/**
+ * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
+ */
+interface Message {
+    /**
+  A unique identifier for the message.
+     */
+    id: string;
+    /**
+  The timestamp of the message.
+     */
+    createdAt?: Date;
+    /**
+  Text content of the message. Use parts when possible.
+     */
+    content: string;
+    /**
+  Reasoning for the message.
+  
+  @deprecated Use `parts` instead.
+     */
+    reasoning?: string;
+    /**
+     * Additional attachments to be sent along with the message.
+     */
+    experimental_attachments?: Attachment[];
+    /**
+  The 'data' role is deprecated.
+     */
+    role: 'system' | 'user' | 'assistant' | 'data';
+    /**
+  For data messages.
+  
+  @deprecated Data messages will be removed.
+     */
+    data?: JSONValue;
+    /**
+     * Additional message-specific information added on the server via StreamData
+     */
+    annotations?: JSONValue[] | undefined;
+    /**
+  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
+  that the assistant made as part of this message.
+  
+  @deprecated Use `parts` instead.
+     */
+    toolInvocations?: Array<ToolInvocation>;
+    /**
+     * The parts of the message. Use this for rendering the message in the UI.
+     *
+     * Assistant messages can have text, reasoning and tool invocation parts.
+     * User messages can have text parts.
+     */
+    parts?: Array<TextUIPart | ReasoningUIPart | ToolInvocationUIPart | SourceUIPart | FileUIPart | StepStartUIPart>;
+}
+/**
+ * A text part of a message.
+ */
+type TextUIPart = {
+    type: 'text';
+    /**
+     * The text content.
+     */
+    text: string;
+};
+/**
+ * A reasoning part of a message.
+ */
+type ReasoningUIPart = {
+    type: 'reasoning';
+    /**
+     * The reasoning text.
+     */
+    reasoning: string;
+    details: Array<{
+        type: 'text';
+        text: string;
+        signature?: string;
+    } | {
+        type: 'redacted';
+        data: string;
+    }>;
+};
+/**
+ * A tool invocation part of a message.
+ */
+type ToolInvocationUIPart = {
+    type: 'tool-invocation';
+    /**
+     * The tool invocation.
+     */
+    toolInvocation: ToolInvocation;
+};
+/**
+ * A source part of a message.
+ */
+type SourceUIPart = {
+    type: 'source';
+    /**
+     * The source.
+     */
+    source: LanguageModelV2Source;
+};
+/**
+ * A file part of a message.
+ */
+type FileUIPart = {
+    type: 'file';
+    /**
+     * IANA media type of the file.
+     *
+     * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+     */
+    mediaType: string;
+    /**
+     * The base64 encoded data.
+     */
+    data: string;
+};
+/**
+ * A step boundary part of a message.
+ */
+type StepStartUIPart = {
+    type: 'step-start';
+};
+/**
+A JSON value can be a string, number, boolean, object, array, or null.
+JSON values can be serialized and deserialized by the JSON.stringify and JSON.parse methods.
+ */
+type JSONValue = null | string | number | boolean | {
+    [value: string]: JSONValue;
+} | Array<JSONValue>;
+
+/**
+ * Used to mark schemas so we can support both Zod and custom schemas.
+ */
+declare const schemaSymbol: unique symbol;
+type Schema<OBJECT = unknown> = Validator<OBJECT> & {
+    /**
+     * Used to mark schemas so we can support both Zod and custom schemas.
+     */
+    [schemaSymbol]: true;
+    /**
+     * Schema type for inference.
+     */
+    _type: OBJECT;
+    /**
+     * The JSON Schema for the schema. It is passed to the providers.
+     */
+    readonly jsonSchema: JSONSchema7;
+};
+
+type ToolResultContent = Array<{
+    type: 'text';
+    text: string;
+} | {
+    type: 'image';
+    data: string;
+    mediaType?: string;
+    /**
+     * @deprecated Use `mediaType` instead.
+     */
+    mimeType?: string;
+}>;
+
 /**
 Data content. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.
  */

package/dist/internal/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name7 in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // internal/index.ts
@@ -708,8 +718,52 @@ function standardizePrompt({
   throw new Error("unreachable");
 }
 
-// core/prompt/prepare-tools-and-tool-choice.ts
-var import_ui_utils = require("@ai-sdk/ui-utils");
+// core/util/index.ts
+var import_provider_utils4 = require("@ai-sdk/provider-utils");
+
+// core/util/schema.ts
+var import_provider_utils3 = require("@ai-sdk/provider-utils");
+
+// core/util/zod-schema.ts
+var import_zod_to_json_schema = __toESM(require("zod-to-json-schema"));
+function zodSchema(zodSchema2, options) {
+  var _a7;
+  const useReferences = (_a7 = options == null ? void 0 : options.useReferences) != null ? _a7 : false;
+  return jsonSchema(
+    (0, import_zod_to_json_schema.default)(zodSchema2, {
+      $refStrategy: useReferences ? "root" : "none",
+      target: "jsonSchema7"
+      // note: openai mode breaks various gemini conversions
+    }),
+    {
+      validate: (value) => {
+        const result = zodSchema2.safeParse(value);
+        return result.success ? { success: true, value: result.data } : { success: false, error: result.error };
+      }
+    }
+  );
+}
+
+// core/util/schema.ts
+var schemaSymbol = Symbol.for("vercel.ai.schema");
+function jsonSchema(jsonSchema2, {
+  validate
+} = {}) {
+  return {
+    [schemaSymbol]: true,
+    _type: void 0,
+    // should never be used directly
+    [import_provider_utils3.validatorSymbol]: true,
+    jsonSchema: jsonSchema2,
+    validate
+  };
+}
+function isSchema(value) {
+  return typeof value === "object" && value !== null && schemaSymbol in value && value[schemaSymbol] === true && "jsonSchema" in value && "validate" in value;
+}
+function asSchema(schema) {
+  return isSchema(schema) ? schema : zodSchema(schema);
+}
 
 // core/util/is-non-empty-object.ts
 function isNonEmptyObject(object) {
@@ -741,7 +795,7 @@ function prepareToolsAndToolChoice({
             type: "function",
             name: name7,
             description: tool.description,
-            parameters: (0, import_ui_utils.asSchema)(tool.parameters).jsonSchema
+            parameters: asSchema(tool.parameters).jsonSchema
           };
         case "provider-defined":
           return {
@@ -788,7 +842,7 @@ _a3 = symbol3;
 
 // util/retry-with-exponential-backoff.ts
 var import_provider6 = require("@ai-sdk/provider");
-var import_provider_utils3 = require("@ai-sdk/provider-utils");
+var import_provider_utils5 = require("@ai-sdk/provider-utils");
 
 // util/retry-error.ts
 var import_provider5 = require("@ai-sdk/provider");
@@ -832,13 +886,13 @@ async function _retryWithExponentialBackoff(f, {
   try {
     return await f();
   } catch (error) {
-    if ((0, import_provider_utils3.isAbortError)(error)) {
+    if ((0, import_provider_utils5.isAbortError)(error)) {
       throw error;
     }
     if (maxRetries === 0) {
       throw error;
     }
-    const errorMessage = (0, import_provider_utils3.getErrorMessage)(error);
+    const errorMessage = (0, import_provider_utils5.getErrorMessage)(error);
     const newErrors = [...errors, error];
     const tryNumber = newErrors.length;
     if (tryNumber > maxRetries) {
@@ -849,7 +903,7 @@ async function _retryWithExponentialBackoff(f, {
       });
     }
     if (error instanceof Error && import_provider6.APICallError.isInstance(error) && error.isRetryable === true && tryNumber <= maxRetries) {
-      await (0, import_provider_utils3.delay)(delayInMs);
+      await (0, import_provider_utils5.delay)(delayInMs);
       return _retryWithExponentialBackoff(
         f,
         { maxRetries, delayInMs: backoffFactor * delayInMs, backoffFactor },
@@ -989,7 +1043,7 @@ function prepareCallSettings({
 }
 
 // core/prompt/convert-to-language-model-prompt.ts
-var import_provider_utils4 = require("@ai-sdk/provider-utils");
+var import_provider_utils6 = require("@ai-sdk/provider-utils");
 
 // util/download-error.ts
 var import_provider7 = require("@ai-sdk/provider");
@@ -1383,7 +1437,7 @@ function convertPartToLanguageModelPart(part, downloadedAssets) {
         mediaType: mediaType != null ? mediaType : "image/*",
         // any image
         filename: void 0,
-        data: normalizedData instanceof Uint8Array ? (0, import_provider_utils4.convertUint8ArrayToBase64)(normalizedData) : normalizedData,
+        data: normalizedData instanceof Uint8Array ? (0, import_provider_utils6.convertUint8ArrayToBase64)(normalizedData) : normalizedData,
         providerOptions: (_d = part.providerOptions) != null ? _d : part.experimental_providerMetadata
       };
     }