zumito-framework 1.1.79 → 1.1.80

package/dist/ZumitoFramework.d.ts

@@ -64,7 +64,7 @@ export declare class ZumitoFramework {
      * @see {@link TranslationManager}
      */
     translations: TranslationManager;
-    routes: Map<string, (req: Request, res: Response) => void>;
+    routes: any;
     /**
      * The database models loaded in the framework.
      * @type {Array<DatabaseModel>}

package/dist/ZumitoFramework.js

@@ -131,7 +131,6 @@ export class ZumitoFramework {
         this.events = new Map();
         this.translations = new TranslationManager();
         this.models = [];
-        this.routes = new Map();
         this.eventManager = new EventManager();
         if (settings.logLevel) {
             console.logLevel = settings.logLevel;
@@ -210,9 +209,6 @@ export class ZumitoFramework {
         //Route Prefixes
         //this.app.use("/", indexRouter);
         //this.app.use("/api/", apiRouter);
-        this.routes.forEach((router, path) => {
-            this.app.use(path, router);
-        });
         // throw 404 if URL not found
         this.app.all('*', function (req, res) {
             return ApiResponse.notFoundResponse(res, 'Page not found');
@@ -304,8 +300,12 @@ export class ZumitoFramework {
         moduleInstance.getModels().forEach((model) => {
             this.models.push(model);
         });
+        /*
+
         // Register module routes
         this.routes = new Map([...this.routes, ...moduleInstance.getRoutes()]);
+
+        */
     }
     /**
      * Initializes the Discord client using the Discord.js library.

package/dist/index.d.ts

@@ -21,5 +21,4 @@ import { TranslationManager } from './TranslationManager.js';
 import { ZumitoFramework } from './ZumitoFramework.js';
 import * as discord from 'discord.js';
 import { EventParameters } from './types/EventParameters.js';
-import { FrameworkRouter } from './types/FrameworkRouter.js';
-export { ZumitoFramework, FrameworkSettings, Command, Module, CommandParameters, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, SelectMenuParameters, CommandType, CommandArgDefinition, CommandChoiceDefinition, ButtonPressed, ButtonPressedParams, TextFormatter, EmojiFallback, DatabaseConfigLoader, DatabaseModel, PresenceDataRule, RuledPresenceData, StatusManagerOptions, discord, EventParameters, FrameworkRouter, };
+export { ZumitoFramework, FrameworkSettings, Command, Module, CommandParameters, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, SelectMenuParameters, CommandType, CommandArgDefinition, CommandChoiceDefinition, ButtonPressed, ButtonPressedParams, TextFormatter, EmojiFallback, DatabaseConfigLoader, DatabaseModel, PresenceDataRule, RuledPresenceData, StatusManagerOptions, discord, EventParameters, };

package/dist/index.js

@@ -13,5 +13,4 @@ import { Translation } from './types/Translation.js';
 import { TranslationManager } from './TranslationManager.js';
 import { ZumitoFramework } from './ZumitoFramework.js';
 import * as discord from 'discord.js';
-import { FrameworkRouter } from './types/FrameworkRouter.js';
-export { ZumitoFramework, Command, Module, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, CommandType, ButtonPressed, TextFormatter, EmojiFallback, DatabaseConfigLoader, DatabaseModel, discord, FrameworkRouter, };
+export { ZumitoFramework, Command, Module, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, CommandType, ButtonPressed, TextFormatter, EmojiFallback, DatabaseConfigLoader, DatabaseModel, discord, };

package/dist/types/Module.d.ts

@@ -2,14 +2,12 @@ import { ZumitoFramework } from '../ZumitoFramework.js';
 import { Command } from './Command.js';
 import { FrameworkEvent } from './FrameworkEvent.js';
 import { DatabaseModel } from './DatabaseModel.js';
-import { Request, Response } from 'express';
 export declare abstract class Module {
     protected path: string;
     protected framework: ZumitoFramework;
     protected commands: Map<string, Command>;
     protected events: Map<string, FrameworkEvent>;
     protected models: Array<DatabaseModel>;
-    protected routes: Map<string, (req: Request, res: Response) => void>;
     constructor(path: any, framework: any);
     initialize(): Promise<void>;
     registerCommands(): Promise<void>;
@@ -23,10 +21,11 @@ export declare abstract class Module {
     parseEventArgs(args: any[]): any;
     getEvents(): Map<string, FrameworkEvent>;
     registerTranslations(subpath?: string): Promise<void>;
+    onTranslationCreated(filePath: string): Promise<void>;
+    onTranslationChanged(filePath: string): Promise<void>;
+    onErrorLoadingTranslation(error: Error): void;
     loadTranslationFile(subpath: string, file: string): Promise<any>;
     parseTranslation(path: string, lang: string, json: any): any;
     registerModels(): Promise<void>;
     getModels(): Array<DatabaseModel>;
-    registerRoutes(subpath?: string): Promise<void>;
-    getRoutes(): Map<string, (req: Request, res: Response) => void>;
 }

package/dist/types/Module.js

@@ -4,14 +4,12 @@ import boxen from 'boxen';
 import * as fs from 'fs';
 import path from 'path';
 import { ButtonInteraction, CommandInteraction, ModalSubmitInteraction, StringSelectMenuInteraction, } from 'discord.js';
-import { FrameworkRouter } from "./FrameworkRouter.js";
 export class Module {
     path;
     framework;
     commands = new Map();
     events = new Map();
     models = [];
-    routes = new Map();
     constructor(path, framework) {
         this.path = path;
         this.framework = framework;
@@ -21,7 +19,6 @@ export class Module {
         await this.registerEvents();
         await this.registerTranslations();
         await this.registerModels();
-        await this.registerRoutes();
     }
     async registerCommands() {
         if (fs.existsSync(path.join(this.path, 'commands'))) {
@@ -40,7 +37,7 @@ export class Module {
             // register watcher
             if (process.env.DEBUG) {
                 /*
-                    Debug only cause in prod environment commands should't be changed.
+                    Debug only cause in prod environment commands should't be changed in runtime.
                     Appart from that, esm module cache invalidation is not working properly
                     and can cause memory leaks and crashes.
                 */
