Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mulesoft-labs/node-raml-validate
Strict validation of RAML parameters in JavaScript
https://github.com/mulesoft-labs/node-raml-validate
raml raml-tooling
Last synced: about 2 months ago
JSON representation
Strict validation of RAML parameters in JavaScript
- Host: GitHub
- URL: https://github.com/mulesoft-labs/node-raml-validate
- Owner: mulesoft-labs
- License: other
- Archived: true
- Created: 2014-06-30T18:36:53.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-02-12T08:42:52.000Z (over 2 years ago)
- Last Synced: 2024-04-13T03:44:11.843Z (5 months ago)
- Topics: raml, raml-tooling
- Language: JavaScript
- Size: 174 KB
- Stars: 17
- Watchers: 319
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# RAML Validate
[![NPM version][npm-image]][npm-url]
[![Build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[](https://greenkeeper.io/)
Strict and pluginable validation of [RAML 0.8 named parameters](https://github.com/raml-org/raml-spec/blob/master/versions/raml-08/raml-08.md#named-parameters) and [RAML 1.0 built-in types](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#built-in-types).
## Installation
```shell
npm install raml-validate --save
```
## Usage
You must require the module and call it as a function to get a validation instance back.
```javascript
var validate = require('raml-validate')();
// RAML version to use, either 'RAML10' or 'RAML08' (default)
var RAMLVersion = 'RAML10'
// Create a user model schema.
var user = validate({
username: {
type: 'string',
minLength: 5,
maxLength: 50,
required: true
},
password: {
type: 'string',
minLength: 5,
maxLength: 50,
required: true
}
}, RAMLVersion);
// Validate a user model.
user({
username: 'blakeembrey',
password: 'super secret password'
}); //=> { valid: true, errors: [] }
```
**Module does not currently support [wild-card parameters](https://github.com/raml-org/raml-spec/blob/master/versions/raml-08/raml-08.md#headers) (RAML 0.8) and regular expression patterns in [property declaration](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#property-declarations) (RAML 1.0)**
### Getting validation errors
All validation errors can be retrieved from the `errors` property on the returned object. If `valid === false`, the errors will be set to an array. This can be useful for generating error messages for the client.
```javascript
[
{
valid: false,
key: 'password',
value: 'test',
rule: 'minLength',
attr: 5
}
]
```
### Required validation
If the validation does not set `required` to be true, a `null` or `undefined` value will be valid.
### Union types (RAML 1.0 only)
The module supports the 'union' type as defined in [`datatype-expansion`'s algorithm](https://github.com/raml-org/raml-parser-toolbelt/blob/master/tools/datatype-expansion/doc/algorithms.md).
```javascript
validate({
userId: {
type: 'union',
anyOf: [
{ type: 'string' },
{
type: 'integer',
maximum: 100
}
]
}
});
```
### Repeated validation (RAML 0.8 only)
The module has core support for repeated properties in the form of an array. If the validation is set to `repeat`, but does not receive an array - validation will fail with a `repeat` error.
### Multiple types (RAML 0.8 only)
The module supports multiple types according to the RAML spec (see [RAML 0.8 named parameters with multiple types](https://github.com/raml-org/raml-spec/blob/master/versions/raml-08/raml-08.md#named-parameters-with-multiple-types). When multiple types are specified, it'll run the validation against the matching type.
```javascript
validate({
file: [{
type: 'string'
}, {
type: 'file'
}]
});
```
If any of the types are set to `repeat`, it'll only run that validation object when every value in the array is of the correct type - otherwise you will receive a type error.
### Adding new types (RAML 0.8 only)
New type validations can be added by setting the corresponding property on the `validate.TYPES` object. For example, adding file validation to support buffers can be added by doing:
```javascript
validate.TYPES.file = function (value) {
return Buffer.isBuffer(value);
};
```
The function must accept the value as the first parameter and return a boolean depending on success or failure.
### Adding new rules (RAML 0.8 only)
New rules can be added by setting the corresponding property on the `validate.RULES` object. For example, to add file size support we can do the following:
```javascript
validate.RULES.minFileSize = function (size) {
return function (value) {
return value.length <= size;
};
};
```
The function must accept the validation value as its only parameter and is expected to return another function that implements the validation logic. The returned function must accept the value as the first argument, and can optionally accept the key and model as the second and third arguments. This is useful for implementing a rule such as `requires`, where both parameters may be optional; however, when set, depend on eachother being set.
```javascript
validate.RULES.requires = function (property) {
return function (value, key, object) {
return value != null && object[property] != null;
};
};
```
## License
Apache 2.0
[npm-image]: https://img.shields.io/npm/v/raml-validate.svg?style=flat
[npm-url]: https://npmjs.org/package/raml-validate
[travis-image]: https://img.shields.io/travis/mulesoft-labs/node-raml-validate.svg?style=flat
[travis-url]: https://travis-ci.org/mulesoft-labs/node-raml-validate
[coveralls-image]: https://img.shields.io/coveralls/mulesoft-labs/node-raml-validate.svg?style=flat
[coveralls-url]: https://coveralls.io/r/mulesoft-labs/node-raml-validate?branch=master