snap-validate 0.3.1 → 0.3.2

package/README.md

@@ -11,19 +11,20 @@ A lightning-fast, lightweight validation library for common patterns without hea
 
 ## Features
 
-- ⚡ **Lightning Fast**: Optimized for speed and performance
-- 🚀 **Lightweight**: No external dependencies, minimal footprint
-- 🔧 **Flexible**: Chainable validation rules and custom validators
-- 📧 **Common Patterns**: Email, phone, credit card, URL, password validation
-- 🌍 **International**: Support for different formats (US/International phone, postal codes)
-- 🔄 **Async Support**: Full async validation support for database checks and API calls
-- 🎯 **Conditional**: Advanced conditional validation with `when()` and `optional()`
-- 🛠️ **Custom Validators**: Add your own sync and async validation logic
-- 🔒 **Security First**: Built-in protection against ReDoS attacks and unsafe regex patterns
-- 🛡️ **Timeout Protection**: Configurable timeout for regex operations to prevent DoS attacks
-- 🧪 **Well Tested**: Comprehensive test suite with high coverage
-- 📦 **Easy Integration**: Works in Node.js and browsers
-- 🔗 **Chainable API**: Intuitive fluent interface
+- ⚡ **Lightning Fast**: Optimized for speed and performance  
+- 🚀 **Lightweight**: No external dependencies, minimal footprint  
+- 🔧 **Flexible**: Chainable validation rules and custom validators  
+- 📧 **Common Patterns**: Email, phone, credit card, URL, password validation  
+- 🌍 **International**: Support for different formats (US/International phone, postal codes)  
+- 🔄 **Async Support**: Full async validation support for database checks and API calls  
+- 🎯 **Conditional**: Advanced conditional validation with `when()` and `optional()`  
+- 🛠️ **Custom Validators**: Add your own sync and async validation logic  
+- 🔒 **Security First**: Built-in protection against ReDoS attacks and unsafe regex patterns  
+- 🛡️ **Timeout Protection**: Configurable timeout for regex operations to prevent DoS attacks  
+- 🧪 **Well Tested**: Comprehensive test suite with high coverage  
+- 📦 **Easy Integration**: Works in Node.js and browsers  
+- 🔗 **Chainable API**: Intuitive fluent interface  
+- 📘 **TypeScript Support**: Complete TypeScript definitions with full IntelliSense support  
 
 ## Installation
 
@@ -31,6 +32,15 @@ A lightning-fast, lightweight validation library for common patterns without hea
 npm install snap-validate
 ```
 
+### TypeScript
+
+For TypeScript projects, types are included automatically:
+
+```bash
+npm install snap-validate
+# Types are included - no need for @types/snap-validate
+```
+
 ## Quick Start
 
 ```javascript
@@ -57,6 +67,52 @@ const result = validate(schema, data);
 console.log(result.isValid); // true
 ```
 
+## TypeScript Support
+
+Snap Validate includes comprehensive TypeScript definitions for enhanced developer experience:
+
+```typescript
+import { BaseValidator, validators, validate, ValidationResult } from 'snap-validate';
+
+// Full type safety and auto-completion
+const validator = new BaseValidator('test-value')
+  .required('This field is required')
+  .min(5, 'Must be at least 5 characters')
+  .pattern(/^[a-zA-Z]+$/, 'Only letters allowed');
+
+// Type-safe result handling
+const result: ValidationResult = validator.validate();
+
+// Schema validation with types
+interface UserData {
+  email: string;
+  phone: string;
+  password: string;
+}
+
+const userData: UserData = {
+  email: 'john@example.com',
+  phone: '1234567890',
+  password: 'StrongPass123'
+};
+
+const schema = {
+  email: validators.email,
+  phone: (value: string) => validators.phone(value, 'us'),
+  password: validators.password
+};
+
+const result = validate(schema, userData);
+```
+
+Features:
+
+- Complete type definitions for all classes and functions  
+- IntelliSense support in VS Code, WebStorm, and other editors  
+- Compile-time validation prevents common usage errors  
+- Generic support for flexible validation workflows  
+- Rich JSDoc comments for comprehensive documentation  
+
 ## Security Features
 
 ### ReDoS Protection
@@ -397,6 +453,14 @@ if (!unsafeResult.isValid) {
 - `validators.numeric(value)`
 - `validators.zipCode(value, country?)`
 
+### TypeScript Types
+
+- `ValidationResult` - Interface for validation results  
+- `ValidatorFunction` - Type for validator functions used in schemas  
+- `ValidationSchema` - Type for validation schema objects  
+- `PasswordOptions` - Interface for password validation configuration  
+- `BaseValidator<T>` - Generic base validator class
+
 ### Validation Functions
 
 - `validate(schema, data)` - Synchronous schema validation
@@ -448,6 +512,12 @@ npm run format
 
 # Security audit
 npm audit
+
+# Type checking (for TypeScript users)
+npm run type-check
+
+# Validate TypeScript definitions
+npm run validate-types
 ```
 
 ## License
