@twin.org/entity-storage-service 0.0.2-next.9 → 0.0.3-next.10

package/docs/reference/classes/EntityStorageService.md

@@ -34,21 +34,35 @@ The dependencies for the entity storage service.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IEntityStorageComponent.CLASS_NAME`
+`IEntityStorageComponent.className`
 
-## Methods
+***
 
-### set()
+### set() {#set}
 
-> **set**(`entity`, `userIdentity?`): `Promise`\<`void`\>
+> **set**(`entity`): `Promise`\<`void`\>
 
 Set an entity.
 
@@ -60,27 +74,47 @@ Set an entity.
 
 The entity to set.
 
-##### userIdentity?
+#### Returns
 
-`string`
+`Promise`\<`void`\>
+
+The id of the entity.
 
-The user identity to use with storage operations.
+#### Implementation of
+
+`IEntityStorageComponent.set`
+
+***
+
+### setBatch() {#setbatch}
+
+> **setBatch**(`entities`): `Promise`\<`void`\>
+
+Set multiple entities in a batch.
+
+#### Parameters
+
+##### entities
+
+`T`[]
+
+The entities to set.
 
 #### Returns
 
 `Promise`\<`void`\>
 
-The id of the entity.
+Nothing.
 
 #### Implementation of
 
-`IEntityStorageComponent.set`
+`IEntityStorageComponent.setBatch`
 
 ***
 
-### get()
+### get() {#get}
 
-> **get**(`id`, `secondaryIndex?`, `userIdentity?`): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex?`): `Promise`\<`T` \| `undefined`\>
 
 Get an entity.
 
@@ -98,15 +132,9 @@ keyof `T`
 
 Get the item using a secondary index.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
-`Promise`\<`undefined` \| `T`\>
+`Promise`\<`T` \| `undefined`\>
 
 The object if it can be found or undefined.
 
@@ -116,9 +144,9 @@ The object if it can be found or undefined.
 
 ***
 
-### remove()
+### remove() {#remove}
 
-> **remove**(`id`, `userIdentity?`): `Promise`\<`void`\>
+> **remove**(`id`): `Promise`\<`void`\>
 
 Remove the entity.
 
@@ -130,11 +158,31 @@ Remove the entity.
 
 The id of the entity to remove.
 
-##### userIdentity?
+#### Returns
+
+`Promise`\<`void`\>
 
-`string`
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageComponent.remove`
+
+***
+
+### removeBatch() {#removebatch}
+
+> **removeBatch**(`ids`): `Promise`\<`void`\>
+
+Remove multiple entities by id.
+
+#### Parameters
+
+##### ids
 
-The user identity to use with storage operations.
+`string`[]
+
+The ids of the entities to remove.
 
 #### Returns
 
@@ -144,13 +192,49 @@ Nothing.
 
 #### Implementation of
 
-`IEntityStorageComponent.remove`
+`IEntityStorageComponent.removeBatch`
 
 ***
 
-### query()
+### empty() {#empty}
+
+> **empty**(): `Promise`\<`void`\>
+
+Remove all entities from the storage.
+
+#### Returns
 
-> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`, `userIdentity?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageComponent.empty`
+
+***
+
+### count() {#count}
+
+> **count**(): `Promise`\<`number`\>
+
+Count all the entities which match the conditions.
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The total count of entities in the storage.
+
+#### Implementation of
+
+`IEntityStorageComponent.count`
+
+***
+
+### query() {#query}
+
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 Query all the entities which match the conditions.
 
@@ -184,20 +268,14 @@ The optional properties to return, defaults to all.
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `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.
-
 #### Returns
 
 `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>

package/docs/reference/functions/entityStorageCount.md

@@ -0,0 +1,31 @@
+# Function: entityStorageCount()
+
+> **entityStorageCount**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IEntityStorageCountResponse`\>
+
+Count the entries 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
+
+`IEntityStorageCountRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IEntityStorageCountResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/entityStorageEmpty.md

@@ -0,0 +1,31 @@
+# Function: entityStorageEmpty()
+
+> **entityStorageEmpty**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove all 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
+
+`IEntityStorageEmptyRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/entityStorageRemoveBatch.md

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

package/docs/reference/functions/entityStorageSetBatch.md

@@ -0,0 +1,31 @@
+# Function: entityStorageSetBatch()
+
+> **entityStorageSetBatch**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Set multiple entries 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
+
+`IEntityStorageSetBatchRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -6,8 +6,8 @@
 
 ## Interfaces
 
-- [IEntityStorageConfig](interfaces/IEntityStorageConfig.md)
 - [IEntityStorageRoutesExamples](interfaces/IEntityStorageRoutesExamples.md)
+- [IEntityStorageServiceConfig](interfaces/IEntityStorageServiceConfig.md)
 - [IEntityStorageServiceConstructorOptions](interfaces/IEntityStorageServiceConstructorOptions.md)
 
 ## Variables
@@ -19,6 +19,10 @@
 
 - [generateRestRoutesEntityStorage](functions/generateRestRoutesEntityStorage.md)
 - [entityStorageSet](functions/entityStorageSet.md)
+- [entityStorageSetBatch](functions/entityStorageSetBatch.md)
+- [entityStorageEmpty](functions/entityStorageEmpty.md)
 - [entityStorageGet](functions/entityStorageGet.md)
 - [entityStorageRemove](functions/entityStorageRemove.md)
 - [entityStorageList](functions/entityStorageList.md)
+- [entityStorageCount](functions/entityStorageCount.md)
+- [entityStorageRemoveBatch](functions/entityStorageRemoveBatch.md)

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.
 
@@ -57,3 +57,19 @@ Examples for the list route.
 #### responseExamples
 
 > **responseExamples**: `IRestRouteResponseExample`\<`IEntityStorageListResponse`\>[]
+
+***
+
+### count? {#count}
+
+> `optional` **count?**: `object`
+
+Examples for the count route.
+
+#### requestExamples
+
+> **requestExamples**: `IRestRouteRequestExample`\<`IEntityStorageCountRequest`\>[]
+
+#### responseExamples
+
+> **responseExamples**: `IRestRouteResponseExample`\<`IEntityStorageCountResponse`\>[]

package/docs/reference/interfaces/IEntityStorageServiceConfig.md

@@ -0,0 +1,3 @@
+# Interface: IEntityStorageServiceConfig
+
+Configuration for the entity storage service.

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**: [`IEntityStorageConfig`](IEntityStorageConfig.md)
+> `optional` **config?**: [`IEntityStorageServiceConfig`](IEntityStorageServiceConfig.md)
 
 The configuration for the service.

package/locales/en.json

@@ -1,7 +1 @@
-{
-	"error": {
-		"entityStorageService": {
-			"entityNotFound": "Could not find entity with id \"{id}\""
-		}
-	}
-}
+{}

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/entity-storage-service",
-	"version": "0.0.2-next.9",
-	"description": "Entity Storage contract implementation and REST endpoint definitions",
+	"version": "0.0.3-next.10",
+	"description": "Service layer exposing storage contracts and REST endpoint definitions.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/entity-storage.git",
+		"url": "git+https://github.com/iotaledger/entity-storage.git",
 		"directory": "packages/entity-storage-service"
 	},
 	"author": "martyn.janes@iota.org",
@@ -17,24 +17,22 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.2-next.9",
+		"@twin.org/entity-storage-models": "0.0.3-next.10",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -53,5 +51,9 @@
 		"service",
 		"microservice",
 		"business-logic"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/iotaledger/entity-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }