Merge pull request #24 from firefliesai/feature-sc-93154-add-date-type-support-with-string-format-date

Author: greguintow

README.md

@@ -24,6 +24,7 @@ Schema Forge is a powerful TypeScript library that transforms your TypeScript cl
     - [Structured Output Formatting](#structured-output-formatting)
     - [Property Overrides](#property-overrides)
     - [Nested Objects and Arrays](#nested-objects-and-arrays)
+    - [Class-Validator Integration](#class-validator-integration)
     - [Using TypeScript Enums](#using-typescript-enums)
     - [Dynamic Schema Updates](#dynamic-schema-updates)
     - [Using Direct JSON Schema Converters](#using-direct-json-schema-converters)
@@ -67,6 +68,7 @@ Schema Forge is a powerful TypeScript library that transforms your TypeScript cl
 - 📝 Built-in structured output formatting for various LLM providers
 - 📦 TypeScript-first with full type safety and inference
 - 🪶 Lightweight with minimal dependencies (only requires reflect-metadata)
+- 🔗 Automatic class-validator integration: infers JSON Schema constraints from validation decorators when used
 
 ## Who Should Use This Library?
 
@@ -496,6 +498,87 @@ Schema Forge uses TypeScript's reflection capabilities to automatically infer mo
 
 All other primitive types (string, number, boolean) and custom classes are automatically inferred without additional type specification.
 
+### Class-Validator Integration
+
+If you're using [class-validator](https://github.com/typestack/class-validator) decorators in your project, Schema Forge will automatically infer JSON Schema constraints from them. This means you can define validation rules once and have them reflected in your generated schemas.
+
+Supported class-validator decorators:
+
+| Decorator | JSON Schema Property |
+|-----------|---------------------|
+| `@ArrayMaxSize(n)` | `maxItems: n` |
+| `@ArrayMinSize(n)` | `minItems: n` |
+| `@ArrayUnique()` | `uniqueItems: true` |
+| `@ArrayNotEmpty()` | `minItems: 1` |
+| `@Max(n)` | `maximum: n` |
+| `@Min(n)` | `minimum: n` |
+| `@IsInt()` | `type: 'integer'` |
+| `@MinLength(n)` | `minLength: n` |
+| `@MaxLength(n)` | `maxLength: n` |
+| `@IsUrl()` | `format: 'uri'` |
+| `@IsEmail()` | `format: 'email'` |
+| `@IsPositive()` | `minimum: 1` |
+
+Example:
+
+```typescript
+import { ToolProp } from '@firefliesai/schema-forge';
+import { Min, Max, IsInt, MinLength, MaxLength, IsUrl, IsPositive } from 'class-validator';
+
+class ProductInput {
+  @ToolProp({ description: 'Product name' })
+  @MinLength(2)
+  @MaxLength(100)
+  name: string;
+
+  @ToolProp({ description: 'Product price in cents' })
+  @IsInt()
+  @IsPositive()
+  price: number;
+
+  @ToolProp({ description: 'Stock quantity' })
+  @Min(0)
+  @Max(10000)
+  quantity: number;
+
+  @ToolProp({ description: 'Product page URL' })
+  @IsUrl()
+  url: string;
+}
+
+// The generated schema will include the constraints:
+// {
+//   properties: {
+//     name: { type: 'string', minLength: 2, maxLength: 100, ... },
+//     price: { type: 'integer', minimum: 1, ... },
+//     quantity: { type: 'number', minimum: 0, maximum: 10000, ... },
+//     url: { type: 'string', format: 'uri', ... }
+//   }
+// }
+```
+
+You can also specify these constraints directly in `@ToolProp` options without using class-validator:
+
+```typescript
+class ProductInput {
+  @ToolProp({ 
+    description: 'Product name',
+    minLength: 2,
+    maxLength: 100
+  })
+  name: string;
+
+  @ToolProp({ 
+    description: 'Product price in cents',
+    type: 'integer',
+    minimum: 1
+  })
+  price: number;
+}
+```
+
+When both class-validator decorators and explicit `@ToolProp` options are present, the explicit options take precedence.
+
 ### Using TypeScript Enums
 
 Schema Forge works well with native TypeScript enums:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@firefliesai/schema-forge",
-  "version": "1.0.4",
+  "version": "2.0.0",
   "main": "dist/lib/index.js",
   "types": "dist/lib/index.d.ts",
   "exports": {
@@ -78,6 +78,7 @@
     "@google/generative-ai": "^0.24.0",
     "@types/jest": "^29.5.14",
     "@types/reflect-metadata": "^0.0.5",
+    "class-validator": "^0.14.3",
     "env-cmd": "^10.1.0",
     "eslint": "^9.22.0",
     "eslint-config-prettier": "^10.1.1",