feat: deepProperties keyword

Author: epoberezkin

README.md

@@ -18,6 +18,7 @@ Custom JSON-Schema keywords for [ajv](https://github.com/epoberezkin/ajv) valida
   - [range and exclusiveRange](#range-and-exclusiverange)
   - [propertyNames](#propertynames)
   - [if/then/else](#ifthenelse)
+  - [deepProperties](#deepproperties)
   - [deepRequired](#deeprequired)
   - [regexp](#regexp)
   - [dynamicDefaults](#dynamicdefaults)
@@ -226,6 +227,58 @@ var invalidData = {
 See [json-schema-org/json-schema-spec#203](https://github.com/json-schema-org/json-schema-spec/issues/203#issue-197211916) for an example of the equivalent schema without `deepRequired` keyword.
 
 
+## `deepProperties`
+
+This keyword allows to validate deep properties (identified by JSON pointers). The value should be an object, where keys are JSON pointers to the data, starting from the current position in data, and the values are corresponding schemas.
+
+```javascript
+var schema = {
+  type: 'object',
+  deepProperties: {
+    "users/1/role": { "enum": ["admin"] }
+  }
+};
+
+var validData = {
+  users: [
+    {},
+    {
+      id: 123,
+      role: 'admin'
+    }
+  ]
+};
+
+var alsoValidData = {
+  users: {
+    "1": {
+      id: 123,
+      role: 'admin'
+    }
+  }
+};
+
+var invalidData = {
+  users: [
+    {},
+    {
+      id: 123,
+      role: 'user'
+    }
+  ]
+};
+
+var alsoInvalidData = {
+  users: {
+    "1": {
+      id: 123,
+      role: 'user'
+    }
+  }
+};
+```
+
+
 ### `regexp`
 
 This keyword allows to use regular expressions with flags in schemas (the standard `pattern` keyword does not support flags). The value of this keyword can be either a string (the result of `regexp.toString()`) or an object with the properties `pattern` and `flags` (the same strings that should be passed to RegExp constructor).

keywords/deepProperties.js

@@ -0,0 +1,44 @@
+'use strict';
+
+module.exports = function defFunc(ajv) {
+  defFunc.definition = {
+    type: 'object',
+    macro: function (schema) {
+      var schemas = [];
+      for (var pointer in schema)
+        schemas.push(getSchema(pointer, schema[pointer]));
+      return { 'allOf': schemas };
+    }
+  };
+
+  ajv.addKeyword('deepProperties', defFunc.definition);
+  return ajv;
+};
+
+
+function getSchema(jsonPointer, schema) {
+  var segments = jsonPointer.split('/');
+  var rootSchema = {};
+  var pointerSchema = rootSchema;
+  for (var i=1; i<segments.length; i++) {
+    var segment = segments[i];
+    var isLast = i == segments.length - 1;
+    segment = unescapeJsonPointer(segment);
+    var properties = pointerSchema.properties = {};
+    var items = undefined;
+    if (/[0-9]+/.test(segment)) {
+      var count = +segment;
+      items = pointerSchema.items = [];
+      while (count--) items.push({});
+    }
+    pointerSchema = isLast ? schema : {};
+    properties[segment] = pointerSchema;
+    if (items) items.push(pointerSchema);
+  }
+  return rootSchema;
+}
+
+
+function unescapeJsonPointer(str) {
+  return str.replace(/~1/g, '/').replace(/~0/g, '~');
+}

keywords/index.js

@@ -8,6 +8,7 @@ module.exports = {
   'typeof': require('./typeof'),
   dynamicDefaults: require('./dynamicDefaults'),
   'if': require('./if'),
+  deepProperties: require('./deepProperties'),
   deepRequired: require('./deepRequired')
   // formatMinimum: require('./formatMinimum'),
   // formatMaximum: require('./formatMaximum'),

spec/schema-tests.spec.js

@@ -7,7 +7,7 @@ var defineKeywords = require('..');
 var ajvs = [
   // defineKeywords(getAjv(),
   //   ['switch', 'patternRequired', 'formatMinimum', 'formatMaximum']),
-  defineKeywords(getAjv(), ['if', 'deepRequired']),
+  defineKeywords(getAjv(), ['if', 'deepRequired', 'deepProperties']),
   defineKeywords(getAjv()),
   defineKeywords(getAjv(true))
 ];