Add support for multiple versions of JSON Schema

See https://ajv.js.org/json-schema.html#json-schema-versions
Fix #8

Author: Alkarex

.editorconfig

@@ -13,8 +13,7 @@ indent_style = tab
 indent_style = tab
 
 [*.json]
-indent_size = 2
-indent_style = space
+indent_style = tab
 
 [*.md]
 indent_size = 4

README.md

@@ -275,6 +275,7 @@ Output:
 
 * *Context*: Node-RED node, or command line with `node ./index.js json-multi-schema-validator`
 * *Purpose*: Ability to validate a JSON observation (e.g. one of the FIWARE NGSI types) on the fly against a specified JSON Schema URL. Schemas are automatically downloaded and cached the first time they are needed.
+* *Configuration*: A `schemaVersion` property indicating which [version of JSON Schema version](http://json-schema.org/specification.html). See the [Ajv documentation](https://ajv.js.org/json-schema.html#json-schema-versions) for technical details.
 * *Input*: A JSON observation (e.g. one of the FIWARE NGSI types) in the `msg.payload` property, and the corresponding JSON Schema URL on the `msg.schemaUrl` property (coming from json-multi-schema-resolver).
   * If no `msg.schemaUrl` is provided, no validation is performed.
 * *Output*: The unmodified JSON observation in the `msg.payload` property, the used schema in the `msg.validUrl` (if any validation was performed), and potential validation errors in the `msg.error` property.
@@ -312,7 +313,7 @@ The JSON input messages must each be on one single line, and wrapped into a Node
 
 ```sh
 echo '{"payload":{"id":"TA120-T246177-NoiseLevelObserved-2018-09-17T07:01:09.000000Z","type":"NoiseLevelObserved","LAeq":48.6,"dateObservedFrom":"2018-09-17T07:01:09.000000Z","dateObservedTo":"2018-09-17T07:01:09.000000Z","location":{"coordinates":[24.985891,60.274286],"type":"Point"}},"error":false,"transformUrl":"https://raw.githubusercontent.com/alexandrainst/node-red-contrib-json-multi-schema/master/examples/Cesva-TA120-to-NoiseLevelObserved.jsonata.js","schemaUrl":"https://smart-data-models.github.io/data-models/specs/Environment/NoiseLevelObserved/schema.json"}' | \
-node ./index.js json-multi-schema-validator | \
+node ./index.js json-multi-schema-validator --schemaVersion='\"draft-2019-09\"' | \
 jq .
 ```
 

json-multi-schema-validator.html

@@ -5,6 +5,7 @@
 		color: '#00B4FF',
 		defaults: {
 			name: { value: '' },
+			schemaVersion: { value: 'draft-07' },
 		},
 		inputs: 1,
 		outputs: 1,
@@ -20,6 +21,16 @@
 		<label for="node-input-name"><i class="icon-tag"></i> Name</label>
 		<input type="text" id="node-input-name" placeholder="Name" />
 	</div>
+	<div class="form-row">
+		<label for="node-input-schemaVersion"><i class="fa fa-flag"></i> JSON Schema version</label>
+		<select id="node-input-schemaVersion">
+			<option value="draft-07">draft-07 (default)</option>
+			<option value="draft-2019-09">draft-2019-09 (newer but slower) + draft-07</option>
+			<option value="draft-2020-12">draft-2020-12 (newest, not backwards compatible)</option>
+			<option value="draft-06">draft-06 (obsolete) + draft-07</option>
+			<option value="draft-04">draft-04 (obsolete, deprecated)</option>
+		</select>
+	</div>
 </script>
 
 <script type="text/x-red" data-help-name="json-multi-schema-validator">
@@ -29,4 +40,10 @@
 		<li>The content of <code>msg.payload</code> is unchanged. If no <code>msg.schemaUrl</code> is provided, no validation is performed.</li>
 		<li>Errors are returned on <code>msg.error</code></li>
 	</ul>
+	<h3>Options</h3>
+	<dl>
+		<dt>schemaVersion</dt>
+		<dd>Version of <a href="http://json-schema.org/specification.html">JSON Schema</a> to use</dd>
+		<dd>See the <a href="https://ajv.js.org/json-schema.html#json-schema-versions">documentation from the underlying library</a></dd>
+	</dl>
 </script>

json-multi-schema-validator.js

@@ -5,7 +5,6 @@
  */
 
 // Ajv: Another JSON Schema Validator
-const Ajv = require('ajv').default;
 const addFormats = require('ajv-formats').default;
 const util = require('util');
 
@@ -21,11 +20,48 @@ module.exports = RED => {
 
 		const jsonCache = require('./json-cache.js')(node);
 
-		const ajv = new Ajv({
+		let ajv;
+		const opts = {
 			allErrors: true,	// TODO: Make a parameter
 			loadSchema: jsonCache.loadAsync,
 			messages: true,	// TODO: Make a parameter
-		});
+		};
+
+		// http://json-schema.org/specification.html
+		// https://ajv.js.org/json-schema.html#json-schema-versions
+		switch (config.schemaVersion) {
+			case 'draft-2020-12': {
+				const Ajv2020 = require('ajv/dist/2020');
+				ajv = new Ajv2020(opts);
+				break;
+			}
+			case 'draft-2019-09': {
+				const Ajv2019 = require('ajv/dist/2019');
+				ajv = new Ajv2019(opts);
+				const draft7MetaSchema = require('ajv/dist/refs/json-schema-draft-07.json');
+				ajv.addMetaSchema(draft7MetaSchema);
+				break;
+			}
+			case 'draft-06': {
+				const Ajv = require('ajv');
+				const draft6MetaSchema = require('ajv/dist/refs/json-schema-draft-06.json');
+				ajv = new Ajv(opts);
+				ajv.addMetaSchema(draft6MetaSchema);
+				break;
+			}
+			case 'draft-04': {
+				const Ajv = require('ajv-draft-04');
+				ajv = new Ajv(opts);
+				break;
+			}
+			case 'draft-07':
+			default: {
+				const Ajv = require('ajv');
+				ajv = new Ajv(opts);
+				break;
+			}
+		}
+
 		addFormats(ajv);
 
 		// Cache of validators for different schemas

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "node-red-contrib-json-multi-schema",
-	"version": "1.5.2",
+	"version": "1.6.0",
 	"description": "Generic JSON data pipeline tools, with dynamic transformation (using JSONata rules), resolving JSON Schema (using JSONata rules), and then validation (using JSON Schema). For Node-RED and for command-line.",
 	"main": "index.js",
 	"readmeFilename": "readme.md",
@@ -39,6 +39,7 @@
 	},
 	"dependencies": {
 		"ajv": "^8.12.0",
+		"ajv-draft-04": "^1.0.0",
 		"ajv-formats": "^2.1.1",
 		"jsonata": "^2.0.3",
 		"node-fetch": "^2.6.11",
@@ -58,6 +59,9 @@
 		"eslint_fix": "eslint --fix --ext .js,.html .",
 		"fix": "npm run eslint_fix",
 		"pretest": "npm run-script eslint",
-		"test": "rm /tmp/schema.*.tmp.js ; printf '{\"payload\":{\"id\":\"TA120-T246177\",\"type\":\"Cesva-TA120\",\"NoiseLevelObserved\":{\"id\":\"TA120-T246177-NoiseLevelObserved-2018-09-17T07:01:09.000000Z\",\"sonometerClass\":\"1\",\"location\":{\"coordinates\":[24.985891,60.274286],\"type\":\"Point\"},\"measurand\":[\"LAeq | 48.6 | A-weighted, equivalent, sound level\"],\"dateObserved\":\"2018-09-17T07:01:09.000000Z\",\"LAeq\":48.6,\"type\":\"NoiseLevelObserved\"}}} \\n {\"payload\":{\"id\":\"TA120-T246183\",\"type\":\"Cesva-TA120\",\"NoiseLevelObserved\":{\"id\":\"TA120-T246183-NoiseLevelObserved-2018-09-17T07:01:15.000000Z\",\"sonometerClass\":\"1\",\"location\":{\"coordinates\":[24.9030921,60.161804],\"type\":\"Point\"},\"measurand\":[\"LAeq | 37.6 | A-weighted, equivalent, sound level\"],\"dateObserved\":\"2018-09-17T07:01:15.000000Z\",\"LAeq\":37.6,\"type\":\"NoiseLevelObserved\"}}}' | node ./index.js json-multi-schema-resolver --mappingsUrl='\"https://raw.githubusercontent.com/alexandrainst/node-red-contrib-json-multi-schema/master/examples/smart-data-transforms.json\"' | node ./index.js json-multi-schema-transformer | node ./index.js json-multi-schema-resolver --mappingsUrl='\"https://raw.githubusercontent.com/alexandrainst/node-red-contrib-json-multi-schema/master/examples/smart-data-models.json\"' | node ./index.js json-multi-schema-validator"
+		"clean": "rm /tmp/schema.*.tmp.js",
+		"draft-07": "printf '{\"payload\":{\"id\":\"TA120-T246177\",\"type\":\"Cesva-TA120\",\"NoiseLevelObserved\":{\"id\":\"TA120-T246177-NoiseLevelObserved-2018-09-17T07:01:09.000000Z\",\"sonometerClass\":\"1\",\"location\":{\"coordinates\":[24.985891,60.274286],\"type\":\"Point\"},\"measurand\":[\"LAeq | 48.6 | A-weighted, equivalent, sound level\"],\"dateObserved\":\"2018-09-17T07:01:09.000000Z\",\"LAeq\":48.6,\"type\":\"NoiseLevelObserved\"}}} \\n {\"payload\":{\"id\":\"TA120-T246183\",\"type\":\"Cesva-TA120\",\"NoiseLevelObserved\":{\"id\":\"TA120-T246183-NoiseLevelObserved-2018-09-17T07:01:15.000000Z\",\"sonometerClass\":\"1\",\"location\":{\"coordinates\":[24.9030921,60.161804],\"type\":\"Point\"},\"measurand\":[\"LAeq | 37.6 | A-weighted, equivalent, sound level\"],\"dateObserved\":\"2018-09-17T07:01:15.000000Z\",\"LAeq\":37.6,\"type\":\"NoiseLevelObserved\"}}}' | node ./index.js json-multi-schema-resolver --mappingsUrl='\"https://raw.githubusercontent.com/alexandrainst/node-red-contrib-json-multi-schema/master/examples/smart-data-transforms.json\"' | node ./index.js json-multi-schema-transformer | node ./index.js json-multi-schema-resolver --mappingsUrl='\"https://raw.githubusercontent.com/alexandrainst/node-red-contrib-json-multi-schema/master/examples/smart-data-models.json\"' | node ./index.js json-multi-schema-validator",
+		"draft-2019-09": "printf '{\"payload\":{\"id\":\"TA120-T246177\",\"type\":\"Cesva-TA120\",\"NoiseLevelObserved\":{\"id\":\"TA120-T246177-NoiseLevelObserved-2018-09-17T07:01:09.000000Z\",\"sonometerClass\":\"1\",\"location\":{\"coordinates\":[24.985891,60.274286],\"type\":\"Point\"},\"measurand\":[\"LAeq | 48.6 | A-weighted, equivalent, sound level\"],\"dateObserved\":\"2018-09-17T07:01:09.000000Z\",\"LAeq\":48.6,\"type\":\"NoiseLevelObserved\"}}} \\n {\"payload\":{\"id\":\"TA120-T246183\",\"type\":\"Cesva-TA120\",\"NoiseLevelObserved\":{\"id\":\"TA120-T246183-NoiseLevelObserved-2018-09-17T07:01:15.000000Z\",\"sonometerClass\":\"1\",\"location\":{\"coordinates\":[24.9030921,60.161804],\"type\":\"Point\"},\"measurand\":[\"LAeq | 37.6 | A-weighted, equivalent, sound level\"],\"dateObserved\":\"2018-09-17T07:01:15.000000Z\",\"LAeq\":37.6,\"type\":\"NoiseLevelObserved\"}}}' | node ./index.js json-multi-schema-resolver --mappingsUrl='\"https://raw.githubusercontent.com/alexandrainst/node-red-contrib-json-multi-schema/master/examples/smart-data-transforms.json\"' | node ./index.js json-multi-schema-transformer | node ./index.js json-multi-schema-resolver --mappingsUrl='\"https://raw.githubusercontent.com/alexandrainst/node-red-contrib-json-multi-schema/master/examples/smart-data-models.json\"' | node ./index.js json-multi-schema-validator --schemaVersion='\"draft-2019-09\"'",
+		"test": "npm run clean; npm run draft-07 && npm run draft-2019-09"
 	}
 }