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

package/dist/cjs/index.cjs

@@ -114,27 +114,25 @@ class FileEntityStorageConnector {
      * 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.
      */
-    async get(id, secondaryIndex) {
+    async get(id, secondaryIndex, conditions) {
         core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        const lookupKey = secondaryIndex ?? this._primaryKey.property;
         const store = await this.readStore();
-        const found = store?.find(entity => entity[lookupKey] === id);
-        if (found) {
-            return found;
-        }
-        return undefined;
+        const foundIndex = this.findItem(store, id, secondaryIndex, conditions);
+        return foundIndex === -1 ? undefined : store[foundIndex];
     }
     /**
      * 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.
      */
-    async set(entity) {
+    async set(entity, conditions) {
         core.Guards.object(this.CLASS_NAME, "entity", entity);
         const store = await this.readStore();
-        const existingIndex = store.findIndex(e => e[this._primaryKey.property] === entity[this._primaryKey.property]);
+        const existingIndex = this.findItem(store, entity[this._primaryKey.property], undefined, conditions);
         if (existingIndex >= 0) {
             store[existingIndex] = entity;
         }
@@ -146,16 +144,17 @@ class FileEntityStorageConnector {
     /**
      * Remove the entity.
      * @param id The id of the entity to remove.
+     * @param conditions The optional conditions to match for the entities.
      * @returns Nothing.
      */
-    async remove(id) {
+    async remove(id, conditions) {
         core.Guards.stringValue(this.CLASS_NAME, "id", id);
         const store = await this.readStore();
-        const index = store.findIndex(e => e[this._primaryKey.property] === id);
+        const index = this.findItem(store, id, undefined, conditions);
         if (index >= 0) {
             store.splice(index, 1);
+            await this.writeStore(store);
         }
-        await this.writeStore(store);
     }
     /**
      * Find all the entities which match the conditions.
@@ -233,6 +232,51 @@ class FileEntityStorageConnector {
             return false;
         }
     }
+    /**
+     * Find the item in the store.
+     * @param store The store to search.
+     * @param id The id to search for.
+     * @param secondaryIndex The secondary index to search for.
+     * @param conditions The optional conditions to match for the entities.
+     * @returns The index of the item if found or -1.
+     * @internal
+     */
+    findItem(store, id, secondaryIndex, conditions) {
+        const finalConditions = [];
+        if (!core.Is.empty(secondaryIndex)) {
+            finalConditions.push({
+                property: secondaryIndex,
+                comparison: entity.ComparisonOperator.Equals,
+                value: id
+            });
+        }
+        if (core.Is.arrayValue(conditions)) {
+            // If we haven't added a secondary index condition we need to add the primary key condition.
+            if (finalConditions.length === 0) {
+                finalConditions.push({
+                    property: this._primaryKey.property,
+                    comparison: entity.ComparisonOperator.Equals,
+                    value: id
+                });
+            }
+            finalConditions.push(...conditions.map(c => ({
+                property: c.property,
+                comparison: entity.ComparisonOperator.Equals,
+                value: c.value
+            })));
+        }
+        if (finalConditions.length > 0) {
+            for (let i = 0; i < store.length; i++) {
+                if (entity.EntityConditions.check(store[i], { conditions: finalConditions })) {
+                    return i;
+                }
+            }
+        }
+        else {
+            return store.findIndex(e => e[this._primaryKey.property] === id);
+        }
+        return -1;
+    }
 }
 
 exports.FileEntityStorageConnector = FileEntityStorageConnector;

package/dist/esm/index.mjs

@@ -1,7 +1,7 @@
 import { mkdir, readFile, writeFile, access } from 'node:fs/promises';
 import path from 'node:path';
-import { Guards, BaseError, Coerce, ObjectHelper } from '@twin.org/core';
-import { EntitySchemaFactory, EntitySchemaHelper, EntitySorter, EntityConditions } from '@twin.org/entity';
+import { Guards, BaseError, Coerce, ObjectHelper, Is } from '@twin.org/core';
+import { EntitySchemaFactory, EntitySchemaHelper, EntitySorter, EntityConditions, ComparisonOperator } from '@twin.org/entity';
 import { LoggingConnectorFactory } from '@twin.org/logging-models';
 
 // Copyright 2024 IOTA Stiftung.
@@ -112,27 +112,25 @@ class FileEntityStorageConnector {
      * 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.
      */
-    async get(id, secondaryIndex) {
+    async get(id, secondaryIndex, conditions) {
         Guards.stringValue(this.CLASS_NAME, "id", id);
-        const lookupKey = secondaryIndex ?? this._primaryKey.property;
         const store = await this.readStore();
-        const found = store?.find(entity => entity[lookupKey] === id);
-        if (found) {
-            return found;
-        }
-        return undefined;
+        const foundIndex = this.findItem(store, id, secondaryIndex, conditions);
+        return foundIndex === -1 ? undefined : store[foundIndex];
     }
     /**
      * 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.
      */
-    async set(entity) {
+    async set(entity, conditions) {
         Guards.object(this.CLASS_NAME, "entity", entity);
         const store = await this.readStore();
-        const existingIndex = store.findIndex(e => e[this._primaryKey.property] === entity[this._primaryKey.property]);
+        const existingIndex = this.findItem(store, entity[this._primaryKey.property], undefined, conditions);
         if (existingIndex >= 0) {
             store[existingIndex] = entity;
         }
@@ -144,16 +142,17 @@ class FileEntityStorageConnector {
     /**
      * Remove the entity.
      * @param id The id of the entity to remove.
+     * @param conditions The optional conditions to match for the entities.
      * @returns Nothing.
      */
-    async remove(id) {
+    async remove(id, conditions) {
         Guards.stringValue(this.CLASS_NAME, "id", id);
         const store = await this.readStore();
-        const index = store.findIndex(e => e[this._primaryKey.property] === id);
+        const index = this.findItem(store, id, undefined, conditions);
         if (index >= 0) {
             store.splice(index, 1);
+            await this.writeStore(store);
         }
-        await this.writeStore(store);
     }
     /**
      * Find all the entities which match the conditions.
@@ -231,6 +230,51 @@ class FileEntityStorageConnector {
             return false;
         }
     }
+    /**
+     * Find the item in the store.
+     * @param store The store to search.
+     * @param id The id to search for.
+     * @param secondaryIndex The secondary index to search for.
+     * @param conditions The optional conditions to match for the entities.
+     * @returns The index of the item if found or -1.
+     * @internal
+     */
+    findItem(store, id, secondaryIndex, conditions) {
+        const finalConditions = [];
+        if (!Is.empty(secondaryIndex)) {
+            finalConditions.push({
+                property: secondaryIndex,
+                comparison: ComparisonOperator.Equals,
+                value: id
+            });
+        }
+        if (Is.arrayValue(conditions)) {
+            // If we haven't added a secondary index condition we need to add the primary key condition.
+            if (finalConditions.length === 0) {
+                finalConditions.push({
+                    property: this._primaryKey.property,
+                    comparison: ComparisonOperator.Equals,
+                    value: id
+                });
+            }
+            finalConditions.push(...conditions.map(c => ({
+                property: c.property,
+                comparison: ComparisonOperator.Equals,
+                value: c.value
+            })));
+        }
+        if (finalConditions.length > 0) {
+            for (let i = 0; i < store.length; i++) {
+                if (EntityConditions.check(store[i], { conditions: finalConditions })) {
+                    return i;
+                }
+            }
+        }
+        else {
+            return store.findIndex(e => e[this._primaryKey.property] === id);
+        }
+        return -1;
+    }
 }
 
 export { FileEntityStorageConnector };

package/dist/types/fileEntityStorageConnector.d.ts

@@ -34,21 +34,33 @@ export declare class FileEntityStorageConnector<T = unknown> implements IEntityS
      * 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>;
     /**
      * 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>;
     /**
      * 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>;
     /**
      * Find 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-connector-file - Changelog
 
-## v0.0.1-next.8
+## v0.0.1-next.9
 
 - Initial Release

package/docs/reference/classes/FileEntityStorageConnector.md

@@ -94,7 +94,7 @@ The schema for the entities.
 
 ### get()
 
-> **get**(`id`, `secondaryIndex`?): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex`?, `conditions`?): `Promise`\<`undefined` \| `T`\>
 
 Get an entity.
 
@@ -108,6 +108,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`\>
@@ -122,7 +126,7 @@ The object if it can be found or undefined.
 
 ### set()
 
-> **set**(`entity`): `Promise`\<`void`\>
+> **set**(`entity`, `conditions`?): `Promise`\<`void`\>
 
 Set an entity.
 
@@ -132,6 +136,10 @@ Set an entity.
 
 The entity to set.
 
+• **conditions?**: `object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -146,7 +154,7 @@ The id of the entity.
 
 ### remove()
 
-> **remove**(`id`): `Promise`\<`void`\>
+> **remove**(`id`, `conditions`?): `Promise`\<`void`\>
 
 Remove the entity.
 
@@ -156,6 +164,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-connector-file",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1-next.9",
 	"description": "Entity Storage connector implementation using file storage",
 	"repository": {
 		"type": "git",
@@ -16,7 +16,7 @@
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.1-next.8",
+		"@twin.org/entity-storage-models": "0.0.1-next.9",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},