add json schemas

package.json

@@ -16,6 +16,8 @@
     "@babel/core": "^7.3.3",
     "@babel/plugin-proposal-export-default-from": "^7.2.0",
     "@babel/preset-env": "^7.3.1",
+    "ajv": "^6.10.0",
+    "ajv-cli": "^3.0.0",
     "cross-env": "^5.2.0",
     "eslint": "^5.14.1",
     "eslint-config-airbnb": "^17.1.0",
@@ -24,6 +26,7 @@
     "eslint-plugin-jsx-a11y": "^6.2.1",
     "eslint-plugin-prettier": "^3.0.1",
     "eslint-plugin-react": "^7.12.4",
+    "glob": "^7.1.3",
     "husky": "^1.3.1",
     "lint-staged": "^8.1.4",
     "prettier": "^1.16.4",
@@ -40,6 +43,7 @@
   "scripts": {
     "lint": "eslint src tests",
     "lint-fix": "npm run lint -- --fix",
+    "lint:schemas": "ajv compile -s schemas/json-logic.json -r 'schemas/**/*.json'",
     "test": "cross-env NODE_ENV=test qunit 'tests/**/*.js' -r tap",
     "pretest": "npm run build-package",
     "build": "cross-env NODE_ENV=production npm run build-lib",

schemas/common/all-types.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/common/all-types.json",
+
+  "title": "All",
+  "description": "Any valid JSON data type.",
+  "type": ["array", "boolean", "null", "number", "object", "string"]
+}

schemas/common/any.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/common/any.json",
+
+  "title": "All",
+  "description": "Any valid JSON Logic data source.",
+
+  "anyOf": [
+    { "$ref": "http://jsonlogic.com/schemas/operators/accessor/variable.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/accessor/missing.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/accessor/missing_some.json" },
+
+    { "$ref": "http://jsonlogic.com/schemas/operators/arithmetic/add.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/arithmetic/divide.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/arithmetic/modulo.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/arithmetic/multiply.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/arithmetic/substract.json" },
+
+    { "$ref": "http://jsonlogic.com/schemas/operators/array/all.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/array/filter.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/array/map.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/array/merge.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/array/none.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/array/reduce.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/array/some.json" },
+
+    { "$ref": "http://jsonlogic.com/schemas/operators/logic/and.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/logic/equal.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/logic/if.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/logic/not.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/logic/notEqual.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/logic/notnot.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/logic/or.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/logic/strictEqual.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/logic/strictNotEqual.json" },
+
+    { "$ref": "http://jsonlogic.com/schemas/operators/misc/in.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/misc/log.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/misc/method.json" },
+
+    { "$ref": "http://jsonlogic.com/schemas/operators/numeric/greater.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/numeric/greaterEqual.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/numeric/less.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/numeric/lessEqual.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/numeric/max.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/numeric/min.json" },
+
+    { "$ref": "http://jsonlogic.com/schemas/operators/string/cat.json" },
+    { "$ref": "http://jsonlogic.com/schemas/operators/string/substr.json" },
+
+    { "$ref": "http://jsonlogic.com/schemas/common/all-types.json" }
+  ]
+}

schemas/common/binary-args.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/common/binary-args.json",
+
+  "title": "Binary Arg",
+  "description": "Up to two args of valid JSON Logic data source.",
+
+  "oneOf": [
+    {
+      "title": "Array",
+      "description": "An array with one or two elements.",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 2,
+      "items": {
+        "$ref": "http://jsonlogic.com/schemas/common/any.json"
+      }
+    },
+    {
+      "$ref": "http://jsonlogic.com/schemas/common/any.json",
+      "title": "Single Arg",
+      "description": "Note: binary operators can also take a single, non array argument:"
+    }
+  ]
+}

schemas/common/one-or-more-args.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/common/one-or-more-args.json",
+
+  "title": "1 or more args",
+  "description": "With 1 or more arguments.",
+
+  "oneOf": [
+    {
+      "title": "Single Array",
+      "description": "An array with 1 or more elements.",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "http://jsonlogic.com/schemas/common/any.json"
+      }
+    },
+    {
+      "$ref": "http://jsonlogic.com/schemas/common/any.json",
+      "title": "Single Arg",
+      "description": "Note: 1 or more operators can also take a single, non array argument:"
+    }
+  ]
+}

schemas/common/pointer.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/common/pointer.json",
+
+  "title": "Pointer",
+  "description": "Schema to access properties of an object or items of an array by index.",
+
+  "oneOf": [
+    {
+      "type": "string",
+      "title": "Property",
+      "description": "The key passed to var can use dot-notation to get the property of a property (to any depth you need):"
+    },
+    {
+      "type": "number",
+      "title": "Index",
+      "description": "You can also use the var operator to access an array by numeric index."
+    }
+  ]
+}

