@reldens/storage 0.42.0 → 0.44.0

package/lib/entities-generator.js

@@ -44,58 +44,20 @@ class EntitiesGenerator
         };
         this.server = sc.get(props, 'server', false);
         this.connectionData = sc.get(props, 'connectionData', false);
-        if(!this.server && !this.connectionData){
-            ErrorManager.error('Either server or connectionData must be provided to EntitiesGenerator.');
-        }
         this.generatedEntities = {};
     }
 
-    ensureFoldersExist()
-    {
-        if(!FileHandler.exists(this.generationFolder)){
-            try {
-                FileHandler.createFolder(this.generationFolder, { recursive: true });
-            } catch (error) {
-                ErrorManager.error('Failed to create generation folder: '+error.message);
-            }
-        }
-        if(!FileHandler.exists(this.entitiesFolder)){
-            try {
-                FileHandler.createFolder(this.entitiesFolder, { recursive: true });
-            } catch (error) {
-                ErrorManager.error('Failed to create entities folder: '+error.message);
-            }
-        }
-        if(!FileHandler.exists(this.modelsFolder)){
-            try {
-                FileHandler.createFolder(this.modelsFolder, { recursive: true });
-            } catch (error) {
-                ErrorManager.error('Failed to create models folder: '+error.message);
-            }
-        }
-        for(let driverKey of Object.keys(this.driverMap)){
-            let driverFolder = FileHandler.joinPaths(this.modelsFolder, driverKey);
-            if(!FileHandler.exists(driverFolder)){
-                try {
-                    FileHandler.createFolder(driverFolder, { recursive: true });
-                } catch (error) {
-                    ErrorManager.error('Failed to create driver folder: '+error.message);
-                }
-            }
-        }
-    }
-
     async generateEntityFile(tableName, tableData)
     {
         let entityTemplatePath = this.templates['entity'];
         if(!FileHandler.exists(entityTemplatePath)){
-            ErrorManager.error('Entity template file not found: '+entityTemplatePath);
+            Logger.critical('Entity template file not found: '+entityTemplatePath);
+            return false;
         }
-        let entityTemplateContent;
-        try {
-            entityTemplateContent = FileHandler.fetchFileContents(entityTemplatePath);
-        } catch (error) {
-            ErrorManager.error('Failed to read entity template file: '+error.message);
+        let entityTemplateContent = FileHandler.fetchFileContents(entityTemplatePath);
+        if(!entityTemplateContent) {
+            Logger.critical('Failed to read entity template file: '+entityTemplatePath);
+            return false;
         }
         let entityClassName = sc.capitalizedCamelCase(tableName)+'Entity';
         let titleProperty = this.determineTitleProperty(tableData.columns);
@@ -114,7 +76,8 @@ class EntitiesGenerator
         }
         let editPropertiesRemoval = this.getEditPropertiesRemoval(fieldsToRemoveFromEdit);
         let listPropertiesDeclaration = this.getListPropertiesDeclaration(tableData.columns);
-        let needsSc = listPropertiesDeclaration.includes('sc.removeFromArray') || editPropertiesRemoval.includes('sc.removeFromArray');
+        let needsSc = listPropertiesDeclaration.includes('sc.removeFromArray')
+            || editPropertiesRemoval.includes('sc.removeFromArray');
         let scRequire = needsSc ? '\nconst { sc } = require(\'@reldens/utils\');' : '';
         let replacements = {
             entityClassName,
@@ -128,25 +91,26 @@ class EntitiesGenerator
         let entityContent = this.applyReplacements(entityTemplateContent, replacements);
         let fileName = sc.kebabCase(tableName)+'-entity.js';
         let filePath = FileHandler.joinPaths(this.entitiesFolder, fileName);
-        try {
-            FileHandler.writeFile(filePath, entityContent);
-            Logger.info('Generated entity file: '+filePath);
-            this.generatedEntities[tableName] = {
-                entityClassName,
-                entityFileName: fileName,
-                tableName,
-                titleProperty
-            };
-            return true;
-        } catch (error) {
-            ErrorManager.error('Failed to write entity file: '+error.message);
+        if(!FileHandler.writeFile(filePath, entityContent)){
+            Logger.critical('Failed to write entity file: '+filePath);
+            return false;
         }
+        Logger.info('Generated entity file: '+filePath);
+        this.generatedEntities[tableName] = {
+            entityClassName,
+            entityFileName: fileName,
+            tableName,
+            titleProperty
+        };
+        return true;
     }
 
     getEditPropertiesRemoval(fieldsToRemove)
     {
         if(1 === fieldsToRemove.length){
-            return 'let editProperties = [...showProperties];\n        editProperties.splice(editProperties.indexOf(\''+fieldsToRemove[0]+'\'), 1);';
+            return 'let editProperties = [...showProperties];\n        editProperties.splice(editProperties.indexOf(\''+
+                fieldsToRemove[0]
+                +'\'), 1);';
         }
         return 'let editProperties = sc.removeFromArray([...showProperties], [\''+fieldsToRemove.join('\', \'')+'\']);';
     }
@@ -183,7 +147,9 @@ class EntitiesGenerator
                 propertiesConfig.push(propertyKey+': {}');
                 continue;
             }
-            propertiesConfig.push(propertyKey+': {\n                '+props.join(',\n                ')+'\n            }');
+            propertiesConfig.push(
+                propertyKey+': {\n                '+props.join(',\n                ')+ '\n            }'
+            );
         }
         return propertiesConfig.join(',\n            ');
     }
