@ai-sdk/provider 3.0.5 → 3.0.6

package/src/embedding-model/v3/embedding-model-v3.ts

@@ -2,35 +2,35 @@ import { EmbeddingModelV3CallOptions } from './embedding-model-v3-call-options';
 import { EmbeddingModelV3Result } from './embedding-model-v3-result';
 
 /**
-Specification for an embedding model that implements the embedding model
-interface version 3.
-
-It is specific to text embeddings.
+ * Specification for an embedding model that implements the embedding model
+ * interface version 3.
+ *
+ * It is specific to text embeddings.
  */
 export type EmbeddingModelV3 = {
   /**
-The embedding model must specify which embedding model interface
-version it implements. This will allow us to evolve the embedding
-model interface and retain backwards compatibility. The different
-implementation versions can be handled as a discriminated union
-on our side.
+   * The embedding model must specify which embedding model interface
+   * version it implements. This will allow us to evolve the embedding
+   * model interface and retain backwards compatibility. The different
+   * implementation versions can be handled as a discriminated union
+   * on our side.
    */
   readonly specificationVersion: 'v3';
 
   /**
-Name of the provider for logging purposes.
+   * Name of the provider for logging purposes.
    */
   readonly provider: string;
 
   /**
-Provider-specific model ID for logging purposes.
+   * Provider-specific model ID for logging purposes.
    */
   readonly modelId: string;
 
   /**
-Limit of how many embeddings can be generated in a single API call.
-
-Use Infinity for models that do not have a limit.
+   * Limit of how many embeddings can be generated in a single API call.
+   *
+   * Use Infinity for models that do not have a limit.
    */
   readonly maxEmbeddingsPerCall:
     | PromiseLike<number | undefined>
@@ -38,15 +38,15 @@ Use Infinity for models that do not have a limit.
     | undefined;
 
   /**
-True if the model can handle multiple embedding calls in parallel.
+   * True if the model can handle multiple embedding calls in parallel.
    */
   readonly supportsParallelCalls: PromiseLike<boolean> | boolean;
 
   /**
-Generates a list of embeddings for the given input text.
-
-Naming: "do" prefix to prevent accidental direct usage of the method
-by the user.
+   * Generates a list of embeddings for the given input text.
+   *
+   * Naming: "do" prefix to prevent accidental direct usage of the method
+   * by the user.
    */
   doEmbed(
     options: EmbeddingModelV3CallOptions,

package/src/errors/index.ts

@@ -11,5 +11,6 @@ export { LoadSettingError } from './load-setting-error';
 export { NoContentGeneratedError } from './no-content-generated-error';
 export { NoSuchModelError } from './no-such-model-error';
 export { TooManyEmbeddingValuesForCallError } from './too-many-embedding-values-for-call-error';
+export type { TypeValidationContext } from './type-validation-error';
 export { TypeValidationError } from './type-validation-error';
 export { UnsupportedFunctionalityError } from './unsupported-functionality-error';

package/src/errors/no-content-generated-error.ts

@@ -5,7 +5,7 @@ const marker = `vercel.ai.error.${name}`;
 const symbol = Symbol.for(marker);
 
 /**
-Thrown when the AI provider fails to generate any content.
+ * Thrown when the AI provider fails to generate any content.
  */
 export class NoContentGeneratedError extends AISDKError {
   private readonly [symbol] = true; // used in isInstance

package/src/errors/type-validation-error.ts

@@ -5,22 +5,68 @@ const name = 'AI_TypeValidationError';
 const marker = `vercel.ai.error.${name}`;
 const symbol = Symbol.for(marker);
 
+export interface TypeValidationContext {
+  /**
+   * Field path in dot notation (e.g., "message.metadata", "message.parts[3].data")
+   */
+  field?: string;
+
+  /**
+   * Entity name (e.g., tool name, data type name)
+   */
+  entityName?: string;
+
+  /**
+   * Entity identifier (e.g., message ID, tool call ID)
+   */
+  entityId?: string;
+}
+
 export class TypeValidationError extends AISDKError {
   private readonly [symbol] = true; // used in isInstance
 
   readonly value: unknown;
+  readonly context?: TypeValidationContext;
+
+  constructor({
+    value,
+    cause,
+    context,
+  }: {
+    value: unknown;
+    cause: unknown;
+    context?: TypeValidationContext;
+  }) {
+    let contextPrefix = 'Type validation failed';
+
+    if (context?.field) {
+      contextPrefix += ` for ${context.field}`;
+    }
+
+    if (context?.entityName || context?.entityId) {
+      contextPrefix += ' (';
+      const parts: string[] = [];
+      if (context.entityName) {
+        parts.push(context.entityName);
+      }
+      if (context.entityId) {
+        parts.push(`id: "${context.entityId}"`);
+      }
+      contextPrefix += parts.join(', ');
+      contextPrefix += ')';
+    }
 
-  constructor({ value, cause }: { value: unknown; cause: unknown }) {
     super({
       name,
       message:
-        `Type validation failed: ` +
+        `${contextPrefix}: ` +
         `Value: ${JSON.stringify(value)}.\n` +
         `Error message: ${getErrorMessage(cause)}`,
       cause,
     });
 
     this.value = value;
+    this.context = context;
   }
 
   static isInstance(error: unknown): error is TypeValidationError {
@@ -29,23 +75,34 @@ export class TypeValidationError extends AISDKError {
 
   /**
    * Wraps an error into a TypeValidationError.
-   * If the cause is already a TypeValidationError with the same value, it returns the cause.
+   * If the cause is already a TypeValidationError with the same value and context, it returns the cause.
    * Otherwise, it creates a new TypeValidationError.
    *
    * @param {Object} params - The parameters for wrapping the error.
    * @param {unknown} params.value - The value that failed validation.
    * @param {unknown} params.cause - The original error or cause of the validation failure.
+   * @param {TypeValidationContext} params.context - Optional context about what is being validated.
    * @returns {TypeValidationError} A TypeValidationError instance.
    */
   static wrap({
     value,
     cause,
+    context,
   }: {
     value: unknown;
     cause: unknown;
+    context?: TypeValidationContext;
   }): TypeValidationError {
-    return TypeValidationError.isInstance(cause) && cause.value === value
-      ? cause
-      : new TypeValidationError({ value, cause });
+    if (
+      TypeValidationError.isInstance(cause) &&
+      cause.value === value &&
+      cause.context?.field === context?.field &&
+      cause.context?.entityName === context?.entityName &&
+      cause.context?.entityId === context?.entityId
+    ) {
+      return cause;
+    }
+
+    return new TypeValidationError({ value, cause, context });
   }
 }

package/src/image-model/v2/image-model-v2-call-options.ts

@@ -2,59 +2,59 @@ import { SharedV2ProviderOptions } from '../../shared';
 
 export type ImageModelV2CallOptions = {
   /**
-Prompt for the image generation.
-     */
+   * Prompt for the image generation.
+   */
   prompt: string;
 
   /**
-Number of images to generate.
- */
+   * Number of images to generate.
+   */
   n: number;
 
   /**
-Size of the images to generate.
-Must have the format `{width}x{height}`.
-`undefined` will use the provider's default size.
- */
+   * Size of the images to generate.
+   * Must have the format `{width}x{height}`.
+   * `undefined` will use the provider's default size.
+   */
   size: `${number}x${number}` | undefined;
 
   /**
-Aspect ratio of the images to generate.
-Must have the format `{width}:{height}`.
-`undefined` will use the provider's default aspect ratio.
- */
+   * Aspect ratio of the images to generate.
+   * Must have the format `{width}:{height}`.
+   * `undefined` will use the provider's default aspect ratio.
+   */
   aspectRatio: `${number}:${number}` | undefined;
 
   /**
-Seed for the image generation.
-`undefined` will use the provider's default seed.
- */
+   * Seed for the image generation.
+   * `undefined` will use the provider's default seed.
+   */
   seed: number | undefined;
 
   /**
-Additional provider-specific options that are passed through to the provider
-as body parameters.
-
-The outer record is keyed by the provider name, and the inner
-record is keyed by the provider-specific metadata key.
-```ts
-{
-  "openai": {
-    "style": "vivid"
-  }
-}
-```
- */
+   * Additional provider-specific options that are passed through to the provider
+   * as body parameters.
+   *
+   * The outer record is keyed by the provider name, and the inner
+   * record is keyed by the provider-specific metadata key.
+   * ```ts
+   * {
+   * "openai": {
+   * "style": "vivid"
+   * }
+   * }
+   * ```
+   */
   providerOptions: SharedV2ProviderOptions;
 
   /**
-Abort signal for cancelling the operation.
- */
+   * Abort signal for cancelling the operation.
+   */
   abortSignal?: AbortSignal;
 
   /**
-Additional HTTP headers to be sent with the request.
-Only applicable for HTTP-based providers.
- */
+   * Additional HTTP headers to be sent with the request.
+   * Only applicable for HTTP-based providers.
+   */
   headers?: Record<string, string | undefined>;
 };

package/src/image-model/v2/image-model-v2-call-warning.ts

@@ -1,8 +1,8 @@
 import { ImageModelV2CallOptions } from './image-model-v2-call-options';
 
 /**
-Warning from the model provider for this call. The call will proceed, but e.g.
-some settings might not be supported, which can lead to suboptimal results.
+ * Warning from the model provider for this call. The call will proceed, but e.g.
+ * some settings might not be supported, which can lead to suboptimal results.
  */
 export type ImageModelV2CallWarning =
   | {

package/src/image-model/v2/image-model-v2.ts

@@ -14,90 +14,90 @@ type GetMaxImagesPerCallFunction = (options: {
 }) => PromiseLike<number | undefined> | number | undefined;
 
 /**
-Image generation model specification version 2.
+ * Image generation model specification version 2.
  */
 export type ImageModelV2 = {
   /**
-The image model must specify which image model interface
-version it implements. This will allow us to evolve the image
-model interface and retain backwards compatibility. The different
-implementation versions can be handled as a discriminated union
-on our side.
+   * The image model must specify which image model interface
+   * version it implements. This will allow us to evolve the image
+   * model interface and retain backwards compatibility. The different
+   * implementation versions can be handled as a discriminated union
+   * on our side.
    */
   readonly specificationVersion: 'v2';
 
   /**
-Name of the provider for logging purposes.
+   * Name of the provider for logging purposes.
    */
   readonly provider: string;
 
   /**
-Provider-specific model ID for logging purposes.
+   * Provider-specific model ID for logging purposes.
    */
   readonly modelId: string;
 
   /**
-Limit of how many images can be generated in a single API call.
-Can be set to a number for a fixed limit, to undefined to use
-the global limit, or a function that returns a number or undefined, 
-optionally as a promise. 
+   * Limit of how many images can be generated in a single API call.
+   * Can be set to a number for a fixed limit, to undefined to use
+   * the global limit, or a function that returns a number or undefined,
+   * optionally as a promise.
    */
   readonly maxImagesPerCall: number | undefined | GetMaxImagesPerCallFunction;
 
   /**
-Generates an array of images.
+   * Generates an array of images.
    */
   doGenerate(options: ImageModelV2CallOptions): PromiseLike<{
     /**
-Generated images as base64 encoded strings or binary data.
-The images should be returned without any unnecessary conversion.
-If the API returns base64 encoded strings, the images should be returned
-as base64 encoded strings. If the API returns binary data, the images should
-be returned as binary data.
+     * Generated images as base64 encoded strings or binary data.
+     * The images should be returned without any unnecessary conversion.
+     * If the API returns base64 encoded strings, the images should be returned
+     * as base64 encoded strings. If the API returns binary data, the images should
+     * be returned as binary data.
      */
     images: Array<string> | Array<Uint8Array>;
 
     /**
-Warnings for the call, e.g. unsupported settings.
+     * Warnings for the call, e.g. unsupported settings.
      */
     warnings: Array<ImageModelV2CallWarning>;
 
     /**
-Additional provider-specific metadata. They are passed through
-from the provider to the AI SDK and enable provider-specific
-results that can be fully encapsulated in the provider.
-
-The outer record is keyed by the provider name, and the inner
-record is provider-specific metadata. It always includes an
-`images` key with image-specific metadata
-
-```ts
-{
-  "openai": {
-    "images": ["revisedPrompt": "Revised prompt here."]
-  }
-}
-```
-      */
+     * Additional provider-specific metadata. They are passed through
+     * from the provider to the AI SDK and enable provider-specific
+     * results that can be fully encapsulated in the provider.
+     *
+     * The outer record is keyed by the provider name, and the inner
+     * record is provider-specific metadata. It always includes an
+     * `images` key with image-specific metadata
+     *
+     * ```ts
+     * {
+     * "openai": {
+     * "images": ["revisedPrompt": "Revised prompt here."]
+     * }
+     * }
+     * ```
+     */
     providerMetadata?: ImageModelV2ProviderMetadata;
 
     /**
-Response information for telemetry and debugging purposes.
+     * Response information for telemetry and debugging purposes.
      */
     response: {
       /**
-Timestamp for the start of the generated response.
-      */
+       * Timestamp for the start of the generated response.
+       */
       timestamp: Date;
 
       /**
-The ID of the response model that was used to generate the response.
-      */
+       * The ID of the response model that was used to generate the response.
+       */
       modelId: string;
 
       /**
-Response headers.
-      */
+       * Response headers.
+       */
       headers: Record<string, string> | undefined;
     };
   }>;

package/src/image-model/v3/image-model-v3-usage.ts

@@ -1,19 +1,19 @@
 /**
-Usage information for an image model call.
+ * Usage information for an image model call.
  */
 export type ImageModelV3Usage = {
   /**
-  The number of input (prompt) tokens used.
+   * The number of input (prompt) tokens used.
    */
   inputTokens: number | undefined;
 
   /**
-  The number of output tokens used, if reported by the provider.
+   * The number of output tokens used, if reported by the provider.
    */
   outputTokens: number | undefined;
 
   /**
-  The total number of tokens as reported by the provider.
+   * The total number of tokens as reported by the provider.
    */
   totalTokens: number | undefined;
 };

package/src/image-model/v3/image-model-v3.ts

@@ -15,95 +15,95 @@ type GetMaxImagesPerCallFunction = (options: {
 }) => PromiseLike<number | undefined> | number | undefined;
 
 /**
-Image generation model specification version 3.
+ * Image generation model specification version 3.
  */
 export type ImageModelV3 = {
   /**
-The image model must specify which image model interface
-version it implements. This will allow us to evolve the image
-model interface and retain backwards compatibility. The different
-implementation versions can be handled as a discriminated union
-on our side.
+   * The image model must specify which image model interface
+   * version it implements. This will allow us to evolve the image
+   * model interface and retain backwards compatibility. The different
+   * implementation versions can be handled as a discriminated union
+   * on our side.
    */
   readonly specificationVersion: 'v3';
 
   /**
-Name of the provider for logging purposes.
+   * Name of the provider for logging purposes.
    */
   readonly provider: string;
 
   /**
-Provider-specific model ID for logging purposes.
+   * Provider-specific model ID for logging purposes.
    */
   readonly modelId: string;
 
   /**
-Limit of how many images can be generated in a single API call.
-Can be set to a number for a fixed limit, to undefined to use
-the global limit, or a function that returns a number or undefined,
-optionally as a promise.
+   * Limit of how many images can be generated in a single API call.
+   * Can be set to a number for a fixed limit, to undefined to use
+   * the global limit, or a function that returns a number or undefined,
+   * optionally as a promise.
    */
   readonly maxImagesPerCall: number | undefined | GetMaxImagesPerCallFunction;
 
   /**
-Generates an array of images.
+   * Generates an array of images.
    */
   doGenerate(options: ImageModelV3CallOptions): PromiseLike<{
     /**
-Generated images as base64 encoded strings or binary data.
-The images should be returned without any unnecessary conversion.
-If the API returns base64 encoded strings, the images should be returned
-as base64 encoded strings. If the API returns binary data, the images should
-be returned as binary data.
+     * Generated images as base64 encoded strings or binary data.
+     * The images should be returned without any unnecessary conversion.
+     * If the API returns base64 encoded strings, the images should be returned
+     * as base64 encoded strings. If the API returns binary data, the images should
+     * be returned as binary data.
      */
     images: Array<string> | Array<Uint8Array>;
 
     /**
-Warnings for the call, e.g. unsupported features.
+     * Warnings for the call, e.g. unsupported features.
      */
     warnings: Array<SharedV3Warning>;
 
     /**
-Additional provider-specific metadata. They are passed through
-from the provider to the AI SDK and enable provider-specific
-results that can be fully encapsulated in the provider.
-
-The outer record is keyed by the provider name, and the inner
-record is provider-specific metadata. It always includes an
-`images` key with image-specific metadata
-
-```ts
-{
-  "openai": {
-    "images": ["revisedPrompt": "Revised prompt here."]
-  }
-}
-```
-      */
+     * Additional provider-specific metadata. They are passed through
+     * from the provider to the AI SDK and enable provider-specific
+     * results that can be fully encapsulated in the provider.
+     *
+     * The outer record is keyed by the provider name, and the inner
+     * record is provider-specific metadata. It always includes an
+     * `images` key with image-specific metadata
+     *
+     * ```ts
+     * {
+     * "openai": {
+     * "images": ["revisedPrompt": "Revised prompt here."]
+     * }
+     * }
+     * ```
+     */
     providerMetadata?: ImageModelV3ProviderMetadata;
 
     /**
-Response information for telemetry and debugging purposes.
+     * Response information for telemetry and debugging purposes.
      */
     response: {
       /**
-Timestamp for the start of the generated response.
-      */
+       * Timestamp for the start of the generated response.
+       */
       timestamp: Date;
 
       /**
-The ID of the response model that was used to generate the response.
-      */
+       * The ID of the response model that was used to generate the response.
+       */
       modelId: string;
 
       /**
-Response headers.
-      */
+       * Response headers.
+       */
       headers: Record<string, string> | undefined;
     };
 
     /**
-    Optional token usage for the image generation call (if the provider reports it).
+     * Optional token usage for the image generation call (if the provider reports it).
      */
     usage?: ImageModelV3Usage;
   }>;

package/src/json-value/json-value.ts

@@ -1,6 +1,6 @@
 /**
-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.
+ * 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.
  */
 export type JSONValue =
   | null