@mastra/schema-compat 0.0.0-ai-v5-20250625173645

package/.turbo/turbo-build.log

@@ -0,0 +1,23 @@
+
+> @mastra/schema-compat@0.10.2 build /home/runner/work/mastra/mastra/packages/schema-compat
+> tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.0
+TSC Build start
+TSC ⚡️ Build success in 2200ms
+DTS Build start
+CLI Target: es2022
+Analysis will use the bundled TypeScript version 5.8.3
+Writing package typings: /home/runner/work/mastra/mastra/packages/schema-compat/dist/_tsup-dts-rollup.d.ts
+Analysis will use the bundled TypeScript version 5.8.3
+Writing package typings: /home/runner/work/mastra/mastra/packages/schema-compat/dist/_tsup-dts-rollup.d.cts
+DTS ⚡️ Build success in 1893ms
+CLI Cleaning output folder
+ESM Build start
+CJS Build start
+ESM dist/index.js 21.19 KB
+ESM ⚡️ Build success in 149ms
+CJS dist/index.cjs 21.82 KB
+CJS ⚡️ Build success in 149ms

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# @mastra/schema-compat
+
+## 0.0.0-ai-v5-20250625173645
+
+### Minor Changes
+
+- 66858d4: AI SDK v5 beta
+
+## 0.10.2
+
+### Patch Changes
+
+- f6fd25f: Updates @mastra/schema-compat to allow all zod schemas. Uses @mastra/schema-compat to apply schema transformations to agent output schema.
+- f9816ae: Create @mastra/schema-compat package to extract the schema compatibility layer to be used outside of mastra
+
+## 0.10.2-alpha.3
+
+### Patch Changes
+
+- f6fd25f: Updates @mastra/schema-compat to allow all zod schemas. Uses @mastra/schema-compat to apply schema transformations to agent output schema.
+
+## 0.10.2-alpha.2
+
+### Patch Changes
+
+- f9816ae: Create @mastra/schema-compat package to extract the schema compatibility layer to be used outside of mastra

package/LICENSE.md

@@ -0,0 +1,46 @@
+# Elastic License 2.0 (ELv2)
+
+Copyright (c) 2025 Mastra AI, Inc.
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,148 @@
+# @mastra/schema-compat
+
+Schema compatibility layer for Mastra.ai that provides compatibility fixes for different AI model providers when using Zod schemas with tools.
+
+## Installation
+
+```bash
+pnpm add @mastra/schema-compat
+```
+
+## Usage
+
+### Basic Usage
+
+The package provides a base `SchemaCompatLayer` class that you can extend to create custom compatibility layers for different AI model providers:
+
+```typescript
+import { SchemaCompatLayer } from '@mastra/schema-compat';
+import type { LanguageModelV1 } from 'ai';
+
+class MyCustomCompat extends SchemaCompatLayer {
+  constructor(model: LanguageModelV1) {
+    super(model);
+  }
+
+  shouldApply(): boolean {
+    return this.getModel().provider === 'my-provider';
+  }
+
+  getSchemaTarget() {
+    return 'jsonSchema7';
+  }
+
+  processZodType<T extends z.AnyZodObject>(value: z.ZodTypeAny): ShapeValue<T> {
+    // Your custom processing logic here
+    return value;
+  }
+}
+```
+
+### Schema Processing
+
+The package includes pre-built compatibility layers for popular AI providers:
+
+Use the `applyCompatLayer` function to automatically apply the right compatibility layer:
+
+```typescript
+import { applyCompatLayer, OpenAISchemaCompatLayer, AnthropicSchemaCompatLayer } from '@mastra/schema-compat';
+import { yourCustomCompatibilityLayer } from './customCompatibilityLayer';
+import { z } from 'zod';
+
+const schema = z.object({
+  name: z.string().email(),
+  preferences: z.array(z.string()).min(1),
+});
+
+const compatLayers = [
+  new OpenAISchemaCompatLayer(model),
+  new AnthropicSchemaCompatLayer(model),
+  new yourCustomCompatibilityLayer(model),
+];
+
+// Automatically applies the first matching compatibility
+const result = applyCompatLayer({
+  schema,
+  compatLayers,
+  mode: 'aiSdkSchema', // or 'jsonSchema'
+});
+```
+
+### Schema Building Utilities
+
+The package also provides utility functions for schema conversion:
+
+```typescript
+import { convertZodSchemaToAISDKSchema, convertSchemaToZod } from '@mastra/schema-compat';
+import { z } from 'zod';
+import { jsonSchema } from 'ai';
+
+const zodSchema = z.object({
+  name: z.string(),
+  age: z.number(),
+});
+
+// Convert Zod to AI SDK Schema
+const aiSchema = convertZodSchemaToAISDKSchema(zodSchema);
+
+// Convert AI SDK Schema back to Zod
+const aiSdkSchema = jsonSchema({
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+  },
+});
+const backToZod = convertSchemaToZod(aiSdkSchema);
+```
+
+## API Reference
+
+### Classes
+
+- `SchemaCompatLayer` - Base abstract class for creating compatibility layers
+- `AnthropicSchemaCompatLayer` - Compatibility for Anthropic Claude models
+- `OpenAISchemaCompatLayer` - Compatibility for OpenAI models (without structured outputs)
+- `OpenAIReasoningSchemaCompatLayer` - Compatibility for OpenAI reasoning models (o1 series)
+- `GoogleSchemaCompatLayer` - Compatibility for Google Gemini models
+- `DeepSeekSchemaCompatLayer` - Compatibility for DeepSeek models
+- `MetaSchemaCompatLayer` - Compatibility for Meta Llama models
+
+### Functions
+
+- `applyCompatLayer(options)` - Process schema with automatic compatibility detection
+- `convertZodSchemaToAISDKSchema(zodSchema, target?)` - Convert Zod schema to AI SDK Schema
+- `convertSchemaToZod(schema)` - Convert AI SDK Schema to Zod schema
+
+### Types and Constants
+
+- `StringCheckType`, `NumberCheckType`, `ArrayCheckType` - Check types for validation
+- `UnsupportedZodType`, `SupportedZodType`, `AllZodType` - Zod type classifications
+- `ZodShape`, `ShapeKey`, `ShapeValue` - Utility types for Zod schemas
+- `ALL_STRING_CHECKS`, `ALL_NUMBER_CHECKS`, `ALL_ARRAY_CHECKS` - Validation constraint arrays
+- `SUPPORTED_ZOD_TYPES`, `UNSUPPORTED_ZOD_TYPES` - Type classification arrays
+
+## Provider-Specific Behavior
+
+Different AI providers have varying levels of support for JSON Schema features. This package handles these differences automatically:
+
+- **OpenAI**: Removes certain string validations for models without structured outputs
+- **Anthropic**: Handles complex nested schemas with proper constraint descriptions
+- **Google**: Uses OpenAPI 3.0 schema format for better compatibility
+- **DeepSeek**: Converts advanced string patterns to descriptions
+- **Meta**: Optimizes array and union type handling
+
+## Testing
+
+The package includes comprehensive tests covering all functionality:
+
+```bash
+# Run tests
+pnpm test
+
+# Run tests in watch mode
+pnpm test --watch
+```
+
+## License
+
+Elastic-2.0