@twin.org/entity-storage-connector-file 0.0.1-next.2 → 0.0.1-next.21

package/dist/cjs/index.cjs

@@ -39,8 +39,6 @@ class FileEntityStorageConnector {
     /**
      * Create a new instance of FileEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);
@@ -103,31 +101,36 @@ class FileEntityStorageConnector {
         }
         return true;
     }
+    /**
+     * Get the schema for the entities.
+     * @returns The schema for the entities.
+     */
+    getSchema() {
+        return this._entitySchema;
+    }
     /**
      * 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;
         }
@@ -139,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) {
         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.
@@ -173,7 +177,10 @@ class FileEntityStorageConnector {
                 if (entity.EntityConditions.check(allEntities[i], conditions) && entities.length < finalPageSize) {
                     entities.push(core.ObjectHelper.pick(allEntities[i], properties));
                     if (entities.length >= finalPageSize) {
-                        nextCursor = (i + 1).toString();
+                        if (i < allEntities.length - 1) {
+                            nextCursor = (i + 1).toString();
+                        }
+                        break;
                     }
                 }
             }
@@ -226,6 +233,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.
@@ -37,8 +37,6 @@ class FileEntityStorageConnector {
     /**
      * Create a new instance of FileEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);
@@ -101,31 +99,36 @@ class FileEntityStorageConnector {
         }
         return true;
     }
+    /**
+     * Get the schema for the entities.
+     * @returns The schema for the entities.
+     */
+    getSchema() {
+        return this._entitySchema;
+    }
     /**
      * 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;
         }
@@ -137,16 +140,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.
@@ -171,7 +175,10 @@ class FileEntityStorageConnector {
                 if (EntityConditions.check(allEntities[i], conditions) && entities.length < finalPageSize) {
                     entities.push(ObjectHelper.pick(allEntities[i], properties));
                     if (entities.length >= finalPageSize) {
-                        nextCursor = (i + 1).toString();
+                        if (i < allEntities.length - 1) {
+                            nextCursor = (i + 1).toString();
+                        }
+                        break;
                     }
                 }
             }
@@ -224,6 +231,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

@@ -1,6 +1,6 @@
-import { type EntityCondition, type SortDirection } from "@twin.org/entity";
+import { type EntityCondition, type IEntitySchema, type SortDirection } from "@twin.org/entity";
 import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
-import type { IFileEntityStorageConnectorConfig } from "./models/IFileEntityStorageConnectorConfig";
+import type { IFileEntityStorageConnectorConstructorOptions } from "./models/IFileEntityStorageConnectorConstructorOptions";
 /**
  * Class for performing entity storage operations in file.
  */
@@ -12,38 +12,50 @@ export declare class FileEntityStorageConnector<T = unknown> implements IEntityS
     /**
      * Create a new instance of FileEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.config The configuration for the connector.
      */
-    constructor(options: {
-        entitySchema: string;
-        config: IFileEntityStorageConnectorConfig;
-    });
+    constructor(options: IFileEntityStorageConnectorConstructorOptions);
     /**
      * Bootstrap the connector by creating and initializing any resources it needs.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
      * @returns True if the bootstrapping process was successful.
      */
     bootstrap(nodeLoggingConnectorType?: string): Promise<boolean>;
+    /**
+     * Get the schema for the entities.
+     * @returns The schema for the entities.
+     */
+    getSchema(): IEntitySchema;
     /**
      * 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/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./fileEntityStorageConnector";
 export * from "./models/IFileEntityStorageConnectorConfig";
+export * from "./models/IFileEntityStorageConnectorConstructorOptions";

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

@@ -0,0 +1,14 @@
+import type { IFileEntityStorageConnectorConfig } from "./IFileEntityStorageConnectorConfig";
+/**
+ * Options for the File Entity Storage Connector constructor.
+ */
+export interface IFileEntityStorageConnectorConstructorOptions {
+    /**
+     * The name of the entity schema.
+     */
+    entitySchema: string;
+    /**
+     * The configuration for the connector.
+     */
+    config: IFileEntityStorageConnectorConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/entity-storage-connector-file - Changelog
 
-## v0.0.1-next.2
+## v0.0.1-next.21
 
 - Initial Release

package/docs/reference/classes/FileEntityStorageConnector.md

@@ -20,17 +20,11 @@ Create a new instance of FileEntityStorageConnector.
 
 #### Parameters
 
-• **options**
+##### options
 
-The options for the connector.
-
-• **options.entitySchema**: `string`
-
-The name of the entity schema.
+[`IFileEntityStorageConnectorConstructorOptions`](../interfaces/IFileEntityStorageConnectorConstructorOptions.md)
 
-• **options.config**: [`IFileEntityStorageConnectorConfig`](../interfaces/IFileEntityStorageConnectorConfig.md)
-
-The configuration for the connector.
+The options for the connector.
 
 #### Returns
 
@@ -58,7 +52,9 @@ Bootstrap the connector by creating and initializing any resources it needs.
 
 #### Parameters
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -74,22 +70,50 @@ True if the bootstrapping process was successful.
 
 ***
 
+### getSchema()
+
+> **getSchema**(): `IEntitySchema`
+
+Get the schema for the entities.
+
+#### Returns
+
+`IEntitySchema`
+
+The schema for the entities.
+
+#### Implementation of
+
+`IEntityStorageConnector.getSchema`
+
+***
+
 ### get()
 
-> **get**(`id`, `secondaryIndex`?): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex`?, `conditions`?): `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.
 
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`undefined` \| `T`\>
@@ -104,16 +128,24 @@ The object if it can be found or undefined.
 
 ### set()
 
-> **set**(`entity`): `Promise`\<`void`\>
+> **set**(`entity`, `conditions`?): `Promise`\<`void`\>
 
 Set an entity.
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to set.
 
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -128,16 +160,24 @@ The id of the entity.
 
 ### remove()
 
-> **remove**(`id`): `Promise`\<`void`\>
+> **remove**(`id`, `conditions`?): `Promise`\<`void`\>
 
 Remove the entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to remove.
 
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -152,51 +192,49 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
 
 Find all the entities which match the conditions.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<`T`\>
+##### conditions?
+
+`EntityCondition`\<`T`\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### sortProperties?
+
+`object`[]
 
 The optional sort order.
 
-• **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.
 
 #### 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
 
 `IEntityStorageConnector.query`

package/docs/reference/index.md

@@ -7,3 +7,4 @@
 ## Interfaces
 
 - [IFileEntityStorageConnectorConfig](interfaces/IFileEntityStorageConnectorConfig.md)
+- [IFileEntityStorageConnectorConstructorOptions](interfaces/IFileEntityStorageConnectorConstructorOptions.md)

package/docs/reference/interfaces/IFileEntityStorageConnectorConstructorOptions.md

@@ -0,0 +1,19 @@
+# Interface: IFileEntityStorageConnectorConstructorOptions
+
+Options for the File Entity Storage Connector constructor.
+
+## Properties
+
+### entitySchema
+
+> **entitySchema**: `string`
+
+The name of the entity schema.
+
+***
+
+### config
+
+> **config**: [`IFileEntityStorageConnectorConfig`](IFileEntityStorageConnectorConfig.md)
+
+The configuration for the connector.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-file",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.21",
 	"description": "Entity Storage connector implementation using file storage",
 	"repository": {
 		"type": "git",
@@ -13,54 +13,23 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage docs/reference",
-		"build": "tspc",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.1-next.2",
+		"@twin.org/entity-storage-models": "0.0.1-next.21",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},
-	"devDependencies": {
-		"@twin.org/entity-storage-connector-memory": "0.0.1-next.2",
-		"@twin.org/logging-connector-entity-storage": "next",
-		"@twin.org/nameof-transformer": "next",
-		"@types/node": "22.5.5",
-		"@vitest/coverage-v8": "2.1.1",
-		"copyfiles": "2.4.1",
-		"dotenv": "16.4.5",
-		"rimraf": "6.0.1",
-		"rollup": "4.21.3",
-		"rollup-plugin-copy": "3.5.0",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
-	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"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",