@twin.org/entity-storage-service 0.0.1-next.9 → 0.0.2-next.1

package/docs/reference/classes/EntityStorageService.md

@@ -4,7 +4,9 @@ Class for performing entity service operations.
 
 ## Type Parameters
 
-• **T** = `any`
+### T
+
+`T` = `any`
 
 ## Implements
 
@@ -12,29 +14,23 @@ Class for performing entity service operations.
 
 ## Constructors
 
-### new EntityStorageService()
+### Constructor
 
-> **new EntityStorageService**\<`T`\>(`options`): [`EntityStorageService`](EntityStorageService.md)\<`T`\>
+> **new EntityStorageService**\<`T`\>(`options`): `EntityStorageService`\<`T`\>
 
 Create a new instance of EntityStorageService.
 
 #### Parameters
 
-• **options**
-
-The dependencies for the entity storage service.
-
-• **options.entityStorageType**: `string`
-
-The entity storage type.
+##### options
 
-• **options.config?**: [`IEntityStorageConfig`](../interfaces/IEntityStorageConfig.md)
+[`IEntityStorageServiceConstructorOptions`](../interfaces/IEntityStorageServiceConstructorOptions.md)
 
-The configuration for the service.
+The dependencies for the entity storage service.
 
 #### Returns
 
-[`EntityStorageService`](EntityStorageService.md)\<`T`\>
+`EntityStorageService`\<`T`\>
 
 ## Properties
 
@@ -52,21 +48,27 @@ Runtime name for the class.
 
 ### set()
 
-> **set**(`entity`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **set**(`entity`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Set an entity.
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to set.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The user identity to use with storage operations.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use with storage operations.
 
@@ -84,25 +86,33 @@ The id of the entity.
 
 ### get()
 
-> **get**(`id`, `secondaryIndex`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`undefined` \| `T`\>
 
 Get an entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to get, or the index value if secondaryIndex is set.
 
-• **secondaryIndex?**: keyof `T`
+##### secondaryIndex?
+
+keyof `T`
 
 Get the item using a secondary index.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The user identity to use with storage operations.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use with storage operations.
 
@@ -120,21 +130,27 @@ The object if it can be found or undefined.
 
 ### remove()
 
-> **remove**(`id`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **remove**(`id`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Remove the entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to remove.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The user identity to use with storage operations.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use with storage operations.
 
@@ -152,59 +168,67 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`object`\>
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 Query all the entities which match the conditions.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<`T`\>
+##### conditions?
+
+`EntityCondition`\<`T`\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### orderBy?
 
-The optional sort order.
+keyof `T`
 
-• **properties?**: keyof `T`[]
+The order for the results.
+
+##### orderByDirection?
+
+`SortDirection`
+
+The direction for the order, defaults to ascending.
+
+##### properties?
+
+keyof `T`[]
 
 The optional properties to return, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The user identity to use with storage operations.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use with storage operations.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 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

@@ -6,15 +6,21 @@ Get the entry from entity storage.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IEntityStorageGetRequest`
+### request
+
+`IEntityStorageGetRequest`
 
 The request.
 

package/docs/reference/functions/entityStorageList.md

@@ -6,15 +6,21 @@ Query the entries from entity storage.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IEntityStorageListRequest`
+### request
+
+`IEntityStorageListRequest`
 
 The request.
 

package/docs/reference/functions/entityStorageRemove.md

@@ -6,15 +6,21 @@ Remove the entry from entity storage.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IEntityStorageRemoveRequest`
+### request
+
+`IEntityStorageRemoveRequest`
 
 The request.
 

package/docs/reference/functions/entityStorageSet.md

@@ -6,15 +6,21 @@ Set the entry in entity storage.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IEntityStorageSetRequest`
+### request
+
+`IEntityStorageSetRequest`
 
 The request.
 

package/docs/reference/functions/generateRestRoutesEntityStorage.md

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

package/docs/reference/index.md

@@ -8,6 +8,7 @@
 
 - [IEntityStorageConfig](interfaces/IEntityStorageConfig.md)
 - [IEntityStorageRoutesExamples](interfaces/IEntityStorageRoutesExamples.md)
+- [IEntityStorageServiceConstructorOptions](interfaces/IEntityStorageServiceConstructorOptions.md)
 
 ## Variables
 

package/docs/reference/interfaces/IEntityStorageServiceConstructorOptions.md

@@ -0,0 +1,19 @@
+# Interface: IEntityStorageServiceConstructorOptions
+
+Options for the Entity Storage Service constructor.
+
+## Properties
+
+### entityStorageType
+
+> **entityStorageType**: `string`
+
+The type of the entity storage.
+
+***
+
+### config?
+
+> `optional` **config**: [`IEntityStorageConfig`](IEntityStorageConfig.md)
+
+The configuration for the service.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-service",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"description": "Entity Storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "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.1-next.9",
+		"@twin.org/entity-storage-models": "0.0.2-next.1",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
@@ -26,11 +26,11 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",