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

package/README.md

@@ -13,7 +13,7 @@ npm install @twin.org/entity-storage-connector-postgresql
 The tests developed are functional tests and need an instance of PostgreSql up and running. To run PostgreSql locally:
 
 ```sh
-docker run -p 5432:5432 --name twin-entity-storage-postgresql --hostname postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=password -d postgres
+docker run -p 5444:5432 --name twin-entity-storage-postgresql --hostname postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=password -d postgres
 ```
 
 Afterwards you can run the tests as follows:

package/dist/cjs/index.cjs

@@ -2,7 +2,6 @@
 
 var core = require('@twin.org/core');
 var entity = require('@twin.org/entity');
-var loggingModels = require('@twin.org/logging-models');
 var postgres = require('postgres');
 
 // Copyright 2024 IOTA Stiftung.
@@ -12,14 +11,14 @@ var postgres = require('postgres');
  */
 class PostgreSqlEntityStorageConnector {
     /**
-     * Limit the number of entities when finding.
-     * @internal
+     * Runtime name for the class.
      */
-    static _PAGE_SIZE = 40;
+    static CLASS_NAME = "PostgreSqlEntityStorageConnector";
     /**
-     * Runtime name for the class.
+     * Limit the number of entities when finding.
+     * @internal
      */
-    CLASS_NAME = "PostgreSqlEntityStorageConnector";
+    static _DEFAULT_LIMIT = 40;
     /**
      * The schema for the entity.
      * @internal
@@ -40,33 +39,33 @@ class PostgreSqlEntityStorageConnector {
      * @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.host", options.config.host);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.user", options.config.user);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.password", options.config.password);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.database", options.config.database);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.tableName", options.config.tableName);
+        core.Guards.object(PostgreSqlEntityStorageConnector.CLASS_NAME, "options", options);
+        core.Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        core.Guards.object(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config", options.config);
+        core.Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config.host", options.config.host);
+        core.Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config.user", options.config.user);
+        core.Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config.password", options.config.password);
+        core.Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config.database", options.config.database);
+        core.Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config.tableName", options.config.tableName);
         this._entitySchema = entity.EntitySchemaFactory.get(options.entitySchema);
         this._config = options.config;
     }
     /**
      * Initialize the PostgreSql environment.
-     * @param nodeLoggingConnectorType Optional type of the logging connector.
+     * @param nodeLoggingComponentType Optional type of the logging component.
      * @returns A promise that resolves to a boolean indicating success.
      */
-    async bootstrap(nodeLoggingConnectorType) {
-        const nodeLogging = loggingModels.LoggingConnectorFactory.getIfExists(nodeLoggingConnectorType ?? "node-logging");
+    async bootstrap(nodeLoggingComponentType) {
+        const nodeLogging = core.ComponentFactory.getIfExists(nodeLoggingComponentType);
         try {
             const dbConnection = await this.createConnection();
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: PostgreSqlEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseCreating",
                 data: {
-                    database: this._config.database
+                    databaseName: this._config.database
                 }
             });
             const res = await dbConnection.unsafe(`SELECT datname FROM pg_catalog.pg_database WHERE datname = '${this._config.database}'`);
@@ -75,11 +74,11 @@ class PostgreSqlEntityStorageConnector {
             }
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: PostgreSqlEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseExists",
                 data: {
-                    database: this._config.database
+                    databaseName: this._config.database
                 }
             });
             const tableExistsQuery = `SELECT to_regclass('${this._config.tableName}')`;
@@ -90,28 +89,25 @@ class PostgreSqlEntityStorageConnector {
             }
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: PostgreSqlEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "tableExists",
                 data: {
-                    table: this._config.tableName
+                    tableName: this._config.tableName
                 }
             });
         }
         catch (error) {
-            const errors = error instanceof AggregateError ? error.errors : [error];
-            for (const err of errors) {
-                await nodeLogging?.log({
-                    level: "error",
-                    source: this.CLASS_NAME,
-                    ts: Date.now(),
-                    message: "databaseCreateFailed",
-                    error: core.BaseError.fromError(err),
-                    data: {
-                        database: this._config.database
-                    }
-                });
-            }
+            await nodeLogging?.log({
+                level: "error",
+                source: PostgreSqlEntityStorageConnector.CLASS_NAME,
+                ts: Date.now(),
+                message: "databaseCreateFailed",
+                error: core.BaseError.fromError(error),
+                data: {
+                    databaseName: this._config.database
+                }
+            });
             return false;
         }
         return true;
