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

package/dist/cjs/index.cjs

@@ -4,7 +4,6 @@ var promises = require('node:fs/promises');
 var path = require('node:path');
 var core = require('@twin.org/core');
 var entity = require('@twin.org/entity');
-var loggingModels = require('@twin.org/logging-models');
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -13,14 +12,14 @@ var loggingModels = require('@twin.org/logging-models');
  */
 class FileEntityStorageConnector {
     /**
-     * Default Page Size for cursor.
-     * @internal
+     * Runtime name for the class.
      */
-    static _DEFAULT_PAGE_SIZE = 20;
+    static CLASS_NAME = "FileEntityStorageConnector";
     /**
-     * Runtime name for the class.
+     * Default limit for number of items to return.
+     * @internal
      */
-    CLASS_NAME = "FileEntityStorageConnector";
+    static _DEFAULT_LIMIT = 20;
     /**
      * The schema for the entity.
      * @internal
@@ -41,25 +40,25 @@ class FileEntityStorageConnector {
      * @param options The options for the connector.
      */
     constructor(options) {
-        core.Guards.object(this.CLASS_NAME, "options", options);
-        core.Guards.stringValue(this.CLASS_NAME, "options.entitySchema", options.entitySchema);
-        core.Guards.object(this.CLASS_NAME, "options.config", options.config);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.directory", options.config.directory);
+        core.Guards.object(FileEntityStorageConnector.CLASS_NAME, "options", options);
+        core.Guards.stringValue(FileEntityStorageConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        core.Guards.object(FileEntityStorageConnector.CLASS_NAME, "options.config", options.config);
+        core.Guards.stringValue(FileEntityStorageConnector.CLASS_NAME, "options.config.directory", options.config.directory);
         this._entitySchema = entity.EntitySchemaFactory.get(options.entitySchema);
         this._primaryKey = entity.EntitySchemaHelper.getPrimaryKey(this._entitySchema);
         this._directory = path.resolve(options.config.directory);
     }
     /**
      * Bootstrap the connector by creating and initializing any resources it needs.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns True if the bootstrapping process was successful.
      */
-    async bootstrap(nodeLoggingConnectorType) {
-        const nodeLogging = loggingModels.LoggingConnectorFactory.getIfExists(nodeLoggingConnectorType ?? "node-logging");
+    async bootstrap(nodeLoggingComponentType) {
+        const nodeLogging = core.ComponentFactory.getIfExists(nodeLoggingComponentType);
         if (!(await this.dirExists(this._directory))) {
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: FileEntityStorageConnector.CLASS_NAME,
                 message: "directoryCreating",
                 data: {
                     directory: this._directory
@@ -69,7 +68,7 @@ class FileEntityStorageConnector {
                 await promises.mkdir(this._directory, { recursive: true });
                 await nodeLogging?.log({
                     level: "info",
-                    source: this.CLASS_NAME,
+                    source: FileEntityStorageConnector.CLASS_NAME,
                     message: "directoryCreated",
                     data: {
                         directory: this._directory
@@ -79,7 +78,7 @@ class FileEntityStorageConnector {
             catch (err) {
                 await nodeLogging?.log({
                     level: "error",
-                    source: this.CLASS_NAME,
+                    source: FileEntityStorageConnector.CLASS_NAME,
                     message: "directoryCreateFailed",
                     data: {
                         directory: this._directory
@@ -92,7 +91,7 @@ class FileEntityStorageConnector {
         else {
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: FileEntityStorageConnector.CLASS_NAME,
                 message: "directoryExists",
                 data: {
                     directory: this._directory
@@ -116,7 +115,7 @@ class FileEntityStorageConnector {
      * @returns The object if it can be found or undefined.
      */
     async get(id, secondaryIndex, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(FileEntityStorageConnector.CLASS_NAME, "id", id);
         const store = await this.readStore();
         const foundIndex = this.findItem(store, id, secondaryIndex, conditions);
         return foundIndex === -1 ? undefined : store[foundIndex];
@@ -128,7 +127,7 @@ class FileEntityStorageConnector {
      * @returns The id of the entity.
      */
     async set(entity$1, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        core.Guards.object(FileEntityStorageConnector.CLASS_NAME, "entity", entity$1);
         entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
         const store = await this.readStore();
         const existingIndex = this.findItem(store, entity$1[this._primaryKey.property], undefined, conditions);
@@ -147,7 +146,7 @@ class FileEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(FileEntityStorageConnector.CLASS_NAME, "id", id);
         const store = await this.readStore();
         const index = this.findItem(store, id, undefined, conditions);
         if (index >= 0) {
@@ -160,24 +159,24 @@ class FileEntityStorageConnector {
      * @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 cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, properties, cursor, pageSize) {
+    async query(conditions, sortProperties, properties, cursor, limit) {
         let allEntities = await this.readStore();
         const entities = [];
-        const finalPageSize = pageSize ?? FileEntityStorageConnector._DEFAULT_PAGE_SIZE;
+        const finalLimit = limit ?? FileEntityStorageConnector._DEFAULT_LIMIT;
         let nextCursor;
         if (allEntities.length > 0) {
             const finalSortKeys = entity.EntitySchemaHelper.buildSortProperties(this._entitySchema, sortProperties);
             allEntities = entity.EntitySorter.sort(allEntities, finalSortKeys);
             const startIndex = core.Coerce.number(cursor) ?? 0;
             for (let i = startIndex; i < allEntities.length; i++) {
-                if (entity.EntityConditions.check(allEntities[i], conditions) && entities.length < finalPageSize) {
+                if (entity.EntityConditions.check(allEntities[i], conditions) && entities.length < finalLimit) {
                     entities.push(core.ObjectHelper.pick(allEntities[i], properties));
-                    if (entities.length >= finalPageSize) {
+                    if (entities.length >= finalLimit) {
                         if (i < allEntities.length - 1) {
                             nextCursor = (i + 1).toString();
                         }

package/dist/esm/index.mjs

@@ -1,8 +1,7 @@
 import { mkdir, readFile, writeFile, access } from 'node:fs/promises';
 import path from 'node:path';
-import { Guards, BaseError, Coerce, ObjectHelper, Is } from '@twin.org/core';
+import { Guards, ComponentFactory, 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.
 // SPDX-License-Identifier: Apache-2.0.
@@ -11,14 +10,14 @@ import { LoggingConnectorFactory } from '@twin.org/logging-models';
  */
 class FileEntityStorageConnector {
     /**
-     * Default Page Size for cursor.
-     * @internal
+     * Runtime name for the class.
      */
-    static _DEFAULT_PAGE_SIZE = 20;
+    static CLASS_NAME = "FileEntityStorageConnector";
     /**
-     * Runtime name for the class.
+     * Default limit for number of items to return.
+     * @internal
      */
-    CLASS_NAME = "FileEntityStorageConnector";
+    static _DEFAULT_LIMIT = 20;
     /**
      * The schema for the entity.
      * @internal
@@ -39,25 +38,25 @@ class FileEntityStorageConnector {
      * @param options The options for the connector.
      */
     constructor(options) {
-        Guards.object(this.CLASS_NAME, "options", options);
-        Guards.stringValue(this.CLASS_NAME, "options.entitySchema", options.entitySchema);
-        Guards.object(this.CLASS_NAME, "options.config", options.config);
-        Guards.stringValue(this.CLASS_NAME, "options.config.directory", options.config.directory);
+        Guards.object(FileEntityStorageConnector.CLASS_NAME, "options", options);
+        Guards.stringValue(FileEntityStorageConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        Guards.object(FileEntityStorageConnector.CLASS_NAME, "options.config", options.config);
+        Guards.stringValue(FileEntityStorageConnector.CLASS_NAME, "options.config.directory", options.config.directory);
         this._entitySchema = EntitySchemaFactory.get(options.entitySchema);
         this._primaryKey = EntitySchemaHelper.getPrimaryKey(this._entitySchema);
         this._directory = path.resolve(options.config.directory);
     }
     /**
      * Bootstrap the connector by creating and initializing any resources it needs.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns True if the bootstrapping process was successful.
      */
-    async bootstrap(nodeLoggingConnectorType) {
-        const nodeLogging = LoggingConnectorFactory.getIfExists(nodeLoggingConnectorType ?? "node-logging");
+    async bootstrap(nodeLoggingComponentType) {
+        const nodeLogging = ComponentFactory.getIfExists(nodeLoggingComponentType);
         if (!(await this.dirExists(this._directory))) {
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: FileEntityStorageConnector.CLASS_NAME,
                 message: "directoryCreating",
                 data: {
                     directory: this._directory
@@ -67,7 +66,7 @@ class FileEntityStorageConnector {
                 await mkdir(this._directory, { recursive: true });
                 await nodeLogging?.log({
                     level: "info",
-                    source: this.CLASS_NAME,
+                    source: FileEntityStorageConnector.CLASS_NAME,
                     message: "directoryCreated",
                     data: {
                         directory: this._directory
@@ -77,7 +76,7 @@ class FileEntityStorageConnector {
             catch (err) {
                 await nodeLogging?.log({
                     level: "error",
-                    source: this.CLASS_NAME,
+                    source: FileEntityStorageConnector.CLASS_NAME,
                     message: "directoryCreateFailed",
                     data: {
                         directory: this._directory
@@ -90,7 +89,7 @@ class FileEntityStorageConnector {
         else {
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: FileEntityStorageConnector.CLASS_NAME,
                 message: "directoryExists",
                 data: {
                     directory: this._directory
@@ -114,7 +113,7 @@ class FileEntityStorageConnector {
      * @returns The object if it can be found or undefined.
      */
     async get(id, secondaryIndex, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(FileEntityStorageConnector.CLASS_NAME, "id", id);
         const store = await this.readStore();
         const foundIndex = this.findItem(store, id, secondaryIndex, conditions);
         return foundIndex === -1 ? undefined : store[foundIndex];
@@ -126,7 +125,7 @@ class FileEntityStorageConnector {
      * @returns The id of the entity.
      */
     async set(entity, conditions) {
-        Guards.object(this.CLASS_NAME, "entity", entity);
+        Guards.object(FileEntityStorageConnector.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);
@@ -145,7 +144,7 @@ class FileEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(FileEntityStorageConnector.CLASS_NAME, "id", id);
         const store = await this.readStore();
         const index = this.findItem(store, id, undefined, conditions);
         if (index >= 0) {
@@ -158,24 +157,24 @@ class FileEntityStorageConnector {
      * @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 cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, properties, cursor, pageSize) {
+    async query(conditions, sortProperties, properties, cursor, limit) {
         let allEntities = await this.readStore();
         const entities = [];
-        const finalPageSize = pageSize ?? FileEntityStorageConnector._DEFAULT_PAGE_SIZE;
+        const finalLimit = limit ?? FileEntityStorageConnector._DEFAULT_LIMIT;
         let nextCursor;
         if (allEntities.length > 0) {
             const finalSortKeys = EntitySchemaHelper.buildSortProperties(this._entitySchema, sortProperties);
             allEntities = EntitySorter.sort(allEntities, finalSortKeys);
             const startIndex = Coerce.number(cursor) ?? 0;
             for (let i = startIndex; i < allEntities.length; i++) {
-                if (EntityConditions.check(allEntities[i], conditions) && entities.length < finalPageSize) {
+                if (EntityConditions.check(allEntities[i], conditions) && entities.length < finalLimit) {
                     entities.push(ObjectHelper.pick(allEntities[i], properties));
-                    if (entities.length >= finalPageSize) {
+                    if (entities.length >= finalLimit) {
                         if (i < allEntities.length - 1) {
                             nextCursor = (i + 1).toString();
                         }

package/dist/types/fileEntityStorageConnector.d.ts

@@ -8,7 +8,7 @@ export declare class FileEntityStorageConnector<T = unknown> implements IEntityS
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of FileEntityStorageConnector.
      * @param options The options for the connector.
@@ -16,10 +16,10 @@ export declare class FileEntityStorageConnector<T = unknown> implements IEntityS
     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".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns True if the bootstrapping process was successful.
      */
-    bootstrap(nodeLoggingConnectorType?: string): Promise<boolean>;
+    bootstrap(nodeLoggingComponentType?: string): Promise<boolean>;
     /**
      * Get the schema for the entities.
      * @returns The schema for the entities.
@@ -61,15 +61,15 @@ export declare class FileEntityStorageConnector<T = unknown> implements IEntityS
      * @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 cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
      * @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): Promise<{
+    }[], properties?: (keyof T)[], cursor?: string, limit?: number): Promise<{
         /**
          * The entities, which can be partial if a limited keys list was provided.
          */

package/docs/changelog.md

@@ -1,5 +1,149 @@
 # @twin.org/entity-storage-connector-file - Changelog
 
+## [0.0.2-next.10](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.2-next.9...entity-storage-connector-file-v0.0.2-next.10) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.2-next.8...entity-storage-connector-file-v0.0.2-next.9) (2025-10-02)
+
+
+### 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.2-next.8 to 0.0.2-next.9
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.2-next.7...entity-storage-connector-file-v0.0.2-next.8) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.7 to 0.0.2-next.8
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.7 to 0.0.2-next.8
+
+## [0.0.2-next.7](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.2-next.6...entity-storage-connector-file-v0.0.2-next.7) (2025-08-20)
+
+
+### Features
+
+* logging naming consistency ([f99d12d](https://github.com/twinfoundation/entity-storage/commit/f99d12dea04b6d4f2b5632ff5473e9ec7d5f9055))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.6 to 0.0.2-next.7
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.6 to 0.0.2-next.7
+
+## [0.0.2-next.6](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.2-next.5...entity-storage-connector-file-v0.0.2-next.6) (2025-08-19)
+
+
+### Features
+
+* update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.5 to 0.0.2-next.6
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## [0.0.2-next.5](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.2-next.4...entity-storage-connector-file-v0.0.2-next.5) (2025-08-11)
+
+
+### 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.2-next.4 to 0.0.2-next.5
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.2-next.3...entity-storage-connector-file-v0.0.2-next.4) (2025-08-08)
+
+
+### 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.2-next.3 to 0.0.2-next.4
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [0.0.2-next.3](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.2-next.2...entity-storage-connector-file-v0.0.2-next.3) (2025-07-25)
+
+
+### 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.2-next.2 to 0.0.2-next.3
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.2-next.1...entity-storage-connector-file-v0.0.2-next.2) (2025-07-24)
+
+
+### 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.2-next.1 to 0.0.2-next.2
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.1 to 0.0.2-next.2
+
 ## [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)
 
 

package/docs/reference/classes/FileEntityStorageConnector.md

@@ -36,29 +36,25 @@ The options for the connector.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`IEntityStorageConnector.CLASS_NAME`
-
 ## Methods
 
 ### bootstrap()
 
-> **bootstrap**(`nodeLoggingConnectorType?`): `Promise`\<`boolean`\>
+> **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
 
 Bootstrap the connector by creating and initializing any resources it needs.
 
 #### Parameters
 
-##### nodeLoggingConnectorType?
+##### nodeLoggingComponentType?
 
 `string`
 
-The node logging connector type, defaults to "node-logging".
+The node logging component type.
 
 #### Returns
 
@@ -194,7 +190,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
+> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 Find all the entities which match the conditions.
 
@@ -222,9 +218,9 @@ The optional properties to return, defaults to all.
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-file",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.10",
 	"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.2-next.1",
+		"@twin.org/entity-storage-models": "0.0.2-next.10",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},
@@ -37,5 +37,24 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"entity-storage",
+		"entity",
+		"storage",
+		"persistence",
+		"database",
+		"connector",
+		"adapter",
+		"integration"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/entity-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }