Amanda v0.4.0

[Baggz]

Hi everyone!

I would like to introduce you the latest version of Amanda (v0.4.0).

First change (and probably the most important) is a change in the direction. Amanda is no longer just a validation library for JSON Schema. It's aiming to be an universal validation library, currently it supports only the JSON Schema Internet Draft, but I'm planning to add Orderly, Relax NG and others very soon.

Example

/**
 * Schema
 */
var schema = {
  type: 'object',
  properties: {
    name: {
      required: true,
      type: 'string',
      length: 7
    }
  }
};

/**
 * Data
 */
var data = {
  name: 'Kenneth'
};

// Initialize a JSON Schema validator
var jsonSchemaValidator = amanda('json');

// Validate the data against the schema
jsonSchemaValidator.validate(data, schema, function(error) {
  // Do something...
});

Compliant with the JSON Schema Internet Draft

Amanda is now more compliant with the JSON Schema Internet Draft. I have added new attributes.

• additionalProperties
• additionaltems
• dependencies
• patternProperties
• uniqueItems
• ...and others.

Also the format attribute supports all formats defined by the JSON Schema Internet Draft plus some custom formats like alpha, alphanumeric, decimal, percentage and others.

Another notable change is that validators has been renamed to attributes. Instead of calling the addValidator method, please use the addAttribute method. This changes also applies to the Error object.

• addValidator → addAttribute
• validator → attribute
• validatorName → attributeName
• validatorValue → attributeValue
• ...

Attributes API

The thing I'm the most excited about is enhanced attributes API. You already know you can add a custom attribute.

var myValidator = amanda('json');

/**
 * MyAttribute
 */
var myAttribute = function(property, propertyValue, attributeValue, propertyAttributes, callback) {
  // Do something...
};

myValidator.addAttribute('test', myAttribute);

An error can be reported by calling the addError method.

var myAttribute = function(property, propertyValue, attributeValue, propertyAttributes, callback) {

  if ( ... ) {
    this.addError('Lorem ipsum dolor error!');
  }

  return callback();

}

Attributes are more powerful with the new enhanced attributes API. They have an access to the internal API (via this keyword).

• validateItems,
• validateProperties
• validateSchema
• validateProperty
• getProperty
• joinPath and others.

The same applies for internal properties.

• An instance (this.instance)
• A schema (this.schema)
• An Error object (this.errors)
• All the attributes (this.attributes)

Again, all these methods and properties are available under the this keyword.

Documentation

The documentation has been completely revamped. It could be found in the /docs/ folder. To be noted, the documentation is not complete yet.

Tests

All tests have been rewritten into Mocha in order to test the library in the browser.

Error Messages

More accurate error messages, that's it.

Build

Amanda was separated into multiple files. I hope you and the ‘make’ command get along well.

Conclusion

Although I was trying hard to not break the current API, in some cases it could happen. Please keep this in mind.