@briza/illogical 1.4.3 → 1.5.2

package/lib/illogical.js

@@ -2,26 +2,6 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-function _defineProperty(obj, key, value) {
-  if (key in obj) {
-    Object.defineProperty(obj, key, {
-      value: value,
-      enumerable: true,
-      configurable: true,
-      writable: true
-    });
-  } else {
-    obj[key] = value;
-  }
-
-  return obj;
-}
-
-/**
- * Common module.
- * @module illogical/common
- */
-
 /**
  * Is number predicate.
  * @param value Tested value.
@@ -72,10 +52,20 @@ function isEvaluable(value) {
   return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
 
-/**
- * Common module.
- * @module illogical/common
- */
+function _defineProperty(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+
+  return obj;
+}
 
 /**
  * Valid types for context members
@@ -111,12 +101,12 @@ class Comparison {
    * @param {Operand} right Right operand.
    */
   constructor(operator, operatorSymbol, left, right) {
+    _defineProperty(this, "type", EvaluableType.Expression);
+
     this.operator = operator;
     this.operatorSymbol = operatorSymbol;
     this.left = left;
     this.right = right;
-
-    _defineProperty(this, "type", EvaluableType.Expression);
   }
   /**
    * {@link Evaluable.evaluate}
@@ -146,9 +136,9 @@ class Comparison {
   /**
    * {@link Evaluable.simplify}
    */
