smart-auth-validator 1.0.0 → 1.0.1

package/README.md

@@ -26,3 +26,35 @@ Smart, type-safe, zero-regex validation middleware for Node.js backends. Support
 
 ```bash
 npm install smart-auth-validator
+
+
+Supported Fields
+The library currently supports a wide array of built-in validation rules. You can validate these fields by simply passing their keys:
+
+Category: Supported Fields
+Identity  "name, username, email, password"
+Contact   "phone, url"
+Address   "street, city, state, postalCode"
+Finance   "creditCard, cvv"
+General   "date, time, active (boolean)"
+
+Simple Usage
+To use Smart Auth Validator, simply define a schema with the fields you want to validate and pass your input data to the validate function.
+
+Basic 3-Field Example
+Even though the library supports 10+ fields, you can choose only the ones you need:
+
+import { validate } from "smart-auth-validator";
+const result = validate({ name: true, email: true, password: true }, req.body);
+
+
+Error Response Format
+If validation fails, you get a clean array explaining exactly what went wrong:
+
+REQUIRED: Field is missing.
+
+PATTERN: Invalid format (e.g., bad email).
+
+MIN_LENGTH: Input is too short.
+
+WEAK_PASSWORD: Password doesn't meet security standards.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smart-auth-validator",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Zero-regex, type-safe authentication and form validation for Fastify and Express",
   "author": "Muhammad Burhan Chughtai",
   "license": "MIT",
@@ -19,12 +19,12 @@
     "dist"
   ],
   "sideEffects": false,
- "scripts": {
-  "test": "vitest run",
-  "lint": "eslint src --max-warnings=0",
-  "build": "tsup",
-  "prepublishOnly": "npm run lint && npm run test && npm run build"
-},
+  "scripts": {
+    "test": "vitest run",
+    "lint": "eslint src --max-warnings=0",
+    "build": "tsup",
+    "prepublishOnly": "npm run lint && npm run test && npm run build"
+  },
   "peerDependencies": {
     "express": "^4.22.1",
     "fastify": "^4 || ^5"