@oxog/vld 1.0.0

package/README.md

@@ -0,0 +1,776 @@
+# VLD - Fast, Type-Safe Validation Library
+
+[![npm version](https://img.shields.io/npm/v/@oxog/vld.svg)](https://www.npmjs.com/package/@oxog/vld)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
+[![Zero Dependencies](https://img.shields.io/badge/Dependencies-0-green.svg)](package.json)
+[![Test Coverage](https://img.shields.io/badge/Coverage-95%25-brightgreen.svg)](package.json)
+
+VLD is a blazing-fast, type-safe validation library for TypeScript and JavaScript with **full Zod feature parity**. Built with performance in mind, it provides a simple and intuitive API while maintaining excellent type inference and 27+ language internationalization support.
+
+## 🚀 Features
+
+### Core Features
+- **⚡ Blazing Fast**: Optimized for V8 engine with superior performance
+- **🎯 Type-Safe**: Full TypeScript support with excellent type inference  
+- **📦 Zero Dependencies**: Lightweight with no external dependencies
+- **🌳 Tree-Shakeable**: Only import what you need
+- **🔧 Composable**: Chain validations for complex schemas
+- **⚠️ Advanced Error Formatting**: Tree, pretty, and flatten error utilities
+- **🌍 Multi-language**: Built-in support for 27+ languages
+- **✅ 95% Test Coverage**: Rigorously tested with comprehensive test suite
+
+### Advanced Zod-Compatible Features  
+- **🔄 Type Coercion**: `v.coerce.string()`, `v.coerce.number()`, `v.coerce.boolean()`, etc.
+- **📊 Advanced Types**: BigInt, Symbol, Tuple, Record, Set, Map validation
+- **⚡ Intersection Types**: Combine multiple schemas with intelligent merging
+- **🎨 Custom Validation**: `refine()` for custom predicates and validation logic
+- **🔄 Data Transformation**: `transform()` for post-validation data transformation
+- **🏠 Default Values**: `default()` for handling undefined inputs elegantly  
+- **🛡️ Fallback Handling**: `catch()` for graceful error recovery
+- **🎯 Object Utilities**: `pick()`, `omit()`, `extend()` for flexible object schemas
+
+## 📊 Performance
+
+VLD is designed for speed. In our benchmarks:
+- **2.91x faster** than Zod for number validation
+- **3.70x faster** for boolean validation
+- **3.47x faster** for array validation
+- **2.30x faster** for email validation
+
+### 🎭 The Truth About Zod's Benchmarks
+
+Many validation library benchmarks are misleading because they test with **reused schema instances**:
+
+```javascript
+// What benchmarks typically test (unrealistic):
+const schema = z.string();
+for (let i = 0; i < 1000000; i++) {
+  schema.parse(data); // Same instance reused
+}
+
+// What happens in real applications:
+app.post('/api/user', (req, res) => {
+  // New schema created for each request
+  const schema = z.object({
+    email: z.string().email(),
+    age: z.number().min(18)
+  });
+  schema.parse(req.body);
+});
+```
+
+When testing real-world patterns:
+- **Creating new instances**: VLD is **2000x faster** than Zod
+- **Reused instances**: Zod benefits from V8's singleton optimization
+- **Real applications**: Schemas are often created dynamically, where VLD excels
+
+Run `npm run benchmark:truth` to see the real performance difference.
+
+## 📦 Installation
+
+```bash
+npm install @oxog/vld
+# or
+yarn add @oxog/vld
+# or
+pnpm add @oxog/vld
+```
+
+## 🎯 Quick Start
+
+```typescript
+import { v } from '@oxog/vld';
+
+// Define a schema
+const userSchema = v.object({
+  name: v.string().min(2),
+  email: v.string().email(),
+  age: v.number().min(18).max(100),
+  isActive: v.boolean()
+});
+
+// Validate data
+const result = userSchema.safeParse({
+  name: 'John Doe',
+  email: 'john@example.com',
+  age: 25,
+  isActive: true
+});
+
+if (result.success) {
+  console.log('Valid user:', result.data);
+} else {
+  console.log('Validation error:', result.error);
+}
+```
+
+For advanced error formatting:
+```typescript
+import { v, VldError, treeifyError, prettifyError, flattenError } from '@oxog/vld';
+```
+
+## 📖 API Reference
+
+### Basic Types
+
+```typescript
+v.string()    // String validation
+v.number()    // Number validation  
+v.boolean()   // Boolean validation
+v.bigint()    // BigInt validation
+v.symbol()    // Symbol validation
+v.date()      // Date validation
+v.literal()   // Literal values
+v.enum()      // Enum values
+v.any()       // Any type
+v.unknown()   // Unknown type  
+v.void()      // Void type
+v.never()     // Never type
+```
+
+### Advanced Types
+
+```typescript
+// Collections
+v.array(v.string())                    // Array validation
+v.tuple(v.string(), v.number())        // Fixed-length tuple
+v.record(v.number())                   // Record/dictionary validation
+v.set(v.string())                      // Set validation
+v.map(v.string(), v.number())          // Map validation
+
+// Objects
+v.object({                             // Object schema
+  name: v.string(),
+  age: v.number()  
+})
+
+// Composition
+v.union(v.string(), v.number())        // Union types
+v.intersection(schemaA, schemaB)       // Intersection types
+v.optional(v.string())                 // Optional fields
+v.nullable(v.string())                 // Nullable fields
+```
+
+### String Validators
+
+```typescript
+v.string()
+  .min(5)                    // Minimum length
+  .max(10)                   // Maximum length
+  .length(8)                 // Exact length
+  .email()                   // Email format
+  .url()                     // URL format
+  .uuid()                    // UUID format
+  .regex(/pattern/)          // Custom regex
+  .startsWith('prefix')      // String prefix
+  .endsWith('suffix')        // String suffix
+  .includes('substring')     // Contains substring
+  .ip()                      // IP address (v4 or v6)
+  .trim()                    // Trim whitespace
+  .toLowerCase()             // Convert to lowercase
+  .toUpperCase()             // Convert to uppercase
+  .nonempty()               // Non-empty string
+```
+
+### Number Validators
+
+```typescript
+v.number()
+  .min(0)                    // Minimum value
+  .max(100)                  // Maximum value
+  .int()                     // Integer only
+  .positive()                // Positive numbers
+  .negative()                // Negative numbers
+  .nonnegative()            // >= 0
+  .nonpositive()            // <= 0
+  .finite()                  // Finite numbers
+  .safe()                    // Safe integers
+  .multipleOf(5)            // Multiple of value
+```
+
+### Arrays and Objects
+
+```typescript
+// Arrays
+v.array(v.string())          // Array of strings
+  .min(1)                    // Minimum length
+  .max(10)                   // Maximum length
+  .length(5)                 // Exact length
+  .nonempty()               // Non-empty array
+
+// Objects
+v.object({
+  name: v.string(),
+  age: v.number()
+})
+  .partial()                 // All fields optional
+  .strict()                  // No extra fields
+```
+
+### Composite Types
+
+```typescript
+// Optional
+v.optional(v.string())       // string | undefined
+
+// Nullable
+v.nullable(v.string())       // string | null
+
+// Union
+v.union(v.string(), v.number()) // string | number
+
+// Literal
+v.literal('active')          // 'active'
+
+// Enum
+v.enum('red', 'green', 'blue') // 'red' | 'green' | 'blue'
+```
+
+### Type Coercion
+
+```typescript
+// Coerce strings from various types
+v.coerce.string().parse(123)        // "123"
+v.coerce.string().parse(true)       // "true"
+
+// Coerce numbers from strings/booleans  
+v.coerce.number().parse("123")      // 123
+v.coerce.number().parse(true)       // 1
+
+// Coerce booleans from strings/numbers
+v.coerce.boolean().parse("true")    // true
+v.coerce.boolean().parse(1)         // true
+
+// Coerce BigInt from strings/numbers
+v.coerce.bigint().parse("123")      // 123n
+v.coerce.bigint().parse(456)        // 456n
+
+// Coerce Date from strings/timestamps
+v.coerce.date().parse("2023-01-01") // Date object
+v.coerce.date().parse(1672531200000) // Date object
+```
+
+### Object Schema Methods
+
+```typescript
+const userSchema = v.object({
+  name: v.string(),
+  age: v.number(),
+  email: v.string(),
+  role: v.string()
+});
+
+// Pick specific fields
+const publicSchema = userSchema.pick('name', 'age');
+// Type: { name: string; age: number }
+
+// Omit sensitive fields  
+const safeSchema = userSchema.omit('email', 'role');
+// Type: { name: string; age: number }
+
+// Extend with new fields
+const extendedSchema = userSchema.extend({
+  isActive: v.boolean(),
+  lastLogin: v.date()
+});
+// Type: { name: string; age: number; email: string; role: string; isActive: boolean; lastLogin: Date }
+```
+
+### Advanced Validation Methods
+
+```typescript
+// Custom validation with refine()
+const positiveNumber = v.number()
+  .refine(n => n > 0, "Number must be positive");
+
+// Data transformation with transform()  
+const uppercaseString = v.string()
+  .transform(s => s.toUpperCase());
+
+// Default values for undefined
+const withDefault = v.string().default("fallback");
+withDefault.parse(undefined); // "fallback"
+
+// Catch errors and provide fallback
+const withCatch = v.number().catch(-1);
+withCatch.parse("invalid"); // -1
+
+// Method chaining
+const complexSchema = v.string()
+  .min(3)
+  .transform(s => s.trim())
+  .refine(s => s.includes('@'), 'Must contain @')
+  .default('user@example.com');
+```
+
+### Type Inference
+
+```typescript
+import { v, Infer } from '@oxog/vld';
+
+const schema = v.object({
+  name: v.string(),
+  age: v.number()
+});
+
+// Automatically infer the type
+type User = Infer<typeof schema>;
+// { name: string; age: number }
+```
+
+### Error Formatting Types
+
+```typescript
+import { 
+  VldError,           // Main error class
+  VldIssue,           // Individual validation issue
+  VldErrorTree,       // Nested error structure
+  VldFlattenedError   // Flattened error structure
+} from '@oxog/vld';
+```
+
+### Custom Error Messages
+
+```typescript
+const schema = v.string().min(8, 'Password must be at least 8 characters');
+
+const result = schema.safeParse('short');
+if (!result.success) {
+  console.log(result.error.message); // 'Password must be at least 8 characters'
+}
+```
+
+## 🌍 Internationalization (i18n)
+
+VLD supports 27+ languages out of the box with comprehensive error messages:
+
+```typescript
+import { v, setLocale } from '@oxog/vld';
+
+// Default is English
+const schema = v.string().min(5);
+schema.safeParse('Hi'); // Error: "String must be at least 5 characters"
+
+// Switch to Turkish
+setLocale('tr');
+schema.safeParse('Hi'); // Error: "Metin en az 5 karakter olmalı"
+
+// Switch to Spanish
+setLocale('es');
+schema.safeParse('Hi'); // Error: "La cadena debe tener al menos 5 caracteres"
+
+// Switch to Japanese
+setLocale('ja');
+schema.safeParse('Hi'); // Error: "文字列は5文字以上である必要があります"
+```
+
+### Supported Languages
+
+#### Base Languages (15):
+- 🇬🇧 English (`en`) - 🇹🇷 Turkish (`tr`) - 🇪🇸 Spanish (`es`) - 🇫🇷 French (`fr`) - 🇩🇪 German (`de`)
+- 🇮🇹 Italian (`it`) - 🇵🇹 Portuguese (`pt`) - 🇷🇺 Russian (`ru`) - 🇯🇵 Japanese (`ja`) - 🇰🇷 Korean (`ko`)
+- 🇨🇳 Chinese (`zh`) - 🇸🇦 Arabic (`ar`) - 🇮🇳 Hindi (`hi`) - 🇳🇱 Dutch (`nl`) - 🇵🇱 Polish (`pl`)
+
+#### European Languages (4):
+- 🇩🇰 Danish (`da`) - 🇸🇪 Swedish (`sv`) - 🇳🇴 Norwegian (`no`) - 🇫🇮 Finnish (`fi`)
+
+#### Asian Languages (4):
+- 🇹🇭 Thai (`th`) - 🇻🇳 Vietnamese (`vi`) - 🇮🇩 Indonesian (`id`) - 🇧🇩 Bengali (`bn`)
+
+#### African Languages (2):
+- 🇰🇪 Swahili (`sw`) - 🇿🇦 Afrikaans (`af`)
+
+#### American Languages (2):
+- 🇧🇷 Portuguese Brazil (`pt-BR`) - 🇲🇽 Spanish Mexico (`es-MX`)
+
+**Plus 75+ additional languages** supported through comprehensive type definitions with English fallback, including Icelandic, Czech, Slovak, Hungarian, Romanian, Bulgarian, Croatian, Slovenian, Greek, Hebrew, Persian, Georgian, Armenian, and many more!
+
+## ⚠️ Error Handling & Formatting
+
+VLD provides advanced error formatting utilities similar to Zod's error handling system. These utilities help you transform validation errors into user-friendly formats for different use cases.
+
+### Error Formatting Utilities
+
+```typescript
+import { v, VldError, treeifyError, prettifyError, flattenError } from '@oxog/vld';
+
+const userSchema = v.object({
+  username: v.string().min(3),
+  favoriteNumbers: v.array(v.number()),
+  profile: v.object({
+    name: v.string(),
+    email: v.string().email()
+  })
+});
+
+// This will fail validation
+const result = userSchema.safeParse({
+  username: 'ab', // too short
+  favoriteNumbers: [1, 'two', 3], // 'two' is not a number
+  profile: {
+    name: '',
+    email: 'invalid-email'
+  },
+  extraField: 'not allowed'
+});
+
+if (!result.success) {
+  const error = result.error as VldError;
+  
+  // 1. Tree Format - Nested structure for complex UIs
+  const tree = treeifyError(error);
+  console.log(tree);
+  /*
+  {
+    errors: ['Unrecognized key: "extraField"'],
+    properties: {
+      username: { errors: ['String must be at least 3 characters'] },
+      favoriteNumbers: {
+        items: [
+          undefined,
+          { errors: ['Expected number, received string'] },
+          undefined
+        ]
+      },
+      profile: {
+        properties: {
+          name: { errors: ['String cannot be empty'] },
+          email: { errors: ['Invalid email format'] }
+        }
+      }
+    }
+  }
+  */
+  
+  // 2. Pretty Format - Human-readable console output
+  const pretty = prettifyError(error);
+  console.log(pretty);
+  /*
+  ✖ Unrecognized key: "extraField"
+  ✖ String must be at least 3 characters
+    → at username
+  ✖ Expected number, received string
+    → at favoriteNumbers[1]
+  ✖ String cannot be empty
+    → at profile.name
+  ✖ Invalid email format
+    → at profile.email
+  */
+  
+  // 3. Flatten Format - Simple form validation
+  const flattened = flattenError(error);
+  console.log(flattened);
+  /*
+  {
+    formErrors: ['Unrecognized key: "extraField"'],
+    fieldErrors: {
+      username: ['String must be at least 3 characters'],
+      favoriteNumbers: ['Expected number, received string'],
+      profile: ['String cannot be empty', 'Invalid email format']
+    }
+  }
+  */
+}
+```
+
+### Using Error Formats in Practice
+
+#### React Form Validation
+```typescript
+function UserForm() {
+  const [errors, setErrors] = useState<VldFlattenedError | null>(null);
+  
+  const handleSubmit = (data: unknown) => {
+    const result = userSchema.safeParse(data);
+    
+    if (!result.success) {
+      setErrors(flattenError(result.error as VldError));
+    } else {
+      setErrors(null);
+      // Process valid data
+    }
+  };
+  
+  return (
+    <form onSubmit={handleSubmit}>
+      {errors?.formErrors.map(error => (
+        <div key={error} className="form-error">{error}</div>
+      ))}
+      
+      <input name="username" />
+      {errors?.fieldErrors.username?.map(error => (
+        <div key={error} className="field-error">{error}</div>
+      ))}
+    </form>
+  );
+}
+```
+
+#### API Error Responses
+```typescript
+app.post('/api/users', (req, res) => {
+  const result = userSchema.safeParse(req.body);
+  
+  if (!result.success) {
+    const tree = treeifyError(result.error as VldError);
+    res.status(400).json({
+      error: 'Validation failed',
+      details: tree
+    });
+  } else {
+    // Process valid user data
+  }
+});
+```
+
+#### Console Debugging
+```typescript
+function validateAndLog(data: unknown) {
+  const result = userSchema.safeParse(data);
+  
+  if (!result.success) {
+    console.log('Validation failed:');
+    console.log(prettifyError(result.error as VldError));
+  }
+}
+```
+
+## 🔥 Advanced Examples
+
+### Complex Validation with New Features
+
+```typescript
+const postSchema = v.object({
+  id: v.union(v.string().uuid(), v.number()),
+  title: v.string().min(5).max(100),
+  content: v.string().min(10),
+  author: v.object({
+    name: v.string(),
+    email: v.string().email(),
+    age: v.coerce.number(), // Auto-convert to number
+  }),
+  tags: v.set(v.string()).default(new Set()), // Use Set instead of array
+  metadata: v.record(v.any()), // Key-value metadata
+  coordinates: v.tuple(v.number(), v.number()), // [lat, lng]
+  publishedAt: v.date().default(() => new Date()),
+  status: v.enum('draft', 'published', 'archived')
+});
+
+// Extend with additional fields
+const blogPostSchema = postSchema.extend({
+  viewCount: v.bigint().default(0n),
+  categories: v.array(v.string()).min(1),
+  featured: v.boolean().default(false)
+});
+
+// Create a public version without sensitive data
+const publicPostSchema = blogPostSchema
+  .omit('author')
+  .extend({
+    authorName: v.string()
+  });
+```
+
+### Advanced Transformations & Validation
+
+```typescript
+// Complex email processing with coercion and transformation
+const emailSchema = v.coerce.string()
+  .transform(s => s.toLowerCase().trim())
+  .refine(s => s.includes('@'), 'Must be valid email format')
+  .transform(s => s.replace(/\+.*@/, '@')) // Remove plus addressing
+  .catch('invalid@example.com');
+
+// Process user input with fallbacks
+const userInputSchema = v.object({
+  name: v.coerce.string()
+    .transform(s => s.trim())
+    .refine(s => s.length > 0, 'Name cannot be empty')
+    .default('Anonymous'),
+  
+  age: v.coerce.number()
+    .refine(n => n >= 0 && n <= 150, 'Age must be realistic')
+    .catch(0),
+    
+  preferences: v.record(v.any()).default({}),
+  
+  tags: v.union(
+    v.array(v.string()),
+    v.coerce.string().transform(s => s.split(','))
+  ).default([])
+});
+
+// Intersection for combining user types
+const baseUser = v.object({
+  id: v.string(),
+  name: v.string()
+});
+
+const adminUser = v.object({
+  role: v.literal('admin'),
+  permissions: v.array(v.string())
+});
+
+const adminSchema = v.intersection(baseUser, adminUser);
+```
+
+### Collection Validation
+
+```typescript
+// Advanced tuple validation
+const coordinatesSchema = v.tuple(
+  v.number().min(-90).max(90),    // latitude
+  v.number().min(-180).max(180),  // longitude
+  v.number().positive().optional() // altitude
+);
+
+// Map validation for configuration
+const configSchema = v.map(
+  v.string().min(1), // keys must be non-empty strings
+  v.union(v.string(), v.number(), v.boolean()) // values can be mixed types
+);
+
+// Set validation for unique tags
+const uniqueTagsSchema = v.set(v.string().min(1).max(20))
+  .refine(tags => tags.size <= 10, 'Too many tags');
+```
+
+### Real-world API Schema
+
+```typescript
+// Complete API endpoint schema with all features
+const apiUserSchema = v.object({
+  // Basic info with coercion
+  id: v.coerce.string(),
+  username: v.string()
+    .min(3)
+    .max(20)
+    .refine(s => /^[a-zA-Z0-9_]+$/.test(s), 'Invalid username format'),
+  
+  email: v.coerce.string()
+    .transform(s => s.toLowerCase().trim())
+    .refine(s => s.includes('@'), 'Invalid email'),
+    
+  // Age with fallback
+  age: v.coerce.number()
+    .min(13)
+    .max(120)
+    .catch(null),
+    
+  // Preferences as key-value store
+  preferences: v.record(v.any()).default({}),
+  
+  // Roles as a set for uniqueness
+  roles: v.set(v.enum('user', 'admin', 'moderator'))
+    .default(new Set(['user'])),
+    
+  // Metadata with BigInt support
+  createdAt: v.coerce.date(),
+  userId: v.coerce.bigint(),
+  
+  // Optional complex nested data
+  profile: v.object({
+    bio: v.string().max(500).default(''),
+    location: v.tuple(v.number(), v.number()).optional(),
+    socialLinks: v.record(v.string().url()).default({})
+  }).optional()
+});
+
+// Specialized schemas using pick/omit
+const publicUserSchema = apiUserSchema.pick('username', 'profile');
+const adminUserSchema = apiUserSchema.extend({
+  adminNotes: v.string().optional(),
+  lastLogin: v.date().optional()
+});
+```
+
+### Type-Safe Forms
+
+```typescript
+const loginSchema = v.object({
+  username: v.string().min(3),
+  password: v.string().min(8),
+  rememberMe: v.optional(v.boolean())
+});
+
+type LoginForm = Infer<typeof loginSchema>;
+
+function handleLogin(data: unknown) {
+  const result = loginSchema.safeParse(data);
+  
+  if (result.success) {
+    // data is now typed as LoginForm
+    const { username, password, rememberMe } = result.data;
+    // ... handle login
+  } else {
+    // Handle validation errors
+    console.error(result.error);
+  }
+}
+```
+
+## 🎯 Why VLD?
+
+### 🚀 Full Zod Feature Parity + More
+VLD provides **complete Zod compatibility** with all advanced features including coercion, intersections, transformations, and object utilities - plus unique features like 27+ language internationalization.
+
+### ⚡ Performance First
+VLD is built from the ground up with performance in mind. Every line of code is optimized for the V8 engine, resulting in validation that doesn't slow down your application.
+
+### 🌍 Internationalization Leader
+The **only** major validation library with built-in support for 27+ languages. Perfect for global applications requiring localized error messages.
+
+### 🎯 Real-World Testing  
+Our benchmarks test real-world scenarios, not just synthetic loops. VLD excels where it matters: in actual applications where schemas are created dynamically.
+
+### 👨‍💻 Exceptional Developer Experience
+- **Full TypeScript integration** with perfect type inference
+- **Intuitive Zod-compatible API** for easy migration
+- **Advanced error formatting** with tree, pretty, and flatten utilities  
+- **95% test coverage** ensuring reliability
+- **Comprehensive documentation** with real-world examples
+
+### 📦 Zero Dependencies  
+No dependencies means smaller bundle size, fewer security concerns, and better maintainability.
+
+### 🔄 Migration Ready
+Drop-in replacement for Zod with enhanced features:
+```typescript
+// Zod syntax works perfectly
+const schema = v.object({
+  name: v.string(),
+  age: v.number()
+}).refine(data => data.age > 0);
+
+// Plus VLD enhancements
+schema.extend({ email: v.string().email() })
+      .pick('name', 'email')  
+      .catch({ name: 'Unknown', email: 'no-email@example.com' });
+```
+
+## 📈 Benchmarks
+
+Run the benchmarks yourself:
+
+```bash
+# Standard performance comparison
+npm run benchmark
+
+# Real-world performance test (reveals the truth about benchmarks)
+npm run benchmark:truth
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 🔗 Links
+
+- [NPM Package](https://www.npmjs.com/package/@oxog/vld)
+- [GitHub Repository](https://github.com/ersinkoc/vld)
+- [Documentation](https://github.com/ersinkoc/vld#readme)
+
+---
+
+Made with ❤️ by Ersin KOÇ