@@ -460,4 +530,4 @@ See [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes.
 
 ---
 
-Made with ⚡ by [Ramachandra Anirudh Vemulapalli](https://github.com/aniru-dh21)
+Made with ⚡ by [Ramachandra Anirudh Vemulapalli](https://github.com/aniru-dh21)

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "snap-validate",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Lightweight validation library for common patterns without heavy dependencies",
   "main": "src/index.js",
   "types": "types/index.d.ts",
+  "typings": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "require": "./src/index.js",
+      "import": "./src/index.js"
+    }
+  },
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watch",
@@ -14,7 +22,12 @@
     "prepare": "husky install",
     "prepublishOnly": "npm test && npm run lint",
     "build": "echo 'No build step required for this library'",
-    "example": "node examples/basic-usage.js"
+    "example": "node examples/basic-usage.js",
+    "type-check": "tsc --noEmit",
+    "test-types": "tsc test-types.ts --noEmit",
+    "validate-types": "tsc --noEmit && echo 'TypeScript definitions are valid!'",
+    "lint-types": "eslint types/**/*.ts",
+    "check-exports": "node -e \"console.log(Object.keys(require('./src/index.js')))\""
   },
   "keywords": [
     "validation",

package/src/index.js

@@ -1,9 +1,8 @@
 /**
  * Snap Validate - Enhanced Lightweight validator library
- * @version 0.3.1 - Security Fixes
+ * @version 0.3.2 - Typescript Patch
  */
 
-// Utility function to safely test regex with timeout protection
 // Utility function to safely test regex with timeout protection
 const safeRegexTest = (regex, str, timeoutMs = 1000) => {
   return new Promise((resolve, reject) => {

package/types/index.d.ts

@@ -63,6 +63,7 @@ declare module 'snap-validate' {
     rules: Array<() => ValidationResult>;
     asyncRules: Array<() => Promise<ValidationResult>>;
     isOptional: boolean;
+    regexTimeout: number;
 
     /**
      * Make field required
@@ -74,6 +75,11 @@ declare module 'snap-validate' {
      */
     optional(): BaseValidator;
 
+    /**
+     * Set timeout for regex operations in milliseconds
+     */
+    setRegexTimeout(timeoutMs: number): BaseValidator;
+
     /**
      * Set minimum length/value
      */
@@ -85,10 +91,15 @@ declare module 'snap-validate' {
     max(length: number, message?: string): BaseValidator;
 
     /**
-     * Validate against regex pattern
+     * Validate against regex pattern (synchronous)
      */
     pattern(regex: RegExp, message?: string): BaseValidator;
 
+    /**
+     * Validate against regex pattern with timeout protection (asynchronous)
+     */
+    patternAsync(regex: RegExp, message?: string): BaseValidator;
+
     /**
      * Conditional validation
      */
@@ -177,4 +188,27 @@ declare module 'snap-validate' {
     schema: Schema,
     data: { [key: string]: any }
   ): Promise<SchemaValidationResult>;
+
+  /**
+   * Safely test regex with timeout protection (asynchronous)
+   */
+  export function safeRegexTest(
+    regex: RegExp,
+    str: string,
+    timeoutMs?: number
+  ): Promise<boolean>;
+
+  /**
+   * Safely test regex with input length protection (synchronous)
+   */
+  export function safeRegexTestSync(
+    regex: RegExp,
+    str: string,
+    maxLength?: number
+  ): boolean;
+
+  /**
+   * Check if a regex pattern is safe to use (ReDoS protection)
+   */
+  export function isRegexSafe(regex: RegExp): boolean;
 }