Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/supendi/ts-validity
https://github.com/supendi/ts-validity
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/supendi/ts-validity
- Owner: supendi
- Created: 2024-03-21T06:52:55.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-13T00:41:27.000Z (7 months ago)
- Last Synced: 2024-09-16T15:48:49.685Z (2 months ago)
- Language: TypeScript
- Size: 354 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ts-validity
## Installation
```
npm install ts-validity # npm
yarn add ts-validity # yarn
```
## Usage
### Let's start with simple validation
Given interface
```typescript
interface Account {
name: string,
age: number,
email: string
}
```
Create the validation rule and validate the object
```typescript
import { objectValidator, ValidationRule, minNumber, required, emailAddress } from "ts-validity";
const validationRule: ValidationRule = {
name: [required("Account name is required.")],
age: [required(), minNumber(17, "Should be at least 17 years old.")],
email: [required(), emailAddress("Invalid email address")]
}
const account: Account = {
name: "",
age: 0,
email: ""
}
const validationResult = objectValidator.validate(account, validationRule)
// The above validationResult value:
// {
// message: "One or more validation errors occurred.",
// isValid: false,
// errors: {
// name: ["Account name is required."],
// age: ["This field is required.", "Should be at least 17 years old."],
// email: ["This field is required.", "Invalid email address"],
// }
// }
Notice that the validationResult.errors property, has the same property names as the account object, but its dataype is array of string.
```
### Nested object validation
```typescript
import { objectValidator, ValidationRule, minNumber, required, emailAddress } from "ts-validity";
interface Person {
name: string,
age: number,
child?: Person
address?: {
street: string,
city: {
name: string
country: {
name: string
continent: {
name: string
}
}
}
}
}
const rule: ValidationRule = {
name: [required()],
age: [minNumber(20)],
address: {
street: [required()],
city: {
name: [required()],
country: {
name: [required()],
continent: {
name: [required()],
}
}
}
},
child: {
name: [required()]
}
}
const john: Person = {
name: "",
age: 0,
address: {
street: "",
city: {
name: "",
country: {
name: "",
continent: {
name: ""
}
}
}
},
child: {
name: "",
age: 0,
}
}
const validationResult = objectValidator.validate(john, rule)
// validationResult = {
// message: defaultMessage.errorMessage,
// isValid: false,
// errors: {
// name: ["This field is required."],
// age: ["The minimum value for this field is 20."],
// address: {
// street: ["This field is required."],
// city: {
// name: ["This field is required."],
// country: {
// name: ["This field is required."],
// continent: {
// name: ["This field is required."],
// }
// }
// }
// },
// child: {
// name: ["This field is required."],
// }
// }
// }
```
### Validate array property
```typescript
import { objectValidator, ValidationRule, minNumber, required, emailAddress, arrayMinLen } from "ts-validity";
interface Product {
name?: string
units?: Unit[]
}
interface Unit {
name: string,
conversion: number,
}
const validationRule: ValidationRule = {
name: [required()],
units: {
validators: [arrayMinLen(3, "Product uom has to be at least 3 units.")],
validationRule: {
name: [required()],
conversion: [minNumber(1)]
}
}
}
const ironStick: Product = {
name: "",
units: [
{
name: "",
conversion: 0
},
{
name: "cm",
conversion: 0
}
]
}
const validationResult = objectValidator.validate(ironStick, validationRule)
// validationResult = {
// message: defaultMessage.errorMessage,
// isValid: false,
// errors: {
// name: ["This field is required."],
// units: {
// errors: ["Product uom has to be at least 3 units."],
// errorsEach: [
// {
// index: 0,
// errors: {
// name: ["This field is required."],
// conversion: ["The minimum value for this field is 1."]
// },
// validatedObject: {
// name: "",
// conversion: 0
// }
// },
// {
// index: 1,
// errors: {
// conversion: ["The minimum value for this field is 1."]
// },
// validatedObject: {
// name: "cm",
// conversion: 0
// }
// }
// ]
// }
// }
// }
```
## Custom Property Validator
To use your own validator, you can use the propertyValidator function.
The following is the signature of **propertyValidator** function:
```typescript
export declare const propertyValidator: (func: ValidateFunc, errorMessage: string, validatorDescription?: string) => PropertyValidator;
```
The existing built-in property validators, including the propertyValidator actually is a closure that returns a validate function, which is called by the objectValidator. The following is the signature of the **ValidateFunc**:
```typescript
export type ValidateFunc = (value: TValue, objRef?: TObject) => boolean
```
And this is the **PropertyValidator** type:
```typescript
export type PropertyValidator = {
description: string;
validate: ValidateFunc;
returningErrorMessage: string;
};
```
### Usage
```typescript
import { objectValidator, ValidationRule, propertyValidator } from "ts-validity";
interface Account {
name: string,
}
const validationRule: ValidationRule = {
name: [
// Name length minimum is 5 char
propertyValidator((value, object) => {
return value.length >= 5
}, "Name length minimum is 5 chars."),
// Must contain A letter
propertyValidator((value, object) => {
return value.toLocaleLowerCase().includes("a")
}, "Name must contain 'A' letter."),
],
}
const account: Account = {
name: "John",
}
const validationResult = objectValidator.validate(account, validationRule)
// validationResult = {
// message: "One or more validation errors occurred.",
// isValid: false,
// errors: {
// name: ["Name length minimum is 5 chars.", "Name must contain 'A' letter."]
// }
// }
```
## Use existing npm validator package as custom validator
We can use and combine the existing popular validator from npm. In this example I use the validator package (https://www.npmjs.com/package/validator).
### Installation
```typescript
npm install validator
npm install -D @types/validator // if typescript
```
### Usage
```typescript
import { objectValidator, ValidationRule, propertyValidator } from "ts-validity";
import validator from 'validator';
interface Account {
name: string,
email: string,
phone: string,
password: string
}
const validationRule: ValidationRule = {
name: [required()],
// Combine the built-in validator and the 'validator' package
email: [
required(),
propertyValidator((value, object) => {
return validator.isEmail(value) // the 'validator' package
}, "Not a valid email."),
],
phone: [
required(),
propertyValidator((value, object) => {
return validator.isMobilePhone(value, "en-AU") // the 'validator' package
}, "Should be an AU mobile phone number format"),
],
password: [
required(),
propertyValidator((value, object) => {
// the 'validator' package
return validator.isStrongPassword(value, {
minLength: 8,
minUppercase: 2
})
}, "Password should be 8 chars minimum, and has to contain at least 2 upper case."),
],
}
const account: Account = {
name: "John",
email: "valid@@email.com",
phone: "123123123",
password: "strongpassword"
}
const validationResult = objectValidator.validate(account, validationRule)
// validationResult = {
// message: "One or more validation errors occurred.",
// isValid: false,
// errors: {
// email: ["Not a valid email."],
// phone: ["Should be an AU mobile phone number format"],
// password: ["Password should be 8 chars minimum, and has to contain at least 2 upper case."]
// }
// }
```
## Available Built-in Property Validators
```typescript
export {
alphabetOnly,
arrayMaxLen,
arrayMinLen,
elementOf,
emailAddress,
equalToPropertyValue,
maxNumber,
minNumber,
maxSumOf,
minSumOf,
propertyValidator,
regularExpression,
required,
stringMaxLen,
stringMinLen,
}
```