feat: deepRequired keyword

Author: epoberezkin

keywords/deepRequired.js

@@ -0,0 +1,52 @@
+'use strict';
+
+module.exports = function defFunc(ajv) {
+  defFunc.definition = {
+    type: 'object',
+    inline: function (it, keyword, schema) {
+      var expr = '';
+      for (var i=0; i<schema.length; i++) {
+        if (i) expr += ' && ';
+        expr += '(' + getData(schema[i], it.dataLvl) + ' !== undefined)';
+      }
+      return expr;
+    }
+  };
+
+  ajv.addKeyword('deepRequired', defFunc.definition);
+  return ajv;
+};
+
+
+function getData(jsonPointer, lvl) {
+  var data = 'data' + (lvl || '');
+  if (!jsonPointer) return data;
+
+  var expr = data;
+  var segments = jsonPointer.split('/');
+  for (var i=0; i<segments.length; i++) {
+    var segment = segments[i];
+    if (segment) {
+      data += getProperty(unescapeJsonPointer(segment));
+      expr += ' && ' + data;
+    }
+  }
+  return expr;
+}
+
+
+var IDENTIFIER = /^[a-z$_][a-z$_0-9]*$/i;
+var INTEGER = /^[0-9]+$/;
+var SINGLE_QUOTE = /'|\\/g;
+function getProperty(key) {
+  return INTEGER.test(key)
+          ? '[' + key + ']'
+          : IDENTIFIER.test(key)
+            ? '.' + key
+            : "['" + key.replace(SINGLE_QUOTE, '\\$&') + "']";
+}
+
+
+function unescapeJsonPointer(str) {
+  return str.replace(/~1/g, '/').replace(/~0/g, '~');
+}

keywords/index.js

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

spec/schema-tests.spec.js

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

spec/tests/deepRequired.json

@@ -0,0 +1,94 @@
+[
+  {
+    "description": "deepRequired keyword validation",
+    "schema": {
+      "type": "object",
+      "deepRequired": [ "/foo/bar", "/foo/baz", "/quux" ]
+    },
+    "tests": [
+      {
+        "description": "object with all required properties is valid",
+        "data": {
+          "foo": {
+            "bar": 1,
+            "baz": 2
+          },
+          "quux": 3
+        },
+        "valid": true
+      },
+      {
+        "description": "object without any required properties is invalid",
+        "data": {
+          "foo": {}
+        },
+        "valid": false
+      },
+      {
+        "description": "object with one required property is invalid",
+        "data": {
+          "quux": 3
+        },
+        "valid": false
+      },
+      {
+        "description": "object with one required sub-property is invalid",
+        "data": {
+          "foo": {
+            "bar": 1
+          },
+          "quux": 3
+        },
+        "valid": false
+      }
+    ]
+  },
+  {
+    "description": "deepRequired keyword with items",
+    "schema": {
+      "type": "object",
+      "deepRequired": [ "/foo/1/bar", "/foo/2/baz", "/quux/3" ]
+    },
+    "tests": [
+      {
+        "description": "object with all required properties/items is valid",
+        "data": {
+          "foo": [
+            {},
+            { "bar": 1 },
+            { "baz": 2 }
+          ],
+          "quux": [ 0, 1, 2, 3 ]
+        },
+        "valid": true
+      },
+      {
+        "description": "object without any required properties is invalid",
+        "data": {
+          "foo": [{}, {}, {}],
+          "quux": [0, 1, 2]
+        },
+        "valid": false
+      },
+      {
+        "description": "object with one required property is invalid",
+        "data": {
+          "quux": [ 0, 1, 2, 3 ]
+        },
+        "valid": false
+      },
+      {
+        "description": "object with one required sub-property is invalid",
+        "data": {
+          "foo": [
+            {},
+            { "bar": 1 },
+            {}
+          ],
+          "quux": [ 0, 1, 2, 3 ]
+        },
+        "valid": false
+      }
+    ]
+  }
+]