zumito-framework 1.1.78 → 1.1.80

package/dist/types/Module.d.ts

@@ -21,6 +21,9 @@ 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>;

package/dist/types/Module.js

@@ -37,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.
                 */
@@ -164,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',
             },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zumito-framework",
-  "version": "1.1.78",
+  "version": "1.1.80",
   "description": "Discord.js bot framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,7 +34,7 @@
     "express": "^4.18.1",
     "leven": "^4.0.0",
     "mongoose": "^6.6.5",
-    "semver": "^7.5.3",
+    "semver": "^7.5.4",
     "tingodb": "^0.6.1"
   },
   "devDependencies": {

package/dist/baseModule/BaseModule.d.ts

@@ -1,6 +0,0 @@
-import { Module } from "../types/Module";
-import { ZumitoFramework } from "../ZumitoFramework";
-export declare class baseModule extends Module {
-    constructor(modulePath: string, framework: ZumitoFramework);
-    registerEvents(): void;
-}

package/dist/baseModule/BaseModule.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.baseModule = void 0;
-const Module_1 = require("../types/Module");
-const interactionCreate_1 = require("./events/discord/interactionCreate");
-const messageCreate_1 = require("./events/discord/messageCreate");
-class baseModule extends Module_1.Module {
-    constructor(modulePath, framework) {
-        super(modulePath, framework);
-    }
-    registerEvents() {
-        this.events.set('interactionCreate', new interactionCreate_1.InteractionCreate());
-        this.events.set('messageCreate', new messageCreate_1.MessageCreate());
-    }
-}
-exports.baseModule = baseModule;

package/dist/baseModule/events/discord/interactionCreate.d.ts

@@ -1,8 +0,0 @@
-import { Command } from '../../../types/Command.js';
-import { EventParameters } from '../../../types/EventParameters.js';
-import { FrameworkEvent } from '../../../types/FrameworkEvent.js';
-export declare class InteractionCreate extends FrameworkEvent {
-    once: boolean;
-    execute({ interaction, client, framework, }: EventParameters): Promise<void>;
-    getTransMethod(commandInstance: Command, framework: any, guildSettings: any): (key: string, params?: any) => any;
-}

package/dist/baseModule/events/discord/interactionCreate.js

@@ -1,121 +0,0 @@
-import { CommandType } from '../../../types/CommandType.js';
-import { FrameworkEvent } from '../../../types/FrameworkEvent.js';
-export class InteractionCreate extends FrameworkEvent {
-    once = false;
-    async execute({ interaction, client, framework, }) {
-        let guildSettings;
-        if (interaction.guildId) {
-            guildSettings = await framework.getGuildSettings(interaction.guildId);
-        }
-        if (interaction.isCommand()) {
-            if (!framework.commands.has(interaction.commandName))
-                return;
-            const commandInstance = framework.commands.get(interaction.commandName);
-            const args = new Map();
-            commandInstance.args.forEach((arg) => {
-                const option = interaction.options.get(arg.name);
-                if (option) {
-                    switch (arg.type) {
-                        case 'user':
-                            args.set(arg.name, option.user);
-                            break;
-                        case 'member':
-                            args.set(arg.name, option.member);
-                            break;
-                        default:
-                            args.set(arg.name, option.value ||
-                                option.user ||
-                                option.role ||
-                                option.channel ||
-                                option.options ||
-                                option.message ||
-                                option.member ||
-                                option.focused ||
-                                option.autocomplete ||
-                                option.attachment);
-                            break;
-                    }
-                }
-            });
-            if (![
-                CommandType.any,
-                CommandType.separated,
-                CommandType.slash,
-            ].includes(commandInstance.type))
-                return;
-            const trans = this.getTransMethod(commandInstance, framework, guildSettings);
-            if (commandInstance.type === CommandType.separated ||
-                commandInstance.type === CommandType.slash) {
-                await commandInstance.executeSlashCommand({
-                    client,
-                    interaction,
-                    args,
-                    framework,
-                    guildSettings,
-                    trans,
-                });
-            }
-            else {
-                await commandInstance.execute({
-                    client,
-                    interaction,
-                    args,
-                    framework,
-                    guildSettings,
-                    trans,
-                });
-            }
-        }
-        else if (interaction.isButton()) {
-            interaction = interaction;
-            const path = interaction.customId.split('.');
-            const commandInstance = framework.commands.get(path[0]);
-            if (!commandInstance)
-                throw new Error(`Command ${path[0]} not found or button id bad formatted`);
-            // If the command has impements ButtonPress class then execute the method
-            if (commandInstance.constructor.prototype.hasOwnProperty('buttonPressed')) {
-                commandInstance.buttonPressed({
-                    path,
-                    interaction,
-                    client,
-                    framework,
-                    guildSettings,
-                });
-            }
-        }
-        else if (interaction.isSelectMenu()) {
-            const path = interaction.customId.split('.');
-            const commandInstance = framework.commands.get(path[0]);
-            if (!commandInstance)
-                throw new Error(`Command ${path[0]} not found or select menu id bad formatted`);
-            const trans = (key, params) => {
-                if (key.startsWith('$')) {
-                    return framework.translations.get(key.replace('$', ''), guildSettings.lang, params);
-                }
-                else {
-                    return framework.translations.get('command.' + commandInstance.name + '.' + key, guildSettings.lang, params);
-                }
-            };
-            if (commandInstance.selectMenu) {
-                commandInstance.selectMenu({
-                    path,
-                    interaction,
-                    client,
-                    framework,
-                    guildSettings,
-                    trans,
-                });
-            }
-        }
-    }
-    getTransMethod(commandInstance, framework, guildSettings) {
-        return (key, params) => {
-            if (key.startsWith('$')) {
-                return framework.translations.get(key.replace('$', ''), guildSettings.lang, params);
-            }
-            else {
-                return framework.translations.get('command.' + commandInstance.name + '.' + key, guildSettings.lang, params);
-            }
-        };
-    }
-}

package/dist/baseModule/events/discord/messageCreate.d.ts

@@ -1,16 +0,0 @@
-import { ActionRowBuilder, EmbedBuilder } from 'discord.js';
-import { EventParameters } from '../../../types/EventParameters.js';
-import { FrameworkEvent } from '../../../types/FrameworkEvent.js';
-export declare class MessageCreate extends FrameworkEvent {
-    once: boolean;
-    execute({ message, client, framework }: EventParameters): Promise<import("discord.js").Message<boolean>>;
-    autocorrect(str: string, words: string[]): any;
-    getErrorEmbed(error: any, parse: any): {
-        embeds: EmbedBuilder[];
-        components: ActionRowBuilder<import("@discordjs/builders").AnyComponentBuilder>[];
-        allowedMentions: {
-            repliedUser: boolean;
-        };
-    };
-    parseError(error: any): any;
-}

package/dist/baseModule/events/discord/messageCreate.js

@@ -1,271 +0,0 @@
-import * as url from 'url';
-import { ActionRowBuilder, ButtonBuilder, ButtonStyle, ChannelType, EmbedBuilder, PermissionsBitField, } from 'discord.js';
-import ErrorStackParser from 'error-stack-parser';
-import { FrameworkEvent } from '../../../types/FrameworkEvent.js';
-import { ZumitoFramework } from '../../../ZumitoFramework.js';
-import leven from 'leven';
-import path from 'path';
-export class MessageCreate extends FrameworkEvent {
-    once = false;
-    async execute({ message, client, framework }) {
-        const channel = message.channel;
-        const prefix = framework.settings.defaultPrefix;
-        const args = ZumitoFramework.splitCommandLine(message.content.slice(prefix.length));
-        const command = args.shift().toLowerCase();
-        let commandInstance;
-        if (message.content.startsWith(prefix)) {
-            if (!framework.commands.has(command)) {
-                const commandNames = Array.from(framework.commands.keys());
-                const correctedCommand = this.autocorrect(command, commandNames);
-                if (framework.commands.has(correctedCommand)) {
-                    commandInstance = framework.commands.get(correctedCommand);
-                }
-                else {
-                    return; // Command not found
-                }
-            }
-            else {
-                commandInstance = framework.commands.get(command);
-            }
-            if (message.guild == null && commandInstance.dm == false)
-                return;
-            if (commandInstance.adminOnly ||
-                commandInstance.userPermissions.length > 0) {
-                let denied = false;
-                if (framework.memberHasPermission(message.member, message.channel, PermissionsBitField.Flags.Administrator) ||
-                    message.member.id != message.guild.ownerId) {
-                    if (commandInstance.userPermissions.length > 0) {
-                        commandInstance.userPermissions.forEach((permission) => {
-                            if (!framework.memberHasPermission(message.member, message.channel, permission)) {
-                                denied = true;
-                            }
-                        });
-                    }
-                }
-                if (denied) {
-                    return message.reply({
-                        content: 'You do not have permission to use this command.',
-                        allowedMentions: {
-                            repliedUser: false,
-                        },
-                    });
-                }
-            }
-            if (message.channel.isTextBased) {
-                const channel = message.channel;
-                // Check command is nsfw and if channel is allowed
-                if (commandInstance.nsfw &&
-                    !channel.nsfw &&
-                    !channel
-                        .permissionsFor(message.member)
-                        .has(PermissionsBitField.Flags.Administrator) &&
-                    message.member.id != message.guild.ownerId) {
-                    return message.reply({
-                        content: 'This command is nsfw and this channel is not nsfw.',
-                        allowedMentions: {
-                            repliedUser: false,
-                        },
-                    });
-                }
-            }
-            try {
-                const guildSettings = await framework.getGuildSettings(message.guildId);
-                const parsedArgs = new Map();
-                const userMentionCount = 0;
-                for (let i = 0; i < args.length; i++) {
-                    const arg = args[i];
-                    const type = commandInstance.args[i]?.type;
-                    if (type) {
-                        if (type == 'member' || type == 'user') {
-                            const member = await message.guild.members.cache.get(arg.replace(/[<@!>]/g, ''));
-                            if (member) {
-                                if (type == 'user') {
-                                    parsedArgs.set(commandInstance.args[i].name, member.user);
-                                }
-                                else {
-                                    parsedArgs.set(commandInstance.args[i].name, member);
-                                }
-                            }
-                            else {
-                                return message.reply({
-                                    content: 'Invalid user.',
-                                    allowedMentions: {
-                                        repliedUser: false,
-                                    },
-                                });
-                            }
-                        }
-                        else if (type == 'string') {
-                            parsedArgs.set(commandInstance.args?.[i]?.name || i.toString(), arg);
-                        }
-                    }
-                }
-                await commandInstance.execute({
-                    message,
-                    args: parsedArgs,
-                    client: framework.client,
-                    framework: framework,
-                    guildSettings: guildSettings,
-                    trans: (key, params) => {
-                        if (key.startsWith('$')) {
-                            return framework.translations.get(key.replace('$', ''), guildSettings.lang, params);
-                        }
-                        else {
-                            return framework.translations.get('command.' + commandInstance.name + '.' + key, guildSettings.lang, params);
-                        }
-                    },
-                });
-                if (!message.channel.isDMBased && !message.deletable) {
-                    return; // TODO: test if this works
-                    // false = settings.deleteCommands
-                    try {
-                        message.delete().catch(function () {
-                            console.error("can't delete user command");
-                        });
-                        const metadata = await fetch('https://tulipo.ga/api/last_command/' + command).then((res) => res.json());
-                    }
-                    catch (err) {
-                        console.error(err.name, err.message);
-                    }
-                }
-            }
-            catch (error) {
-                const content = await this.getErrorEmbed({
-                    name: error.name,
-                    message: error.message,
-                    command: commandInstance,
-                    args: args,
-                    stack: error.stack,
-                }, true);
-                try {
-                    message.reply(content);
-                }
-                catch (e) {
-                    if (channel.type !== ChannelType.GuildStageVoice) {
-                        channel.send(content);
-                    }
-                }
-            }
-        }
-    }
-    autocorrect(str, words) {
-        let distance, bestWord, i, word, min;
-        const dictionary = words || [];
-        const len = dictionary.length;
-        for (i = 0; i < len; i++) {
-            word = dictionary[i];
-            distance = leven(str, word);
-            if (distance === 0) {
-                return word;
-            }
-            else if (min === undefined || distance < min) {
-                min = distance;
-                bestWord = word;
-            }
-        }
-        return bestWord;
-    }
-    getErrorEmbed(error, parse) {
-        let parsedError;
-        if (parse) {
-            parsedError = this.parseError(error);
-        }
-        else {
-            parsedError = error;
-        }
-        const embed = new EmbedBuilder()
-            .setTitle('Error')
-            .setDescription('An error has occured while executing this command.')
-            .setTimestamp()
-            .addFields([
-            {
-                name: 'Command:',
-                value: error.command.name || 'Not defined',
-            },
-        ])
-            .addFields([
-            {
-                name: 'Arguments:',
-                value: error.args.toString() || 'None',
-            },
-        ])
-            .addFields([
-            {
-                name: 'Error name:',
-                value: error.name || 'Not defined',
-            },
-        ])
-            .addFields([
-            {
-                name: 'Error message:',
-                value: error.message || 'Not defined',
-            },
-        ]);
-        if (error.possibleSolutions !== undefined) {
-            error.possibleSolutions.forEach((solution) => {
-                embed.addFields([
-                    {
-                        name: 'Posible solution:',
-                        value: solution,
-                    },
-                ]);
-            });
-        }
-        const stackFrames = ErrorStackParser.parse(error).filter((e) => !e.fileName.includes('node_modules') &&
-            !e.fileName.includes('node:internal'));
-        let stack = '';
-        const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
-        const path1 = path.resolve('./');
-        const path2 = path1.replaceAll('\\', '/');
-        stackFrames.forEach((frame) => {
-            stack += `[${frame.fileName
-                .replace(path1, '')
-                .replace(path2, '')
-                .replace('file://', '')}:${frame.lineNumber}](https://zumito.ga/redirect?url=vscode://file/${frame.fileName.replace('file://', '')}:${frame.lineNumber}) ${frame.functionName}()\n`;
-        });
-        if (error.stack !== undefined) {
-            embed.addFields([
-                {
-                    name: 'Call stack:',
-                    value: stack || error.stack || error.stack.toString(),
-                },
-            ]);
-        }
-        if (error.details !== undefined) {
-            error.details.forEach((detail) => {
-                embed.addFields([
-                    {
-                        name: 'Detail:',
-                        value: detail,
-                    },
-                ]);
-            });
-        }
-        const body = `\n\n\n---\nComand:\`\`\`${error.command.name || 'not defined'}\`\`\`\nArguments:\`\`\`${error.args.toString() || 'none'}\`\`\`\nError:\`\`\`${error.name || 'not defined'}\`\`\`\nError message:\`\`\`${error.message || 'not defined'}\`\`\`\n`;
-        const requestUrl = `https://github.com/ZumitoTeam/Zumito/issues/new?body=${encodeURIComponent(body)}`;
-        const row = new ActionRowBuilder().addComponents(new ButtonBuilder()
-            .setStyle(ButtonStyle.Link)
-            .setLabel('Report error')
-            .setEmoji('975645505302437978')
-            .setURL(requestUrl));
-        return {
-            embeds: [embed],
-            components: [row],
-            allowedMentions: {
-                repliedUser: false,
-            },
-        };
-    }
-    parseError(error) {
-        error.possibleSolutions = [];
-        if (/(?:^|(?<= ))(EmbedBuilder|Discord|ActionRowBuilder|ButtonBuilder|MessageSelectMenu)(?:(?= )|$) is not defined/gm.test(error.message)) {
-            error.possibleSolutions.push('const { ' +
-                error.message.split(' ')[0] +
-                " } = require('discord.js');");
-        }
-        else if (error.message.includes('A custom id and url cannot both be specified')) {
-            error.possibleSolutions.push('Remove .setCustomId(...) or .setURL(...)');
-        }
-        return error;
-    }
-}

package/dist/types/Commands.d.ts

@@ -1,23 +0,0 @@
-import { CommandParameters } from "./CommandParameters";
-import { SelectMenuParameters } from "./SelectMenuParameters";
-export declare abstract class Command {
-    name: string;
-    categories: string[];
-    aliases?: string[];
-    examples?: string[];
-    permissions?: bigint[];
-    botPermissions?: string[];
-    hidden?: boolean;
-    adminOnly?: boolean;
-    nsfw?: boolean;
-    cooldown?: number;
-    slashCommand?: boolean;
-    dm: boolean;
-    args: CommandArgDefinition[];
-    type: string;
-    constructor();
-    abstract execute({ message, interaction, args, client, framework }: CommandParameters): void;
-    executePrefixCommand({ message, interaction, args, client, framework }: CommandParameters): void;
-    executeSlashCommand({ message, interaction, args, client, framework }: CommandParameters): void;
-    selectMenu({ path, interaction, client, framework }: SelectMenuParameters): void;
-}

package/dist/types/Commands.js

@@ -1,26 +0,0 @@
-import { CommandType } from "./CommandType.js";
-export class Command {
-    name = this.constructor.name.toLowerCase();
-    categories = [];
-    aliases = [];
-    examples = [];
-    permissions = [];
-    botPermissions = [];
-    hidden = false;
-    adminOnly = false;
-    nsfw = false;
-    cooldown = 0;
-    slashCommand = false;
-    dm = false;
-    args = [];
-    type = CommandType.prefix;
-    constructor() {
-    }
-    executePrefixCommand({ message, interaction, args, client, framework }) {
-        this.execute({ message, interaction, args, client, framework });
-    }
-    executeSlashCommand({ message, interaction, args, client, framework }) {
-        this.execute({ message, interaction, args, client, framework });
-    }
-    selectMenu({ path, interaction, client, framework }) { }
-}