@reldens/storage 0.89.0 → 0.91.0

package/CLAUDE.md

@@ -191,7 +191,14 @@ npx reldens-storage-prisma --host=<host> --database=<db> --user=<user> --passwor
 
 **EntitiesTranslationsGeneration** (`lib/generators/entities-translations-generation.js`):
 - Generates `entities-translations.js` file
-- Creates i18n translation keys for entities
+- Creates i18n translation keys for entities and fields
+- Generates two types of translations:
+  - Table labels: Human-readable entity names
+  - Entity-specific field translations: Field labels per entity
+- Methods:
+  - `getTranslationLabels()`: Generates table name translations
+  - `getFieldTranslations()`: Generates entity-specific field translations
+  - `formatFieldName()`: Converts field names to human-readable labels (e.g., `owner_id` → `Owner ID`)
 
 **BaseGenerator** (`lib/generators/base-generator.js`):
 - Base class for all generators
@@ -255,7 +262,9 @@ All generated files are created in the **generated-entities/** directory:
 
 **Configuration Files:**
 - entities-config.js (entity relation configuration)
-- entities-translations.js (translation keys)
+- entities-translations.js (translation keys with two sections):
+  - `labels`: Table name translations (e.g., `'skills_class_path': 'Class Paths'`)
+  - `fields`: Entity-specific field translations (e.g., `'skills_class_path': {'id': 'ID', 'key': 'Key'}`)
 
 ## Relation Keys Pattern
 

package/index.js

@@ -20,6 +20,7 @@ const { PrismaDriver } = require('./lib/prisma/prisma-driver');
 const { PrismaDataServer } = require('./lib/prisma/prisma-data-server');
 const { PrismaSchemaGenerator } = require('./lib/prisma/prisma-schema-generator');
 const { PrismaClientLoader } = require('./lib/prisma/prisma-client-loader');
+const { RELATION_PREFIX } = require('./lib/relation-key');
 
 module.exports = {
     // base:
@@ -52,5 +53,7 @@ module.exports = {
     EntitiesGenerator,
     EntityProperties,
     TypeMapper,
-    MySQLTablesProvider
+    MySQLTablesProvider,
+    // relation key:
+    RELATION_PREFIX
 };

package/lib/entity-templates/entities-translations.template

@@ -7,5 +7,8 @@
 module.exports.entitiesTranslations = {
     labels: {
         {{labels}}
+    },
+    fields: {
+        {{fields}}
     }
 };

package/lib/generators/entities-generation.js

@@ -8,6 +8,7 @@ const { FileHandler } = require('@reldens/server-utils');
 const { Logger, sc } = require('@reldens/utils');
 const { TypeMapper } = require('../type-mapper');
 const { BaseGenerator } = require('./base-generator');
+const { RELATION_PREFIX } = require('../relation-key');
 
 class EntitiesGeneration extends BaseGenerator
 {
@@ -18,6 +19,7 @@ class EntitiesGeneration extends BaseGenerator
         this.entitiesFolder = sc.get(props, 'entitiesFolder', '');
         this.templatePath = sc.get(props, 'templatePath', '');
         this.generatedEntities = {};
+        this.removeIdFromMultipleRelations = sc.get(props, 'removeIdFromMultipleRelations', true);
     }
 
     async generateEntityFile(tableName, tableData)
@@ -75,15 +77,26 @@ class EntitiesGeneration extends BaseGenerator
             return false;
         }
         Logger.info('Generated entity file: '+fileName);
+        let properties = this.buildPropertiesObject(tableData.columns);
         this.generatedEntities[tableName] = {
             entityClassName,
             entityFileName: fileName,
             tableName,
-            titleProperty
+            titleProperty,
+            properties
         };
         return true;
     }
 
+    buildPropertiesObject(columns)
+    {
+        let properties = {};
+        for(let columnName of Object.keys(columns)){
+            properties[columnName] = true;
+        }
+        return properties;
+    }
+
     detectPrimaryKeyColumn(columns)
     {
         for(let columnName of Object.keys(columns)){
@@ -141,20 +154,49 @@ class EntitiesGeneration extends BaseGenerator
         return false;
     }
 
+    countReferencesPerTable(columns)
+    {
+        let counts = {};
+        for(let columnName of Object.keys(columns)){
+            let column = columns[columnName];
+            if(!sc.hasOwn(column, 'referencedTable')){
+                continue;
+            }
+            if(!counts[column.referencedTable]){
+                counts[column.referencedTable] = 0;
+            }
+            counts[column.referencedTable]++;
+        }
+        return counts;
+    }
+
+    generateForwardRelationKey(referencedTable, columnName, referenceCounts)
+    {
+        if(1 === referenceCounts[referencedTable]){
+            return RELATION_PREFIX+referencedTable;
+        }
+        let columnSuffix = columnName;
+        if(this.removeIdFromMultipleRelations){
+            columnSuffix = columnName.replace(/_id$/i, '');
+        }
+        return RELATION_PREFIX+referencedTable+'_'+columnSuffix;
+    }
+
     generatePropertiesConfig(columns, titleProperty, primaryKeyColumn)
     {
+        let referenceCounts = this.countReferencesPerTable(columns);
         let propertiesConfig = [];
         for(let columnName of Object.keys(columns)){
             let column = columns[columnName];
             let propertyKey = titleProperty && titleProperty === columnName ? '[titleProperty]' : columnName;
             let isPrimaryKey = primaryKeyColumn && primaryKeyColumn === columnName;
             if(isPrimaryKey){
-                let props = this.getPropertyAttributes(column);
+                let props = this.getPropertyAttributes(column, columnName, referenceCounts);
                 props.unshift('isId: true');
                 propertiesConfig.push(propertyKey+': {\n                '+props.join(',\n                ')+ '\n            }');
                 continue;
             }
-            let props = this.getPropertyAttributes(column);
+            let props = this.getPropertyAttributes(column, columnName, referenceCounts);
             if(0 === props.length){
                 let dbType = column.type.toLowerCase();
                 propertiesConfig.push(propertyKey+': {\n                dbType: \''+dbType+'\'\n            }');
@@ -167,21 +209,24 @@ class EntitiesGeneration extends BaseGenerator
         return propertiesConfig.join(',\n            ');
     }
 
-    getPropertyAttributes(column)
+    getPropertyAttributes(column, columnName, referenceCounts)
     {
         let props = [];
         let type = column.type.toLowerCase();
-        this.addTypeAttribute(props, column, type);
+        this.addTypeAttribute(props, column, type, columnName, referenceCounts);
         this.addRequiredAttribute(props, column);
         props.push('dbType: \''+type+'\'');
         return props;
     }
 
-    addTypeAttribute(props, column, type)
+    addTypeAttribute(props, column, type, columnName, referenceCounts)
     {
         if(column.referencedTable){
             props.push('type: \'reference\'');
-            props.push('reference: \''+this.getReferenceTable(column)+'\'');
+            let referenceTable = this.getReferenceTable(column);
+            props.push('reference: \''+referenceTable+'\'');
+            let alias = this.generateForwardRelationKey(referenceTable, columnName, referenceCounts);
+            props.push('alias: \''+alias+'\'');
             return;
         }
         if('date' === type || 'datetime' === type || 'timestamp' === type){

package/lib/generators/entities-translations-generation.js

@@ -37,10 +37,10 @@ class EntitiesTranslationsGeneration extends BaseGenerator
             Logger.critical('Failed to read entities translations template file: '+this.templatePath);
             return false;
         }
-        let translationsContent = translationsTemplateContent.replace(
-            /{{labels}}/g,
-            this.getTranslationLabels(Object.assign({}, existingEntities, generatedEntities))
-        );
+        let allEntities = Object.assign({}, existingEntities, generatedEntities);
+        let translationsContent = translationsTemplateContent
+            .replace(/{{labels}}/g, this.getTranslationLabels(allEntities))
+            .replace(/{{fields}}/g, this.getFieldTranslations(allEntities));
         if(!FileHandler.writeFile(this.entitiesTranslationsPath, translationsContent)){
             Logger.critical('Failed to write entities translations file: '+this.entitiesTranslationsPath);
             return false;
@@ -130,6 +130,42 @@ class EntitiesTranslationsGeneration extends BaseGenerator
         return labels.join(',\n        ');
     }
 
+    getFieldTranslations(allEntities)
+    {
+        let fieldsTranslations = [];
+        for(let tableName of Object.keys(allEntities)){
+            let entity = allEntities[tableName];
+            if(!sc.hasOwn(entity, 'properties')){
+                continue;
+            }
+            let entityFields = [];
+            for(let fieldName of Object.keys(entity.properties)){
+                let formattedName = this.formatFieldName(fieldName);
+                entityFields.push('\''+fieldName+'\': \''+formattedName+'\'');
+            }
+            if(0 === entityFields.length){
+                continue;
+            }
+            fieldsTranslations.push(
+                '\''+tableName+'\': {\n            '+entityFields.join(',\n            ')+'\n        }'
+            );
+        }
+        return fieldsTranslations.join(',\n        ');
+    }
+
+    formatFieldName(fieldName)
+    {
+        let formatted = fieldName
+            .split('_')
+            .map(word => word.charAt(0).toUpperCase()+word.slice(1))
+            .join(' ');
+        formatted = formatted.replace(/\sId(\s|$)/g, ' ID$1');
+        formatted = formatted.replace(/\sAt(\s|$)/g, ' At$1');
+        formatted = formatted.replace(/\sKey(\s|$)/g, ' Key$1');
+        formatted = formatted.replace(/^Id(\s|$)/g, 'ID$1');
+        return formatted;
+    }
+
 }
 
 module.exports.EntitiesTranslationsGeneration = EntitiesTranslationsGeneration;

package/lib/generators/models-generation.js

@@ -8,6 +8,7 @@ const { FileHandler } = require('@reldens/server-utils');
 const { Logger, sc } = require('@reldens/utils');
 const { TypeMapper } = require('../type-mapper');
 const { BaseGenerator } = require('./base-generator');
+const { RELATION_PREFIX } = require('../relation-key');
 
 class ModelsGeneration extends BaseGenerator
 {
@@ -249,13 +250,13 @@ class ModelsGeneration extends BaseGenerator
     generatePrismaReverseRelationKey(relatedTable, prismaName, tableName, referenceCount)
     {
         if(1 === referenceCount){
-            return 'related_'+relatedTable;
+            return RELATION_PREFIX+relatedTable;
         }
         let columnHint = this.extractColumnHintFromPrismaName(prismaName, relatedTable, tableName);
         if(columnHint){
-            return 'related_'+relatedTable+'_'+columnHint;
+            return RELATION_PREFIX+relatedTable+'_'+columnHint;
         }
-        return 'related_'+relatedTable;
+        return RELATION_PREFIX+relatedTable;
     }
 
     extractColumnHintFromPrismaName(prismaName, relatedTable, tableName)
@@ -420,25 +421,25 @@ class ModelsGeneration extends BaseGenerator
     generateForwardRelationKey(referencedTable, columnName, referenceCounts)
     {
         if(1 === referenceCounts[referencedTable]){
-            return 'related_'+referencedTable;
+            return RELATION_PREFIX+referencedTable;
         }
         let columnSuffix = columnName;
         if(this.removeIdFromMultipleRelations){
             columnSuffix = columnName.replace(/_id$/i, '');
         }
-        return 'related_'+referencedTable+'_'+columnSuffix;
+        return RELATION_PREFIX+referencedTable+'_'+columnSuffix;
     }
 
     generateReverseRelationKey(referencingTable, columnName, referenceCount)
     {
         if(1 === referenceCount){
-            return 'related_'+referencingTable;
+            return RELATION_PREFIX+referencingTable;
         }
         let columnSuffix = columnName;
         if(this.removeIdFromMultipleRelations){
             columnSuffix = columnName.replace(/_id$/i, '');
         }
-        return 'related_'+referencingTable+'_'+columnSuffix;
+        return RELATION_PREFIX+referencingTable+'_'+columnSuffix;
     }
 
     determineForwardRelationType(tableName, columnName, column)
@@ -578,7 +579,7 @@ class ModelsGeneration extends BaseGenerator
     findMappedByKey(currentTable, referencingTable, reverseRelation)
     {
         if(!this.allTablesData[referencingTable]){
-            return 'related_'+currentTable;
+            return RELATION_PREFIX+currentTable;
         }
         let referencingTableData = this.allTablesData[referencingTable];
         let forwardRelations = this.detectObjectionJsRelations(referencingTable, referencingTableData);
@@ -588,7 +589,7 @@ class ModelsGeneration extends BaseGenerator
                 return forwardKey;
             }
         }
-        return 'related_'+currentTable;
+        return RELATION_PREFIX+currentTable;
     }
 
     generateFkMappings(tableName, tableData, driverKey)

package/lib/objection-js/objection-js-data-server.js

@@ -9,7 +9,7 @@ const { ObjectionJsDriver } = require('./objection-js-driver');
 const { MySQLTablesProvider } = require('../mysql-tables-provider');
 const { Model } = require('objection');
 const Knex = require('knex');
-const { Logger } = require('@reldens/utils');
+const { Logger, sc } = require('@reldens/utils');
 
 class ObjectionJsDataServer extends BaseDataServer
 {
@@ -21,6 +21,16 @@ class ObjectionJsDataServer extends BaseDataServer
         if(!this.rawModel){
             this.rawModel = Model;
         }
+        this.validMySQL2Options = [
+            'authPlugins', 'authSwitchHandler', 'bigNumberStrings', 'charset', 'charsetNumber', 'compress',
+            'connectAttributes', 'connectTimeout', 'database', 'dateStrings', 'debug', 'decimalNumbers',
+            'enableKeepAlive', 'flags', 'host', 'insecureAuth', 'infileStreamFactory', 'isServer',
+            'keepAliveInitialDelay', 'localAddress', 'maxPreparedStatements', 'multipleStatements',
+            'namedPlaceholders', 'nestTables', 'password', 'password1', 'password2', 'password3', 'passwordSha1',
+            'pool', 'port', 'queryFormat', 'rowsAsArray', 'socketPath', 'ssl', 'stream', 'stringifyObjects',
+            'supportBigNumbers', 'timezone', 'trace', 'typeCast', 'uri', 'user', 'disableEval', 'connectionLimit',
+            'maxIdle', 'idleTimeout', 'Promise', 'queueLimit', 'waitForConnections', 'jsonStrings', 'gracefulEnd'
+        ];
     }
 
     async connect()
@@ -28,9 +38,10 @@ class ObjectionJsDataServer extends BaseDataServer
         if(this.initialized){
             return this.initialized;
         }
+        let connectionConfig = this.sanitizeConnectionConfig(this.config);
         this.knex = await Knex({
             client: this.client,
-            connection: this.config,
+            connection: connectionConfig,
             pool: this.poolConfig,
             debug: this.debug,
             multipleStatements: this.multipleStatements
@@ -47,6 +58,20 @@ class ObjectionJsDataServer extends BaseDataServer
         return this.initialized;
     }
 
+    sanitizeConnectionConfig(config)
+    {
+        if('mysql2' !== this.client){
+            return config;
+        }
+        let cleanConfig = {};
+        for(let prop of this.validMySQL2Options){
+            if(sc.hasOwn(config, prop)){
+                cleanConfig[prop] = config[prop];
+            }
+        }
+        return cleanConfig;
+    }
+
     async disconnect()
     {
         if(!this.knex){

package/lib/relation-key.js

@@ -0,0 +1,9 @@
+/**
+ *
+ * Reldens - Relation Key
+ *
+ */
+
+module.exports = {
+    RELATION_PREFIX: process.env.RELDENS_RELATION_PREFIX || 'related_'
+};

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@reldens/storage",
     "scope": "@reldens",
