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

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);
@@ -129,15 +127,16 @@ class FileEntityStorageConnector {
      * @param conditions The optional conditions to match for the entities.
      * @returns The id of the entity.
      */
-    async set(entity, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity);
+    async set(entity$1, conditions) {
+        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
         const store = await this.readStore();
-        const existingIndex = this.findItem(store, entity[this._primaryKey.property], undefined, conditions);
+        const existingIndex = this.findItem(store, entity$1[this._primaryKey.property], undefined, conditions);
         if (existingIndex >= 0) {
-            store[existingIndex] = entity;
+            store[existingIndex] = entity$1;
         }
         else {
-            store.push(entity);
+            store.push(entity$1);
         }
         await this.writeStore(store);
     }
@@ -179,7 +178,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;
                     }
                 }
             }

package/dist/esm/index.mjs

@@ -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);
@@ -129,6 +127,7 @@ class FileEntityStorageConnector {
      */
     async set(entity, conditions) {
         Guards.object(this.CLASS_NAME, "entity", entity);
+        EntitySchemaHelper.validateEntity(entity, this.getSchema());
         const store = await this.readStore();
         const existingIndex = this.findItem(store, entity[this._primaryKey.property], undefined, conditions);
         if (existingIndex >= 0) {
@@ -177,7 +176,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;
                     }
                 }
             }

package/dist/types/fileEntityStorageConnector.d.ts

@@ -1,6 +1,6 @@
 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,13 +12,8 @@ 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".

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,132 @@
 # @twin.org/entity-storage-connector-file - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.2-next.0...entity-storage-connector-file-v0.0.2-next.1) (2025-07-17)
+
+
+### Features
+
+* add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+* use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
+
+
+### Bug Fixes
+
+* query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.0 to 0.0.2-next.1
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.0 to 0.0.2-next.1
+
+## 0.0.1 (2025-07-04)
+
+
+### Features
+
+* add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
+* release to production ([a309051](https://github.com/twinfoundation/entity-storage/commit/a3090519adebf7943232b4df12e4c6bd5afe7eed))
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+* use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
+
+
+### Bug Fixes
+
+* query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from ^0.0.0 to ^0.0.1
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.31](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.1-next.30...entity-storage-connector-file-v0.0.1-next.31) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.30 to 0.0.1-next.31
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.30 to 0.0.1-next.31
+
+## [0.0.1-next.30](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.1-next.29...entity-storage-connector-file-v0.0.1-next.30) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.1-next.28...entity-storage-connector-file-v0.0.1-next.29) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## [0.0.1-next.28](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.1-next.27...entity-storage-connector-file-v0.0.1-next.28) (2025-04-09)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-file:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.27 to 0.0.1-next.28
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.27 to 0.0.1-next.28
+
+## [0.0.1-next.27](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.1-next.26...entity-storage-connector-file-v0.0.1-next.27) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-file:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.26 to 0.0.1-next.27
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.26 to 0.0.1-next.27
+
+## v0.0.1-next.26
 
 - Initial Release

package/docs/reference/classes/FileEntityStorageConnector.md

@@ -4,7 +4,9 @@ Class for performing entity storage operations in file.
 
 ## Type Parameters
 
-• **T** = `unknown`
+### T
+
+`T` = `unknown`
 
 ## Implements
 
@@ -12,29 +14,23 @@ Class for performing entity storage operations in file.
 
 ## Constructors
 
-### new FileEntityStorageConnector()
+### Constructor
 
-> **new FileEntityStorageConnector**\<`T`\>(`options`): [`FileEntityStorageConnector`](FileEntityStorageConnector.md)\<`T`\>
+> **new FileEntityStorageConnector**\<`T`\>(`options`): `FileEntityStorageConnector`\<`T`\>
 
 Create a new instance of FileEntityStorageConnector.
 
 #### Parameters
 
-• **options**
-
-The options for the connector.
-
-• **options.entitySchema**: `string`
+##### options
 
-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
 
-[`FileEntityStorageConnector`](FileEntityStorageConnector.md)\<`T`\>
+`FileEntityStorageConnector`\<`T`\>
 
 ## Properties
 
@@ -52,13 +48,15 @@ Runtime name for the class.
 
 ### bootstrap()
 
-> **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
+> **bootstrap**(`nodeLoggingConnectorType?`): `Promise`\<`boolean`\>
 
 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".
 
@@ -76,13 +74,13 @@ True if the bootstrapping process was successful.
 
 ### getSchema()
 
-> **getSchema**(): `IEntitySchema`\<`unknown`\>
+> **getSchema**(): `IEntitySchema`
 
 Get the schema for the entities.
 
 #### Returns
 
-`IEntitySchema`\<`unknown`\>
+`IEntitySchema`
 
 The schema for the entities.
 
@@ -94,21 +92,27 @@ The schema for the entities.
 
 ### get()
 
-> **get**(`id`, `secondaryIndex`?, `conditions`?): `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`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -126,17 +130,21 @@ The object if it can be found or undefined.
 
 ### set()
 
-> **set**(`entity`, `conditions`?): `Promise`\<`void`\>
+> **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
 Set an entity.
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to set.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -154,17 +162,21 @@ The id of the entity.
 
 ### remove()
 
-> **remove**(`id`, `conditions`?): `Promise`\<`void`\>
+> **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
 Remove the entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to remove.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -182,51 +194,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.9",
+	"version": "0.0.2-next.1",
 	"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.9",
+		"@twin.org/entity-storage-models": "0.0.2-next.1",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},
@@ -25,11 +25,11 @@
 	"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",