@twin.org/entity-storage-service 0.0.1-next.13 → 0.0.1-next.15

package/dist/cjs/index.cjs

@@ -259,8 +259,6 @@ class EntityStorageService {
     /**
      * Create a new instance of EntityStorageService.
      * @param options The dependencies for the entity storage service.
-     * @param options.config The configuration for the service.
-     * @param options.entityStorageType The entity storage type.
      */
     constructor(options) {
         core.Guards.string(this.CLASS_NAME, "options.entityStorageType", options.entityStorageType);

package/dist/esm/index.mjs

@@ -257,8 +257,6 @@ class EntityStorageService {
     /**
      * Create a new instance of EntityStorageService.
      * @param options The dependencies for the entity storage service.
-     * @param options.config The configuration for the service.
-     * @param options.entityStorageType The entity storage type.
      */
     constructor(options) {
         Guards.string(this.CLASS_NAME, "options.entityStorageType", options.entityStorageType);

package/dist/types/entityStorageService.d.ts

@@ -1,6 +1,6 @@
 import { type EntityCondition, SortDirection } from "@twin.org/entity";
 import { type IEntityStorageComponent } from "@twin.org/entity-storage-models";
-import type { IEntityStorageConfig } from "./models/IEntityStorageConfig";
+import type { IEntityStorageServiceConstructorOptions } from "./models/IEntityStorageServiceConstructorOptions";
 /**
  * Class for performing entity service operations.
  */
@@ -12,13 +12,8 @@ export declare class EntityStorageService<T = any> implements IEntityStorageComp
     /**
      * Create a new instance of EntityStorageService.
      * @param options The dependencies for the entity storage service.
-     * @param options.config The configuration for the service.
-     * @param options.entityStorageType The entity storage type.
      */
-    constructor(options: {
-        entityStorageType: string;
-        config?: IEntityStorageConfig;
-    });
+    constructor(options: IEntityStorageServiceConstructorOptions);
     /**
      * Set an entity.
      * @param entity The entity to set.

package/dist/types/index.d.ts

@@ -2,4 +2,5 @@ export * from "./entityStorageRoutes";
 export * from "./entityStorageService";
 export * from "./models/IEntityStorageConfig";
 export * from "./models/IEntityStorageRoutesExamples";
+export * from "./models/IEntityStorageServiceConstructorOptions";
 export * from "./restEntryPoints";

package/dist/types/models/IEntityStorageServiceConstructorOptions.d.ts

@@ -0,0 +1,14 @@
+import type { IEntityStorageConfig } from "./IEntityStorageConfig";
+/**
+ * Options for the Entity Storage Service constructor.
+ */
+export interface IEntityStorageServiceConstructorOptions {
+    /**
+     * The type of the entity storage.
+     */
+    entityStorageType: string;
+    /**
+     * The configuration for the service.
+     */
+    config?: IEntityStorageConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/entity-storage-service - Changelog
 
-## v0.0.1-next.13
+## v0.0.1-next.15
 
 - Initial Release

package/docs/reference/classes/EntityStorageService.md

@@ -20,17 +20,11 @@ Create a new instance of EntityStorageService.
 
 #### Parameters
 
-• **options**
+##### options
 
-The dependencies for the entity storage service.
-
-• **options.entityStorageType**: `string`
-
-The entity storage type.
-
-• **options.config?**: [`IEntityStorageConfig`](../interfaces/IEntityStorageConfig.md)
+[`IEntityStorageServiceConstructorOptions`](../interfaces/IEntityStorageServiceConstructorOptions.md)
 
-The configuration for the service.
+The dependencies for the entity storage service.
 
 #### Returns
 
@@ -58,15 +52,21 @@ 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.
 
@@ -90,19 +90,27 @@ 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.
 
@@ -126,15 +134,21 @@ 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,63 +166,67 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `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.
 
-• **orderBy?**: keyof `T`
+##### orderBy?
+
+keyof `T`
 
 The order for the results.
 
-• **orderByDirection?**: `SortDirection`
+##### orderByDirection?
+
+`SortDirection`
 
 The direction for the order, defaults to ascending.
 
-• **properties?**: keyof `T`[]
+##### 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

@@ -6,27 +6,37 @@ 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.
 

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.13",
+	"version": "0.0.1-next.15",
 	"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.13",
+		"@twin.org/entity-storage-models": "0.0.1-next.15",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
@@ -30,7 +30,7 @@
 			"import": "./dist/esm/index.mjs",
 			"types": "./dist/types/index.d.ts"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",