@ai-sdk/provider-utils 4.0.10 → 4.0.11

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,
     };
   }