@@ -131,7 +127,7 @@ class PostgreSqlEntityStorageConnector {
      * @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(PostgreSqlEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const dbConnection = await this.createConnection();
             const whereClauses = [];
@@ -175,7 +171,7 @@ class PostgreSqlEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "getFailed", {
+            throw new core.GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "getFailed", {
                 id
             }, err);
         }
@@ -188,7 +184,7 @@ class PostgreSqlEntityStorageConnector {
      * @returns The id of the entity.
      */
     async set(entity$1, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        core.Guards.object(PostgreSqlEntityStorageConnector.CLASS_NAME, "entity", entity$1);
         entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
         const primaryKey = entity.EntitySchemaHelper.getPrimaryKey(this.getSchema());
         const id = entity$1[primaryKey.property];
@@ -212,7 +208,7 @@ class PostgreSqlEntityStorageConnector {
                 .join(", ")};`, values);
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "setFailed", {
+            throw new core.GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "setFailed", {
                 id
             }, err);
         }
@@ -224,7 +220,7 @@ class PostgreSqlEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const dbConnection = await this.createConnection();
             const itemData = await this.get(id);
@@ -243,7 +239,7 @@ class PostgreSqlEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "removeFailed", {
+            throw new core.GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "removeFailed", {
                 id
             }, err);
         }
@@ -253,15 +249,15 @@ class PostgreSqlEntityStorageConnector {
      * @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) {
         const sql = "";
         try {
-            const returnSize = pageSize ?? PostgreSqlEntityStorageConnector._PAGE_SIZE;
+            const returnSize = limit ?? PostgreSqlEntityStorageConnector._DEFAULT_LIMIT;
             let orderByClause = "";
             if (Array.isArray(sortProperties)) {
                 const orderClauses = [];
@@ -305,7 +301,7 @@ class PostgreSqlEntityStorageConnector {
             };
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "queryFailed", { sql }, err);
+            throw new core.GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "queryFailed", { sql }, err);
         }
     }
     /**
@@ -436,7 +432,7 @@ class PostgreSqlEntityStorageConnector {
         else if (comparator.comparison === entity.ComparisonOperator.Includes) {
             return `EXISTS (SELECT 1 FROM jsonb_array_elements("${prop}") elem WHERE elem @> $${values.length}::jsonb)`;
         }
-        throw new core.GeneralError(this.CLASS_NAME, "comparisonNotSupported", {
+        throw new core.GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "comparisonNotSupported", {
             comparison: comparator.comparison
         });
     }
@@ -479,7 +475,9 @@ class PostgreSqlEntityStorageConnector {
         else if (operator === entity.LogicalOperator.Or) {
             return "OR";
         }
-        throw new core.GeneralError(this.CLASS_NAME, "conditionalNotSupported", { operator });
+        throw new core.GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "conditionalNotSupported", {
+            operator
+        });
     }
     /**
      * Verify the conditions for the entity.
@@ -505,7 +503,7 @@ class PostgreSqlEntityStorageConnector {
             [entity.EntitySchemaPropertyType.Boolean]: "BOOLEAN"
         };
         if (!entitySchema.properties) {
-            throw new core.GeneralError(this.CLASS_NAME, "entitySchemaPropertiesUndefined");
+            throw new core.GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "entitySchemaPropertiesUndefined");
         }
         const primaryKeys = [];
         const columnDefinitions = entitySchema.properties

package/dist/esm/index.mjs

@@ -1,6 +1,5 @@
-import { Guards, BaseError, GeneralError, Is, ObjectHelper } from '@twin.org/core';
+import { Guards, ComponentFactory, BaseError, GeneralError, Is, ObjectHelper } from '@twin.org/core';
 import { EntitySchemaFactory, EntitySchemaHelper, EntitySchemaPropertyType, SortDirection, ComparisonOperator, LogicalOperator } from '@twin.org/entity';
-import { LoggingConnectorFactory } from '@twin.org/logging-models';
 import postgres from 'postgres';
 
 // Copyright 2024 IOTA Stiftung.
@@ -10,14 +9,14 @@ import postgres from 'postgres';
  */
 class PostgreSqlEntityStorageConnector {
     /**
-     * Limit the number of entities when finding.
-     * @internal
+     * Runtime name for the class.
      */
-    static _PAGE_SIZE = 40;
+    static CLASS_NAME = "PostgreSqlEntityStorageConnector";
     /**
-     * Runtime name for the class.
+     * Limit the number of entities when finding.
+     * @internal
      */
-    CLASS_NAME = "PostgreSqlEntityStorageConnector";
+    static _DEFAULT_LIMIT = 40;
     /**
      * The schema for the entity.
      * @internal
@@ -38,33 +37,33 @@ class PostgreSqlEntityStorageConnector {
      * @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.host", options.config.host);
-        Guards.stringValue(this.CLASS_NAME, "options.config.user", options.config.user);
-        Guards.stringValue(this.CLASS_NAME, "options.config.password", options.config.password);
-        Guards.stringValue(this.CLASS_NAME, "options.config.database", options.config.database);
-        Guards.stringValue(this.CLASS_NAME, "options.config.tableName", options.config.tableName);
+        Guards.object(PostgreSqlEntityStorageConnector.CLASS_NAME, "options", options);
+        Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        Guards.object(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config", options.config);
+        Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config.host", options.config.host);
+        Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config.user", options.config.user);
+        Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config.password", options.config.password);
+        Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config.database", options.config.database);
+        Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "options.config.tableName", options.config.tableName);
         this._entitySchema = EntitySchemaFactory.get(options.entitySchema);
         this._config = options.config;
     }
     /**
      * Initialize the PostgreSql environment.
-     * @param nodeLoggingConnectorType Optional type of the logging connector.
+     * @param nodeLoggingComponentType Optional type of the logging component.
      * @returns A promise that resolves to a boolean indicating success.
      */
-    async bootstrap(nodeLoggingConnectorType) {
-        const nodeLogging = LoggingConnectorFactory.getIfExists(nodeLoggingConnectorType ?? "node-logging");
+    async bootstrap(nodeLoggingComponentType) {
+        const nodeLogging = ComponentFactory.getIfExists(nodeLoggingComponentType);
         try {
             const dbConnection = await this.createConnection();
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: PostgreSqlEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseCreating",
                 data: {
-                    database: this._config.database
+                    databaseName: this._config.database
                 }
             });
             const res = await dbConnection.unsafe(`SELECT datname FROM pg_catalog.pg_database WHERE datname = '${this._config.database}'`);
@@ -73,11 +72,11 @@ class PostgreSqlEntityStorageConnector {
             }
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: PostgreSqlEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseExists",
                 data: {
-                    database: this._config.database
+                    databaseName: this._config.database
                 }
             });
             const tableExistsQuery = `SELECT to_regclass('${this._config.tableName}')`;
@@ -88,28 +87,25 @@ class PostgreSqlEntityStorageConnector {
             }
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: PostgreSqlEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "tableExists",
                 data: {
-                    table: this._config.tableName
+                    tableName: this._config.tableName
                 }
             });
         }
         catch (error) {
-            const errors = error instanceof AggregateError ? error.errors : [error];
-            for (const err of errors) {
-                await nodeLogging?.log({
-                    level: "error",
-                    source: this.CLASS_NAME,
-                    ts: Date.now(),
-                    message: "databaseCreateFailed",
-                    error: BaseError.fromError(err),
-                    data: {
-                        database: this._config.database
-                    }
-                });
-            }
+            await nodeLogging?.log({
+                level: "error",
+                source: PostgreSqlEntityStorageConnector.CLASS_NAME,
+                ts: Date.now(),
+                message: "databaseCreateFailed",
+                error: BaseError.fromError(error),
+                data: {
+                    databaseName: this._config.database
+                }
+            });
             return false;
         }
         return true;
@@ -129,7 +125,7 @@ class PostgreSqlEntityStorageConnector {
      * @returns The object if it can be found or undefined.
      */
     async get(id, secondaryIndex, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const dbConnection = await this.createConnection();
             const whereClauses = [];
@@ -173,7 +169,7 @@ class PostgreSqlEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "getFailed", {
+            throw new GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "getFailed", {
                 id
             }, err);
         }
@@ -186,7 +182,7 @@ class PostgreSqlEntityStorageConnector {
      * @returns The id of the entity.
      */
     async set(entity, conditions) {
-        Guards.object(this.CLASS_NAME, "entity", entity);
+        Guards.object(PostgreSqlEntityStorageConnector.CLASS_NAME, "entity", entity);
         EntitySchemaHelper.validateEntity(entity, this.getSchema());
         const primaryKey = EntitySchemaHelper.getPrimaryKey(this.getSchema());
         const id = entity[primaryKey.property];
@@ -210,7 +206,7 @@ class PostgreSqlEntityStorageConnector {
                 .join(", ")};`, values);
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "setFailed", {
+            throw new GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "setFailed", {
                 id
             }, err);
         }
@@ -222,7 +218,7 @@ class PostgreSqlEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(PostgreSqlEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const dbConnection = await this.createConnection();
             const itemData = await this.get(id);
@@ -241,7 +237,7 @@ class PostgreSqlEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "removeFailed", {
+            throw new GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "removeFailed", {
                 id
             }, err);
         }
@@ -251,15 +247,15 @@ class PostgreSqlEntityStorageConnector {
      * @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) {
         const sql = "";
         try {
-            const returnSize = pageSize ?? PostgreSqlEntityStorageConnector._PAGE_SIZE;
+            const returnSize = limit ?? PostgreSqlEntityStorageConnector._DEFAULT_LIMIT;
             let orderByClause = "";
             if (Array.isArray(sortProperties)) {
                 const orderClauses = [];
@@ -303,7 +299,7 @@ class PostgreSqlEntityStorageConnector {
             };
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "queryFailed", { sql }, err);
+            throw new GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "queryFailed", { sql }, err);
         }
     }
     /**
@@ -434,7 +430,7 @@ class PostgreSqlEntityStorageConnector {
         else if (comparator.comparison === ComparisonOperator.Includes) {
             return `EXISTS (SELECT 1 FROM jsonb_array_elements("${prop}") elem WHERE elem @> $${values.length}::jsonb)`;
         }
-        throw new GeneralError(this.CLASS_NAME, "comparisonNotSupported", {
+        throw new GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "comparisonNotSupported", {
             comparison: comparator.comparison
         });
     }
@@ -477,7 +473,9 @@ class PostgreSqlEntityStorageConnector {
         else if (operator === LogicalOperator.Or) {
             return "OR";
         }
-        throw new GeneralError(this.CLASS_NAME, "conditionalNotSupported", { operator });
+        throw new GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "conditionalNotSupported", {
+            operator
+        });
     }
     /**
      * Verify the conditions for the entity.
@@ -503,7 +501,7 @@ class PostgreSqlEntityStorageConnector {
             [EntitySchemaPropertyType.Boolean]: "BOOLEAN"
         };
         if (!entitySchema.properties) {
-            throw new GeneralError(this.CLASS_NAME, "entitySchemaPropertiesUndefined");
+            throw new GeneralError(PostgreSqlEntityStorageConnector.CLASS_NAME, "entitySchemaPropertiesUndefined");
         }
         const primaryKeys = [];
         const columnDefinitions = entitySchema.properties

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

@@ -8,10 +8,10 @@ export interface IPostgreSqlEntityStorageConnectorConstructorOptions {
      */
     entitySchema: string;
     /**
-     * The type of logging connector to use.
+     * The type of logging component to use.
      * @default logging
      */
