@twin.org/data-json-path 0.0.3-next.2 → 0.0.3-next.21

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Data JSONPath
 
-JSONPath abstraction layer for TWIN platform.
+This package provides a consistent abstraction for JSONPath queries, helping teams read and filter complex JSON structures through one stable interface. It builds on [JSONPath](https://goessner.net/articles/JsonPath/) concepts and the `json-p3` implementation to support reliable document querying across the repository.
 
 ## Installation
 

package/dist/es/index.js

@@ -1,5 +1,6 @@
 // Copyright 2025 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 export * from "./jsonPathHelper.js";
+export * from "./models/IJsonPathLocation.js";
 export * from "./models/IJsonPathResult.js";
 //# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./jsonPathHelper.js\";\nexport * from \"./models/IJsonPathResult.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./jsonPathHelper.js\";\nexport * from \"./models/IJsonPathLocation.js\";\nexport * from \"./models/IJsonPathResult.js\";\n"]}

package/dist/es/jsonPathHelper.js

@@ -114,5 +114,105 @@ export class JsonPathHelper {
             }, BaseError.fromError(error));
         }
     }
+    /**
+     * Set a value on the target object using a JSONPath location.
+     * @param root The target root object.
+     * @param location The JSONPath location tokens.
+     * @param value The value to set.
+     */
+    static setAtLocation(root, location, value) {
+        if (!Is.arrayValue(location) || location.length === 0) {
+            return;
+        }
+        let current = root;
+        for (let i = 0; i < location.length - 1; i++) {
+            const token = location[i];
+            const nextToken = location[i + 1];
+            if (!Is.array(current) && !Is.object(current)) {
+                return;
+            }
+            if (Is.number(token)) {
+                if (!Is.array(current)) {
+                    return;
+                }
+                const existing = current[token];
+                if (!Is.array(existing) && !Is.object(existing)) {
+                    current[token] = Is.number(nextToken) ? [] : {};
+                }
+                current = current[token];
+            }
+            else {
+                if (!Is.object(current)) {
+                    return;
+                }
+                const existing = current[token];
+                if (!Is.array(existing) && !Is.object(existing)) {
+                    current[token] = Is.number(nextToken) ? [] : {};
+                }
+                current = current[token];
+            }
+        }
+        const lastToken = location[location.length - 1];
+        if (!Is.array(current) && !Is.object(current)) {
+            return;
+        }
+        if (Is.number(lastToken)) {
+            if (!Is.array(current)) {
+                return;
+            }
+            current[lastToken] = value;
+        }
+        else {
+            if (!Is.object(current)) {
+                return;
+            }
+            current[lastToken] = value;
+        }
+    }
+    /**
+     * Delete a value on the target object using a JSONPath location.
+     * @param root The target root object.
+     * @param location The JSONPath location tokens.
+     */
+    static deleteAtLocation(root, location) {
+        if (!Is.arrayValue(location) || location.length === 0) {
+            return;
+        }
+        let current = root;
+        for (let i = 0; i < location.length - 1; i++) {
+            const token = location[i];
+            if (!Is.array(current) && !Is.object(current)) {
+                return;
+            }
+            if (Is.number(token)) {
+                if (!Is.array(current)) {
+                    return;
+                }
+                current = current[token];
+            }
+            else {
+                if (!Is.object(current)) {
+                    return;
+                }
+                current = current[token];
+            }
+        }
+        if (!Is.array(current) && !Is.object(current)) {
+            return;
+        }
+        const lastToken = location[location.length - 1];
+        if (Is.number(lastToken)) {
+            if (!Is.array(current)) {
+                return;
+            }
+            current[lastToken] = undefined;
+        }
+        else {
+            if (!Is.object(current)) {
+                return;
+            }
+            delete current[lastToken];
+        }
+    }
 }
 //# sourceMappingURL=jsonPathHelper.js.map