-  simplify(...args) {
-    const left = this.left.simplify(...args);
-    const right = this.right.simplify(...args);
+  simplify() {
+    const left = this.left.simplify(...arguments);
+    const right = this.right.simplify(...arguments);
 
     if (!isEvaluable(left) && !isEvaluable(right)) {
       return this.comparison(left, right);
@@ -176,11 +166,6 @@ class Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$h = Symbol('EQ');
 /**
  * Equal comparison expression
@@ -210,11 +195,6 @@ class Equal extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$g = Symbol('GE');
 /**
  * Greater than or equal comparison expression
@@ -248,11 +228,6 @@ class GreaterThanOrEqual extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$f = Symbol('GT');
 /**
  * Greater than comparison expression
@@ -286,11 +261,6 @@ class GreaterThan extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$e = Symbol('IN');
 /**
  * In comparison expression
@@ -355,11 +325,6 @@ class In extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$d = Symbol('LE');
 /**
  * Less than or equal comparison expression
@@ -393,11 +358,6 @@ class LessThanOrEqual extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$c = Symbol('LT');
 /**
  * Less than comparison expression
@@ -431,11 +391,6 @@ class LessThan extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$b = Symbol('NE');
 /**
  * Not equal comparison expression
@@ -465,11 +420,6 @@ class NotEqual extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$a = Symbol('NOT IN');
 /**
  * Not in comparison expression
@@ -534,11 +484,6 @@ class NotIn extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$9 = Symbol('OVERLAP');
 /**
  * Overlap comparison expression
@@ -589,11 +534,6 @@ class Overlap extends Comparison {
 
 }
 
-/**
- * Prefix expression module.
- * @module illogical/expression/prefix
- */
-
 const OPERATOR$8 = Symbol('PREFIX');
 /**
  * Prefix comparison expression
@@ -684,9 +624,6 @@ class Value extends Operand {
     }
 
     super();
-
-    _defineProperty(this, "value", void 0);
-
     this.value = value;
   }
   /**
@@ -725,11 +662,6 @@ class Value extends Operand {
 
 }
 
-/**
- * Present expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$7 = Symbol('PRESENT');
 /**
  * Present comparison expression
@@ -780,11 +712,6 @@ class Present extends Comparison {
 
 }
 
-/**
- * Suffix expression module.
- * @module illogical/expression/suffix
- */
-
 const OPERATOR$6 = Symbol('PREFIX');
 /**
  * Suffix comparison expression
@@ -829,11 +756,6 @@ class Suffix extends Comparison {
 
 }
 
-/**
- * Undefined expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$5 = Symbol('UNDEFINED');
 /**
  * Undefined comparison expression
@@ -898,11 +820,11 @@ class Logical {
    * @param {Evaluable[]} operands Collection of operands.
    */
   constructor(operator, operatorSymbol, operands) {
+    _defineProperty(this, "type", EvaluableType.Expression);
+
     this.operator = operator;
     this.operatorSymbol = operatorSymbol;
     this.operands = operands;
-
-    _defineProperty(this, "type", EvaluableType.Expression);
   }
   /**
    * {@link Evaluable.evaluate}
@@ -932,11 +854,6 @@ class Logical {
 
 }
 
-/**
- * Logical expression module.
- * @module illogical/expression/logical
- */
-
 const OPERATOR$4 = Symbol('AND');
 /**
  * And logical expression
@@ -975,17 +892,21 @@ class And extends Logical {
    */
 
 
-  simplify(...args) {
+  simplify() {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
     const simplified = this.operands.reduce((result, child) => {
       if (result !== false) {
         const childResult = child.simplify(...args);
 
-        if (!isBoolean(childResult)) {
+        if (isEvaluable(childResult)) {
           if (isBoolean(result)) {
-            return [child];
+            return [childResult];
           }
 
-          return [...result, child];
+          return [...result, childResult];
         }
 
         if (!childResult) {
@@ -1009,11 +930,6 @@ class And extends Logical {
 
 }
 
-/**
- * Logical expression module.
- * @module illogical/expression/logical
- */
-
 const OPERATOR$3 = Symbol('NOT');
 /**
  * Not logical expression
@@ -1052,8 +968,8 @@ class Not extends Logical {
    */
 
 
-  simplify(...args) {
-    const simplified = this.operands[0].simplify(...args);
+  simplify() {
+    const simplified = this.operands[0].simplify(...arguments);
 
     if (isBoolean(simplified)) {
       return !simplified;
@@ -1068,11 +984,6 @@ class Not extends Logical {
 
 }
 
-/**
- * Logical expression module.
- * @module illogical/expression/logical
- */
-
 const OPERATOR$2 = Symbol('NOR');
 /**
  * Nor logical expression
@@ -1111,17 +1022,21 @@ class Nor extends Logical {
    */
 
 
-  simplify(...args) {
+  simplify() {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
     const simplified = this.operands.reduce((result, child) => {
       if (result !== false) {
         const childResult = child.simplify(...args);
 
         if (isEvaluable(childResult)) {
           if (isBoolean(result)) {
-            return [child];
+            return [childResult];
           }
 
-          return [...result, child];
+          return [...result, childResult];
         }
 
         if (childResult) {
@@ -1145,11 +1060,6 @@ class Nor extends Logical {
 
 }
 
-/**
- * Logical expression module.
- * @module illogical/expression/logical
- */
-
 const OPERATOR$1 = Symbol('OR');
 /**
  * Or logical expression
@@ -1188,17 +1098,21 @@ class Or extends Logical {
    */
 
 
-  simplify(...args) {
+  simplify() {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
     const simplified = this.operands.reduce((result, child) => {
       if (result !== true) {
         const childResult = child.simplify(...args);
 
-        if (!isBoolean(childResult)) {
+        if (isEvaluable(childResult)) {
           if (isBoolean(result)) {
-            return [child];
+            return [childResult];
           }
 
-          return [...result, child];
+          return [...result, childResult];
         }
 
         if (childResult) {
@@ -1222,11 +1136,6 @@ class Or extends Logical {
 
 }
 
-/**
- * Logical expression module.
- * @module illogical/expression/logical
- */
-
 const OPERATOR = Symbol('XOR');
 /**
  * Logical xor
@@ -1280,16 +1189,22 @@ class Xor extends Logical {
    */
 
 
-  simplify(...args) {
-    const [evaluablesLeft, trueCount] = this.operands.reduce(([notSimplifiedConditions, trueCount], child) => {
+  simplify() {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    const [evaluablesLeft, trueCount] = this.operands.reduce((_ref, child) => {
+      let [notSimplifiedConditions, trueCount] = _ref;
+
       if (trueCount > 1) {
         return [notSimplifiedConditions, trueCount];
       }
 
       const childResult = child.simplify(...args);
 
-      if (!isBoolean(childResult)) {
-        return [[...notSimplifiedConditions, child], trueCount];
+      if (isEvaluable(childResult)) {
+        return [[...notSimplifiedConditions, childResult], trueCount];
       }
 
       if (childResult) {
@@ -1334,9 +1249,6 @@ class Collection extends Operand {
    */
   constructor(items) {
     super();
-
-    _defineProperty(this, "items", void 0);
-
     this.items = items;
   }
   /**
@@ -1354,11 +1266,11 @@ class Collection extends Operand {
    */
 
 
-  simplify(...args) {
+  simplify() {
     const values = [];
 
     for (const item of this.items) {
-      const simplifiedItem = item.simplify(...args);
+      const simplifiedItem = item.simplify(...arguments);
 
       if (isEvaluable(simplifiedItem)) {
         return this;
@@ -1519,11 +1431,6 @@ class Reference extends Operand {
     }
 
     super();
-
-    _defineProperty(this, "key", void 0);
-
-    _defineProperty(this, "dataType", void 0);
-
     this.key = key;
     const dataTypeMatch = dataTypeRegex.exec(this.key);
 
@@ -1550,7 +1457,7 @@ class Reference extends Operand {
    */
 
 
-  simplify(ctx, ignoreKeys) {
+  simplify(ctx, strictKeys, optionalKeys) {
     const keys = extractKeys(ctx, this.key);
 
     if (!keys) {
@@ -1559,20 +1466,21 @@ class Reference extends Operand {
 
     const key = keys[0].replace(/\[.+$/, '');
 
-    if (ctx[key] !== undefined || ignoreKeys.includes(key)) {
+    if (ctx[key] !== undefined) {
       return this.evaluate(ctx);
     }
 
-    return this;
+    return strictKeys && strictKeys.includes(key) || optionalKeys && !optionalKeys.includes(key) ? undefined : this;
   }
   /**
    * {@link Evaluable.serialize}
    */
 
 
-  serialize({
-    referenceSerialization
-  }) {
+  serialize(_ref) {
+    let {
+      referenceSerialization
+    } = _ref;
     const key = this.dataType ? `${this.key}.(${this.dataType})` : this.key;
     return referenceSerialization(key);
   }
@@ -1614,11 +1522,6 @@ class Reference extends Operand {
 
 }
 
-/**
- * Parser module.
- * @module illogical/parser
- */
-
 /**
  * Default reference predicate.
  * The "$" symbol at the begging of the operand is used
@@ -1668,10 +1571,6 @@ class Parser {
    * @param {Options?} options Parser options.
    */
   constructor(options) {
-    _defineProperty(this, "opts", void 0);
-
-    _defineProperty(this, "expectedOperators", void 0);
-
     this.opts = { ...defaultOptions
     }; // Apply exclusive options overrides
 
@@ -1720,6 +1619,8 @@ class Parser {
 
 
   parseRawExp(raw) {
+    var _this = this;
+
     // Value / Reference
     if (!Array.isArray(raw)) {
       return this.getOperand(raw);
@@ -1741,9 +1642,11 @@ class Parser {
      * @param collapsible
      */
 
-    const logicalExpressionReducer = (operands, collapsible = false) => {
+    const logicalExpressionReducer = function (operands) {
+      let collapsible = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+
       if (operands.length === 0 || operands.filter(operand => operand.type === EvaluableType.Expression).length === 0) {
-        return this.getOperand(raw);
+        return _this.getOperand(raw);
       }
 
       return collapsible && operands.length === 1 ? operands[0] : undefined;
@@ -1877,6 +1780,10 @@ class Parser {
 
 }
 
+/**
+ * Main module.
+ * @module illogical
+ */
 /**
  * Condition engine
  */
@@ -1887,8 +1794,6 @@ class Engine {
    * @param {Options?} options Parser options.
    */
   constructor(options) {
-    _defineProperty(this, "parser", void 0);
-
     this.parser = new Parser(options);
   }
   /**
@@ -1931,14 +1836,16 @@ class Engine {
    *
    * @param {ExpressionInput} exp  Raw expression.
    * @param {Context} context Evaluation data context.
-   * @param {string[]} ignoreKeys keys to be considered present even if their not present in the context.
-   *  Default to empty array
+   * @param {string[]} strictKeys keys to be considered present even if they are not present in the context
+   * @param {string[]} optionalKeys keys to be considered not present unless they are in the context or in
+   *  `strictKeys`; when `strictKeys` is `undefined` and `optionalKeys` is an array, every key that is not in
+   *  `optionalKeys` is considered to be present and thus will be evaluated
    * @returns {Inpunt | boolean}
    */
 
 
-  simplify(exp, context, ignoreKeys = []) {
-    const result = this.parse(exp).simplify(context, ignoreKeys);
+  simplify(exp, context, strictKeys, optionalKeys) {
+    const result = this.parse(exp).simplify(context, strictKeys, optionalKeys);
 
     if (isEvaluable(result)) {
       return result.serialize(this.parser.options);
@@ -1971,4 +1878,4 @@ exports.OPERATOR_PRESENT = OPERATOR$7;
 exports.OPERATOR_SUFFIX = OPERATOR$6;
 exports.OPERATOR_UNDEFINED = OPERATOR$5;
 exports.OPERATOR_XOR = OPERATOR;
-exports.default = Engine;
+exports["default"] = Engine;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@briza/illogical",
-  "version": "1.4.3",
+  "version": "1.5.2",
   "description": "A micro conditional javascript engine used to parse the raw logical and comparison expressions, evaluate the expression in the given data context, and provide access to a text form of the given expressions.",
   "main": "lib/illogical.js",
   "module": "lib/illogical.esm.js",
@@ -25,7 +25,7 @@
     "lint": "eslint --max-warnings 0 \"src/**/*.{ts,js}\"",
     "lint:fix": "eslint --max-warnings 0 \"src/**/*.{ts,js}\" --fix",
     "prepublishOnly": "npm run test && npm run build",
-    "check-licenses": "license-checker --summary --excludePrivatePackages --onlyAllow \"MIT;MIT OR X11;Apache-2.0;ISC;BSD-3-Clause;BSD-2-Clause;CC-BY-4.0;Public Domain;BSD;CC-BY-3.0;CC0-1.0;Unlicense\""
+    "check-licenses": "license-checker --summary --excludePrivatePackages --onlyAllow \"MIT;MIT OR X11;Apache-2.0;ISC;BSD-3-Clause;BSD-2-Clause;CC-BY-4.0;Public Domain;BSD;CC-BY-3.0;CC0-1.0;Python-2.0;Unlicense\""
   },
   "repository": {
     "type": "git",
@@ -42,31 +42,31 @@
     "rules"
   ],
   "devDependencies": {
-    "@babel/core": "^7.14.2",
-    "@babel/plugin-proposal-class-properties": "^7.12.13",
-    "@babel/preset-env": "^7.14.2",
-    "@babel/preset-typescript": "^7.12.13",
+    "@babel/core": "^7.16.12",
+    "@babel/plugin-proposal-class-properties": "^7.16.7",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-typescript": "^7.16.7",
     "@rollup/plugin-babel": "^5.2.3",
-    "@rollup/plugin-commonjs": "^19.0.0",
-    "@rollup/plugin-node-resolve": "^13.0.0",
-    "@types/jest": "^26.0.23",
-    "@typescript-eslint/eslint-plugin": "^4.24.0",
-    "@typescript-eslint/parser": "^4.24.0",
-    "eslint": "^7.26.0",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "@types/jest": "^27.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.10.2",
+    "@typescript-eslint/parser": "^5.10.2",
+    "eslint": "^8.8.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-import-resolver-typescript": "^2.3.0",
-    "eslint-plugin-import": "^2.23.2",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-promise": "^6.0.0",
     "eslint-plugin-simple-import-sort": "^7.0.0",
-    "jest": "^26.6.3",
+    "jest": "^27.4.7",
     "license-checker": "^25.0.1",
-    "prettier": "^2.3.0",
-    "rollup": "^2.48.0",
+    "prettier": "^2.5.1",
+    "rollup": "^2.66.1",
     "rollup-plugin-eslint": "^7.0.0",
-    "ts-jest": "^26.5.6",
-    "typedoc": "^0.20.36",
-    "typescript": "^4.2.4"
+    "ts-jest": "^27.1.3",
+    "typedoc": "^0.22.11",
+    "typescript": "^4.5.5"
   }
-}
+}