zumito-framework 1.1.55 → 1.1.57

package/dist/TranslationManager.d.ts

@@ -1,4 +1,4 @@
-import { Translation } from "./types/Translation.js";
+import { Translation } from './types/Translation.js';
 export declare class TranslationManager {
     private translations;
     private defaultLanguage;

package/dist/TranslationManager.js

@@ -1,4 +1,4 @@
-import { Translation } from "./types/Translation.js";
+import { Translation } from './types/Translation.js';
 export class TranslationManager {
     translations = new Map();
     defaultLanguage = 'en';

package/dist/ZumitoFramework.d.ts

@@ -1,20 +1,25 @@
-import { GuildMember, TextChannel } from "discord.js";
-import { Command } from "./types/Command.js";
-import { FrameworkSettings } from "./types/FrameworkSettings.js";
-import { Module } from "./types/Module.js";
-import { FrameworkEvent } from "./types/FrameworkEvent.js";
-import { TranslationManager } from "./TranslationManager.js";
+import { GuildMember, TextChannel, Client } from 'discord.js';
+import { Command } from './types/Command.js';
+import { FrameworkSettings } from './types/FrameworkSettings.js';
+import { Module } from './types/Module.js';
+import { FrameworkEvent } from './types/FrameworkEvent.js';
+import { TranslationManager } from './TranslationManager.js';
 /**
  * @class ZumitoFramework
  * @classdesc The main class of the framework.
  *
- * @property {FrameworkSettings} settings - The settings of the framework.
- * @property {Client} client - The client client instance.
- * @property {Collection<string, Module>} modules - The modules loaded in the framework.
- * @property {Collection<string, Command>} commands - The commands loaded in the framework.
+ * @property {FrameworkSettings} settings - The settings for the framework.
+ * @property {Client} client - The discord client instance.
+ * @property {Map<string, Module>} modules - The modules loaded in the framework.
+ * @property {Map<string, Command>} commands - The commands loaded in the framework.
+ * @property {Map<string, FrameworkEvent>} events - The events loaded in the framework.
+ * @property {TranslationManager} translations - The Translation Manager for the framework.
+ * @property {Map<string, any>} models - The database models loaded in the framework.
+ * @property {mongoose.Connection} database - The connection to the MongoDB database.
+ * @property {express.Application} app - The ExpressJS application for the API server.
  */
 export declare class ZumitoFramework {
-    client: any;
+    client: Client;
     settings: FrameworkSettings;
     modules: Map<string, Module>;
     commands: Map<string, Command>;
@@ -26,26 +31,92 @@ export declare class ZumitoFramework {
     app: any;
     /**
      * @constructor
-     * @description Creates a new instance of the framework.
-     * @param {FrameworkSettings} settings - The settings of the framework.
-     * @example new ZumitoFramework({
-     *     prefix: '!',
-     *     discordClientOptions: {
-     *        token: 'token',
-     *        clientId: 'clientId',
-     *       intents: 0
-     *    }
-     * });
-     * @public
+     * @param {FrameworkSettings} settings - The settings to use for the framework.
+     * @param {(framework: ZumitoFramework) => void} [callback] - A callback to be called when the framework has finished initializing.
+     */
+    constructor(settings: FrameworkSettings, callback?: (framework: any) => void);
+    /**
+     * Initializes the framework.
+     * Connects to the MongoDB database, starts the Discord client, and runs API server.
+     * It also loads the modules from the project's modules folder.
+     * @async
+     * @private
+     * @returns {Promise<void>}
+     */
+    private initialize;
+    /**
+     * Initializes and starts the API server using ExpressJS.
+     * Sets up middleware, routes, and error handling for the server.
      */
-    constructor(settings: FrameworkSettings, callback?: Function);
-    initialize(): Promise<void>;
     startApiServer(): void;
+    /**
+     * Register all modules in the 'modules' folder.
+     * Scans the specified folder for module files and calls the `registerModule` method for each file.
+     *  Also, it loads the baseModule in the framework.
+     * @private
+     * @returns {Promise<void>}
+     */
     private registerModules;
     private registerModule;
+    /**
+     * Initializes the Discord client using the Discord.js library.
+     * Logs in to the Discord API using the provided token and logs a message when the client is ready.
+     * @private
+     */
     private initializeDiscordClient;
+    /**
+     * From a command-line string, returns an array of parameters.
+     * @param commandLine
+     * @returns {string[]}
+     * @private
+     * @static
+     * @example
+     * // returns ['a', 'b', 'c']
+     * splitCommandLine('a b c');
+     * @example
+     * // returns ['a', 'b c']
+     * splitCommandLine('a "b c"');
+     */
     static splitCommandLine(commandLine: any): any;
+    /**
+     * Checks if a member has a permission in a channel.
+     * @param member
+     * @param channel
+     * @param permission
+     * @returns {Promise<boolean>}
+     * @public
+     * @example
+     * // returns true if the member has the permission
+     * memberHasPermission(member, channel, Permissions.FLAGS.MANAGE_MESSAGES);
+     * @example
+     * // returns true if the member has the permission
+     * memberHasPermission(member, channel, Permissions.FLAGS.MANAGE_MESSAGES | Permissions.FLAGS.MANAGE_CHANNELS);
+     * @example
+     */
     memberHasPermission(member: GuildMember, channel: TextChannel, permission: bigint): Promise<boolean>;
+    /**
+     * Gets the guild settings from the database.
+     * If the guild is not in the database, it is added.
+     * @param guildId
+     * @returns {Promise<any>}
+     * @public
+     * @async
+     * @example
+     * // returns the guild settings
+     * getGuildSettings('123456789012345678');
+     * @example
+     * // returns the guild settings
+     * getGuildSettings(guild.id);
+     * @example
+     * // returns the guild settings
+     * getGuildSettings(message.guild.id);
+     * @example
+     * // returns the guild settings
+     * getGuildSettings(interaction.guild.id);
+     * @example
+     * // returns the guild settings
+     * getGuildSettings(interaction.guildId);
+     */
     getGuildSettings(guildId: string): Promise<any>;
     refreshSlashCommands(): Promise<void>;
 }

package/dist/ZumitoFramework.js

@@ -1,31 +1,35 @@
-import { SlashCommandBuilder } from "discord.js";
-import { Module } from "./types/Module.js";
+import { SlashCommandBuilder, Client, } from 'discord.js';
+import { Module } from './types/Module.js';
 import { ApiResponse } from './definitions/ApiResponse.js';
-import { baseModule } from "./baseModule/index.js";
-import { TranslationManager } from "./TranslationManager.js";
+import { baseModule } from './baseModule/index.js';
+import { TranslationManager } from './TranslationManager.js';
 import express from 'express';
 import * as fs from 'fs';
 import path from 'path';
-import { Client } from "discord.js";
 // import better-logging
-import { betterLogging } from "better-logging";
+import { betterLogging } from 'better-logging';
 betterLogging(console);
 import { REST } from '@discordjs/rest';
 import { Routes } from 'discord-api-types/v9';
-import mongoose from "mongoose";
+import mongoose from 'mongoose';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';
 import http from 'http';
 import * as url from 'url';
-import { CommandType } from "./types/CommandType.js";
+import { CommandType } from './types/CommandType.js';
 /**
  * @class ZumitoFramework
  * @classdesc The main class of the framework.
  *
- * @property {FrameworkSettings} settings - The settings of the framework.
- * @property {Client} client - The client client instance.
- * @property {Collection<string, Module>} modules - The modules loaded in the framework.
- * @property {Collection<string, Command>} commands - The commands loaded in the framework.
+ * @property {FrameworkSettings} settings - The settings for the framework.
+ * @property {Client} client - The discord client instance.
+ * @property {Map<string, Module>} modules - The modules loaded in the framework.
+ * @property {Map<string, Command>} commands - The commands loaded in the framework.
+ * @property {Map<string, FrameworkEvent>} events - The events loaded in the framework.
+ * @property {TranslationManager} translations - The Translation Manager for the framework.
+ * @property {Map<string, any>} models - The database models loaded in the framework.
+ * @property {mongoose.Connection} database - The connection to the MongoDB database.
+ * @property {express.Application} app - The ExpressJS application for the API server.
  */
 export class ZumitoFramework {
     client;
@@ -40,17 +44,8 @@ export class ZumitoFramework {
     app;
     /**
      * @constructor
-     * @description Creates a new instance of the framework.
-     * @param {FrameworkSettings} settings - The settings of the framework.
-     * @example new ZumitoFramework({
-     *     prefix: '!',
-     *     discordClientOptions: {
-     *        token: 'token',
-     *        clientId: 'clientId',
-     *       intents: 0
-     *    }
-     * });
-     * @public
+     * @param {FrameworkSettings} settings - The settings to use for the framework.
+     * @param {(framework: ZumitoFramework) => void} [callback] - A callback to be called when the framework has finished initializing.
      */
     constructor(settings, callback) {
         this.settings = settings;
@@ -62,20 +57,30 @@ export class ZumitoFramework {
         if (settings.logLevel) {
             console.logLevel = settings.logLevel;
         }
-        this.initialize().then(() => {
+        this.initialize()
+            .then(() => {
             if (callback)
                 callback(this);
-        }).catch(err => {
+        })
+            .catch((err) => {
             console.error(err, err.message, err.stack, err.name);
         });
     }
+    /**
+     * Initializes the framework.
+     * Connects to the MongoDB database, starts the Discord client, and runs API server.
+     * It also loads the modules from the project's modules folder.
+     * @async
+     * @private
+     * @returns {Promise<void>}
+     */
     async initialize() {
         try {
             mongoose.set('strictQuery', true);
             await mongoose.connect(this.settings.mongoQueryString);
         }
         catch (err) {
-            console.error("[🗄️🔴] Database connection error:", err.message);
+            console.error('[🗄️🔴] Database connection error:', err.message);
             process.exit(1);
         }
         finally {
@@ -87,11 +92,15 @@ export class ZumitoFramework {
         await this.registerModules();
         await this.refreshSlashCommands();
     }
+    /**
+     * Initializes and starts the API server using ExpressJS.
+     * Sets up middleware, routes, and error handling for the server.
+     */
     startApiServer() {
         this.app = express();
-        let port = process.env.PORT || '80';
+        const port = process.env.PORT || '80';
         this.app.set('port', port);
-        var server = http.createServer(this.app);
+        const server = http.createServer(this.app);
         server.listen(port);
         server.on('error', (err) => {
             console.log('[🌐🔴] Error starting API web server: ' + err);
@@ -109,15 +118,22 @@ export class ZumitoFramework {
         //this.app.use("/", indexRouter);
         //this.app.use("/api/", apiRouter);
         // throw 404 if URL not found
-        this.app.all("*", function (req, res) {
-            return ApiResponse.notFoundResponse(res, "Page not found");
+        this.app.all('*', function (req, res) {
+            return ApiResponse.notFoundResponse(res, 'Page not found');
         });
         this.app.use(function (err, req, res) {
             if (err.name === 'UnauthorizedError') {
-                return ApiResponse.unauthorizedResponse(res, "Invalid token");
+                return ApiResponse.unauthorizedResponse(res, 'Invalid token');
             }
         });
     }
+    /**
+     * Register all modules in the 'modules' folder.
+     * Scans the specified folder for module files and calls the `registerModule` method for each file.
+     *  Also, it loads the baseModule in the framework.
+     * @private
+     * @returns {Promise<void>}
+     */
     async registerModules() {
         let modulesFolder;
         if (fs.existsSync(`${process.cwd()}/modules`)) {
@@ -130,8 +146,8 @@ export class ZumitoFramework {
             return;
         const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
         await this.registerModule(__dirname, 'baseModule', baseModule);
-        let files = fs.readdirSync(modulesFolder);
-        for (let file of files) {
+        const files = fs.readdirSync(modulesFolder);
+        for (const file of files) {
             await this.registerModule(modulesFolder, file);
         }
         this.models.forEach((modelDefinition, modelName) => {
@@ -152,7 +168,6 @@ export class ZumitoFramework {
             else {
                 module = Module;
             }
-            ;
         }
         // Create module instance
         let moduleInstance;
@@ -171,7 +186,10 @@ export class ZumitoFramework {
                 this.commands.set(command.name, command);
             });
         }
-        this.commands = new Map([...this.commands, ...moduleInstance.getCommands()]);
+        this.commands = new Map([
+            ...this.commands,
+            ...moduleInstance.getCommands(),
+        ]);
         // Register module events
         this.events = new Map([...this.events, ...moduleInstance.getEvents()]);
         // Register models
@@ -190,9 +208,14 @@ export class ZumitoFramework {
 
         */
     }
+    /**
+     * Initializes the Discord client using the Discord.js library.
+     * Logs in to the Discord API using the provided token and logs a message when the client is ready.
+     * @private
+     */
     initializeDiscordClient() {
         this.client = new Client({
-            intents: this.settings.discordClientOptions.intents
+            intents: this.settings.discordClientOptions.intents,
         });
         this.client.login(this.settings.discordClientOptions.token);
         this.client.on('ready', () => {
@@ -200,11 +223,24 @@ export class ZumitoFramework {
             console.log('[🤖🟢] Discord client ready');
         });
     }
+    /**
+     * From a command-line string, returns an array of parameters.
+     * @param commandLine
+     * @returns {string[]}
+     * @private
+     * @static
+     * @example
+     * // returns ['a', 'b', 'c']
+     * splitCommandLine('a b c');
+     * @example
+     * // returns ['a', 'b c']
+     * splitCommandLine('a "b c"');
+     */
     static splitCommandLine(commandLine) {
         //log( 'commandLine', commandLine ) ;
         //  Find a unique marker for the space character.
         //  Start with '<SP>' and repeatedly append '@' if necessary to make it unique.
-        var spaceMarker = '<SP>';
+        let spaceMarker = '<SP>';
         while (commandLine.indexOf(spaceMarker) > -1)
             spaceMarker += '@';
         //  Protect double-quoted strings.
@@ -213,21 +249,59 @@ export class ZumitoFramework {
         //   o  Replace each double-quoted-string with what's inside the qouble-quotes,
         //      after each space character has been replaced with the space-marker above.
         //   o  The outer double-quotes will not be present.
-        var noSpacesInQuotes = commandLine.replace(/"([^"]*)"?/g, (fullMatch, capture) => {
+        const noSpacesInQuotes = commandLine.replace(/"([^"]*)"?/g, (fullMatch, capture) => {
             return capture.replace(/ /g, spaceMarker);
         });
         //  Now that it is safe to do so, split the command-line at one-or-more spaces.
-        var mangledParamArray = noSpacesInQuotes.split(/ +/);
+        const mangledParamArray = noSpacesInQuotes.split(/ +/);
         //  Create a new array by restoring spaces from any space-markers.
-        var paramArray = mangledParamArray.map((mangledParam) => {
+        const paramArray = mangledParamArray.map((mangledParam) => {
             return mangledParam.replace(RegExp(spaceMarker, 'g'), ' ');
         });
         return paramArray;
     }
+    /**
+     * Checks if a member has a permission in a channel.
+     * @param member
+     * @param channel
+     * @param permission
+     * @returns {Promise<boolean>}
+     * @public
+     * @example
+     * // returns true if the member has the permission
+     * memberHasPermission(member, channel, Permissions.FLAGS.MANAGE_MESSAGES);
+     * @example
+     * // returns true if the member has the permission
+     * memberHasPermission(member, channel, Permissions.FLAGS.MANAGE_MESSAGES | Permissions.FLAGS.MANAGE_CHANNELS);
+     * @example
+     */
     async memberHasPermission(member, channel, permission) {
-        let memberPermission = await channel.permissionsFor(member);
+        const memberPermission = await channel.permissionsFor(member);
         return memberPermission.has(permission);
     }
+    /**
+     * Gets the guild settings from the database.
+     * If the guild is not in the database, it is added.
+     * @param guildId
+     * @returns {Promise<any>}
+     * @public
+     * @async
+     * @example
+     * // returns the guild settings
+     * getGuildSettings('123456789012345678');
+     * @example
+     * // returns the guild settings
+     * getGuildSettings(guild.id);
+     * @example
+     * // returns the guild settings
+     * getGuildSettings(message.guild.id);
+     * @example
+     * // returns the guild settings
+     * getGuildSettings(interaction.guild.id);
+     * @example
+     * // returns the guild settings
+     * getGuildSettings(interaction.guildId);
+     */
     async getGuildSettings(guildId) {
         const Guild = this.models.get('Guild');
         let guild = await Guild.findOne({ guild_id: guildId }).exec();
@@ -241,10 +315,12 @@ export class ZumitoFramework {
     }
     async refreshSlashCommands() {
         const rest = new REST({ version: '10' }).setToken(this.settings.discordClientOptions.token);
-        let commands = Array.from(this.commands.values())
-            .filter((command) => command.type == CommandType.slash || command.type == CommandType.separated || command.type == CommandType.any)
+        const commands = Array.from(this.commands.values())
+            .filter((command) => command.type == CommandType.slash ||
+            command.type == CommandType.separated ||
+            command.type == CommandType.any)
             .map((command) => {
-            let slashCommand = new SlashCommandBuilder()
+            const slashCommand = new SlashCommandBuilder()
                 .setName(command.name)
                 .setDescription(this.translations.get('command.' + command.name + '.description', 'en'));
             if (command.args) {
@@ -269,17 +345,22 @@ export class ZumitoFramework {
                     }
                     slashCommand[method]((option) => {
                         option.setName(arg.name);
-                        option.setDescription(this.translations.get('command.' + command.name + '.args.' + arg.name + '.description', 'en'));
+                        option.setDescription(this.translations.get('command.' +
+                            command.name +
+                            '.args.' +
+                            arg.name +
+                            '.description', 'en'));
                         option.setRequired(!arg.optional);
                         if (arg.choices) {
                             // if arg.choices is function, call it
                             if (typeof arg.choices == 'function') {
-                                arg.choices = arg.choices();
+                                arg.choices =
+                                    arg.choices();
                             }
                             arg.choices.forEach((choice) => {
                                 option.addChoices({
                                     name: choice.name,
-                                    value: choice.value
+                                    value: choice.value,
                                 });
                             });
                         }
@@ -294,7 +375,7 @@ export class ZumitoFramework {
     }
 }
 function MergeRecursive(obj1, obj2) {
-    for (var p in obj2) {
+    for (const p in obj2) {
         try {
             // Property in destination object set; update its value.
             if (obj2[p].constructor == Object) {

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

@@ -1,8 +1,8 @@
-import { Command } from "../../../types/Command.js";
-import { EventParameters } from "../../../types/EventParameters.js";
-import { FrameworkEvent } from "../../../types/FrameworkEvent.js";
+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>;
+    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,8 +1,8 @@
-import { CommandType } from "../../../types/CommandType.js";
-import { FrameworkEvent } from "../../../types/FrameworkEvent.js";
+import { CommandType } from '../../../types/CommandType.js';
+import { FrameworkEvent } from '../../../types/FrameworkEvent.js';
 export class InteractionCreate extends FrameworkEvent {
     once = false;
-    async execute({ interaction, client, framework }) {
+    async execute({ interaction, client, framework, }) {
         let guildSettings;
         if (interaction.guildId) {
             guildSettings = await framework.getGuildSettings(interaction.guildId);
@@ -11,46 +11,80 @@ export class InteractionCreate extends FrameworkEvent {
             if (!framework.commands.has(interaction.commandName))
                 return;
             const commandInstance = framework.commands.get(interaction.commandName);
-            let args = new Map();
-            commandInstance.args.forEach(arg => {
-                let option = interaction.options.get(arg.name);
+            const args = new Map();
+            commandInstance.args.forEach((arg) => {
+                const option = interaction.options.get(arg.name);
                 if (option) {
                     switch (arg.type) {
-                        case "user":
+                        case 'user':
                             args.set(arg.name, option.user);
                             break;
-                        case "member":
+                        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);
+                            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))
+            if (![
+                CommandType.any,
+                CommandType.separated,
+                CommandType.slash,
+            ].includes(commandInstance.type))
                 return;
             const trans = this.getTransMethod(commandInstance, guildSettings, framework);
-            if (commandInstance.type === CommandType.separated || commandInstance.type === CommandType.slash) {
-                await commandInstance.executeSlashCommand({ client, interaction, args, framework, guildSettings, trans });
+            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 });
+                await commandInstance.execute({
+                    client,
+                    interaction,
+                    args,
+                    framework,
+                    guildSettings,
+                    trans,
+                });
             }
         }
         else if (interaction.isButton()) {
             interaction = interaction;
-            let path = interaction.customId.split('.');
+            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 });
+                commandInstance.buttonPressed({
+                    path,
+                    interaction,
+                    client,
+                    framework,
+                    guildSettings,
+                });
             }
         }
         else if (interaction.isSelectMenu()) {
-            let path = interaction.customId.split('.');
+            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`);
@@ -63,7 +97,14 @@ export class InteractionCreate extends FrameworkEvent {
                 }
             };
             if (commandInstance.selectMenu) {
-                commandInstance.selectMenu({ path, interaction, client, framework, guildSettings, trans });
+                commandInstance.selectMenu({
+                    path,
+                    interaction,
+                    client,
+                    framework,
+                    guildSettings,
+                    trans,
+                });
             }
         }
     }

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

@@ -1,6 +1,6 @@
-import { ActionRowBuilder, EmbedBuilder } from "discord.js";
-import { EventParameters } from "../../../types/EventParameters.js";
-import { FrameworkEvent } from "../../../types/FrameworkEvent.js";
+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>>;