package/dist/es/jsonPathHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"jsonPathHelper.js","sourceRoot":"","sources":["../../src/jsonPathHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAErE,OAAO,EAAE,QAAQ,EAAkB,MAAM,SAAS,CAAC;AAGnD;;;GAGG;AACH,MAAM,OAAO,cAAc;IAC1B;;OAEG;IACI,MAAM,CAAU,UAAU,oBAAoC;IAErE;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,IAAY,EAAE,IAAa;QAC9C,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAElE,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAiB,CAAC,CAAC;YACxD,uDAAuD;YACvD,MAAM,WAAW,GAAsB,EAAE,CAAC;YAC1C,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;gBAC5B,WAAW,CAAC,IAAI,CAAC;oBAChB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;iBACzC,CAAC,CAAC;YACJ,CAAC;YACD,OAAO,WAAW,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,cAAc,CAAC,UAAU,EACzB,OAAO,EACP;gBACC,IAAI;aACJ,EACD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAC1B,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,IAAa;QAC/C,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAElE,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAiB,CAAC,CAAC;YACxD,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACzB,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,IAAY,EAAE,IAAa;QACtD,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAElE,IAAI,CAAC;YACJ,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAiB,CAAC,CAAC;YACrD,OAAO,IAAI,EAAE,KAAK,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,cAAc,CAAC,UAAU,EACzB,qBAAqB,EACrB;gBACC,IAAI;aACJ,EACD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAC1B,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,IAAY,EAAE,IAAa;QACnD,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAElE,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAiB,CAAC,CAAC;YACxD,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,cAAc,CAAC,UAAU,EACzB,kBAAkB,EAClB;gBACC,IAAI;aACJ,EACD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAC1B,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAY;QAClC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACd,CAAC;QAED,IAAI,CAAC;YACJ,yCAAyC;YACzC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,cAAc,CAAC,UAAU,EACzB,gBAAgB,EAChB;gBACC,IAAI;aACJ,EACD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAC1B,CAAC;QACH,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseError, GeneralError, Guards, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { jsonpath, type JSONValue } from \"json-p3\";\nimport type { IJsonPathResult } from \"./models/IJsonPathResult.js\";\n\n/**\n * Helper class for JSONPath operations.\n * Provides abstraction over the json-p3 library.\n */\nexport class JsonPathHelper {\n\t/**\n\t * The name of the class name of the JsonPathHelper class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<JsonPathHelper>();\n\n\t/**\n\t * Execute a JSONPath query and return results with values and locations.\n\t * @param path The JSONPath query string (e.g., \"$.store.book[*].title\").\n\t * @param data The data to query.\n\t * @returns Array of results containing values and their locations.\n\t * @throws GeneralError if the path is invalid or data cannot be queried.\n\t */\n\tpublic static query(path: string, data: unknown): IJsonPathResult[] {\n\t\tGuards.stringValue(JsonPathHelper.CLASS_NAME, nameof(path), path);\n\n\t\ttry {\n\t\t\tconst results = jsonpath.query(path, data as JSONValue);\n\t\t\t// Convert JSONPathNodeList to array of IJsonPathResult\n\t\t\tconst resultArray: IJsonPathResult[] = [];\n\t\t\tfor (const node of results) {\n\t\t\t\tresultArray.push({\n\t\t\t\t\tvalue: node.value,\n\t\t\t\t\tlocation: node.location,\n\t\t\t\t\tpath: node.getPath({ form: \"canonical\" })\n\t\t\t\t});\n\t\t\t}\n\t\t\treturn resultArray;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tJsonPathHelper.CLASS_NAME,\n\t\t\t\t\"query\",\n\t\t\t\t{\n\t\t\t\t\tpath\n\t\t\t\t},\n\t\t\t\tBaseError.fromError(error)\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Check if a JSONPath exists in the data.\n\t * @param path The JSONPath query string.\n\t * @param data The data to check.\n\t * @returns True if the path exists and returns at least one result.\n\t */\n\tpublic static exists(path: string, data: unknown): boolean {\n\t\tGuards.stringValue(JsonPathHelper.CLASS_NAME, nameof(path), path);\n\n\t\ttry {\n\t\t\tconst results = jsonpath.query(path, data as JSONValue);\n\t\t\treturn !results.empty();\n\t\t} catch {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t/**\n\t * Extract the first value from a JSONPath query.\n\t * @param path The JSONPath query string.\n\t * @param data The data to query.\n\t * @returns The first matched value, or undefined if no matches.\n\t * @throws GeneralError if the path is invalid or data cannot be queried.\n\t */\n\tpublic static extractSingle(path: string, data: unknown): unknown {\n\t\tGuards.stringValue(JsonPathHelper.CLASS_NAME, nameof(path), path);\n\n\t\ttry {\n\t\t\tconst node = jsonpath.match(path, data as JSONValue);\n\t\t\treturn node?.value;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tJsonPathHelper.CLASS_NAME,\n\t\t\t\t\"extractSingleFailed\",\n\t\t\t\t{\n\t\t\t\t\tpath\n\t\t\t\t},\n\t\t\t\tBaseError.fromError(error)\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Extract all values from a JSONPath query.\n\t * @param path The JSONPath query string.\n\t * @param data The data to query.\n\t * @returns Array of all matched values.\n\t * @throws GeneralError if the path is invalid or data cannot be queried.\n\t */\n\tpublic static extractAll(path: string, data: unknown): unknown[] {\n\t\tGuards.stringValue(JsonPathHelper.CLASS_NAME, nameof(path), path);\n\n\t\ttry {\n\t\t\tconst results = jsonpath.query(path, data as JSONValue);\n\t\t\treturn results.values();\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tJsonPathHelper.CLASS_NAME,\n\t\t\t\t\"extractAllFailed\",\n\t\t\t\t{\n\t\t\t\t\tpath\n\t\t\t\t},\n\t\t\t\tBaseError.fromError(error)\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Validate if a JSONPath query is valid.\n\t * @param path The JSONPath query string to validate.\n\t * @returns True if the syntax is valid.\n\t * @throws GeneralError if the path is invalid or data cannot be queried.\n\t */\n\tpublic static validate(path: string): boolean {\n\t\tif (!Is.stringValue(path)) {\n\t\t\treturn false;\n\t\t}\n\n\t\ttry {\n\t\t\t// Query with empty object to test syntax\n\t\t\tjsonpath.query(path, {});\n\t\t\treturn true;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tJsonPathHelper.CLASS_NAME,\n\t\t\t\t\"validateFailed\",\n\t\t\t\t{\n\t\t\t\t\tpath\n\t\t\t\t},\n\t\t\t\tBaseError.fromError(error)\n\t\t\t);\n\t\t}\n\t}\n}\n"]}
+{"version":3,"file":"jsonPathHelper.js","sourceRoot":"","sources":["../../src/jsonPathHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAErE,OAAO,EAAE,QAAQ,EAAkB,MAAM,SAAS,CAAC;AAInD;;;GAGG;AACH,MAAM,OAAO,cAAc;IAC1B;;OAEG;IACI,MAAM,CAAU,UAAU,oBAAoC;IAErE;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,IAAY,EAAE,IAAa;QAC9C,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAElE,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAiB,CAAC,CAAC;YACxD,uDAAuD;YACvD,MAAM,WAAW,GAAsB,EAAE,CAAC;YAC1C,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;gBAC5B,WAAW,CAAC,IAAI,CAAC;oBAChB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;iBACzC,CAAC,CAAC;YACJ,CAAC;YACD,OAAO,WAAW,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,cAAc,CAAC,UAAU,EACzB,OAAO,EACP;gBACC,IAAI;aACJ,EACD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAC1B,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,IAAa;QAC/C,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAElE,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAiB,CAAC,CAAC;YACxD,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACzB,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,IAAY,EAAE,IAAa;QACtD,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAElE,IAAI,CAAC;YACJ,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAiB,CAAC,CAAC;YACrD,OAAO,IAAI,EAAE,KAAK,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,cAAc,CAAC,UAAU,EACzB,qBAAqB,EACrB;gBACC,IAAI;aACJ,EACD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAC1B,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,IAAY,EAAE,IAAa;QACnD,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAElE,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAiB,CAAC,CAAC;YACxD,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,cAAc,CAAC,UAAU,EACzB,kBAAkB,EAClB;gBACC,IAAI;aACJ,EACD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAC1B,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAY;QAClC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACd,CAAC;QAED,IAAI,CAAC;YACJ,yCAAyC;YACzC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,cAAc,CAAC,UAAU,EACzB,gBAAgB,EAChB;gBACC,IAAI;aACJ,EACD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAC1B,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,IAAa,EAAE,QAA2B,EAAE,KAAc;QACrF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvD,OAAO;QACR,CAAC;QAED,IAAI,OAAO,GAAY,IAAI,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAElC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/C,OAAO;YACR,CAAC;YAED,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtB,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;oBACxB,OAAO;gBACR,CAAC;gBACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;gBAChC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACjD,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjD,CAAC;gBACD,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;oBACzB,OAAO;gBACR,CAAC;gBACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;gBAChC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACjD,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjD,CAAC;gBACD,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;QACF,CAAC;QAED,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAChD,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/C,OAAO;QACR,CAAC;QACD,IAAI,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;gBACxB,OAAO;YACR,CAAC;YACD,OAAO,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;QAC5B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBACzB,OAAO;YACR,CAAC;YACD,OAAO,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;QAC5B,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAa,EAAE,QAA2B;QACxE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvD,OAAO;QACR,CAAC;QAED,IAAI,OAAO,GAAY,IAAI,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC1B,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/C,OAAO;YACR,CAAC;YAED,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtB,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;oBACxB,OAAO;gBACR,CAAC;gBACD,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;oBACzB,OAAO;gBACR,CAAC;gBACD,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;QACF,CAAC;QAED,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/C,OAAO;QACR,CAAC;QAED,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAChD,IAAI,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;gBACxB,OAAO;YACR,CAAC;YACD,OAAO,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;QAChC,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBACzB,OAAO;YACR,CAAC;YACD,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3B,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseError, GeneralError, Guards, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { jsonpath, type JSONValue } from \"json-p3\";\nimport type { IJsonPathLocation } from \"./models/IJsonPathLocation.js\";\nimport type { IJsonPathResult } from \"./models/IJsonPathResult.js\";\n\n/**\n * Helper class for JSONPath operations.\n * Provides abstraction over the json-p3 library.\n */\nexport class JsonPathHelper {\n\t/**\n\t * The name of the class name of the JsonPathHelper class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<JsonPathHelper>();\n\n\t/**\n\t * Execute a JSONPath query and return results with values and locations.\n\t * @param path The JSONPath query string (e.g., \"$.store.book[*].title\").\n\t * @param data The data to query.\n\t * @returns Array of results containing values and their locations.\n\t * @throws GeneralError if the path is invalid or data cannot be queried.\n\t */\n\tpublic static query(path: string, data: unknown): IJsonPathResult[] {\n\t\tGuards.stringValue(JsonPathHelper.CLASS_NAME, nameof(path), path);\n\n\t\ttry {\n\t\t\tconst results = jsonpath.query(path, data as JSONValue);\n\t\t\t// Convert JSONPathNodeList to array of IJsonPathResult\n\t\t\tconst resultArray: IJsonPathResult[] = [];\n\t\t\tfor (const node of results) {\n\t\t\t\tresultArray.push({\n\t\t\t\t\tvalue: node.value,\n\t\t\t\t\tlocation: node.location,\n\t\t\t\t\tpath: node.getPath({ form: \"canonical\" })\n\t\t\t\t});\n\t\t\t}\n\t\t\treturn resultArray;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tJsonPathHelper.CLASS_NAME,\n\t\t\t\t\"query\",\n\t\t\t\t{\n\t\t\t\t\tpath\n\t\t\t\t},\n\t\t\t\tBaseError.fromError(error)\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Check if a JSONPath exists in the data.\n\t * @param path The JSONPath query string.\n\t * @param data The data to check.\n\t * @returns True if the path exists and returns at least one result.\n\t */\n\tpublic static exists(path: string, data: unknown): boolean {\n\t\tGuards.stringValue(JsonPathHelper.CLASS_NAME, nameof(path), path);\n\n\t\ttry {\n\t\t\tconst results = jsonpath.query(path, data as JSONValue);\n\t\t\treturn !results.empty();\n\t\t} catch {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t/**\n\t * Extract the first value from a JSONPath query.\n\t * @param path The JSONPath query string.\n\t * @param data The data to query.\n\t * @returns The first matched value, or undefined if no matches.\n\t * @throws GeneralError if the path is invalid or data cannot be queried.\n\t */\n\tpublic static extractSingle(path: string, data: unknown): unknown {\n\t\tGuards.stringValue(JsonPathHelper.CLASS_NAME, nameof(path), path);\n\n\t\ttry {\n\t\t\tconst node = jsonpath.match(path, data as JSONValue);\n\t\t\treturn node?.value;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tJsonPathHelper.CLASS_NAME,\n\t\t\t\t\"extractSingleFailed\",\n\t\t\t\t{\n\t\t\t\t\tpath\n\t\t\t\t},\n\t\t\t\tBaseError.fromError(error)\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Extract all values from a JSONPath query.\n\t * @param path The JSONPath query string.\n\t * @param data The data to query.\n\t * @returns Array of all matched values.\n\t * @throws GeneralError if the path is invalid or data cannot be queried.\n\t */\n\tpublic static extractAll(path: string, data: unknown): unknown[] {\n\t\tGuards.stringValue(JsonPathHelper.CLASS_NAME, nameof(path), path);\n\n\t\ttry {\n\t\t\tconst results = jsonpath.query(path, data as JSONValue);\n\t\t\treturn results.values();\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tJsonPathHelper.CLASS_NAME,\n\t\t\t\t\"extractAllFailed\",\n\t\t\t\t{\n\t\t\t\t\tpath\n\t\t\t\t},\n\t\t\t\tBaseError.fromError(error)\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Validate if a JSONPath query is valid.\n\t * @param path The JSONPath query string to validate.\n\t * @returns True if the syntax is valid.\n\t * @throws GeneralError if the path is invalid or data cannot be queried.\n\t */\n\tpublic static validate(path: string): boolean {\n\t\tif (!Is.stringValue(path)) {\n\t\t\treturn false;\n\t\t}\n\n\t\ttry {\n\t\t\t// Query with empty object to test syntax\n\t\t\tjsonpath.query(path, {});\n\t\t\treturn true;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tJsonPathHelper.CLASS_NAME,\n\t\t\t\t\"validateFailed\",\n\t\t\t\t{\n\t\t\t\t\tpath\n\t\t\t\t},\n\t\t\t\tBaseError.fromError(error)\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Set a value on the target object using a JSONPath location.\n\t * @param root The target root object.\n\t * @param location The JSONPath location tokens.\n\t * @param value The value to set.\n\t */\n\tpublic static setAtLocation(root: unknown, location: IJsonPathLocation, value: unknown): void {\n\t\tif (!Is.arrayValue(location) || location.length === 0) {\n\t\t\treturn;\n\t\t}\n\n\t\tlet current: unknown = root;\n\t\tfor (let i = 0; i < location.length - 1; i++) {\n\t\t\tconst token = location[i];\n\t\t\tconst nextToken = location[i + 1];\n\n\t\t\tif (!Is.array(current) && !Is.object(current)) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tif (Is.number(token)) {\n\t\t\t\tif (!Is.array(current)) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tconst existing = current[token];\n\t\t\t\tif (!Is.array(existing) && !Is.object(existing)) {\n\t\t\t\t\tcurrent[token] = Is.number(nextToken) ? [] : {};\n\t\t\t\t}\n\t\t\t\tcurrent = current[token];\n\t\t\t} else {\n\t\t\t\tif (!Is.object(current)) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tconst existing = current[token];\n\t\t\t\tif (!Is.array(existing) && !Is.object(existing)) {\n\t\t\t\t\tcurrent[token] = Is.number(nextToken) ? [] : {};\n\t\t\t\t}\n\t\t\t\tcurrent = current[token];\n\t\t\t}\n\t\t}\n\n\t\tconst lastToken = location[location.length - 1];\n\t\tif (!Is.array(current) && !Is.object(current)) {\n\t\t\treturn;\n\t\t}\n\t\tif (Is.number(lastToken)) {\n\t\t\tif (!Is.array(current)) {\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tcurrent[lastToken] = value;\n\t\t} else {\n\t\t\tif (!Is.object(current)) {\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tcurrent[lastToken] = value;\n\t\t}\n\t}\n\n\t/**\n\t * Delete a value on the target object using a JSONPath location.\n\t * @param root The target root object.\n\t * @param location The JSONPath location tokens.\n\t */\n\tpublic static deleteAtLocation(root: unknown, location: IJsonPathLocation): void {\n\t\tif (!Is.arrayValue(location) || location.length === 0) {\n\t\t\treturn;\n\t\t}\n\n\t\tlet current: unknown = root;\n\t\tfor (let i = 0; i < location.length - 1; i++) {\n\t\t\tconst token = location[i];\n\t\t\tif (!Is.array(current) && !Is.object(current)) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tif (Is.number(token)) {\n\t\t\t\tif (!Is.array(current)) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tcurrent = current[token];\n\t\t\t} else {\n\t\t\t\tif (!Is.object(current)) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tcurrent = current[token];\n\t\t\t}\n\t\t}\n\n\t\tif (!Is.array(current) && !Is.object(current)) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst lastToken = location[location.length - 1];\n\t\tif (Is.number(lastToken)) {\n\t\t\tif (!Is.array(current)) {\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tcurrent[lastToken] = undefined;\n\t\t} else {\n\t\t\tif (!Is.object(current)) {\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tdelete current[lastToken];\n\t\t}\n\t}\n}\n"]}

