@briza/illogical 1.4.3 → 1.5.2

package/changelog.md

@@ -1,5 +1,18 @@
 # illogical changelog
 
+## 1.5.2
+
+- Update dependencies.
+
+## 1.5.1
+
+- Fix issue with nested conditions not being completely simplified.
+
+## 1.5.0
+
+- Add simplify capability to strictly evaluate the expression for all referred values
+  not present in the context except for a specified list of optional keys
+
 ## 1.4.3
 
 - Prevent unexpected parsing of any expression used as an operand in a comparison expression

package/lib/illogical.esm.js

@@ -1,23 +1,3 @@
-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.
@@ -68,10 +48,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
@@ -107,12 +97,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}
@@ -142,9 +132,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);
@@ -172,11 +162,6 @@ class Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$h = Symbol('EQ');
 /**
  * Equal comparison expression
@@ -206,11 +191,6 @@ class Equal extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$g = Symbol('GE');
 /**
  * Greater than or equal comparison expression
@@ -244,11 +224,6 @@ class GreaterThanOrEqual extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$f = Symbol('GT');
 /**
  * Greater than comparison expression
@@ -282,11 +257,6 @@ class GreaterThan extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$e = Symbol('IN');
 /**
  * In comparison expression
@@ -351,11 +321,6 @@ class In extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$d = Symbol('LE');
 /**
  * Less than or equal comparison expression
@@ -389,11 +354,6 @@ class LessThanOrEqual extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$c = Symbol('LT');
 /**
  * Less than comparison expression
@@ -427,11 +387,6 @@ class LessThan extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$b = Symbol('NE');
 /**
  * Not equal comparison expression
@@ -461,11 +416,6 @@ class NotEqual extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$a = Symbol('NOT IN');
 /**
  * Not in comparison expression
@@ -530,11 +480,6 @@ class NotIn extends Comparison {
 
 }
 
-/**
- * Comparison expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$9 = Symbol('OVERLAP');
 /**
  * Overlap comparison expression
@@ -585,11 +530,6 @@ class Overlap extends Comparison {
 
 }
 
-/**
- * Prefix expression module.
- * @module illogical/expression/prefix
- */
-
 const OPERATOR$8 = Symbol('PREFIX');
 /**
  * Prefix comparison expression
@@ -680,9 +620,6 @@ class Value extends Operand {
     }
 
     super();
-
-    _defineProperty(this, "value", void 0);
-
     this.value = value;
   }
   /**
@@ -721,11 +658,6 @@ class Value extends Operand {
 
 }
 
-/**
- * Present expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$7 = Symbol('PRESENT');
 /**
  * Present comparison expression
@@ -776,11 +708,6 @@ class Present extends Comparison {
 
 }
 
-/**
- * Suffix expression module.
- * @module illogical/expression/suffix
- */
-
 const OPERATOR$6 = Symbol('PREFIX');
 /**
  * Suffix comparison expression
@@ -825,11 +752,6 @@ class Suffix extends Comparison {
 
 }
 
-/**
- * Undefined expression module.
- * @module illogical/expression/comparison
- */
-
 const OPERATOR$5 = Symbol('UNDEFINED');
 /**
  * Undefined comparison expression
@@ -894,11 +816,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}
@@ -928,11 +850,6 @@ class Logical {
 
 }
 
-/**
- * Logical expression module.
- * @module illogical/expression/logical
- */
-
 const OPERATOR$4 = Symbol('AND');
 /**
  * And logical expression
@@ -971,17 +888,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) {
@@ -1005,11 +926,6 @@ class And extends Logical {
 
 }
 
-/**
- * Logical expression module.
- * @module illogical/expression/logical
- */
-
 const OPERATOR$3 = Symbol('NOT');
 /**
  * Not logical expression
@@ -1048,8 +964,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;
@@ -1064,11 +980,6 @@ class Not extends Logical {
 
 }
 
-/**
- * Logical expression module.
- * @module illogical/expression/logical
- */
-
 const OPERATOR$2 = Symbol('NOR');
 /**
  * Nor logical expression
@@ -1107,17 +1018,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) {
@@ -1141,11 +1056,6 @@ class Nor extends Logical {
 
 }
 
-/**
- * Logical expression module.
- * @module illogical/expression/logical
- */
-
 const OPERATOR$1 = Symbol('OR');
 /**
  * Or logical expression
@@ -1184,17 +1094,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) {
@@ -1218,11 +1132,6 @@ class Or extends Logical {
 
 }
 
-/**
- * Logical expression module.
- * @module illogical/expression/logical
- */
-
 const OPERATOR = Symbol('XOR');
 /**
  * Logical xor
@@ -1276,16 +1185,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) {
@@ -1330,9 +1245,6 @@ class Collection extends Operand {
    */
   constructor(items) {
     super();
-
-    _defineProperty(this, "items", void 0);
-
     this.items = items;
   }
   /**
@@ -1350,11 +1262,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;
@@ -1515,11 +1427,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);
 
@@ -1546,7 +1453,7 @@ class Reference extends Operand {
    */
 
 
