@twin.org/entity-storage-service 0.0.1-next.5

package/docs/reference/classes/EntityStorageService.md

@@ -0,0 +1,210 @@
+# Class: EntityStorageService\<T\>
+
+Class for performing entity service operations.
+
+## Type Parameters
+
+• **T** *extends* `object` = `any`
+
+## Implements
+
+- `IEntityStorageComponent`\<`T`\>
+
+## Constructors
+
+### new EntityStorageService()
+
+> **new EntityStorageService**\<`T`\>(`options`): [`EntityStorageService`](EntityStorageService.md)\<`T`\>
+
+Create a new instance of EntityStorageService.
+
+#### Parameters
+
+• **options**
+
+The dependencies for the entity storage service.
+
+• **options.entityStorageType**: `string`
+
+The entity storage type.
+
+• **options.config?**: [`IEntityStorageConfig`](../interfaces/IEntityStorageConfig.md)
+
+The configuration for the service.
+
+#### Returns
+
+[`EntityStorageService`](EntityStorageService.md)\<`T`\>
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IEntityStorageComponent.CLASS_NAME`
+
+## Methods
+
+### set()
+
+> **set**(`entity`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+
+Set an entity.
+
+#### Parameters
+
+• **entity**: `T`
+
+The entity to set.
+
+• **userIdentity?**: `string`
+
+The user identity to use with storage operations.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use with storage operations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+The id of the entity.
+
+#### Implementation of
+
+`IEntityStorageComponent.set`
+
+***
+
+### get()
+
+> **get**(`id`, `secondaryIndex`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`undefined` \| `T`\>
+
+Get an entity.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the entity to get, or the index value if secondaryIndex is set.
+
+• **secondaryIndex?**: keyof `T`
+
+Get the item using a secondary index.
+
+• **userIdentity?**: `string`
+
+The user identity to use with storage operations.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use with storage operations.
+
+#### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+The object if it can be found or undefined.
+
+#### Implementation of
+
+`IEntityStorageComponent.get`
+
+***
+
+### remove()
+
+> **remove**(`id`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+
+Remove the entity.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the entity to remove.
+
+• **userIdentity?**: `string`
+
+The user identity to use with storage operations.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use with storage operations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageComponent.remove`
+
+***
+
+### query()
+
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`object`\>
+
+Query all the entities which match the conditions.
+
+#### Parameters
+
+• **conditions?**: `EntityCondition`\<`T`\>
+
+The conditions to match for the entities.
+
+• **sortProperties?**: `object`[]
+
+The optional sort order.
+
+• **properties?**: keyof `T`[]
+
+The optional properties to return, defaults to all.
+
+• **cursor?**: `string`
+
+The cursor to request the next page of entities.
+
+• **pageSize?**: `number`
+
+The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+
+• **userIdentity?**: `string`
+
+The user identity to use with storage operations.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use with storage operations.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+##### entities
+
+> **entities**: `Partial`\<`T`\>[]
+
+The entities, which can be partial if a limited keys list was provided.
+
+##### cursor?
+
+> `optional` **cursor**: `string`
+
+An optional cursor, when defined can be used to call find to get more entities.
+
+#### Implementation of
+
+`IEntityStorageComponent.query`

package/docs/reference/functions/entityStorageGet.md

@@ -0,0 +1,25 @@
+# Function: entityStorageGet()
+
+> **entityStorageGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IEntityStorageGetResponse`\>
+
+Get the entry from entity storage.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `IEntityStorageGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IEntityStorageGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/entityStorageList.md

@@ -0,0 +1,25 @@
+# Function: entityStorageList()
+
+> **entityStorageList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IEntityStorageListResponse`\>
+
+Query the entries from entity storage.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `IEntityStorageListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IEntityStorageListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/entityStorageRemove.md

@@ -0,0 +1,25 @@
+# Function: entityStorageRemove()
+
+> **entityStorageRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove the entry from entity storage.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `IEntityStorageRemoveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/entityStorageSet.md

@@ -0,0 +1,25 @@
+# Function: entityStorageSet()
+
+> **entityStorageSet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Set the entry in entity storage.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `IEntityStorageSetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/generateRestRoutesEntityStorage.md