package/dist/es/models/IJsonPathLocation.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IJsonPathLocation.js.map

package/dist/es/models/IJsonPathLocation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IJsonPathLocation.js","sourceRoot":"","sources":["../../../src/models/IJsonPathLocation.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Result paths from a JSONPath query operation.\n */\nexport type IJsonPathLocation = (string | number)[];\n"]}

package/dist/es/models/IJsonPathResult.js

@@ -1,4 +1,2 @@
-// Copyright 2025 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
 export {};
 //# sourceMappingURL=IJsonPathResult.js.map

package/dist/es/models/IJsonPathResult.js.map

@@ -1 +1 @@
-{"version":3,"file":"IJsonPathResult.js","sourceRoot":"","sources":["../../../src/models/IJsonPathResult.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Result from a JSONPath query operation.\n */\nexport interface IJsonPathResult {\n\t/**\n\t * The value at the matched path.\n\t */\n\tvalue: unknown;\n\n\t/**\n\t * The location path to the value.\n\t */\n\tlocation: (string | number)[];\n\n\t/**\n\t * The location path as a string for debugging.\n\t */\n\tpath: string;\n}\n"]}
+{"version":3,"file":"IJsonPathResult.js","sourceRoot":"","sources":["../../../src/models/IJsonPathResult.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonPathLocation } from \"./IJsonPathLocation.js\";\n\n/**\n * Result from a JSONPath query operation.\n */\nexport interface IJsonPathResult {\n\t/**\n\t * The value at the matched path.\n\t */\n\tvalue: unknown;\n\n\t/**\n\t * The location path to the value.\n\t */\n\tlocation: IJsonPathLocation;\n\n\t/**\n\t * The location path as a string for debugging.\n\t */\n\tpath: string;\n}\n"]}

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./jsonPathHelper.js";
+export * from "./models/IJsonPathLocation.js";
 export * from "./models/IJsonPathResult.js";