@@ -239,7 +205,11 @@ class EntitiesGenerator
         for(let i = 0; i < enumValues.length; i++){
             availableValues.push('{value: '+(i+1)+', label: \''+enumValues[i]+'\'}');
         }
-        props.push('availableValues: [\n                    '+availableValues.join(',\n                    ')+'\n                ]');
+        props.push(
+            'availableValues: [\n                    '+
+            availableValues.join(',\n                    ')+
+            '\n                ]'
+        );
     }
 
     parseEnumValues(columnType)
@@ -284,7 +254,9 @@ class EntitiesGenerator
             return 'let listProperties = showProperties;';
         }
         if(1 === fieldsToRemove.length){
-            return 'let listProperties = [...showProperties];\n        listProperties.splice(listProperties.indexOf(\''+fieldsToRemove[0]+'\'), 1);';
+            return 'let listProperties = [...showProperties];\n        listProperties.splice(listProperties.indexOf(\''+
+                fieldsToRemove[0]+
+                '\'), 1);';
         }
         return 'let listProperties = sc.removeFromArray([...showProperties], [\''+fieldsToRemove.join('\', \'')+'\']);';
     }
@@ -306,13 +278,13 @@ class EntitiesGenerator
     {
         let modelTemplatePath = this.templates[driverKey];
         if(!FileHandler.exists(modelTemplatePath)){
-            ErrorManager.error('Model template file "'+modelTemplatePath+'" not found for driver "'+driverKey+'".');
+            Logger.critical('Model template file "'+modelTemplatePath+'" not found for driver "'+driverKey+'".');
+            return false;
         }
-        let modelTemplateContent;
-        try {
-            modelTemplateContent = FileHandler.fetchFileContents(modelTemplatePath);
-        } catch (error) {
-            ErrorManager.error('Failed to read model template file: '+error.message);
+        let modelTemplateContent = FileHandler.fetchFileContents(modelTemplatePath);
+        if(!modelTemplateContent){
+            Logger.critical('Failed to read model template file: '+modelTemplatePath);
+            return false;
         }
         let modelClassName = sc.capitalizedCamelCase(tableName)+'Model';
         let modelPropertiesList = Object.keys(tableData.columns).join(', ');
@@ -332,17 +304,20 @@ class EntitiesGenerator
         let modelContent = this.applyReplacements(modelTemplateContent, replacements);
         let fileName = sc.kebabCase(tableName)+'-model.js';
         let driverFolder = FileHandler.joinPaths(this.modelsFolder, driverKey);
+        if(!FileHandler.createFolder(driverFolder)){
+            Logger.critical('Failed to create driver folder.');
+            return false;
+        }
         let filePath = FileHandler.joinPaths(driverFolder, fileName);
-        try {
-            FileHandler.writeFile(filePath, modelContent);
-            Logger.info('Generated model file: '+filePath);
-            this.generatedEntities[tableName].modelClassName = modelClassName;
-            this.generatedEntities[tableName].modelFileName = fileName;
-            this.generatedEntities[tableName].driverKey = driverKey;
-            return true;
-        } catch (error) {
-            ErrorManager.error('Failed to write model file: '+error.message);
+        if(!FileHandler.writeFile(filePath, modelContent)){
+            Logger.critical('Failed to write model file: '+filePath);
+            return false;
         }
+        Logger.info('Generated model file: '+filePath);
+        this.generatedEntities[tableName].modelClassName = modelClassName;
+        this.generatedEntities[tableName].modelFileName = fileName;
+        this.generatedEntities[tableName].driverKey = driverKey;
+        return true;
     }
 
     getEntityPropertiesDefinition(columns, driverKey)
@@ -390,16 +365,13 @@ class EntitiesGenerator
     {
         let configTemplatePath = this.templates['entities-config'];
         if(!FileHandler.exists(configTemplatePath)){
-            ErrorManager.error('Entities config template file not found: '+configTemplatePath);
-        }
-        let configTemplateContent;
-        try {
-            configTemplateContent = FileHandler.fetchFileContents(configTemplatePath);
-        } catch (error) {
-            ErrorManager.error('Failed to read entities config template file: '+error.message);
+            Logger.critical('Entities config template file not found: '+configTemplatePath);
+            return false;
         }
-        if(!configTemplateContent || 'string' !== typeof configTemplateContent){
-            ErrorManager.error('Invalid entities config template content');
+        let configTemplateContent = FileHandler.fetchFileContents(configTemplatePath);
+        if(!configTemplateContent) {
+            Logger.critical('Failed to read entities config template file: '+configTemplatePath);
+            return false;
         }
         let requireStatements = this.getRequireStatements();
         let entitiesConfigExport = this.getEntitiesConfigExport();
@@ -408,13 +380,12 @@ class EntitiesGenerator
             entitiesConfigExport
         };
         let configContent = this.applyReplacements(configTemplateContent, replacements);
-        try {
-            FileHandler.writeFile(this.entitiesConfigPath, configContent);
-            Logger.info('Generated entities config file: '+this.entitiesConfigPath);
-            return true;
-        } catch (error) {
-            ErrorManager.error('Failed to write entities config file: '+error.message);
+        if (!FileHandler.writeFile(this.entitiesConfigPath, configContent)){
+            Logger.critical('Failed to write entities config file: '+this.entitiesConfigPath);
+            return false;
         }
+        Logger.info('Generated entities config file: '+this.entitiesConfigPath);
+        return true;
     }
 
     getRequireStatements()
@@ -422,7 +393,10 @@ class EntitiesGenerator
         let requireStatements = [];
         for(let tableName in this.generatedEntities){
             let entity = this.generatedEntities[tableName];
-            requireStatements.push('const { '+entity.entityClassName+' } = require(\'./entities/'+entity.entityFileName.replace('.js', '')+'\');');
+            let nameWithoutExtension = entity.entityFileName.replace('.js', '');
+            requireStatements.push(
+                'const { '+ entity.entityClassName+' } = require(\'./entities/'+nameWithoutExtension+'\');'
+            );
         }
         return requireStatements.join('\n');
     }
@@ -433,7 +407,10 @@ class EntitiesGenerator
         for(let tableName in this.generatedEntities){
             let entity = this.generatedEntities[tableName];
             let camelCaseKey = sc.camelCase(tableName);
-            entitiesConfigExport.push(camelCaseKey+': '+entity.entityClassName+'.propertiesConfig()');
+            let capitalizedCase = sc.capitalizedCamelCase(tableName);
+            entitiesConfigExport.push(
+                camelCaseKey+': '+entity.entityClassName+'.propertiesConfig({parentItemLabel: \''+capitalizedCase+'\'})'
+            );
         }
         return entitiesConfigExport.join(',\n    ');
     }
@@ -442,39 +419,29 @@ class EntitiesGenerator
     {
         let translationsTemplatePath = this.templates['entities-translations'];
         if(!FileHandler.exists(translationsTemplatePath)){
-            ErrorManager.error('Entities translations template file not found: '+translationsTemplatePath);
-        }
-        let translationsTemplateContent;
-        try {
-            translationsTemplateContent = FileHandler.fetchFileContents(translationsTemplatePath);
-        } catch (error) {
-            ErrorManager.error('Failed to read entities translations template file: '+error.message);
+            Logger.critical('Entities translations template file not found: '+translationsTemplatePath);
+            return false;
         }
-        if(!translationsTemplateContent || 'string' !== typeof translationsTemplateContent){
-            ErrorManager.error('Invalid entities translations template content');
+        let translationsTemplateContent = FileHandler.fetchFileContents(translationsTemplatePath);
+        if(!translationsTemplateContent){
+            Logger.critical('Failed to read entities translations template file: '+translationsTemplatePath);
+            return false;
         }
         let labels = this.getTranslationLabels();
-        let translationsContent = translationsTemplateContent.replace(
-            /{{labels}}/g,
-            labels
-        );
-        try {
-            FileHandler.writeFile(this.entitiesTranslationsPath, translationsContent);
-            Logger.info('Generated entities translations file: '+this.entitiesTranslationsPath);
-            return true;
-        } catch (error) {
-            ErrorManager.error('Failed to write entities translations file: '+error.message);
+        let translationsContent = translationsTemplateContent.replace(/{{labels}}/g, labels);
+        if(!FileHandler.writeFile(this.entitiesTranslationsPath, translationsContent)){
+            Logger.critical('Failed to write entities translations file: '+this.entitiesTranslationsPath);
+            return false;
         }
+        Logger.info('Generated entities translations file: '+this.entitiesTranslationsPath);
+        return true;
     }
 
     getTranslationLabels()
     {
         let labels = [];
         for(let tableName in this.generatedEntities){
-            let humanReadable = tableName
-                .split('_')
-                .map(word => word.charAt(0).toUpperCase() + word.slice(1))
-                .join(' ');
+            let humanReadable = tableName.split('_').map(word => word.charAt(0).toUpperCase()+word.slice(1)).join(' ');
             labels.push('\''+tableName+'\': \''+humanReadable+'\'');
         }
         return labels.join(',\n        ');
@@ -484,33 +451,27 @@ class EntitiesGenerator
     {
         let registeredTemplatePath = this.templates['registered-models'];
         if(!FileHandler.exists(registeredTemplatePath)){
-            ErrorManager.error('Registered models template file not found: '+registeredTemplatePath);
-        }
-        let registeredTemplateContent;
-        try {
-            registeredTemplateContent = FileHandler.fetchFileContents(registeredTemplatePath);
-        } catch (error) {
-            ErrorManager.error('Failed to read registered models template file: '+error.message);
+            Logger.critical('Registered models template file not found: '+registeredTemplatePath);
+            return false;
         }
-        if(!registeredTemplateContent || 'string' !== typeof registeredTemplateContent){
-            ErrorManager.error('Invalid registered models template content');
+        let registeredTemplateContent = FileHandler.fetchFileContents(registeredTemplatePath);
+        if(!registeredTemplateContent){
+            Logger.critical('Failed to read registered models template file: '+registeredTemplatePath);
+            return false;
         }
-        let registeredModels = this.getRegisteredModels(driverKey);
-        let registeredEntitiesObject = this.getRegisteredEntitiesObject(driverKey);
         let replacements = {
-            registeredModels,
-            registeredEntitiesObject
+            registeredModels: this.getRegisteredModels(driverKey),
+            registeredEntitiesObject: this.getRegisteredEntitiesObject(driverKey)
         };
         let registeredContent = this.applyReplacements(registeredTemplateContent, replacements);
         let driverFolder = FileHandler.joinPaths(this.modelsFolder, driverKey);
         let filePath = FileHandler.joinPaths(driverFolder, 'registered-models-'+driverKey+'.js');
-        try {
-            FileHandler.writeFile(filePath, registeredContent);
-            Logger.info('Generated registered models file: '+filePath);
-            return true;
-        } catch (error) {
-            ErrorManager.error('Failed to write registered models file: '+error.message);
+        if(!FileHandler.writeFile(filePath, registeredContent)){
+            Logger.critical('Failed to write registered models file: '+filePath);
+            return false;
         }
+        Logger.info('Generated registered models file: '+filePath);
+        return true;
     }
 
     getRegisteredModels(driverKey)
@@ -518,9 +479,12 @@ class EntitiesGenerator
         let registeredModels = [];
         for(let tableName in this.generatedEntities){
             let entity = this.generatedEntities[tableName];
-            if(entity.driverKey === driverKey){
-                registeredModels.push('const { '+entity.modelClassName+' } = require(\'./'+entity.modelFileName.replace('.js', '')+'\');');
+            if(driverKey !== entity.driverKey){
+                continue;
             }
+            registeredModels.push(
+                'const { '+entity.modelClassName+' } = require(\'./'+entity.modelFileName.replace('.js', '')+'\');'
+            );
         }
         return registeredModels.join('\n');
     }
@@ -530,10 +494,10 @@ class EntitiesGenerator
         let registeredEntitiesObject = [];
         for(let tableName in this.generatedEntities){
             let entity = this.generatedEntities[tableName];
-            if(entity.driverKey === driverKey){
-                let camelCaseKey = sc.camelCase(tableName);
-                registeredEntitiesObject.push(camelCaseKey+': '+entity.modelClassName);
+            if(driverKey !== entity.driverKey){
+                continue;
             }
+            registeredEntitiesObject.push(sc.camelCase(tableName)+': '+entity.modelClassName);
         }
         return registeredEntitiesObject.join(',\n    ');
     }
@@ -541,15 +505,13 @@ class EntitiesGenerator
     applyReplacements(content, replacements)
     {
         let result = content;
-        for(let placeholder in replacements){
-            result = result.replace(
-                new RegExp('{{'+placeholder+'}}', 'g'),
-                replacements[placeholder]
-            );
+        for(let placeholder of Object.keys(replacements)){
+            result = result.replace(new RegExp('{{'+placeholder+'}}','g'), replacements[placeholder]);
         }
         return result;
     }
 
+
     async generate()
     {
         if(!this.server){
@@ -566,7 +528,9 @@ class EntitiesGenerator
             Logger.critical('EntitiesGenerator tables fetch failed.');
             return false;
         }
-        this.ensureFoldersExist();
+        if(!this.ensureFoldersExist()){
+            return false;
+        }
         let driverKey = sc.get(
             this.connectionData,
             'driver',
@@ -595,7 +559,8 @@ class EntitiesGenerator
         let driverKey = sc.get(this.connectionData, 'driver', 'objection-js');
         let driverClassMapped = this.driverMap[driverKey];
         if(!driverClassMapped){
-            ErrorManager.error('Unsupported driver: '+driverKey);
+            Logger.critical('Unsupported driver: '+driverKey);
+            return false;
         }
         this.server = new driverClassMapped({
             client: sc.get(this.connectionData, 'client', 'mysql2'),
@@ -610,6 +575,23 @@ class EntitiesGenerator
         return this.server;
     }
 
+    ensureFoldersExist()
+    {
+        if(!FileHandler.createFolder(this.generationFolder)){
+            Logger.critical('Failed to create generation folder.');
+            return false;
+        }
+        if(!FileHandler.createFolder(this.entitiesFolder)){
+            Logger.critical('Failed to create entities folder.');
+            return false;
+        }
+        if(!FileHandler.createFolder(this.modelsFolder)){
+            Logger.critical('Failed to create models folder.');
+            return false;
+        }
+        return true;
+    }
+
 }
 
 module.exports.EntitiesGenerator = EntitiesGenerator;

package/lib/mikro-orm/mikro-orm-driver.js

@@ -12,7 +12,6 @@ class MikroOrmDriver extends BaseDriver
 
     constructor(props)
     {
-        // @TODO - BETA - Finish implementation.
         super(props);
         if(!props.orm){
             ErrorManager.error('Missing ORM on Mikro ORM driver.');

package/lib/mysql-tables-provider.js

@@ -4,7 +4,7 @@
  *
  */
 
-const { ErrorManager, sc } = require('@reldens/utils');
+const { Logger, sc } = require('@reldens/utils');
 
 class MySQLTablesProvider
 {
@@ -30,7 +30,8 @@ class MySQLTablesProvider
         try {
             let result = await server.rawQuery(tablesQuery);
             if(!sc.isArray(result) || 0 === result.length){
-                ErrorManager.error('No tables found in the database.');
+                Logger.critical('No tables found in the database.');
+                return false;
             }
             let tables = {};
             for(let row of result){
@@ -63,18 +64,20 @@ class MySQLTablesProvider
                 '    AND REFERENCED_TABLE_NAME IS NOT NULL;';
 
             let foreignKeysResult = await server.rawQuery(foreignKeysQuery);
-            if(sc.isArray(foreignKeysResult) && 0 < foreignKeysResult.length){
-                for(let row of foreignKeysResult){
-                    if(tables[row.TABLE_NAME] && tables[row.TABLE_NAME].columns[row.COLUMN_NAME]){
-                        tables[row.TABLE_NAME].columns[row.COLUMN_NAME].referencedTable = row.REFERENCED_TABLE_NAME;
-                        tables[row.TABLE_NAME].columns[row.COLUMN_NAME].referencedColumn = row.REFERENCED_COLUMN_NAME;
-                    }
+            if(!sc.isArray(foreignKeysResult) || 0 < foreignKeysResult.length){
+                return tables;
+            }
+            for(let row of foreignKeysResult){
+                if(tables[row.TABLE_NAME] && tables[row.TABLE_NAME].columns[row.COLUMN_NAME]){
+                    tables[row.TABLE_NAME].columns[row.COLUMN_NAME].referencedTable = row.REFERENCED_TABLE_NAME;
+                    tables[row.TABLE_NAME].columns[row.COLUMN_NAME].referencedColumn = row.REFERENCED_COLUMN_NAME;
                 }
             }
             return tables;
         } catch(error) {
-            ErrorManager.error('Failed to fetch tables from database: '+error.message);
+            Logger.critical('Failed to fetch tables from database: '+error.message);
         }
+        return false;
     }
 
 }

package/lib/prisma/prisma-schema-generator.js

@@ -31,9 +31,9 @@ class PrismaSchemaGenerator
             execSync('npx prisma generate', { stdio: 'inherit' });
             return true;
         } catch(error) {
-            ErrorManager.error('Failed to generate Prisma schema. '+error.message);
-            return false;
+            Logger.critical('Failed to generate Prisma schema. '+error.message);
         }
+        return false;
     }
 
     generateSchemaFile()

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@reldens/storage",
     "scope": "@reldens",
-    "version": "0.42.0",
+    "version": "0.44.0",
     "description": "Reldens - Storage",
     "author": "Damian A. Pastorini",
     "license": "MIT",
@@ -32,19 +32,11 @@
         "database",
         "db",
         "system",
-        "game",
-        "mmorpg",
-        "rpg",
-        "dwd",
-        "colyseus",
-        "phaser",
-        "parcel",
         "nodejs",
-        "mmo",
-        "multiplayer",
-        "rol",
         "platform",
-        "framework"
+        "framework",
+        "library",
+        "lib"
     ],
     "bugs": {
         "url": "https://github.com/damian-pastorini/reldens-storage/issues"