@mastra/schema-compat 0.10.5 → 0.10.6-alpha.1

package/dist/schema-compatibility-v3.d.ts

@@ -0,0 +1,319 @@
+import type { Schema } from 'ai';
+import type { JSONSchema7 } from 'json-schema';
+import { z, ZodOptional, ZodObject, ZodArray, ZodUnion, ZodString, ZodNumber, ZodDate, ZodDefault, ZodNull } from 'zod';
+import type { ZodTypeAny } from 'zod';
+import type { Targets } from 'zod-to-json-schema';
+import type { SchemaCompatLayer as ParentSchemaCompatLayer } from './schema-compatibility';
+import type { ModelInformation } from './types';
+/**
+ * All supported string validation check types that can be processed or converted to descriptions.
+ * @constant
+ */
+export declare const ALL_STRING_CHECKS: readonly ["regex", "emoji", "email", "url", "uuid", "cuid", "min", "max"];
+/**
+ * All supported number validation check types that can be processed or converted to descriptions.
+ * @constant
+ */
+export declare const ALL_NUMBER_CHECKS: readonly ["min", "max", "multipleOf"];
+/**
+ * All supported array validation check types that can be processed or converted to descriptions.
+ * @constant
+ */
+export declare const ALL_ARRAY_CHECKS: readonly ["min", "max", "length"];
+export declare const isOptional: (v: ZodTypeAny) => v is ZodOptional<any>;
+export declare const isObj: (v: ZodTypeAny) => v is ZodObject<any, any, any>;
+export declare const isNull: (v: ZodTypeAny) => v is ZodNull;
+export declare const isArr: (v: ZodTypeAny) => v is ZodArray<any, any>;
+export declare const isUnion: (v: ZodTypeAny) => v is ZodUnion<[ZodTypeAny, ...ZodTypeAny[]]>;
+export declare const isString: (v: ZodTypeAny) => v is ZodString;
+export declare const isNumber: (v: ZodTypeAny) => v is ZodNumber;
+export declare const isDate: (v: ZodTypeAny) => v is ZodDate;
+export declare const isDefault: (v: ZodTypeAny) => v is ZodDefault<any>;
+/**
+ * Zod types that are not supported by most AI model providers and should be avoided.
+ * @constant
+ */
+export declare const UNSUPPORTED_ZOD_TYPES: readonly ["ZodIntersection", "ZodNever", "ZodNull", "ZodTuple", "ZodUndefined"];
+/**
+ * Zod types that are generally supported by AI model providers.
+ * @constant
+ */
+export declare const SUPPORTED_ZOD_TYPES: readonly ["ZodObject", "ZodArray", "ZodUnion", "ZodString", "ZodNumber", "ZodDate", "ZodAny", "ZodDefault"];
+/**
+ * All Zod types (both supported and unsupported).
+ * @constant
+ */
+export declare const ALL_ZOD_TYPES: readonly ["ZodObject", "ZodArray", "ZodUnion", "ZodString", "ZodNumber", "ZodDate", "ZodAny", "ZodDefault", "ZodIntersection", "ZodNever", "ZodNull", "ZodTuple", "ZodUndefined"];
+/**
+ * Type representing string validation checks.
+ */
+export type StringCheckType = (typeof ALL_STRING_CHECKS)[number];
+/**
+ * Type representing number validation checks.
+ */
+export type NumberCheckType = (typeof ALL_NUMBER_CHECKS)[number];
+/**
+ * Type representing array validation checks.
+ */
+export type ArrayCheckType = (typeof ALL_ARRAY_CHECKS)[number];
+/**
+ * Type representing unsupported Zod schema types.
+ */
+export type UnsupportedZodType = (typeof UNSUPPORTED_ZOD_TYPES)[number];
+/**
+ * Type representing supported Zod schema types.
+ */
+export type SupportedZodType = (typeof SUPPORTED_ZOD_TYPES)[number];
+/**
+ * Type representing all Zod schema types (supported and unsupported).
+ */
+export type AllZodType = (typeof ALL_ZOD_TYPES)[number];
+/**
+ * Utility type to extract the shape of a Zod object schema.
+ */
+export type ZodShape<T extends z.AnyZodObject> = T['shape'];
+/**
+ * Utility type to extract the keys from a Zod object shape.
+ */
+export type ShapeKey<T extends z.AnyZodObject> = keyof ZodShape<T>;
+/**
+ * Utility type to extract the value types from a Zod object shape.
+ */
+export type ShapeValue<T extends z.AnyZodObject> = ZodShape<T>[ShapeKey<T>];
+type StringConstraints = {
+    minLength?: number;
+    maxLength?: number;
+    email?: boolean;
+    url?: boolean;
+    uuid?: boolean;
+    cuid?: boolean;
+    emoji?: boolean;
+    regex?: {
+        pattern: string;
+        flags?: string;
+    };
+};
+type NumberConstraints = {
+    gt?: number;
+    gte?: number;
+    lt?: number;
+    lte?: number;
+    multipleOf?: number;
+};
+type ArrayConstraints = {
+    minLength?: number;
+    maxLength?: number;
+    exactLength?: number;
+};
+type DateConstraints = {
+    minDate?: string;
+    maxDate?: string;
+    dateFormat?: string;
+};
+/**
+ * Abstract base class for creating schema compatibility layers for different AI model providers.
+ *
+ * This class provides a framework for transforming Zod schemas to work with specific AI model
+ * provider requirements and limitations. Each provider may have different support levels for
+ * JSON Schema features, validation constraints, and data types.
+ *
+ *
+ * @example
+ * ```typescript
+ * import { SchemaCompatLayer } from '@mastra/schema-compat';
+ * import type { LanguageModelV1 } from 'ai';
+ *
+ * class CustomProviderCompat extends SchemaCompatLayer {
+ *   constructor(model: ModelInformation) {
+ *     super(model);
+ *   }
+ *
+ *   shouldApply(): boolean {
+ *     return this.getModel().provider === 'custom-provider';
+ *   }
+ *
+ *   getSchemaTarget() {
+ *     return 'jsonSchema7';
+ *   }
+ *
+ *   processZodType<T extends z.AnyZodObject>(value: z.ZodTypeAny): ShapeValue<T> {
+ *     // Custom processing logic for this provider
+ *     switch (value._def.typeName) {
+ *       case 'ZodString':
+ *         return this.defaultZodStringHandler(value, ['email', 'url']);
+ *       default:
+ *         return this.defaultUnsupportedZodTypeHandler(value);
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare class SchemaCompatLayer {
+    private model;
+    private parent;
+    /**
+     * Creates a new schema compatibility instance.
+     *
+     * @param model - The language model this compatibility layer applies to
+     */
+    constructor(model: ModelInformation, parent: ParentSchemaCompatLayer);
+    /**
+     * Gets the language model associated with this compatibility layer.
+     *
+     * @returns The language model instance
+     */
+    getModel(): ModelInformation;
+    getUnsupportedZodTypes(): readonly string[];
+    /**
+     * Type guard for optional Zod types
+     */
+    isOptional(v: ZodTypeAny): v is ZodOptional<any>;
+    /**
+     * Type guard for object Zod types
+     */
+    isObj(v: ZodTypeAny): v is ZodObject<any, any, any>;
+    /**
+     * Type guard for null Zod types
+     */
+    isNull(v: ZodTypeAny): v is ZodNull;
+    /**
+     * Type guard for array Zod types
+     */
+    isArr(v: ZodTypeAny): v is ZodArray<any, any>;
+    /**
+     * Type guard for union Zod types
+     */
+    isUnion(v: ZodTypeAny): v is ZodUnion<[ZodTypeAny, ...ZodTypeAny[]]>;
+    /**
+     * Type guard for string Zod types
+     */
+    isString(v: ZodTypeAny): v is ZodString;
+    /**
+     * Type guard for number Zod types
+     */
+    isNumber(v: ZodTypeAny): v is ZodNumber;
+    /**
+     * Type guard for date Zod types
+     */
+    isDate(v: ZodTypeAny): v is ZodDate;
+    /**
+     * Type guard for default Zod types
+     */
+    isDefault(v: ZodTypeAny): v is ZodDefault<any>;
+    /**
+     * Determines whether this compatibility layer should be applied for the current model.
+     *
+     * @returns True if this compatibility layer should be used, false otherwise
+     * @abstract
+     */
+    shouldApply(): boolean;
+    /**
+     * Returns the JSON Schema target format for this provider.
+     *
+     * @returns The schema target format, or undefined to use the default 'jsonSchema7'
+     * @abstract
+     */
+    getSchemaTarget(): Targets | undefined;
+    /**
+     * Processes a specific Zod type according to the provider's requirements.
+     *
+     * @param value - The Zod type to process
+     * @returns The processed Zod type
+     * @abstract
+     */
+    processZodType(value: ZodTypeAny): ZodTypeAny;
+    /**
+     * Default handler for Zod object types. Recursively processes all properties in the object.
+     *
+     * @param value - The Zod object to process
+     * @returns The processed Zod object
+     */
+    defaultZodObjectHandler(value: ZodObject<any, any, any>, options?: {
+        passthrough?: boolean;
+    }): ZodObject<any, any, any>;
+    /**
+     * Merges validation constraints into a parameter description.
+     *
+     * This helper method converts validation constraints that may not be supported
+     * by a provider into human-readable descriptions.
+     *
+     * @param description - The existing parameter description
+     * @param constraints - The validation constraints to merge
+     * @returns The updated description with constraints, or undefined if no constraints
+     */
+    mergeParameterDescription(description: string | undefined, constraints: NumberConstraints | StringConstraints | ArrayConstraints | DateConstraints | {
+        defaultValue?: unknown;
+    }): string | undefined;
+    /**
+     * Default handler for unsupported Zod types. Throws an error for specified unsupported types.
+     *
+     * @param value - The Zod type to check
+     * @param throwOnTypes - Array of type names to throw errors for
+     * @returns The original value if not in the throw list
+     * @throws Error if the type is in the unsupported list
+     */
+    defaultUnsupportedZodTypeHandler<T extends z.AnyZodObject>(value: z.ZodTypeAny, throwOnTypes?: readonly UnsupportedZodType[]): ShapeValue<T>;
+    /**
+     * Default handler for Zod array types. Processes array constraints according to provider support.
+     *
+     * @param value - The Zod array to process
+     * @param handleChecks - Array constraints to convert to descriptions vs keep as validation
+     * @returns The processed Zod array
+     */
+    defaultZodArrayHandler(value: ZodArray<any, any>, handleChecks?: readonly ArrayCheckType[]): ZodArray<any, any>;
+    /**
+     * Default handler for Zod union types. Processes all union options.
+     *
+     * @param value - The Zod union to process
+     * @returns The processed Zod union
+     * @throws Error if union has fewer than 2 options
+     */
+    defaultZodUnionHandler(value: ZodUnion<[ZodTypeAny, ...ZodTypeAny[]]>): ZodTypeAny;
+    /**
+     * Default handler for Zod string types. Processes string validation constraints.
+     *
+     * @param value - The Zod string to process
+     * @param handleChecks - String constraints to convert to descriptions vs keep as validation
+     * @returns The processed Zod string
+     */
+    defaultZodStringHandler(value: ZodString, handleChecks?: readonly StringCheckType[]): ZodString;
+    /**
+     * Default handler for Zod number types. Processes number validation constraints.
+     *
+     * @param value - The Zod number to process
+     * @param handleChecks - Number constraints to convert to descriptions vs keep as validation
+     * @returns The processed Zod number
+     */
+    defaultZodNumberHandler(value: ZodNumber, handleChecks?: readonly NumberCheckType[]): ZodNumber;
+    /**
+     * Default handler for Zod date types. Converts dates to ISO strings with constraint descriptions.
+     *
+     * @param value - The Zod date to process
+     * @returns A Zod string schema representing the date in ISO format
+     */
+    defaultZodDateHandler(value: ZodDate): ZodString;
+    /**
+     * Default handler for Zod optional types. Processes the inner type and maintains optionality.
+     *
+     * @param value - The Zod optional to process
+     * @param handleTypes - Types that should be processed vs passed through
+     * @returns The processed Zod optional
+     */
+    defaultZodOptionalHandler(value: ZodOptional<any>, handleTypes?: readonly AllZodType[]): ZodTypeAny;
+    /**
+     * Processes a Zod object schema and converts it to an AI SDK Schema.
+     *
+     * @param zodSchema - The Zod object schema to process
+     * @returns An AI SDK Schema with provider-specific compatibility applied
+     */
+    processToAISDKSchema(zodSchema: z.ZodSchema): Schema;
+    /**
+     * Processes a Zod object schema and converts it to a JSON Schema.
+     *
+     * @param zodSchema - The Zod object schema to process
+     * @returns A JSONSchema7 object with provider-specific compatibility applied
+     */
+    processToJSONSchema(zodSchema: z.ZodSchema): JSONSchema7;
+}
+export {};
+//# sourceMappingURL=schema-compatibility-v3.d.ts.map