-    "version": "0.89.0",
+    "version": "0.91.0",
     "description": "Reldens - Storage",
     "author": "Damian A. Pastorini",
     "license": "MIT",
@@ -59,7 +59,7 @@
         "@reldens/utils": "^0.54.0",
         "knex": "3.1.0",
         "mysql": "2.18.1",
-        "mysql2": "3.16.2",
+        "mysql2": "3.16.3",
         "objection": "3.1.5",
         "prisma": "6.19.2"
     }

package/tests/fixtures/{expected-entities-prisma → expected-entities}/entities/test-categories-entity.js

@@ -1,70 +1,70 @@
-/**
- *
- * Reldens - TestCategoriesEntity
- *
- */
-
-const { EntityProperties } = require('../../index');
-const { sc } = require('@reldens/utils');
-
-class TestCategoriesEntity extends EntityProperties
-{
-
-    static propertiesConfig(extraProps)
-    {
-        let titleProperty = 'name';
-        let properties = {
-            id: {
-                isId: true,
-                type: 'number',
-                isRequired: true,
-                dbType: 'int'
-            },
-            [titleProperty]: {
-                isRequired: true,
-                dbType: 'varchar'
-            },
-            slug: {
-                isRequired: true,
-                dbType: 'varchar'
-            },
-            description: {
-                type: 'textarea',
-                dbType: 'text'
-            },
-            is_active: {
-                type: 'boolean',
-                dbType: 'tinyint'
-            },
-            display_order: {
-                type: 'number',
-                dbType: 'int'
-            },
-            created_at: {
-                type: 'datetime',
-                dbType: 'timestamp'
-            },
-            updated_at: {
-                type: 'datetime',
-                dbType: 'timestamp'
-            }
-        };
-        let propertiesKeys = Object.keys(properties);
-        let showProperties = propertiesKeys;
-        let editProperties = sc.removeFromArray([...propertiesKeys], ['id', 'created_at', 'updated_at']);
-        let listProperties = [...propertiesKeys];
-        listProperties.splice(listProperties.indexOf('description'), 1);
-        return {
-            showProperties,
-            editProperties,
-            listProperties,
-            filterProperties: listProperties,
-            properties,
-            titleProperty,
-            ...extraProps
-        };
-    }
-
-}
-
-module.exports.TestCategoriesEntity = TestCategoriesEntity;
+/**
+ *
+ * Reldens - TestCategoriesEntity
+ *
+ */
+
+const { EntityProperties } = require('../../index');
+const { sc } = require('@reldens/utils');
+
+class TestCategoriesEntity extends EntityProperties
+{
+
+    static propertiesConfig(extraProps)
+    {
+        let titleProperty = 'name';
+        let properties = {
+            id: {
+                isId: true,
+                type: 'number',
+                isRequired: true,
+                dbType: 'int'
+            },
+            [titleProperty]: {
+                isRequired: true,
+                dbType: 'varchar'
+            },
+            slug: {
+                isRequired: true,
+                dbType: 'varchar'
+            },
+            description: {
+                type: 'textarea',
+                dbType: 'text'
+            },
+            is_active: {
+                type: 'boolean',
+                dbType: 'tinyint'
+            },
+            display_order: {
+                type: 'number',
+                dbType: 'int'
+            },
+            created_at: {
+                type: 'datetime',
+                dbType: 'timestamp'
+            },
+            updated_at: {
+                type: 'datetime',
+                dbType: 'timestamp'
+            }
+        };
+        let propertiesKeys = Object.keys(properties);
+        let showProperties = propertiesKeys;
+        let editProperties = sc.removeFromArray([...propertiesKeys], ['id', 'created_at', 'updated_at']);
+        let listProperties = [...propertiesKeys];
+        listProperties.splice(listProperties.indexOf('description'), 1);
+        return {
+            showProperties,
+            editProperties,
+            listProperties,
+            filterProperties: listProperties,
+            properties,
+            titleProperty,
+            ...extraProps
+        };
+    }
+
+}
+
+module.exports.TestCategoriesEntity = TestCategoriesEntity;