A hash table of every instance and what schemas were validated against it.
The key of each item in the table is the URI of the instance that was validated.
The value of this key is an array of strings of URIs of the schema that validated it.
The name of the schema attribute that generated the error.
{Any}details
The value of the schema attribute that generated the error.
{String}message
An user-friendly (English) message about what failed to validate.
{String}schemaUri
The URI of the schema that generated the error.
{String}uri
The URI of the instance that has the error.
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Sep 14 2011 18:53:24 GMT-0600 (MDT)
package/docs/symbols/src/ 0000755 0001750 0001750 00000000000 11727717452 014635 5 ustar david david package/docs/symbols/src/jsv.js.html 0000644 0001750 0001750 00001111571 11727717626 016752 0 ustar david david
1/**
2 * JSV: JSON Schema Validator
3 *
4 * @fileOverview A JavaScript implementation of a extendable, fully compliant JSON Schema validator.
5 * @author <a href="mailto:gary.court@gmail.com">Gary Court</a>
6 * @version 4.0
7 * @see http://github.com/garycourt/JSV
8 */ 9 10/*
11 * Copyright 2010 Gary Court. All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without modification, are
14 * permitted provided that the following conditions are met:
15 *
16 * 1. Redistributions of source code must retain the above copyright notice, this list of
17 * conditions and the following disclaimer.
18 *
19 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
20 * of conditions and the following disclaimer in the documentation and/or other materials
21 * provided with the distribution.
22 *
23 * THIS SOFTWARE IS PROVIDED BY GARY COURT ``AS IS'' AND ANY EXPRESS OR IMPLIED
24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
25 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARY COURT OR
26 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
29 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 *
33 * The views and conclusions contained in the software and documentation are those of the
34 * authors and should not be interpreted as representing official policies, either expressed
35 * or implied, of Gary Court or the JSON Schema specification.
36 */ 37 38/*jslint white: true, sub: true, onevar: true, undef: true, eqeqeq: true, newcap: true, immed: true, indent: 4 */ 39 40varexports=exports||this, 41require=require||function(){ 42returnexports; 43}; 44 45(function(){ 46 47varURI=require("./uri/uri").URI, 48O={}, 49I2H="0123456789abcdef".split(""), 50mapArray,filterArray,searchArray, 51 52JSV; 53 54// 55// Utility functions 56// 57 58functiontypeOf(o){ 59returno===undefined?"undefined":(o===null?"null":Object.prototype.toString.call(o).split(" ").pop().split("]").shift().toLowerCase()); 60} 61 62/** @inner */ 63functionF(){} 64 65functioncreateObject(proto){ 66F.prototype=proto||{}; 67returnnewF(); 68} 69 70functionmapObject(obj,func,scope){ 71varnewObj={},key; 72for(keyinobj){ 73if(obj[key]!==O[key]){ 74newObj[key]=func.call(scope,obj[key],key,obj); 75} 76} 77returnnewObj; 78} 79 80/** @ignore */ 81mapArray=function(arr,func,scope){ 82varx=0,xl=arr.length,newArr=newArray(xl); 83for(;x<xl;++x){ 84newArr[x]=func.call(scope,arr[x],x,arr); 85} 86returnnewArr; 87}; 88 89if(Array.prototype.map){ 90/** @ignore */ 91mapArray=function(arr,func,scope){ 92returnArray.prototype.map.call(arr,func,scope); 93}; 94} 95 96/** @ignore */ 97filterArray=function(arr,func,scope){ 98varx=0,xl=arr.length,newArr=[]; 99for(;x<xl;++x){100if(func.call(scope,arr[x],x,arr)){101newArr[newArr.length]=arr[x];102}103}104returnnewArr;105};106107if(Array.prototype.filter){108/** @ignore */109filterArray=function(arr,func,scope){110returnArray.prototype.filter.call(arr,func,scope);111};112}113114/** @ignore */115searchArray=function(arr,o){116varx=0,xl=arr.length;117for(;x<xl;++x){118if(arr[x]===o){119returnx;120}121}122return-1;123};124125if(Array.prototype.indexOf){126/** @ignore */127searchArray=function(arr,o){128returnArray.prototype.indexOf.call(arr,o);129};130}131132functiontoArray(o){133returno!==undefined&&o!==null?(oinstanceofArray&&!o.callee?o:(typeofo.length!=="number"||o.split||o.setInterval||o.call?[o]:Array.prototype.slice.call(o))):[];134}135136functionkeys(o){137varresult=[],key;138139switch(typeOf(o)){140case"object":141for(keyino){142if(o[key]!==O[key]){143result[result.length]=key;144}145}146break;147case"array":148for(key=o.length-1;key>=0;--key){149result[key]=key;150}151break;152}153154returnresult;155}156157functionpushUnique(arr,o){158if(searchArray(arr,o)===-1){159arr.push(o);160}161returnarr;162}163164functionpopFirst(arr,o){165varindex=searchArray(arr,o);166if(index>-1){167arr.splice(index,1);168}169returnarr;170}171172functionrandomUUID(){173return[174I2H[Math.floor(Math.random()*0x10)],175I2H[Math.floor(Math.random()*0x10)],176I2H[Math.floor(Math.random()*0x10)],177I2H[Math.floor(Math.random()*0x10)],178I2H[Math.floor(Math.random()*0x10)],179I2H[Math.floor(Math.random()*0x10)],180I2H[Math.floor(Math.random()*0x10)],181I2H[Math.floor(Math.random()*0x10)],182"-",183I2H[Math.floor(Math.random()*0x10)],184I2H[Math.floor(Math.random()*0x10)],185I2H[Math.floor(Math.random()*0x10)],186I2H[Math.floor(Math.random()*0x10)],187"-4",//set 4 high bits of time_high field to version188I2H[Math.floor(Math.random()*0x10)],189I2H[Math.floor(Math.random()*0x10)],190I2H[Math.floor(Math.random()*0x10)],191"-",192I2H[(Math.floor(Math.random()*0x10)&0x3)|0x8],//specify 2 high bits of clock sequence193I2H[Math.floor(Math.random()*0x10)],194I2H[Math.floor(Math.random()*0x10)],195I2H[Math.floor(Math.random()*0x10)],196"-",197I2H[Math.floor(Math.random()*0x10)],198I2H[Math.floor(Math.random()*0x10)],199I2H[Math.floor(Math.random()*0x10)],200I2H[Math.floor(Math.random()*0x10)],201I2H[Math.floor(Math.random()*0x10)],202I2H[Math.floor(Math.random()*0x10)],203I2H[Math.floor(Math.random()*0x10)],204I2H[Math.floor(Math.random()*0x10)],205I2H[Math.floor(Math.random()*0x10)],206I2H[Math.floor(Math.random()*0x10)],207I2H[Math.floor(Math.random()*0x10)],208I2H[Math.floor(Math.random()*0x10)]209].join("");210}211212functionescapeURIComponent(str){213returnencodeURIComponent(str).replace(/!/g,'%21').replace(/'/g,'%27').replace(/\(/g,'%28').replace(/\)/g,'%29').replace(/\*/g,'%2A');214}215216functionformatURI(uri){217if(typeofuri==="string"&&uri.indexOf("#")===-1){218uri+="#";219}220returnuri;221}222223functionstripInstances(o){224if(oinstanceofJSONInstance){225returno.getURI();226}227228switch(typeOf(o)){229case"undefined":230case"null":231case"boolean":232case"number":233case"string":234returno;//do nothing235236case"object":237returnmapObject(o,stripInstances);238239case"array":240returnmapArray(o,stripInstances);241242default:243returno.toString();244}245}246247/**
248 * The exception that is thrown when a schema fails to be created.
249 *
250 * @name InitializationError
251 * @class
252 * @param {JSONInstance|String} instance The instance (or instance URI) that is invalid
253 * @param {JSONSchema|String} schema The schema (or schema URI) that was validating the instance
254 * @param {String} attr The attribute that failed to validated
255 * @param {String} message A user-friendly message on why the schema attribute failed to validate the instance
256 * @param {Any} details The value of the schema attribute
257 */258259functionInitializationError(instance,schema,attr,message,details){260Error.call(this,message);261262this.uri=instanceinstanceofJSONInstance?instance.getURI():instance;263this.schemaUri=schemainstanceofJSONInstance?schema.getURI():schema;264this.attribute=attr;265this.message=message;266this.description=message;//IE267this.details=details;268}269270InitializationError.prototype=newError();271InitializationError.prototype.constructor=InitializationError;272InitializationError.prototype.name="InitializationError";273274/**
275 * Defines an error, found by a schema, with an instance.
276 * This class can only be instantiated by {@link Report#addError}.
277 *
278 * @name ValidationError
279 * @class
280 * @see Report#addError
281 */282283/**
284 * The URI of the instance that has the error.
285 *
286 * @name ValidationError.prototype.uri
287 * @type String
288 */289290/**
291 * The URI of the schema that generated the error.
292 *
293 * @name ValidationError.prototype.schemaUri
294 * @type String
295 */296297/**
298 * The name of the schema attribute that generated the error.
299 *
300 * @name ValidationError.prototype.attribute
301 * @type String
302 */303304/**
305 * An user-friendly (English) message about what failed to validate.
306 *
307 * @name ValidationError.prototype.message
308 * @type String
309 */310311/**
312 * The value of the schema attribute that generated the error.
313 *
314 * @name ValidationError.prototype.details
315 * @type Any
316 */317318/**
319 * Reports are returned from validation methods to describe the result of a validation.
320 *
321 * @name Report
322 * @class
323 * @see JSONSchema#validate
324 * @see Environment#validate
325 */326327functionReport(){328/**
329 * An array of {@link ValidationError} objects that define all the errors generated by the schema against the instance.
330 *
331 * @name Report.prototype.errors
332 * @type Array
333 * @see Report#addError
334 */335this.errors=[];336337/**
338 * A hash table of every instance and what schemas were validated against it.
339 * <p>
340 * The key of each item in the table is the URI of the instance that was validated.
341 * The value of this key is an array of strings of URIs of the schema that validated it.
342 * </p>
343 *
344 * @name Report.prototype.validated
345 * @type Object
346 * @see Report#registerValidation
347 * @see Report#isValidatedBy
348 */349this.validated={};350351/**
352 * If the report is generated by {@link Environment#validate}, this field is the generated instance.
353 *
354 * @name Report.prototype.instance
355 * @type JSONInstance
356 * @see Environment#validate
357 */358359/**
360 * If the report is generated by {@link Environment#validate}, this field is the generated schema.
361 *
362 * @name Report.prototype.schema
363 * @type JSONSchema
364 * @see Environment#validate
365 */366367/**
368 * If the report is generated by {@link Environment#validate}, this field is the schema's schema.
369 * This value is the same as calling <code>schema.getSchema()</code>.
370 *
371 * @name Report.prototype.schemaSchema
372 * @type JSONSchema
373 * @see Environment#validate
374 * @see JSONSchema#getSchema
375 */376}377378/**
379 * Adds a {@link ValidationError} object to the <a href="#errors"><code>errors</code></a> field.
380 *
381 * @param {JSONInstance|String} instance The instance (or instance URI) that is invalid
382 * @param {JSONSchema|String} schema The schema (or schema URI) that was validating the instance
383 * @param {String} attr The attribute that failed to validated
384 * @param {String} message A user-friendly message on why the schema attribute failed to validate the instance
385 * @param {Any} details The value of the schema attribute
386 */387388Report.prototype.addError=function(instance,schema,attr,message,details){389this.errors.push({390uri:instanceinstanceofJSONInstance?instance.getURI():instance,391schemaUri:schemainstanceofJSONInstance?schema.getURI():schema,392attribute:attr,393message:message,394details:stripInstances(details)395});396};397398/**
399 * Registers that the provided instance URI has been validated by the provided schema URI.
400 * This is recorded in the <a href="#validated"><code>validated</code></a> field.
401 *
402 * @param {String} uri The URI of the instance that was validated
403 * @param {String} schemaUri The URI of the schema that validated the instance
404 */405406Report.prototype.registerValidation=function(uri,schemaUri){407if(!this.validated[uri]){408this.validated[uri]=[schemaUri];409}else{410this.validated[uri].push(schemaUri);411}412};413414/**
415 * Returns if an instance with the provided URI has been validated by the schema with the provided URI.
416 *
417 * @param {String} uri The URI of the instance
418 * @param {String} schemaUri The URI of a schema
419 * @returns {Boolean} If the instance has been validated by the schema.
420 */421422Report.prototype.isValidatedBy=function(uri,schemaUri){423return!!this.validated[uri]&&searchArray(this.validated[uri],schemaUri)!==-1;424};425426/**
427 * A wrapper class for binding an Environment, URI and helper methods to an instance.
428 * This class is most commonly instantiated with {@link Environment#createInstance}.
429 *
430 * @name JSONInstance
431 * @class
432 * @param {Environment} env The environment this instance belongs to
433 * @param {JSONInstance|Any} json The value of the instance
434 * @param {String} [uri] The URI of the instance. If undefined, the URI will be a randomly generated UUID.
435 * @param {String} [fd] The fragment delimiter for properties. If undefined, uses the environment default.
436 */437438functionJSONInstance(env,json,uri,fd){439if(jsoninstanceofJSONInstance){440if(typeoffd!=="string"){441fd=json._fd;442}443if(typeofuri!=="string"){444uri=json._uri;445}446json=json._value;447}448449if(typeofuri!=="string"){450uri="urn:uuid:"+randomUUID()+"#";451}elseif(uri.indexOf(":")===-1){452uri=formatURI(URI.resolve("urn:uuid:"+randomUUID()+"#",uri));453}454455this._env=env;456this._value=json;457this._uri=uri;458this._fd=fd||this._env._options["defaultFragmentDelimiter"];459}460461/**
462 * Returns the environment the instance is bound to.
463 *
464 * @returns {Environment} The environment of the instance
465 */466467JSONInstance.prototype.getEnvironment=function(){468returnthis._env;469};470471/**
472 * Returns the name of the type of the instance.
473 *
474 * @returns {String} The name of the type of the instance
475 */476477JSONInstance.prototype.getType=function(){478returntypeOf(this._value);479};480481/**
482 * Returns the JSON value of the instance.
483 *
484 * @returns {Any} The actual JavaScript value of the instance
485 */486487JSONInstance.prototype.getValue=function(){488returnthis._value;489};490491/**
492 * Returns the URI of the instance.
493 *
494 * @returns {String} The URI of the instance
495 */496497JSONInstance.prototype.getURI=function(){498returnthis._uri;499};500501/**
502 * Returns a resolved URI of a provided relative URI against the URI of the instance.
503 *
504 * @param {String} uri The relative URI to resolve
505 * @returns {String} The resolved URI
506 */507508JSONInstance.prototype.resolveURI=function(uri){509returnformatURI(URI.resolve(this._uri,uri));510};511512/**
513 * Returns an array of the names of all the properties.
514 *
515 * @returns {Array} An array of strings which are the names of all the properties
516 */517518JSONInstance.prototype.getPropertyNames=function(){519returnkeys(this._value);520};521522/**
523 * Returns a {@link JSONInstance} of the value of the provided property name.
524 *
525 * @param {String} key The name of the property to fetch
526 * @returns {JSONInstance} The instance of the property value
527 */528529JSONInstance.prototype.getProperty=function(key){530varvalue=this._value?this._value[key]:undefined;531if(valueinstanceofJSONInstance){532returnvalue;533}534//else535returnnewJSONInstance(this._env,value,this._uri+this._fd+escapeURIComponent(key),this._fd);536};537538/**
539 * Returns all the property instances of the target instance.
540 * <p>
541 * If the target instance is an Object, then the method will return a hash table of {@link JSONInstance}s of all the properties.
542 * If the target instance is an Array, then the method will return an array of {@link JSONInstance}s of all the items.
543 * </p>
544 *
545 * @returns {Object|Array|undefined} The list of instances for all the properties
546 */547548JSONInstance.prototype.getProperties=function(){549vartype=typeOf(this._value),550self=this;551552if(type==="object"){553returnmapObject(this._value,function(value,key){554if(valueinstanceofJSONInstance){555returnvalue;556}557returnnewJSONInstance(self._env,value,self._uri+self._fd+escapeURIComponent(key),self._fd);558});559}elseif(type==="array"){560returnmapArray(this._value,function(value,key){561if(valueinstanceofJSONInstance){562returnvalue;563}564returnnewJSONInstance(self._env,value,self._uri+self._fd+escapeURIComponent(key),self._fd);565});566}567};568569/**
570 * Returns the JSON value of the provided property name.
571 * This method is a faster version of calling <code>instance.getProperty(key).getValue()</code>.
572 *
573 * @param {String} key The name of the property
574 * @returns {Any} The JavaScript value of the instance
575 * @see JSONInstance#getProperty
576 * @see JSONInstance#getValue
577 */578579JSONInstance.prototype.getValueOfProperty=function(key){580if(this._value){581if(this._value[key]instanceofJSONInstance){582returnthis._value[key]._value;583}584returnthis._value[key];585}586};587588/**
589 * Return if the provided value is the same as the value of the instance.
590 *
591 * @param {JSONInstance|Any} instance The value to compare
592 * @returns {Boolean} If both the instance and the value match
593 */594595JSONInstance.prototype.equals=function(instance){596if(instanceinstanceofJSONInstance){597returnthis._value===instance._value;598}599//else600returnthis._value===instance;601};602603/**
604 * Warning: Not a generic clone function
605 * Produces a JSV acceptable clone
606 */607608functionclone(obj,deep){609varnewObj,x;610611if(objinstanceofJSONInstance){612obj=obj.getValue();613}614615switch(typeOf(obj)){616case"object":617if(deep){618newObj={};619for(xinobj){620if(obj[x]!==O[x]){621newObj[x]=clone(obj[x],deep);622}623}624returnnewObj;625}else{626returncreateObject(obj);627}628break;629case"array":630if(deep){631newObj=newArray(obj.length);632x=obj.length;633while(--x>=0){634newObj[x]=clone(obj[x],deep);635}636returnnewObj;637}else{638returnArray.prototype.slice.call(obj);639}640break;641default:642returnobj;643}644}645646/**
647 * This class binds a {@link JSONInstance} with a {@link JSONSchema} to provided context aware methods.
648 *
649 * @name JSONSchema
650 * @class
651 * @param {Environment} env The environment this schema belongs to
652 * @param {JSONInstance|Any} json The value of the schema
653 * @param {String} [uri] The URI of the schema. If undefined, the URI will be a randomly generated UUID.
654 * @param {JSONSchema|Boolean} [schema] The schema to bind to the instance. If <code>undefined</code>, the environment's default schema will be used. If <code>true</code>, the instance's schema will be itself.
655 * @extends JSONInstance
656 */657658functionJSONSchema(env,json,uri,schema){659varfr;660JSONInstance.call(this,env,json,uri);661662if(schema===true){663this._schema=this;664}elseif(jsoninstanceofJSONSchema&&!(schemainstanceofJSONSchema)){665this._schema=json._schema;//TODO: Make sure cross environments don't mess everything up666}else{667this._schema=schemainstanceofJSONSchema?schema:this._env.getDefaultSchema()||this._env.createEmptySchema();668}669670//determine fragment delimiter from schema671fr=this._schema.getValueOfProperty("fragmentResolution");672if(fr==="dot-delimited"){673this._fd=".";674}elseif(fr==="slash-delimited"){675this._fd="/";676}677678returnthis.rebuild();//this works even when called with "new"679}680681JSONSchema.prototype=createObject(JSONInstance.prototype);682683/**
684 * Returns the schema of the schema.
685 *
686 * @returns {JSONSchema} The schema of the schema
687 */688689JSONSchema.prototype.getSchema=function(){690varuri=this._refs&&this._refs["describedby"],691newSchema;692693if(uri){694newSchema=uri&&this._env.findSchema(uri);695696if(newSchema){697if(!newSchema.equals(this._schema)){698this._schema=newSchema;699this.rebuild();//if the schema has changed, the context has changed - so everything must be rebuilt700}701}elseif(this._env._options["enforceReferences"]){702thrownewInitializationError(this,this._schema,"{describedby}","Unknown schema reference",uri);703}704}705706returnthis._schema;707};708709/**
710 * Returns the value of the provided attribute name.
711 * <p>
712 * This method is different from {@link JSONInstance#getProperty} as the named property
713 * is converted using a parser defined by the schema's schema before being returned. This
714 * makes the return value of this method attribute dependent.
715 * </p>
716 *
717 * @param {String} key The name of the attribute
718 * @param {Any} [arg] Some attribute parsers accept special arguments for returning resolved values. This is attribute dependent.
719 * @returns {JSONSchema|Any} The value of the attribute
720 */721722JSONSchema.prototype.getAttribute=function(key,arg){723varschemaProperty,parser,property,result,724schema=this.getSchema();//we do this here to make sure the "describedby" reference has not changed, and that the attribute cache is up-to-date725726if(!arg&&this._attributes&&this._attributes.hasOwnProperty(key)){727returnthis._attributes[key];728}729730schemaProperty=schema.getProperty("properties").getProperty(key);731parser=schemaProperty.getValueOfProperty("parser");732property=this.getProperty(key);733if(typeofparser==="function"){734result=parser(property,schemaProperty,arg);735if(!arg&&this._attributes){736this._attributes[key]=result;737}738returnresult;739}740//else741returnproperty.getValue();742};743744/**
745 * Returns all the attributes of the schema.
746 *
747 * @returns {Object} A map of all parsed attribute values
748 */749750JSONSchema.prototype.getAttributes=function(){751varproperties,schemaProperties,key,schemaProperty,parser,752schema=this.getSchema();//we do this here to make sure the "describedby" reference has not changed, and that the attribute cache is up-to-date753754if(!this._attributes&&this.getType()==="object"){755properties=this.getProperties();756schemaProperties=schema.getProperty("properties");757this._attributes={};758for(keyinproperties){759if(properties[key]!==O[key]){760schemaProperty=schemaProperties&&schemaProperties.getProperty(key);761parser=schemaProperty&&schemaProperty.getValueOfProperty("parser");762if(typeofparser==="function"){763this._attributes[key]=parser(properties[key],schemaProperty);764}else{765this._attributes[key]=properties[key].getValue();766}767}768}769}770771returnclone(this._attributes,false);772};773774/**
775 * Convenience method for retrieving a link or link object from a schema.
776 * This method is the same as calling <code>schema.getAttribute("links", [rel, instance])[0];</code>.
777 *
778 * @param {String} rel The link relationship
779 * @param {JSONInstance} [instance] The instance to resolve any URIs from
780 * @returns {String|Object|undefined} If <code>instance</code> is provided, a string containing the resolve URI of the link is returned.
781 * If <code>instance</code> is not provided, a link object is returned with details of the link.
782 * If no link with the provided relationship exists, <code>undefined</code> is returned.
783 * @see JSONSchema#getAttribute
784 */785786JSONSchema.prototype.getLink=function(rel,instance){787varschemaLinks=this.getAttribute("links",[rel,instance]);788if(schemaLinks&&schemaLinks.length&&schemaLinks[schemaLinks.length-1]){789returnschemaLinks[schemaLinks.length-1];790}791};792793/**
794 * Validates the provided instance against the target schema and returns a {@link Report}.
795 *
796 * @param {JSONInstance|Any} instance The instance to validate; may be a {@link JSONInstance} or any JavaScript value
797 * @param {Report} [report] A {@link Report} to concatenate the result of the validation to. If <code>undefined</code>, a new {@link Report} is created.
798 * @param {JSONInstance} [parent] The parent/containing instance of the provided instance
799 * @param {JSONSchema} [parentSchema] The schema of the parent/containing instance
800 * @param {String} [name] The name of the parent object's property that references the instance
801 * @returns {Report} The result of the validation
802 */803804JSONSchema.prototype.validate=function(instance,report,parent,parentSchema,name){805varschemaSchema=this.getSchema(),806validator=schemaSchema.getValueOfProperty("validator");807808if(!(instanceinstanceofJSONInstance)){809instance=this.getEnvironment().createInstance(instance);810}811812if(!(reportinstanceofReport)){813report=newReport();814}815816if(this._env._options["validateReferences"]&&this._refs){817if(this._refs["describedby"]&&!this._env.findSchema(this._refs["describedby"])){818report.addError(this,this._schema,"{describedby}","Unknown schema reference",this._refs["describedby"]);819}820if(this._refs["full"]&&!this._env.findSchema(this._refs["full"])){821report.addError(this,this._schema,"{full}","Unknown schema reference",this._refs["full"]);822}823}824825if(typeofvalidator==="function"&&!report.isValidatedBy(instance.getURI(),this.getURI())){826report.registerValidation(instance.getURI(),this.getURI());827validator(instance,this,schemaSchema,report,parent,parentSchema,name);828}829830returnreport;831};832833/** @inner */834functioncreateFullLookupWrapper(func){835return/** @inner */functionfullLookupWrapper(){836varscope=this,837stack=[],838uri=scope._refs&&scope._refs["full"],839schema;840841while(uri){842schema=scope._env.findSchema(uri);843if(schema){844if(schema._value===scope._value){845break;846}847scope=schema;848stack.push(uri);849uri=scope._refs&&scope._refs["full"];850if(stack.indexOf(uri)>-1){851break;//stop infinite loop852}853}elseif(scope._env._options["enforceReferences"]){854thrownewInitializationError(scope,scope._schema,"{full}","Unknown schema reference",uri);855}else{856uri=null;857}858}859returnfunc.apply(scope,arguments);860};861}862863/**
864 * Wraps all JSONInstance methods with a function that resolves the "full" reference.
865 *
866 * @inner
867 */868869(function(){870varkey;871for(keyinJSONSchema.prototype){872if(JSONSchema.prototype[key]!==O[key]&&typeOf(JSONSchema.prototype[key])==="function"){873JSONSchema.prototype[key]=createFullLookupWrapper(JSONSchema.prototype[key]);874}875}876}());877878/**
879 * Reinitializes/re-registers/rebuilds the schema.
880 * <br/>
881 * This is used internally, and should only be called when a schema's private variables are modified directly.
882 *
883 * @private
884 * @return {JSONSchema} The newly rebuilt schema
885 */886887JSONSchema.prototype.rebuild=function(){888varinstance=this,889initializer=instance.getSchema().getValueOfProperty("initializer");890891//clear previous built values892instance._refs=null;893instance._attributes=null;894895if(typeofinitializer==="function"){896instance=initializer(instance);897}898899//register schema900instance._env._schemas[instance._uri]=instance;901902//build & cache the rest of the schema903instance.getAttributes();904905returninstance;906};907908/**
909 * Set the provided reference to the given value.
910 * <br/>
911 * References are used for establishing soft-links to other {@link JSONSchema}s.
912 * Currently, the following references are natively supported:
913 * <dl>
914 * <dt><code>full</code></dt>
915 * <dd>The value is the URI to the full instance of this instance.</dd>
916 * <dt><code>describedby</code></dt>
917 * <dd>The value is the URI to the schema of this instance.</dd>
918 * </dl>
919 *
920 * @param {String} name The name of the reference
921 * @param {String} uri The URI of the schema to refer to
922 */923924JSONSchema.prototype.setReference=function(name,uri){925if(!this._refs){926this._refs={};927}928this._refs[name]=this.resolveURI(uri);929};930931/**
932 * Returns the value of the provided reference name.
933 *
934 * @param {String} name The name of the reference
935 * @return {String} The value of the provided reference name
936 */937938JSONSchema.prototype.getReference=function(name){939returnthis._refs&&this._refs[name];940};941942/**
943 * Merges two schemas/instances together.
944 */945946functioninherits(base,extra,extension){947varbaseType=typeOf(base),948extraType=typeOf(extra),949child,x;950951if(extraType==="undefined"){952returnclone(base,true);953}elseif(baseType==="undefined"||extraType!==baseType){954returnclone(extra,true);955}elseif(extraType==="object"){956if(baseinstanceofJSONSchema){957base=base.getAttributes();958}959if(extrainstanceofJSONSchema){960extra=extra.getAttributes();961if(extra["extends"]&&extension&&extra["extends"]instanceofJSONSchema){962extra["extends"]=[extra["extends"]];963}964}965child=clone(base,true);//this could be optimized as some properties get overwritten966for(xinextra){967if(extra[x]!==O[x]){968child[x]=inherits(base[x],extra[x],extension);969}970}971returnchild;972}else{973returnclone(extra,true);974}975}976977/**
978 * An Environment is a sandbox of schemas thats behavior is different from other environments.
979 *
980 * @name Environment
981 * @class
982 */983984functionEnvironment(){985this._id=randomUUID();986this._schemas={};987this._options={};988989this.createSchema({},true,"urn:jsv:empty-schema#");990}991992/**
993 * Returns a clone of the target environment.
994 *
995 * @returns {Environment} A new {@link Environment} that is a exact copy of the target environment
996 */997998Environment.prototype.clone=function(){999varenv=newEnvironment();1000env._schemas=createObject(this._schemas);1001env._options=createObject(this._options);10021003returnenv;1004};10051006/**
1007 * Returns a new {@link JSONInstance} of the provided data.
1008 *
1009 * @param {JSONInstance|Any} data The value of the instance
1010 * @param {String} [uri] The URI of the instance. If undefined, the URI will be a randomly generated UUID.
1011 * @returns {JSONInstance} A new {@link JSONInstance} from the provided data
1012 */10131014Environment.prototype.createInstance=function(data,uri){1015uri=formatURI(uri);10161017if(datainstanceofJSONInstance&&(!uri||data.getURI()===uri)){1018returndata;1019}10201021returnnewJSONInstance(this,data,uri);1022};10231024/**
1025 * Creates a new {@link JSONSchema} from the provided data, and registers it with the environment.
1026 *
1027 * @param {JSONInstance|Any} data The value of the schema
1028 * @param {JSONSchema|Boolean} [schema] The schema to bind to the instance. If <code>undefined</code>, the environment's default schema will be used. If <code>true</code>, the instance's schema will be itself.
1029 * @param {String} [uri] The URI of the schema. If undefined, the URI will be a randomly generated UUID.
1030 * @returns {JSONSchema} A new {@link JSONSchema} from the provided data
1031 * @throws {InitializationError} If a schema that is not registered with the environment is referenced
1032 */10331034Environment.prototype.createSchema=function(data,schema,uri){1035uri=formatURI(uri);10361037if(datainstanceofJSONSchema&&(!uri||data._uri===uri)&&(!schema||data.getSchema().equals(schema))){1038returndata;1039}10401041returnnewJSONSchema(this,data,uri,schema);1042};10431044/**
1045 * Creates an empty schema.
1046 *
1047 * @returns {JSONSchema} The empty schema, who's schema is itself.
1048 */10491050Environment.prototype.createEmptySchema=function(){1051returnthis._schemas["urn:jsv:empty-schema#"];1052};10531054/**
1055 * Returns the schema registered with the provided URI.
1056 *
1057 * @param {String} uri The absolute URI of the required schema
1058 * @returns {JSONSchema|undefined} The request schema, or <code>undefined</code> if not found
1059 */10601061Environment.prototype.findSchema=function(uri){1062returnthis._schemas[formatURI(uri)];1063};10641065/**
1066 * Sets the specified environment option to the specified value.
1067 *
1068 * @param {String} name The name of the environment option to set
1069 * @param {Any} value The new value of the environment option
1070 */10711072Environment.prototype.setOption=function(name,value){1073this._options[name]=value;1074};10751076/**
1077 * Returns the specified environment option.
1078 *
1079 * @param {String} name The name of the environment option to set
1080 * @returns {Any} The value of the environment option
1081 */10821083Environment.prototype.getOption=function(name){1084returnthis._options[name];1085};10861087/**
1088 * Sets the default fragment delimiter of the environment.
1089 *
1090 * @deprecated Use {@link Environment#setOption} with option "defaultFragmentDelimiter"
1091 * @param {String} fd The fragment delimiter character
1092 */10931094Environment.prototype.setDefaultFragmentDelimiter=function(fd){1095if(typeoffd==="string"&&fd.length>0){1096this._options["defaultFragmentDelimiter"]=fd;1097}1098};10991100/**
1101 * Returns the default fragment delimiter of the environment.
1102 *
1103 * @deprecated Use {@link Environment#getOption} with option "defaultFragmentDelimiter"
1104 * @returns {String} The fragment delimiter character
1105 */11061107Environment.prototype.getDefaultFragmentDelimiter=function(){1108returnthis._options["defaultFragmentDelimiter"];1109};11101111/**
1112 * Sets the URI of the default schema for the environment.
1113 *
1114 * @deprecated Use {@link Environment#setOption} with option "defaultSchemaURI"
1115 * @param {String} uri The default schema URI
1116 */11171118Environment.prototype.setDefaultSchemaURI=function(uri){1119if(typeofuri==="string"){1120this._options["defaultSchemaURI"]=formatURI(uri);1121}1122};11231124/**
1125 * Returns the default schema of the environment.
1126 *
1127 * @returns {JSONSchema} The default schema
1128 */11291130Environment.prototype.getDefaultSchema=function(){1131returnthis.findSchema(this._options["defaultSchemaURI"]);1132};11331134/**
1135 * Validates both the provided schema and the provided instance, and returns a {@link Report}.
1136 * If the schema fails to validate, the instance will not be validated.
1137 *
1138 * @param {JSONInstance|Any} instanceJSON The {@link JSONInstance} or JavaScript value to validate.
1139 * @param {JSONSchema|Any} schemaJSON The {@link JSONSchema} or JavaScript value to use in the validation. This will also be validated againt the schema's schema.
1140 * @returns {Report} The result of the validation
1141 */11421143Environment.prototype.validate=function(instanceJSON,schemaJSON){1144varinstance,1145schema,1146schemaSchema,1147report=newReport();11481149try{1150instance=this.createInstance(instanceJSON);1151report.instance=instance;1152}catch(e){1153report.addError(e.uri,e.schemaUri,e.attribute,e.message,e.details);1154}11551156try{1157schema=this.createSchema(schemaJSON);1158report.schema=schema;11591160schemaSchema=schema.getSchema();1161report.schemaSchema=schemaSchema;1162}catch(f){1163report.addError(f.uri,f.schemaUri,f.attribute,f.message,f.details);1164}11651166if(schemaSchema){1167schemaSchema.validate(schema,report);1168}11691170if(report.errors.length){1171returnreport;1172}11731174returnschema.validate(instance,report);1175};11761177/**
1178 * @private
1179 */11801181Environment.prototype._checkForInvalidInstances=function(stackSize,schemaURI){1182varresult=[],1183stack=[1184[schemaURI,this._schemas[schemaURI]]1185],1186counter=0,1187item,uri,instance,properties,key;11881189while(counter++<stackSize&&stack.length){1190item=stack.shift();1191uri=item[0];1192instance=item[1];11931194if(instanceinstanceofJSONSchema){1195if(this._schemas[instance._uri]!==instance){1196result.push("Instance "+uri+" does not match "+instance._uri);1197}else{1198//schema = instance.getSchema();1199//stack.push([uri + "/{schema}", schema]);12001201properties=instance.getAttributes();1202for(keyinproperties){1203if(properties[key]!==O[key]){1204stack.push([uri+"/"+escapeURIComponent(key),properties[key]]);1205}1206}1207}1208}elseif(typeOf(instance)==="object"){1209properties=instance;1210for(keyinproperties){1211if(properties.hasOwnProperty(key)){1212stack.push([uri+"/"+escapeURIComponent(key),properties[key]]);1213}1214}1215}elseif(typeOf(instance)==="array"){1216properties=instance;1217for(key=0;key<properties.length;++key){1218stack.push([uri+"/"+escapeURIComponent(key),properties[key]]);1219}1220}1221}12221223returnresult.length?result:counter;1224};12251226/**
1227 * A globaly accessible object that provides the ability to create and manage {@link Environments},
1228 * as well as providing utility methods.
1229 *
1230 * @namespace
1231 */12321233JSV={1234_environments:{},1235_defaultEnvironmentID:"",12361237/**
1238 * Returns if the provide value is an instance of {@link JSONInstance}.
1239 *
1240 * @param o The value to test
1241 * @returns {Boolean} If the provide value is an instance of {@link JSONInstance}
1242 */12431244isJSONInstance:function(o){1245returnoinstanceofJSONInstance;1246},12471248/**
1249 * Returns if the provide value is an instance of {@link JSONSchema}.
1250 *
1251 * @param o The value to test
1252 * @returns {Boolean} If the provide value is an instance of {@link JSONSchema}
1253 */12541255isJSONSchema:function(o){1256returnoinstanceofJSONSchema;1257},12581259/**
1260 * Creates and returns a new {@link Environment} that is a clone of the environment registered with the provided ID.
1261 * If no environment ID is provided, the default environment is cloned.
1262 *
1263 * @param {String} [id] The ID of the environment to clone. If <code>undefined</code>, the default environment ID is used.
1264 * @returns {Environment} A newly cloned {@link Environment}
1265 * @throws {Error} If there is no environment registered with the provided ID
1266 */12671268createEnvironment:function(id){1269id=id||this._defaultEnvironmentID;12701271if(!this._environments[id]){1272thrownewError("Unknown Environment ID");1273}1274//else1275returnthis._environments[id].clone();1276},12771278Environment:Environment,12791280/**
1281 * Registers the provided {@link Environment} with the provided ID.
1282 *
1283 * @param {String} id The ID of the environment
1284 * @param {Environment} env The environment to register
1285 */12861287registerEnvironment:function(id,env){1288id=id||(env||0)._id;1289if(id&&!this._environments[id]&&envinstanceofEnvironment){1290env._id=id;1291this._environments[id]=env;1292}1293},12941295/**
1296 * Sets which registered ID is the default environment.
1297 *
1298 * @param {String} id The ID of the registered environment that is default
1299 * @throws {Error} If there is no registered environment with the provided ID
1300 */13011302setDefaultEnvironmentID:function(id){1303if(typeofid==="string"){1304if(!this._environments[id]){1305thrownewError("Unknown Environment ID");1306}13071308this._defaultEnvironmentID=id;1309}1310},13111312/**
1313 * Returns the ID of the default environment.
1314 *
1315 * @returns {String} The ID of the default environment
1316 */13171318getDefaultEnvironmentID:function(){1319returnthis._defaultEnvironmentID;1320},13211322//1323// Utility Functions1324//13251326/**
1327 * Returns the name of the type of the provided value.
1328 *
1329 * @event //utility
1330 * @param {Any} o The value to determine the type of
1331 * @returns {String} The name of the type of the value
1332 */1333typeOf:typeOf,13341335/**
1336 * Return a new object that inherits all of the properties of the provided object.
1337 *
1338 * @event //utility
1339 * @param {Object} proto The prototype of the new object
1340 * @returns {Object} A new object that inherits all of the properties of the provided object
1341 */1342createObject:createObject,13431344/**
1345 * Returns a new object with each property transformed by the iterator.
1346 *
1347 * @event //utility
1348 * @param {Object} obj The object to transform
1349 * @param {Function} iterator A function that returns the new value of the provided property
1350 * @param {Object} [scope] The value of <code>this</code> in the iterator
1351 * @returns {Object} A new object with each property transformed
1352 */1353mapObject:mapObject,13541355/**
1356 * Returns a new array with each item transformed by the iterator.
1357 *
1358 * @event //utility
1359 * @param {Array} arr The array to transform
1360 * @param {Function} iterator A function that returns the new value of the provided item
1361 * @param {Object} scope The value of <code>this</code> in the iterator
1362 * @returns {Array} A new array with each item transformed
1363 */1364mapArray:mapArray,13651366/**
1367 * Returns a new array that only contains the items allowed by the iterator.
1368 *
1369 * @event //utility
1370 * @param {Array} arr The array to filter
1371 * @param {Function} iterator The function that returns true if the provided property should be added to the array
1372 * @param {Object} scope The value of <code>this</code> within the iterator
1373 * @returns {Array} A new array that contains the items allowed by the iterator
1374 */1375filterArray:filterArray,13761377/**
1378 * Returns the first index in the array that the provided item is located at.
1379 *
1380 * @event //utility
1381 * @param {Array} arr The array to search
1382 * @param {Any} o The item being searched for
1383 * @returns {Number} The index of the item in the array, or <code>-1</code> if not found
1384 */1385searchArray:searchArray,13861387/**
1388 * Returns an array representation of a value.
1389 * <ul>
1390 * <li>For array-like objects, the value will be casted as an Array type.</li>
1391 * <li>If an array is provided, the function will simply return the same array.</li>
1392 * <li>For a null or undefined value, the result will be an empty Array.</li>
1393 * <li>For all other values, the value will be the first element in a new Array. </li>
1394 * </ul>
1395 *
1396 * @event //utility
1397 * @param {Any} o The value to convert into an array
1398 * @returns {Array} The value as an array
1399 */1400toArray:toArray,14011402/**
1403 * Returns an array of the names of all properties of an object.
1404 *
1405 * @event //utility
1406 * @param {Object|Array} o The object in question
1407 * @returns {Array} The names of all properties
1408 */1409keys:keys,14101411/**
1412 * Mutates the array by pushing the provided value onto the array only if it is not already there.
1413 *
1414 * @event //utility
1415 * @param {Array} arr The array to modify
1416 * @param {Any} o The object to add to the array if it is not already there
1417 * @returns {Array} The provided array for chaining
1418 */1419pushUnique:pushUnique,14201421/**
1422 * Mutates the array by removing the first item that matches the provided value in the array.
1423 *
1424 * @event //utility
1425 * @param {Array} arr The array to modify
1426 * @param {Any} o The object to remove from the array
1427 * @returns {Array} The provided array for chaining
1428 */1429popFirst:popFirst,14301431/**
1432 * Creates a copy of the target object.
1433 * <p>
1434 * This method will create a new instance of the target, and then mixin the properties of the target.
1435 * If <code>deep</code> is <code>true</code>, then each property will be cloned before mixin.
1436 * </p>
1437 * <p><b>Warning</b>: This is not a generic clone function, as it will only properly clone objects and arrays.</p>
1438 *
1439 * @event //utility
1440 * @param {Any} o The value to clone
1441 * @param {Boolean} [deep=false] If each property should be recursively cloned
1442 * @returns A cloned copy of the provided value
1443 */1444clone:clone,14451446/**
1447 * Generates a pseudo-random UUID.
1448 *
1449 * @event //utility
1450 * @returns {String} A new universally unique ID
1451 */1452randomUUID:randomUUID,14531454/**
1455 * Properly escapes a URI component for embedding into a URI string.
1456 *
1457 * @event //utility
1458 * @param {String} str The URI component to escape
1459 * @returns {String} The escaped URI component
1460 */1461escapeURIComponent:escapeURIComponent,14621463/**
1464 * Returns a URI that is formated for JSV. Currently, this only ensures that the URI ends with a hash tag (<code>#</code>).
1465 *
1466 * @event //utility
1467 * @param {String} uri The URI to format
1468 * @returns {String} The URI formatted for JSV
1469 */1470formatURI:formatURI,14711472/**
1473 * Merges two schemas/instance together.
1474 *
1475 * @event //utility
1476 * @param {JSONSchema|Any} base The old value to merge
1477 * @param {JSONSchema|Any} extra The new value to merge
1478 * @param {Boolean} extension If the merge is a JSON Schema extension
1479 * @return {Any} The modified base value
1480 */14811482inherits:inherits,14831484/**
1485 * @private
1486 * @event //utility
1487 */14881489InitializationError:InitializationError1490};14911492this.JSV=JSV;//set global object1493exports.JSV=JSV;//export to CommonJS14941495require("./environments");//load default environments14961497}());
package/docs/symbols/InitializationError.html 0000644 0001750 0001750 00000017047 11727717626 020751 0 ustar david david
JsDoc Reference - InitializationError
Returns a resolved URI of a provided relative URI against the URI of the instance.
Class Detail
JSONInstance(env, json, uri, fd)
A wrapper class for binding an Environment, URI and helper methods to an instance.
This class is most commonly instantiated with Environment#createInstance.
Returns all the property instances of the target instance.
If the target instance is an Object, then the method will return a hash table of JSONInstances of all the properties.
If the target instance is an Array, then the method will return an array of JSONInstances of all the items.
Returns:
{Object|Array|undefined} The list of instances for all the properties
Creates and returns a new Environment that is a clone of the environment registered with the provided ID.
If no environment ID is provided, the default environment is cloned.
Parameters:
{String}idOptional
The ID of the environment to clone. If undefined, the default environment ID is used.
Throws:
{Error}
If there is no environment registered with the provided ID
Sets which registered ID is the default environment.
Parameters:
{String}id
The ID of the registered environment that is default
Throws:
{Error}
If there is no registered environment with the provided ID
Utility Method Detail
<static>
JSV.clone(o, deep)
Creates a copy of the target object.
This method will create a new instance of the target, and then mixin the properties of the target.
If deep is true, then each property will be cloned before mixin.
Warning: This is not a generic clone function, as it will only properly clone objects and arrays.
Parameters:
{Any}o
The value to clone
{Boolean}deepOptional, Default: false
If each property should be recursively cloned
Returns:
A cloned copy of the provided value
<static>
{Object}JSV.createObject(proto)
Return a new object that inherits all of the properties of the provided object.
Parameters:
{Object}proto
The prototype of the new object
Returns:
{Object} A new object that inherits all of the properties of the provided object
<static>
{String}JSV.escapeURIComponent(str)
Properly escapes a URI component for embedding into a URI string.
Validates both the provided schema and the provided instance, and returns a Report.
If the schema fails to validate, the instance will not be validated.
This method is different from JSONInstance#getProperty as the named property
is converted using a parser defined by the schema's schema before being returned. This
makes the return value of this method attribute dependent.
Parameters:
{String}key
The name of the attribute
{Any}argOptional
Some attribute parsers accept special arguments for returning resolved values. This is attribute dependent.
Convenience method for retrieving a link or link object from a schema.
This method is the same as calling schema.getAttribute("links", [rel, instance])[0];.
{String|Object|undefined} If instance is provided, a string containing the resolve URI of the link is returned.
If instance is not provided, a link object is returned with details of the link.
If no link with the provided relationship exists, undefined is returned.
Set the provided reference to the given value.
References are used for establishing soft-links to other JSONSchemas.
Currently, the following references are natively supported:
full
The value is the URI to the full instance of this instance.
describedby
The value is the URI to the schema of this instance.
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Sep 14 2011 18:53:24 GMT-0600 (MDT)
package/.project 0000644 0001750 0001750 00000000317 11457104345 013065 0 ustar david david
JSV
package/examples/ 0000755 0001750 0001750 00000000000 11727717452 013244 5 ustar david david package/examples/index.html 0000644 0001750 0001750 00000022620 11727717626 015246 0 ustar david david
JSV: JSON Schema Validator
JSV: JSON Schema Validator
package/CHANGELOG.md 0000644 0001750 0001750 00000003320 11727717626 013240 0 ustar david david # Changelog
## 4.0 (2011/08/23)
* Added referencing to JSONSchema, allows for soft-linking to other schemas.
* Environment option "validateReferences" now validates references at validation time for any environment.
* Environment option "enforceReferences" will cause invalid references to throw an error at creation time for any environment.
* Fixed floating point errors with "divisibleBy" attribute.
* Fixed typo in JSV.clone.
* Fixed typo in draft-03 hyper-schema.json.
* Updated uri.js to latest version.
* Fixed bug with Report#addError. (Identified by cellog)
* ValidationError#details is now safe to stringify.
* Removed JSONSchema#createEmptySchema. All empty schemas created by Environment#createEmptySchema now have the same URI (urn:jsv:empty-schema#).
* Added example HTML page.
## 3.5 (2011/03/07)
* Links to unregistered schemas will now throw an error. This can be disabled by setting the environment option "validateReferences" to false.
* Environment#validate now catches errors (such as InitializationErrors) and adds them to it's returned report.
* Report#addError now accepts instance/schema URI strings.
* Fixed bug where empty schemas would not be registered.
* Added private method Environment#_checkForInvalidInstances, for testing the reliability of circular schemas.
* Fixed bug where schemas in the "disallow" attribute would not validate. (Identified by henchan)
## 3.4 (2011/03/06)
* Fixed bug with "id", "$ref", "$schema" attributes not resolving properly under the "http://json-schema.org/draft-03/schema#" schema. (Identified by dougtreder)
* Added dougtreder's referencing tests.
## Older
Older releases were not documented. See git commit history for more information. package/lib/ 0000755 0001750 0001750 00000000000 11727717452 012174 5 ustar david david package/lib/uri/ 0000755 0001750 0001750 00000000000 11727717452 012773 5 ustar david david package/lib/uri/uri.js 0000644 0001750 0001750 00000054114 11727717626 014140 0 ustar david david /**
* URI.js
*
* @fileoverview An RFC 3986 compliant, scheme extendable URI parsing/validating/resolving library for JavaScript.
* @author Gary Court
* @version 1.3
* @see http://github.com/garycourt/uri-js
* @license URI.js v1.3 (c) 2010 Gary Court. License: http://github.com/garycourt/uri-js
*/
/**
* Copyright 2010 Gary Court. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY GARY COURT ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARY COURT OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of Gary Court.
*/
/*jslint white: true, sub: true, onevar: true, undef: true, eqeqeq: true, newcap: true, immed: true, indent: 4 */
/*global exports:true, require:true */
if (typeof exports === "undefined") {
exports = {};
}
if (typeof require !== "function") {
require = function (id) {
return exports;
};
}
(function () {
var
/**
* @param {...string} sets
* @return {string}
*/
mergeSet = function (sets) {
var set = arguments[0],
x = 1,
nextSet = arguments[x];
while (nextSet) {
set = set.slice(0, -1) + nextSet.slice(1);
nextSet = arguments[++x];
}
return set;
},
/**
* @param {string} str
* @return {string}
*/
subexp = function (str) {
return "(?:" + str + ")";
},
ALPHA$$ = "[A-Za-z]",
CR$ = "[\\x0D]",
DIGIT$$ = "[0-9]",
DQUOTE$$ = "[\\x22]",
HEXDIG$$ = mergeSet(DIGIT$$, "[A-Fa-f]"), //case-insensitive
LF$$ = "[\\x0A]",
SP$$ = "[\\x20]",
PCT_ENCODED$ = subexp("%" + HEXDIG$$ + HEXDIG$$),
GEN_DELIMS$$ = "[\\:\\/\\?\\#\\[\\]\\@]",
SUB_DELIMS$$ = "[\\!\\$\\&\\'\\(\\)\\*\\+\\,\\;\\=]",
RESERVED$$ = mergeSet(GEN_DELIMS$$, SUB_DELIMS$$),
UNRESERVED$$ = mergeSet(ALPHA$$, DIGIT$$, "[\\-\\.\\_\\~]"),
SCHEME$ = subexp(ALPHA$$ + mergeSet(ALPHA$$, DIGIT$$, "[\\+\\-\\.]") + "*"),
USERINFO$ = subexp(subexp(PCT_ENCODED$ + "|" + mergeSet(UNRESERVED$$, SUB_DELIMS$$, "[\\:]")) + "*"),
DEC_OCTET$ = subexp(subexp("25[0-5]") + "|" + subexp("2[0-4]" + DIGIT$$) + "|" + subexp("1" + DIGIT$$ + DIGIT$$) + "|" + subexp("[1-9]" + DIGIT$$) + "|" + DIGIT$$),
IPV4ADDRESS$ = subexp(DEC_OCTET$ + "\\." + DEC_OCTET$ + "\\." + DEC_OCTET$ + "\\." + DEC_OCTET$),
H16$ = subexp(HEXDIG$$ + "{1,4}"),
LS32$ = subexp(subexp(H16$ + "\\:" + H16$) + "|" + IPV4ADDRESS$),
IPV6ADDRESS$ = subexp(mergeSet(UNRESERVED$$, SUB_DELIMS$$, "[\\:]") + "+"), //FIXME
IPVFUTURE$ = subexp("v" + HEXDIG$$ + "+\\." + mergeSet(UNRESERVED$$, SUB_DELIMS$$, "[\\:]") + "+"),
IP_LITERAL$ = subexp("\\[" + subexp(IPV6ADDRESS$ + "|" + IPVFUTURE$) + "\\]"),
REG_NAME$ = subexp(subexp(PCT_ENCODED$ + "|" + mergeSet(UNRESERVED$$, SUB_DELIMS$$)) + "*"),
HOST$ = subexp(IP_LITERAL$ + "|" + IPV4ADDRESS$ + "|" + REG_NAME$),
PORT$ = subexp(DIGIT$$ + "*"),
AUTHORITY$ = subexp(subexp(USERINFO$ + "@") + "?" + HOST$ + subexp("\\:" + PORT$) + "?"),
PCHAR$ = subexp(PCT_ENCODED$ + "|" + mergeSet(UNRESERVED$$, SUB_DELIMS$$, "[\\:\\@]")),
SEGMENT$ = subexp(PCHAR$ + "*"),
SEGMENT_NZ$ = subexp(PCHAR$ + "+"),
SEGMENT_NZ_NC$ = subexp(subexp(PCT_ENCODED$ + "|" + mergeSet(UNRESERVED$$, SUB_DELIMS$$, "[\\@]")) + "+"),
PATH_ABEMPTY$ = subexp(subexp("\\/" + SEGMENT$) + "*"),
PATH_ABSOLUTE$ = subexp("\\/" + subexp(SEGMENT_NZ$ + PATH_ABEMPTY$) + "?"), //simplified
PATH_NOSCHEME$ = subexp(SEGMENT_NZ_NC$ + PATH_ABEMPTY$), //simplified
PATH_ROOTLESS$ = subexp(SEGMENT_NZ$ + PATH_ABEMPTY$), //simplified
PATH_EMPTY$ = subexp(""), //simplified
PATH$ = subexp(PATH_ABEMPTY$ + "|" + PATH_ABSOLUTE$ + "|" + PATH_NOSCHEME$ + "|" + PATH_ROOTLESS$ + "|" + PATH_EMPTY$),
QUERY$ = subexp(subexp(PCHAR$ + "|[\\/\\?]") + "*"),
FRAGMENT$ = subexp(subexp(PCHAR$ + "|[\\/\\?]") + "*"),
HIER_PART$ = subexp(subexp("\\/\\/" + AUTHORITY$ + PATH_ABEMPTY$) + "|" + PATH_ABSOLUTE$ + "|" + PATH_ROOTLESS$ + "|" + PATH_EMPTY$),
URI$ = subexp(SCHEME$ + "\\:" + HIER_PART$ + subexp("\\?" + QUERY$) + "?" + subexp("\\#" + FRAGMENT$) + "?"),
RELATIVE_PART$ = subexp(subexp("\\/\\/" + AUTHORITY$ + PATH_ABEMPTY$) + "|" + PATH_ABSOLUTE$ + "|" + PATH_NOSCHEME$ + "|" + PATH_EMPTY$),
RELATIVE_REF$ = subexp(RELATIVE_PART$ + subexp("\\?" + QUERY$) + "?" + subexp("\\#" + FRAGMENT$) + "?"),
URI_REFERENCE$ = subexp(URI$ + "|" + RELATIVE_REF$),
ABSOLUTE_URI$ = subexp(SCHEME$ + "\\:" + HIER_PART$ + subexp("\\?" + QUERY$) + "?"),
URI_REF = new RegExp("^" + subexp("(" + URI$ + ")|(" + RELATIVE_REF$ + ")") + "$"),
GENERIC_REF = new RegExp("^(" + SCHEME$ + ")\\:" + subexp(subexp("\\/\\/(" + subexp("(" + USERINFO$ + ")@") + "?(" + HOST$ + ")" + subexp("\\:(" + PORT$ + ")") + "?)") + "?(" + PATH_ABEMPTY$ + "|" + PATH_ABSOLUTE$ + "|" + PATH_ROOTLESS$ + "|" + PATH_EMPTY$ + ")") + subexp("\\?(" + QUERY$ + ")") + "?" + subexp("\\#(" + FRAGMENT$ + ")") + "?$"),
RELATIVE_REF = new RegExp("^(){0}" + subexp(subexp("\\/\\/(" + subexp("(" + USERINFO$ + ")@") + "?(" + HOST$ + ")" + subexp("\\:(" + PORT$ + ")") + "?)") + "?(" + PATH_ABEMPTY$ + "|" + PATH_ABSOLUTE$ + "|" + PATH_NOSCHEME$ + "|" + PATH_EMPTY$ + ")") + subexp("\\?(" + QUERY$ + ")") + "?" + subexp("\\#(" + FRAGMENT$ + ")") + "?$"),
ABSOLUTE_REF = new RegExp("^(" + SCHEME$ + ")\\:" + subexp(subexp("\\/\\/(" + subexp("(" + USERINFO$ + ")@") + "?(" + HOST$ + ")" + subexp("\\:(" + PORT$ + ")") + "?)") + "?(" + PATH_ABEMPTY$ + "|" + PATH_ABSOLUTE$ + "|" + PATH_ROOTLESS$ + "|" + PATH_EMPTY$ + ")") + subexp("\\?(" + QUERY$ + ")") + "?$"),
SAMEDOC_REF = new RegExp("^" + subexp("\\#(" + FRAGMENT$ + ")") + "?$"),
AUTHORITY = new RegExp("^" + subexp("(" + USERINFO$ + ")@") + "?(" + HOST$ + ")" + subexp("\\:(" + PORT$ + ")") + "?$"),
NOT_SCHEME = new RegExp(mergeSet("[^]", ALPHA$$, DIGIT$$, "[\\+\\-\\.]"), "g"),
NOT_USERINFO = new RegExp(mergeSet("[^\\%\\:]", UNRESERVED$$, SUB_DELIMS$$), "g"),
NOT_HOST = new RegExp(mergeSet("[^\\%]", UNRESERVED$$, SUB_DELIMS$$), "g"),
NOT_PATH = new RegExp(mergeSet("[^\\%\\/\\:\\@]", UNRESERVED$$, SUB_DELIMS$$), "g"),
NOT_PATH_NOSCHEME = new RegExp(mergeSet("[^\\%\\/\\@]", UNRESERVED$$, SUB_DELIMS$$), "g"),
NOT_QUERY = new RegExp(mergeSet("[^\\%]", UNRESERVED$$, SUB_DELIMS$$, "[\\:\\@\\/\\?]"), "g"),
NOT_FRAGMENT = NOT_QUERY,
ESCAPE = new RegExp(mergeSet("[^]", UNRESERVED$$, SUB_DELIMS$$), "g"),
UNRESERVED = new RegExp(UNRESERVED$$, "g"),
OTHER_CHARS = new RegExp(mergeSet("[^\\%]", UNRESERVED$$, RESERVED$$), "g"),
PCT_ENCODEDS = new RegExp(PCT_ENCODED$ + "+", "g"),
URI_PARSE = /^(?:([^:\/?#]+):)?(?:\/\/((?:([^\/?#@]*)@)?([^\/?#:]*)(?:\:(\d*))?))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?/i,
RDS1 = /^\.\.?\//,
RDS2 = /^\/\.(\/|$)/,
RDS3 = /^\/\.\.(\/|$)/,
RDS4 = /^\.\.?$/,
RDS5 = /^\/?.*?(?=\/|$)/,
NO_MATCH_IS_UNDEFINED = ("").match(/(){0}/)[1] === undefined,
/**
* @param {string} chr
* @return {string}
*/
pctEncChar = function (chr) {
var c = chr.charCodeAt(0);
if (c < 128) {
return "%" + c.toString(16).toUpperCase();
}
else if ((c > 127) && (c < 2048)) {
return "%" + ((c >> 6) | 192).toString(16).toUpperCase() + "%" + ((c & 63) | 128).toString(16).toUpperCase();
}
else {
return "%" + ((c >> 12) | 224).toString(16).toUpperCase() + "%" + (((c >> 6) & 63) | 128).toString(16).toUpperCase() + "%" + ((c & 63) | 128).toString(16).toUpperCase();
}
},
/**
* @param {string} str
* @return {string}
*/
pctDecUnreserved = function (str) {
var newStr = "",
i = 0,
c, s;
while (i < str.length) {
c = parseInt(str.substr(i + 1, 2), 16);
if (c < 128) {
s = String.fromCharCode(c);
if (s.match(UNRESERVED)) {
newStr += s;
} else {
newStr += str.substr(i, 3);
}
i += 3;
}
else if ((c > 191) && (c < 224)) {
newStr += str.substr(i, 6);
i += 6;
}
else {
newStr += str.substr(i, 9);
i += 9;
}
}
return newStr;
},
/**
* @param {string} str
* @return {string}
*/
pctDecChars = function (str) {
var newStr = "",
i = 0,
c, c2, c3;
while (i < str.length) {
c = parseInt(str.substr(i + 1, 2), 16);
if (c < 128) {
newStr += String.fromCharCode(c);
i += 3;
}
else if ((c > 191) && (c < 224)) {
c2 = parseInt(str.substr(i + 4, 2), 16);
newStr += String.fromCharCode(((c & 31) << 6) | (c2 & 63));
i += 6;
}
else {
c2 = parseInt(str.substr(i + 4, 2), 16);
c3 = parseInt(str.substr(i + 7, 2), 16);
newStr += String.fromCharCode(((c & 15) << 12) | ((c2 & 63) << 6) | (c3 & 63));
i += 9;
}
}
return newStr;
},
/**
* @return {string}
*/
typeOf = function (o) {
return o === undefined ? "undefined" : (o === null ? "null" : Object.prototype.toString.call(o).split(" ").pop().split("]").shift().toLowerCase());
},
/**
* @constructor
* @implements URIComponents
*/
Components = function () {
this.errors = [];
},
/** @namespace */
URI = exports;
/**
* Components
*/
Components.prototype = {
/**
* @type String
*/
scheme : undefined,
/**
* @type String
*/
authority : undefined,
/**
* @type String
*/
userinfo : undefined,
/**
* @type String
*/
host : undefined,
/**
* @type number
*/
port : undefined,
/**
* @type string
*/
path : undefined,
/**
* @type string
*/
query : undefined,
/**
* @type string
*/
fragment : undefined,
/**
* @type string
* @values "uri", "absolute", "relative", "same-document"
*/
reference : undefined,
/**
* @type Array
*/
errors : undefined
};
/**
* URI
*/
/**
* @namespace
*/
URI.SCHEMES = {};
/**
* @param {string} uriString
* @param {Options} [options]
* @returns {URIComponents}
*/
URI.parse = function (uriString, options) {
var matches,
components = new Components(),
schemeHandler;
uriString = uriString ? uriString.toString() : "";
options = options || {};
if (options.reference === "suffix") {
uriString = (options.scheme ? options.scheme + ":" : "") + "//" + uriString;
}
matches = uriString.match(URI_REF);
if (matches) {
if (matches[1]) {
//generic URI
matches = uriString.match(GENERIC_REF);
} else {
//relative URI
matches = uriString.match(RELATIVE_REF);
}
}
if (!matches) {
if (!options.tolerant) {
components.errors.push("URI is not strictly valid.");
}
matches = uriString.match(URI_PARSE);
}
if (matches) {
if (NO_MATCH_IS_UNDEFINED) {
//store each component
components.scheme = matches[1];
components.authority = matches[2];
components.userinfo = matches[3];
components.host = matches[4];
components.port = parseInt(matches[5], 10);
components.path = matches[6] || "";
components.query = matches[7];
components.fragment = matches[8];
//fix port number
if (isNaN(components.port)) {
components.port = matches[5];
}
} else { //IE FIX for improper RegExp matching
//store each component
components.scheme = matches[1] || undefined;
components.authority = (uriString.indexOf("//") !== -1 ? matches[2] : undefined);
components.userinfo = (uriString.indexOf("@") !== -1 ? matches[3] : undefined);
components.host = (uriString.indexOf("//") !== -1 ? matches[4] : undefined);
components.port = parseInt(matches[5], 10);
components.path = matches[6] || "";
components.query = (uriString.indexOf("?") !== -1 ? matches[7] : undefined);
components.fragment = (uriString.indexOf("#") !== -1 ? matches[8] : undefined);
//fix port number
if (isNaN(components.port)) {
components.port = (uriString.match(/\/\/.*\:(?:\/|\?|\#|$)/) ? matches[4] : undefined);
}
}
//determine reference type
if (!components.scheme && !components.authority && !components.path && !components.query) {
components.reference = "same-document";
} else if (!components.scheme) {
components.reference = "relative";
} else if (!components.fragment) {
components.reference = "absolute";
} else {
components.reference = "uri";
}
//check for reference errors
if (options.reference && options.reference !== "suffix" && options.reference !== components.reference) {
components.errors.push("URI is not a " + options.reference + " reference.");
}
//check if a handler for the scheme exists
schemeHandler = URI.SCHEMES[(components.scheme || options.scheme || "").toLowerCase()];
if (schemeHandler && schemeHandler.parse) {
//perform extra parsing
schemeHandler.parse(components, options);
}
} else {
components.errors.push("URI can not be parsed.");
}
return components;
};
/**
* @private
* @param {URIComponents} components
* @returns {string|undefined}
*/
URI._recomposeAuthority = function (components) {
var uriTokens = [];
if (components.userinfo !== undefined || components.host !== undefined || typeof components.port === "number") {
if (components.userinfo !== undefined) {
uriTokens.push(components.userinfo.toString().replace(NOT_USERINFO, pctEncChar));
uriTokens.push("@");
}
if (components.host !== undefined) {
uriTokens.push(components.host.toString().toLowerCase().replace(NOT_HOST, pctEncChar));
}
if (typeof components.port === "number") {
uriTokens.push(":");
uriTokens.push(components.port.toString(10));
}
}
return uriTokens.length ? uriTokens.join("") : undefined;
};
/**
* @param {string} input
* @returns {string}
*/
URI.removeDotSegments = function (input) {
var output = [], s;
while (input.length) {
if (input.match(RDS1)) {
input = input.replace(RDS1, "");
} else if (input.match(RDS2)) {
input = input.replace(RDS2, "/");
} else if (input.match(RDS3)) {
input = input.replace(RDS3, "/");
output.pop();
} else if (input === "." || input === "..") {
input = "";
} else {
s = input.match(RDS5)[0];
input = input.slice(s.length);
output.push(s);
}
}
return output.join("");
};
/**
* @param {URIComponents} components
* @param {Options} [options]
* @returns {string}
*/
URI.serialize = function (components, options) {
var uriTokens = [],
schemeHandler,
s;
options = options || {};
//check if a handler for the scheme exists
schemeHandler = URI.SCHEMES[components.scheme || options.scheme];
if (schemeHandler && schemeHandler.serialize) {
//perform extra serialization
schemeHandler.serialize(components, options);
}
if (options.reference !== "suffix" && components.scheme) {
uriTokens.push(components.scheme.toString().toLowerCase().replace(NOT_SCHEME, ""));
uriTokens.push(":");
}
components.authority = URI._recomposeAuthority(components);
if (components.authority !== undefined) {
if (options.reference !== "suffix") {
uriTokens.push("//");
}
uriTokens.push(components.authority);
if (components.path && components.path.charAt(0) !== "/") {
uriTokens.push("/");
}
}
if (components.path) {
s = URI.removeDotSegments(components.path.toString().replace(/%2E/ig, "."));
if (components.scheme) {
s = s.replace(NOT_PATH, pctEncChar);
} else {
s = s.replace(NOT_PATH_NOSCHEME, pctEncChar);
}
if (components.authority === undefined) {
s = s.replace(/^\/\//, "/%2F"); //don't allow the path to start with "//"
}
uriTokens.push(s);
}
if (components.query) {
uriTokens.push("?");
uriTokens.push(components.query.toString().replace(NOT_QUERY, pctEncChar));
}
if (components.fragment) {
uriTokens.push("#");
uriTokens.push(components.fragment.toString().replace(NOT_FRAGMENT, pctEncChar));
}
return uriTokens
.join('') //merge tokens into a string
.replace(PCT_ENCODEDS, pctDecUnreserved) //undecode unreserved characters
//.replace(OTHER_CHARS, pctEncChar) //replace non-URI characters
.replace(/%[0-9A-Fa-f]{2}/g, function (str) { //uppercase percent encoded characters
return str.toUpperCase();
})
;
};
/**
* @param {URIComponents} base
* @param {URIComponents} relative
* @param {Options} [options]
* @param {boolean} [skipNormalization]
* @returns {URIComponents}
*/
URI.resolveComponents = function (base, relative, options, skipNormalization) {
var target = new Components();
if (!skipNormalization) {
base = URI.parse(URI.serialize(base, options), options); //normalize base components
relative = URI.parse(URI.serialize(relative, options), options); //normalize relative components
}
options = options || {};
if (!options.tolerant && relative.scheme) {
target.scheme = relative.scheme;
target.authority = relative.authority;
target.userinfo = relative.userinfo;
target.host = relative.host;
target.port = relative.port;
target.path = URI.removeDotSegments(relative.path);
target.query = relative.query;
} else {
if (relative.authority !== undefined) {
target.authority = relative.authority;
target.userinfo = relative.userinfo;
target.host = relative.host;
target.port = relative.port;
target.path = URI.removeDotSegments(relative.path);
target.query = relative.query;
} else {
if (!relative.path) {
target.path = base.path;
if (relative.query !== undefined) {
target.query = relative.query;
} else {
target.query = base.query;
}
} else {
if (relative.path.charAt(0) === "/") {
target.path = URI.removeDotSegments(relative.path);
} else {
if (base.authority !== undefined && !base.path) {
target.path = "/" + relative.path;
} else if (!base.path) {
target.path = relative.path;
} else {
target.path = base.path.slice(0, base.path.lastIndexOf("/") + 1) + relative.path;
}
target.path = URI.removeDotSegments(target.path);
}
target.query = relative.query;
}
target.authority = base.authority;
target.userinfo = base.userinfo;
target.host = base.host;
target.port = base.port;
}
target.scheme = base.scheme;
}
target.fragment = relative.fragment;
return target;
};
/**
* @param {string} baseURI
* @param {string} relativeURI
* @param {Options} [options]
* @returns {string}
*/
URI.resolve = function (baseURI, relativeURI, options) {
return URI.serialize(URI.resolveComponents(URI.parse(baseURI, options), URI.parse(relativeURI, options), options, true), options);
};
/**
* @param {string|URIComponents} uri
* @param {Options} options
* @returns {string|URIComponents}
*/
URI.normalize = function (uri, options) {
if (typeof uri === "string") {
return URI.serialize(URI.parse(uri, options), options);
} else if (typeOf(uri) === "object") {
return URI.parse(URI.serialize(uri, options), options);
}
return uri;
};
/**
* @param {string|URIComponents} uriA
* @param {string|URIComponents} uriB
* @param {Options} options
*/
URI.equal = function (uriA, uriB, options) {
if (typeof uriA === "string") {
uriA = URI.serialize(URI.parse(uriA, options), options);
} else if (typeOf(uriA) === "object") {
uriA = URI.serialize(uriA, options);
}
if (typeof uriB === "string") {
uriB = URI.serialize(URI.parse(uriB, options), options);
} else if (typeOf(uriB) === "object") {
uriB = URI.serialize(uriB, options);
}
return uriA === uriB;
};
/**
* @param {string} str
* @returns {string}
*/
URI.escapeComponent = function (str) {
return str && str.toString().replace(ESCAPE, pctEncChar);
};
/**
* @param {string} str
* @returns {string}
*/
URI.unescapeComponent = function (str) {
return str && str.toString().replace(PCT_ENCODEDS, pctDecChars);
};
//export API
exports.pctEncChar = pctEncChar;
exports.pctDecChars = pctDecChars;
exports.Components = Components;
exports.URI = URI;
//name-safe export API
exports["pctEncChar"] = pctEncChar;
exports["pctDecChars"] = pctDecChars;
exports["Components"] = Components;
exports["URI"] = {
"SCHEMES" : URI.SCHEMES,
"parse" : URI.parse,
"removeDotSegments" : URI.removeDotSegments,
"serialize" : URI.serialize,
"resolveComponents" : URI.resolveComponents,
"resolve" : URI.resolve,
"normalize" : URI.normalize,
"equal" : URI.equal,
"escapeComponent" : URI.escapeComponent,
"unescapeComponent" : URI.unescapeComponent
};
}()); package/lib/uri/schemes/ 0000755 0001750 0001750 00000000000 11727717452 014422 5 ustar david david package/lib/uri/schemes/urn.js 0000644 0001750 0001750 00000004740 11727717626 015574 0 ustar david david (function () {
var URI_NS = require("../uri"),
URI = URI_NS.URI,
pctEncChar = URI_NS.pctEncChar,
NID$ = "(?:[0-9A-Za-z][0-9A-Za-z\\-]{1,31})",
PCT_ENCODED$ = "(?:\\%[0-9A-Fa-f]{2})",
TRANS$$ = "[0-9A-Za-z\\(\\)\\+\\,\\-\\.\\:\\=\\@\\;\\$\\_\\!\\*\\'\\/\\?\\#]",
NSS$ = "(?:(?:" + PCT_ENCODED$ + "|" + TRANS$$ + ")+)",
URN_SCHEME = new RegExp("^urn\\:(" + NID$ + ")$"),
URN_PATH = new RegExp("^(" + NID$ + ")\\:(" + NSS$ + ")$"),
URN_PARSE = /^([^\:]+)\:(.*)/,
URN_EXCLUDED = /[\x00-\x20\\\"\&\<\>\[\]\^\`\{\|\}\~\x7F-\xFF]/g,
UUID = /^[0-9A-Fa-f]{8}(?:\-[0-9A-Fa-f]{4}){3}\-[0-9A-Fa-f]{12}$/;
//RFC 2141
URI.SCHEMES["urn"] = {
parse : function (components, options) {
var matches = components.path.match(URN_PATH),
scheme, schemeHandler;
if (!matches) {
if (!options.tolerant) {
components.errors.push("URN is not strictly valid.");
}
matches = components.path.match(URN_PARSE);
}
if (matches) {
scheme = "urn:" + matches[1].toLowerCase();
schemeHandler = URI.SCHEMES[scheme];
//in order to serialize properly,
//every URN must have a serializer that calls the URN serializer
if (!schemeHandler) {
schemeHandler = URI.SCHEMES[scheme] = {};
}
if (!schemeHandler.serialize) {
schemeHandler.serialize = URI.SCHEMES["urn"].serialize;
}
components.scheme = scheme;
components.path = matches[2];
if (schemeHandler.parse) {
schemeHandler.parse(components, options);
}
} else {
components.errors.push("URN can not be parsed.");
}
return components;
},
serialize : function (components, options) {
var scheme = components.scheme || options.scheme,
matches;
if (scheme && scheme !== "urn") {
var matches = scheme.match(URN_SCHEME);
if (!matches) {
matches = ["urn:" + scheme, scheme];
}
components.scheme = "urn";
components.path = matches[1] + ":" + (components.path ? components.path.replace(URN_EXCLUDED, pctEncChar) : "");
}
return components;
}
};
//RFC 4122
URI.SCHEMES["urn:uuid"] = {
serialize : function (components, options) {
//ensure UUID is valid
if (!options.tolerant && (!components.path || !components.path.match(UUID))) {
//invalid UUIDs can not have this scheme
components.scheme = undefined;
}
return URI.SCHEMES["urn"].serialize(components, options);
}
};
}()); package/lib/json-schema-draft-02.js 0000644 0001750 0001750 00000076726 11727717626 016303 0 ustar david david /**
* json-schema-draft-02 Environment
*
* @fileOverview Implementation of the second revision of the JSON Schema specification draft.
* @author Gary Court
* @version 1.6
* @see http://github.com/garycourt/JSV
*/
/*
* Copyright 2010 Gary Court. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY GARY COURT ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARY COURT OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of Gary Court or the JSON Schema specification.
*/
/*jslint white: true, sub: true, onevar: true, undef: true, eqeqeq: true, newcap: true, immed: true, indent: 4 */
/*global require */
(function () {
var O = {},
JSV = require('./jsv').JSV,
ENVIRONMENT,
TYPE_VALIDATORS,
SCHEMA,
HYPERSCHEMA,
LINKS;
TYPE_VALIDATORS = {
"string" : function (instance, report) {
return instance.getType() === "string";
},
"number" : function (instance, report) {
return instance.getType() === "number";
},
"integer" : function (instance, report) {
return instance.getType() === "number" && instance.getValue() % 1 === 0;
},
"boolean" : function (instance, report) {
return instance.getType() === "boolean";
},
"object" : function (instance, report) {
return instance.getType() === "object";
},
"array" : function (instance, report) {
return instance.getType() === "array";
},
"null" : function (instance, report) {
return instance.getType() === "null";
},
"any" : function (instance, report) {
return true;
}
};
ENVIRONMENT = new JSV.Environment();
ENVIRONMENT.setOption("defaultFragmentDelimiter", "/");
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/schema#"); //updated later
SCHEMA = ENVIRONMENT.createSchema({
"$schema" : "http://json-schema.org/hyper-schema#",
"id" : "http://json-schema.org/schema#",
"type" : "object",
"properties" : {
"type" : {
"type" : ["string", "array"],
"items" : {
"type" : ["string", {"$ref" : "#"}]
},
"optional" : true,
"uniqueItems" : true,
"default" : "any",
"parser" : function (instance, self) {
var parser;
if (instance.getType() === "string") {
return instance.getValue();
} else if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(
instance,
self.getEnvironment().findSchema(self.resolveURI("#"))
);
} else if (instance.getType() === "array") {
parser = self.getValueOfProperty("parser");
return JSV.mapArray(instance.getProperties(), function (prop) {
return parser(prop, self);
});
}
//else
return "any";
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var requiredTypes = JSV.toArray(schema.getAttribute("type")),
x, xl, type, subreport, typeValidators;
//for instances that are required to be a certain type
if (instance.getType() !== "undefined" && requiredTypes && requiredTypes.length) {
typeValidators = self.getValueOfProperty("typeValidators") || {};
//ensure that type matches for at least one of the required types
for (x = 0, xl = requiredTypes.length; x < xl; ++x) {
type = requiredTypes[x];
if (JSV.isJSONSchema(type)) {
subreport = JSV.createObject(report);
subreport.errors = [];
subreport.validated = JSV.clone(report.validated);
if (type.validate(instance, subreport, parent, parentSchema, name).errors.length === 0) {
return true; //instance matches this schema
}
} else {
if (typeValidators[type] !== O[type] && typeof typeValidators[type] === "function") {
if (typeValidators[type](instance, report)) {
return true; //type is valid
}
} else {
return true; //unknown types are assumed valid
}
}
}
//if we get to this point, type is invalid
report.addError(instance, schema, "type", "Instance is not a required type", requiredTypes);
return false;
}
//else, anything is allowed if no type is specified
return true;
},
"typeValidators" : TYPE_VALIDATORS
},
"properties" : {
"type" : "object",
"additionalProperties" : {"$ref" : "#"},
"optional" : true,
"default" : {},
"parser" : function (instance, self, arg) {
var env = instance.getEnvironment(),
selfEnv = self.getEnvironment();
if (instance.getType() === "object") {
if (arg) {
return env.createSchema(instance.getProperty(arg), selfEnv.findSchema(self.resolveURI("#")));
} else {
return JSV.mapObject(instance.getProperties(), function (instance) {
return env.createSchema(instance, selfEnv.findSchema(self.resolveURI("#")));
});
}
}
//else
return {};
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var propertySchemas, key;
//this attribute is for object type instances only
if (instance.getType() === "object") {
//for each property defined in the schema
propertySchemas = schema.getAttribute("properties");
for (key in propertySchemas) {
if (propertySchemas[key] !== O[key] && propertySchemas[key]) {
//ensure that instance property is valid
propertySchemas[key].validate(instance.getProperty(key), report, instance, schema, key);
}
}
}
}
},
"items" : {
"type" : [{"$ref" : "#"}, "array"],
"items" : {"$ref" : "#"},
"optional" : true,
"default" : {},
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
} else if (instance.getType() === "array") {
return JSV.mapArray(instance.getProperties(), function (instance) {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
});
}
//else
return instance.getEnvironment().createEmptySchema();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var properties, items, x, xl, itemSchema, additionalProperties;
if (instance.getType() === "array") {
properties = instance.getProperties();
items = schema.getAttribute("items");
additionalProperties = schema.getAttribute("additionalProperties");
if (JSV.typeOf(items) === "array") {
for (x = 0, xl = properties.length; x < xl; ++x) {
itemSchema = items[x] || additionalProperties;
if (itemSchema !== false) {
itemSchema.validate(properties[x], report, instance, schema, x);
} else {
report.addError(instance, schema, "additionalProperties", "Additional items are not allowed", itemSchema);
}
}
} else {
itemSchema = items || additionalProperties;
for (x = 0, xl = properties.length; x < xl; ++x) {
itemSchema.validate(properties[x], report, instance, schema, x);
}
}
}
}
},
"optional" : {
"type" : "boolean",
"optional" : true,
"default" : false,
"parser" : function (instance, self) {
return !!instance.getValue();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
if (instance.getType() === "undefined" && !schema.getAttribute("optional")) {
report.addError(instance, schema, "optional", "Property is required", false);
}
},
"validationRequired" : true
},
"additionalProperties" : {
"type" : [{"$ref" : "#"}, "boolean"],
"optional" : true,
"default" : {},
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
} else if (instance.getType() === "boolean" && instance.getValue() === false) {
return false;
}
//else
return instance.getEnvironment().createEmptySchema();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var additionalProperties, propertySchemas, properties, key;
//we only need to check against object types as arrays do their own checking on this property
if (instance.getType() === "object") {
additionalProperties = schema.getAttribute("additionalProperties");
propertySchemas = schema.getAttribute("properties") || {};
properties = instance.getProperties();
for (key in properties) {
if (properties[key] !== O[key] && properties[key] && !propertySchemas[key]) {
if (JSV.isJSONSchema(additionalProperties)) {
additionalProperties.validate(properties[key], report, instance, schema, key);
} else if (additionalProperties === false) {
report.addError(instance, schema, "additionalProperties", "Additional properties are not allowed", additionalProperties);
}
}
}
}
}
},
"requires" : {
"type" : ["string", {"$ref" : "#"}],
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "string") {
return instance.getValue();
} else if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var requires;
if (instance.getType() !== "undefined" && parent && parent.getType() !== "undefined") {
requires = schema.getAttribute("requires");
if (typeof requires === "string") {
if (parent.getProperty(requires).getType() === "undefined") {
report.addError(instance, schema, "requires", 'Property requires sibling property "' + requires + '"', requires);
}
} else if (JSV.isJSONSchema(requires)) {
requires.validate(parent, report); //WATCH: A "requires" schema does not support the "requires" attribute
}
}
}
},
"minimum" : {
"type" : "number",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var minimum, minimumCanEqual;
if (instance.getType() === "number") {
minimum = schema.getAttribute("minimum");
minimumCanEqual = schema.getAttribute("minimumCanEqual");
if (typeof minimum === "number" && (instance.getValue() < minimum || (minimumCanEqual === false && instance.getValue() === minimum))) {
report.addError(instance, schema, "minimum", "Number is less then the required minimum value", minimum);
}
}
}
},
"maximum" : {
"type" : "number",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maximum, maximumCanEqual;
if (instance.getType() === "number") {
maximum = schema.getAttribute("maximum");
maximumCanEqual = schema.getAttribute("maximumCanEqual");
if (typeof maximum === "number" && (instance.getValue() > maximum || (maximumCanEqual === false && instance.getValue() === maximum))) {
report.addError(instance, schema, "maximum", "Number is greater then the required maximum value", maximum);
}
}
}
},
"minimumCanEqual" : {
"type" : "boolean",
"optional" : true,
"requires" : "minimum",
"default" : true,
"parser" : function (instance, self) {
if (instance.getType() === "boolean") {
return instance.getValue();
}
//else
return true;
}
},
"maximumCanEqual" : {
"type" : "boolean",
"optional" : true,
"requires" : "maximum",
"default" : true,
"parser" : function (instance, self) {
if (instance.getType() === "boolean") {
return instance.getValue();
}
//else
return true;
}
},
"minItems" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"default" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
//else
return 0;
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var minItems;
if (instance.getType() === "array") {
minItems = schema.getAttribute("minItems");
if (typeof minItems === "number" && instance.getProperties().length < minItems) {
report.addError(instance, schema, "minItems", "The number of items is less then the required minimum", minItems);
}
}
}
},
"maxItems" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maxItems;
if (instance.getType() === "array") {
maxItems = schema.getAttribute("maxItems");
if (typeof maxItems === "number" && instance.getProperties().length > maxItems) {
report.addError(instance, schema, "maxItems", "The number of items is greater then the required maximum", maxItems);
}
}
}
},
"uniqueItems" : {
"type" : "boolean",
"optional" : true,
"default" : false,
"parser" : function (instance, self) {
return !!instance.getValue();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var value, x, xl, y, yl;
if (instance.getType() === "array" && schema.getAttribute("uniqueItems")) {
value = instance.getProperties();
for (x = 0, xl = value.length - 1; x < xl; ++x) {
for (y = x + 1, yl = value.length; y < yl; ++y) {
if (value[x].equals(value[y])) {
report.addError(instance, schema, "uniqueItems", "Array can only contain unique items", { x : x, y : y });
}
}
}
}
}
},
"pattern" : {
"type" : "string",
"optional" : true,
"format" : "regex",
"parser" : function (instance, self) {
if (instance.getType() === "string") {
try {
return new RegExp(instance.getValue());
} catch (e) {
return e;
}
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var pattern;
try {
pattern = schema.getAttribute("pattern");
if (pattern instanceof Error) {
report.addError(instance, schema, "pattern", "Invalid pattern", pattern);
} else if (instance.getType() === "string" && pattern && !pattern.test(instance.getValue())) {
report.addError(instance, schema, "pattern", "String does not match pattern", pattern.toString());
}
} catch (e) {
report.addError(instance, schema, "pattern", "Invalid pattern", e);
}
}
},
"minLength" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"default" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
//else
return 0;
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var minLength;
if (instance.getType() === "string") {
minLength = schema.getAttribute("minLength");
if (typeof minLength === "number" && instance.getValue().length < minLength) {
report.addError(instance, schema, "minLength", "String is less then the required minimum length", minLength);
}
}
}
},
"maxLength" : {
"type" : "integer",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maxLength;
if (instance.getType() === "string") {
maxLength = schema.getAttribute("maxLength");
if (typeof maxLength === "number" && instance.getValue().length > maxLength) {
report.addError(instance, schema, "maxLength", "String is greater then the required maximum length", maxLength);
}
}
}
},
"enum" : {
"type" : "array",
"optional" : true,
"minItems" : 1,
"uniqueItems" : true,
"parser" : function (instance, self) {
if (instance.getType() === "array") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var enums, x, xl;
if (instance.getType() !== "undefined") {
enums = schema.getAttribute("enum");
if (enums) {
for (x = 0, xl = enums.length; x < xl; ++x) {
if (instance.equals(enums[x])) {
return true;
}
}
report.addError(instance, schema, "enum", "Instance is not one of the possible values", enums);
}
}
}
},
"title" : {
"type" : "string",
"optional" : true
},
"description" : {
"type" : "string",
"optional" : true
},
"format" : {
"type" : "string",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "string") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var format, formatValidators;
if (instance.getType() === "string") {
format = schema.getAttribute("format");
formatValidators = self.getValueOfProperty("formatValidators");
if (typeof format === "string" && formatValidators[format] !== O[format] && typeof formatValidators[format] === "function" && !formatValidators[format].call(this, instance, report)) {
report.addError(instance, schema, "format", "String is not in the required format", format);
}
}
},
"formatValidators" : {}
},
"contentEncoding" : {
"type" : "string",
"optional" : true
},
"default" : {
"type" : "any",
"optional" : true
},
"divisibleBy" : {
"type" : "number",
"minimum" : 0,
"minimumCanEqual" : false,
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var divisor;
if (instance.getType() === "number") {
divisor = schema.getAttribute("divisibleBy");
if (divisor === 0) {
report.addError(instance, schema, "divisibleBy", "Nothing is divisible by 0", divisor);
} else if (divisor !== 1 && ((instance.getValue() / divisor) % 1) !== 0) {
report.addError(instance, schema, "divisibleBy", "Number is not divisible by " + divisor, divisor);
}
}
}
},
"disallow" : {
"type" : ["string", "array"],
"items" : {"type" : "string"},
"optional" : true,
"uniqueItems" : true,
"parser" : function (instance, self) {
if (instance.getType() === "string" || instance.getType() === "array") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var disallowedTypes = JSV.toArray(schema.getAttribute("disallow")),
x, xl, key, typeValidators;
//for instances that are required to be a certain type
if (instance.getType() !== "undefined" && disallowedTypes && disallowedTypes.length) {
typeValidators = self.getValueOfProperty("typeValidators") || {};
//ensure that type matches for at least one of the required types
for (x = 0, xl = disallowedTypes.length; x < xl; ++x) {
key = disallowedTypes[x];
if (typeValidators[key] !== O[key] && typeof typeValidators[key] === "function") {
if (typeValidators[key](instance, report)) {
report.addError(instance, schema, "disallow", "Instance is a disallowed type", disallowedTypes);
return false;
}
}
/*
else {
report.addError(instance, schema, "disallow", "Instance may be a disallowed type", disallowedTypes);
return false;
}
*/
}
//if we get to this point, type is valid
return true;
}
//else, everything is allowed if no disallowed types are specified
return true;
},
"typeValidators" : TYPE_VALIDATORS
},
"extends" : {
"type" : [{"$ref" : "#"}, "array"],
"items" : {"$ref" : "#"},
"optional" : true,
"default" : {},
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
} else if (instance.getType() === "array") {
return JSV.mapArray(instance.getProperties(), function (instance) {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
});
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var extensions = schema.getAttribute("extends"), x, xl;
if (extensions) {
if (JSV.isJSONSchema(extensions)) {
extensions.validate(instance, report, parent, parentSchema, name);
} else if (JSV.typeOf(extensions) === "array") {
for (x = 0, xl = extensions.length; x < xl; ++x) {
extensions[x].validate(instance, report, parent, parentSchema, name);
}
}
}
}
}
},
"optional" : true,
"default" : {},
"fragmentResolution" : "slash-delimited",
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self);
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var propNames = schema.getPropertyNames(),
x, xl,
attributeSchemas = self.getAttribute("properties"),
validator;
for (x in attributeSchemas) {
if (attributeSchemas[x] !== O[x] && attributeSchemas[x].getValueOfProperty("validationRequired")) {
JSV.pushUnique(propNames, x);
}
}
for (x = 0, xl = propNames.length; x < xl; ++x) {
if (attributeSchemas[propNames[x]] !== O[propNames[x]]) {
validator = attributeSchemas[propNames[x]].getValueOfProperty("validator");
if (typeof validator === "function") {
validator(instance, schema, attributeSchemas[propNames[x]], report, parent, parentSchema, name);
}
}
}
},
"initializer" : function (instance) {
var link, extension, extended;
//if there is a link to a different schema, set reference
link = instance._schema.getLink("describedby", instance);
if (link && instance._schema._uri !== link) {
instance.setReference("describedby", link);
}
//if instance has a URI link to itself, update it's own URI
link = instance._schema.getLink("self", instance);
if (JSV.typeOf(link) === "string") {
instance._uri = JSV.formatURI(link);
}
//if there is a link to the full representation, set reference
link = instance._schema.getLink("full", instance);
if (link && instance._uri !== link) {
instance.setReference("full", link);
}
//extend schema
extension = instance.getAttribute("extends");
if (JSV.isJSONSchema(extension)) {
extended = JSV.inherits(extension, instance, true);
instance = instance._env.createSchema(extended, instance._schema, instance._uri);
}
return instance;
}
}, true, "http://json-schema.org/schema#");
HYPERSCHEMA = ENVIRONMENT.createSchema(JSV.inherits(SCHEMA, ENVIRONMENT.createSchema({
"$schema" : "http://json-schema.org/hyper-schema#",
"id" : "http://json-schema.org/hyper-schema#",
"properties" : {
"links" : {
"type" : "array",
"items" : {"$ref" : "links#"},
"optional" : true,
"parser" : function (instance, self, arg) {
var links,
linkSchemaURI = self.getValueOfProperty("items")["$ref"],
linkSchema = self.getEnvironment().findSchema(linkSchemaURI),
linkParser = linkSchema && linkSchema.getValueOfProperty("parser");
arg = JSV.toArray(arg);
if (typeof linkParser === "function") {
links = JSV.mapArray(instance.getProperties(), function (link) {
return linkParser(link, linkSchema);
});
} else {
links = JSV.toArray(instance.getValue());
}
if (arg[0]) {
links = JSV.filterArray(links, function (link) {
return link["rel"] === arg[0];
});
}
if (arg[1]) {
links = JSV.mapArray(links, function (link) {
var instance = arg[1],
href = link["href"];
href = href.replace(/\{(.+)\}/g, function (str, p1, offset, s) {
var value;
if (p1 === "-this") {
value = instance.getValue();
} else {
value = instance.getValueOfProperty(p1);
}
return value !== undefined ? String(value) : "";
});
return href ? JSV.formatURI(instance.resolveURI(href)) : href;
});
}
return links;
}
},
"fragmentResolution" : {
"type" : "string",
"optional" : true,
"default" : "slash-delimited"
},
"root" : {
"type" : "boolean",
"optional" : true,
"default" : false
},
"readonly" : {
"type" : "boolean",
"optional" : true,
"default" : false
},
"pathStart" : {
"type" : "string",
"optional" : true,
"format" : "uri",
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var pathStart;
if (instance.getType() !== "undefined") {
pathStart = schema.getAttribute("pathStart");
if (typeof pathStart === "string") {
//TODO: Find out what pathStart is relative to
if (instance.getURI().indexOf(pathStart) !== 0) {
report.addError(instance, schema, "pathStart", "Instance's URI does not start with " + pathStart, pathStart);
}
}
}
}
},
"mediaType" : {
"type" : "string",
"optional" : true,
"format" : "media-type"
},
"alternate" : {
"type" : "array",
"items" : {"$ref" : "#"},
"optional" : true
}
},
"links" : [
{
"href" : "{$ref}",
"rel" : "full"
},
{
"href" : "{$schema}",
"rel" : "describedby"
},
{
"href" : "{id}",
"rel" : "self"
}
]//,
//not needed as JSV.inherits does the job for us
//"extends" : {"$ref" : "http://json-schema.org/schema#"}
}, SCHEMA), true), true, "http://json-schema.org/hyper-schema#");
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/hyper-schema#");
LINKS = ENVIRONMENT.createSchema({
"$schema" : "http://json-schema.org/hyper-schema#",
"id" : "http://json-schema.org/links#",
"type" : "object",
"properties" : {
"href" : {
"type" : "string"
},
"rel" : {
"type" : "string"
},
"targetSchema" : {
"$ref" : "hyper-schema#",
//need this here because parsers are run before links are resolved
"parser" : HYPERSCHEMA.getAttribute("parser")
},
"method" : {
"type" : "string",
"default" : "GET",
"optional" : true
},
"enctype" : {
"type" : "string",
"requires" : "method",
"optional" : true
},
"properties" : {
"type" : "object",
"additionalProperties" : {"$ref" : "hyper-schema#"},
"optional" : true,
"parser" : function (instance, self, arg) {
var env = instance.getEnvironment(),
selfEnv = self.getEnvironment(),
additionalPropertiesSchemaURI = self.getValueOfProperty("additionalProperties")["$ref"];
if (instance.getType() === "object") {
if (arg) {
return env.createSchema(instance.getProperty(arg), selfEnv.findSchema(self.resolveURI(additionalPropertiesSchemaURI)));
} else {
return JSV.mapObject(instance.getProperties(), function (instance) {
return env.createSchema(instance, selfEnv.findSchema(self.resolveURI(additionalPropertiesSchemaURI)));
});
}
}
}
}
},
"parser" : function (instance, self) {
var selfProperties = self.getProperty("properties");
if (instance.getType() === "object") {
return JSV.mapObject(instance.getProperties(), function (property, key) {
var propertySchema = selfProperties.getProperty(key),
parser = propertySchema && propertySchema.getValueOfProperty("parser");
if (typeof parser === "function") {
return parser(property, propertySchema);
}
//else
return property.getValue();
});
}
return instance.getValue();
}
}, HYPERSCHEMA, "http://json-schema.org/links#");
JSV.registerEnvironment("json-schema-draft-02", ENVIRONMENT);
if (!JSV.getDefaultEnvironmentID() || JSV.getDefaultEnvironmentID() === "json-schema-draft-01") {
JSV.setDefaultEnvironmentID("json-schema-draft-02");
}
}()); package/lib/environments.js 0000644 0001750 0001750 00000000152 11504242545 015244 0 ustar david david require("./json-schema-draft-01");
require("./json-schema-draft-02");
require("./json-schema-draft-03"); package/lib/jsv.js 0000644 0001750 0001750 00000132225 11727717626 013344 0 ustar david david /**
* JSV: JSON Schema Validator
*
* @fileOverview A JavaScript implementation of a extendable, fully compliant JSON Schema validator.
* @author Gary Court
* @version 4.0
* @see http://github.com/garycourt/JSV
*/
/*
* Copyright 2010 Gary Court. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY GARY COURT ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARY COURT OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of Gary Court or the JSON Schema specification.
*/
/*jslint white: true, sub: true, onevar: true, undef: true, eqeqeq: true, newcap: true, immed: true, indent: 4 */
var exports = exports || this,
require = require || function () {
return exports;
};
(function () {
var URI = require("./uri/uri").URI,
O = {},
I2H = "0123456789abcdef".split(""),
mapArray, filterArray, searchArray,
JSV;
//
// Utility functions
//
function typeOf(o) {
return o === undefined ? "undefined" : (o === null ? "null" : Object.prototype.toString.call(o).split(" ").pop().split("]").shift().toLowerCase());
}
/** @inner */
function F() {}
function createObject(proto) {
F.prototype = proto || {};
return new F();
}
function mapObject(obj, func, scope) {
var newObj = {}, key;
for (key in obj) {
if (obj[key] !== O[key]) {
newObj[key] = func.call(scope, obj[key], key, obj);
}
}
return newObj;
}
/** @ignore */
mapArray = function (arr, func, scope) {
var x = 0, xl = arr.length, newArr = new Array(xl);
for (; x < xl; ++x) {
newArr[x] = func.call(scope, arr[x], x, arr);
}
return newArr;
};
if (Array.prototype.map) {
/** @ignore */
mapArray = function (arr, func, scope) {
return Array.prototype.map.call(arr, func, scope);
};
}
/** @ignore */
filterArray = function (arr, func, scope) {
var x = 0, xl = arr.length, newArr = [];
for (; x < xl; ++x) {
if (func.call(scope, arr[x], x, arr)) {
newArr[newArr.length] = arr[x];
}
}
return newArr;
};
if (Array.prototype.filter) {
/** @ignore */
filterArray = function (arr, func, scope) {
return Array.prototype.filter.call(arr, func, scope);
};
}
/** @ignore */
searchArray = function (arr, o) {
var x = 0, xl = arr.length;
for (; x < xl; ++x) {
if (arr[x] === o) {
return x;
}
}
return -1;
};
if (Array.prototype.indexOf) {
/** @ignore */
searchArray = function (arr, o) {
return Array.prototype.indexOf.call(arr, o);
};
}
function toArray(o) {
return o !== undefined && o !== null ? (o instanceof Array && !o.callee ? o : (typeof o.length !== "number" || o.split || o.setInterval || o.call ? [ o ] : Array.prototype.slice.call(o))) : [];
}
function keys(o) {
var result = [], key;
switch (typeOf(o)) {
case "object":
for (key in o) {
if (o[key] !== O[key]) {
result[result.length] = key;
}
}
break;
case "array":
for (key = o.length - 1; key >= 0; --key) {
result[key] = key;
}
break;
}
return result;
}
function pushUnique(arr, o) {
if (searchArray(arr, o) === -1) {
arr.push(o);
}
return arr;
}
function popFirst(arr, o) {
var index = searchArray(arr, o);
if (index > -1) {
arr.splice(index, 1);
}
return arr;
}
function randomUUID() {
return [
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
"-",
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
"-4", //set 4 high bits of time_high field to version
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
"-",
I2H[(Math.floor(Math.random() * 0x10) & 0x3) | 0x8], //specify 2 high bits of clock sequence
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
"-",
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)],
I2H[Math.floor(Math.random() * 0x10)]
].join("");
}
function escapeURIComponent(str) {
return encodeURIComponent(str).replace(/!/g, '%21').replace(/'/g, '%27').replace(/\(/g, '%28').replace(/\)/g, '%29').replace(/\*/g, '%2A');
}
function formatURI(uri) {
if (typeof uri === "string" && uri.indexOf("#") === -1) {
uri += "#";
}
return uri;
}
function stripInstances(o) {
if (o instanceof JSONInstance) {
return o.getURI();
}
switch (typeOf(o)) {
case "undefined":
case "null":
case "boolean":
case "number":
case "string":
return o; //do nothing
case "object":
return mapObject(o, stripInstances);
case "array":
return mapArray(o, stripInstances);
default:
return o.toString();
}
}
/**
* The exception that is thrown when a schema fails to be created.
*
* @name InitializationError
* @class
* @param {JSONInstance|String} instance The instance (or instance URI) that is invalid
* @param {JSONSchema|String} schema The schema (or schema URI) that was validating the instance
* @param {String} attr The attribute that failed to validated
* @param {String} message A user-friendly message on why the schema attribute failed to validate the instance
* @param {Any} details The value of the schema attribute
*/
function InitializationError(instance, schema, attr, message, details) {
Error.call(this, message);
this.uri = instance instanceof JSONInstance ? instance.getURI() : instance;
this.schemaUri = schema instanceof JSONInstance ? schema.getURI() : schema;
this.attribute = attr;
this.message = message;
this.description = message; //IE
this.details = details;
}
InitializationError.prototype = new Error();
InitializationError.prototype.constructor = InitializationError;
InitializationError.prototype.name = "InitializationError";
/**
* Defines an error, found by a schema, with an instance.
* This class can only be instantiated by {@link Report#addError}.
*
* @name ValidationError
* @class
* @see Report#addError
*/
/**
* The URI of the instance that has the error.
*
* @name ValidationError.prototype.uri
* @type String
*/
/**
* The URI of the schema that generated the error.
*
* @name ValidationError.prototype.schemaUri
* @type String
*/
/**
* The name of the schema attribute that generated the error.
*
* @name ValidationError.prototype.attribute
* @type String
*/
/**
* An user-friendly (English) message about what failed to validate.
*
* @name ValidationError.prototype.message
* @type String
*/
/**
* The value of the schema attribute that generated the error.
*
* @name ValidationError.prototype.details
* @type Any
*/
/**
* Reports are returned from validation methods to describe the result of a validation.
*
* @name Report
* @class
* @see JSONSchema#validate
* @see Environment#validate
*/
function Report() {
/**
* An array of {@link ValidationError} objects that define all the errors generated by the schema against the instance.
*
* @name Report.prototype.errors
* @type Array
* @see Report#addError
*/
this.errors = [];
/**
* A hash table of every instance and what schemas were validated against it.
*
* The key of each item in the table is the URI of the instance that was validated.
* The value of this key is an array of strings of URIs of the schema that validated it.
*
*
* @name Report.prototype.validated
* @type Object
* @see Report#registerValidation
* @see Report#isValidatedBy
*/
this.validated = {};
/**
* If the report is generated by {@link Environment#validate}, this field is the generated instance.
*
* @name Report.prototype.instance
* @type JSONInstance
* @see Environment#validate
*/
/**
* If the report is generated by {@link Environment#validate}, this field is the generated schema.
*
* @name Report.prototype.schema
* @type JSONSchema
* @see Environment#validate
*/
/**
* If the report is generated by {@link Environment#validate}, this field is the schema's schema.
* This value is the same as calling schema.getSchema().
*
* @name Report.prototype.schemaSchema
* @type JSONSchema
* @see Environment#validate
* @see JSONSchema#getSchema
*/
}
/**
* Adds a {@link ValidationError} object to the errors field.
*
* @param {JSONInstance|String} instance The instance (or instance URI) that is invalid
* @param {JSONSchema|String} schema The schema (or schema URI) that was validating the instance
* @param {String} attr The attribute that failed to validated
* @param {String} message A user-friendly message on why the schema attribute failed to validate the instance
* @param {Any} details The value of the schema attribute
*/
Report.prototype.addError = function (instance, schema, attr, message, details) {
this.errors.push({
uri : instance instanceof JSONInstance ? instance.getURI() : instance,
schemaUri : schema instanceof JSONInstance ? schema.getURI() : schema,
attribute : attr,
message : message,
details : stripInstances(details)
});
};
/**
* Registers that the provided instance URI has been validated by the provided schema URI.
* This is recorded in the validated field.
*
* @param {String} uri The URI of the instance that was validated
* @param {String} schemaUri The URI of the schema that validated the instance
*/
Report.prototype.registerValidation = function (uri, schemaUri) {
if (!this.validated[uri]) {
this.validated[uri] = [ schemaUri ];
} else {
this.validated[uri].push(schemaUri);
}
};
/**
* Returns if an instance with the provided URI has been validated by the schema with the provided URI.
*
* @param {String} uri The URI of the instance
* @param {String} schemaUri The URI of a schema
* @returns {Boolean} If the instance has been validated by the schema.
*/
Report.prototype.isValidatedBy = function (uri, schemaUri) {
return !!this.validated[uri] && searchArray(this.validated[uri], schemaUri) !== -1;
};
/**
* A wrapper class for binding an Environment, URI and helper methods to an instance.
* This class is most commonly instantiated with {@link Environment#createInstance}.
*
* @name JSONInstance
* @class
* @param {Environment} env The environment this instance belongs to
* @param {JSONInstance|Any} json The value of the instance
* @param {String} [uri] The URI of the instance. If undefined, the URI will be a randomly generated UUID.
* @param {String} [fd] The fragment delimiter for properties. If undefined, uses the environment default.
*/
function JSONInstance(env, json, uri, fd) {
if (json instanceof JSONInstance) {
if (typeof fd !== "string") {
fd = json._fd;
}
if (typeof uri !== "string") {
uri = json._uri;
}
json = json._value;
}
if (typeof uri !== "string") {
uri = "urn:uuid:" + randomUUID() + "#";
} else if (uri.indexOf(":") === -1) {
uri = formatURI(URI.resolve("urn:uuid:" + randomUUID() + "#", uri));
}
this._env = env;
this._value = json;
this._uri = uri;
this._fd = fd || this._env._options["defaultFragmentDelimiter"];
}
/**
* Returns the environment the instance is bound to.
*
* @returns {Environment} The environment of the instance
*/
JSONInstance.prototype.getEnvironment = function () {
return this._env;
};
/**
* Returns the name of the type of the instance.
*
* @returns {String} The name of the type of the instance
*/
JSONInstance.prototype.getType = function () {
return typeOf(this._value);
};
/**
* Returns the JSON value of the instance.
*
* @returns {Any} The actual JavaScript value of the instance
*/
JSONInstance.prototype.getValue = function () {
return this._value;
};
/**
* Returns the URI of the instance.
*
* @returns {String} The URI of the instance
*/
JSONInstance.prototype.getURI = function () {
return this._uri;
};
/**
* Returns a resolved URI of a provided relative URI against the URI of the instance.
*
* @param {String} uri The relative URI to resolve
* @returns {String} The resolved URI
*/
JSONInstance.prototype.resolveURI = function (uri) {
return formatURI(URI.resolve(this._uri, uri));
};
/**
* Returns an array of the names of all the properties.
*
* @returns {Array} An array of strings which are the names of all the properties
*/
JSONInstance.prototype.getPropertyNames = function () {
return keys(this._value);
};
/**
* Returns a {@link JSONInstance} of the value of the provided property name.
*
* @param {String} key The name of the property to fetch
* @returns {JSONInstance} The instance of the property value
*/
JSONInstance.prototype.getProperty = function (key) {
var value = this._value ? this._value[key] : undefined;
if (value instanceof JSONInstance) {
return value;
}
//else
return new JSONInstance(this._env, value, this._uri + this._fd + escapeURIComponent(key), this._fd);
};
/**
* Returns all the property instances of the target instance.
*
* If the target instance is an Object, then the method will return a hash table of {@link JSONInstance}s of all the properties.
* If the target instance is an Array, then the method will return an array of {@link JSONInstance}s of all the items.
*
*
* @returns {Object|Array|undefined} The list of instances for all the properties
*/
JSONInstance.prototype.getProperties = function () {
var type = typeOf(this._value),
self = this;
if (type === "object") {
return mapObject(this._value, function (value, key) {
if (value instanceof JSONInstance) {
return value;
}
return new JSONInstance(self._env, value, self._uri + self._fd + escapeURIComponent(key), self._fd);
});
} else if (type === "array") {
return mapArray(this._value, function (value, key) {
if (value instanceof JSONInstance) {
return value;
}
return new JSONInstance(self._env, value, self._uri + self._fd + escapeURIComponent(key), self._fd);
});
}
};
/**
* Returns the JSON value of the provided property name.
* This method is a faster version of calling instance.getProperty(key).getValue().
*
* @param {String} key The name of the property
* @returns {Any} The JavaScript value of the instance
* @see JSONInstance#getProperty
* @see JSONInstance#getValue
*/
JSONInstance.prototype.getValueOfProperty = function (key) {
if (this._value) {
if (this._value[key] instanceof JSONInstance) {
return this._value[key]._value;
}
return this._value[key];
}
};
/**
* Return if the provided value is the same as the value of the instance.
*
* @param {JSONInstance|Any} instance The value to compare
* @returns {Boolean} If both the instance and the value match
*/
JSONInstance.prototype.equals = function (instance) {
if (instance instanceof JSONInstance) {
return this._value === instance._value;
}
//else
return this._value === instance;
};
/**
* Warning: Not a generic clone function
* Produces a JSV acceptable clone
*/
function clone(obj, deep) {
var newObj, x;
if (obj instanceof JSONInstance) {
obj = obj.getValue();
}
switch (typeOf(obj)) {
case "object":
if (deep) {
newObj = {};
for (x in obj) {
if (obj[x] !== O[x]) {
newObj[x] = clone(obj[x], deep);
}
}
return newObj;
} else {
return createObject(obj);
}
break;
case "array":
if (deep) {
newObj = new Array(obj.length);
x = obj.length;
while (--x >= 0) {
newObj[x] = clone(obj[x], deep);
}
return newObj;
} else {
return Array.prototype.slice.call(obj);
}
break;
default:
return obj;
}
}
/**
* This class binds a {@link JSONInstance} with a {@link JSONSchema} to provided context aware methods.
*
* @name JSONSchema
* @class
* @param {Environment} env The environment this schema belongs to
* @param {JSONInstance|Any} json The value of the schema
* @param {String} [uri] The URI of the schema. If undefined, the URI will be a randomly generated UUID.
* @param {JSONSchema|Boolean} [schema] The schema to bind to the instance. If undefined, the environment's default schema will be used. If true, the instance's schema will be itself.
* @extends JSONInstance
*/
function JSONSchema(env, json, uri, schema) {
var fr;
JSONInstance.call(this, env, json, uri);
if (schema === true) {
this._schema = this;
} else if (json instanceof JSONSchema && !(schema instanceof JSONSchema)) {
this._schema = json._schema; //TODO: Make sure cross environments don't mess everything up
} else {
this._schema = schema instanceof JSONSchema ? schema : this._env.getDefaultSchema() || this._env.createEmptySchema();
}
//determine fragment delimiter from schema
fr = this._schema.getValueOfProperty("fragmentResolution");
if (fr === "dot-delimited") {
this._fd = ".";
} else if (fr === "slash-delimited") {
this._fd = "/";
}
return this.rebuild(); //this works even when called with "new"
}
JSONSchema.prototype = createObject(JSONInstance.prototype);
/**
* Returns the schema of the schema.
*
* @returns {JSONSchema} The schema of the schema
*/
JSONSchema.prototype.getSchema = function () {
var uri = this._refs && this._refs["describedby"],
newSchema;
if (uri) {
newSchema = uri && this._env.findSchema(uri);
if (newSchema) {
if (!newSchema.equals(this._schema)) {
this._schema = newSchema;
this.rebuild(); //if the schema has changed, the context has changed - so everything must be rebuilt
}
} else if (this._env._options["enforceReferences"]) {
throw new InitializationError(this, this._schema, "{describedby}", "Unknown schema reference", uri);
}
}
return this._schema;
};
/**
* Returns the value of the provided attribute name.
*
* This method is different from {@link JSONInstance#getProperty} as the named property
* is converted using a parser defined by the schema's schema before being returned. This
* makes the return value of this method attribute dependent.
*
*
* @param {String} key The name of the attribute
* @param {Any} [arg] Some attribute parsers accept special arguments for returning resolved values. This is attribute dependent.
* @returns {JSONSchema|Any} The value of the attribute
*/
JSONSchema.prototype.getAttribute = function (key, arg) {
var schemaProperty, parser, property, result,
schema = this.getSchema(); //we do this here to make sure the "describedby" reference has not changed, and that the attribute cache is up-to-date
if (!arg && this._attributes && this._attributes.hasOwnProperty(key)) {
return this._attributes[key];
}
schemaProperty = schema.getProperty("properties").getProperty(key);
parser = schemaProperty.getValueOfProperty("parser");
property = this.getProperty(key);
if (typeof parser === "function") {
result = parser(property, schemaProperty, arg);
if (!arg && this._attributes) {
this._attributes[key] = result;
}
return result;
}
//else
return property.getValue();
};
/**
* Returns all the attributes of the schema.
*
* @returns {Object} A map of all parsed attribute values
*/
JSONSchema.prototype.getAttributes = function () {
var properties, schemaProperties, key, schemaProperty, parser,
schema = this.getSchema(); //we do this here to make sure the "describedby" reference has not changed, and that the attribute cache is up-to-date
if (!this._attributes && this.getType() === "object") {
properties = this.getProperties();
schemaProperties = schema.getProperty("properties");
this._attributes = {};
for (key in properties) {
if (properties[key] !== O[key]) {
schemaProperty = schemaProperties && schemaProperties.getProperty(key);
parser = schemaProperty && schemaProperty.getValueOfProperty("parser");
if (typeof parser === "function") {
this._attributes[key] = parser(properties[key], schemaProperty);
} else {
this._attributes[key] = properties[key].getValue();
}
}
}
}
return clone(this._attributes, false);
};
/**
* Convenience method for retrieving a link or link object from a schema.
* This method is the same as calling schema.getAttribute("links", [rel, instance])[0];.
*
* @param {String} rel The link relationship
* @param {JSONInstance} [instance] The instance to resolve any URIs from
* @returns {String|Object|undefined} If instance is provided, a string containing the resolve URI of the link is returned.
* If instance is not provided, a link object is returned with details of the link.
* If no link with the provided relationship exists, undefined is returned.
* @see JSONSchema#getAttribute
*/
JSONSchema.prototype.getLink = function (rel, instance) {
var schemaLinks = this.getAttribute("links", [rel, instance]);
if (schemaLinks && schemaLinks.length && schemaLinks[schemaLinks.length - 1]) {
return schemaLinks[schemaLinks.length - 1];
}
};
/**
* Validates the provided instance against the target schema and returns a {@link Report}.
*
* @param {JSONInstance|Any} instance The instance to validate; may be a {@link JSONInstance} or any JavaScript value
* @param {Report} [report] A {@link Report} to concatenate the result of the validation to. If undefined, a new {@link Report} is created.
* @param {JSONInstance} [parent] The parent/containing instance of the provided instance
* @param {JSONSchema} [parentSchema] The schema of the parent/containing instance
* @param {String} [name] The name of the parent object's property that references the instance
* @returns {Report} The result of the validation
*/
JSONSchema.prototype.validate = function (instance, report, parent, parentSchema, name) {
var schemaSchema = this.getSchema(),
validator = schemaSchema.getValueOfProperty("validator");
if (!(instance instanceof JSONInstance)) {
instance = this.getEnvironment().createInstance(instance);
}
if (!(report instanceof Report)) {
report = new Report();
}
if (this._env._options["validateReferences"] && this._refs) {
if (this._refs["describedby"] && !this._env.findSchema(this._refs["describedby"])) {
report.addError(this, this._schema, "{describedby}", "Unknown schema reference", this._refs["describedby"]);
}
if (this._refs["full"] && !this._env.findSchema(this._refs["full"])) {
report.addError(this, this._schema, "{full}", "Unknown schema reference", this._refs["full"]);
}
}
if (typeof validator === "function" && !report.isValidatedBy(instance.getURI(), this.getURI())) {
report.registerValidation(instance.getURI(), this.getURI());
validator(instance, this, schemaSchema, report, parent, parentSchema, name);
}
return report;
};
/** @inner */
function createFullLookupWrapper(func) {
return /** @inner */ function fullLookupWrapper() {
var scope = this,
stack = [],
uri = scope._refs && scope._refs["full"],
schema;
while (uri) {
schema = scope._env.findSchema(uri);
if (schema) {
if (schema._value === scope._value) {
break;
}
scope = schema;
stack.push(uri);
uri = scope._refs && scope._refs["full"];
if (stack.indexOf(uri) > -1) {
break; //stop infinite loop
}
} else if (scope._env._options["enforceReferences"]) {
throw new InitializationError(scope, scope._schema, "{full}", "Unknown schema reference", uri);
} else {
uri = null;
}
}
return func.apply(scope, arguments);
};
}
/**
* Wraps all JSONInstance methods with a function that resolves the "full" reference.
*
* @inner
*/
(function () {
var key;
for (key in JSONSchema.prototype) {
if (JSONSchema.prototype[key] !== O[key] && typeOf(JSONSchema.prototype[key]) === "function") {
JSONSchema.prototype[key] = createFullLookupWrapper(JSONSchema.prototype[key]);
}
}
}());
/**
* Reinitializes/re-registers/rebuilds the schema.
*
* This is used internally, and should only be called when a schema's private variables are modified directly.
*
* @private
* @return {JSONSchema} The newly rebuilt schema
*/
JSONSchema.prototype.rebuild = function () {
var instance = this,
initializer = instance.getSchema().getValueOfProperty("initializer");
//clear previous built values
instance._refs = null;
instance._attributes = null;
if (typeof initializer === "function") {
instance = initializer(instance);
}
//register schema
instance._env._schemas[instance._uri] = instance;
//build & cache the rest of the schema
instance.getAttributes();
return instance;
};
/**
* Set the provided reference to the given value.
*
* References are used for establishing soft-links to other {@link JSONSchema}s.
* Currently, the following references are natively supported:
*
*
full
*
The value is the URI to the full instance of this instance.
*
describedby
*
The value is the URI to the schema of this instance.
*
*
* @param {String} name The name of the reference
* @param {String} uri The URI of the schema to refer to
*/
JSONSchema.prototype.setReference = function (name, uri) {
if (!this._refs) {
this._refs = {};
}
this._refs[name] = this.resolveURI(uri);
};
/**
* Returns the value of the provided reference name.
*
* @param {String} name The name of the reference
* @return {String} The value of the provided reference name
*/
JSONSchema.prototype.getReference = function (name) {
return this._refs && this._refs[name];
};
/**
* Merges two schemas/instances together.
*/
function inherits(base, extra, extension) {
var baseType = typeOf(base),
extraType = typeOf(extra),
child, x;
if (extraType === "undefined") {
return clone(base, true);
} else if (baseType === "undefined" || extraType !== baseType) {
return clone(extra, true);
} else if (extraType === "object") {
if (base instanceof JSONSchema) {
base = base.getAttributes();
}
if (extra instanceof JSONSchema) {
extra = extra.getAttributes();
if (extra["extends"] && extension && extra["extends"] instanceof JSONSchema) {
extra["extends"] = [ extra["extends"] ];
}
}
child = clone(base, true); //this could be optimized as some properties get overwritten
for (x in extra) {
if (extra[x] !== O[x]) {
child[x] = inherits(base[x], extra[x], extension);
}
}
return child;
} else {
return clone(extra, true);
}
}
/**
* An Environment is a sandbox of schemas thats behavior is different from other environments.
*
* @name Environment
* @class
*/
function Environment() {
this._id = randomUUID();
this._schemas = {};
this._options = {};
this.createSchema({}, true, "urn:jsv:empty-schema#");
}
/**
* Returns a clone of the target environment.
*
* @returns {Environment} A new {@link Environment} that is a exact copy of the target environment
*/
Environment.prototype.clone = function () {
var env = new Environment();
env._schemas = createObject(this._schemas);
env._options = createObject(this._options);
return env;
};
/**
* Returns a new {@link JSONInstance} of the provided data.
*
* @param {JSONInstance|Any} data The value of the instance
* @param {String} [uri] The URI of the instance. If undefined, the URI will be a randomly generated UUID.
* @returns {JSONInstance} A new {@link JSONInstance} from the provided data
*/
Environment.prototype.createInstance = function (data, uri) {
uri = formatURI(uri);
if (data instanceof JSONInstance && (!uri || data.getURI() === uri)) {
return data;
}
return new JSONInstance(this, data, uri);
};
/**
* Creates a new {@link JSONSchema} from the provided data, and registers it with the environment.
*
* @param {JSONInstance|Any} data The value of the schema
* @param {JSONSchema|Boolean} [schema] The schema to bind to the instance. If undefined, the environment's default schema will be used. If true, the instance's schema will be itself.
* @param {String} [uri] The URI of the schema. If undefined, the URI will be a randomly generated UUID.
* @returns {JSONSchema} A new {@link JSONSchema} from the provided data
* @throws {InitializationError} If a schema that is not registered with the environment is referenced
*/
Environment.prototype.createSchema = function (data, schema, uri) {
uri = formatURI(uri);
if (data instanceof JSONSchema && (!uri || data._uri === uri) && (!schema || data.getSchema().equals(schema))) {
return data;
}
return new JSONSchema(this, data, uri, schema);
};
/**
* Creates an empty schema.
*
* @returns {JSONSchema} The empty schema, who's schema is itself.
*/
Environment.prototype.createEmptySchema = function () {
return this._schemas["urn:jsv:empty-schema#"];
};
/**
* Returns the schema registered with the provided URI.
*
* @param {String} uri The absolute URI of the required schema
* @returns {JSONSchema|undefined} The request schema, or undefined if not found
*/
Environment.prototype.findSchema = function (uri) {
return this._schemas[formatURI(uri)];
};
/**
* Sets the specified environment option to the specified value.
*
* @param {String} name The name of the environment option to set
* @param {Any} value The new value of the environment option
*/
Environment.prototype.setOption = function (name, value) {
this._options[name] = value;
};
/**
* Returns the specified environment option.
*
* @param {String} name The name of the environment option to set
* @returns {Any} The value of the environment option
*/
Environment.prototype.getOption = function (name) {
return this._options[name];
};
/**
* Sets the default fragment delimiter of the environment.
*
* @deprecated Use {@link Environment#setOption} with option "defaultFragmentDelimiter"
* @param {String} fd The fragment delimiter character
*/
Environment.prototype.setDefaultFragmentDelimiter = function (fd) {
if (typeof fd === "string" && fd.length > 0) {
this._options["defaultFragmentDelimiter"] = fd;
}
};
/**
* Returns the default fragment delimiter of the environment.
*
* @deprecated Use {@link Environment#getOption} with option "defaultFragmentDelimiter"
* @returns {String} The fragment delimiter character
*/
Environment.prototype.getDefaultFragmentDelimiter = function () {
return this._options["defaultFragmentDelimiter"];
};
/**
* Sets the URI of the default schema for the environment.
*
* @deprecated Use {@link Environment#setOption} with option "defaultSchemaURI"
* @param {String} uri The default schema URI
*/
Environment.prototype.setDefaultSchemaURI = function (uri) {
if (typeof uri === "string") {
this._options["defaultSchemaURI"] = formatURI(uri);
}
};
/**
* Returns the default schema of the environment.
*
* @returns {JSONSchema} The default schema
*/
Environment.prototype.getDefaultSchema = function () {
return this.findSchema(this._options["defaultSchemaURI"]);
};
/**
* Validates both the provided schema and the provided instance, and returns a {@link Report}.
* If the schema fails to validate, the instance will not be validated.
*
* @param {JSONInstance|Any} instanceJSON The {@link JSONInstance} or JavaScript value to validate.
* @param {JSONSchema|Any} schemaJSON The {@link JSONSchema} or JavaScript value to use in the validation. This will also be validated againt the schema's schema.
* @returns {Report} The result of the validation
*/
Environment.prototype.validate = function (instanceJSON, schemaJSON) {
var instance,
schema,
schemaSchema,
report = new Report();
try {
instance = this.createInstance(instanceJSON);
report.instance = instance;
} catch (e) {
report.addError(e.uri, e.schemaUri, e.attribute, e.message, e.details);
}
try {
schema = this.createSchema(schemaJSON);
report.schema = schema;
schemaSchema = schema.getSchema();
report.schemaSchema = schemaSchema;
} catch (f) {
report.addError(f.uri, f.schemaUri, f.attribute, f.message, f.details);
}
if (schemaSchema) {
schemaSchema.validate(schema, report);
}
if (report.errors.length) {
return report;
}
return schema.validate(instance, report);
};
/**
* @private
*/
Environment.prototype._checkForInvalidInstances = function (stackSize, schemaURI) {
var result = [],
stack = [
[schemaURI, this._schemas[schemaURI]]
],
counter = 0,
item, uri, instance, properties, key;
while (counter++ < stackSize && stack.length) {
item = stack.shift();
uri = item[0];
instance = item[1];
if (instance instanceof JSONSchema) {
if (this._schemas[instance._uri] !== instance) {
result.push("Instance " + uri + " does not match " + instance._uri);
} else {
//schema = instance.getSchema();
//stack.push([uri + "/{schema}", schema]);
properties = instance.getAttributes();
for (key in properties) {
if (properties[key] !== O[key]) {
stack.push([uri + "/" + escapeURIComponent(key), properties[key]]);
}
}
}
} else if (typeOf(instance) === "object") {
properties = instance;
for (key in properties) {
if (properties.hasOwnProperty(key)) {
stack.push([uri + "/" + escapeURIComponent(key), properties[key]]);
}
}
} else if (typeOf(instance) === "array") {
properties = instance;
for (key = 0; key < properties.length; ++key) {
stack.push([uri + "/" + escapeURIComponent(key), properties[key]]);
}
}
}
return result.length ? result : counter;
};
/**
* A globaly accessible object that provides the ability to create and manage {@link Environments},
* as well as providing utility methods.
*
* @namespace
*/
JSV = {
_environments : {},
_defaultEnvironmentID : "",
/**
* Returns if the provide value is an instance of {@link JSONInstance}.
*
* @param o The value to test
* @returns {Boolean} If the provide value is an instance of {@link JSONInstance}
*/
isJSONInstance : function (o) {
return o instanceof JSONInstance;
},
/**
* Returns if the provide value is an instance of {@link JSONSchema}.
*
* @param o The value to test
* @returns {Boolean} If the provide value is an instance of {@link JSONSchema}
*/
isJSONSchema : function (o) {
return o instanceof JSONSchema;
},
/**
* Creates and returns a new {@link Environment} that is a clone of the environment registered with the provided ID.
* If no environment ID is provided, the default environment is cloned.
*
* @param {String} [id] The ID of the environment to clone. If undefined, the default environment ID is used.
* @returns {Environment} A newly cloned {@link Environment}
* @throws {Error} If there is no environment registered with the provided ID
*/
createEnvironment : function (id) {
id = id || this._defaultEnvironmentID;
if (!this._environments[id]) {
throw new Error("Unknown Environment ID");
}
//else
return this._environments[id].clone();
},
Environment : Environment,
/**
* Registers the provided {@link Environment} with the provided ID.
*
* @param {String} id The ID of the environment
* @param {Environment} env The environment to register
*/
registerEnvironment : function (id, env) {
id = id || (env || 0)._id;
if (id && !this._environments[id] && env instanceof Environment) {
env._id = id;
this._environments[id] = env;
}
},
/**
* Sets which registered ID is the default environment.
*
* @param {String} id The ID of the registered environment that is default
* @throws {Error} If there is no registered environment with the provided ID
*/
setDefaultEnvironmentID : function (id) {
if (typeof id === "string") {
if (!this._environments[id]) {
throw new Error("Unknown Environment ID");
}
this._defaultEnvironmentID = id;
}
},
/**
* Returns the ID of the default environment.
*
* @returns {String} The ID of the default environment
*/
getDefaultEnvironmentID : function () {
return this._defaultEnvironmentID;
},
//
// Utility Functions
//
/**
* Returns the name of the type of the provided value.
*
* @event //utility
* @param {Any} o The value to determine the type of
* @returns {String} The name of the type of the value
*/
typeOf : typeOf,
/**
* Return a new object that inherits all of the properties of the provided object.
*
* @event //utility
* @param {Object} proto The prototype of the new object
* @returns {Object} A new object that inherits all of the properties of the provided object
*/
createObject : createObject,
/**
* Returns a new object with each property transformed by the iterator.
*
* @event //utility
* @param {Object} obj The object to transform
* @param {Function} iterator A function that returns the new value of the provided property
* @param {Object} [scope] The value of this in the iterator
* @returns {Object} A new object with each property transformed
*/
mapObject : mapObject,
/**
* Returns a new array with each item transformed by the iterator.
*
* @event //utility
* @param {Array} arr The array to transform
* @param {Function} iterator A function that returns the new value of the provided item
* @param {Object} scope The value of this in the iterator
* @returns {Array} A new array with each item transformed
*/
mapArray : mapArray,
/**
* Returns a new array that only contains the items allowed by the iterator.
*
* @event //utility
* @param {Array} arr The array to filter
* @param {Function} iterator The function that returns true if the provided property should be added to the array
* @param {Object} scope The value of this within the iterator
* @returns {Array} A new array that contains the items allowed by the iterator
*/
filterArray : filterArray,
/**
* Returns the first index in the array that the provided item is located at.
*
* @event //utility
* @param {Array} arr The array to search
* @param {Any} o The item being searched for
* @returns {Number} The index of the item in the array, or -1 if not found
*/
searchArray : searchArray,
/**
* Returns an array representation of a value.
*
*
For array-like objects, the value will be casted as an Array type.
*
If an array is provided, the function will simply return the same array.
*
For a null or undefined value, the result will be an empty Array.
*
For all other values, the value will be the first element in a new Array.
*
*
* @event //utility
* @param {Any} o The value to convert into an array
* @returns {Array} The value as an array
*/
toArray : toArray,
/**
* Returns an array of the names of all properties of an object.
*
* @event //utility
* @param {Object|Array} o The object in question
* @returns {Array} The names of all properties
*/
keys : keys,
/**
* Mutates the array by pushing the provided value onto the array only if it is not already there.
*
* @event //utility
* @param {Array} arr The array to modify
* @param {Any} o The object to add to the array if it is not already there
* @returns {Array} The provided array for chaining
*/
pushUnique : pushUnique,
/**
* Mutates the array by removing the first item that matches the provided value in the array.
*
* @event //utility
* @param {Array} arr The array to modify
* @param {Any} o The object to remove from the array
* @returns {Array} The provided array for chaining
*/
popFirst : popFirst,
/**
* Creates a copy of the target object.
*
* This method will create a new instance of the target, and then mixin the properties of the target.
* If deep is true, then each property will be cloned before mixin.
*
*
Warning: This is not a generic clone function, as it will only properly clone objects and arrays.
*
* @event //utility
* @param {Any} o The value to clone
* @param {Boolean} [deep=false] If each property should be recursively cloned
* @returns A cloned copy of the provided value
*/
clone : clone,
/**
* Generates a pseudo-random UUID.
*
* @event //utility
* @returns {String} A new universally unique ID
*/
randomUUID : randomUUID,
/**
* Properly escapes a URI component for embedding into a URI string.
*
* @event //utility
* @param {String} str The URI component to escape
* @returns {String} The escaped URI component
*/
escapeURIComponent : escapeURIComponent,
/**
* Returns a URI that is formated for JSV. Currently, this only ensures that the URI ends with a hash tag (#).
*
* @event //utility
* @param {String} uri The URI to format
* @returns {String} The URI formatted for JSV
*/
formatURI : formatURI,
/**
* Merges two schemas/instance together.
*
* @event //utility
* @param {JSONSchema|Any} base The old value to merge
* @param {JSONSchema|Any} extra The new value to merge
* @param {Boolean} extension If the merge is a JSON Schema extension
* @return {Any} The modified base value
*/
inherits : inherits,
/**
* @private
* @event //utility
*/
InitializationError : InitializationError
};
this.JSV = JSV; //set global object
exports.JSV = JSV; //export to CommonJS
require("./environments"); //load default environments
}()); package/lib/json-schema-draft-01.js 0000644 0001750 0001750 00000075051 11727717626 016270 0 ustar david david /**
* json-schema-draft-01 Environment
*
* @fileOverview Implementation of the first revision of the JSON Schema specification draft.
* @author Gary Court
* @version 1.6
* @see http://github.com/garycourt/JSV
*/
/*
* Copyright 2010 Gary Court. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY GARY COURT ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARY COURT OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of Gary Court or the JSON Schema specification.
*/
/*jslint white: true, sub: true, onevar: true, undef: true, eqeqeq: true, newcap: true, immed: true, indent: 4 */
/*global require */
(function () {
var O = {},
JSV = require('./jsv').JSV,
ENVIRONMENT,
TYPE_VALIDATORS,
SCHEMA,
HYPERSCHEMA,
LINKS;
TYPE_VALIDATORS = {
"string" : function (instance, report) {
return instance.getType() === "string";
},
"number" : function (instance, report) {
return instance.getType() === "number";
},
"integer" : function (instance, report) {
return instance.getType() === "number" && instance.getValue() % 1 === 0;
},
"boolean" : function (instance, report) {
return instance.getType() === "boolean";
},
"object" : function (instance, report) {
return instance.getType() === "object";
},
"array" : function (instance, report) {
return instance.getType() === "array";
},
"null" : function (instance, report) {
return instance.getType() === "null";
},
"any" : function (instance, report) {
return true;
}
};
ENVIRONMENT = new JSV.Environment();
ENVIRONMENT.setOption("defaultFragmentDelimiter", ".");
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/schema#"); //updated later
SCHEMA = ENVIRONMENT.createSchema({
"$schema" : "http://json-schema.org/hyper-schema#",
"id" : "http://json-schema.org/schema#",
"type" : "object",
"properties" : {
"type" : {
"type" : ["string", "array"],
"items" : {
"type" : ["string", {"$ref" : "#"}]
},
"optional" : true,
"uniqueItems" : true,
"default" : "any",
"parser" : function (instance, self) {
var parser;
if (instance.getType() === "string") {
return instance.getValue();
} else if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(
instance,
self.getEnvironment().findSchema(self.resolveURI("#"))
);
} else if (instance.getType() === "array") {
parser = self.getValueOfProperty("parser");
return JSV.mapArray(instance.getProperties(), function (prop) {
return parser(prop, self);
});
}
//else
return "any";
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var requiredTypes = JSV.toArray(schema.getAttribute("type")),
x, xl, type, subreport, typeValidators;
//for instances that are required to be a certain type
if (instance.getType() !== "undefined" && requiredTypes && requiredTypes.length) {
typeValidators = self.getValueOfProperty("typeValidators") || {};
//ensure that type matches for at least one of the required types
for (x = 0, xl = requiredTypes.length; x < xl; ++x) {
type = requiredTypes[x];
if (JSV.isJSONSchema(type)) {
subreport = JSV.createObject(report);
subreport.errors = [];
subreport.validated = JSV.clone(report.validated);
if (type.validate(instance, subreport, parent, parentSchema, name).errors.length === 0) {
return true; //instance matches this schema
}
} else {
if (typeValidators[type] !== O[type] && typeof typeValidators[type] === "function") {
if (typeValidators[type](instance, report)) {
return true; //type is valid
}
} else {
return true; //unknown types are assumed valid
}
}
}
//if we get to this point, type is invalid
report.addError(instance, schema, "type", "Instance is not a required type", requiredTypes);
return false;
}
//else, anything is allowed if no type is specified
return true;
},
"typeValidators" : TYPE_VALIDATORS
},
"properties" : {
"type" : "object",
"additionalProperties" : {"$ref" : "#"},
"optional" : true,
"default" : {},
"parser" : function (instance, self, arg) {
var env = instance.getEnvironment(),
selfEnv = self.getEnvironment();
if (instance.getType() === "object") {
if (arg) {
return env.createSchema(instance.getProperty(arg), selfEnv.findSchema(self.resolveURI("#")));
} else {
return JSV.mapObject(instance.getProperties(), function (instance) {
return env.createSchema(instance, selfEnv.findSchema(self.resolveURI("#")));
});
}
}
//else
return {};
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var propertySchemas, key;
//this attribute is for object type instances only
if (instance.getType() === "object") {
//for each property defined in the schema
propertySchemas = schema.getAttribute("properties");
for (key in propertySchemas) {
if (propertySchemas[key] !== O[key] && propertySchemas[key]) {
//ensure that instance property is valid
propertySchemas[key].validate(instance.getProperty(key), report, instance, schema, key);
}
}
}
}
},
"items" : {
"type" : [{"$ref" : "#"}, "array"],
"items" : {"$ref" : "#"},
"optional" : true,
"default" : {},
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
} else if (instance.getType() === "array") {
return JSV.mapArray(instance.getProperties(), function (instance) {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
});
}
//else
return instance.getEnvironment().createEmptySchema();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var properties, items, x, xl, itemSchema, additionalProperties;
if (instance.getType() === "array") {
properties = instance.getProperties();
items = schema.getAttribute("items");
additionalProperties = schema.getAttribute("additionalProperties");
if (JSV.typeOf(items) === "array") {
for (x = 0, xl = properties.length; x < xl; ++x) {
itemSchema = items[x] || additionalProperties;
if (itemSchema !== false) {
itemSchema.validate(properties[x], report, instance, schema, x);
} else {
report.addError(instance, schema, "additionalProperties", "Additional items are not allowed", itemSchema);
}
}
} else {
itemSchema = items || additionalProperties;
for (x = 0, xl = properties.length; x < xl; ++x) {
itemSchema.validate(properties[x], report, instance, schema, x);
}
}
}
}
},
"optional" : {
"type" : "boolean",
"optional" : true,
"default" : false,
"parser" : function (instance, self) {
return !!instance.getValue();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
if (instance.getType() === "undefined" && !schema.getAttribute("optional")) {
report.addError(instance, schema, "optional", "Property is required", false);
}
},
"validationRequired" : true
},
"additionalProperties" : {
"type" : [{"$ref" : "#"}, "boolean"],
"optional" : true,
"default" : {},
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
} else if (instance.getType() === "boolean" && instance.getValue() === false) {
return false;
}
//else
return instance.getEnvironment().createEmptySchema();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var additionalProperties, propertySchemas, properties, key;
//we only need to check against object types as arrays do their own checking on this property
if (instance.getType() === "object") {
additionalProperties = schema.getAttribute("additionalProperties");
propertySchemas = schema.getAttribute("properties") || {};
properties = instance.getProperties();
for (key in properties) {
if (properties[key] !== O[key] && properties[key] && !propertySchemas[key]) {
if (JSV.isJSONSchema(additionalProperties)) {
additionalProperties.validate(properties[key], report, instance, schema, key);
} else if (additionalProperties === false) {
report.addError(instance, schema, "additionalProperties", "Additional properties are not allowed", additionalProperties);
}
}
}
}
}
},
"requires" : {
"type" : ["string", {"$ref" : "#"}],
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "string") {
return instance.getValue();
} else if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var requires;
if (instance.getType() !== "undefined" && parent && parent.getType() !== "undefined") {
requires = schema.getAttribute("requires");
if (typeof requires === "string") {
if (parent.getProperty(requires).getType() === "undefined") {
report.addError(instance, schema, "requires", 'Property requires sibling property "' + requires + '"', requires);
}
} else if (JSV.isJSONSchema(requires)) {
requires.validate(parent, report); //WATCH: A "requires" schema does not support the "requires" attribute
}
}
}
},
"minimum" : {
"type" : "number",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var minimum, minimumCanEqual;
if (instance.getType() === "number") {
minimum = schema.getAttribute("minimum");
minimumCanEqual = schema.getAttribute("minimumCanEqual");
if (typeof minimum === "number" && (instance.getValue() < minimum || (minimumCanEqual === false && instance.getValue() === minimum))) {
report.addError(instance, schema, "minimum", "Number is less then the required minimum value", minimum);
}
}
}
},
"maximum" : {
"type" : "number",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maximum, maximumCanEqual;
if (instance.getType() === "number") {
maximum = schema.getAttribute("maximum");
maximumCanEqual = schema.getAttribute("maximumCanEqual");
if (typeof maximum === "number" && (instance.getValue() > maximum || (maximumCanEqual === false && instance.getValue() === maximum))) {
report.addError(instance, schema, "maximum", "Number is greater then the required maximum value", maximum);
}
}
}
},
"minimumCanEqual" : {
"type" : "boolean",
"optional" : true,
"requires" : "minimum",
"default" : true,
"parser" : function (instance, self) {
if (instance.getType() === "boolean") {
return instance.getValue();
}
//else
return true;
}
},
"maximumCanEqual" : {
"type" : "boolean",
"optional" : true,
"requires" : "maximum",
"default" : true,
"parser" : function (instance, self) {
if (instance.getType() === "boolean") {
return instance.getValue();
}
//else
return true;
}
},
"minItems" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"default" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
//else
return 0;
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var minItems;
if (instance.getType() === "array") {
minItems = schema.getAttribute("minItems");
if (typeof minItems === "number" && instance.getProperties().length < minItems) {
report.addError(instance, schema, "minItems", "The number of items is less then the required minimum", minItems);
}
}
}
},
"maxItems" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maxItems;
if (instance.getType() === "array") {
maxItems = schema.getAttribute("maxItems");
if (typeof maxItems === "number" && instance.getProperties().length > maxItems) {
report.addError(instance, schema, "maxItems", "The number of items is greater then the required maximum", maxItems);
}
}
}
},
"pattern" : {
"type" : "string",
"optional" : true,
"format" : "regex",
"parser" : function (instance, self) {
if (instance.getType() === "string") {
try {
return new RegExp(instance.getValue());
} catch (e) {
return e;
}
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var pattern;
try {
pattern = schema.getAttribute("pattern");
if (pattern instanceof Error) {
report.addError(instance, schema, "pattern", "Invalid pattern", pattern);
} else if (instance.getType() === "string" && pattern && !pattern.test(instance.getValue())) {
report.addError(instance, schema, "pattern", "String does not match pattern", pattern.toString());
}
} catch (e) {
report.addError(instance, schema, "pattern", "Invalid pattern", e);
}
}
},
"minLength" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"default" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
//else
return 0;
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var minLength;
if (instance.getType() === "string") {
minLength = schema.getAttribute("minLength");
if (typeof minLength === "number" && instance.getValue().length < minLength) {
report.addError(instance, schema, "minLength", "String is less then the required minimum length", minLength);
}
}
}
},
"maxLength" : {
"type" : "integer",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maxLength;
if (instance.getType() === "string") {
maxLength = schema.getAttribute("maxLength");
if (typeof maxLength === "number" && instance.getValue().length > maxLength) {
report.addError(instance, schema, "maxLength", "String is greater then the required maximum length", maxLength);
}
}
}
},
"enum" : {
"type" : "array",
"optional" : true,
"minItems" : 1,
"uniqueItems" : true,
"parser" : function (instance, self) {
if (instance.getType() === "array") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var enums, x, xl;
if (instance.getType() !== "undefined") {
enums = schema.getAttribute("enum");
if (enums) {
for (x = 0, xl = enums.length; x < xl; ++x) {
if (instance.equals(enums[x])) {
return true;
}
}
report.addError(instance, schema, "enum", "Instance is not one of the possible values", enums);
}
}
}
},
"title" : {
"type" : "string",
"optional" : true
},
"description" : {
"type" : "string",
"optional" : true
},
"format" : {
"type" : "string",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "string") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var format, formatValidators;
if (instance.getType() === "string") {
format = schema.getAttribute("format");
formatValidators = self.getValueOfProperty("formatValidators");
if (typeof format === "string" && formatValidators[format] !== O[format] && typeof formatValidators[format] === "function" && !formatValidators[format].call(this, instance, report)) {
report.addError(instance, schema, "format", "String is not in the required format", format);
}
}
},
"formatValidators" : {}
},
"contentEncoding" : {
"type" : "string",
"optional" : true
},
"default" : {
"type" : "any",
"optional" : true
},
"maxDecimal" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maxDecimal, decimals;
if (instance.getType() === "number") {
maxDecimal = schema.getAttribute("maxDecimal");
if (typeof maxDecimal === "number") {
decimals = instance.getValue().toString(10).split('.')[1];
if (decimals && decimals.length > maxDecimal) {
report.addError(instance, schema, "maxDecimal", "The number of decimal places is greater then the allowed maximum", maxDecimal);
}
}
}
}
},
"disallow" : {
"type" : ["string", "array"],
"items" : {"type" : "string"},
"optional" : true,
"uniqueItems" : true,
"parser" : function (instance, self) {
if (instance.getType() === "string" || instance.getType() === "array") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var disallowedTypes = JSV.toArray(schema.getAttribute("disallow")),
x, xl, key, typeValidators;
//for instances that are required to be a certain type
if (instance.getType() !== "undefined" && disallowedTypes && disallowedTypes.length) {
typeValidators = self.getValueOfProperty("typeValidators") || {};
//ensure that type matches for at least one of the required types
for (x = 0, xl = disallowedTypes.length; x < xl; ++x) {
key = disallowedTypes[x];
if (typeValidators[key] !== O[key] && typeof typeValidators[key] === "function") {
if (typeValidators[key](instance, report)) {
report.addError(instance, schema, "disallow", "Instance is a disallowed type", disallowedTypes);
return false;
}
}
/*
else {
report.addError(instance, schema, "disallow", "Instance may be a disallowed type", disallowedTypes);
return false;
}
*/
}
//if we get to this point, type is valid
return true;
}
//else, everything is allowed if no disallowed types are specified
return true;
},
"typeValidators" : TYPE_VALIDATORS
},
"extends" : {
"type" : [{"$ref" : "#"}, "array"],
"items" : {"$ref" : "#"},
"optional" : true,
"default" : {},
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
} else if (instance.getType() === "array") {
return JSV.mapArray(instance.getProperties(), function (instance) {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
});
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var extensions = schema.getAttribute("extends"), x, xl;
if (extensions) {
if (JSV.isJSONSchema(extensions)) {
extensions.validate(instance, report, parent, parentSchema, name);
} else if (JSV.typeOf(extensions) === "array") {
for (x = 0, xl = extensions.length; x < xl; ++x) {
extensions[x].validate(instance, report, parent, parentSchema, name);
}
}
}
}
}
},
"optional" : true,
"default" : {},
"fragmentResolution" : "dot-delimited",
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self);
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var propNames = schema.getPropertyNames(),
x, xl,
attributeSchemas = self.getAttribute("properties"),
validator;
for (x in attributeSchemas) {
if (attributeSchemas[x] !== O[x] && attributeSchemas[x].getValueOfProperty("validationRequired")) {
JSV.pushUnique(propNames, x);
}
}
for (x = 0, xl = propNames.length; x < xl; ++x) {
if (attributeSchemas[propNames[x]] !== O[propNames[x]]) {
validator = attributeSchemas[propNames[x]].getValueOfProperty("validator");
if (typeof validator === "function") {
validator(instance, schema, attributeSchemas[propNames[x]], report, parent, parentSchema, name);
}
}
}
},
"initializer" : function (instance) {
var link, extension, extended;
//if there is a link to a different schema, set reference
link = instance._schema.getLink("describedby", instance);
if (link && instance._schema._uri !== link) {
instance.setReference("describedby", link);
}
//if instance has a URI link to itself, update it's own URI
link = instance._schema.getLink("self", instance);
if (JSV.typeOf(link) === "string") {
instance._uri = JSV.formatURI(link);
}
//if there is a link to the full representation, set reference
link = instance._schema.getLink("full", instance);
if (link && instance._uri !== link) {
instance.setReference("full", link);
}
//extend schema
extension = instance.getAttribute("extends");
if (JSV.isJSONSchema(extension)) {
extended = JSV.inherits(extension, instance, true);
instance = instance._env.createSchema(extended, instance._schema, instance._uri);
}
return instance;
}
}, true, "http://json-schema.org/schema#");
HYPERSCHEMA = ENVIRONMENT.createSchema(JSV.inherits(SCHEMA, ENVIRONMENT.createSchema({
"$schema" : "http://json-schema.org/hyper-schema#",
"id" : "http://json-schema.org/hyper-schema#",
"properties" : {
"links" : {
"type" : "array",
"items" : {"$ref" : "links#"},
"optional" : true,
"parser" : function (instance, self, arg) {
var links,
linkSchemaURI = self.getValueOfProperty("items")["$ref"],
linkSchema = self.getEnvironment().findSchema(linkSchemaURI),
linkParser = linkSchema && linkSchema.getValueOfProperty("parser");
arg = JSV.toArray(arg);
if (typeof linkParser === "function") {
links = JSV.mapArray(instance.getProperties(), function (link) {
return linkParser(link, linkSchema);
});
} else {
links = JSV.toArray(instance.getValue());
}
if (arg[0]) {
links = JSV.filterArray(links, function (link) {
return link["rel"] === arg[0];
});
}
if (arg[1]) {
links = JSV.mapArray(links, function (link) {
var instance = arg[1],
href = link["href"];
href = href.replace(/\{(.+)\}/g, function (str, p1, offset, s) {
var value;
if (p1 === "-this") {
value = instance.getValue();
} else {
value = instance.getValueOfProperty(p1);
}
return value !== undefined ? String(value) : "";
});
return href ? JSV.formatURI(instance.resolveURI(href)) : href;
});
}
return links;
}
},
"fragmentResolution" : {
"type" : "string",
"optional" : true,
"default" : "dot-delimited"
},
"root" : {
"type" : "boolean",
"optional" : true,
"default" : false
},
"readonly" : {
"type" : "boolean",
"optional" : true,
"default" : false
},
"pathStart" : {
"type" : "string",
"optional" : true,
"format" : "uri",
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var pathStart;
if (instance.getType() !== "undefined") {
pathStart = schema.getAttribute("pathStart");
if (typeof pathStart === "string") {
//TODO: Find out what pathStart is relative to
if (instance.getURI().indexOf(pathStart) !== 0) {
report.addError(instance, schema, "pathStart", "Instance's URI does not start with " + pathStart, pathStart);
}
}
}
}
},
"mediaType" : {
"type" : "string",
"optional" : true,
"format" : "media-type"
},
"alternate" : {
"type" : "array",
"items" : {"$ref" : "#"},
"optional" : true
}
},
"links" : [
{
"href" : "{$ref}",
"rel" : "full"
},
{
"href" : "{$schema}",
"rel" : "describedby"
},
{
"href" : "{id}",
"rel" : "self"
}
]//,
//not needed as JSV.inherits does the job for us
//"extends" : {"$ref" : "http://json-schema.org/schema#"}
}, SCHEMA), true), true, "http://json-schema.org/hyper-schema#");
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/hyper-schema#");
LINKS = ENVIRONMENT.createSchema({
"$schema" : "http://json-schema.org/hyper-schema#",
"id" : "http://json-schema.org/links#",
"type" : "object",
"properties" : {
"href" : {
"type" : "string"
},
"rel" : {
"type" : "string"
},
"method" : {
"type" : "string",
"default" : "GET",
"optional" : true
},
"enctype" : {
"type" : "string",
"requires" : "method",
"optional" : true
},
"properties" : {
"type" : "object",
"additionalProperties" : {"$ref" : "hyper-schema#"},
"optional" : true,
"parser" : function (instance, self, arg) {
var env = instance.getEnvironment(),
selfEnv = self.getEnvironment(),
additionalPropertiesSchemaURI = self.getValueOfProperty("additionalProperties")["$ref"];
if (instance.getType() === "object") {
if (arg) {
return env.createSchema(instance.getProperty(arg), selfEnv.findSchema(self.resolveURI(additionalPropertiesSchemaURI)));
} else {
return JSV.mapObject(instance.getProperties(), function (instance) {
return env.createSchema(instance, selfEnv.findSchema(self.resolveURI(additionalPropertiesSchemaURI)));
});
}
}
}
}
},
"parser" : function (instance, self) {
var selfProperties = self.getProperty("properties");
if (instance.getType() === "object") {
return JSV.mapObject(instance.getProperties(), function (property, key) {
var propertySchema = selfProperties.getProperty(key),
parser = propertySchema && propertySchema.getValueOfProperty("parser");
if (typeof parser === "function") {
return parser(property, propertySchema);
}
//else
return property.getValue();
});
}
return instance.getValue();
}
}, HYPERSCHEMA, "http://json-schema.org/links#");
JSV.registerEnvironment("json-schema-draft-00", ENVIRONMENT);
JSV.registerEnvironment("json-schema-draft-01", JSV.createEnvironment("json-schema-draft-00"));
if (!JSV.getDefaultEnvironmentID()) {
JSV.setDefaultEnvironmentID("json-schema-draft-01");
}
}()); package/lib/json-schema-draft-03.js 0000644 0001750 0001750 00000144644 11727717626 016277 0 ustar david david /**
* json-schema-draft-03 Environment
*
* @fileOverview Implementation of the third revision of the JSON Schema specification draft.
* @author Gary Court
* @version 1.4
* @see http://github.com/garycourt/JSV
*/
/*
* Copyright 2010 Gary Court. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY GARY COURT ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARY COURT OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of Gary Court or the JSON Schema specification.
*/
/*jslint white: true, sub: true, onevar: true, undef: true, eqeqeq: true, newcap: true, immed: true, indent: 4 */
/*global require */
(function () {
var O = {},
JSV = require('./jsv').JSV,
TYPE_VALIDATORS,
ENVIRONMENT,
SCHEMA_00_JSON,
HYPERSCHEMA_00_JSON,
LINKS_00_JSON,
SCHEMA_00,
HYPERSCHEMA_00,
LINKS_00,
SCHEMA_01_JSON,
HYPERSCHEMA_01_JSON,
LINKS_01_JSON,
SCHEMA_01,
HYPERSCHEMA_01,
LINKS_01,
SCHEMA_02_JSON,
HYPERSCHEMA_02_JSON,
LINKS_02_JSON,
SCHEMA_02,
HYPERSCHEMA_02,
LINKS_02,
SCHEMA_03_JSON,
HYPERSCHEMA_03_JSON,
LINKS_03_JSON,
SCHEMA_03,
HYPERSCHEMA_03,
LINKS_03;
TYPE_VALIDATORS = {
"string" : function (instance, report) {
return instance.getType() === "string";
},
"number" : function (instance, report) {
return instance.getType() === "number";
},
"integer" : function (instance, report) {
return instance.getType() === "number" && instance.getValue() % 1 === 0;
},
"boolean" : function (instance, report) {
return instance.getType() === "boolean";
},
"object" : function (instance, report) {
return instance.getType() === "object";
},
"array" : function (instance, report) {
return instance.getType() === "array";
},
"null" : function (instance, report) {
return instance.getType() === "null";
},
"any" : function (instance, report) {
return true;
}
};
ENVIRONMENT = new JSV.Environment();
ENVIRONMENT.setOption("validateReferences", true);
ENVIRONMENT.setOption("enforceReferences", false);
ENVIRONMENT.setOption("strict", false);
//
// draft-00
//
SCHEMA_00_JSON = {
"$schema" : "http://json-schema.org/draft-00/hyper-schema#",
"id" : "http://json-schema.org/draft-00/schema#",
"type" : "object",
"properties" : {
"type" : {
"type" : ["string", "array"],
"items" : {
"type" : ["string", {"$ref" : "#"}]
},
"optional" : true,
"uniqueItems" : true,
"default" : "any",
"parser" : function (instance, self) {
var parser;
if (instance.getType() === "string") {
return instance.getValue();
} else if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(
instance,
self.getEnvironment().findSchema(self.resolveURI("#"))
);
} else if (instance.getType() === "array") {
parser = self.getValueOfProperty("parser");
return JSV.mapArray(instance.getProperties(), function (prop) {
return parser(prop, self);
});
}
//else
return "any";
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var requiredTypes = JSV.toArray(schema.getAttribute("type")),
x, xl, type, subreport, typeValidators;
//for instances that are required to be a certain type
if (instance.getType() !== "undefined" && requiredTypes && requiredTypes.length) {
typeValidators = self.getValueOfProperty("typeValidators") || {};
//ensure that type matches for at least one of the required types
for (x = 0, xl = requiredTypes.length; x < xl; ++x) {
type = requiredTypes[x];
if (JSV.isJSONSchema(type)) {
subreport = JSV.createObject(report);
subreport.errors = [];
subreport.validated = JSV.clone(report.validated);
if (type.validate(instance, subreport, parent, parentSchema, name).errors.length === 0) {
return true; //instance matches this schema
}
} else {
if (typeValidators[type] !== O[type] && typeof typeValidators[type] === "function") {
if (typeValidators[type](instance, report)) {
return true; //type is valid
}
} else {
return true; //unknown types are assumed valid
}
}
}
//if we get to this point, type is invalid
report.addError(instance, schema, "type", "Instance is not a required type", requiredTypes);
return false;
}
//else, anything is allowed if no type is specified
return true;
},
"typeValidators" : TYPE_VALIDATORS
},
"properties" : {
"type" : "object",
"additionalProperties" : {"$ref" : "#"},
"optional" : true,
"default" : {},
"parser" : function (instance, self, arg) {
var env = instance.getEnvironment(),
selfEnv = self.getEnvironment();
if (instance.getType() === "object") {
if (arg) {
return env.createSchema(instance.getProperty(arg), selfEnv.findSchema(self.resolveURI("#")));
} else {
return JSV.mapObject(instance.getProperties(), function (instance) {
return env.createSchema(instance, selfEnv.findSchema(self.resolveURI("#")));
});
}
}
//else
return {};
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var propertySchemas, key;
//this attribute is for object type instances only
if (instance.getType() === "object") {
//for each property defined in the schema
propertySchemas = schema.getAttribute("properties");
for (key in propertySchemas) {
if (propertySchemas[key] !== O[key] && propertySchemas[key]) {
//ensure that instance property is valid
propertySchemas[key].validate(instance.getProperty(key), report, instance, schema, key);
}
}
}
}
},
"items" : {
"type" : [{"$ref" : "#"}, "array"],
"items" : {"$ref" : "#"},
"optional" : true,
"default" : {},
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
} else if (instance.getType() === "array") {
return JSV.mapArray(instance.getProperties(), function (instance) {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
});
}
//else
return instance.getEnvironment().createEmptySchema();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var properties, items, x, xl, itemSchema, additionalProperties;
if (instance.getType() === "array") {
properties = instance.getProperties();
items = schema.getAttribute("items");
additionalProperties = schema.getAttribute("additionalProperties");
if (JSV.typeOf(items) === "array") {
for (x = 0, xl = properties.length; x < xl; ++x) {
itemSchema = items[x] || additionalProperties;
if (itemSchema !== false) {
itemSchema.validate(properties[x], report, instance, schema, x);
} else {
report.addError(instance, schema, "additionalProperties", "Additional items are not allowed", itemSchema);
}
}
} else {
itemSchema = items || additionalProperties;
for (x = 0, xl = properties.length; x < xl; ++x) {
itemSchema.validate(properties[x], report, instance, schema, x);
}
}
}
}
},
"optional" : {
"type" : "boolean",
"optional" : true,
"default" : false,
"parser" : function (instance, self) {
return !!instance.getValue();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
if (instance.getType() === "undefined" && !schema.getAttribute("optional")) {
report.addError(instance, schema, "optional", "Property is required", false);
}
},
"validationRequired" : true
},
"additionalProperties" : {
"type" : [{"$ref" : "#"}, "boolean"],
"optional" : true,
"default" : {},
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
} else if (instance.getType() === "boolean" && instance.getValue() === false) {
return false;
}
//else
return instance.getEnvironment().createEmptySchema();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var additionalProperties, propertySchemas, properties, key;
//we only need to check against object types as arrays do their own checking on this property
if (instance.getType() === "object") {
additionalProperties = schema.getAttribute("additionalProperties");
propertySchemas = schema.getAttribute("properties") || {};
properties = instance.getProperties();
for (key in properties) {
if (properties[key] !== O[key] && properties[key] && propertySchemas[key] === O[key]) {
if (JSV.isJSONSchema(additionalProperties)) {
additionalProperties.validate(properties[key], report, instance, schema, key);
} else if (additionalProperties === false) {
report.addError(instance, schema, "additionalProperties", "Additional properties are not allowed", additionalProperties);
}
}
}
}
}
},
"requires" : {
"type" : ["string", {"$ref" : "#"}],
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "string") {
return instance.getValue();
} else if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var requires;
if (instance.getType() !== "undefined" && parent && parent.getType() !== "undefined") {
requires = schema.getAttribute("requires");
if (typeof requires === "string") {
if (parent.getProperty(requires).getType() === "undefined") {
report.addError(instance, schema, "requires", 'Property requires sibling property "' + requires + '"', requires);
}
} else if (JSV.isJSONSchema(requires)) {
requires.validate(parent, report); //WATCH: A "requires" schema does not support the "requires" attribute
}
}
}
},
"minimum" : {
"type" : "number",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var minimum, minimumCanEqual;
if (instance.getType() === "number") {
minimum = schema.getAttribute("minimum");
minimumCanEqual = schema.getAttribute("minimumCanEqual");
if (typeof minimum === "number" && (instance.getValue() < minimum || (minimumCanEqual === false && instance.getValue() === minimum))) {
report.addError(instance, schema, "minimum", "Number is less then the required minimum value", minimum);
}
}
}
},
"maximum" : {
"type" : "number",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maximum, maximumCanEqual;
if (instance.getType() === "number") {
maximum = schema.getAttribute("maximum");
maximumCanEqual = schema.getAttribute("maximumCanEqual");
if (typeof maximum === "number" && (instance.getValue() > maximum || (maximumCanEqual === false && instance.getValue() === maximum))) {
report.addError(instance, schema, "maximum", "Number is greater then the required maximum value", maximum);
}
}
}
},
"minimumCanEqual" : {
"type" : "boolean",
"optional" : true,
"requires" : "minimum",
"default" : true,
"parser" : function (instance, self) {
if (instance.getType() === "boolean") {
return instance.getValue();
}
//else
return true;
}
},
"maximumCanEqual" : {
"type" : "boolean",
"optional" : true,
"requires" : "maximum",
"default" : true,
"parser" : function (instance, self) {
if (instance.getType() === "boolean") {
return instance.getValue();
}
//else
return true;
}
},
"minItems" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"default" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
//else
return 0;
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var minItems;
if (instance.getType() === "array") {
minItems = schema.getAttribute("minItems");
if (typeof minItems === "number" && instance.getProperties().length < minItems) {
report.addError(instance, schema, "minItems", "The number of items is less then the required minimum", minItems);
}
}
}
},
"maxItems" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maxItems;
if (instance.getType() === "array") {
maxItems = schema.getAttribute("maxItems");
if (typeof maxItems === "number" && instance.getProperties().length > maxItems) {
report.addError(instance, schema, "maxItems", "The number of items is greater then the required maximum", maxItems);
}
}
}
},
"pattern" : {
"type" : "string",
"optional" : true,
"format" : "regex",
"parser" : function (instance, self) {
if (instance.getType() === "string") {
try {
return new RegExp(instance.getValue());
} catch (e) {
return e;
}
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var pattern;
try {
pattern = schema.getAttribute("pattern");
if (pattern instanceof Error) {
report.addError(schema, self, "pattern", "Invalid pattern", schema.getValueOfProperty("pattern"));
} else if (instance.getType() === "string" && pattern && !pattern.test(instance.getValue())) {
report.addError(instance, schema, "pattern", "String does not match pattern", pattern.toString());
}
} catch (e) {
report.addError(schema, self, "pattern", "Invalid pattern", schema.getValueOfProperty("pattern"));
}
}
},
"minLength" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"default" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
//else
return 0;
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var minLength;
if (instance.getType() === "string") {
minLength = schema.getAttribute("minLength");
if (typeof minLength === "number" && instance.getValue().length < minLength) {
report.addError(instance, schema, "minLength", "String is less then the required minimum length", minLength);
}
}
}
},
"maxLength" : {
"type" : "integer",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maxLength;
if (instance.getType() === "string") {
maxLength = schema.getAttribute("maxLength");
if (typeof maxLength === "number" && instance.getValue().length > maxLength) {
report.addError(instance, schema, "maxLength", "String is greater then the required maximum length", maxLength);
}
}
}
},
"enum" : {
"type" : "array",
"optional" : true,
"minItems" : 1,
"uniqueItems" : true,
"parser" : function (instance, self) {
if (instance.getType() === "array") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var enums, x, xl;
if (instance.getType() !== "undefined") {
enums = schema.getAttribute("enum");
if (enums) {
for (x = 0, xl = enums.length; x < xl; ++x) {
if (instance.equals(enums[x])) {
return true;
}
}
report.addError(instance, schema, "enum", "Instance is not one of the possible values", enums);
}
}
}
},
"title" : {
"type" : "string",
"optional" : true
},
"description" : {
"type" : "string",
"optional" : true
},
"format" : {
"type" : "string",
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "string") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var format, formatValidators;
if (instance.getType() === "string") {
format = schema.getAttribute("format");
formatValidators = self.getValueOfProperty("formatValidators");
if (typeof format === "string" && formatValidators[format] !== O[format] && typeof formatValidators[format] === "function" && !formatValidators[format].call(this, instance, report)) {
report.addError(instance, schema, "format", "String is not in the required format", format);
}
}
},
"formatValidators" : {}
},
"contentEncoding" : {
"type" : "string",
"optional" : true
},
"default" : {
"type" : "any",
"optional" : true
},
"maxDecimal" : {
"type" : "integer",
"optional" : true,
"minimum" : 0,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maxDecimal, decimals;
if (instance.getType() === "number") {
maxDecimal = schema.getAttribute("maxDecimal");
if (typeof maxDecimal === "number") {
decimals = instance.getValue().toString(10).split('.')[1];
if (decimals && decimals.length > maxDecimal) {
report.addError(instance, schema, "maxDecimal", "The number of decimal places is greater then the allowed maximum", maxDecimal);
}
}
}
}
},
"disallow" : {
"type" : ["string", "array"],
"items" : {"type" : "string"},
"optional" : true,
"uniqueItems" : true,
"parser" : function (instance, self) {
if (instance.getType() === "string" || instance.getType() === "array") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var disallowedTypes = JSV.toArray(schema.getAttribute("disallow")),
x, xl, key, typeValidators, subreport;
//for instances that are required to be a certain type
if (instance.getType() !== "undefined" && disallowedTypes && disallowedTypes.length) {
typeValidators = self.getValueOfProperty("typeValidators") || {};
//ensure that type matches for at least one of the required types
for (x = 0, xl = disallowedTypes.length; x < xl; ++x) {
key = disallowedTypes[x];
if (JSV.isJSONSchema(key)) { //this is supported draft-03 and on
subreport = JSV.createObject(report);
subreport.errors = [];
subreport.validated = JSV.clone(report.validated);
if (key.validate(instance, subreport, parent, parentSchema, name).errors.length === 0) {
//instance matches this schema
report.addError(instance, schema, "disallow", "Instance is a disallowed type", disallowedTypes);
return false;
}
} else if (typeValidators[key] !== O[key] && typeof typeValidators[key] === "function") {
if (typeValidators[key](instance, report)) {
report.addError(instance, schema, "disallow", "Instance is a disallowed type", disallowedTypes);
return false;
}
}
/*
else {
report.addError(instance, schema, "disallow", "Instance may be a disallowed type", disallowedTypes);
return false;
}
*/
}
//if we get to this point, type is valid
return true;
}
//else, everything is allowed if no disallowed types are specified
return true;
},
"typeValidators" : TYPE_VALIDATORS
},
"extends" : {
"type" : [{"$ref" : "#"}, "array"],
"items" : {"$ref" : "#"},
"optional" : true,
"default" : {},
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
} else if (instance.getType() === "array") {
return JSV.mapArray(instance.getProperties(), function (instance) {
return instance.getEnvironment().createSchema(instance, self.getEnvironment().findSchema(self.resolveURI("#")));
});
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var extensions = schema.getAttribute("extends"), x, xl;
if (extensions) {
if (JSV.isJSONSchema(extensions)) {
extensions.validate(instance, report, parent, parentSchema, name);
} else if (JSV.typeOf(extensions) === "array") {
for (x = 0, xl = extensions.length; x < xl; ++x) {
extensions[x].validate(instance, report, parent, parentSchema, name);
}
}
}
}
}
},
"optional" : true,
"default" : {},
"fragmentResolution" : "dot-delimited",
"parser" : function (instance, self) {
if (instance.getType() === "object") {
return instance.getEnvironment().createSchema(instance, self);
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var propNames = schema.getPropertyNames(),
x, xl,
attributeSchemas = self.getAttribute("properties"),
strict = instance.getEnvironment().getOption("strict"),
validator;
for (x in attributeSchemas) {
if (attributeSchemas[x] !== O[x]) {
if (attributeSchemas[x].getValueOfProperty("validationRequired")) {
JSV.pushUnique(propNames, x);
}
if (strict && attributeSchemas[x].getValueOfProperty("deprecated")) {
JSV.popFirst(propNames, x);
}
}
}
for (x = 0, xl = propNames.length; x < xl; ++x) {
if (attributeSchemas[propNames[x]] !== O[propNames[x]]) {
validator = attributeSchemas[propNames[x]].getValueOfProperty("validator");
if (typeof validator === "function") {
validator(instance, schema, attributeSchemas[propNames[x]], report, parent, parentSchema, name);
}
}
}
}
};
HYPERSCHEMA_00_JSON = {
"$schema" : "http://json-schema.org/draft-00/hyper-schema#",
"id" : "http://json-schema.org/draft-00/hyper-schema#",
"properties" : {
"links" : {
"type" : "array",
"items" : {"$ref" : "links#"},
"optional" : true,
"parser" : function (instance, self, arg) {
var links,
linkSchemaURI = self.getValueOfProperty("items")["$ref"],
linkSchema = self.getEnvironment().findSchema(linkSchemaURI),
linkParser = linkSchema && linkSchema.getValueOfProperty("parser"),
selfReferenceVariable;
arg = JSV.toArray(arg);
if (typeof linkParser === "function") {
links = JSV.mapArray(instance.getProperties(), function (link) {
return linkParser(link, linkSchema);
});
} else {
links = JSV.toArray(instance.getValue());
}
if (arg[0]) {
links = JSV.filterArray(links, function (link) {
return link["rel"] === arg[0];
});
}
if (arg[1]) {
selfReferenceVariable = self.getValueOfProperty("selfReferenceVariable");
links = JSV.mapArray(links, function (link) {
var instance = arg[1],
href = link["href"];
href = href.replace(/\{(.+)\}/g, function (str, p1, offset, s) {
var value;
if (p1 === selfReferenceVariable) {
value = instance.getValue();
} else {
value = instance.getValueOfProperty(p1);
}
return value !== undefined ? String(value) : "";
});
return href ? JSV.formatURI(instance.resolveURI(href)) : href;
});
}
return links;
},
"selfReferenceVariable" : "-this"
},
"fragmentResolution" : {
"type" : "string",
"optional" : true,
"default" : "dot-delimited"
},
"root" : {
"type" : "boolean",
"optional" : true,
"default" : false
},
"readonly" : {
"type" : "boolean",
"optional" : true,
"default" : false
},
"pathStart" : {
"type" : "string",
"optional" : true,
"format" : "uri",
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var pathStart;
if (instance.getType() !== "undefined") {
pathStart = schema.getAttribute("pathStart");
if (typeof pathStart === "string") {
//TODO: Find out what pathStart is relative to
if (instance.getURI().indexOf(pathStart) !== 0) {
report.addError(instance, schema, "pathStart", "Instance's URI does not start with " + pathStart, pathStart);
}
}
}
}
},
"mediaType" : {
"type" : "string",
"optional" : true,
"format" : "media-type"
},
"alternate" : {
"type" : "array",
"items" : {"$ref" : "#"},
"optional" : true
}
},
"links" : [
{
"href" : "{$ref}",
"rel" : "full"
},
{
"href" : "{$schema}",
"rel" : "describedby"
},
{
"href" : "{id}",
"rel" : "self"
}
],
"initializer" : function (instance) {
var link, extension, extended;
//if there is a link to a different schema, set reference
link = instance._schema.getLink("describedby", instance);
if (link && instance._schema._uri !== link) {
instance.setReference("describedby", link);
}
//if instance has a URI link to itself, update it's own URI
link = instance._schema.getLink("self", instance);
if (JSV.typeOf(link) === "string") {
instance._uri = JSV.formatURI(link);
}
//if there is a link to the full representation, set reference
link = instance._schema.getLink("full", instance);
if (link && instance._uri !== link) {
instance.setReference("full", link);
}
//extend schema
extension = instance.getAttribute("extends");
if (JSV.isJSONSchema(extension)) {
extended = JSV.inherits(extension, instance, true);
instance = instance._env.createSchema(extended, instance._schema, instance._uri);
}
return instance;
}
//not needed as JSV.inherits does the job for us
//"extends" : {"$ref" : "http://json-schema.org/schema#"}
};
LINKS_00_JSON = {
"$schema" : "http://json-schema.org/draft-00/hyper-schema#",
"id" : "http://json-schema.org/draft-00/links#",
"type" : "object",
"properties" : {
"href" : {
"type" : "string"
},
"rel" : {
"type" : "string"
},
"method" : {
"type" : "string",
"default" : "GET",
"optional" : true
},
"enctype" : {
"type" : "string",
"requires" : "method",
"optional" : true
},
"properties" : {
"type" : "object",
"additionalProperties" : {"$ref" : "hyper-schema#"},
"optional" : true,
"parser" : function (instance, self, arg) {
var env = instance.getEnvironment(),
selfEnv = self.getEnvironment(),
additionalPropertiesSchemaURI = self.getValueOfProperty("additionalProperties")["$ref"];
if (instance.getType() === "object") {
if (arg) {
return env.createSchema(instance.getProperty(arg), selfEnv.findSchema(self.resolveURI(additionalPropertiesSchemaURI)));
} else {
return JSV.mapObject(instance.getProperties(), function (instance) {
return env.createSchema(instance, selfEnv.findSchema(self.resolveURI(additionalPropertiesSchemaURI)));
});
}
}
}
}
},
"parser" : function (instance, self) {
var selfProperties = self.getProperty("properties");
if (instance.getType() === "object") {
return JSV.mapObject(instance.getProperties(), function (property, key) {
var propertySchema = selfProperties.getProperty(key),
parser = propertySchema && propertySchema.getValueOfProperty("parser");
if (typeof parser === "function") {
return parser(property, propertySchema);
}
//else
return property.getValue();
});
}
return instance.getValue();
}
};
ENVIRONMENT.setOption("defaultFragmentDelimiter", ".");
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/draft-00/schema#"); //updated later
SCHEMA_00 = ENVIRONMENT.createSchema(SCHEMA_00_JSON, true, "http://json-schema.org/draft-00/schema#");
HYPERSCHEMA_00 = ENVIRONMENT.createSchema(JSV.inherits(SCHEMA_00, ENVIRONMENT.createSchema(HYPERSCHEMA_00_JSON, true, "http://json-schema.org/draft-00/hyper-schema#"), true), true, "http://json-schema.org/draft-00/hyper-schema#");
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/draft-00/hyper-schema#");
LINKS_00 = ENVIRONMENT.createSchema(LINKS_00_JSON, HYPERSCHEMA_00, "http://json-schema.org/draft-00/links#");
//
// draft-01
//
SCHEMA_01_JSON = JSV.inherits(SCHEMA_00_JSON, {
"$schema" : "http://json-schema.org/draft-01/hyper-schema#",
"id" : "http://json-schema.org/draft-01/schema#"
});
HYPERSCHEMA_01_JSON = JSV.inherits(HYPERSCHEMA_00_JSON, {
"$schema" : "http://json-schema.org/draft-01/hyper-schema#",
"id" : "http://json-schema.org/draft-01/hyper-schema#"
});
LINKS_01_JSON = JSV.inherits(LINKS_00_JSON, {
"$schema" : "http://json-schema.org/draft-01/hyper-schema#",
"id" : "http://json-schema.org/draft-01/links#"
});
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/draft-01/schema#"); //update later
SCHEMA_01 = ENVIRONMENT.createSchema(SCHEMA_01_JSON, true, "http://json-schema.org/draft-01/schema#");
HYPERSCHEMA_01 = ENVIRONMENT.createSchema(JSV.inherits(SCHEMA_01, ENVIRONMENT.createSchema(HYPERSCHEMA_01_JSON, true, "http://json-schema.org/draft-01/hyper-schema#"), true), true, "http://json-schema.org/draft-01/hyper-schema#");
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/draft-01/hyper-schema#");
LINKS_01 = ENVIRONMENT.createSchema(LINKS_01_JSON, HYPERSCHEMA_01, "http://json-schema.org/draft-01/links#");
//
// draft-02
//
SCHEMA_02_JSON = JSV.inherits(SCHEMA_01_JSON, {
"$schema" : "http://json-schema.org/draft-02/hyper-schema#",
"id" : "http://json-schema.org/draft-02/schema#",
"properties" : {
"uniqueItems" : {
"type" : "boolean",
"optional" : true,
"default" : false,
"parser" : function (instance, self) {
return !!instance.getValue();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var value, x, xl, y, yl;
if (instance.getType() === "array" && schema.getAttribute("uniqueItems")) {
value = instance.getProperties();
for (x = 0, xl = value.length - 1; x < xl; ++x) {
for (y = x + 1, yl = value.length; y < yl; ++y) {
if (value[x].equals(value[y])) {
report.addError(instance, schema, "uniqueItems", "Array can only contain unique items", { x : x, y : y });
}
}
}
}
}
},
"maxDecimal" : {
"deprecated" : true
},
"divisibleBy" : {
"type" : "number",
"minimum" : 0,
"minimumCanEqual" : false,
"optional" : true,
"parser" : function (instance, self) {
if (instance.getType() === "number") {
return instance.getValue();
}
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var divisor, value, digits;
if (instance.getType() === "number") {
divisor = schema.getAttribute("divisibleBy");
if (divisor === 0) {
report.addError(instance, schema, "divisibleBy", "Nothing is divisible by 0", divisor);
} else if (divisor !== 1) {
value = instance.getValue();
digits = Math.max((value.toString().split(".")[1] || " ").length, (divisor.toString().split(".")[1] || " ").length);
digits = parseFloat(((value / divisor) % 1).toFixed(digits)); //cut out floating point errors
if (0 < digits && digits < 1) {
report.addError(instance, schema, "divisibleBy", "Number is not divisible by " + divisor, divisor);
}
}
}
}
}
},
"fragmentResolution" : "slash-delimited"
});
HYPERSCHEMA_02_JSON = JSV.inherits(HYPERSCHEMA_01_JSON, {
"id" : "http://json-schema.org/draft-02/hyper-schema#",
"properties" : {
"fragmentResolution" : {
"default" : "slash-delimited"
}
}
});
LINKS_02_JSON = JSV.inherits(LINKS_01_JSON, {
"$schema" : "http://json-schema.org/draft-02/hyper-schema#",
"id" : "http://json-schema.org/draft-02/links#",
"properties" : {
"targetSchema" : {
"$ref" : "hyper-schema#",
//need this here because parsers are run before links are resolved
"parser" : HYPERSCHEMA_01.getAttribute("parser")
}
}
});
ENVIRONMENT.setOption("defaultFragmentDelimiter", "/");
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/draft-02/schema#"); //update later
SCHEMA_02 = ENVIRONMENT.createSchema(SCHEMA_02_JSON, true, "http://json-schema.org/draft-02/schema#");
HYPERSCHEMA_02 = ENVIRONMENT.createSchema(JSV.inherits(SCHEMA_02, ENVIRONMENT.createSchema(HYPERSCHEMA_02_JSON, true, "http://json-schema.org/draft-02/hyper-schema#"), true), true, "http://json-schema.org/draft-02/hyper-schema#");
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/draft-02/hyper-schema#");
LINKS_02 = ENVIRONMENT.createSchema(LINKS_02_JSON, HYPERSCHEMA_02, "http://json-schema.org/draft-02/links#");
//
// draft-03
//
function getMatchedPatternProperties(instance, schema, report, self) {
var matchedProperties = {}, patternProperties, pattern, regexp, properties, key;
if (instance.getType() === "object") {
patternProperties = schema.getAttribute("patternProperties");
properties = instance.getProperties();
for (pattern in patternProperties) {
if (patternProperties[pattern] !== O[pattern]) {
regexp = null;
try {
regexp = new RegExp(pattern);
} catch (e) {
if (report) {
report.addError(schema, self, "patternProperties", "Invalid pattern", pattern);
}
}
if (regexp) {
for (key in properties) {
if (properties[key] !== O[key] && regexp.test(key)) {
matchedProperties[key] = matchedProperties[key] ? JSV.pushUnique(matchedProperties[key], patternProperties[pattern]) : [ patternProperties[pattern] ];
}
}
}
}
}
}
return matchedProperties;
}
SCHEMA_03_JSON = JSV.inherits(SCHEMA_02_JSON, {
"$schema" : "http://json-schema.org/draft-03/schema#",
"id" : "http://json-schema.org/draft-03/schema#",
"properties" : {
"patternProperties" : {
"type" : "object",
"additionalProperties" : {"$ref" : "#"},
"default" : {},
"parser" : SCHEMA_02.getValueOfProperty("properties")["properties"]["parser"],
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var matchedProperties, key, x;
if (instance.getType() === "object") {
matchedProperties = getMatchedPatternProperties(instance, schema, report, self);
for (key in matchedProperties) {
if (matchedProperties[key] !== O[key]) {
x = matchedProperties[key].length;
while (x--) {
matchedProperties[key][x].validate(instance.getProperty(key), report, instance, schema, key);
}
}
}
}
}
},
"additionalProperties" : {
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var additionalProperties, propertySchemas, properties, matchedProperties, key;
if (instance.getType() === "object") {
additionalProperties = schema.getAttribute("additionalProperties");
propertySchemas = schema.getAttribute("properties") || {};
properties = instance.getProperties();
matchedProperties = getMatchedPatternProperties(instance, schema);
for (key in properties) {
if (properties[key] !== O[key] && properties[key] && propertySchemas[key] === O[key] && matchedProperties[key] === O[key]) {
if (JSV.isJSONSchema(additionalProperties)) {
additionalProperties.validate(properties[key], report, instance, schema, key);
} else if (additionalProperties === false) {
report.addError(instance, schema, "additionalProperties", "Additional properties are not allowed", additionalProperties);
}
}
}
}
}
},
"items" : {
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var properties, items, x, xl, itemSchema, additionalItems;
if (instance.getType() === "array") {
properties = instance.getProperties();
items = schema.getAttribute("items");
additionalItems = schema.getAttribute("additionalItems");
if (JSV.typeOf(items) === "array") {
for (x = 0, xl = properties.length; x < xl; ++x) {
itemSchema = items[x] || additionalItems;
if (itemSchema !== false) {
itemSchema.validate(properties[x], report, instance, schema, x);
} else {
report.addError(instance, schema, "additionalItems", "Additional items are not allowed", itemSchema);
}
}
} else {
itemSchema = items || additionalItems;
for (x = 0, xl = properties.length; x < xl; ++x) {
itemSchema.validate(properties[x], report, instance, schema, x);
}
}
}
}
},
"additionalItems" : {
"type" : [{"$ref" : "#"}, "boolean"],
"default" : {},
"parser" : SCHEMA_02.getValueOfProperty("properties")["additionalProperties"]["parser"],
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var additionalItems, properties, x, xl;
//only validate if the "items" attribute is undefined
if (instance.getType() === "array" && schema.getProperty("items").getType() === "undefined") {
additionalItems = schema.getAttribute("additionalItems");
properties = instance.getProperties();
if (additionalItems !== false) {
for (x = 0, xl = properties.length; x < xl; ++x) {
additionalItems.validate(properties[x], report, instance, schema, x);
}
} else if (properties.length) {
report.addError(instance, schema, "additionalItems", "Additional items are not allowed", additionalItems);
}
}
}
},
"optional" : {
"validationRequired" : false,
"deprecated" : true
},
"required" : {
"type" : "boolean",
"default" : false,
"parser" : function (instance, self) {
return !!instance.getValue();
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
if (instance.getType() === "undefined" && schema.getAttribute("required")) {
report.addError(instance, schema, "required", "Property is required", true);
}
}
},
"requires" : {
"deprecated" : true
},
"dependencies" : {
"type" : "object",
"additionalProperties" : {
"type" : ["string", "array", {"$ref" : "#"}],
"items" : {
"type" : "string"
}
},
"default" : {},
"parser" : function (instance, self, arg) {
function parseProperty(property) {
var type = property.getType();
if (type === "string" || type === "array") {
return property.getValue();
} else if (type === "object") {
return property.getEnvironment().createSchema(property, self.getEnvironment().findSchema(self.resolveURI("#")));
}
}
if (instance.getType() === "object") {
if (arg) {
return parseProperty(instance.getProperty(arg));
} else {
return JSV.mapObject(instance.getProperties(), parseProperty);
}
}
//else
return {};
},
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var dependencies, key, dependency, type, x, xl;
if (instance.getType() === "object") {
dependencies = schema.getAttribute("dependencies");
for (key in dependencies) {
if (dependencies[key] !== O[key] && instance.getProperty(key).getType() !== "undefined") {
dependency = dependencies[key];
type = JSV.typeOf(dependency);
if (type === "string") {
if (instance.getProperty(dependency).getType() === "undefined") {
report.addError(instance, schema, "dependencies", 'Property "' + key + '" requires sibling property "' + dependency + '"', dependencies);
}
} else if (type === "array") {
for (x = 0, xl = dependency.length; x < xl; ++x) {
if (instance.getProperty(dependency[x]).getType() === "undefined") {
report.addError(instance, schema, "dependencies", 'Property "' + key + '" requires sibling property "' + dependency[x] + '"', dependencies);
}
}
} else if (JSV.isJSONSchema(dependency)) {
dependency.validate(instance, report);
}
}
}
}
}
},
"minimumCanEqual" : {
"deprecated" : true
},
"maximumCanEqual" : {
"deprecated" : true
},
"exclusiveMinimum" : {
"type" : "boolean",
"default" : false,
"parser" : function (instance, self) {
return !!instance.getValue();
}
},
"exclusiveMaximum" : {
"type" : "boolean",
"default" : false,
"parser" : function (instance, self) {
return !!instance.getValue();
}
},
"minimum" : {
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var minimum, exclusiveMinimum;
if (instance.getType() === "number") {
minimum = schema.getAttribute("minimum");
exclusiveMinimum = schema.getAttribute("exclusiveMinimum") || (!instance.getEnvironment().getOption("strict") && !schema.getAttribute("minimumCanEqual"));
if (typeof minimum === "number" && (instance.getValue() < minimum || (exclusiveMinimum === true && instance.getValue() === minimum))) {
report.addError(instance, schema, "minimum", "Number is less then the required minimum value", minimum);
}
}
}
},
"maximum" : {
"validator" : function (instance, schema, self, report, parent, parentSchema, name) {
var maximum, exclusiveMaximum;
if (instance.getType() === "number") {
maximum = schema.getAttribute("maximum");
exclusiveMaximum = schema.getAttribute("exclusiveMaximum") || (!instance.getEnvironment().getOption("strict") && !schema.getAttribute("maximumCanEqual"));
if (typeof maximum === "number" && (instance.getValue() > maximum || (exclusiveMaximum === true && instance.getValue() === maximum))) {
report.addError(instance, schema, "maximum", "Number is greater then the required maximum value", maximum);
}
}
}
},
"contentEncoding" : {
"deprecated" : true
},
"divisibleBy" : {
"exclusiveMinimum" : true
},
"disallow" : {
"items" : {
"type" : ["string", {"$ref" : "#"}]
},
"parser" : SCHEMA_02_JSON["properties"]["type"]["parser"]
},
"id" : {
"type" : "string",
"format" : "uri"
},
"$ref" : {
"type" : "string",
"format" : "uri"
},
"$schema" : {
"type" : "string",
"format" : "uri"
}
},
"dependencies" : {
"exclusiveMinimum" : "minimum",
"exclusiveMaximum" : "maximum"
},
"initializer" : function (instance) {
var link, extension, extended,
schemaLink = instance.getValueOfProperty("$schema"),
refLink = instance.getValueOfProperty("$ref"),
idLink = instance.getValueOfProperty("id");
//if there is a link to a different schema, set reference
if (schemaLink) {
link = instance.resolveURI(schemaLink);
instance.setReference("describedby", link);
}
//if instance has a URI link to itself, update it's own URI
if (idLink) {
link = instance.resolveURI(idLink);
if (JSV.typeOf(link) === "string") {
instance._uri = JSV.formatURI(link);
}
}
//if there is a link to the full representation, set reference
if (refLink) {
link = instance.resolveURI(refLink);
instance.setReference("full", link);
}
//extend schema
extension = instance.getAttribute("extends");
if (JSV.isJSONSchema(extension)) {
extended = JSV.inherits(extension, instance, true);
instance = instance._env.createSchema(extended, instance._schema, instance._uri);
}
return instance;
}
});
HYPERSCHEMA_03_JSON = JSV.inherits(HYPERSCHEMA_02_JSON, {
"$schema" : "http://json-schema.org/draft-03/hyper-schema#",
"id" : "http://json-schema.org/draft-03/hyper-schema#",
"properties" : {
"links" : {
"selfReferenceVariable" : "@"
},
"root" : {
"deprecated" : true
},
"contentEncoding" : {
"deprecated" : false //moved from core to hyper
},
"alternate" : {
"deprecated" : true
}
}
});
LINKS_03_JSON = JSV.inherits(LINKS_02_JSON, {
"$schema" : "http://json-schema.org/draft-03/hyper-schema#",
"id" : "http://json-schema.org/draft-03/links#",
"properties" : {
"href" : {
"required" : true,
"format" : "link-description-object-template"
},
"rel" : {
"required" : true
},
"properties" : {
"deprecated" : true
},
"schema" : {"$ref" : "http://json-schema.org/draft-03/hyper-schema#"}
}
});
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/draft-03/schema#"); //update later
SCHEMA_03 = ENVIRONMENT.createSchema(SCHEMA_03_JSON, true, "http://json-schema.org/draft-03/schema#");
HYPERSCHEMA_03 = ENVIRONMENT.createSchema(JSV.inherits(SCHEMA_03, ENVIRONMENT.createSchema(HYPERSCHEMA_03_JSON, true, "http://json-schema.org/draft-03/hyper-schema#"), true), true, "http://json-schema.org/draft-03/hyper-schema#");
ENVIRONMENT.setOption("defaultSchemaURI", "http://json-schema.org/draft-03/hyper-schema#");
LINKS_03 = ENVIRONMENT.createSchema(LINKS_03_JSON, true, "http://json-schema.org/draft-03/links#");
ENVIRONMENT.setOption("latestJSONSchemaSchemaURI", "http://json-schema.org/draft-03/schema#");
ENVIRONMENT.setOption("latestJSONSchemaHyperSchemaURI", "http://json-schema.org/draft-03/hyper-schema#");
ENVIRONMENT.setOption("latestJSONSchemaLinksURI", "http://json-schema.org/draft-03/links#");
//
//Latest JSON Schema
//
//Hack, but WAY faster then instantiating a new schema
ENVIRONMENT._schemas["http://json-schema.org/schema#"] = SCHEMA_03;
ENVIRONMENT._schemas["http://json-schema.org/hyper-schema#"] = HYPERSCHEMA_03;
ENVIRONMENT._schemas["http://json-schema.org/links#"] = LINKS_03;
//
//register environment
//
JSV.registerEnvironment("json-schema-draft-03", ENVIRONMENT);
if (!JSV.getDefaultEnvironmentID() || JSV.getDefaultEnvironmentID() === "json-schema-draft-01" || JSV.getDefaultEnvironmentID() === "json-schema-draft-02") {
JSV.setDefaultEnvironmentID("json-schema-draft-03");
}
}()); package/package.json 0000644 0001750 0001750 00000001411 11727717626 013714 0 ustar david david {
"name" : "JSV",
"version" : "4.0.0",
"description" : "A JavaScript implementation of a extendable, fully compliant JSON Schema validator.",
"homepage" : "http://github.com/garycourt/JSV",
"author" : "Gary Court ",
"licenses" : [
{
"type" : "FreeBSD",
"url" : "http://github.com/garycourt/JSV/raw/master/jsv.js"
}
],
"maintainers" : [
{
"name" : "Gary Court",
"email" : "gary.court@gmail.com"
}
],
"bugs" : {
"mail" : "gary.court@gmail.com",
"web" : "http://github.com/garycourt/JSV/issues"
},
"repositories" : [
{
"type" : "git",
"url" : "git://github.com/garycourt/JSV.git"
}
],
"dependencies" : [],
"main" : "lib/jsv.js",
"keywords" : ["json", "schema", "validator"]
}
package/README.md 0000644 0001750 0001750 00000020732 11727717626 012714 0 ustar david david JSV: JSON Schema Validator
==========================
JSV is a JavaScript implementation of a extendable, fully compliant JSON Schema validator with the following features:
* The fastest extendable JSON validator available!
* Complete implementation of all current JSON Schema draft revisions.
* Supports creating individual environments (sandboxes) that validate using a particular schema specification.
* Provides an intuitive API for creating new validating schema attributes, or whole new custom schema schemas.
* Supports `self`, `full` and `describedby` hyper links.
* Validates itself, and is bootstrapped from the JSON Schema schemas.
* Includes over 1100 unit tests for testing all parts of the specifications.
* Works in all ECMAScript 3 environments, including all web browsers and Node.js.
* Licensed under the FreeBSD License, a very open license.
## It's a what?
**JSON** (an acronym for **JavaScript Object Notation**) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. It is based on a subset of JavaScript/ECMA-262 3rd Edition. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages. (C, C++, C#, Java, JavaScript, Perl, Python, ...) These properties make JSON an ideal data-interchange language. \[[json.org](http://json.org)\]
**JSON Schema** is a JSON media type for defining the structure of JSON data. JSON Schema provides a contract for what JSON data is required for a given application and how to interact with it. JSON Schema is intended to define validation, documentation, hyperlink navigation, and interaction control of JSON data. \[[draft-zyp-json-schema-02](http://tools.ietf.org/html/draft-zyp-json-schema-02)\]
A **JSON validator** is a program that takes JSON data and, with a provided schema, will ensure that the provided JSON is structured in the way defined by the schema. This ensures that if validation has passed, the JSON instance is guaranteed to be in the expected format. It will also provide an explanation on why a particular instance failed validation.
## Example
Here's an example on how to validate some JSON with JSV:
var JSV = require("./jsv").JSV;
var json = {};
var schema = {"type" : "object"};
var env = JSV.createEnvironment();
var report = env.validate(json, schema);
if (report.errors.length === 0) {
//JSON is valid against the schema
}
Another example; for the following test:
env.validate({ a : 1 }, { type : 'object', properties : { a : { type : 'string' }} });
The generated report would look like:
{
errors : [
{
message : "Instance is not a required type",
uri : "urn:uuid:74b843b5-3aa4-44e9-b7bc-f555936fa823#/a",
schemaUri : "urn:uuid:837fdefe-3bd4-4993-9a20-38a6a0624d5a#/properties/a",
attribute : "type",
details : ["string"]
}
],
validated : {
"urn:uuid:74b843b5-3aa4-44e9-b7bc-f555936fa823#" : ["urn:uuid:837fdefe-3bd4-4993-9a20-38a6a0624d5a#"],
"urn:uuid:74b843b5-3aa4-44e9-b7bc-f555936fa823#/a" : ["urn:uuid:837fdefe-3bd4-4993-9a20-38a6a0624d5a#/properties/a"],
//...
},
instance : [JSONInstance object],
schema : [JSONSchema object],
schemaSchema : [JSONSchema object]
}
## Environments & JSON Schema support
There is no one way to validate JSON, just like there is no one way to validate XML. Even the JSON Schema specification has gone through several revisions which are not 100% backwards compatible with each other. To solve the issue of using numerous schemas already written to older specifications, JSV provides customizable environments to validate your JSON within.
When creating an environment, you can optionally specify how you want that environment to behave. For example, this allows you to specify which version of the JSON Schema you would like the environment to behave like. JSV already provides the following environments:
* `json-schema-draft-03`
A complete implementation of the [third revision](http://tools.ietf.org/html/draft-zyp-json-schema-03) of the JSON Schema specification. This is the same as the second revision, except:
* "optional" has been replaced by "required"
* "requires" has been replaced by "dependencies"
* "minimumCanEqual"/"maximumCanEqual" has been replaced by "exclusiveMinimum"/"exclusiveMaximum"
* "self"/"full"/"describedby" links have been moved to the core schema, and are provided by "id"/"$ref"/"$schema"
* Adds the attributes "patternSchema" and "additionalItems"
* Deprecates the attributes "root" and "alternate"
* Schemas are now versioned under the URIs "http://json-schema.org/draft-XX/", where XX is the draft number
In addition to this, all schemas from the previous versions of the JSON Schema draft are included in this environment, and are backwards compatible (where possible) with it's previous version.
This backwards compatibility can be disabled with the environment option `strict` is set to `true`.
This is currently the default environment.
* `json-schema-draft-02`
A complete implementation of the [second revision](http://tools.ietf.org/html/draft-zyp-json-schema-02) of the JSON Schema specification. This is the same as the first revision, except adds:
* "targetSchema" attribute
* slash-delimited fragment identifiers, which is now the default behavior
* `json-schema-draft-01`
A complete implementation of the [first revision](http://tools.ietf.org/html/draft-zyp-json-schema-01) of the JSON Schema specification, which is exactly the same as the [original draft](http://tools.ietf.org/html/draft-zyp-json-schema-00).
Users with JSON Schemas written for JSV < v2.1 should use this environment for it's dot-delimited fragment identifiers.
Environments can also be customized and registered for multiple reuse. (See the section on *Extending Environments* below)
## Validation API
The following methods are used to validate JSON data:
### JSV.createEnvironment(*environmentID?*) *->* *<Environment>*
* *environmentID* *<String>* *(optional)* The ID of the environment to clone a new Environment from
Creates an new environment that is a copy of the Environment registered with the provided `environmentID`. If no ID is provided, the latest registered JSON Schema is used as the template.
See the above section on *Environments* for the default available Environment IDs.
### *<Environment>*.validate(*json*, *schema*) *->* *<Report>*
* *json* *<Any|JSONInstance>* The JSON data to validate
* *schema* *<Object|JSONInstance|JSONSchema>* The schema to validate the JSON with
Validates both the schema and the JSON, and returns a report of the validation.
### *<Report>*.errors *<Array>*
An array of error objects from the validation process; each object represents a restriction check that failed. If the array is empty, the validation passed.
The error objects have the following schema:
{
"type" : "object",
"properties" : {
"message" : {
"description" : "A user-friendly error message about what failed to validate.",
"type" : "string"
},
"uri" : {
"description" : "URI of the instance that failed to validate.",
"type" : "string",
"format" : "uri"
},
"schemaUri" : {
"description" : "URI of the schema instance that reported the error.",
"type" : "string",
"format" : "uri"
},
"attribute" : {
"description" : "The attribute of the schema instance that failed to validate.",
"type" : "string"
},
"details" : {
"description" : "The value of the schema attribute that failed to validate.",
"type" : "any"
}
}
}
## API Documentation
There are many more APIs available for JSV, too many to detail here. The complete API and documentation can be found in the `docs` directory.
## Extending Environments
JSV provides an API for extending available schemas, adding new attributes and validation to currently existing schemas, and creating whole new Environments with unique behaviors.
In fact, in the [eat-your-own-dog-food](http://en.wikipedia.org/wiki/Eating_your_own_dog_food) approach, all the default JSON Schema environments available are implemented using this API.
Details and instruction on this feature will be provided at a later date.
## Unit Tests
Open `tests/index.html` and `tests/index3.html` in your web browser to run the unit tests.
## License
JSV is licensed under the FreeBSD License.