schemas/common/trinary-args.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/common/trinary-args.json",
+
+  "title": "Trinary Args",
+  "description": "Up to three args of valid JSON Logic data source.",
+
+  "oneOf": [
+    {
+      "title": "Array",
+      "description": "An array with one or three elements.",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 3,
+      "items": {
+        "$ref": "http://jsonlogic.com/schemas/common/any.json"
+      }
+    },
+    {
+      "$ref": "http://jsonlogic.com/schemas/common/any.json",
+      "title": "Single Arg",
+      "description": "Note: trinary operators can also take a single, non array argument:"
+    }
+  ]
+}

schemas/common/unary-arg.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/common/unary-arg.json",
+
+  "title": "Unary Arg",
+  "description": "Only one valid JSON Logic data source.",
+
+  "oneOf": [
+    {
+      "title": "Single Array",
+      "description": "An array with just one element.",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 1,
+      "items": {
+        "$ref": "http://jsonlogic.com/schemas/common/any.json"
+      }
+    },
+    {
+      "$ref": "http://jsonlogic.com/schemas/common/any.json",
+      "title": "Single Arg",
+      "description": "Note: unary operators can also take a single, non array argument:"
+    }
+  ]
+}

schemas/common/var.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/common/var.json",
+
+  "title": "Var",
+  "description": "Retrieve data from the provided data object.",
+
+  "oneOf": [
+    {
+      "type": "array",
+      "items": [
+        { "$ref": "http://jsonlogic.com/schemas/common/pointer.json" },
+        {
+          "$ref": "http://jsonlogic.com/schemas/common/all-types.json",
+          "title": "Default",
+          "description": "You can supply a default, as the second argument, for values that might be missing in the data object."
+        }
+      ]
+    },
+    {
+      "$ref": "http://jsonlogic.com/schemas/common/pointer.json",
+      "title": "Shortcut",
+      "description": "If you like, we support syntactic sugar to skip the array around single arguments."
+    },
+    {
+      "type": "string",
+      "enum": [""],
+      "title": "Entire data object",
+      "description": "You can also use var with an empty string to get the entire data object – which is really useful in map, filter, and reduce rules."
+    }
+  ]
+}

schemas/json-logic.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/json-logic.json",
+
+  "title": "JSON-Logic Schema",
+  "description": "Build complex rules, serialize them as JSON, share them between front-end and back-end.",
+
+  "$ref": "http://jsonlogic.com/schemas/common/any.json"
+}

schemas/operators/accessor/missing.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/operators/accessor/missing.json",
+
+  "title": "missing",
+  "description": "Takes an array of data keys to search for (same format as var). Returns an array of any keys that are missing from the data object, or an empty array.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["missing"],
+  "properties": {
+    "missing": {
+      "$ref": "http://jsonlogic.com/schemas/common/var.json"
+    }
+  }
+}

schemas/operators/accessor/missing_some.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/operators/accessor/missing_some.json",
+
+  "title": "missing_some",
+  "description": "Takes a minimum number of data keys that are required, and an array of keys to search for (same format as var or missing). Returns an empty array if the minimum is met, or an array of the missing keys otherwise.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["missing_some"],
+  "properties": {
+    "missing_some": {
+      "type": "array",
+      "minItems": 2,
+      "maxItems": 2,
+      "items": [
+        {
+          "type": "integer",
+          "title": "Need-Count",
+          "description": "Takes a minimum number of data keys that are required"
+        },
+        {
+          "$ref": "http://jsonlogic.com/schemas/common/var.json",
+          "description": "An array of keys to search for (same format as var or missing)."
+        }
+      ]
+    }
+  }
+}

schemas/operators/accessor/variable.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/operators/accessor/variable.json",
+
+  "title": "var",
+  "description": "Retrieve data from the provided data object.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["var"],
+  "properties": {
+    "var": {
+      "$ref": "http://jsonlogic.com/schemas/common/var.json"
+    }
+  }
+}

schemas/operators/arithmetic/add.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/operators/arithmetic/add.json",
+
+  "title": "+",
+  "description": "Addition. Because addition is associative, it happily take as many args as you want. Passing just one argument to + casts it to a number.",
+
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["+"],
+  "properties": {
+    "+": {
+      "$ref": "http://jsonlogic.com/schemas/common/one-or-more-args.json"
+    }
+  }
+}

schemas/operators/arithmetic/divide.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/operators/arithmetic/divide.json",
+
+  "title": "/",
+  "description": "Division.",
+
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["/"],
+  "properties": {
+    "/": {
+      "$ref": "http://jsonlogic.com/schemas/common/binary-args.json"
+    }
+  }
+}

schemas/operators/arithmetic/modulo.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/operators/arithmetic/modulo.json",
+
+  "title": "%",
+  "description": "Module. Finds the remainder after the first argument is divided by the second argument.",
+
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["%"],
+  "properties": {
+    "%": {
+      "$ref": "http://jsonlogic.com/schemas/common/binary-args.json"
+    }
+  }
+}

schemas/operators/arithmetic/multiply.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://jsonlogic.com/schemas/operators/arithmetic/multiply.json",
+
+  "title": "*",
+  "description": "Multiplication. Because multiplication is associative, it happily take as many args as you want.",
+
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["*"],
+  "properties": {
+    "*": {
+      "$ref": "http://jsonlogic.com/schemas/common/one-or-more-args.json"
+    }
+  }
+}