@briza/illogical 1.5.6 → 1.5.8

package/changelog.md

@@ -1,5 +1,14 @@
 # illogical changelog
 
+## 1.5.8
+
+- Introduce the backtick syntax for condition referencing keys that contain dot delimiters
+
+## 1.5.7
+
+- Update documentation to include example of comparison operator with two references
+- Fix linting issues
+
 ## 1.5.6
 
 - Comparison Expressions updated to support string comparison for ISO-8601 formatted dates.

package/lib/illogical.esm.js

@@ -1232,23 +1232,29 @@ class Collection extends Operand {
 
 const keyWithArrayIndexRegex = /^(?<currentKey>[^[\]]+?)(?<indexes>(?:\[\d+])+)?$/;
 const arrayIndexRegex = /\[(\d+)]/g;
-const parseKey = key => key.split('.').flatMap(key => {
-  const parseResult = keyWithArrayIndexRegex.exec(key);
-  const keys = [];
-  if (parseResult) {
-    var _parseResult$groups$c, _parseResult$groups, _parseResult$groups2;
-    keys.push((_parseResult$groups$c = parseResult === null || parseResult === void 0 || (_parseResult$groups = parseResult.groups) === null || _parseResult$groups === void 0 ? void 0 : _parseResult$groups.currentKey) !== null && _parseResult$groups$c !== void 0 ? _parseResult$groups$c : key);
-    const rawIndexes = parseResult === null || parseResult === void 0 || (_parseResult$groups2 = parseResult.groups) === null || _parseResult$groups2 === void 0 ? void 0 : _parseResult$groups2.indexes;
-    if (rawIndexes) {
-      for (const indexResult of rawIndexes.matchAll(arrayIndexRegex)) {
-        keys.push(parseInt(indexResult[1]));
+const parseBacktickWrappedKey = key => key.startsWith('`') && key.endsWith('`') ? key.slice(1, -1) : key;
+const parseKey = key => {
+  const keys = key.match(/(`[^[\]]+`(\[\d+\])*|[^`.]+)/g);
+  return !keys ? [] : keys.flatMap(key => {
+    const unwrappedKey = parseBacktickWrappedKey(key);
+    const keys = [];
+    const parseResult = keyWithArrayIndexRegex.exec(unwrappedKey);
+    if (parseResult) {
+      var _parseResult$groups$c, _parseResult$groups, _parseResult$groups2;
+      const extractedKey = parseBacktickWrappedKey((_parseResult$groups$c = parseResult === null || parseResult === void 0 || (_parseResult$groups = parseResult.groups) === null || _parseResult$groups === void 0 ? void 0 : _parseResult$groups.currentKey) !== null && _parseResult$groups$c !== void 0 ? _parseResult$groups$c : unwrappedKey);
+      keys.push(extractedKey);
+      const rawIndexes = parseResult === null || parseResult === void 0 || (_parseResult$groups2 = parseResult.groups) === null || _parseResult$groups2 === void 0 ? void 0 : _parseResult$groups2.indexes;
+      if (rawIndexes) {
+        for (const indexResult of rawIndexes.matchAll(arrayIndexRegex)) {
+          keys.push(parseInt(indexResult[1]));
+        }
       }
+    } else {
+      keys.push(unwrappedKey);
     }
-  } else {
-    keys.push(key);
-  }
-  return keys;
-});
+    return keys;
+  });
+};
 const complexKeyExpression = /{([^{}]+)}/;
 function extractComplexKeys(ctx, key) {
   // Resolve complex keys

package/lib/illogical.js

@@ -1236,23 +1236,29 @@ class Collection extends Operand {
 
 const keyWithArrayIndexRegex = /^(?<currentKey>[^[\]]+?)(?<indexes>(?:\[\d+])+)?$/;
 const arrayIndexRegex = /\[(\d+)]/g;
-const parseKey = key => key.split('.').flatMap(key => {
-  const parseResult = keyWithArrayIndexRegex.exec(key);
-  const keys = [];
-  if (parseResult) {
-    var _parseResult$groups$c, _parseResult$groups, _parseResult$groups2;
-    keys.push((_parseResult$groups$c = parseResult === null || parseResult === void 0 || (_parseResult$groups = parseResult.groups) === null || _parseResult$groups === void 0 ? void 0 : _parseResult$groups.currentKey) !== null && _parseResult$groups$c !== void 0 ? _parseResult$groups$c : key);
-    const rawIndexes = parseResult === null || parseResult === void 0 || (_parseResult$groups2 = parseResult.groups) === null || _parseResult$groups2 === void 0 ? void 0 : _parseResult$groups2.indexes;
-    if (rawIndexes) {
-      for (const indexResult of rawIndexes.matchAll(arrayIndexRegex)) {
-        keys.push(parseInt(indexResult[1]));
+const parseBacktickWrappedKey = key => key.startsWith('`') && key.endsWith('`') ? key.slice(1, -1) : key;
+const parseKey = key => {
+  const keys = key.match(/(`[^[\]]+`(\[\d+\])*|[^`.]+)/g);
+  return !keys ? [] : keys.flatMap(key => {
+    const unwrappedKey = parseBacktickWrappedKey(key);
+    const keys = [];
+    const parseResult = keyWithArrayIndexRegex.exec(unwrappedKey);
+    if (parseResult) {
+      var _parseResult$groups$c, _parseResult$groups, _parseResult$groups2;
+      const extractedKey = parseBacktickWrappedKey((_parseResult$groups$c = parseResult === null || parseResult === void 0 || (_parseResult$groups = parseResult.groups) === null || _parseResult$groups === void 0 ? void 0 : _parseResult$groups.currentKey) !== null && _parseResult$groups$c !== void 0 ? _parseResult$groups$c : unwrappedKey);
+      keys.push(extractedKey);
+      const rawIndexes = parseResult === null || parseResult === void 0 || (_parseResult$groups2 = parseResult.groups) === null || _parseResult$groups2 === void 0 ? void 0 : _parseResult$groups2.indexes;
+      if (rawIndexes) {
+        for (const indexResult of rawIndexes.matchAll(arrayIndexRegex)) {
+          keys.push(parseInt(indexResult[1]));
+        }
       }
+    } else {
+      keys.push(unwrappedKey);
     }
-  } else {
-    keys.push(key);
-  }
-  return keys;
-});
+    return keys;
+  });
+};
 const complexKeyExpression = /{([^{}]+)}/;
 function extractComplexKeys(ctx, key) {
   // Resolve complex keys

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@briza/illogical",
-  "version": "1.5.6",
+  "version": "1.5.8",
   "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",

package/readme.md

@@ -230,6 +230,26 @@ The evaluation data context is used to provide the expression with variable refe
 To reference the nested reference, please use "." delimiter, e.g.:
 `$address.city`
 
+If the key of the nested reference includes the "." delimiter, please wrap the whole key with backticks `` ` ``, e.g.:
+`` $address.`city.code` `` can reference the object
+```javascript
+{
+  address: {
+    'city.code': 'TOR'
+  }
+}
+```
+
+`` $address.`city.code`[0] `` can reference the object
+```javascript
+{
+  address: {
+    'city.code': ['TOR']
+  }
+}
+```
+when the value of the nested reference is an array.
+
 #### Accessing Array Element:
 
 `$options[1]`
@@ -331,11 +351,12 @@ The reference operand must be prefixed with `$` symbol, e.g.: `$name`. This migh
 
 **Example**
 
-| Expression                    | Data Context      |
-| ----------------------------- | ----------------- |
-| `['==', '$age', 21]`          | `{age: 21}`       |
-| `['==', 'circle', '$shape'] ` | `{age: 'circle'}` |
-| `['==', '$visible', true]`    | `{visible: true}` |
+| Expression                    | Data Context                          |
+| ----------------------------- | ------------------------------------- |
+| `['==', '$age', 21]`          | `{age: 21}`                           |
+| `['==', 'circle', '$shape'] ` | `{shape: 'circle'}`                   |
+| `['==', '$visible', true]`    | `{visible: true}`                     |
+| `['==', '$circle', '$shape']` | `{circle: 'circle', shape: 'circle'}` |
 
 #### Collection