@twin.org/data-json-path 0.0.3-next.16 → 0.0.3-next.18

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/docs/changelog.md

@@ -1,4 +1,18 @@
-# @twin.org/data-json-path - Changelog
+# Changelog
+
+## [0.0.3-next.18](https://github.com/twinfoundation/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/twinfoundation/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/twinfoundation/data/compare/data-json-path-v0.0.3-next.15...data-json-path-v0.0.3-next.16) (2026-03-06)
 

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`
 
@@ -173,7 +173,7 @@ GeneralError if the path is invalid or data cannot be queried.
 
 ***
 
-### setAtLocation()
+### setAtLocation() {#setatlocation}
 
 > `static` **setAtLocation**(`root`, `location`, `value`): `void`
 
@@ -205,7 +205,7 @@ The value to set.
 
 ***
 
-### deleteAtLocation()
+### deleteAtLocation() {#deleteatlocation}
 
 > `static` **deleteAtLocation**(`root`, `location`): `void`
 

package/docs/reference/interfaces/IJsonPathResult.md

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

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/data-json-path",
-	"version": "0.0.3-next.16",
-	"description": "JSONPath abstraction layer for TWIN platform",
+	"version": "0.0.3-next.18",
+	"description": "A consistent JSONPath query abstraction.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/data.git",