-    loggingConnectorType?: string;
+    loggingComponentType?: string;
     /**
      * The configuration for the connector.
      */

package/dist/types/postgreSqlEntityStorageConnector.d.ts

@@ -8,7 +8,7 @@ export declare class PostgreSqlEntityStorageConnector<T = unknown> implements IE
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of PostgreSqlEntityStorageConnector.
      * @param options The options for the connector.
@@ -16,10 +16,10 @@ export declare class PostgreSqlEntityStorageConnector<T = unknown> implements IE
     constructor(options: IPostgreSqlEntityStorageConnectorConstructorOptions);
     /**
      * Initialize the PostgreSql environment.
-     * @param nodeLoggingConnectorType Optional type of the logging connector.
+     * @param nodeLoggingComponentType Optional type of the logging component.
      * @returns A promise that resolves to a boolean indicating success.
      */
-    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 PostgreSqlEntityStorageConnector<T = unknown> implements IE
      * @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<{
         entities: Partial<T>[];
         cursor?: string;
     }>;

package/docs/changelog.md

@@ -1,5 +1,149 @@
 # @twin.org/entity-storage-connector-postgresql - Changelog
 
+## [0.0.2-next.10](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.9...entity-storage-connector-postgresql-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-postgresql-v0.0.2-next.8...entity-storage-connector-postgresql-v0.0.2-next.9) (2025-10-02)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-postgresql:** 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-postgresql-v0.0.2-next.7...entity-storage-connector-postgresql-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-postgresql-v0.0.2-next.6...entity-storage-connector-postgresql-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-postgresql-v0.0.2-next.5...entity-storage-connector-postgresql-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-postgresql-v0.0.2-next.4...entity-storage-connector-postgresql-v0.0.2-next.5) (2025-08-11)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-postgresql:** 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-postgresql-v0.0.2-next.3...entity-storage-connector-postgresql-v0.0.2-next.4) (2025-08-08)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-postgresql:** 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-postgresql-v0.0.2-next.2...entity-storage-connector-postgresql-v0.0.2-next.3) (2025-07-25)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-postgresql:** 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-postgresql-v0.0.2-next.1...entity-storage-connector-postgresql-v0.0.2-next.2) (2025-07-24)
+
+
+### Features
+
+* synchronised storage ([#44](https://github.com/twinfoundation/entity-storage/issues/44)) ([94e10e2](https://github.com/twinfoundation/entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
+
+
+### 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-postgresql-v0.0.2-next.0...entity-storage-connector-postgresql-v0.0.2-next.1) (2025-07-17)
 
 

package/docs/reference/classes/PostgreSqlEntityStorageConnector.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`\>
 
 Initialize the PostgreSql environment.
 
 #### Parameters
 
-##### nodeLoggingConnectorType?
+##### nodeLoggingComponentType?
 
 `string`
 
-Optional type of the logging connector.
+Optional type of the logging component.
 
 #### 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/docs/reference/interfaces/IPostgreSqlEntityStorageConnectorConstructorOptions.md

@@ -12,11 +12,11 @@ The schema for the entity.
 
 ***
 
-### loggingConnectorType?
+### loggingComponentType?
 
-> `optional` **loggingConnectorType**: `string`
+> `optional` **loggingComponentType**: `string`
 
-The type of logging connector to use.
+The type of logging component to use.
 
 #### Default
 

package/locales/en.json

@@ -8,14 +8,14 @@
 	},
 	"error": {
 		"postgreSqlEntityStorageConnector": {
+			"databaseCreateFailed": "Unable to create database \"{databaseName}\"",
 			"setFailed": "Unable to set entity \"{id}\"",
 			"getFailed": "Unable to get entity \"{id}\"",
 			"removeFailed": "Unable to remove entity \"{id}\"",
 			"queryFailed": "The query failed",
 			"comparisonNotSupported": "Comparison operator \"{comparison}\" is not supported",
 			"conditionalNotSupported": "Conditional operator \"{operator}\" is not supported",
-			"sortSingle": "You can only sort by a single property",
-			"sortNotIndexed": "The property \"{property}\" is not indexed and cannot be used for sorting"
+			"entitySchemaPropertiesUndefined": "The entity schema properties are undefined"
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-postgresql",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.10",
 	"description": "Entity Storage connector implementation using PostgreSql 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",
 		"postgres": "3.4.7"
@@ -38,5 +38,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"
 }