@twin.org/entity-storage-rest-client 0.0.3-next.6 → 0.0.3-next.7

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Entity Storage REST Client
+# Entity Storage REST Client
 
-Entity Storage contract implementation which can connect to REST endpoints.
+This package provides a client layer for calling storage service endpoints through a consistent REST interface. It is designed to work with the wider storage ecosystem so applications can keep behaviour consistent across connectors and environments.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,18 @@
-# @twin.org/entity-storage-rest-client - Changelog
+# Changelog
+
+## [0.0.3-next.7](https://github.com/twinfoundation/entity-storage/compare/entity-storage-rest-client-v0.0.3-next.6...entity-storage-rest-client-v0.0.3-next.7) (2026-03-13)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
 
 ## [0.0.3-next.6](https://github.com/twinfoundation/entity-storage/compare/entity-storage-rest-client-v0.0.3-next.5...entity-storage-rest-client-v0.0.3-next.6) (2026-01-21)
 

package/docs/examples.md

@@ -1 +1,60 @@
-# @twin.org/entity-storage-rest-client - Examples
+# Entity Storage REST Client Examples
+
+These snippets show how to call the REST endpoints with typed payloads and how to shape filtered list requests.
+
+## EntityStorageRestClient
+
+```typescript
+import { EntityStorageRestClient } from '@twin.org/entity-storage-rest-client';
+import {
+  ComparisonOperator,
+  LogicalOperator,
+  SortDirection,
+  type EntityCondition
+} from '@twin.org/entity';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+const client = new EntityStorageRestClient<Profile>({
+  endpoint: 'http://localhost:8080'
+});
+
+const className = client.className();
+
+await client.set({
+  id: 'profile-1',
+  email: 'ada@example.com',
+  status: 'active',
+  createdAt: '2026-03-09T10:30:00.000Z'
+});
+
+const byPrimaryKey = await client.get('profile-1');
+const bySecondaryIndex = await client.get('ada@example.com', 'email');
+
+const activeCondition: EntityCondition<Profile> = {
+  logicalOperator: LogicalOperator.And,
+  conditions: [
+    {
+      property: 'status',
+      comparison: ComparisonOperator.Equals,
+      value: 'active'
+    }
+  ]
+};
+
+const result = await client.query(
+  activeCondition,
+  'createdAt',
+  SortDirection.Descending,
+  ['id', 'email', 'status'],
+  undefined,
+  25
+);
+
+await client.remove('profile-1');
+```

package/docs/reference/classes/EntityStorageRestClient.md

@@ -42,7 +42,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -50,7 +50,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -68,7 +68,7 @@ The class name of the component.
 
 ***
 
-### set()
+### set() {#set}
 
 > **set**(`entity`): `Promise`\<`void`\>
 
@@ -94,7 +94,7 @@ The id of the entity.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`, `secondaryIndex?`): `Promise`\<`T` \| `undefined`\>
 
@@ -126,7 +126,7 @@ The object if it can be found or undefined.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`id`): `Promise`\<`void`\>
 
@@ -152,7 +152,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/entity-storage-rest-client",
-	"version": "0.0.3-next.6",
-	"description": "Entity Storage contract implementation which can connect to REST endpoints",
+	"version": "0.0.3-next.7",
+	"description": "REST client for calling storage services from applications and tools.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/entity-storage.git",
@@ -18,7 +18,7 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.3-next.6",
+		"@twin.org/entity-storage-models": "0.0.3-next.7",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},