package/dist/schema-compatibility-v3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-compatibility-v3.d.ts","sourceRoot":"","sources":["../src/schema-compatibility-v3.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AACxH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,KAAK,CAAC;AACtC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,iBAAiB,IAAI,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAC3F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAGhD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,2EAA4E,CAAC;AAE3G;;;GAGG;AACH,eAAO,MAAM,iBAAiB,uCAIpB,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,gBAAgB,mCAAoC,CAAC;AAElE,eAAO,MAAM,UAAU,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,WAAW,CAAC,GAAG,CAA6B,CAAC;AAC7F,eAAO,MAAM,KAAK,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAA2B,CAAC;AAC9F,eAAO,MAAM,MAAM,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,OAA+B,CAAC;AAC5E,eAAO,MAAM,KAAK,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,QAAQ,CAAC,GAAG,EAAE,GAAG,CAA0B,CAAC;AACvF,eAAO,MAAM,OAAO,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,UAAU,EAAE,GAAG,UAAU,EAAE,CAAC,CAA0B,CAAC;AAC9G,eAAO,MAAM,QAAQ,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,SAAmC,CAAC;AAClF,eAAO,MAAM,QAAQ,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,SAAmC,CAAC;AAClF,eAAO,MAAM,MAAM,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,OAA+B,CAAC;AAC5E,eAAO,MAAM,SAAS,GAAI,GAAG,UAAU,KAAG,CAAC,IAAI,UAAU,CAAC,GAAG,CAA4B,CAAC;AAE1F;;;GAGG;AACH,eAAO,MAAM,qBAAqB,iFAAkF,CAAC;AAErH;;;GAGG;AACH,eAAO,MAAM,mBAAmB,6GAStB,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,aAAa,mLAA8D,CAAC;AAEzF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,YAAY,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC,YAAY,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAI5E,KAAK,iBAAiB,GAAG;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7C,CAAC;AAEF,KAAK,iBAAiB,GAAG;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,MAAM,CAA0B;IAExC;;;;OAIG;gBACS,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,uBAAuB;IAKpE;;;;OAIG;IACH,QAAQ,IAAI,gBAAgB;IAI5B,sBAAsB,IAAI,SAAS,MAAM,EAAE;IAI3C;;OAEG;IACH,UAAU,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC;IAIhD;;OAEG;IACH,KAAK,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IAInD;;OAEG;IACH,MAAM,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,IAAI,OAAO;IAInC;;OAEG;IACH,KAAK,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,IAAI,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAI7C;;OAEG;IACH,OAAO,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,UAAU,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;IAIpE;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,IAAI,SAAS;IAIvC;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,IAAI,SAAS;IAIvC;;OAEG;IACH,MAAM,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,IAAI,OAAO;IAInC;;OAEG;IACH,SAAS,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC;IAI9C;;;;;OAKG;IACH,WAAW,IAAI,OAAO;IAItB;;;;;OAKG;IACH,eAAe,IAAI,OAAO,GAAG,SAAS;IAItC;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU;IAI7C;;;;;OAKG;IACI,uBAAuB,CAC5B,KAAK,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC/B,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAA0B,GACzD,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IA0B3B;;;;;;;;;OASG;IACI,yBAAyB,CAC9B,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,WAAW,EACP,iBAAiB,GACjB,iBAAiB,GACjB,gBAAgB,GAChB,eAAe,GACf;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7B,MAAM,GAAG,SAAS;IAQrB;;;;;;;OAOG;IACI,gCAAgC,CAAC,CAAC,SAAS,CAAC,CAAC,YAAY,EAC9D,KAAK,EAAE,CAAC,CAAC,UAAU,EACnB,YAAY,GAAE,SAAS,kBAAkB,EAA0B,GAClE,UAAU,CAAC,CAAC,CAAC;IAOhB;;;;;;OAMG;IACI,sBAAsB,CAC3B,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,EACzB,YAAY,GAAE,SAAS,cAAc,EAAqB,GACzD,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAuCrB;;;;;;OAMG;IACI,sBAAsB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,UAAU,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,GAAG,UAAU;IAUzF;;;;;;OAMG;IACI,uBAAuB,CAC5B,KAAK,EAAE,SAAS,EAChB,YAAY,GAAE,SAAS,eAAe,EAAsB,GAC3D,SAAS;IA6DZ;;;;;;OAMG;IACI,uBAAuB,CAC5B,KAAK,EAAE,SAAS,EAChB,YAAY,GAAE,SAAS,eAAe,EAAsB,GAC3D,SAAS;IAqDZ;;;;;OAKG;IACI,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS;IAkCvD;;;;;;OAMG;IACI,yBAAyB,CAC9B,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,EACvB,WAAW,GAAE,SAAS,UAAU,EAAwB,GACvD,UAAU;IAQb;;;;;OAKG;IACI,oBAAoB,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,MAAM;IAM3D;;;;;OAKG;IACI,mBAAmB,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,WAAW;CAGhE"}

