validate-and-clean
v0.1.3
Published
An async-friendly nodejs object validation library which doesn't suck
Downloads
23
Readme
validate-and-clean
validate-and-clean is a library which validates and sanitizes your JSON inputs.
Sorry... :-)
The samples below are written in coffeescript, because it's what I like to write. You don't need coffeescript to use this module though.
The simple stuff
first say you have a structure like this:
person =
name: " John"
surname: "Doe "
age: 17
foobar: 'baz'
You'd write a schema as follows:
vac = require 'validate-and-clean'
person_schema =
_: vac().filter("name", "surname", "age")
name: vac().string().trim().minLen(3).maxLen(50)
surname: vac().string().trim().minLen(3).maxLen(50)
age: vac().optional().number().minVal(18)
Then you would validate and sanitize your object like so
vac.validate(person).with(person_schema)
.then (errors) ->
if(errors)
console.log "validation errors:", errors
else
console.log "there were no errors."
console.log "person has been sanitized to:"
console.log person
And you'd get the following output:
validation errors: { age: 'minVal' }
person has been sanitized to: { name: 'John', surname: 'Doe', age: 17 }
Built in validators / sanitizers
| check name | description |
|-----------------|-----------------------------------------------------------|
| default(val) | sets a default value if undefined or null |
| email | checks if a valid email |
| enum(list...) | checks if is any item in list |
| equals(val) | checks if equal to val
|
| notEquals | checks if not equal to val
|
| filter(list...) | removes any attribute not in list from the object |
| hasDigit | checks if contains at least one digit |
| hasLowerCase | checks if contains at least one lowercase letter |
| hasSpecial | checks if contains at least one special character |
| hasUpperCase | checks if contains at least one uppercase letter |
| integer | checks if is an integer value |
| like(regexp) | checks if matches regexp |
| notLike(regexp) | checks unless matches regexp |
| maxLen(val) | checks if has at most val
elements |
| maxVal(val) | checks if value is at most val
|
| minLen(val) | checks if has at least val
elements |
| minVal(val) | checks if value is at least val
|
| number | casts the value into a number unless it's NaN |
| optional | if undefined or null, this chain of checks will pass |
| overwrite(val) | overwrites with val
|
| pick | restrict an object to a certain set of attributes |
| round(decimals) | rounds a number to decimal places (default: 0) |
| sip | does it look like a sip address |
| string | casts the value into a string |
| trim | trims a string |
| uuid | checks if looks like an uuid |
| url | checks if looks like an URL |
| array | checks if it's an array |
| schema | these two are used for nested structures... |
| each | see examples below! |
Is there an obvious one I missed? Let me know or better, do a pull request! (on the index.coffee file please)
Add your own checks
Say an object has a user_id attribute, and you want to make sure it exists
but also to replace the attribute with a user
object:
vac.register 'user', ->
(attribute, object) ->
id = object[attribute]
if id is null then return Promise.resolve 'null'
if id is undefined then return Promise.resolve 'undefined'
return new Promise (resolve, reject) ->
storage.getUserById id, (error, user) ->
if error then return reject(error)
# the validation fails, so we resolve to an error.
# YES I SAID RESOLVE.
# reject() is reserved for 'real' big, bad errors
# (database unreachable, I/O errors, etc) not the
# normal validation process return values.
unless user then return resolve('user')
# it worked!
delete object[attribute]
object.user = user
resolve()
You can now use this in your schema:
schema.user_id = vac().user()
Things to remember
Your check can alter the model / object which you validate! You should make a deep copy of your object if / when needed
If your check resolves(), the check will pass and go to the next check in the chain
If your check resolves(null), the check will pass unconditionnally (stop the chain for this attribute)
If your check resolves anything else, it will be considered an error.
It's using Promises throughout so we can transparently do some cool async stuff.
Handling lists
Say we have a list of interests with a person:
person =
id: 12
name: "John"
surname: "Doe"
age: 23
likes: [ 'kiwis', 'bananas', 'beer' ]
And say we have written a 'isValidIngredient' check. You could do:
schema =
name: vac().string().minLen(3).maxLen(50)
surname: vac().string().minLen(3).maxLen(50)
age: vac().optional().number()
likes: vac().array().each(
vac().isValidIngredient())
)
Handling nested objects
We can validate attributes which have an object as a value against a new schema also.
schema =
name: vac().string().minLen(3).maxLen(50)
surname: vac().string().minLen(3).maxLen(50)
age: vac().optional().number()
details: vac().schema(
limbs: vac().integer().minVal(0).maxVal(4)
eyes: vac().integer().minVal(0).maxVal(2)
noses: vac().integer().minVal(0).maxVal(1)
)
Lists can also contain schemas...
which can even reference themselves (but self referencing structures are not supported)
person1 =
name: " John"
person2 =
name: "Mary "
person3 =
name: "Mo"
person1.friends = [ person2, person3 ]
person_schema =
name: vac().string().trim().minLen(3).maxLen(50)
person_schema.friends = vac().optional().array().each(
vac().schema(person_schema)
)
vac.validate(person1).with(person_schema)
.then (errors) ->
if(errors)
console.log "validation errors", JSON.stringify errors, null, 2
else
console.log "there were no errors"
console.log "person is now", person1
Outputs:
validation errors {
"friends": [
null,
{
"name": "minLen"
}
]
}
person is now { name: 'John',
friends:
[ { name: 'Mary', friends: null },
{ name: 'Mo', friends: null } ] }
Error output format for lists & nested objects
Say we have
person =
id: 12
name: "John"
surname: "Doe"
age: -1
likes: [ 'kiwis', 'bananas', 'arsenic' ]
details:
limbs: 5
eyes: 2
noses: 1
After validation, object could look like:
{
"age": "minVal",
"likes": [
null,
null,
"badForYou"
],
"details": {
"limbs": "maxVal"
}
}
EXPORTS
- vac()
- vac.register()
- vac.validate()
BUGS
If you find any, please drop me an email - jhiver (at) gmail (dot) com. Patches & pull requests are always welcome of course!
ALSO
This module free software and is distributed under the same license as node.js itself (MIT license)
Copyright (C) 2018 - Jean-Michel Hiver
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.