@twin.org/entity-storage-models 0.0.1-next.4 → 0.0.1-next.6

package/dist/types/index.d.ts

@@ -1,2 +1,9 @@
 export * from "./factories/entityStorageConnectorFactory";
+export * from "./models/api/IEntityStorageGetRequest";
+export * from "./models/api/IEntityStorageGetResponse";
+export * from "./models/api/IEntityStorageListRequest";
+export * from "./models/api/IEntityStorageListResponse";
+export * from "./models/api/IEntityStorageRemoveRequest";
+export * from "./models/api/IEntityStorageSetRequest";
+export * from "./models/IEntityStorageComponent";
 export * from "./models/IEntityStorageConnector";

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

@@ -0,0 +1,57 @@
+import type { IComponent } from "@twin.org/core";
+import type { EntityCondition, SortDirection } from "@twin.org/entity";
+/**
+ * Interface describing an entity storage component.
+ */
+export interface IEntityStorageComponent<T = unknown> extends IComponent {
+    /**
+     * Set an entity.
+     * @param entity The entity to set.
+     * @param userIdentity The user identity to use with storage operations.
+     * @param nodeIdentity The node identity to use with storage operations.
+     * @returns The id of the entity.
+     */
+    set(entity: T, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    /**
+     * Get an entity.
+     * @param id The id of the entity to get, or the index value if secondaryIndex is set.
+     * @param secondaryIndex Get the item using a secondary index.
+     * @param userIdentity The user identity to use with storage operations.
+     * @param nodeIdentity The node identity to use with storage operations.
+     * @returns The object if it can be found or undefined.
+     */
+    get(id: string, secondaryIndex?: keyof T, userIdentity?: string, nodeIdentity?: string): Promise<T | undefined>;
+    /**
+     * Remove the entity.
+     * @param id The id of the entity to remove.
+     * @param userIdentity The user identity to use with storage operations.
+     * @param nodeIdentity The node identity to use with storage operations.
+     * @returns Nothing.
+     */
+    remove(id: string, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    /**
+     * Query all the entities which match the conditions.
+     * @param conditions The conditions to match for the entities.
+     * @param sortProperties The optional sort order.
+     * @param properties The optional properties to return, defaults to all.
+     * @param cursor The cursor to request the next page of entities.
+     * @param pageSize The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+     * @param userIdentity The user identity to use with storage operations.
+     * @param nodeIdentity The node identity to use with storage operations.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    query(conditions?: EntityCondition<T>, sortProperties?: {
+        property: keyof T;
+        sortDirection: SortDirection;
+    }[], properties?: (keyof T)[], cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<{
+        /**
+         * The entities, which can be partial if a limited keys list was provided.
+         */
+        entities: Partial<T>[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    }>;
+}

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

@@ -1,22 +1,27 @@
 import type { IComponent } from "@twin.org/core";
-import type { EntityCondition, SortDirection } from "@twin.org/entity";
+import type { EntityCondition, IEntitySchema, SortDirection } from "@twin.org/entity";
 /**
  * Interface describing an entity storage connector.
  */
 export interface IEntityStorageConnector<T = unknown> extends IComponent {
     /**
-     * Get an entity.
-     * @param id The id of the entity to get, or the index value if secondaryIndex is set.
-     * @param secondaryIndex Get the item using a secondary index.
-     * @returns The object if it can be found or undefined.
+     * Get the schema for the entities.
+     * @returns The schema for the entities.
      */
-    get(id: string, secondaryIndex?: keyof T): Promise<T | undefined>;
+    getSchema(): IEntitySchema;
     /**
      * Set an entity.
      * @param entity The entity to set.
      * @returns The id of the entity.
      */
     set(entity: T): Promise<void>;
+    /**
+     * Get an entity.
+     * @param id The id of the entity to get, or the index value if secondaryIndex is set.
+     * @param secondaryIndex Get the item using a secondary index.
+     * @returns The object if it can be found or undefined.
+     */
+    get(id: string, secondaryIndex?: keyof T): Promise<T | undefined>;
     /**
      * Remove the entity.
      * @param id The id of the entity to remove.

package/dist/types/models/api/IEntityStorageGetRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Get an entry from entity storage.
+ */
+export interface IEntityStorageGetRequest {
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the entity to get.
+         */
+        id: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * The secondary index to query with the id.
+         */
+        secondaryIndex?: string;
+    };
+}

package/dist/types/models/api/IEntityStorageGetResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Get an entry from entity storage.
+ */
+export interface IEntityStorageGetResponse {
+    /**
+     * The data for the requested entity.
+     */
+    body: unknown;
+}

package/dist/types/models/api/IEntityStorageListRequest.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Query the entries from entity storage.
+ */
+export interface IEntityStorageListRequest {
+    /**
+     * The parameters from the query.
+     */
+    query?: {
+        /**
+         * The condition for the query as JSON version of EntityCondition type.
+         */
+        conditions?: string;
+        /**
+         * The sort property array as JSON serialization of {property,direction}[].
+         */
+        sortProperties?: string;
+        /**
+         * The properties to return in the response as a comma separated list, by default returns all properties.
+         */
+        properties?: string;
+        /**
+         * The number of entries to return per page.
+         */
+        pageSize?: number;
+        /**
+         * The cursor to get next chunk of data, returned in previous response.
+         */
+        cursor?: string;
+    };
+}

package/dist/types/models/api/IEntityStorageListResponse.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Response to getting the list of entries from a query.
+ */
+export interface IEntityStorageListResponse {
+    /**
+     * The list of entries from the query.
+     */
+    body: {
+        /**
+         * The entities from the query.
+         */
+        entities?: unknown[];
+        /**
+         * The cursor for the next page.
+         */
+        cursor?: string;
+    };
+}

package/dist/types/models/api/IEntityStorageRemoveRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Remove an entry from entity storage.
+ */
+export interface IEntityStorageRemoveRequest {
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the entity to remove.
+         */
+        id: string;
+    };
+}

package/dist/types/models/api/IEntityStorageSetRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Set an entry in entity storage.
+ */
+export interface IEntityStorageSetRequest {
+    /**
+     * The data to be used in the entity.
+     */
+    body: unknown;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/entity-storage-models - Changelog
 
-## v0.0.1-next.4
+## v0.0.1-next.6
 
 - Initial Release

package/docs/reference/index.md

@@ -2,7 +2,14 @@
 
 ## Interfaces
 
+- [IEntityStorageComponent](interfaces/IEntityStorageComponent.md)
 - [IEntityStorageConnector](interfaces/IEntityStorageConnector.md)
+- [IEntityStorageGetRequest](interfaces/IEntityStorageGetRequest.md)
+- [IEntityStorageGetResponse](interfaces/IEntityStorageGetResponse.md)
+- [IEntityStorageListRequest](interfaces/IEntityStorageListRequest.md)
+- [IEntityStorageListResponse](interfaces/IEntityStorageListResponse.md)
+- [IEntityStorageRemoveRequest](interfaces/IEntityStorageRemoveRequest.md)
+- [IEntityStorageSetRequest](interfaces/IEntityStorageSetRequest.md)
 
 ## Variables
 

package/docs/reference/interfaces/IEntityStorageComponent.md

@@ -0,0 +1,156 @@
+# Interface: IEntityStorageComponent\<T\>
+
+Interface describing an entity storage component.
+
+## Extends
+
+- `IComponent`
+
+## Type Parameters
+
+• **T** = `unknown`
+
+## 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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### 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.

package/docs/reference/interfaces/IEntityStorageConnector.md

@@ -12,27 +12,17 @@ Interface describing an entity storage connector.
 
 ## Methods
 
-### get()
-
-> **get**(`id`, `secondaryIndex`?): `Promise`\<`undefined` \| `T`\>
-
-Get an entity.
-
-#### Parameters
-
-• **id**: `string`
-
-The id of the entity to get, or the index value if secondaryIndex is set.
+### getSchema()
 
-• **secondaryIndex?**: keyof `T`
+> **getSchema**(): `IEntitySchema`\<`unknown`\>
 
-Get the item using a secondary index.
+Get the schema for the entities.
 
 #### Returns
 
-`Promise`\<`undefined` \| `T`\>
+`IEntitySchema`\<`unknown`\>
 
-The object if it can be found or undefined.
+The schema for the entities.
 
 ***
 
@@ -56,6 +46,30 @@ The id of the entity.
 
 ***
 
+### get()
+
+> **get**(`id`, `secondaryIndex`?): `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.
+
+#### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+The object if it can be found or undefined.
+
+***
+
 ### remove()
 
 > **remove**(`id`): `Promise`\<`void`\>

package/docs/reference/interfaces/IEntityStorageGetRequest.md

@@ -0,0 +1,31 @@
+# Interface: IEntityStorageGetRequest
+
+Get an entry from entity storage.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the entity to get.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### secondaryIndex?
+
+> `optional` **secondaryIndex**: `string`
+
+The secondary index to query with the id.

package/docs/reference/interfaces/IEntityStorageGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IEntityStorageGetResponse
+
+Get an entry from entity storage.
+
+## Properties
+
+### body
+
+> **body**: `unknown`
+
+The data for the requested entity.

package/docs/reference/interfaces/IEntityStorageListRequest.md

@@ -0,0 +1,41 @@
+# Interface: IEntityStorageListRequest
+
+Query the entries from entity storage.
+
+## Properties
+
+### query?
+
+> `optional` **query**: `object`
+
+The parameters from the query.
+
+#### conditions?
+
+> `optional` **conditions**: `string`
+
+The condition for the query as JSON version of EntityCondition type.
+
+#### sortProperties?
+
+> `optional` **sortProperties**: `string`
+
+The sort property array as JSON serialization of {property,direction}[].
+
+#### properties?
+
+> `optional` **properties**: `string`
+
+The properties to return in the response as a comma separated list, by default returns all properties.
+
+#### pageSize?
+
+> `optional` **pageSize**: `number`
+
+The number of entries to return per page.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor to get next chunk of data, returned in previous response.

package/docs/reference/interfaces/IEntityStorageListResponse.md

@@ -0,0 +1,23 @@
+# Interface: IEntityStorageListResponse
+
+Response to getting the list of entries from a query.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The list of entries from the query.
+
+#### entities?
+
+> `optional` **entities**: `unknown`[]
+
+The entities from the query.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor for the next page.

package/docs/reference/interfaces/IEntityStorageRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IEntityStorageRemoveRequest
+
+Remove an entry from entity storage.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the entity to remove.

package/docs/reference/interfaces/IEntityStorageSetRequest.md

@@ -0,0 +1,11 @@
+# Interface: IEntityStorageSetRequest
+
+Set an entry in entity storage.
+
+## Properties
+
+### body
+
+> **body**: `unknown`
+
+The data to be used in the entity.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-models",
-	"version": "0.0.1-next.4",
+	"version": "0.0.1-next.6",
 	"description": "Models which define the structure of the entity storage contracts and connectors",
 	"repository": {
 		"type": "git",