package/dist/schema-compatibility-v4.d.ts

@@ -0,0 +1,310 @@
+import type { Schema } from 'ai';
+import type { JSONSchema7 } from 'json-schema';
+import { z, ZodOptional, ZodObject, ZodArray, ZodUnion, ZodString, ZodNumber, ZodDate, ZodDefault, ZodNull } from 'zod/v4';
+import type { ZodAny, ZodType } from 'zod/v4';
+import type { Targets } from 'zod-to-json-schema';
+import type { SchemaCompatLayer as ParentSchemaCompatLayer } from './schema-compatibility';
+import type { ModelInformation } from './types';
+/**
+ * All supported string validation check types that can be processed or converted to descriptions.
+ * @constant
+ */
+export declare const ALL_STRING_CHECKS: readonly ["regex", "emoji", "email", "url", "uuid", "cuid", "min_length", "max_length", "string_format"];
+/**
+ * All supported number validation check types that can be processed or converted to descriptions.
+ * @constant
+ */
+export declare const ALL_NUMBER_CHECKS: readonly ["greater_than", "less_than", "multiple_of"];
+/**
+ * All supported array validation check types that can be processed or converted to descriptions.
+ * @constant
+ */
+export declare const ALL_ARRAY_CHECKS: readonly ["min", "max", "length"];
+/**
+ * Zod types that are not supported by most AI model providers and should be avoided.
+ * @constant
+ */
+export declare const UNSUPPORTED_ZOD_TYPES: readonly ["ZodIntersection", "ZodNever", "ZodNull", "ZodTuple", "ZodUndefined"];
+/**
+ * Zod types that are generally supported by AI model providers.
+ * @constant
+ */
+export declare const SUPPORTED_ZOD_TYPES: readonly ["ZodObject", "ZodArray", "ZodUnion", "ZodString", "ZodNumber", "ZodDate", "ZodAny", "ZodDefault"];
+/**
+ * All Zod types (both supported and unsupported).
+ * @constant
+ */
+export declare const ALL_ZOD_TYPES: readonly ["ZodObject", "ZodArray", "ZodUnion", "ZodString", "ZodNumber", "ZodDate", "ZodAny", "ZodDefault", "ZodIntersection", "ZodNever", "ZodNull", "ZodTuple", "ZodUndefined"];
+/**
+ * Type representing string validation checks.
+ */
+export type StringCheckType = (typeof ALL_STRING_CHECKS)[number];
+/**
+ * Type representing number validation checks.
+ */
+export type NumberCheckType = (typeof ALL_NUMBER_CHECKS)[number];
+/**
+ * Type representing array validation checks.
+ */
+export type ArrayCheckType = (typeof ALL_ARRAY_CHECKS)[number];
+/**
+ * Type representing unsupported Zod schema types.
+ */
+export type UnsupportedZodType = (typeof UNSUPPORTED_ZOD_TYPES)[number];
+/**
+ * Type representing supported Zod schema types.
+ */
+export type SupportedZodType = (typeof SUPPORTED_ZOD_TYPES)[number];
+/**
+ * Type representing all Zod schema types (supported and unsupported).
+ */
+export type AllZodType = (typeof ALL_ZOD_TYPES)[number];
+/**
+ * Utility type to extract the shape of a Zod object schema.
+ */
+export type ZodShape<T extends z.ZodObject<any, any>> = T['shape'];
+/**
+ * Utility type to extract the keys from a Zod object shape.
+ */
+export type ShapeKey<T extends z.ZodObject<any, any>> = keyof ZodShape<T>;
+/**
+ * Utility type to extract the value types from a Zod object shape.
+ */
+export type ShapeValue<T extends z.ZodObject<any, any>> = ZodShape<T>[ShapeKey<T>];
+type StringConstraints = {
+    minLength?: number;
+    maxLength?: number;
+    email?: boolean;
+    url?: boolean;
+    uuid?: boolean;
+    cuid?: boolean;
+    emoji?: boolean;
+    regex?: {
+        pattern: string;
+        flags?: string;
+    };
+};
+type NumberConstraints = {
+    gt?: number;
+    gte?: number;
+    lt?: number;
+    lte?: number;
+    multipleOf?: number;
+};
+type ArrayConstraints = {
+    minLength?: number;
+    maxLength?: number;
+    exactLength?: number;
+};
+type DateConstraints = {
+    minDate?: string;
+    maxDate?: string;
+    dateFormat?: string;
+};
+/**
+ * Abstract base class for creating schema compatibility layers for different AI model providers.
+ *
+ * This class provides a framework for transforming Zod schemas to work with specific AI model
+ * provider requirements and limitations. Each provider may have different support levels for
+ * JSON Schema features, validation constraints, and data types.
+ *
+ *
+ * @example
+ * ```typescript
+ * import { SchemaCompatLayer } from '@mastra/schema-compat';
+ * import type { LanguageModelV1 } from 'ai';
+ *
+ * class CustomProviderCompat extends SchemaCompatLayer {
+ *   constructor(model: LanguageModelV1) {
+ *     super(model);
+ *   }
+ *
+ *   shouldApply(): boolean {
+ *     return this.getModel().provider === 'custom-provider';
+ *   }
+ *
+ *   getSchemaTarget() {
+ *     return 'jsonSchema7';
+ *   }
+ *
+ *   processZodType<T extends z.AnyZodObject>(value: z.ZodAny): ShapeValue<T> {
+ *     // Custom processing logic for this provider
+ *     switch (value._def.typeName) {
+ *       case 'ZodString':
+ *         return this.defaultZodStringHandler(value, ['email', 'url']);
+ *       default:
+ *         return this.defaultUnsupportedZodTypeHandler(value);
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare class SchemaCompatLayer {
+    private model;
+    private parent;
+    /**
+     * Creates a new schema compatibility instance.
+     *
+     * @param model - The language model this compatibility layer applies to
+     */
+    constructor(model: ModelInformation, parent: ParentSchemaCompatLayer);
+    /**
+     * Gets the language model associated with this compatibility layer.
+     *
+     * @returns The language model instance
+     */
+    getModel(): ModelInformation;
+    getUnsupportedZodTypes(): readonly string[];
+    /**
+     * Type guard for optional Zod types
+     */
+    isOptional(v: ZodAny | ZodOptional<any>): v is ZodOptional<any>;
+    /**
+     * Type guard for object Zod types
+     */
+    isObj(v: ZodAny | ZodObject<any, any>): v is ZodObject<any, any>;
+    /**
+     * Type guard for null Zod types
+     */
+    isNull(v: ZodAny | ZodNull): v is ZodNull;
+    /**
+     * Type guard for array Zod types
+     */
+    isArr(v: ZodAny | ZodArray<any>): v is ZodArray<any>;
+    /**
+     * Type guard for union Zod types
+     */
+    isUnion(v: ZodAny | ZodUnion<[ZodAny, ...ZodAny[]]>): v is ZodUnion<[ZodAny, ...ZodAny[]]>;
+    /**
+     * Type guard for string Zod types
+     */
+    isString(v: ZodAny | ZodString): v is ZodString;
+    /**
+     * Type guard for number Zod types
+     */
+    isNumber(v: ZodAny | ZodNumber): v is ZodNumber;
+    /**
+     * Type guard for date Zod types
+     */
+    isDate(v: ZodAny | ZodDate): v is ZodDate;
+    /**
+     * Type guard for default Zod types
+     */
+    isDefault(v: ZodAny | ZodDefault<any>): v is ZodDefault<any>;
+    /**
+     * Determines whether this compatibility layer should be applied for the current model.
+     *
+     * @returns True if this compatibility layer should be used, false otherwise
+     * @abstract
+     */
+    shouldApply(): boolean;
+    /**
+     * Returns the JSON Schema target format for this provider.
+     *
+     * @returns The schema target format, or undefined to use the default 'jsonSchema7'
+     * @abstract
+     */
+    getSchemaTarget(): Targets | undefined;
+    /**
+     * Processes a specific Zod type according to the provider's requirements.
+     *
+     * @param value - The Zod type to process
+     * @returns The processed Zod type
+     * @abstract
+     */
+    processZodType(value: ZodType): ZodType;
+    /**
+     * Default handler for Zod object types. Recursively processes all properties in the object.
+     *
+     * @param value - The Zod object to process
+     * @returns The processed Zod object
+     */
+    defaultZodObjectHandler(value: ZodObject<any, any>, options?: {
+        passthrough?: boolean;
+    }): ZodObject<any, any>;
+    /**
+     * Merges validation constraints into a parameter description.
+     *
+     * This helper method converts validation constraints that may not be supported
+     * by a provider into human-readable descriptions.
+     *
+     * @param description - The existing parameter description
+     * @param constraints - The validation constraints to merge
+     * @returns The updated description with constraints, or undefined if no constraints
+     */
+    mergeParameterDescription(description: string | undefined, constraints: NumberConstraints | StringConstraints | ArrayConstraints | DateConstraints | {
+        defaultValue?: unknown;
+    }): string | undefined;
+    /**
+     * Default handler for unsupported Zod types. Throws an error for specified unsupported types.
+     *
+     * @param value - The Zod type to check
+     * @param throwOnTypes - Array of type names to throw errors for
+     * @returns The original value if not in the throw list
+     * @throws Error if the type is in the unsupported list
+     */
+    defaultUnsupportedZodTypeHandler<T extends z.ZodObject<any, any>>(value: z.ZodAny, throwOnTypes?: readonly UnsupportedZodType[]): ShapeValue<T>;
+    /**
+     * Default handler for Zod array types. Processes array constraints according to provider support.
+     *
+     * @param value - The Zod array to process
+     * @param handleChecks - Array constraints to convert to descriptions vs keep as validation
+     * @returns The processed Zod array
+     */
+    defaultZodArrayHandler(value: ZodArray<any>, handleChecks?: readonly ArrayCheckType[]): ZodArray<any>;
+    /**
+     * Default handler for Zod union types. Processes all union options.
+     *
+     * @param value - The Zod union to process
+     * @returns The processed Zod union
+     * @throws Error if union has fewer than 2 options
+     */
+    defaultZodUnionHandler(value: ZodUnion<[ZodAny, ...ZodAny[]]>): ZodAny;
+    /**
+     * Default handler for Zod string types. Processes string validation constraints.
+     *
+     * @param value - The Zod string to process
+     * @param handleChecks - String constraints to convert to descriptions vs keep as validation
+     * @returns The processed Zod string
+     */
+    defaultZodStringHandler(value: ZodString, handleChecks?: readonly StringCheckType[]): ZodString;
+    /**
+     * Default handler for Zod number types. Processes number validation constraints.
+     *
+     * @param value - The Zod number to process
+     * @param handleChecks - Number constraints to convert to descriptions vs keep as validation
+     * @returns The processed Zod number
+     */
+    defaultZodNumberHandler(value: ZodNumber, handleChecks?: readonly NumberCheckType[]): ZodNumber;
+    /**
+     * Default handler for Zod date types. Converts dates to ISO strings with constraint descriptions.
+     *
+     * @param value - The Zod date to process
+     * @returns A Zod string schema representing the date in ISO format
+     */
+    defaultZodDateHandler(value: ZodDate): ZodString;
+    /**
+     * Default handler for Zod optional types. Processes the inner type and maintains optionality.
+     *
+     * @param value - The Zod optional to process
+     * @param handleTypes - Types that should be processed vs passed through
+     * @returns The processed Zod optional
+     */
+    defaultZodOptionalHandler(value: ZodOptional<any>, handleTypes?: readonly AllZodType[]): ZodType;
+    /**
+     * Processes a Zod object schema and converts it to an AI SDK Schema.
+     *
+     * @param zodSchema - The Zod object schema to process
+     * @returns An AI SDK Schema with provider-specific compatibility applied
+     */
+    processToAISDKSchema(zodSchema: ZodType): Schema;
+    /**
+     * Processes a Zod object schema and converts it to a JSON Schema.
+     *
+     * @param zodSchema - The Zod object schema to process
+     * @returns A JSONSchema7 object with provider-specific compatibility applied
+     */
+    processToJSONSchema(zodSchema: ZodType): JSONSchema7;
+}
+export {};
+//# sourceMappingURL=schema-compatibility-v4.d.ts.map