-  simplify(ctx, ignoreKeys) {
+  simplify(ctx, strictKeys, optionalKeys) {
     const keys = extractKeys(ctx, this.key);
 
     if (!keys) {
@@ -1555,20 +1462,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);
   }
@@ -1610,11 +1518,6 @@ class Reference extends Operand {
 
 }
 
-/**
- * Parser module.
- * @module illogical/parser
- */
-
 /**
  * Default reference predicate.
  * The "$" symbol at the begging of the operand is used
@@ -1664,10 +1567,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
 
@@ -1716,6 +1615,8 @@ class Parser {
 
 
   parseRawExp(raw) {
+    var _this = this;
+
     // Value / Reference
     if (!Array.isArray(raw)) {
       return this.getOperand(raw);
@@ -1737,9 +1638,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;
@@ -1873,6 +1776,10 @@ class Parser {
 
 }
 
+/**
+ * Main module.
+ * @module illogical
+ */
 /**
  * Condition engine
  */
@@ -1883,8 +1790,6 @@ class Engine {
    * @param {Options?} options Parser options.
    */
   constructor(options) {
-    _defineProperty(this, "parser", void 0);
-
     this.parser = new Parser(options);
   }
   /**
@@ -1927,14 +1832,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);
@@ -1949,5 +1856,4 @@ class Engine {
 
 }
 
-export default Engine;
-export { OPERATOR$4 as OPERATOR_AND, OPERATOR$h as OPERATOR_EQ, OPERATOR$g as OPERATOR_GE, OPERATOR$f as OPERATOR_GT, OPERATOR$e as OPERATOR_IN, OPERATOR$d as OPERATOR_LE, OPERATOR$c as OPERATOR_LT, OPERATOR$b as OPERATOR_NE, OPERATOR$2 as OPERATOR_NOR, OPERATOR$3 as OPERATOR_NOT, OPERATOR$a as OPERATOR_NOT_IN, OPERATOR$1 as OPERATOR_OR, OPERATOR$9 as OPERATOR_OVERLAP, OPERATOR$8 as OPERATOR_PREFIX, OPERATOR$7 as OPERATOR_PRESENT, OPERATOR$6 as OPERATOR_SUFFIX, OPERATOR$5 as OPERATOR_UNDEFINED, OPERATOR as OPERATOR_XOR };
+export { OPERATOR$4 as OPERATOR_AND, OPERATOR$h as OPERATOR_EQ, OPERATOR$g as OPERATOR_GE, OPERATOR$f as OPERATOR_GT, OPERATOR$e as OPERATOR_IN, OPERATOR$d as OPERATOR_LE, OPERATOR$c as OPERATOR_LT, OPERATOR$b as OPERATOR_NE, OPERATOR$2 as OPERATOR_NOR, OPERATOR$3 as OPERATOR_NOT, OPERATOR$a as OPERATOR_NOT_IN, OPERATOR$1 as OPERATOR_OR, OPERATOR$9 as OPERATOR_OVERLAP, OPERATOR$8 as OPERATOR_PREFIX, OPERATOR$7 as OPERATOR_PRESENT, OPERATOR$6 as OPERATOR_SUFFIX, OPERATOR$5 as OPERATOR_UNDEFINED, OPERATOR as OPERATOR_XOR, Engine as default };