@swaggerexpert/jsonpath 3.0.1 → 3.2.2

package/README.md

@@ -43,6 +43,8 @@ The development of this library contributed to the identification and formal sub
       - [Statistics](#statistics)
       - [Tracing](#tracing)
     - [Validation](#validation)
+    - [Compilation](#compilation)
+    - [Escaping](#escaping)
     - [Errors](#errors)
     - [Grammar](#grammar)
 - [More about JSONPath](#more-about-jsonpath)
@@ -200,10 +202,11 @@ const { result, trace } = parse('$fdfadfd', { trace: true });
 
 result.success; // returns false
 trace.displayTrace(); // returns trace information
+trace.inferExpectations(); // returns parser expectations
 ```
 
-By combining information from `result` and `trace`, it is possible to analyze the parsing process in detail
-and generate a messages like this: `'Syntax error at position 1, expected "[", ".", ".."'`. Please see this
+By combining information from `result` and `trace`, you can analyze the parsing process in detail
+and generate messages like: `'Syntax error at position 1, expected "[", ".", ".."'`. Please see this
 [test file](https://github.com/swaggerexpert/jsonpath/blob/main/test/parse/trace.js) for more information how to achieve that.
 
 #### Validation
@@ -226,13 +229,39 @@ test("$['a']", { normalized: true }); // => true
 test('$.store.book[0].title', { normalized: true }); // => false
 ```
 
+#### Compilation
+
+Compilation is the process of transforming a list of selectors into a [Normalized Path](https://www.rfc-editor.org/rfc/rfc9535#name-normalized-paths).
+During compilation, name selectors are automatically escaped before being compiled.
+
+```js
+import { compile } from '@swaggerexpert/jsonpath';
+
+compile(['store', 'book', 0, 'title']); // => "$['store']['book'][0]['title']"
+```
+
+#### Escaping
+
+Certain characters within name selectors in Normalized Paths require escaping.
+The apostrophe (`'`) and backslash (`\`) characters must be escaped.
+Control characters (U+0000 through U+001F) are escaped using specific escape sequences
+(`\b`, `\t`, `\n`, `\f`, `\r`) or Unicode escape sequences (`\uXXXX`).
+
+```js
+import { escape } from '@swaggerexpert/jsonpath';
+
+escape("it's"); // => "it\\'s"
+escape('back\\slash'); // => "back\\\\slash"
+escape('line\nfeed'); // => "line\\nfeed"
+```
+
 #### Errors
 
 `@swaggerexpert/jsonpath` provides a structured error class hierarchy,
-enabling precise error handling across JSONPath operations, including parsing.
+enabling precise error handling across JSONPath operations, including parsing and compilation.
 
 ```js
-import { JSONPathError, JSONPathParseError } from '@swaggerexpert/jsonpath';
+import { JSONPathError, JSONPathParseError, JSONPathCompileError } from '@swaggerexpert/jsonpath';
 ```
 
 **JSONPathError** is the base class for all JSONPath errors.

package/SECURITY.md

@@ -6,7 +6,9 @@ If you believe you've found an exploitable security issue in @swaggerexpert/json
 
 | Version | Supported          |
 |---------|--------------------|
-| ^1.0.0  | :white_check_mark: |
+| ^1.0.0  | :x:                |
+| ^2.0.0  | :x:                |
+| ^3.0.0  | :white_check_mark: |
 
 ## Reporting a Vulnerability
 

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@swaggerexpert/jsonpath",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org",
+    "provenance": true
   },
-  "version": "3.0.1",
-  "description": "RCF 9535 implementation of JSONPath",
+  "version": "3.2.2",
+  "description": "RFC 9535 implementation of JSONPath",
   "main": "./cjs/index.cjs",
   "types": "./types/index.d.ts",
   "exports": {
@@ -60,22 +62,28 @@
     "SECURITY.md"
   ],
   "dependencies": {
-    "apg-lite": "^1.0.4"
+    "apg-lite": "^1.0.5"
   },
   "devDependencies": {
-    "@babel/cli": "=7.27.0",
-    "@babel/core": "=7.26.10",
-    "@babel/preset-env": "=7.26.9",
-    "@commitlint/cli": "=19.8.0",
-    "@commitlint/config-conventional": "=19.8.0",
+    "@babel/cli": "=7.28.6",
+    "@babel/core": "=7.28.6",
+    "@babel/preset-env": "=7.28.6",
+    "@commitlint/cli": "=20.3.1",
+    "@commitlint/config-conventional": "=20.3.1",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.3",
+    "@semantic-release/release-notes-generator": "^14.1.0",
     "apg-js": "^4.4.0",
     "babel-plugin-module-resolver": "^5.0.2",
-    "chai": "=5.2.0",
-    "cross-env": "^7.0.3",
+    "chai": "=6.2.2",
+    "cross-env": "^10.0.0",
     "husky": "=9.1.7",
-    "mocha": "=11.1.0",
-    "mocha-expect-snapshot": "^7.2.0",
+    "mocha": "=11.7.5",
+    "mocha-expect-snapshot": "^8.0.0",
     "npm-watch": "^0.13.0",
-    "prettier": "^3.5.2"
+    "prettier": "^3.5.2",
+    "semantic-release": "^25.0.2"
   }
 }

package/types/index.d.ts

@@ -95,6 +95,8 @@ export interface NameSelectorASTNode extends ASTNode {
   value: string;
   format: 'single-quoted' | 'double-quoted' | 'shorthand';
 }
+type NameSelectorShorthandASTNode = NameSelectorASTNode & { format: 'shorthand' };
+type NameSelectorQuotedASTNode   = NameSelectorASTNode & { format: 'single-quoted' | 'double-quoted' };
 // https://www.rfc-editor.org/rfc/rfc9535#section-2.3.2.1
 export interface WildcardSelectorASTNode extends ASTNode {
   type: 'WildcardSelector';
@@ -169,7 +171,7 @@ export interface FunctionExprASTNode extends ASTNode {
 // https://www.rfc-editor.org/rfc/rfc9535#section-2.5.1.1
 export interface ChildSegmentASTNode extends ASTNode {
   type: 'ChildSegment';
-  selector: BracketedSelectionASTNode | WildcardSelectorASTNode | NameSelectorASTNode;
+  selector: BracketedSelectionASTNode | WildcardSelectorASTNode | NameSelectorShorthandASTNode;
 }
 export interface BracketedSelectionASTNode extends ASTNode {
   type: 'BracketedSelection';
@@ -177,11 +179,11 @@ export interface BracketedSelectionASTNode extends ASTNode {
 }
 export interface DescendantSegmentASTNode extends ASTNode {
   type: 'DescendantSegment';
-  selector: BracketedSelectionASTNode | WildcardSelectorASTNode | NameSelectorASTNode;
+  selector: BracketedSelectionASTNode | WildcardSelectorASTNode | NameSelectorShorthandASTNode;
 }
 // union types
 export type SelectorASTNode =
-  | NameSelectorASTNode
+  | NameSelectorQuotedASTNode
   | WildcardSelectorASTNode
   | SliceSelectorASTNode
   | IndexSelectorASTNode