@twin.org/entity-storage-models 0.0.3-next.5 → 0.0.3-next.7

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Entity Storage Models
+# Entity Storage Models
 
-Models which define the structure of the entity storage contracts and connectors.
+This package defines the shared domain models that standardise storage contracts, requests, responses and connector capabilities. 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-models - Changelog
+# Changelog
+
+## [0.0.3-next.7](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.3-next.6...entity-storage-models-v0.0.3-next.7) (2026-03-13)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.6](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.3-next.5...entity-storage-models-v0.0.3-next.6) (2026-01-21)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-models:** Synchronize repo versions
 
 ## [0.0.3-next.5](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.3-next.4...entity-storage-models-v0.0.3-next.5) (2026-01-06)
 

package/docs/examples.md

@@ -1 +1,87 @@
-# @twin.org/entity-storage-models - Examples
+# Entity Storage Models Examples
+
+These examples focus on wiring connectors through the shared factory and shaping typed API request and response contracts.
+
+## EntityStorageConnectorFactory
+
+```typescript
+import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
+import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+EntityStorageConnectorFactory.register(
+  'profile-storage',
+  () =>
+    new MemoryEntityStorageConnector<Profile>({
+      entitySchema: 'Profile'
+    })
+);
+
+const connector =
+  EntityStorageConnectorFactory.get<MemoryEntityStorageConnector<Profile>>('profile-storage');
+
+await connector.set({
+  id: 'profile-1',
+  email: 'ada@example.com',
+  status: 'active',
+  createdAt: '2026-03-09T10:30:00.000Z'
+});
+```
+
+```typescript
+import type {
+  IEntityStorageGetRequest,
+  IEntityStorageGetResponse,
+  IEntityStorageListRequest,
+  IEntityStorageListResponse,
+  IEntityStorageRemoveRequest,
+  IEntityStorageSetRequest
+} from '@twin.org/entity-storage-models';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+const setRequest: IEntityStorageSetRequest = {
+  body: {
+    id: 'profile-1',
+    email: 'ada@example.com',
+    status: 'active',
+    createdAt: '2026-03-09T10:30:00.000Z'
+  }
+};
+
+const getRequest: IEntityStorageGetRequest = {
+  pathParams: { id: 'profile-1' }
+};
+
+const listRequest: IEntityStorageListRequest = {
+  query: {
+    limit: '25'
+  }
+};
+
+const getResponse: IEntityStorageGetResponse = {
+  body: setRequest.body
+};
+
+const listResponse: IEntityStorageListResponse = {
+  body: {
+    entities: [setRequest.body],
+    cursor: 'next-page-token'
+  }
+};
+
+const removeRequest: IEntityStorageRemoveRequest = {
+  pathParams: { id: 'profile-1' }
+};
+```

package/docs/reference/interfaces/IEntityStorageComponent.md

@@ -14,7 +14,7 @@ Interface describing an entity storage component.
 
 ## Methods
 
-### set()
+### set() {#set}
 
 > **set**(`entity`): `Promise`\<`void`\>
 
@@ -36,7 +36,7 @@ The id of the entity.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`, `secondaryIndex?`): `Promise`\<`T` \| `undefined`\>
 
@@ -64,7 +64,7 @@ The object if it can be found or undefined.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`id`): `Promise`\<`void`\>
 
@@ -86,7 +86,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 

package/docs/reference/interfaces/IEntityStorageConnector.md

@@ -14,7 +14,7 @@ Interface describing an entity storage connector.
 
 ## Methods
 
-### getSchema()
+### getSchema() {#getschema}
 
 > **getSchema**(): `IEntitySchema`
 
@@ -28,7 +28,7 @@ The schema for the entities.
 
 ***
 
-### set()
+### set() {#set}
 
 > **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
@@ -56,7 +56,7 @@ The id of the entity.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
@@ -90,7 +90,7 @@ The object if it can be found or undefined.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
@@ -118,7 +118,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 

package/docs/reference/interfaces/IEntityStorageGetRequest.md

@@ -4,7 +4,7 @@ Get an entry from entity storage.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ The id of the entity to get.
 
 ***
 
-### query?
+### query? {#query}
 
 > `optional` **query**: `object`
 

package/docs/reference/interfaces/IEntityStorageGetResponse.md

@@ -4,7 +4,7 @@ Get an entry from entity storage.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `unknown`
 

package/docs/reference/interfaces/IEntityStorageListRequest.md

@@ -4,7 +4,7 @@ Query the entries from entity storage.
 
 ## Properties
 
-### query?
+### query? {#query}
 
 > `optional` **query**: `object`
 

package/docs/reference/interfaces/IEntityStorageListResponse.md

@@ -4,7 +4,7 @@ Response to getting the list of entries from a query.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IEntityStorageRemoveRequest.md

@@ -4,7 +4,7 @@ Remove an entry from entity storage.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IEntityStorageSetRequest.md

@@ -4,7 +4,7 @@ Set an entry in entity storage.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `unknown`
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/entity-storage-models",
-	"version": "0.0.3-next.5",
-	"description": "Models which define the structure of the entity storage contracts and connectors",
+	"version": "0.0.3-next.7",
+	"description": "Shared models for storage contracts, requests, responses and connector capabilities.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/entity-storage.git",