@twin.org/entity-storage-connector-mysql 0.0.1-next.21 → 0.0.1-next.23

package/dist/cjs/index.cjs

@@ -134,7 +134,13 @@ class MySqlEntityStorageConnector {
                 values.push(id);
             }
             else {
-                whereClauses.push("`id` = ?");
+                const primaryKeyProp = this._entitySchema.properties?.find(prop => prop.isPrimary);
+                if (primaryKeyProp) {
+                    whereClauses.push(`\`${String(primaryKeyProp.property)}\` = ?`);
+                }
+                else {
+                    whereClauses.push("`id` = ?");
+                }
                 values.push(id);
             }
             if (conditions) {
@@ -162,11 +168,10 @@ class MySqlEntityStorageConnector {
      * @param conditions The optional conditions to match for the entities.
      * @returns The id of the entity.
      */
-    async set(entity, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity);
-        // Validate that the entity matches the schema
-        this.entitySqlVerification(entity);
-        const id = entity["id"];
+    async set(entity$1, conditions) {
+        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
+        const id = entity$1["id"];
         try {
             if (core.Is.arrayValue(conditions)) {
                 const itemData = await this.get(id);
@@ -174,16 +179,24 @@ class MySqlEntityStorageConnector {
                     return;
                 }
             }
-            const columns = Object.keys(entity)
+            const columns = Object.keys(entity$1)
                 .map(key => `\`${key}\``)
                 .join(", ");
-            const values = Object.values(entity);
+            const values = Object.values(entity$1);
+            for (const [index, value] of values.entries()) {
+                const property = Object.keys(entity$1)[index];
+                const schemaProp = this._entitySchema.properties?.find(p => p.property === property);
+                if (schemaProp?.type === entity.EntitySchemaPropertyType.Object ||
+                    schemaProp?.type === entity.EntitySchemaPropertyType.Array) {
+                    values[index] = JSON.stringify(value);
+                }
+            }
             const placeholders = values.map(() => "?").join(", ");
             const dbConnection = await this.createConnection();
             await dbConnection.query(`INSERT INTO \`${this._config.database}\`.\`${this._config.tableName}\` (${columns}) VALUES (${placeholders}) ON DUPLICATE KEY UPDATE ${columns
                 .split(", ")
                 .map(col => `${col} = VALUES(${col})`)
-                .join(", ")};`, values.map(value => (typeof value === "object" ? JSON.stringify(value) : value)));
+                .join(", ")};`, values);
         }
         catch (err) {
             throw new core.GeneralError(this.CLASS_NAME, "setFailed", {
@@ -461,46 +474,18 @@ class MySqlEntityStorageConnector {
             const nullable = prop.optional ? " NULL" : " NOT NULL";
             if (prop.isPrimary) {
                 if (sqlType === "LONGTEXT" || sqlType === "TEXT") {
-                    primaryKeys.push(`${columnName}(255)`);
+                    primaryKeys.push(`\`${columnName}\`(255)`);
                 }
                 else {
-                    primaryKeys.push(columnName);
+                    primaryKeys.push(`\`${columnName}\``);
                 }
             }
-            return `${columnName} ${sqlType}${nullable}`;
+            return `\`${columnName}\` ${sqlType}${nullable}`;
         })
             .join(", ");
         const primaryKeyDefinition = primaryKeys.length > 0 ? `, PRIMARY KEY (${primaryKeys.join(", ")})` : "";
         return columnDefinitions + primaryKeyDefinition;
     }
-    /**
-     * Validate that the entity matches the schema.
-     * @param entity The entity to validate.
-     * @throws GeneralError if the entity schema properties are undefined or if the entity does not match the schema.
-     */
-    entitySqlVerification(entity) {
-        // Validate that the entity matches the schema
-        if (!this._entitySchema.properties) {
-            throw new core.GeneralError(this.CLASS_NAME, "entitySchemaPropertiesUndefined");
-        }
-        for (const prop of this._entitySchema.properties) {
-            const value = entity[prop.property];
-            if (value === undefined || value === null) {
-                if (!prop.optional) {
-                    throw new core.GeneralError(this.CLASS_NAME, "invalidEntity", {
-                        entity,
-                        entitySchema: this._entitySchema
-                    });
-                }
-            }
-            else if (typeof value !== prop.type && (prop.type !== "array" || !core.Is.array(value))) {
-                throw new core.GeneralError(this.CLASS_NAME, "invalidEntity", {
-                    entity,
-                    entitySchema: this._entitySchema
-                });
-            }
-        }
-    }
 }
 
 exports.MySqlEntityStorageConnector = MySqlEntityStorageConnector;

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { Guards, BaseError, GeneralError, Is, ObjectHelper } from '@twin.org/core';
-import { EntitySchemaFactory, SortDirection, ComparisonOperator, LogicalOperator, EntitySchemaPropertyType } from '@twin.org/entity';
+import { EntitySchemaFactory, EntitySchemaHelper, EntitySchemaPropertyType, SortDirection, ComparisonOperator, LogicalOperator } from '@twin.org/entity';
 import { LoggingConnectorFactory } from '@twin.org/logging-models';
 import { createConnection } from 'mysql2/promise';
 
