@twin.org/entity-storage-models 0.0.1-next.8 → 0.0.1-next.9

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

@@ -12,22 +12,34 @@ export interface IEntityStorageConnector<T = unknown> extends IComponent {
     /**
      * Set an entity.
      * @param entity The entity to set.
+     * @param conditions The optional conditions to match for the entities.
      * @returns The id of the entity.
      */
-    set(entity: T): Promise<void>;
+    set(entity: T, conditions?: {
+        property: keyof T;
+        value: unknown;
+    }[]): 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 conditions The optional conditions to match for the entities.
      * @returns The object if it can be found or undefined.
      */
-    get(id: string, secondaryIndex?: keyof T): Promise<T | undefined>;
+    get(id: string, secondaryIndex?: keyof T, conditions?: {
+        property: keyof T;
+        value: unknown;
+    }[]): Promise<T | undefined>;
     /**
      * Remove the entity.
      * @param id The id of the entity to remove.
+     * @param conditions The optional conditions to match for the entities.
      * @returns Nothing.
      */
-    remove(id: string): Promise<void>;
+    remove(id: string, conditions?: {
+        property: keyof T;
+        value: unknown;
+    }[]): Promise<void>;
     /**
      * Query all the entities which match the conditions.
      * @param conditions The conditions to match for the entities.

package/docs/changelog.md

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

package/docs/reference/interfaces/IEntityStorageConnector.md

@@ -28,7 +28,7 @@ The schema for the entities.
 
 ### set()
 
-> **set**(`entity`): `Promise`\<`void`\>
+> **set**(`entity`, `conditions`?): `Promise`\<`void`\>
 
 Set an entity.
 
@@ -38,6 +38,10 @@ Set an entity.
 
 The entity to set.
 
+• **conditions?**: `object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -48,7 +52,7 @@ The id of the entity.
 
 ### get()
 
-> **get**(`id`, `secondaryIndex`?): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex`?, `conditions`?): `Promise`\<`undefined` \| `T`\>
 
 Get an entity.
 
@@ -62,6 +66,10 @@ The id of the entity to get, or the index value if secondaryIndex is set.
 
 Get the item using a secondary index.
 
+• **conditions?**: `object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`undefined` \| `T`\>
@@ -72,7 +80,7 @@ The object if it can be found or undefined.
 
 ### remove()
 
-> **remove**(`id`): `Promise`\<`void`\>
+> **remove**(`id`, `conditions`?): `Promise`\<`void`\>
 
 Remove the entity.
 
@@ -82,6 +90,10 @@ Remove the entity.
 
 The id of the entity to remove.
 
+• **conditions?**: `object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`void`\>

package/package.json

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