package/dist/types/jsonPathHelper.d.ts

@@ -1,3 +1,4 @@
+import type { IJsonPathLocation } from "./models/IJsonPathLocation.js";
 import type { IJsonPathResult } from "./models/IJsonPathResult.js";
 /**
  * Helper class for JSONPath operations.
@@ -46,4 +47,17 @@ export declare class JsonPathHelper {
      * @throws GeneralError if the path is invalid or data cannot be queried.
      */
     static validate(path: string): boolean;
+    /**
+     * Set a value on the target object using a JSONPath location.
+     * @param root The target root object.
+     * @param location The JSONPath location tokens.
+     * @param value The value to set.
+     */
+    static setAtLocation(root: unknown, location: IJsonPathLocation, value: unknown): void;
+    /**
+     * Delete a value on the target object using a JSONPath location.
+     * @param root The target root object.
+     * @param location The JSONPath location tokens.
+     */
+    static deleteAtLocation(root: unknown, location: IJsonPathLocation): void;
 }

package/dist/types/models/IJsonPathLocation.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Result paths from a JSONPath query operation.
+ */
+export type IJsonPathLocation = (string | number)[];

package/dist/types/models/IJsonPathResult.d.ts

@@ -1,3 +1,4 @@
+import type { IJsonPathLocation } from "./IJsonPathLocation.js";
 /**
  * Result from a JSONPath query operation.
  */
