@briza/illogical 2.2.0 → 2.2.1

package/lib/illogical.cjs

@@ -2074,6 +2074,36 @@ function resolveCompactRef(ref, ctx) {
   }
   return resolveTokens(ref.tokens ?? [], ref.t, ctx);
 }
+function getKeyFromCompactRef(ref) {
+  if (typeof ref === 'string') {
+    return ref;
+  }
+  if (Array.isArray(ref)) {
+    return ref.map(ref => ref.includes('.') ? `\`${ref}\`` : ref).join('.');
+  }
+  let tokens = ref.tokens;
+  if (ref.d) {
+    let current = ref.k;
+    let match = dynamicKeyRegex.exec(current);
+    while (match) {
+      current = current.replace(dynamicKeyRegex, '').replace('[]', '');
+      match = dynamicKeyRegex.exec(current);
+    }
+    tokens = parseStaticKey(current);
+  }
+  let key = '';
+  for (const token of tokens ?? []) {
+    if (isNumber(token.value)) {
+      return key;
+    }
+    if (token.value.includes('.')) {
+      key += `${key ? '.' : ''}\`${token.value}\``;
+    } else {
+      key += `${key ? '.' : ''}${token.value}`;
+    }
+  }
+  return key;
+}
 
 /**
  * Bytecode compiler.
@@ -3757,7 +3787,6 @@ function interpretSimplify(compiled, ctx, strictKeys, optionalKeys) {
       case OP_PUSH_REF_DYNAMIC:
         {
           const idx = numAt(bytecode[i++]);
-          const rawKey = refRawKeys[idx];
           let val;
           if (resolvedRefDirty[idx]) {
             val = resolvedRefCache[idx];
@@ -3776,12 +3805,12 @@ function interpretSimplify(compiled, ctx, strictKeys, optionalKeys) {
           // Ref is absent from context.
           // Check if it should be treated as a concrete undefined (evaluated as undefined)
           // or as a residual expression (preserved for later simplification).
-          if (strictSet?.has(rawKey)) {
+          if (strictSet?.has(getKeyFromCompactRef(refs[idx]))) {
             // strictKeys: force-evaluate as undefined (not a residual)
             stack[++stackTop] = undefined;
             break;
           }
-          if (optionalSet && !optionalSet.has(rawKey)) {
+          if (optionalSet && !optionalSet.has(getKeyFromCompactRef(refs[idx]))) {
             // Key not in optionalKeys: treat as definitely-present but absent → undefined
             stack[++stackTop] = undefined;
             break;

package/lib/illogical.esm.js

@@ -2070,6 +2070,36 @@ function resolveCompactRef(ref, ctx) {
   }
   return resolveTokens(ref.tokens ?? [], ref.t, ctx);
 }
+function getKeyFromCompactRef(ref) {
+  if (typeof ref === 'string') {
+    return ref;
+  }
+  if (Array.isArray(ref)) {
+    return ref.map(ref => ref.includes('.') ? `\`${ref}\`` : ref).join('.');
+  }
+  let tokens = ref.tokens;
+  if (ref.d) {
+    let current = ref.k;
+    let match = dynamicKeyRegex.exec(current);
+    while (match) {
+      current = current.replace(dynamicKeyRegex, '').replace('[]', '');
+      match = dynamicKeyRegex.exec(current);
+    }
+    tokens = parseStaticKey(current);
+  }
+  let key = '';
+  for (const token of tokens ?? []) {
+    if (isNumber(token.value)) {
+      return key;
+    }
+    if (token.value.includes('.')) {
+      key += `${key ? '.' : ''}\`${token.value}\``;
+    } else {
+      key += `${key ? '.' : ''}${token.value}`;
+    }
+  }
+  return key;
+}
 
 /**
  * Bytecode compiler.
@@ -3753,7 +3783,6 @@ function interpretSimplify(compiled, ctx, strictKeys, optionalKeys) {
       case OP_PUSH_REF_DYNAMIC:
         {
           const idx = numAt(bytecode[i++]);
-          const rawKey = refRawKeys[idx];
           let val;
           if (resolvedRefDirty[idx]) {
             val = resolvedRefCache[idx];
@@ -3772,12 +3801,12 @@ function interpretSimplify(compiled, ctx, strictKeys, optionalKeys) {
           // Ref is absent from context.
           // Check if it should be treated as a concrete undefined (evaluated as undefined)
           // or as a residual expression (preserved for later simplification).
-          if (strictSet?.has(rawKey)) {
+          if (strictSet?.has(getKeyFromCompactRef(refs[idx]))) {
             // strictKeys: force-evaluate as undefined (not a residual)
             stack[++stackTop] = undefined;
             break;
           }
-          if (optionalSet && !optionalSet.has(rawKey)) {
+          if (optionalSet && !optionalSet.has(getKeyFromCompactRef(refs[idx]))) {
             // Key not in optionalKeys: treat as definitely-present but absent → undefined
             stack[++stackTop] = undefined;
             break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@briza/illogical",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "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.",
   "type": "module",
   "main": "./lib/illogical.cjs",

package/readme.md

@@ -8,33 +8,37 @@
   <div align="center">
     <h3 align="center">illogical</h3>
   </div>
+</div>
 
-[![build status](https://github.com/briza-insurance/illogical/actions/workflows/test.yml/badge.svg)](https://github.com/briza-insurance/illogical/actions?branch=master)
-[![npm version](https://badge.fury.io/js/@briza%2Fillogical.svg?icon=si%3Anpm)](https://badge.fury.io/js/@briza%2Fillogical)
-[![install size](https://packagephobia.com/badge?p=@briza/illogical)](https://packagephobia.com/result?p=@briza/illogical)
-![zero dependencies](https://img.shields.io/badge/0-dependencies-green)
-![npm downloads](https://img.shields.io/npm/dm/%40briza%2Fillogical)
-
+<div align="center">
+  <p>
+  **illogical** is a JSON DSL (domain-specific language) for expressing and evaluating business rules in the insurance industry. Underwriters use illogical to model business rules for their question sets, enabling distributors to render great user experiences.
+  </p>
 </div>
 
 <div align="center">
-<p>
-<br />
-JSON DSL for expressing and evaluating business rules. Underwriters use illogical to model business rules for their question sets, enabling distributors to render great user experiences.
-</p>
+  [![build status](https://github.com/briza-insurance/illogical/actions/workflows/test.yml/badge.svg)](https://github.com/briza-insurance/illogical/actions?branch=master)
+  [![npm version](https://badge.fury.io/js/@briza%2Fillogical.svg?icon=si%3Anpm)](https://badge.fury.io/js/@briza%2Fillogical)
+  [![install size](https://packagephobia.com/badge?p=@briza/illogical)](https://packagephobia.com/result?p=@briza/illogical)
+  ![zero dependencies](https://img.shields.io/badge/0-dependencies-green)
+  ![npm downloads](https://img.shields.io/npm/dm/%40briza%2Fillogical)
 </div>
 
 ---
 
-This project is designed such that business rules can be shared between the front-end and back-end, serialized in JSON.
+## 🚀 Getting Started
 
-## 🚀 Get Started
+Get up and running with illogical in just a few steps.
+
+### Installation
 
 ```sh
 # install illogical
 npm install @briza/illogical
 ```
 
+### Basic Usage
+
 ```js
 // Import the illogical engine
 import Engine from '@briza/illogical'
@@ -65,9 +69,11 @@ engine.evaluate(['==', '$age.(String)', '21'], ctx) // true
 engine.evaluate(['AND', ['>', '$age', 20], ['==', '$name', 'peter']]) // true
 ```
 
-## 🖼️ Resources
+## 📚 Documentation
 
-Understand supported expressions:
+### Core Concepts
+
+Explore the supported expressions and their usage:
 
 - [Comparison Expressions](./specs/comparison-expressions.md)
 - [Logical Expressions](./specs/logical-expressions.md)
@@ -75,19 +81,25 @@ Understand supported expressions:
 - [Evaluation Data Context](./specs/evaluation-data-context.md)
 - [Operand Types](./specs/operand-types.md)
 
-Learn about usages:
+### API Reference
+
+Learn how to use the engine and its methods:
 
 - [Evaluate](./specs/evaluate.md)
 - [Statement](./specs/statement.md)
 - [Parse](./specs/parse.md)
 - [Simplify](./specs/simplify.md)
 
+### Customization
+
 Customize the engine and the documentation:
 
 - [Engine Options](./specs/engine.md)
 - [Code Documentation](https://briza-insurance.github.io/illogical/index.html)
 
-Bytecode evaluation and debugging tools:
+### Development Tools
+
+For advanced usage like bytecode evaluation and debugging:
 
 - [Bytecode Evaluator](./specs/bytecode-evaluator.md)
 - [Debugger Tools](./specs/debugger-tools.md)

package/types/bytecode/refs.d.ts

@@ -71,3 +71,4 @@ export declare function resolveDynamic(key: string, dataType: DataType | undefin
  * (OP_OVERLAP_SCAN_REFS_CONST, OP_OR_AND_IN_CONST_2).
  */
 export declare function resolveCompactRef(ref: CompactRef, ctx: Context): Result;
+export declare function getKeyFromCompactRef(ref: CompactRef): string;