@ai-sdk/provider-utils 4.0.9 → 4.0.11

package/src/types/tool.ts

@@ -82,12 +82,12 @@ type ToolOutputProperties<INPUT, OUTPUT> = NeverOptional<
   OUTPUT,
   | {
       /**
-An async function that is called with the arguments from the tool call and produces a result.
-If not provided, the tool will not be executed automatically.
-
-@args is the input of the tool call.
-@options.abortSignal is a signal that can be used to abort the tool call.
-    */
+       * An async function that is called with the arguments from the tool call and produces a result.
+       * If not provided, the tool will not be executed automatically.
+       *
+       * @args is the input of the tool call.
+       * @options.abortSignal is a signal that can be used to abort the tool call.
+       */
       execute: ToolExecuteFunction<INPUT, OUTPUT>;
 
       outputSchema?: FlexibleSchema<OUTPUT>;
@@ -100,19 +100,19 @@ If not provided, the tool will not be executed automatically.
 >;
 
 /**
-A tool contains the description and the schema of the input that the tool expects.
-This enables the language model to generate the input.
-
-The tool can also contain an optional execute function for the actual execution function of the tool.
+ * A tool contains the description and the schema of the input that the tool expects.
+ * This enables the language model to generate the input.
+ *
+ * The tool can also contain an optional execute function for the actual execution function of the tool.
  */
 export type Tool<
   INPUT extends JSONValue | unknown | never = any,
   OUTPUT extends JSONValue | unknown | never = any,
 > = {
   /**
-An optional description of what the tool does.
-Will be used by the language model to decide whether to use the tool.
-Not used for provider-defined tools.
+   * An optional description of what the tool does.
+   * Will be used by the language model to decide whether to use the tool.
+   * Not used for provider-defined tools.
    */
   description?: string;
 
@@ -122,9 +122,9 @@ Not used for provider-defined tools.
   title?: string;
 
   /**
-Additional provider-specific metadata. They are passed through
-to the provider from the AI SDK and enable provider-specific
-functionality that can be fully encapsulated in the provider.
+   * Additional provider-specific metadata. They are passed through
+   * to the provider from the AI SDK and enable provider-specific
+   * functionality that can be fully encapsulated in the provider.
    */
   providerOptions?: ProviderOptions;
 
@@ -211,31 +211,31 @@ functionality that can be fully encapsulated in the provider.
   } & (
     | {
         /**
-Tool with user-defined input and output schemas.
-     */
+         * Tool with user-defined input and output schemas.
+         */
         type?: undefined | 'function';
       }
     | {
         /**
-Tool that is defined at runtime (e.g. an MCP tool).
-The types of input and output are not known at development time.
-       */
+         * Tool that is defined at runtime (e.g. an MCP tool).
+         * The types of input and output are not known at development time.
+         */
         type: 'dynamic';
       }
     | {
         /**
-Tool with provider-defined input and output schemas.
-     */
+         * Tool with provider-defined input and output schemas.
+         */
         type: 'provider';
 
         /**
-The ID of the tool. Must follow the format `<provider-name>.<unique-tool-name>`.
-   */
+         * The ID of the tool. Must follow the format `<provider-name>.<unique-tool-name>`.
+         */
         id: `${string}.${string}`;
 
         /**
-The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
-     */
+         * The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
+         */
         args: Record<string, unknown>;
 
         /**
@@ -268,7 +268,7 @@ export type InferToolOutput<TOOL extends Tool> =
   TOOL extends Tool<any, infer OUTPUT> ? OUTPUT : never;
 
 /**
-Helper function for inferring the execute args of a tool.
+ * Helper function for inferring the execute args of a tool.
  */
 // Note: overload order is important for auto-completion
 export function tool<INPUT, OUTPUT>(

package/src/types/user-model-message.ts

@@ -2,21 +2,21 @@ import { FilePart, ImagePart, TextPart } from './content-part';
 import { ProviderOptions } from './provider-options';
 
 /**
-A user message. It can contain text or a combination of text and images.
+ * A user message. It can contain text or a combination of text and images.
  */
 export type UserModelMessage = {
   role: 'user';
   content: UserContent;
 
   /**
-    Additional provider-specific metadata. They are passed through
-    to the provider from the AI SDK and enable provider-specific
-    functionality that can be fully encapsulated in the provider.
-     */
+   * Additional provider-specific metadata. They are passed through
+   * to the provider from the AI SDK and enable provider-specific
+   * functionality that can be fully encapsulated in the provider.
+   */
   providerOptions?: ProviderOptions;
 };
 
 /**
-  Content of a user message. It can be a string or an array of text and image parts.
-   */
+ * Content of a user message. It can be a string or an array of text and image parts.
+ */
 export type UserContent = string | Array<TextPart | ImagePart | FilePart>;

package/src/validate-types.ts

@@ -1,4 +1,4 @@
-import { TypeValidationError } from '@ai-sdk/provider';
+import { TypeValidationContext, TypeValidationError } from '@ai-sdk/provider';
 import { FlexibleSchema, asSchema } from './schema';
 
 /**
@@ -8,19 +8,22 @@ import { FlexibleSchema, asSchema } from './schema';
  * @template T - The type of the object to validate.
  * @param {string} options.value - The object to validate.
  * @param {Validator<T>} options.schema - The schema to use for validating the JSON.
+ * @param {TypeValidationContext} options.context - Optional context about what is being validated.
  * @returns {Promise<T>} - The typed object.
  */
 export async function validateTypes<OBJECT>({
   value,
   schema,
+  context,
 }: {
   value: unknown;
   schema: FlexibleSchema<OBJECT>;
+  context?: TypeValidationContext;
 }): Promise<OBJECT> {
-  const result = await safeValidateTypes({ value, schema });
+  const result = await safeValidateTypes({ value, schema, context });
 
   if (!result.success) {
-    throw TypeValidationError.wrap({ value, cause: result.error });
+    throw TypeValidationError.wrap({ value, cause: result.error, context });
   }
 
   return result.value;
@@ -33,14 +36,17 @@ export async function validateTypes<OBJECT>({
  * @template T - The type of the object to validate.
  * @param {string} options.value - The JSON object to validate.
  * @param {Validator<T>} options.schema - The schema to use for validating the JSON.
+ * @param {TypeValidationContext} options.context - Optional context about what is being validated.
  * @returns An object with either a `success` flag and the parsed and typed data, or a `success` flag and an error object.
  */
 export async function safeValidateTypes<OBJECT>({
   value,
   schema,
+  context,
 }: {
   value: unknown;
   schema: FlexibleSchema<OBJECT>;
+  context?: TypeValidationContext;
 }): Promise<
   | {
       success: true;
@@ -68,13 +74,13 @@ export async function safeValidateTypes<OBJECT>({
 
     return {
       success: false,
-      error: TypeValidationError.wrap({ value, cause: result.error }),
+      error: TypeValidationError.wrap({ value, cause: result.error, context }),
       rawValue: value,
     };
   } catch (error) {
     return {
       success: false,
-      error: TypeValidationError.wrap({ value, cause: error }),
+      error: TypeValidationError.wrap({ value, cause: error, context }),
       rawValue: value,
     };
   }