Validata-JSTS is a lightweight rule-based validation library for JavaScript/TypeScript. You can define flexible and powerful validation rules using strings or schema objects, including support for custom rules, nested fields, ObjectIds, arrays, and more.
- ✅ Rule-based string validation
- ✅ Schema-based validation using
validateWithSchema - ✅ Auto-rule extraction from Mongoose schemas via
extractRulesFromSchema - ✅ Support for:
string,number,boolean,email,pwd,array,date,objectid - ✅ Custom error messages per rule
- ✅ Optional fields
- ✅ Nested field support (dot notation)
- ✅ Extendable with custom rules via
extend
npm install validata-jstsimport { isInValiData } from "validata-jsts";
const rules = [
"name-string-min3-max20",
"email-email",
"age-number-min18-max99",
"password-pwd-min8",
"bio-string-optional"
];
const data = {
name: "Abraham",
email: "abraham@example.com",
age: 25,
password: "StrongPass123!"
};
const result = isInValiData(rules, data);
if (result) {
console.log("❌ Validation errors:", result);
} else {
console.log("✅ Passed validation");
}const rule = {
name: "string-min3-max30",
email: "email",
age: "number-min18",
password: "pwd-min8",
bio: "string-optional"
};
const data = {
name: "Abraham",
email: "abraham@example.com",
age: 25,
password: "StrongPass123!"
};
const result = isInValiData(rules, data);
if (result) {
console.log("❌ Validation errors:", result);
} else {
console.log("✅ Passed validation");
}fieldName-type-rule1-rule2-err:Custom error
| Type | Description |
|---|---|
| string | Text fields |
| number | Numeric fields |
| boolean | True/false values |
| Valid email address | |
| pwd | Strong password (custom rules) |
| date | Date string in YYYY-MM-DD |
| objectid | Valid MongoDB ObjectId |
| array | Generic array support |
Use optional to allow a field to be skipped:
"bio-string-optional"Use err: or valerr: to specify your own messages:
"email-email-err:Invalid email address"
"password-pwd-min8-valerr:Password too weak"import { validateWithSchema } from "validata-jsts";
import { Schema, validateWithSchema } from "validata-jsts";
const schema = new Schema({
name: { type: "string", min: 3, max: 30 },
email: { type: "email" },
age: { type: "number", min: 18 },
password: { type: "pwd", min: 8 },
bio: { type: "string"}
});
const data = {
name: "John",
email: "john@example.com",
age: 22,
password: "StrongPass1!"
};
const result = validateWithSchema(schema, data);
console.log(result)
//Output
falseimport mongoose from "mongoose";
import { extractRulesFromSchema } from "validata-jsts";
const schema = new mongoose.Schema({
name: { type: String, required: true },
email: { type: String },
password: { type: String, required: true },
profile: {
age: { type: Number, min: 16, required: true },
bio: { type: String, maxlength: 400 }
},
userId: { type: mongoose.Schema.Types.ObjectId, ref: 'User', required: true },
});
const rules = extractRulesFromSchema(schema);
// Output:
[
"name-string-req",
"email-email",
"password-pwd-req",
"profile.age-number-req-min16",
"profile.bio-string-max400",
"userId-objectid-req"
]import { extend, isInValiData } from "validata-jsts";
extend("startsWith", (value, expected) => {
if (typeof value !== "string") return "Must be a string";
if (!value.startsWith(expected)) return `Must start with ${expected}`;
return null;
});
const rules = ["username-string-startsWith:dev"];
const data = { username: "devAbraham" };
const result = isInValiData(rules, data);extend("naPhone", (value) => {
if (!/^(\+234|0)[789][01]\d{8}$/.test(value)) {
return "Invalid Nigerian phone number";
}
return null;
});
const rules = ["phone-naPhone-err:Provide a valid Nigerian number"];// type can be imported : ValidatorFn incase
import { extend, ValidatorFn } from "validata-jsts";
// default config from user
const minLengthCheck: ValidatorFn = (value, _, config = { min: 5 }) => {
if (value.length < config.min) {
return `{Value} is less than the minimum length of ${config.min}`;
}
return null;
};
extend("equal", (value, cond, config) => minLengthCheck(value, cond, { min: 10 }));
const rules = ["phone-equal"];
const value ={ idNumber :"abmercy"};
const result = isInValidata(rules, value)
console.log(result);
// Output: "phone: value is less than the minimum length of 5You can go as far as attaching your equating value to the name and then extract it... from the condition props
// if its a number and your fucntion name length equal is of length 4 your substring value will be 4
const condValue = Number.parseInt(conditions[0].substring(4)) // if condition is one or y
8000
ou map it// then you can validata your value against the condition, you should have your extend function like this
const minLengthCheck: ValidatorFn = (value, conditions, config = { min: 5 }) =>{
// your validation here logic here
}Then pass it into your rule and we will take care of that 🌝
const rule = ["name-equalAbraham"]
// we will take it from there."name-string-min3-max50"
"key-string-16" //must be exactly 8 character long "age-number-min18-max60"
"packs-number-8" //must be exactly equal to 8 "isAdmin-boolean""email-email""password-pwd-min8"Password must include:
- At least one uppercase letter
- At least one lowercase letter
- At least one digit
- At least one special character
"birthdate-date-min1990_01_01-max2020_12_31""userId-objectid""tags-array"- ❌ No strict nested array typing like
array<{ name: string }>- coming soon - ❌ Conditional rules (
if:field=value) - coming soon - ❌ Rule negation using
!prefix (for rule strings) - coming soon - ❌ File/media validation - coming soon
const rule = {
name: "string-min3-max30",
email: "email",
password: "pwd-min8",
confirmPassword: "string-equal:Password123!",
acceptTerms: "boolean"
};
const input = {
name: "Jane Doe",
email: "jane@example.com",
password: "Password123!",
confirmPassword: "Password123!",
acceptTerms: true
};
const result = isInValiData(rule, input);const rule = [
"name-string-min3-max30",
"email-email",
"password-pwd-max18",
"confirmPassword-pwd-max18",
"acceptTerms-boolean"
];
const input = {
name: "Jane Doe",
email: "jane@example.com",
password: "Password123!",
confirmPassword: "Password123!",
acceptTerms: true
};
const result = isInValiData(rule, input);- Fork this repository
- Create a branch:
git checkout -b feature-name - Make your changes
- Push and create a Pull Request
This project is licensed under the MIT License
Coming soon: conditional rules, nested object arrays, and media validation support.
.