@twin.org/entity-storage-service 0.0.3-next.6 → 0.0.3-next.8

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Entity Storage Service
+# Entity Storage Service
 
-Entity Storage contract implementation and REST endpoint definitions.
+This package defines the service-facing contracts and REST endpoint definitions used to expose storage behaviour consistently. 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,36 @@
-# @twin.org/entity-storage-service - Changelog
+# Changelog
+
+## [0.0.3-next.8](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.3-next.7...entity-storage-service-v0.0.3-next.8) (2026-03-20)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.3-next.7 to 0.0.3-next.8
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.7 to 0.0.3-next.8
+
+## [0.0.3-next.7](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.3-next.6...entity-storage-service-v0.0.3-next.7) (2026-03-13)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-service:** 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
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory 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-service-v0.0.3-next.5...entity-storage-service-v0.0.3-next.6) (2026-01-21)
 

package/docs/examples.md

@@ -1 +1,77 @@
-# @twin.org/entity-storage-service - Examples
+# Entity Storage Service Examples
+
+Use these snippets to wire a registered connector into the service layer and to expose matching REST routes.
+
+## EntityStorageService
+
+```typescript
+import {
+  EntityStorageService,
+  generateRestRoutesEntityStorage
+} from '@twin.org/entity-storage-service';
+import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
+import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
+import {
+  ComparisonOperator,
+  LogicalOperator,
+  SortDirection,
+  type EntityCondition
+} from '@twin.org/entity';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+EntityStorageConnectorFactory.register(
+  'profile-storage',
+  () =>
+    new MemoryEntityStorageConnector<Profile>({
+      entitySchema: 'Profile'
+    })
+);
+
+const service = new EntityStorageService<Profile>({
+  entityStorageType: 'profile-storage'
+});
+
+const className = service.className();
+
+await service.set({
+  id: 'profile-1',
+  email: 'ada@example.com',
+  status: 'active',
+  createdAt: '2026-03-09T10:30:00.000Z'
+});
+
+const byPrimaryKey = await service.get('profile-1');
+const bySecondaryIndex = await service.get('ada@example.com', 'email');
+
+const activeCondition: EntityCondition<Profile> = {
+  logicalOperator: LogicalOperator.And,
+  conditions: [
+    {
+      property: 'status',
+      comparison: ComparisonOperator.Equals,
+      value: 'active'
+    }
+  ]
+};
+
+const result = await service.query(
+  activeCondition,
+  'createdAt',
+  SortDirection.Descending,
+  ['id', 'email', 'status'],
+  undefined,
+  25
+);
+
+await service.remove('profile-1');
+
+const routes = generateRestRoutesEntityStorage('/profiles', 'profileStorageComponent', {
+  typeName: 'Profile'
+});
+```

package/docs/open-api/spec.json

@@ -529,13 +529,13 @@
 				"required": [
 					"entities"
 				],
-				"additionalProperties": false,
 				"description": "The list of entries from the query."
 			},
 			"EntityStorageSetRequest": {
 				"description": "The data to be used in the entity."
 			},
 			"Error": {
+				"description": "Model to describe serialized error.",
 				"type": "object",
 				"properties": {
 					"name": {
@@ -566,63 +566,35 @@
 				"required": [
 					"name",
 					"message"
-				],
-				"additionalProperties": false,
-				"description": "Model to describe serialized error."
+				]
 			},
 			"NotFoundResponse": {
 				"type": "object",
-				"additionalProperties": false,
 				"properties": {
 					"notFoundId": {
 						"type": "string",
 						"description": "The id if the item that was not found."
-					},
-					"name": {
-						"type": "string",
-						"description": "The name for the error."
-					},
-					"message": {
-						"type": "string",
-						"description": "The message for the error."
-					},
-					"source": {
-						"type": "string",
-						"description": "The source of the error."
-					},
-					"properties": {
-						"type": "object",
-						"additionalProperties": {},
-						"description": "Any additional information for the error."
-					},
-					"stack": {
-						"type": "string",
-						"description": "The stack trace for the error."
-					},
-					"cause": {
-						"$ref": "#/components/schemas/Error"
 					}
 				},
-				"required": [
-					"message",
-					"name"
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Error"
+					}
 				],
 				"description": "The body which contains the error."
 			},
 			"SortDirection": {
+				"description": "The sort directions.",
 				"anyOf": [
 					{
-						"type": "string",
 						"const": "asc",
 						"description": "Ascending."
 					},
 					{
-						"type": "string",
 						"const": "desc",
 						"description": "Descending."
 					}
-				],
-				"description": "The sort directions."
+				]
 			}
 		},
 		"securitySchemes": {

package/docs/reference/classes/EntityStorageService.md

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

package/docs/reference/interfaces/IEntityStorageRoutesExamples.md

@@ -4,9 +4,9 @@ Examples for the entity storage routes.
 
 ## Properties
 
-### set?
+### set? {#set}
 
-> `optional` **set**: `object`
+> `optional` **set?**: `object`
 
 Examples for the set route.
 
@@ -16,9 +16,9 @@ Examples for the set route.
 
 ***
 
-### get?
+### get? {#get}
 
-> `optional` **get**: `object`
+> `optional` **get?**: `object`
 
 Examples for the get route.
 
@@ -32,9 +32,9 @@ Examples for the get route.
 
 ***
 
-### remove?
+### remove? {#remove}
 
-> `optional` **remove**: `object`
+> `optional` **remove?**: `object`
 
 Examples for the remove route.
 
@@ -44,9 +44,9 @@ Examples for the remove route.
 
 ***
 
-### list?
+### list? {#list}
 
-> `optional` **list**: `object`
+> `optional` **list?**: `object`
 
 Examples for the list route.
 

package/docs/reference/interfaces/IEntityStorageServiceConstructorOptions.md

@@ -4,7 +4,7 @@ Options for the Entity Storage Service constructor.
 
 ## Properties
 
-### entityStorageType
+### entityStorageType {#entitystoragetype}
 
 > **entityStorageType**: `string`
 
@@ -12,8 +12,8 @@ The type of the entity storage.
 
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: [`IEntityStorageServiceConfig`](IEntityStorageServiceConfig.md)
+> `optional` **config?**: [`IEntityStorageServiceConfig`](IEntityStorageServiceConfig.md)
 
 The configuration for the service.

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/entity-storage-service",
-	"version": "0.0.3-next.6",
-	"description": "Entity Storage contract implementation and REST endpoint definitions",
+	"version": "0.0.3-next.8",
+	"description": "Service layer exposing storage contracts and REST endpoint definitions.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/entity-storage.git",
@@ -17,7 +17,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.8",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},