Normalized path

[ashphy]

Close #6

Added a feature to retrieve the normalized path defined at RFC9535 2.7

Usage

Add a path function

import { JSONPathJS } from "jsonpath-js";

const query = new JSONPathJS("$.users[*].name");
const result = query.paths({
	users: [{ name: "John Doe" }, { name: "Jane Doe" }],
});

// [
// 	{ value: "John Doe", path: "$['users'][0]['name']" },
// 	{ value: "Jane Doe", path: "$['users'][1]['name']" },
// ];
console.log(result);

[Copilot]

Pull Request Overview

This pull request introduces a normalized path feature as defined in RFC9535 2.7, enabling retrieval of normalized paths from JSONPath queries. Key changes include:

• Implementation of a new escapeMemberName function for correctly escaping member names.
• Updates to node creation, traversal, and filtering functions to support normalized paths.
• Expanded test coverage and documentation updates to illustrate the new paths() functionality.

Reviewed Changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/utils/escapeMemberName.ts	Introduces a new function to escape member names per RFC9535 for normalized paths.
src/utils/enumarateNode.ts	Adds a function to enumerate nodes using the new normalized node structure.
src/types/node.ts	Updates node definitions and helper functions for normalized paths.
README.md	Updates the usage documentation with examples of the new paths() function.
tests/utils.ts	Adds tests verifying the normalized path output.
tests/RFC9535/jsonpath-compliance-test-suite.test.ts	Adds additional tests covering normalized path outputs.
src/parsers/root.ts, traverseDescendant.ts, jsonpath_js.ts, parser.ts, etc.	Adjust existing functions to work with the updated Node structure and support normalized paths.
src/functions/, src/parsers/, src/comparator/*	Refactors and adjusts implementations to correctly extract node values and normalized paths.
tests/index.test.ts, tests/RFC9535/ietf_jsonpath.test.ts	Updates tests to reflect modifications in node structure and function outputs.