zumito-framework 1.1.57 → 1.1.59

package/dist/ZumitoFramework.d.ts

@@ -4,30 +4,83 @@ import { FrameworkSettings } from './types/FrameworkSettings.js';
 import { Module } from './types/Module.js';
 import { FrameworkEvent } from './types/FrameworkEvent.js';
 import { TranslationManager } from './TranslationManager.js';
+import { DatabaseModel } from './types/DatabaseModel.js';
 /**
  * @class ZumitoFramework
- * @classdesc The main class of 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.
+ * @description The main class of the framework.
+ * @example
+ *  new ZumitoFramework({
+ *     discordClientOptions: {
+ *          intents: 3276799,
+ *          token: 'XXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
+ *          clientId: 755XXXXXXXXXX98,
+ *      },
+ *      defaultPrefix: process.env.BOTPREFIX || "z-",
+ *      mongoQueryString: mongodb://XXXXXX,
+ *      logLevel: parseInt(process.env.LOGLEVEL || "3"),
+ * });
  */
 export declare class ZumitoFramework {
+    /**
+     * The discord client instance.
+     * @type {Client}
+     * @private
+     * @see {@link https://discord.js.org/#/docs/main/stable/class/Client}
+     */
     client: Client;
+    /**
+     * The settings for the framework.
+     * @type {FrameworkSettings}
+     * @private
+     */
     settings: FrameworkSettings;
+    /**
+     * The modules loaded in the framework.
+     * @type {Map<string, Module>}
+     * @private
+     */
     modules: Map<string, Module>;
+    /**
+     * The commands loaded in the framework.
+     * @type {Map<string, Command>}
+     * @private
+     * @see {@link Command}
+     */
     commands: Map<string, Command>;
+    /**
+     * The events loaded in the framework.
+     * @type {Map<string, FrameworkEvent>}
+     * @private
+     * @see {@link FrameworkEvent}
+     */
     events: Map<string, FrameworkEvent>;
+    /**
+     * The Translation Manager for the framework.
+     * @type {TranslationManager}
+     * @private
+     * @see {@link TranslationManager}
+     */
     translations: TranslationManager;
     routes: any;
-    models: any;
+    /**
+     * The database models loaded in the framework.
+     * @type {Array<DatabaseModel>}
+     * @private
+     */
+    models: Array<DatabaseModel>;
+    /**
+     * The canario database schema instance.
+     * @type {canario.Schema}
+     * @private
+     * @see {@link https://www.npmjs.com/package/canario}
+     */
     database: any;
+    /**
+     * The ExpressJS app instance.
+     * @type {express.Application}
+     * @private
+     * @see {@link https://expressjs.com/en/4x/api.html#app}
+     */
     app: any;
     /**
      * @constructor
@@ -44,6 +97,7 @@ export declare class ZumitoFramework {
      * @returns {Promise<void>}
      */
     private initialize;
+    private initializeDatabase;
     /**
      * Initializes and starts the API server using ExpressJS.
      * Sets up middleware, routes, and error handling for the server.
@@ -117,6 +171,6 @@ export declare class ZumitoFramework {
      * // returns the guild settings
      * getGuildSettings(interaction.guildId);
      */
-    getGuildSettings(guildId: string): Promise<any>;
+    getGuildSettings(guildId: string): Promise<unknown>;
     refreshSlashCommands(): Promise<void>;
 }

package/dist/ZumitoFramework.js

@@ -11,7 +11,7 @@ import { betterLogging } from 'better-logging';
 betterLogging(console);
 import { REST } from '@discordjs/rest';
 import { Routes } from 'discord-api-types/v9';
-import mongoose from 'mongoose';
+import canario from 'canario';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';
 import http from 'http';
