@twin.org/entity-storage-connector-mysql 0.0.1 → 0.0.2-next.10

package/README.md

@@ -13,7 +13,7 @@ npm install @twin.org/entity-storage-connector-mysql
 The tests developed are functional tests and need an instance of MySql up and running. To run MySql locally:
 
 ```sh
-docker run -p 3306:3306 --name twin-entity-storage-mysql --hostname mysql -e MYSQL_ROOT_PASSWORD=password -d mysql:latest
+docker run -p 3400:3306 --name twin-entity-storage-mysql --hostname mysql -e MYSQL_ROOT_PASSWORD=password -d mysql:latest
 ```
 
 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 promise = require('mysql2/promise');
 
 // Copyright 2024 IOTA Stiftung.
@@ -12,14 +11,14 @@ var promise = require('mysql2/promise');
  */
 class MySqlEntityStorageConnector {
     /**
-     * Limit the number of entities when finding.
-     * @internal
+     * Runtime name for the class.
      */
-    static _PAGE_SIZE = 40;
+    static CLASS_NAME = "MySqlEntityStorageConnector";
     /**
-     * Runtime name for the class.
+     * Limit the number of entities when finding.
+     * @internal
      */
-    CLASS_NAME = "MySqlEntityStorageConnector";
+    static _DEFAULT_LIMIT = 40;
     /**
      * The schema for the entity.
      * @internal
@@ -40,71 +39,68 @@ class MySqlEntityStorageConnector {
      * @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(MySqlEntityStorageConnector.CLASS_NAME, "options", options);
+        core.Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        core.Guards.object(MySqlEntityStorageConnector.CLASS_NAME, "options.config", options.config);
+        core.Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.config.host", options.config.host);
+        core.Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.config.user", options.config.user);
+        core.Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.config.password", options.config.password);
+        core.Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.config.database", options.config.database);
+        core.Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.config.tableName", options.config.tableName);
         this._entitySchema = entity.EntitySchemaFactory.get(options.entitySchema);
         this._config = options.config;
     }
     /**
      * Initialize the MySql 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: MySqlEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseCreating",
                 data: {
-                    database: this._config.database
+                    databaseName: this._config.database
                 }
             });
             // Create the database if it does not exist
             await dbConnection.query(`CREATE DATABASE IF NOT EXISTS \`${this._config.database}\``);
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: MySqlEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseExists",
                 data: {
-                    database: this._config.database
+                    databaseName: this._config.database
                 }
             });
             await dbConnection.query(`CREATE TABLE IF NOT EXISTS \`${this._config.database}\`.\`${this._config.tableName}\` (${this.mapMySqlProperties(this._entitySchema)})`);
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: MySqlEntityStorageConnector.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: MySqlEntityStorageConnector.CLASS_NAME,
+                ts: Date.now(),
+                message: "databaseCreateFailed",
+                error: core.BaseError.fromError(error),
+                data: {
+                    databaseName: this._config.database
+                }
+            });
             return false;
         }
         return true;
@@ -124,7 +120,7 @@ class MySqlEntityStorageConnector {
      * @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(MySqlEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const dbConnection = await this.createConnection();
             const whereClauses = [];
@@ -156,7 +152,7 @@ class MySqlEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "getFailed", {
+            throw new core.GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "getFailed", {
                 id
             }, err);
         }
@@ -169,7 +165,7 @@ class MySqlEntityStorageConnector {
      * @returns The id of the entity.
      */
     async set(entity$1, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        core.Guards.object(MySqlEntityStorageConnector.CLASS_NAME, "entity", entity$1);
         entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
         const id = entity$1["id"];
         try {
@@ -199,7 +195,7 @@ class MySqlEntityStorageConnector {
                 .join(", ")};`, values);
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "setFailed", {
+            throw new core.GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "setFailed", {
                 id
             }, err);
         }
@@ -211,7 +207,7 @@ class MySqlEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const dbConnection = await this.createConnection();
             const itemData = await this.get(id);
@@ -229,7 +225,7 @@ class MySqlEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "removeFailed", {
+            throw new core.GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "removeFailed", {
                 id
             }, err);
         }
@@ -239,15 +235,15 @@ class MySqlEntityStorageConnector {
      * @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 ?? MySqlEntityStorageConnector._PAGE_SIZE;
+            const returnSize = limit ?? MySqlEntityStorageConnector._DEFAULT_LIMIT;
             let orderByClause = "";
             if (Array.isArray(sortProperties)) {
                 const orderClauses = [];
@@ -273,7 +269,7 @@ class MySqlEntityStorageConnector {
             };
         }
         catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "queryFailed", { sql }, err);
+            throw new core.GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "queryFailed", { sql }, err);
         }
     }
     /**
@@ -398,7 +394,7 @@ class MySqlEntityStorageConnector {
         else if (comparator.comparison === entity.ComparisonOperator.Includes) {
             return `JSON_CONTAINS(\`${prop}\`, ?)`;
         }
-        throw new core.GeneralError(this.CLASS_NAME, "comparisonNotSupported", {
+        throw new core.GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "comparisonNotSupported", {
             comparison: comparator.comparison
         });
     }
@@ -438,7 +434,9 @@ class MySqlEntityStorageConnector {
         else if (operator === entity.LogicalOperator.Or) {
             return "OR";
         }
-        throw new core.GeneralError(this.CLASS_NAME, "conditionalNotSupported", { operator });
+        throw new core.GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "conditionalNotSupported", {
+            operator
+        });
     }
     /**
      * Verify the conditions for the entity.
@@ -464,7 +462,7 @@ class MySqlEntityStorageConnector {
             [entity.EntitySchemaPropertyType.Boolean]: "TINYINT(1)"
         };
         if (!entitySchema.properties) {
-            throw new core.GeneralError(this.CLASS_NAME, "entitySchemaPropertiesUndefined");
+            throw new core.GeneralError(MySqlEntityStorageConnector.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 { createConnection } from 'mysql2/promise';
 
 // Copyright 2024 IOTA Stiftung.
@@ -10,14 +9,14 @@ import { createConnection } from 'mysql2/promise';
  */
 class MySqlEntityStorageConnector {
     /**
-     * Limit the number of entities when finding.
-     * @internal
+     * Runtime name for the class.
      */
-    static _PAGE_SIZE = 40;
+    static CLASS_NAME = "MySqlEntityStorageConnector";
     /**
-     * Runtime name for the class.
+     * Limit the number of entities when finding.
+     * @internal
      */
-    CLASS_NAME = "MySqlEntityStorageConnector";
+    static _DEFAULT_LIMIT = 40;
     /**
      * The schema for the entity.
      * @internal
@@ -38,71 +37,68 @@ class MySqlEntityStorageConnector {
      * @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(MySqlEntityStorageConnector.CLASS_NAME, "options", options);
+        Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        Guards.object(MySqlEntityStorageConnector.CLASS_NAME, "options.config", options.config);
+        Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.config.host", options.config.host);
+        Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.config.user", options.config.user);
+        Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.config.password", options.config.password);
+        Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.config.database", options.config.database);
+        Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "options.config.tableName", options.config.tableName);
         this._entitySchema = EntitySchemaFactory.get(options.entitySchema);
         this._config = options.config;
     }
     /**
      * Initialize the MySql 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: MySqlEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseCreating",
                 data: {
-                    database: this._config.database
+                    databaseName: this._config.database
                 }
             });
             // Create the database if it does not exist
             await dbConnection.query(`CREATE DATABASE IF NOT EXISTS \`${this._config.database}\``);
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: MySqlEntityStorageConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "databaseExists",
                 data: {
-                    database: this._config.database
+                    databaseName: this._config.database
                 }
             });
             await dbConnection.query(`CREATE TABLE IF NOT EXISTS \`${this._config.database}\`.\`${this._config.tableName}\` (${this.mapMySqlProperties(this._entitySchema)})`);
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: MySqlEntityStorageConnector.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: MySqlEntityStorageConnector.CLASS_NAME,
+                ts: Date.now(),
+                message: "databaseCreateFailed",
+                error: BaseError.fromError(error),
+                data: {
+                    databaseName: this._config.database
+                }
+            });
             return false;
         }
         return true;
@@ -122,7 +118,7 @@ class MySqlEntityStorageConnector {
      * @returns The object if it can be found or undefined.
      */
     async get(id, secondaryIndex, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const dbConnection = await this.createConnection();
             const whereClauses = [];
@@ -154,7 +150,7 @@ class MySqlEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "getFailed", {
+            throw new GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "getFailed", {
                 id
             }, err);
         }
@@ -167,7 +163,7 @@ class MySqlEntityStorageConnector {
      * @returns The id of the entity.
      */
     async set(entity, conditions) {
-        Guards.object(this.CLASS_NAME, "entity", entity);
+        Guards.object(MySqlEntityStorageConnector.CLASS_NAME, "entity", entity);
         EntitySchemaHelper.validateEntity(entity, this.getSchema());
         const id = entity["id"];
         try {
@@ -197,7 +193,7 @@ class MySqlEntityStorageConnector {
                 .join(", ")};`, values);
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "setFailed", {
+            throw new GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "setFailed", {
                 id
             }, err);
         }
@@ -209,7 +205,7 @@ class MySqlEntityStorageConnector {
      * @returns Nothing.
      */
     async remove(id, conditions) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(MySqlEntityStorageConnector.CLASS_NAME, "id", id);
         try {
             const dbConnection = await this.createConnection();
             const itemData = await this.get(id);
@@ -227,7 +223,7 @@ class MySqlEntityStorageConnector {
             }
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "removeFailed", {
+            throw new GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "removeFailed", {
                 id
             }, err);
         }
@@ -237,15 +233,15 @@ class MySqlEntityStorageConnector {
      * @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 ?? MySqlEntityStorageConnector._PAGE_SIZE;
+            const returnSize = limit ?? MySqlEntityStorageConnector._DEFAULT_LIMIT;
             let orderByClause = "";
             if (Array.isArray(sortProperties)) {
                 const orderClauses = [];
@@ -271,7 +267,7 @@ class MySqlEntityStorageConnector {
             };
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "queryFailed", { sql }, err);
+            throw new GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "queryFailed", { sql }, err);
         }
     }
     /**
@@ -396,7 +392,7 @@ class MySqlEntityStorageConnector {
         else if (comparator.comparison === ComparisonOperator.Includes) {
             return `JSON_CONTAINS(\`${prop}\`, ?)`;
         }
-        throw new GeneralError(this.CLASS_NAME, "comparisonNotSupported", {
+        throw new GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "comparisonNotSupported", {
             comparison: comparator.comparison
         });
     }
@@ -436,7 +432,9 @@ class MySqlEntityStorageConnector {
         else if (operator === LogicalOperator.Or) {
             return "OR";
         }
-        throw new GeneralError(this.CLASS_NAME, "conditionalNotSupported", { operator });
+        throw new GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "conditionalNotSupported", {
+            operator
+        });
     }
     /**
      * Verify the conditions for the entity.
@@ -462,7 +460,7 @@ class MySqlEntityStorageConnector {
             [EntitySchemaPropertyType.Boolean]: "TINYINT(1)"
         };
         if (!entitySchema.properties) {
-            throw new GeneralError(this.CLASS_NAME, "entitySchemaPropertiesUndefined");
+            throw new GeneralError(MySqlEntityStorageConnector.CLASS_NAME, "entitySchemaPropertiesUndefined");
         }
         const primaryKeys = [];
         const columnDefinitions = entitySchema.properties

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./mysqlEntityStorageConnector";
 export * from "./models/IMySqlEntityStorageConnectorConfig";
 export * from "./models/IMySqlEntityStorageConnectorConstructorOptions";
+export * from "./mysqlEntityStorageConnector";

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

@@ -8,10 +8,10 @@ export interface IMySqlEntityStorageConnectorConstructorOptions {
      */
     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/mysqlEntityStorageConnector.d.ts

@@ -8,7 +8,7 @@ export declare class MySqlEntityStorageConnector<T = unknown> implements IEntity
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of MySqlEntityStorageConnector.
      * @param options The options for the connector.
@@ -16,10 +16,10 @@ export declare class MySqlEntityStorageConnector<T = unknown> implements IEntity
     constructor(options: IMySqlEntityStorageConnectorConstructorOptions);
     /**
      * Initialize the MySql 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 MySqlEntityStorageConnector<T = unknown> implements IEntity
      * @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,174 @@
 # @twin.org/entity-storage-connector-mysql - Changelog
 
+## [0.0.2-next.10](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-mysql-v0.0.2-next.9...entity-storage-connector-mysql-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-mysql-v0.0.2-next.8...entity-storage-connector-mysql-v0.0.2-next.9) (2025-10-02)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-mysql:** 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-mysql-v0.0.2-next.7...entity-storage-connector-mysql-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-mysql-v0.0.2-next.6...entity-storage-connector-mysql-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-mysql-v0.0.2-next.5...entity-storage-connector-mysql-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-mysql-v0.0.2-next.4...entity-storage-connector-mysql-v0.0.2-next.5) (2025-08-11)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-mysql:** 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-mysql-v0.0.2-next.3...entity-storage-connector-mysql-v0.0.2-next.4) (2025-08-08)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-mysql:** 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-mysql-v0.0.2-next.2...entity-storage-connector-mysql-v0.0.2-next.3) (2025-07-25)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-mysql:** 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-mysql-v0.0.2-next.1...entity-storage-connector-mysql-v0.0.2-next.2) (2025-07-24)
+
+
+### Features
+
+* remove includeNodeIdentity flag ([d88d1d0](https://github.com/twinfoundation/entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
+* 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-mysql-v0.0.2-next.0...entity-storage-connector-mysql-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
+
+* Adding a functionality to review the incoming format of a field when creating the table ([#28](https://github.com/twinfoundation/entity-storage/issues/28)) ([865be5a](https://github.com/twinfoundation/entity-storage/commit/865be5afa0f2e3c9d51cb50e3e5e9ace1e213efe))
+* 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)
 
 

package/docs/reference/classes/MySqlEntityStorageConnector.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 MySql 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/IMySqlEntityStorageConnectorConstructorOptions.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

@@ -1,21 +1,21 @@
 {
 	"info": {
-		"mysqlEntityStorageConnector": {
+		"mySqlEntityStorageConnector": {
 			"databaseCreating": "Database \"{databaseName}\" creating",
 			"databaseExists": "Database \"{databaseName}\" created or it already exists",
 			"tableExists": "Database \"{tableName}\" created or it already exists"
 		}
 	},
 	"error": {
-		"mysqlEntityStorageConnector": {
+		"mySqlEntityStorageConnector": {
 			"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",
+			"databaseCreateFailed": "Unable to create database \"{databaseName}\""
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-mysql",
-	"version": "0.0.1",
+	"version": "0.0.2-next.10",
 	"description": "Entity Storage connector implementation using MySQL storage",
 	"repository": {
 		"type": "git",
@@ -14,13 +14,13 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "^0.0.1",
-		"@twin.org/data-json-ld": "^0.0.1",
-		"@twin.org/entity": "^0.0.1",
-		"@twin.org/entity-storage-models": "^0.0.1",
-		"@twin.org/logging-models": "^0.0.1",
-		"@twin.org/nameof": "^0.0.1",
-		"mysql2": "3.14.1"
+		"@twin.org/core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "0.0.2-next.10",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next",
+		"mysql2": "3.15.2"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
@@ -39,5 +39,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"
 }