package/dist/schema-compatibility-v4.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-compatibility-v4.d.ts","sourceRoot":"","sources":["../src/schema-compatibility-v4.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EACL,CAAC,EACD,WAAW,EACX,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,SAAS,EACT,OAAO,EACP,UAAU,EACV,OAAO,EACR,MAAM,QAAQ,CAAC;AAChB,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,iBAAiB,IAAI,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAC3F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAGhD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,0GAUpB,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,iBAAiB,uDAAwD,CAAC;AAEvF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,mCAAoC,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,qBAAqB,iFAAkF,CAAC;AAErH;;;GAGG;AACH,eAAO,MAAM,mBAAmB,6GAStB,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,aAAa,mLAA8D,CAAC;AAEzF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAInF,KAAK,iBAAiB,GAAG;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7C,CAAC;AAEF,KAAK,iBAAiB,GAAG;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,MAAM,CAA0B;IAExC;;;;OAIG;gBACS,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,uBAAuB;IAKpE;;;;OAIG;IACH,QAAQ,IAAI,gBAAgB;IAI5B,sBAAsB,IAAI,SAAS,MAAM,EAAE;IAI3C;;OAEG;IACH,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC;IAI/D;;OAEG;IACH,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IAIhE;;OAEG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,CAAC,IAAI,OAAO;IAIzC;;OAEG;IACH,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC;IAIpD;;OAEG;IACH,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAI1F;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,CAAC,IAAI,SAAS;IAI/C;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,CAAC,IAAI,SAAS;IAI/C;;OAEG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,CAAC,IAAI,OAAO;IAIzC;;OAEG;IACH,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC;IAI5D;;;;;OAKG;IACH,WAAW,IAAI,OAAO;IAItB;;;;;OAKG;IACH,eAAe,IAAI,OAAO,GAAG,SAAS;IAItC;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAIvC;;;;;OAKG;IACI,uBAAuB,CAC5B,KAAK,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EAC1B,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAA0B,GACzD,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IA0BtB;;;;;;;;;OASG;IACI,yBAAyB,CAC9B,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,WAAW,EACP,iBAAiB,GACjB,iBAAiB,GACjB,gBAAgB,GAChB,eAAe,GACf;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7B,MAAM,GAAG,SAAS;IAQrB;;;;;;;OAOG;IACI,gCAAgC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EACrE,KAAK,EAAE,CAAC,CAAC,MAAM,EACf,YAAY,GAAE,SAAS,kBAAkB,EAA0B,GAClE,UAAU,CAAC,CAAC,CAAC;IAOhB;;;;;;OAMG;IACI,sBAAsB,CAC3B,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,EACpB,YAAY,GAAE,SAAS,cAAc,EAAqB,GACzD,QAAQ,CAAC,GAAG,CAAC;IAiDhB;;;;;;OAMG;IACI,sBAAsB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,GAAG,MAAM;IAW7E;;;;;;OAMG;IACI,uBAAuB,CAC5B,KAAK,EAAE,SAAS,EAChB,YAAY,GAAE,SAAS,eAAe,EAAsB,GAC3D,SAAS;IAsEZ;;;;;;OAMG;IACI,uBAAuB,CAC5B,KAAK,EAAE,SAAS,EAChB,YAAY,GAAE,SAAS,eAAe,EAAsB,GAC3D,SAAS;IAkEZ;;;;;OAKG;IACI,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS;IAoCvD;;;;;;OAMG;IACI,yBAAyB,CAC9B,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,EACvB,WAAW,GAAE,SAAS,UAAU,EAAwB,GACvD,OAAO;IAQV;;;;;OAKG;IACI,oBAAoB,CAAC,SAAS,EAAE,OAAO,GAAG,MAAM;IAMvD;;;;;OAKG;IACI,mBAAmB,CAAC,SAAS,EAAE,OAAO,GAAG,WAAW;CAG5D"}