@@ -19,28 +19,80 @@ import * as url from 'url';
 import { CommandType } from './types/CommandType.js';
 /**
  * @class ZumitoFramework
- * @classdesc The main class of 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.
+ * @description The main class of the framework.
+ * @example
+ *  new ZumitoFramework({
+ *     discordClientOptions: {
+ *          intents: 3276799,
+ *          token: 'XXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
+ *          clientId: 755XXXXXXXXXX98,
+ *      },
+ *      defaultPrefix: process.env.BOTPREFIX || "z-",
+ *      mongoQueryString: mongodb://XXXXXX,
+ *      logLevel: parseInt(process.env.LOGLEVEL || "3"),
+ * });
  */
 export class ZumitoFramework {
+    /**
+     * The discord client instance.
+     * @type {Client}
+     * @private
+     * @see {@link https://discord.js.org/#/docs/main/stable/class/Client}
+     */
     client;
+    /**
+     * The settings for the framework.
+     * @type {FrameworkSettings}
+     * @private
+     */
     settings;
+    /**
+     * The modules loaded in the framework.
+     * @type {Map<string, Module>}
+     * @private
+     */
     modules;
+    /**
+     * The commands loaded in the framework.
+     * @type {Map<string, Command>}
+     * @private
+     * @see {@link Command}
+     */
     commands;
+    /**
+     * The events loaded in the framework.
+     * @type {Map<string, FrameworkEvent>}
+     * @private
+     * @see {@link FrameworkEvent}
+     */
     events;
+    /**
+     * The Translation Manager for the framework.
+     * @type {TranslationManager}
+     * @private
+     * @see {@link TranslationManager}
+     */
     translations;
     routes;
+    /**
+     * The database models loaded in the framework.
+     * @type {Array<DatabaseModel>}
+     * @private
+     */
     models;
+    /**
+     * The canario database schema instance.
+     * @type {canario.Schema}
+     * @private
+     * @see {@link https://www.npmjs.com/package/canario}
+     */
     database;
+    /**
+     * The ExpressJS app instance.
+     * @type {express.Application}
+     * @private
+     * @see {@link https://expressjs.com/en/4x/api.html#app}
+     */
     app;
     /**
      * @constructor
@@ -53,7 +105,7 @@ export class ZumitoFramework {
         this.commands = new Map();
         this.events = new Map();
         this.translations = new TranslationManager();
-        this.models = new Map();
+        this.models = [];
         if (settings.logLevel) {
             console.logLevel = settings.logLevel;
         }
@@ -75,23 +127,32 @@ export class ZumitoFramework {
      * @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);
-            process.exit(1);
-        }
-        finally {
-            this.database = mongoose.connection;
-            console.log('[🗄️🟢] Database connection successful');
-        }
+        await this.initializeDatabase();
         this.initializeDiscordClient();
         this.startApiServer();
         await this.registerModules();
         await this.refreshSlashCommands();
     }
+    async initializeDatabase() {
+        const folders = ['db', 'db/tingodb'];
+        for (const folder of folders) {
+            if (!fs.existsSync(folder)) {
+                fs.mkdirSync(folder);
+            }
+        }
+        this.database = new canario.Schema(this.settings?.database?.type || 'tingodb', this.settings?.database || {});
+        await new Promise((resolve, reject) => {
+            this.database.on('connected', resolve);
+            this.database.on('error', reject);
+        })
+            .then(() => {
+            console.log('[🗄️🟢] Database connection successful!');
+        })
+            .catch((err) => {
+            console.error('[🗄️🔴] Database connection error:', err.message);
+            process.exit(1);
+        });
+    }
     /**
      * Initializes and starts the API server using ExpressJS.
      * Sets up middleware, routes, and error handling for the server.
@@ -150,9 +211,21 @@ export class ZumitoFramework {
         for (const file of files) {
             await this.registerModule(modulesFolder, file);
         }
-        this.models.forEach((modelDefinition, modelName) => {
-            const schema = new mongoose.Schema(modelDefinition);
-            this.models.set(modelName, mongoose.model(modelName, schema));
+        // Define models
+        const schemas = {};
+        this.models.forEach((model) => {
+            if (!schemas[model.name]) {
+                schemas[model.name] = model.getModel(this.database);
+            }
+            else {
+                schemas[model.name] = MergeRecursive(schemas[model.name], model.getModel(this.database));
+            }
+        });
+        Object.keys(schemas).forEach((schemaName) => {
+            this.database.define(schemaName, schemas[schemaName]);
+        });
+        this.models.forEach((model) => {
+            model.define(this.database.models[model.name], this.database.models);
         });
     }
     async registerModule(modulesFolder, moduleName, module) {
@@ -193,13 +266,8 @@ export class ZumitoFramework {
         // Register module events
         this.events = new Map([...this.events, ...moduleInstance.getEvents()]);
         // Register models
-        moduleInstance.getModels().forEach((modelDefinition, modelName) => {
-            if (!this.models.has(modelName)) {
-                this.models.set(modelName, modelDefinition);
-            }
-            else {
-                this.models.set(modelName, MergeRecursive(this.models.get(modelName), modelDefinition));
-            }
+        moduleInstance.getModels().forEach((model) => {
+            this.models.push(model);
         });
         /*
 
@@ -303,15 +371,26 @@ export class ZumitoFramework {
      * getGuildSettings(interaction.guildId);
      */
     async getGuildSettings(guildId) {
-        const Guild = this.models.get('Guild');
-        let guild = await Guild.findOne({ guild_id: guildId }).exec();
-        if (guild == null) {
-            guild = new Guild({
-                guild_id: guildId,
+        const Guild = this.database.models.Guild;
+        return await new Promise((resolve, reject) => {
+            Guild.findOne({ where: { guild_id: guildId } }, (err, guild) => {
+                if (err)
+                    reject(err);
+                if (guild == null) {
+                    guild = new Guild({
+                        guild_id: guildId,
+                    });
+                    guild.save((err) => {
+                        if (err)
+                            reject(err);
+                        resolve(guild);
+                    });
+                }
+                else {
+                    resolve(guild);
+                }
             });
-            await guild.save();
-        }
-        return guild;
+        });
     }
     async refreshSlashCommands() {
         const rest = new REST({ version: '10' }).setToken(this.settings.discordClientOptions.token);

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

@@ -43,7 +43,7 @@ export class InteractionCreate extends FrameworkEvent {
                 CommandType.slash,
             ].includes(commandInstance.type))
                 return;
-            const trans = this.getTransMethod(commandInstance, guildSettings, framework);
+            const trans = this.getTransMethod(commandInstance, framework, guildSettings);
             if (commandInstance.type === CommandType.separated ||
                 commandInstance.type === CommandType.slash) {
                 await commandInstance.executeSlashCommand({

package/dist/baseModule/index.d.ts

@@ -3,4 +3,5 @@ import { ZumitoFramework } from '../ZumitoFramework.js';
 export declare class baseModule extends Module {
     constructor(modulePath: string, framework: ZumitoFramework);
     registerEvents(): Promise<any>;
+    registerModels(): Promise<void>;
 }

package/dist/baseModule/index.js

@@ -1,6 +1,7 @@
 import { Module } from '../types/Module.js';
 import { InteractionCreate } from './events/discord/interactionCreate.js';
 import { MessageCreate } from './events/discord/messageCreate.js';
+import { Guild } from './models/Guild.js';
 export class baseModule extends Module {
     constructor(modulePath, framework) {
         super(modulePath, framework);
@@ -12,4 +13,7 @@ export class baseModule extends Module {
             this.registerDiscordEvent(event);
         });
     }
+    async registerModels() {
+        this.models.push(new Guild(this.framework));
+    }
 }

package/dist/baseModule/models/Guild.d.ts

@@ -0,0 +1,27 @@
+import { DatabaseModel } from '../../types/DatabaseModel.js';
+export declare class Guild extends DatabaseModel {
+    getModel(schema: any): {
+        guild_id: {
+            type: any;
+            required: boolean;
+            unique: boolean;
+        };
+        lang: {
+            type: any;
+            default: string;
+        };
+        prefix: {
+            type: any;
+            default: string;
+        };
+        public: {
+            type: any;
+            default: boolean;
+        };
+        deleteCommands: {
+            type: any;
+            default: boolean;
+        };
+    };
+    define(model: any, models: any): void;
+}

package/dist/baseModule/models/Guild.js

@@ -0,0 +1,32 @@
+import { DatabaseModel } from '../../types/DatabaseModel.js';
+export class Guild extends DatabaseModel {
+    getModel(schema) {
+        return {
+            guild_id: {
+                type: schema.String,
+                required: true,
+                unique: true,
+            },
+            lang: {
+                type: schema.String,
+                default: 'en',
+            },
+            prefix: {
+                type: schema.String,
+                default: 'z-',
+            },
+            public: {
+                type: schema.Boolean,
+                default: false,
+            },
+            deleteCommands: {
+                type: schema.Boolean,
+                default: false,
+            },
+        };
+    }
+    define(model, models) {
+        model.validatesUniquenessOf('guild_id');
+        model.validatesInclusionOf('lang', { in: ['en', 'es'] });
+    }
+}

package/dist/index.d.ts

@@ -1,19 +1,20 @@
 import { ApiResponse } from './definitions/ApiResponse.js';
+import { TranslationManager } from './TranslationManager.js';
 import { Command } from './types/Command.js';
 import { CommandArgDefinition } from './types/CommandArgDefinition.js';
 import { CommandArguments } from './types/CommandArguments.js';
 import { CommandChoiceDefinition } from './types/CommandChoiceDefinition.js';
 import { CommandParameters } from './types/CommandParameters.js';
+import { ButtonPressed } from './types/Commands/ButtonPressed.js';
+import { ButtonPressedParams } from './types/Commands/ButtonPressedParams.js';
 import { CommandType } from './types/CommandType.js';
 import { FrameworkEvent } from './types/FrameworkEvent.js';
 import { FrameworkSettings } from './types/FrameworkSettings.js';
 import { Module } from './types/Module.js';
 import { SelectMenuParameters } from './types/SelectMenuParameters.js';
-import { TextFormatter } from './utils/TextFormatter.js';
 import { Translation } from './types/Translation.js';
-import { TranslationManager } from './TranslationManager.js';
-import { ZumitoFramework } from './ZumitoFramework.js';
+import { DatabaseConfigLoader } from './utils/DatabaseConfigLoader.js';
 import { EmojiFallback } from './utils/EmojiFallback.js';
-import { ButtonPressed } from './types/Commands/ButtonPressed.js';
-import { ButtonPressedParams } from './types/Commands/ButtonPressedParams.js';
-export { ZumitoFramework, FrameworkSettings, Command, Module, CommandParameters, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, SelectMenuParameters, CommandType, CommandArgDefinition, CommandChoiceDefinition, ButtonPressed, ButtonPressedParams, TextFormatter, EmojiFallback, };
+import { TextFormatter } from './utils/TextFormatter.js';
+import { ZumitoFramework } from './ZumitoFramework.js';
+export { ZumitoFramework, FrameworkSettings, Command, Module, CommandParameters, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, SelectMenuParameters, CommandType, CommandArgDefinition, CommandChoiceDefinition, ButtonPressed, ButtonPressedParams, TextFormatter, EmojiFallback, DatabaseConfigLoader, };

package/dist/index.js

@@ -1,13 +1,14 @@
 import { ApiResponse } from './definitions/ApiResponse.js';
+import { TranslationManager } from './TranslationManager.js';
 import { Command } from './types/Command.js';
 import { CommandArguments } from './types/CommandArguments.js';
+import { ButtonPressed } from './types/Commands/ButtonPressed.js';
 import { CommandType } from './types/CommandType.js';
 import { FrameworkEvent } from './types/FrameworkEvent.js';
 import { Module } from './types/Module.js';
-import { TextFormatter } from './utils/TextFormatter.js';
 import { Translation } from './types/Translation.js';
-import { TranslationManager } from './TranslationManager.js';
-import { ZumitoFramework } from './ZumitoFramework.js';
+import { DatabaseConfigLoader } from './utils/DatabaseConfigLoader.js';
 import { EmojiFallback } from './utils/EmojiFallback.js';
-import { ButtonPressed } from './types/Commands/ButtonPressed.js';
-export { ZumitoFramework, Command, Module, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, CommandType, ButtonPressed, TextFormatter, EmojiFallback, };
+import { TextFormatter } from './utils/TextFormatter.js';
+import { ZumitoFramework } from './ZumitoFramework.js';
+export { ZumitoFramework, Command, Module, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, CommandType, ButtonPressed, TextFormatter, EmojiFallback, DatabaseConfigLoader, };

package/dist/types/Command.d.ts

@@ -1,22 +1,217 @@
 import { CommandArgDefinition } from './CommandArgDefinition.js';
 import { CommandParameters } from './CommandParameters.js';
 import { SelectMenuParameters } from './SelectMenuParameters.js';
+/**
+ * @name Command
+ * @description Base class for all commands
+ * @see {@link https://docs.zumito.ga/docs/custom/create-command}
+ */
 export declare abstract class Command {
+    /**
+     * @name name
+     * @description The name of the command. This is the name that will be used to execute the command. The framework will automatically set this to the name of the class in lowercase.
+     * @type {string}
+     * @default this.constructor.name.toLowerCase()
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  name = 'ping';
+     * }
+     * ```
+     */
     name: string;
+    /**
+     * @name categories
+     * @description Array of strings of each category the command belongs to. This is used to group commands together in the help command.
+     * The framework will load the translations for each category from key `global.category.${category}`, so its recommended to use camelCase since this is the category key and not the category name.
+     * @type {string[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  categories = ['utility', 'info'];
+     * }
+     * ```
+     */
     categories: string[];
+    /**
+     * @name aliases
+     * @description Array of strings of each alias the command has. This is used to execute the command with an alias.
+     * @type {string[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  aliases = ['pong'];
+     * }
+     * ```
+     */
     aliases: string[];
+    /**
+     * @name examples
+     * @description Array of strings of each example of how to use the command. This is used to show examples of how to use the command in the help command.
+     * Do not include the prefix in the example.
+     * @type {string[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  examples = ['ping', 'ping 100'];
+     * }
+     * ```
+     */
     examples: string[];
+    /**
+     * @name userPermissions
+     * @description Array of {@link https://discord.js.org/#/docs/main/stable/class/Permissions} of each permission the user needs to execute the command.
+     * @type {bigint[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class ClearCommand extends Command {
+     *  userPermissions = [Permissions.FLAGS.MANAGE_MESSAGES];
+     * }
+     * ```
+     * @see {@link https://discord.js.org/#/docs/main/stable/class/Permissions}
+     */
     userPermissions: bigint[];
+    /**
+     * @name botPermissions
+     * @description Array of {@link https://discord.js.org/#/docs/main/stable/class/Permissions} of each permission the bot needs to execute the command.
+     * @type {bigint[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class BanCommand extends Command {
+     *  botPermissions = [Permissions.FLAGS.BAN_MEMBERS];
+     * }
+     * ```
+     * @see {@link https://discord.js.org/#/docs/main/stable/class/Permissions}
+     */
     botPermissions: string[];
+    /**
+     * @name hidden
+     * @description Whether the command should be hidden from the help command.
+     * @type {boolean}
+     * @default false
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  hidden = true;
+     * }
+     * ```
+     */
     hidden: boolean;
+    /**
+     * @name adminOnly
+     * @description Whether the command should only be available to the guild admins.
+     * @type {boolean}
+     * @default false
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  adminOnly = true;
+     * }
+     * ```
+     */
     adminOnly: boolean;
+    /**
+     * @name nsfw
+     * @description Whether the command should only be available in nsfw channels.
+     * @type {boolean}
+     * @default false
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *   nsfw = true;
+     * }
+     * ```
+     */
     nsfw: boolean;
+    /**
+     * @name cooldown
+     * @description The cooldown in seconds for the command. This is used to prevent spamming the command or for command with high processing time.
+     * @type {number}
+     * @default 0
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  cooldown = 5;
+     * }
+     * ```
+     */
     cooldown: number;
     slashCommand: boolean;
+    /**
+     * @name dm
+     * @description Whether the command should be available in dms.
+     * @type {boolean}
+     * @default false
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  dm = true;
+     * }
+     * ```
+     */
     dm: boolean;
+    /**
+     * @name args
+     * @description Array of {@link CommandArgDefinition} of each argument the command has.
+     * @type {CommandArgDefinition[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  args = [
+     *      {
+     *        name: 'number',
+     *        type: 'number',
+     *        required: true,
+     *     },
+     *  ];
+     * }
+     * ```
+     * @see {@link CommandArgDefinition}
+     */
     args: CommandArgDefinition[];
+    /**
+     * @name type
+     * @description The type of the command. This is used to determine how the command should be executed.
+     * @type {CommandType}
+     * @default CommandType.prefix
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  type = CommandType.slash;
+     * }
+     * ```
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  type = CommandType.any;
+     * }
+     * ```
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  type = CommandType.separated;
+     * }
+     * ```
+     * @see {@link CommandType}
+     */
     type: string;
-    constructor();
+    /**
+     * @name execute
+     * @description The function that is executed when the command is called.
+     * @param {CommandParameters} parameters The parameters of the command.
+     * @param {Message} parameters.message The message that triggered the command.
+     * @param {CommandInteraction} parameters.interaction The interaction that triggered the command.
+     * @param {string[]} parameters.args The arguments of the command.
+     * @param {Client} parameters.client The client.
+     * @param {Framework} parameters.framework The framework.
+     * @param {trans} (key: string, options?: any) => string Translation shorthand function.
+     */
     abstract execute({ message, interaction, args, client, framework, }: CommandParameters): void;
     executePrefixCommand({ message, interaction, args, client, framework, trans, }: CommandParameters): void;
     executeSlashCommand({ message, interaction, args, client, framework, trans, }: CommandParameters): void;

package/dist/types/Command.js

@@ -1,20 +1,204 @@
 import { CommandType } from './CommandType.js';
+/**
+ * @name Command
+ * @description Base class for all commands
+ * @see {@link https://docs.zumito.ga/docs/custom/create-command}
+ */
 export class Command {
+    /**
+     * @name name
+     * @description The name of the command. This is the name that will be used to execute the command. The framework will automatically set this to the name of the class in lowercase.
+     * @type {string}
+     * @default this.constructor.name.toLowerCase()
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  name = 'ping';
+     * }
+     * ```
+     */
     name = this.constructor.name.toLowerCase();
+    /**
+     * @name categories
+     * @description Array of strings of each category the command belongs to. This is used to group commands together in the help command.
+     * The framework will load the translations for each category from key `global.category.${category}`, so its recommended to use camelCase since this is the category key and not the category name.
+     * @type {string[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  categories = ['utility', 'info'];
+     * }
+     * ```
+     */
     categories = [];
+    /**
+     * @name aliases
+     * @description Array of strings of each alias the command has. This is used to execute the command with an alias.
+     * @type {string[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  aliases = ['pong'];
+     * }
+     * ```
+     */
     aliases = [];
+    /**
+     * @name examples
+     * @description Array of strings of each example of how to use the command. This is used to show examples of how to use the command in the help command.
+     * Do not include the prefix in the example.
+     * @type {string[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  examples = ['ping', 'ping 100'];
+     * }
+     * ```
+     */
     examples = [];
+    /**
+     * @name userPermissions
+     * @description Array of {@link https://discord.js.org/#/docs/main/stable/class/Permissions} of each permission the user needs to execute the command.
+     * @type {bigint[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class ClearCommand extends Command {
+     *  userPermissions = [Permissions.FLAGS.MANAGE_MESSAGES];
+     * }
+     * ```
+     * @see {@link https://discord.js.org/#/docs/main/stable/class/Permissions}
+     */
     userPermissions = [];
+    /**
+     * @name botPermissions
+     * @description Array of {@link https://discord.js.org/#/docs/main/stable/class/Permissions} of each permission the bot needs to execute the command.
+     * @type {bigint[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class BanCommand extends Command {
+     *  botPermissions = [Permissions.FLAGS.BAN_MEMBERS];
+     * }
+     * ```
+     * @see {@link https://discord.js.org/#/docs/main/stable/class/Permissions}
+     */
     botPermissions = [];
+    /**
+     * @name hidden
+     * @description Whether the command should be hidden from the help command.
+     * @type {boolean}
+     * @default false
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  hidden = true;
+     * }
+     * ```
+     */
     hidden = false;
+    /**
+     * @name adminOnly
+     * @description Whether the command should only be available to the guild admins.
+     * @type {boolean}
+     * @default false
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  adminOnly = true;
+     * }
+     * ```
+     */
     adminOnly = false;
+    /**
+     * @name nsfw
+     * @description Whether the command should only be available in nsfw channels.
+     * @type {boolean}
+     * @default false
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *   nsfw = true;
+     * }
+     * ```
+     */
     nsfw = false;
+    /**
+     * @name cooldown
+     * @description The cooldown in seconds for the command. This is used to prevent spamming the command or for command with high processing time.
+     * @type {number}
+     * @default 0
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  cooldown = 5;
+     * }
+     * ```
+     */
     cooldown = 0;
     slashCommand = false;
+    /**
+     * @name dm
+     * @description Whether the command should be available in dms.
+     * @type {boolean}
+     * @default false
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  dm = true;
+     * }
+     * ```
+     */
     dm = false;
+    /**
+     * @name args
+     * @description Array of {@link CommandArgDefinition} of each argument the command has.
+     * @type {CommandArgDefinition[]}
+     * @default []
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  args = [
+     *      {
+     *        name: 'number',
+     *        type: 'number',
+     *        required: true,
+     *     },
+     *  ];
+     * }
+     * ```
+     * @see {@link CommandArgDefinition}
+     */
     args = [];
+    /**
+     * @name type
+     * @description The type of the command. This is used to determine how the command should be executed.
+     * @type {CommandType}
+     * @default CommandType.prefix
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  type = CommandType.slash;
+     * }
+     * ```
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  type = CommandType.any;
+     * }
+     * ```
+     * @example
+     * ```ts
+     * export class PingCommand extends Command {
+     *  type = CommandType.separated;
+     * }
+     * ```
+     * @see {@link CommandType}
+     */
     type = CommandType.prefix;
-    constructor() { }
     executePrefixCommand({ message, interaction, args, client, framework, trans, }) {
         this.execute({ message, interaction, args, client, framework, trans });
     }

package/dist/types/CommandArgDefinition.d.ts

@@ -3,5 +3,5 @@ export interface CommandArgDefinition {
     name: string;
     optional: boolean;
     type: string;
-    choices?: CommandChoiceDefinition[] | Function;
+    choices?: CommandChoiceDefinition[] | (() => CommandChoiceDefinition[]);
 }

package/dist/types/CommandType.d.ts

@@ -1,6 +1,18 @@
 export declare const CommandType: {
+    /**
+     * The command is executed when the prefix is used. Running `executePrefixCommand` method or `execute` method as fallback.
+     */
     prefix: string;
+    /**
+     * The command is executed when the slash is used. Running `executeSlashCommand` method or `execute` method as fallback.
+     */
     slash: string;
+    /**
+     * The command is executed when the prefix or slash is used. Running `executeSlashCommand` or `executePrefixCommand` method respectively or `execute` method as fallback.
+     */
     separated: string;
+    /**
+     * The command is executed when the prefix or slash is used. Running always `execute` method.
+     */
     any: string;
 };

package/dist/types/CommandType.js

@@ -1,6 +1,18 @@
 export const CommandType = {
+    /**
+     * The command is executed when the prefix is used. Running `executePrefixCommand` method or `execute` method as fallback.
+     */
     prefix: 'prefix',
+    /**
+     * The command is executed when the slash is used. Running `executeSlashCommand` method or `execute` method as fallback.
+     */
     slash: 'slash',
+    /**
+     * The command is executed when the prefix or slash is used. Running `executeSlashCommand` or `executePrefixCommand` method respectively or `execute` method as fallback.
+     */
     separated: 'separated',
+    /**
+     * The command is executed when the prefix or slash is used. Running always `execute` method.
+     */
     any: 'any',
 };

package/dist/types/Commands/ButtonPressed.d.ts

@@ -1,4 +1,4 @@
-import { ButtonPressedParams } from './ButtonPressedParams';
+import { ButtonPressedParams } from './ButtonPressedParams.js';
 export declare abstract class ButtonPressed {
-    abstract buttonPressed({}: ButtonPressedParams): void;
+    abstract buttonPressed(buttonPressedParams: ButtonPressedParams): void;
 }

package/dist/types/Commands/SelectMenu.d.ts

@@ -0,0 +1,4 @@
+import { SelectMenuParameters } from '../SelectMenuParameters.js';
+export declare abstract class SelectMenuSelected {
+    abstract selectMenu(selectMenuParameters: SelectMenuParameters): void;
+}

package/dist/types/Commands/SelectMenu.js

@@ -0,0 +1,2 @@
+export class SelectMenuSelected {
+}

package/dist/types/DatabaseModel.d.ts

@@ -0,0 +1,70 @@
+import { ZumitoFramework } from '../ZumitoFramework.js';
+/**
+ * @name DatabaseModel
+ * @description Base class for all database models.
+ * @see {@link https://docs.zumito.ga/docs/custom/create-database-model}
+ */
+export declare abstract class DatabaseModel {
+    readonly name: string;
+    framework: ZumitoFramework;
+    constructor(framework: ZumitoFramework);
+    /**
+     * @name getModel
+     * @description This method should return the model that will be used by the framework.
+     * @returns {any}
+     * @example
+     * ```ts
+     * getModel(schema) {
+     *  return {
+     *      name:   { type: schema.String, required: true },
+     *      age:    { type: schema.Number, required: true },
+     *      email:  { type: schema.String,  limit: 155, unique: true },
+     *      approved:   { type: schema.Boolean, default: false, index: true }
+     *      joinedAt:   { type: schema.Date,    default: Date.now },
+     * };
+     * ```
+     * @see {@link https://docs.zumito.ga/docs/custom/create-database-model#model}
+     */
+    abstract getModel(schema: any): any;
+    /**
+     * @name define
+     * @description This method is called after all models are loaded. Here you can define relationships, validations, hooks, methods, etc.
+     * @param {any} model The model that was returned by the {@link DatabaseModel.getModel} method.
+     * @param {any} schema The schema of the database.
+     * @example
+     * Example of defining a relationship:
+     * ```ts
+     * define(model, models) {
+     *  model.hasMany(models.SocialMediaUrl, {as: 'socialMediaUrl', foreignKey: 'userId'});
+     * }
+     * ```
+     * @example
+     * Example of defining a validation:
+     * ```ts
+     * define(model) {
+     *  model.validatesPresenceOf('name', 'email')
+     *  model.validatesUniquenessOf('email', {message: 'email is not unique'});
+     *  model.validatesInclusionOf('gender', {in: ['male', 'female']});
+     *  model.validatesNumericalityOf('age', {int: true});
+     * ```
+     * @example
+     * Example of defining a hook:
+     * ```ts
+     * define(model) {
+     *  model.afterUpdate = function (next) {
+     *      this.updated = new Date();
+     *      this.save();
+     *      next();
+     *  };
+     * ```
+     * @example
+     * Example of defining a method:
+     * ```ts
+     * define(model) {
+     * model.prototype.getNameAndAge = function () {
+     *     return this.name + ', ' + this.age;
+     * };
+     * ```
+     */
+    abstract define(model: any, models: any): void;
+}

package/dist/types/DatabaseModel.js

@@ -0,0 +1,14 @@
+/**
+ * @name DatabaseModel
+ * @description Base class for all database models.
+ * @see {@link https://docs.zumito.ga/docs/custom/create-database-model}
+ */
+export class DatabaseModel {
+    // set name to the name of the class capitalized first letter
+    name = this.constructor.name.charAt(0).toUpperCase() +
+        this.constructor.name.slice(1);
+    framework;
+    constructor(framework) {
+        this.framework = framework;
+    }
+}

package/dist/types/FrameworkSettings.d.ts

@@ -1,4 +1,5 @@
 export interface FrameworkSettings {
+    database: any;
     logLevel?: number;
     debug?: boolean;
     discordClientOptions: {
@@ -7,5 +8,4 @@ export interface FrameworkSettings {
         clientId: string;
     };
     defaultPrefix?: string;
-    mongoQueryString: string;
 }

package/dist/types/Module.d.ts

@@ -1,12 +1,13 @@
 import { ZumitoFramework } from '../ZumitoFramework.js';
 import { Command } from './Command.js';
 import { FrameworkEvent } from './FrameworkEvent.js';
+import { DatabaseModel } from './DatabaseModel.js';
 export declare abstract class Module {
     protected path: string;
     protected framework: ZumitoFramework;
     protected commands: Map<string, Command>;
     protected events: Map<string, FrameworkEvent>;
-    protected models: Map<string, any>;
+    protected models: Array<DatabaseModel>;
     constructor(path: any, framework: any);
     initialize(): Promise<void>;
     registerCommands(): Promise<void>;
@@ -22,5 +23,5 @@ export declare abstract class Module {
     loadTranslationFile(subpath: string, file: string): Promise<any>;
     parseTranslation(path: string, lang: string, json: any): any;
     registerModels(): Promise<void>;
-    getModels(): Map<string, any>;
+    getModels(): Array<DatabaseModel>;
 }

package/dist/types/Module.js

@@ -9,7 +9,7 @@ export class Module {
     framework;
     commands = new Map();
     events = new Map();
-    models = new Map();
+    models = [];
     constructor(path, framework) {
         this.path = path;
         this.framework = framework;
@@ -19,8 +19,6 @@ export class Module {
         await this.registerEvents();
         await this.registerTranslations();
         await this.registerModels();
-        // console.error('[🔄🔴 ] Error initializing module ' + this.constructor.name);
-        // console.log(boxen(e + '\n' + e.stack, { padding: 1 }));
     }
     async registerCommands() {
         if (fs.existsSync(path.join(this.path, 'commands'))) {
@@ -218,18 +216,14 @@ export class Module {
             return;
         const files = fs.readdirSync(path.join(this.path, 'models'));
         for (const file of files) {
-            if (file.endsWith('.json')) {
-                const modelName = file.slice(0, -5).charAt(0).toUpperCase() +
-                    file.slice(0, -5).slice(1);
-                const modelDefiniton = await import('file://' + `${this.path}/models/${file}`, {
-                    assert: {
-                        type: 'json',
-                    },
-                }).catch((e) => {
-                    console.error(`[🔄🔴 ] Error loading model ${modelName} on module ${this.constructor.name}`);
-                    console.error(e, e.name, e.stack);
+            if (file.endsWith('.ts') || file.endsWith('.js')) {
+                let model = await import('file://' + `${this.path}/models/${file}`).catch((e) => {
+                    console.error(`[🔄🔴 ] Error loading ${file.slice(0, -3)} model on module ${this.constructor.name}`);
+                    console.error(e + '\n' + e.name + '\n' + e.stack);
                 });
-                this.models.set(modelName, modelDefiniton.default);
+                model = Object.values(model)[0];
+                model = new model();
+                this.models.push(model);
             }
         }
     }

package/dist/utils/DatabaseConfigLoader.d.ts

@@ -0,0 +1,3 @@
+export declare class DatabaseConfigLoader {
+    static getFromEnv(): any;
+}

package/dist/utils/DatabaseConfigLoader.js

@@ -0,0 +1,43 @@
+export class DatabaseConfigLoader {
+    static getFromEnv() {
+        const config = {};
+        if (!process.env.DATABASE_TYPE) {
+            console.warn('No database type specified. Using tingodb as default.\nIf this is intended, Set DATABASE_TYPE to "tingodb" in your .env file.');
+            config.type = 'tingodb';
+        }
+        else {
+            config.type = process.env.DATABASE_TYPE;
+        }
+        if (config.type == 'mysql') {
+            config.host = process.env.DATABASE_HOST;
+            config.port = process.env.DATABASE_PORT || 3306;
+            config.username = process.env.DATABASE_USERNAME;
+            config.password = process.env.DATABASE_PASSWORD;
+            config.database = process.env.DATABASE_NAME;
+        }
+        else if (config.type == 'sqlite') {
+            config.database = process.env.DATABASE_NAME;
+        }
+        else if (config.type == 'postgres') {
+            config.host = process.env.DATABASE_HOST;
+            config.port = process.env.DATABASE_PORT || 5432;
+            config.username = process.env.DATABASE_USERNAME;
+            config.password = process.env.DATABASE_PASSWORD;
+            config.database = process.env.DATABASE_NAME;
+        }
+        else if (config.type == 'mongodb') {
+            config.uri = process.env.DATABASE_URI;
+        }
+        else if (config.type == 'tingodb') {
+            config.database = './db/tingodb';
+        }
+        else if (config.type == 'couchdb') {
+            config.host = process.env.DATABASE_HOST;
+            config.port = process.env.DATABASE_PORT || 5984;
+            config.username = process.env.DATABASE_USERNAME;
+            config.password = process.env.DATABASE_PASSWORD;
+            config.database = process.env.DATABASE_NAME;
+        }
+        return config;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zumito-framework",
-  "version": "1.1.57",
+  "version": "1.1.59",
   "description": "Discord.js bot framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,6 +11,7 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc",
+    "build-watch": "tsc -w",
     "lint": "eslint .",
     "publish-npm": "npm publish",
     "docs": "typedoc --out docs src"
@@ -22,6 +23,7 @@
     "autocorrect": "^1.2.0",
     "better-logging": "^5.0.0",
     "boxen": "^7.0.0",
+    "canario": "^1.0.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
     "cookie-parser": "^1.4.6",
@@ -30,7 +32,8 @@
     "error-stack-parser": "^2.1.4",
     "express": "^4.18.1",
     "leven": "^4.0.0",
-    "mongoose": "^6.6.5"
+    "mongoose": "^6.6.5",
+    "tingodb": "^0.6.1"
   },
   "devDependencies": {
     "@types/node": "^18.7.16",

package/readme.md

@@ -14,7 +14,7 @@
 <br />
 <div align="center">
   <a href="https://github.com/ZumitoTeam/zumito-framework">
-    <img src="https://media.discordapp.net/attachments/964297459327184906/1066399583896342649/d05ce5c0de25fd9afb4f5492f31f21fe.png" alt="Logo" width="80" height="80">
+    <img src="https://media.discordapp.net/attachments/964297459327184906/1066399583896342649/d05ce5c0de25fd9afb4f5492f31f21fe.png" alt="Logo" width="80" height="80"/>
   </a>
 
   <h3 align="center">Zumito framework</h3>