json-p3 1.2.0 → 1.3.0

package/dist/json-p3.iife.js

@@ -1,5 +1,5 @@
 /*
- * json-p3 version 1.2.0
+ * json-p3 version 1.3.0
  * https://github.com/jg-rp/json-p3
  * 
  * MIT License
@@ -642,6 +642,24 @@ var json_p3 = (function (exports) {
     resolve: resolve
   });
 
+  const Nothing = Symbol.for("jsonpath.nothing");
+
+  /**
+   * ValueType for JSONPath function expression tye system.
+   */
+
+  /**
+   * Object passed to FilterExpression.evaluate().
+   */
+
+  /**
+   * A type predicate for an object with a string property.
+   */
+  function hasStringKey(value, key) {
+    return isObject(value) && Object.hasOwn(value, key);
+  }
+  const KEY_MARK = "\x02";
+
   /**
    * The pair of a JSON value and its location found in the target JSON value.
    */
@@ -659,7 +677,7 @@ var json_p3 = (function (exports) {
     get path() {
       return (
         // eslint-disable-next-line prefer-template
-        "$" + this.location.map(s => isString(s) ? `['${s}']` : `[${s}]`).join("")
+        "$" + this.location.map(s => isString(s) ? this.decode_name_location(s) : `[${s}]`).join("")
       );
     }
 
@@ -672,6 +690,9 @@ var json_p3 = (function (exports) {
       }
       return new JSONPointer(JSONPointer.encode(this.location.map(String)));
     }
+    decode_name_location(name) {
+      return name.startsWith(KEY_MARK) ? `[~'${name.slice(1).replaceAll("'", "\\'")}']` : `['${name.replaceAll("'", "\\'")}']`;
+    }
   }
 
   /**
@@ -751,23 +772,6 @@ var json_p3 = (function (exports) {
     }
   }
 
-  const Nothing = Symbol.for("jsonpath.nothing");
-
-  /**
-   * ValueType for JSONPath function expression tye system.
-   */
-
-  /**
-   * Object passed to FilterExpression.evaluate().
-   */
-
-  /**
-   * A type predicate for an object with a string property.
-   */
-  function hasStringKey(value, key) {
-    return isObject(value) && Object.hasOwn(value, key);
-  }
-
   /**
    * Base class for all filter expressions.
    */
@@ -1170,7 +1174,8 @@ var json_p3 = (function (exports) {
     TokenKind["AND"] = "TOKEN_AND";
     TokenKind["COLON"] = "TOKEN_COLON";
     TokenKind["COMMA"] = "TOKEN_COMMA";
-    TokenKind["CURRENT"] = "TOKEN_CURRENT_NODE";
+    TokenKind["CURRENT"] = "TOKEN_CURRENT_VALUE";
+    TokenKind["CURRENT_KEY"] = "TOKEN_CURRENT_KEY";
     TokenKind["DDOT"] = "TOKEN_DDOT";
     TokenKind["DOT"] = "TOKEN_DOT";
     TokenKind["DOUBLE_QUOTE_STRING"] = "TOKEN_DOUBLE_QUOTE_STRING";
@@ -1184,7 +1189,10 @@ var json_p3 = (function (exports) {
     TokenKind["GT"] = "TOKEN_GT";
     TokenKind["INDEX"] = "TOKEN_INDEX";
     TokenKind["KEY"] = "TOKEN_KEY";
+    TokenKind["KEY_DOUBLE_QUOTE_STRING"] = "TOKEN_KEY_DOUBLE_QUOTE_STRING";
+    TokenKind["KEY_SINGLE_QUOTE_STRING"] = "TOKEN_KEY_SINGLE_QUOTE_STRING";
     TokenKind["KEYS"] = "TOKEN_KEYS";
+    TokenKind["KEYS_FILTER"] = "TOKEN_KEYS_FILTER";
     TokenKind["LBRACKET"] = "TOKEN_LBRACKET";
     TokenKind["LE"] = "TOKEN_LE";
     TokenKind["LG"] = "TOKEN_LG";
@@ -1265,6 +1273,7 @@ var json_p3 = (function (exports) {
   const intPattern = /-?[0-9]+/y;
   const namePattern = /[\u0080-\uFFFFa-zA-Z_][\u0080-\uFFFFa-zA-Z0-9_-]*/y;
   const whitespace = new Set([" ", "\n", "\t", "\r"]);
+  const nameFirstPattern = /[\u0080-\uFFFFa-zA-Z_]/; // don't set sticky bit
 
   /**
    * JSONPath lexical scanner.
@@ -1337,6 +1346,11 @@ var json_p3 = (function (exports) {
       if (ch) this.backup();
       return ch;
     }
+    peekMatch(pattern) {
+      const ch = this.next();
+      if (ch) this.backup();
+      return pattern.test(ch);
+    }
     accept(valid) {
       const ch = this.next();
       if (valid.has(ch)) return true;
@@ -1466,10 +1480,28 @@ var json_p3 = (function (exports) {
       l.emit(TokenKind.NAME);
       return lexSegment;
     }
-    if (!l.environment.strict && l.acceptMatchRun(l.environment.keysPattern)) {
-      // Non-standard keys selector
-      l.emit(TokenKind.KEYS);
-      return lexSegment;
+    if (!l.environment.strict) {
+      // We're effectively disabling the _key selector_ and _keys filter selector_ if a
+      // custom _keys selector_ is set.
+      if (l.environment.keysPattern.source === "~" && l.peek() === "~") {
+        l.next();
+        if (l.peekMatch(nameFirstPattern)) {
+          // Non-standard key selector
+          l.ignore(); // ignore ~
+          l.acceptMatchRun(namePattern);
+          l.emit(TokenKind.KEY);
+          return lexSegment;
+        } else {
+          // Non-standard keys selector
+          l.emit(TokenKind.KEYS);
+          return lexSegment;
+        }
+      } else if (l.acceptMatchRun(l.environment.keysPattern)) {
+        // NOTE: A custom keys pattern does not play well with other non-standard key selectors.
+        // We leave this here for backwards compatibility.
+        l.emit(TokenKind.KEYS);
+        return lexSegment;
+      }
     }
     const ch = l.next();
     switch (ch) {
@@ -1494,9 +1526,28 @@ var json_p3 = (function (exports) {
       l.error("unexpected whitespace after dot");
       return null;
     }
-    if (!l.environment.strict && l.acceptMatchRun(l.environment.keysPattern)) {
-      l.emit(TokenKind.KEYS);
-      return lexSegment;
+    if (!l.environment.strict) {
+      // We're effectively disabling the _key selector_ and _keys filter selector_ if a
+      // custom _keys selector_ is set.
+      if (l.environment.keysPattern.source === "~" && l.peek() === "~") {
+        l.next();
+        if (l.peekMatch(nameFirstPattern)) {
+          // Non-standard key selector
+          l.ignore(); // ignore ~
+          l.acceptMatchRun(namePattern);
+          l.emit(TokenKind.KEY);
+          return lexSegment;
+        } else {
+          // Non-standard keys selector
+          l.emit(TokenKind.KEYS);
+          return lexSegment;
+        }
+      } else if (l.acceptMatchRun(l.environment.keysPattern)) {
+        // NOTE: A custom keys pattern does not play well with other non-standard key selectors.
+        // We leave this here for backwards compatibility.
+        l.emit(TokenKind.KEYS);
+        return lexSegment;
+      }
     }
     if (l.acceptMatchRun(namePattern)) {
       l.emit(TokenKind.NAME);
@@ -1519,8 +1570,25 @@ var json_p3 = (function (exports) {
         continue;
       }
       if (!l.environment.strict && l.acceptMatchRun(l.environment.keysPattern)) {
-        l.emit(TokenKind.KEYS);
-        continue;
+        switch (l.peek()) {
+          case "'":
+            l.ignore(); // ~
+            l.next();
+            return lexSingleQuoteKeyString(l);
+          case '"':
+            l.ignore(); // ~
+            l.next();
+            return lexDoubleQuoteKeyString(l);
+          case "?":
+            l.ignore(); // ~
+            l.next();
+            l.emit(TokenKind.KEYS_FILTER);
+            l.filterLevel += 1;
+            return lexInsideFilter;
+          default:
+            l.emit(TokenKind.KEYS);
+            continue;
+        }
       }
       const ch = l.next();
       switch (ch) {
@@ -1607,7 +1675,7 @@ var json_p3 = (function (exports) {
           l.emit(TokenKind.CURRENT);
           return lexSegment;
         case "#":
-          l.emit(TokenKind.KEY);
+          l.emit(TokenKind.CURRENT_KEY);
           return lexSegment;
         case ".":
           l.backup();
@@ -1707,8 +1775,7 @@ var json_p3 = (function (exports) {
    * @param state - The state function to return control to.
    * @returns String tokenizing state function.
    */
-  function makeLexString(quote, state) {
-    // eslint-disable-next-line sonarjs/cognitive-complexity
+  function makeLexString(quote, state, token_kind) {
     function _lexString(l) {
       l.ignore();
       if (l.peek() === quote) {
@@ -1734,7 +1801,7 @@ var json_p3 = (function (exports) {
         }
         if (ch === quote) {
           l.backup();
-          l.emit(quote === "'" ? TokenKind.SINGLE_QUOTE_STRING : TokenKind.DOUBLE_QUOTE_STRING);
+          l.emit(token_kind);
           l.next();
           l.ignore();
           return state;
@@ -1743,10 +1810,12 @@ var json_p3 = (function (exports) {
     }
     return _lexString;
   }
-  const lexSingleQuoteStringInsideBracketSelection = makeLexString("'", lexInsideBracketedSelection);
-  const lexDoubleQuoteStringInsideBracketSelection = makeLexString('"', lexInsideBracketedSelection);
-  const lexSingleQuoteStringInsideFilterExpression = makeLexString("'", lexInsideFilter);
-  const lexDoubleQuoteStringInsideFilterExpression = makeLexString('"', lexInsideFilter);
+  const lexSingleQuoteStringInsideBracketSelection = makeLexString("'", lexInsideBracketedSelection, TokenKind.SINGLE_QUOTE_STRING);
+  const lexDoubleQuoteStringInsideBracketSelection = makeLexString('"', lexInsideBracketedSelection, TokenKind.DOUBLE_QUOTE_STRING);
+  const lexSingleQuoteStringInsideFilterExpression = makeLexString("'", lexInsideFilter, TokenKind.SINGLE_QUOTE_STRING);
+  const lexDoubleQuoteStringInsideFilterExpression = makeLexString('"', lexInsideFilter, TokenKind.DOUBLE_QUOTE_STRING);
+  const lexSingleQuoteKeyString = makeLexString("'", lexInsideBracketedSelection, TokenKind.KEY_SINGLE_QUOTE_STRING);
+  const lexDoubleQuoteKeyString = makeLexString('"', lexInsideBracketedSelection, TokenKind.KEY_DOUBLE_QUOTE_STRING);
 
   /**
    * Base class for all JSONPath segments and selectors.
@@ -1787,7 +1856,7 @@ var json_p3 = (function (exports) {
     resolve(nodes) {
       const rv = [];
       for (const node of nodes) {
-        if (hasStringKey(node.value, this.name)) {
+        if (!isArray(node.value) && hasStringKey(node.value, this.name)) {
           rv.push(new JSONPathNode(node.value[this.name], node.location.concat(this.name), node.root));
         }
       }
@@ -1795,7 +1864,7 @@ var json_p3 = (function (exports) {
     }
     *lazyResolve(nodes) {
       for (const node of nodes) {
-        if (hasStringKey(node.value, this.name)) {
+        if (!isArray(node.value) && hasStringKey(node.value, this.name)) {
           yield new JSONPathNode(node.value[this.name], node.location.concat(this.name), node.root);
         }
       }
@@ -1871,7 +1940,7 @@ var json_p3 = (function (exports) {
     *lazyResolve(nodes) {
       for (const node of nodes) {
         if (!isArray(node.value)) continue;
-        for (const [i, value] of this.slice(node.value, this.start, this.stop, this.step)) {
+        for (const [i, value] of this.lazySlice(node.value, this.start, this.stop, this.step)) {
           yield new JSONPathNode(value, node.location.concat(i), node.root);
         }
       }
@@ -1934,6 +2003,45 @@ var json_p3 = (function (exports) {
       }
       return slicedArray;
     }
+
+    // eslint-disable-next-line sonarjs/cognitive-complexity
+    *lazySlice(arr, start, stop, step) {
+      if (!arr.length) return;
+
+      // Handle negative and undefined start values
+      if (start === undefined || start === null) {
+        start = step && step < 0 ? arr.length - 1 : 0;
+      } else if (start < 0) {
+        start = Math.max(arr.length + start, 0);
+      } else {
+        start = Math.min(start, arr.length - 1);
+      }
+
+      // Handle negative and undefined stop values
+      if (stop === undefined || stop === null) {
+        stop = step && step < 0 ? -1 : arr.length;
+      } else if (stop < 0) {
+        stop = Math.max(arr.length + stop, -1);
+      } else {
+        stop = Math.min(stop, arr.length);
+      }
+
+      // Perform the slice
+      if (step === undefined) {
+        // Default to a step of 1
+        for (let i = start; i < stop; i += 1) {
+          yield [i, arr[i]];
+        }
+      } else if (step > 0) {
+        for (let i = start; i < stop; i += step) {
+          yield [i, arr[i]];
+        }
+      } else if (step < 0) {
+        for (let i = start; i > stop; i += step) {
+          yield [i, arr[i]];
+        }
+      }
+    }
   }
   class WildcardSelector extends JSONPathSelector {
     constructor(environment, token) {
@@ -2000,8 +2108,6 @@ var json_p3 = (function (exports) {
           }
         }
       }
-
-      // console.log(JSON.stringify(rv.map((n: any) => n.value)));
       return this.selector.resolve(rv);
     }
     *lazyResolve(nodes) {
@@ -2358,6 +2464,38 @@ var json_p3 = (function (exports) {
     }
   }
 
+  class KeySelector extends JSONPathSelector {
+    constructor(environment, token, key) {
+      let shorthand = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
+      super(environment, token);
+      this.environment = environment;
+      this.token = token;
+      this.key = key;
+      this.shorthand = shorthand;
+    }
+    resolve(nodes) {
+      const rv = [];
+      for (const node of nodes) {
+        if (node.value instanceof String || isArray(node.value)) continue;
+        if (isObject(node.value) && hasStringKey(node.value, this.key)) {
+          rv.push(new JSONPathNode(this.key, node.location.concat(`${KEY_MARK}${this.key}`), node.root));
+        }
+      }
+      return rv;
+    }
+    *lazyResolve(nodes) {
+      for (const node of nodes) {
+        if (node.value instanceof String || isArray(node.value)) continue;
+        if (isObject(node.value) && hasStringKey(node.value, this.key)) {
+          yield new JSONPathNode(this.key, node.location.concat(`${KEY_MARK}${this.key}`), node.root);
+        }
+      }
+    }
+    toString() {
+      return this.shorthand ? `[~'${this.key.replaceAll("'", "\\'")}']` : `~'${this.key.replaceAll("'", "\\'")}'`;
+    }
+  }
+
   /**
    * Object property name selector or array index selector.
    */
@@ -2374,10 +2512,8 @@ var json_p3 = (function (exports) {
       for (const node of nodes) {
         if (node.value instanceof String || isArray(node.value)) continue;
         if (isObject(node.value)) {
-          let i = 0;
           for (const [key, _] of this.environment.entries(node.value)) {
-            rv.push(new JSONPathNode(key, node.location.concat("[~]", `[${i}]`), node.root));
-            i++;
+            rv.push(new JSONPathNode(key, node.location.concat(`${KEY_MARK}${key}`), node.root));
           }
         }
       }
@@ -2387,10 +2523,8 @@ var json_p3 = (function (exports) {
       for (const node of nodes) {
         if (node.value instanceof String || isArray(node.value)) continue;
         if (isObject(node.value)) {
-          let i = 0;
           for (const [key, _] of this.environment.entries(node.value)) {
-            yield new JSONPathNode(key, node.location.concat("[~]", `[${i}]`), node.root);
-            i++;
+            yield new JSONPathNode(key, node.location.concat(`${KEY_MARK}${key}`), node.root);
           }
         }
       }
@@ -2399,6 +2533,56 @@ var json_p3 = (function (exports) {
       return this.shorthand ? "[~]" : "~";
     }
   }
+  class KeysFilterSelector extends JSONPathSelector {
+    constructor(environment, token, expression) {
+      super(environment, token);
+      this.environment = environment;
+      this.token = token;
+      this.expression = expression;
+    }
+    resolve(nodes) {
+      const rv = [];
+      for (const node of nodes) {
+        if (node.value instanceof String || isArray(node.value)) continue;
+        if (isObject(node.value)) {
+          for (const [key, value] of this.environment.entries(node.value)) {
+            const filterContext = {
+              environment: this.environment,
+              currentValue: value,
+              rootValue: node.root,
+              currentKey: key
+            };
+            if (this.expression.evaluate(filterContext)) {
+              rv.push(new JSONPathNode(key, node.location.concat(`${KEY_MARK}${key}`), node.root));
+            }
+          }
+        }
+      }
+      return rv;
+    }
+    *lazyResolve(nodes) {
+      for (const node of nodes) {
+        if (node.value instanceof String || isArray(node.value)) continue;
+        if (isObject(node.value)) {
+          for (const [key, value] of this.environment.entries(node.value)) {
+            const filterContext = {
+              environment: this.environment,
+              currentValue: value,
+              rootValue: node.root,
+              lazy: true,
+              currentKey: key
+            };
+            if (this.expression.evaluate(filterContext)) {
+              yield new JSONPathNode(key, node.location.concat(`${KEY_MARK}${key}`), node.root);
+            }
+          }
+        }
+      }
+    }
+    toString() {
+      return `~?${this.expression.toString()}`;
+    }
+  }
 
   const PRECEDENCE_LOWEST = 1;
   const PRECEDENCE_LOGICAL_OR = 4;
@@ -2415,7 +2599,7 @@ var json_p3 = (function (exports) {
   class Parser {
     constructor(environment) {
       this.environment = environment;
-      this.tokenMap = new Map([[TokenKind.FALSE, this.parseBoolean], [TokenKind.NUMBER, this.parseNumber], [TokenKind.LPAREN, this.parseGroupedExpression], [TokenKind.NOT, this.parsePrefixExpression], [TokenKind.NULL, this.parseNull], [TokenKind.ROOT, this.parseRootQuery], [TokenKind.CURRENT, this.parseRelativeQuery], [TokenKind.SINGLE_QUOTE_STRING, this.parseString], [TokenKind.DOUBLE_QUOTE_STRING, this.parseString], [TokenKind.TRUE, this.parseBoolean], [TokenKind.FUNCTION, this.parseFunction], [TokenKind.KEY, this.parseCurrentKey], [TokenKind.KEY, this.parseCurrentKey]]);
+      this.tokenMap = new Map([[TokenKind.FALSE, this.parseBoolean], [TokenKind.NUMBER, this.parseNumber], [TokenKind.LPAREN, this.parseGroupedExpression], [TokenKind.NOT, this.parsePrefixExpression], [TokenKind.NULL, this.parseNull], [TokenKind.ROOT, this.parseRootQuery], [TokenKind.CURRENT, this.parseRelativeQuery], [TokenKind.SINGLE_QUOTE_STRING, this.parseString], [TokenKind.DOUBLE_QUOTE_STRING, this.parseString], [TokenKind.TRUE, this.parseBoolean], [TokenKind.FUNCTION, this.parseFunction], [TokenKind.CURRENT_KEY, this.parseCurrentKey]]);
     }
     parse(stream) {
       if (stream.current.kind === TokenKind.ROOT) stream.next();
@@ -2447,6 +2631,8 @@ var json_p3 = (function (exports) {
           return new NameSelector(this.environment, stream.current, stream.current.value, true);
         case TokenKind.WILD:
           return new WildcardSelector(this.environment, stream.current, true);
+        case TokenKind.KEY:
+          return new KeySelector(this.environment, stream.current, stream.current.value, true);
         case TokenKind.KEYS:
           return new KeysSelector(this.environment, stream.current, true);
         case TokenKind.DDOT:
@@ -2542,6 +2728,13 @@ var json_p3 = (function (exports) {
           case TokenKind.WILD:
             items.push(new WildcardSelector(this.environment, stream.current));
             break;
+          case TokenKind.KEY_SINGLE_QUOTE_STRING:
+          case TokenKind.KEY_DOUBLE_QUOTE_STRING:
+            items.push(new KeySelector(this.environment, stream.current, this.decodeString(stream.current, true), false));
+            break;
+          case TokenKind.KEYS_FILTER:
+            items.push(this.parseFilter(stream, true));
+            break;
           case TokenKind.KEYS:
             items.push(new KeysSelector(this.environment, stream.current));
             break;
@@ -2562,6 +2755,7 @@ var json_p3 = (function (exports) {
       return new BracketedSelection(this.environment, token, items);
     }
     parseFilter(stream) {
+      let keys = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
       const tok = stream.next();
       const expr = this.parseFilterExpression(stream);
       if (expr instanceof FunctionExtension) {
@@ -2570,7 +2764,7 @@ var json_p3 = (function (exports) {
           throw new JSONPathTypeError(`result of ${expr.name}()  must be compared`, expr.token);
         }
       }
-      return new FilterSelector(this.environment, tok, new LogicalExpression(tok, expr));
+      return keys ? new KeysFilterSelector(this.environment, tok, new LogicalExpression(tok, expr)) : new FilterSelector(this.environment, tok, new LogicalExpression(tok, expr));
     }
     parseBoolean(stream) {
       if (stream.current.kind === TokenKind.FALSE) return new BooleanLiteral(stream.current, false);
@@ -2605,13 +2799,20 @@ var json_p3 = (function (exports) {
       return new InfixExpression(tok, left, operator, right);
     }
     parseGroupedExpression(stream) {
-      stream.next();
+      if (stream.peek.kind === TokenKind.RPAREN) {
+        throw new JSONPathSyntaxError(`empty paren expression`, stream.current);
+      }
+      stream.next(); // eat open paren
+
       let expr = this.parseFilterExpression(stream);
       stream.next();
       while (stream.current.kind !== TokenKind.RPAREN) {
         if (stream.current.kind === TokenKind.EOF) {
           throw new JSONPathSyntaxError("unbalanced parentheses", stream.current);
         }
+        if (!BINARY_OPERATORS.has(stream.current.kind)) {
+          throw new JSONPathSyntaxError(`expected an expression, found '${stream.current.value}'`, stream.current);
+        }
         expr = this.parseInfixExpression(stream, expr);
       }
       stream.expect(TokenKind.RPAREN);
@@ -2667,7 +2868,7 @@ var json_p3 = (function (exports) {
             msg = "end of expression";
             break;
           default:
-            msg = `'${stream.current.value}`;
+            msg = `'${stream.current.value}'`;
         }
         throw new JSONPathSyntaxError(`unexpected ${msg}`, stream.current);
       }
@@ -2991,6 +3192,7 @@ var json_p3 = (function (exports) {
     JSONPathRecursionLimitError: JSONPathRecursionLimitError,
     JSONPathSyntaxError: JSONPathSyntaxError,
     JSONPathTypeError: JSONPathTypeError,
+    KEY_MARK: KEY_MARK,
     Nothing: Nothing,
     Token: Token,
     TokenKind: TokenKind,
@@ -3483,7 +3685,7 @@ var json_p3 = (function (exports) {
     apply: apply
   });
 
-  const version = "1.2.0";
+  const version = "1.3.0";
 
   exports.DEFAULT_ENVIRONMENT = DEFAULT_ENVIRONMENT;
   exports.FunctionExpressionType = FunctionExpressionType;