Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rstgroup/form-schema-validation
Schema for form validation
https://github.com/rstgroup/form-schema-validation
javascript react
Last synced: 27 days ago
JSON representation
Schema for form validation
- Host: GitHub
- URL: https://github.com/rstgroup/form-schema-validation
- Owner: rstgroup
- License: mit
- Created: 2017-02-08T21:10:39.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-22T06:19:25.000Z (about 1 year ago)
- Last Synced: 2024-04-25T04:02:42.207Z (8 months ago)
- Topics: javascript, react
- Language: JavaScript
- Size: 2.25 MB
- Stars: 14
- Watchers: 6
- Forks: 11
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FORM SCHEMA VALIDATION
[](https://travis-ci.org/rstgroup/form-schema-validation)
[](https://coveralls.io/github/rstgroup/form-schema-validation?branch=master)
[](https://npmjs.org/package/form-schema-validation)
[](https://npmjs.org/package/form-schema-validation)
1. [Features](#features)
1. [Installation](#installation)
1. [How to use](#how-to-use)
1. [Constructor](#constructor)
1. [Methods](#methods)
1. [Types](#types)
1. [Example of custom validator](#example-of-custom-validator)
1. [Example of additional validator](#example-of-additional-validator)
1. [Example of Schema definition](#example-of-schema-definition)
1. [Example of schema in schema](#example-of-schema-in-schema)
1. [Schema keys description](#schema-keys-description)
1. [Custom validation messages](#custom-validation-messages)
1. [Switch of keys validation](#switch-of-keys-validation)
### Features
- sync validation
- async validation (Promise)
- validate object structure
- validate object keys
- validate required fields
- validate optional fields
- validate by type
- validate by custom type
- validate by one of type
- validate field by custom validators
- validate fields relations by custom validators
- validate whole object tree by custom additional validators
### Installation
```bash
$ npm install form-schema-validation --save
```
### How to use
Schema give you posibility to validate object using schema validation. You can defined schema and use validate method to check object. Validate method allways returns errors object but if You don't have errors object is empty so You can check errors by
```js
import Schema from 'form-schema-validation';
const schema = new Schema({
companyName: {
type: String
}
});
const modelObject = {
companyName: 'Test Company'
};
const errors = schema.validate(modelObject); // {}
const error = Object.keys(errors).length > 0; // false
```
### Promises support
You can use validators that return Promise. If You return promis in validator then shema.validate(model) will return Promise.
```js
import Schema from 'form-schema-validation';
const customValidator = {
validator: (value) => {
return new Promise((resolve) => {
setTimeout(() => {
resolve(value === 'test');
}, 1000);
});
},
errorMessage: 'async test error',
}
const schema = new Schema({
companyName: {
type: String,
validators:[customValidator]
}
});
const modelObject = {
companyName: 'Test Company'
};
const results = schema.validate(modelObject); // Promise
results.then((errors) => {
console.log(Object.keys(errors).length > 0); // true
});
```
### Constructor
| Name | Type | Description |
|---|---|---|
| schema | Object | Schema will be used when you validate object |
| errorMessages | Object | Errors messages that will be displayed on error |
| validateKeys | Boolean | This flag give you posibility to don't validate object keys not defined in schema |
### Methods
| Name | Attributes | Description |
|---|---|---|
| validate | model: Object | Validate Object using defined schema |
| setError | key: String, message: String, index: Number | Set error on field |
| setModelError | path: String, message: String | Set error on model tree node |
| getDefaultValues | | Get default values for model using defined schema |
| getField | name: String | Get field properties extended by parent schema instance (`parentSchema`) |
| getFields | | Get all fields schemas |
| oneOfTypes | types: Array of types | Give posibility to validate one of type (Static method) |
| pick | fieldsToPick: [String] | Get fields from schema by keys |
| omit | fieldsToOmit: [String] | Get fields from schema and omit fieldsToOmit |
| extend | fieldsToExtend: [String] | Extend schema by new fields or overwrite them |
| extendFieldValidators | fieldName: String, validator: { validator: Function, errorMessage: String or Function } | Extend field validators |
| registerType | type: SchemaType | Register new schema type |
| isValidatorRegistred | validatorName: String | Check model validator exists in schema |
| addValidator | validator: Function(model: Object, schema: instance of Schema) | Add model validator |
| removeValidator | validator: Function | Remove model validator |
### Types
| Name | Description |
|---|---|
| String | Simple String type |
| Number | Simple Number type |
| Object | Simple Object type this type give you posibility to black box |
| Boolean | Simple Boolean type |
| Date | This type check value is instance of Date |
| Array | This type check value is array of any value |
| new Schema | This type check value is instance of Schema and validate value by this schema |
| Schema.oneOfType([type1, type2, ...]) | This type give you posibility check one of types it will return error if value don't match all types |
| Schema.optionalType(type) | This type will pass validation if value is null or undefined when field is not required |
| SchemaType | You can register new schema type that has name, validator, validator when field is required (requiredValidator) and getDefaultValue |
| [OneOfTypesAbove] | This type check value is array of type |
### Custom validator attributes
| Name | Description |
|---|---|
| value | Field value |
| field | Field properties |
| model | Validated object |
| schema | Field parent schema instance |
#### Example of custom validator
This validator will check two fields. You can validate one field on base another field.
```js
const validateIfFieldTitleIsFilled = (minLength, message) => ({
validator: (value, field, model, schema) => {
if (model.title) {
return !!value;
}
return true;
},
errorMessage: message
});
```
#### Example of additional validator
Additional validator can set error deep in the objects tree.
```js
const fooSchema = new Schema({
fooStart: {
type: String,
},
fooEnd: {
type: String,
},
});
const modelSchema = new Schema({
foo: {
type: fooSchema,
required: true,
},
});
const dataModel = {
foo: {
fooStart: 'start',
fooEnd: 'end',
},
};
modelSchema.addValidator((model, schema) => {
if(model.foo.fooStart === 'start') {
schema.setModelError('foo.fooStart', 'my foo error message');
}
});
modelSchema.validate(dataModel);
```
### Example of dynamic error messages
There can be a need for error messages generated based on the validation outcome. In that case a string or array of strings can be returned from the validator function. Error messages returned from validator function have higher priority that the errorMessage property.
```js
const MIN_AGE = 18;
const validateIfOfAge = () => ({
validator: (value, fieldSchema, formData) => {
const { age } = formData;
if (age <= MIN_AGE) {
return [`Given ${age} is lower than required age of ${MIN_AGE}`];
}
}
});
```
### Example of Schema definition
If You want create new schema You must put object to constructor with information about object keys names and type of value on key.
```js
import Schema from 'form-schema-validation';
const min = (minLength, message) => ({
validator: (value) => {
return value.length > minLength;
},
errorMessage: message
});
const schema = new Schema({
companyName: {
type: String,
required: true,
label: 'Company name',
validators: [min(2, 'Company name should be longer then 2 chars')]
},
createdAt: {
type: Schema.oneOfTypes([Date, String]),
defaultValue: new Date(),
label: 'When start'
},
workers: {
type: Number,
label: 'How many workers we have'
}
});
```
##### Example of schema in schema
```js
import Schema from 'form-schema-validation';
const userSchema = new Schema({
name: {
type: String,
required: true
},
surname: {
type: String,
required: true
},
age: {
type: Number
}
});
const groupSchema = new Schema({
name: {
type: String,
required: true,
label: 'Group name'
},
createdAt: {
type: Date,
defaultValue: new Date(),
label: 'Created at'
},
members: {
type: [userSchema],
label: 'Members'
}
});
```
##### Example of use new schema type
```js
import Schema, { SchemaType } from 'form-schema-validation';
const fooType = new SchemaType('Foo', {
getDefaultValue() {
return 'foo';
},
validator(value, key) {
if (value.indexOf('foo') > -1 || value === '') {
return true;
}
this.setError(key, 'foo error');
return false;
},
requiredValidator(value, key) {
if (value.indexOf('foo') > -1) {
return true;
}
this.setError(key, 'foo required');
return false;
},
});
const schema = new Schema({
foo: {
type: fooType,
},
bar: {
type: String,
},
});
const modelWithErrors = {
foo: 'test',
bar: '',
};
const modelWithoutErros = {
foo: '',
bar: '',
};
const modelWithoutErros2 = {
foo: 'foo',
bar: '',
};
```
#### Schema keys description
When You defined schema You can use this keys:
| Key | Allowed values | Description |
|---|---|---|
| companyName, createdAt, workers, ... | any name | this key defined object key name |
| type | String, Number, Object, Date, Boolean, Array, instance of Schema, [String] ... | this key tell as what type of value we should have on this key in model |
| required | true, false | this key tell as that field is required |
| defaultValue | Any | You can set default value for model |
| disableDefaultValue | Boolean | You can disable filed default value |
| options | Array of (String, Number, Object, Date, ...) | If you use schema for forms You can defined options for select field |
| label | Any instance of String | If you use schema for forms You can defined label for form field |
| validators | array of Functions | You can add custom validators for validate field for example min or max length of value. |
#### Custom validation messages
```js
import Schema from 'form-schema-validation';
const ErrorMessages = {
notDefinedKey(key) { return `Key '${key}' is not defined in schema`; },
modelIsUndefined() { return 'Validated model is undefined'; },
validateRequired(key) { return `Field '${key}' is required`; },
validateString(key) { return `Field '${key}' is not a String`; },
validateNumber(key) { return `Field '${key}' is not a Number`; },
validateObject(key) { return `Field '${key}' is not a Object`; },
validateArray(key) { return `Field '${key}' is not a Array`; },
validateBoolean(key) { return `Field '${key}' is not a Boolean`; },
validateDate(key) { return `Field '${key}' is not a Date`; }
};
const groupSchema = new Schema({
name: {
type: String,
required: true,
label: 'Group name'
},
createdAt: {
type: Date,
defaultValue: new Date(),
label: 'Created at'
},
members: {
type: [userSchema],
label: 'Members'
}
}, ErrorMessages);
```
#### Switch of keys validation
```js
import Schema from 'form-schema-validation';
const schema = new Schema({
companyName: {
type: String,
required: true
}
}, false, false);
const modelObject = {
companyName: 'Test Company',
_id: 'test1234567890',
};
const errors = schema.validate(modelObject);
console.log(Object.keys(errors).length > 0); // false
```