@@ -167,11 +164,59 @@ export class Module {
                 await this.registerTranslations(path.join(subpath, file));
             }
         }
+        // register watcher
+        if (process.env.DEBUG) {
+            /*
+                Debug only cause in prod environment translations should't be changed on runtime.
+                Appart from that, esm module cache invalidation is not working properly
+                and can cause memory leaks and crashes.
+            */
+            chokidar
+                .watch(path.resolve(path.join(this.path, 'translations')), {
+                ignored: /^\./,
+                persistent: true,
+                ignoreInitial: true,
+            })
+                .on('add', this.onTranslationCreated.bind(this))
+                .on('change', this.onTranslationChanged.bind(this))
+                //.on('unlink', function(path) {console.log('File', path, 'has been removed');})
+                .on('error', this.onErrorLoadingTranslation.bind(this));
+        }
+    }
+    async onTranslationCreated(filePath) {
+        if (filePath.endsWith('.json')) {
+            const subpath = path.dirname(filePath).replace(this.path + '/translations', '');
+            const fileName = path.basename(filePath);
+            const json = await this.loadTranslationFile(subpath, fileName);
+            const lang = fileName.slice(0, -5);
+            const baseKey = subpath
+                ? subpath.substring(1).replaceAll('/', '.').replaceAll('\\', '.') + '.'
+                : '';
+            this.parseTranslation(baseKey, lang, json);
+            console.debug('[🆕🟢 ] translations file ' + chalk.blue(filePath.replace(/^.*[\\\/]/, '').split('.').slice(0, -1).join('.')) + ' loaded');
+        }
+    }
+    async onTranslationChanged(filePath) {
+        if (filePath.endsWith('.json')) {
+            const subpath = path.dirname(filePath).replace(this.path + '/translations', '');
+            const fileName = path.basename(filePath);
+            const json = await this.loadTranslationFile(subpath, fileName);
+            const lang = fileName.slice(0, -5);
+            const baseKey = subpath
+                ? subpath.substring(1).replaceAll('/', '.').replaceAll('\\', '.') + '.'
+                : '';
+            this.parseTranslation(baseKey, lang, json);
+            console.debug('[🆕🟢 ] translations file ' + chalk.blue(filePath.replace(/^.*[\\\/]/, '').split('.').slice(0, -1).join('.')) + ' reloaded');
+        }
+    }
+    onErrorLoadingTranslation(error) {
+        console.error('[🔄🔴 ] Error reloading translation file');
+        console.log(boxen(error + '\n' + error.stack, { padding: 1 }));
     }
     async loadTranslationFile(subpath, file) {
         if (subpath)
             subpath = subpath + '/';
-        const json = await import('file://' + `${this.path}/translations/${subpath}${file}`, {
+        const json = await import('file://' + `${this.path}/translations/${subpath}${file}?update=${Date.now().toString()}`, {
             assert: {
                 type: 'json',
             },
@@ -210,28 +255,4 @@ export class Module {
     getModels() {
         return this.models;
     }
-    async registerRoutes(subpath = '') {
-        if (!fs.existsSync(path.join(this.path, 'routes', subpath)))
-            return;
-        const files = fs.readdirSync(path.join(this.path, 'routes', subpath));
-        for (const file of files) {
-            if (file.endsWith('.js') || file.endsWith('.ts')) {
-                const Router = await import('file://' + `${this.path}/routes/${subpath}/${file}`).then(r => Object.values(r)[0]);
-                if (Router.prototype instanceof FrameworkRouter) {
-                    const router = new Router(subpath ? '/' + subpath : '');
-                    this.routes = new Map([...this.routes, ...router.getRoutes()]);
-                }
-                else {
-                    console.warn(`[🔄🟡 ] ${subpath}/${file} is not a valid router on module ${this.constructor.name} \n It must extend the FrameworkRouter class instead of ${Router.prototype}`);
-                    continue;
-                }
-            }
-            else if (fs.lstatSync(path.join(this.path, 'routes', subpath, file)).isDirectory()) {
-                await this.registerRoutes(path.join(subpath, file));
-            }
-        }
-    }
-    getRoutes() {
-        return this.routes;
-    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zumito-framework",
-  "version": "1.1.79",
+  "version": "1.1.80",
   "description": "Discord.js bot framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/types/FrameworkRouter.d.ts

@@ -1,6 +0,0 @@
-import { Request, Response } from 'express';
-export declare abstract class FrameworkRouter {
-    basePath: string;
-    constructor(basePath: string);
-    abstract getRoutes(): Map<string, (req: Request, res: Response) => void>;
-}

package/dist/types/FrameworkRouter.js

@@ -1,6 +0,0 @@
-export class FrameworkRouter {
-    basePath = '';
-    constructor(basePath) {
-        this.basePath = basePath;
-    }
-}