@@ -0,0 +1,37 @@
+# Function: generateRestRoutesEntityStorage()
+
+> **generateRestRoutesEntityStorage**(`baseRouteName`, `componentName`, `options`?): `IRestRoute`[]
+
+The REST routes for entity storage.
+
+## Parameters
+
+• **baseRouteName**: `string`
+
+Prefix to prepend to the paths.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+• **options?**
+
+Additional options for the routes.
+
+• **options.typeName?**: `string`
+
+Optional type name to use in the routes, defaults to Entity Storage.
+
+• **options.tagName?**: `string`
+
+Optional name to use in OpenAPI spec for tag.
+
+• **options.examples?**: [`IEntityStorageRoutesExamples`](../interfaces/IEntityStorageRoutesExamples.md)
+
+Optional examples to use in the routes.
+
+## Returns
+
+`IRestRoute`[]
+
+The generated routes.

package/docs/reference/index.md

@@ -0,0 +1,23 @@
+# @twin.org/entity-storage-service
+
+## Classes
+
+- [EntityStorageService](classes/EntityStorageService.md)
+
+## Interfaces
+
+- [IEntityStorageConfig](interfaces/IEntityStorageConfig.md)
+- [IEntityStorageRoutesExamples](interfaces/IEntityStorageRoutesExamples.md)
+
+## Variables
+
+- [tagsEntityStorage](variables/tagsEntityStorage.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesEntityStorage](functions/generateRestRoutesEntityStorage.md)
+- [entityStorageSet](functions/entityStorageSet.md)
+- [entityStorageGet](functions/entityStorageGet.md)
+- [entityStorageRemove](functions/entityStorageRemove.md)
+- [entityStorageList](functions/entityStorageList.md)

package/docs/reference/interfaces/IEntityStorageConfig.md

@@ -0,0 +1,19 @@
+# Interface: IEntityStorageConfig
+
+Configuration for the entity storage service.
+
+## Properties
+
+### includeNodeIdentity?
+
+> `optional` **includeNodeIdentity**: `boolean`
+
+Include the node identity when performing storage operations, defaults to true.
+
+***
+
+### includeUserIdentity?
+
+> `optional` **includeUserIdentity**: `boolean`
+
+Include the user identity when performing storage operations, defaults to true.

package/docs/reference/interfaces/IEntityStorageRoutesExamples.md

@@ -0,0 +1,59 @@
+# Interface: IEntityStorageRoutesExamples
+
+Examples for the entity storage routes.
+
+## Properties
+
+### set?
+
+> `optional` **set**: `object`
+
+Examples for the set route.
+
+#### requestExamples
+
+> **requestExamples**: `IRestRouteRequestExample`\<`IEntityStorageSetRequest`\>[]
+
+***
+
+### get?
+
+> `optional` **get**: `object`
+
+Examples for the get route.
+
+#### requestExamples
+
+> **requestExamples**: `IRestRouteRequestExample`\<`IEntityStorageGetRequest`\>[]
+
+#### responseExamples
+
+> **responseExamples**: `IRestRouteResponseExample`\<`IEntityStorageGetResponse`\>[]
+
+***
+
+### remove?
+
+> `optional` **remove**: `object`
+
+Examples for the remove route.
+
+#### requestExamples
+
+> **requestExamples**: `IRestRouteRequestExample`\<`IEntityStorageRemoveRequest`\>[]
+
+***
+
+### list?
+
+> `optional` **list**: `object`
+
+Examples for the list route.
+
+#### requestExamples
+
+> **requestExamples**: `IRestRouteRequestExample`\<`IEntityStorageListRequest`\>[]
+
+#### responseExamples
+
+> **responseExamples**: `IRestRouteResponseExample`\<`IEntityStorageListResponse`\>[]

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,7 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+These are dummy entry points for the entity storage service.
+In reality your application would create its own entry points based on the
+entity storage schema objects it wants to store, using a custom defaultBaseRoute.

package/docs/reference/variables/tagsEntityStorage.md

@@ -0,0 +1,5 @@
+# Variable: tagsEntityStorage
+
+> `const` **tagsEntityStorage**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+	"error": {}
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+	"name": "@twin.org/entity-storage-service",
+	"version": "0.0.1-next.5",
+	"description": "Entity Storage contract implementation and REST endpoint definitions",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/entity-storage.git",
+		"directory": "packages/entity-storage-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-models": "next",
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "0.0.1-next.5",
+		"@twin.org/nameof": "next",
+		"@twin.org/web": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}