@@ -9,7 +10,7 @@ export interface IJsonPathResult {
     /**
      * The location path to the value.
      */
-    location: (string | number)[];
+    location: IJsonPathLocation;
     /**
      * The location path as a string for debugging.
      */

package/docs/changelog.md

@@ -1,21 +1,154 @@
-# @twin.org/data-json-path - Changelog
+# Changelog
 
-## [0.0.3-next.2](https://github.com/twinfoundation/data/compare/data-json-path-v0.0.3-next.1...data-json-path-v0.0.3-next.2) (2025-11-24)
+## [0.0.3-next.21](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.20...data-json-path-v0.0.3-next.21) (2026-05-11)
+
+
+### Features
+
+* typescript 6 update ([44cbfe8](https://github.com/iotaledger/twin-data/commit/44cbfe87256282b9928134b2bbed1d3c6ee15acb))
+
+## [0.0.3-next.20](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.19...data-json-path-v0.0.3-next.20) (2026-03-24)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.19](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.18...data-json-path-v0.0.3-next.19) (2026-03-20)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.18](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.17...data-json-path-v0.0.3-next.18) (2026-03-16)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.17](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.16...data-json-path-v0.0.3-next.17) (2026-03-12)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.16](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.15...data-json-path-v0.0.3-next.16) (2026-03-06)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.15](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.14...data-json-path-v0.0.3-next.15) (2026-02-27)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.14](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.13...data-json-path-v0.0.3-next.14) (2026-02-25)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.13](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.12...data-json-path-v0.0.3-next.13) (2026-02-25)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.12](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.11...data-json-path-v0.0.3-next.12) (2026-02-25)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.11](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.10...data-json-path-v0.0.3-next.11) (2026-02-25)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.10](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.9...data-json-path-v0.0.3-next.10) (2026-02-24)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.9](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.8...data-json-path-v0.0.3-next.9) (2026-02-23)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.8](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.7...data-json-path-v0.0.3-next.8) (2026-02-02)
+
+
+### Features
+
+* add json path set and delete methods ([#39](https://github.com/iotaledger/twin-data/issues/39)) ([04b73f3](https://github.com/iotaledger/twin-data/commit/04b73f3d44525f7d3a5d01b56530ff8d9c7bd938))
+
+## [0.0.3-next.7](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.6...data-json-path-v0.0.3-next.7) (2026-01-21)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.6](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.5...data-json-path-v0.0.3-next.6) (2026-01-14)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.5](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.4...data-json-path-v0.0.3-next.5) (2026-01-14)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.4](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.3...data-json-path-v0.0.3-next.4) (2026-01-06)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.3](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.2...data-json-path-v0.0.3-next.3) (2026-01-05)
+
+
+### Miscellaneous Chores
+
+* **data-json-path:** Synchronize repo versions
+
+## [0.0.3-next.2](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.1...data-json-path-v0.0.3-next.2) (2025-11-24)
 
 
 ### Bug Fixes
 
-* extraneous type ([0b5d5c6](https://github.com/twinfoundation/data/commit/0b5d5c6980a07018e6f6bedfae4b3bf55c5de8dc))
+* extraneous type ([0b5d5c6](https://github.com/iotaledger/twin-data/commit/0b5d5c6980a07018e6f6bedfae4b3bf55c5de8dc))
 
-## [0.0.3-next.1](https://github.com/twinfoundation/data/compare/data-json-path-v0.0.3-next.0...data-json-path-v0.0.3-next.1) (2025-11-10)
+## [0.0.3-next.1](https://github.com/iotaledger/twin-data/compare/data-json-path-v0.0.3-next.0...data-json-path-v0.0.3-next.1) (2025-11-10)
 
 
 ### Features
 
-* add context id features ([#25](https://github.com/twinfoundation/data/issues/25)) ([6592f2e](https://github.com/twinfoundation/data/commit/6592f2e4e59021cc42a079a4f46242758a54313d))
-* json path handler ([#24](https://github.com/twinfoundation/data/issues/24)) ([467a0a7](https://github.com/twinfoundation/data/commit/467a0a7e5b7b93d4242ab0f27d042a566bfa6b68))
+* add context id features ([#25](https://github.com/iotaledger/twin-data/issues/25)) ([6592f2e](https://github.com/iotaledger/twin-data/commit/6592f2e4e59021cc42a079a4f46242758a54313d))
+* json path handler ([#24](https://github.com/iotaledger/twin-data/issues/24)) ([467a0a7](https://github.com/iotaledger/twin-data/commit/467a0a7e5b7b93d4242ab0f27d042a566bfa6b68))
 
-## [0.0.2-next.4](https://github.com/twinfoundation/data-processing/compare/data-json-path-v0.0.2-next.3...data-json-path-v0.0.2-next.4) (2025-11-06)
+## [0.0.2-next.4](https://github.com/iotaledger/twin-data-processing/compare/data-json-path-v0.0.2-next.3...data-json-path-v0.0.2-next.4) (2025-11-06)
 
 
 ### Features

package/docs/examples.md

@@ -1 +1,60 @@
-# @twin.org/data-json-path - Examples
+# Data Json Path Examples
+
+These snippets cover common query and update workflows for nested JSON structures.
+
+## JsonPathHelper
+
+```typescript
+import { JsonPathHelper } from '@twin.org/data-json-path';
+
+const sample = {
+  store: {
+    book: [
+      { title: 'The Left Hand of Darkness', price: 8.99 },
+      { title: 'A Wizard of Earthsea', price: 6.5 }
+    ]
+  }
+};
+
+const queryResults = JsonPathHelper.query('$.store.book[*].title', sample);
+console.log('Query result count:', queryResults.length);
+
+console.log('Path exists:', JsonPathHelper.exists('$.store.book[0].price', sample));
+console.log('Single value:', JsonPathHelper.extractSingle('$.store.book[0].title', sample));
+console.log('All prices:', JsonPathHelper.extractAll('$.store.book[*].price', sample));
+console.log('Path is valid:', JsonPathHelper.validate('$.store.book[*].title'));
+```
+
+```typescript
+import { JsonPathHelper } from '@twin.org/data-json-path';
+
+const profile = {
+  user: {
+    name: 'Ada',
+    contact: {
+      email: 'ada@example.org'
+    }
+  }
+};
+
+const emailNode = JsonPathHelper.query('$.user.contact.email', profile)[0];
+JsonPathHelper.setAtLocation(profile, emailNode.location, 'ada.lovelace@example.org');
+
+console.log('Updated email:', profile.user.contact.email);
+```
+
+```typescript
+import { JsonPathHelper } from '@twin.org/data-json-path';
+
+const payload = {
+  user: {
+    id: 'u-100',
+    sessionToken: 'token-abc'
+  }
+};
+
+const tokenNode = JsonPathHelper.query('$.user.sessionToken', payload)[0];
+JsonPathHelper.deleteAtLocation(payload, tokenNode.location);
+
+console.log('Token removed:', !('sessionToken' in payload.user));
+```

package/docs/reference/classes/JsonPathHelper.md

@@ -15,7 +15,7 @@ Provides abstraction over the json-p3 library.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -23,7 +23,7 @@ The name of the class name of the JsonPathHelper class.
 
 ## Methods
 
-### query()
+### query() {#query}
 
 > `static` **query**(`path`, `data`): [`IJsonPathResult`](../interfaces/IJsonPathResult.md)[]
 
@@ -55,7 +55,7 @@ GeneralError if the path is invalid or data cannot be queried.
 
 ***
 
-### exists()
+### exists() {#exists}
 
 > `static` **exists**(`path`, `data`): `boolean`
 
@@ -83,7 +83,7 @@ True if the path exists and returns at least one result.
 
 ***
 
-### extractSingle()
+### extractSingle() {#extractsingle}
 
 > `static` **extractSingle**(`path`, `data`): `unknown`
 
@@ -115,7 +115,7 @@ GeneralError if the path is invalid or data cannot be queried.
 
 ***
 
-### extractAll()
+### extractAll() {#extractall}
 
 > `static` **extractAll**(`path`, `data`): `unknown`[]
 
@@ -147,7 +147,7 @@ GeneralError if the path is invalid or data cannot be queried.
 
 ***
 
-### validate()
+### validate() {#validate}
 
 > `static` **validate**(`path`): `boolean`
 
@@ -170,3 +170,61 @@ True if the syntax is valid.
 #### Throws
 
 GeneralError if the path is invalid or data cannot be queried.
+
+***
+
+### setAtLocation() {#setatlocation}
+
+> `static` **setAtLocation**(`root`, `location`, `value`): `void`
+
+Set a value on the target object using a JSONPath location.
+
+#### Parameters
+
+##### root
+
+`unknown`
+
+The target root object.
+
+##### location
+
+[`IJsonPathLocation`](../type-aliases/IJsonPathLocation.md)
+
+The JSONPath location tokens.
+
+##### value
+
+`unknown`
+
+The value to set.
+
+#### Returns
+
+`void`
+
+***
+
+### deleteAtLocation() {#deleteatlocation}
+
+> `static` **deleteAtLocation**(`root`, `location`): `void`
+
+Delete a value on the target object using a JSONPath location.
+
+#### Parameters
+
+##### root
+
+`unknown`
+
+The target root object.
+
+##### location
+
+[`IJsonPathLocation`](../type-aliases/IJsonPathLocation.md)
+
+The JSONPath location tokens.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -7,3 +7,7 @@
 ## Interfaces
 
 - [IJsonPathResult](interfaces/IJsonPathResult.md)
+
+## Type Aliases
+
+- [IJsonPathLocation](type-aliases/IJsonPathLocation.md)

package/docs/reference/interfaces/IJsonPathResult.md

@@ -4,7 +4,7 @@ Result from a JSONPath query operation.
 
 ## Properties
 
-### value
+### value {#value}
 
 > **value**: `unknown`
 
@@ -12,15 +12,15 @@ The value at the matched path.
 
 ***
 
-### location
+### location {#location}
 
-> **location**: (`string` \| `number`)[]
+> **location**: [`IJsonPathLocation`](../type-aliases/IJsonPathLocation.md)
 
 The location path to the value.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 

package/docs/reference/type-aliases/IJsonPathLocation.md

@@ -0,0 +1,5 @@
+# Type Alias: IJsonPathLocation
+
+> **IJsonPathLocation** = (`string` \| `number`)[]
+
+Result paths from a JSONPath query operation.

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/data-json-path",
-	"version": "0.0.3-next.2",
-	"description": "JSONPath abstraction layer for TWIN platform",
+	"version": "0.0.3-next.21",
+	"description": "A consistent JSONPath query abstraction.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/data.git",
+		"url": "git+https://github.com/iotaledger/data.git",
 		"directory": "packages/data-json-path"
 	},
 	"contributors": [
@@ -50,7 +50,7 @@
 		"conversion"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/data/issues"
+		"url": "git+https://github.com/iotaledger/data/issues"
 	},
 	"homepage": "https://twindev.org"
 }