@@ -132,7 +132,13 @@ class MySqlEntityStorageConnector {
                 values.push(id);
             }
             else {
-                whereClauses.push("`id` = ?");
+                const primaryKeyProp = this._entitySchema.properties?.find(prop => prop.isPrimary);
+                if (primaryKeyProp) {
+                    whereClauses.push(`\`${String(primaryKeyProp.property)}\` = ?`);
+                }
+                else {
+                    whereClauses.push("`id` = ?");
+                }
                 values.push(id);
             }
             if (conditions) {
@@ -162,8 +168,7 @@ class MySqlEntityStorageConnector {
      */
     async set(entity, conditions) {
         Guards.object(this.CLASS_NAME, "entity", entity);
-        // Validate that the entity matches the schema
-        this.entitySqlVerification(entity);
+        EntitySchemaHelper.validateEntity(entity, this.getSchema());
         const id = entity["id"];
         try {
             if (Is.arrayValue(conditions)) {
@@ -176,12 +181,20 @@ class MySqlEntityStorageConnector {
                 .map(key => `\`${key}\``)
                 .join(", ");
             const values = Object.values(entity);
+            for (const [index, value] of values.entries()) {
+                const property = Object.keys(entity)[index];
+                const schemaProp = this._entitySchema.properties?.find(p => p.property === property);
+                if (schemaProp?.type === EntitySchemaPropertyType.Object ||
+                    schemaProp?.type === EntitySchemaPropertyType.Array) {
+                    values[index] = JSON.stringify(value);
+                }
+            }
             const placeholders = values.map(() => "?").join(", ");
             const dbConnection = await this.createConnection();
             await dbConnection.query(`INSERT INTO \`${this._config.database}\`.\`${this._config.tableName}\` (${columns}) VALUES (${placeholders}) ON DUPLICATE KEY UPDATE ${columns
                 .split(", ")
                 .map(col => `${col} = VALUES(${col})`)
-                .join(", ")};`, values.map(value => (typeof value === "object" ? JSON.stringify(value) : value)));
+                .join(", ")};`, values);
         }
         catch (err) {
             throw new GeneralError(this.CLASS_NAME, "setFailed", {
@@ -459,46 +472,18 @@ class MySqlEntityStorageConnector {
             const nullable = prop.optional ? " NULL" : " NOT NULL";
             if (prop.isPrimary) {
                 if (sqlType === "LONGTEXT" || sqlType === "TEXT") {
-                    primaryKeys.push(`${columnName}(255)`);
+                    primaryKeys.push(`\`${columnName}\`(255)`);
                 }
                 else {
-                    primaryKeys.push(columnName);
+                    primaryKeys.push(`\`${columnName}\``);
                 }
             }
-            return `${columnName} ${sqlType}${nullable}`;
+            return `\`${columnName}\` ${sqlType}${nullable}`;
         })
             .join(", ");
         const primaryKeyDefinition = primaryKeys.length > 0 ? `, PRIMARY KEY (${primaryKeys.join(", ")})` : "";
         return columnDefinitions + primaryKeyDefinition;
     }
-    /**
-     * Validate that the entity matches the schema.
-     * @param entity The entity to validate.
-     * @throws GeneralError if the entity schema properties are undefined or if the entity does not match the schema.
-     */
-    entitySqlVerification(entity) {
-        // Validate that the entity matches the schema
-        if (!this._entitySchema.properties) {
-            throw new GeneralError(this.CLASS_NAME, "entitySchemaPropertiesUndefined");
-        }
-        for (const prop of this._entitySchema.properties) {
-            const value = entity[prop.property];
-            if (value === undefined || value === null) {
-                if (!prop.optional) {
-                    throw new GeneralError(this.CLASS_NAME, "invalidEntity", {
-                        entity,
-                        entitySchema: this._entitySchema
-                    });
-                }
-            }
-            else if (typeof value !== prop.type && (prop.type !== "array" || !Is.array(value))) {
-                throw new GeneralError(this.CLASS_NAME, "invalidEntity", {
-                    entity,
-                    entitySchema: this._entitySchema
-                });
-            }
-        }
-    }
 }
 
 export { MySqlEntityStorageConnector };

package/dist/types/mysqlEntityStorageConnector.d.ts

@@ -85,10 +85,4 @@ export declare class MySqlEntityStorageConnector<T = unknown> implements IEntity
      * @throws GeneralError if the entity properties do not exist.
      */
     private mapMySqlProperties;
-    /**
-     * Validate that the entity matches the schema.
-     * @param entity The entity to validate.
-     * @throws GeneralError if the entity schema properties are undefined or if the entity does not match the schema.
-     */
-    private entitySqlVerification;
 }

package/docs/changelog.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-mysql",
-	"version": "0.0.1-next.21",
+	"version": "0.0.1-next.23",
 	"description": "Entity Storage connector implementation using MySQL storage",
 	"repository": {
 		"type": "git",
@@ -15,11 +15,12 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
+		"@twin.org/data-json-ld": "^0.0.1-next.3",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.1-next.21",
+		"@twin.org/entity-storage-models": "0.0.1-next.23",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",
-		"mysql2": "^3.12.0"
+		"mysql2": "^3.13.0"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",