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

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,11 @@
-# @twin.org/data-json-path - Changelog
+# Changelog
+
+## [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/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.17",
+	"description": "A consistent JSONPath query abstraction.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/data.git",