zumito-framework 1.1.34 → 1.1.36

package/dist/ZumitoFramework.d.ts

@@ -46,4 +46,6 @@ export declare class ZumitoFramework {
     private initializeDiscordClient;
     static splitCommandLine(commandLine: any): any;
     memberHasPermission(member: GuildMember, channel: TextChannel, permission: bigint): Promise<boolean>;
+    getGuildSettings(guildId: string): Promise<any>;
+    refreshSlashCommands(): Promise<void>;
 }

package/dist/ZumitoFramework.js

@@ -1,3 +1,4 @@
+import { SlashCommandBuilder } from "discord.js";
 import { Module } from "./types/Module.js";
 import { ApiResponse } from './definitions/ApiResponse.js';
 import { baseModule } from "./baseModule/index.js";
@@ -9,11 +10,14 @@ import { Client } from "discord.js";
 // import 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 cookieParser from 'cookie-parser';
 import cors from 'cors';
 import http from 'http';
 import * as url from 'url';
+import { CommandType } from "./types/CommandType.js";
 /**
  * @class ZumitoFramework
  * @classdesc The main class of the framework.
@@ -80,6 +84,7 @@ export class ZumitoFramework {
         this.initializeDiscordClient();
         this.startApiServer();
         await this.registerModules();
+        await this.refreshSlashCommands();
     }
     startApiServer() {
         this.app = express();
@@ -222,6 +227,51 @@ export class ZumitoFramework {
         let memberPermission = await channel.permissionsFor(member);
         return memberPermission.has(permission);
     }
+    async getGuildSettings(guildId) {
+        let guild = await this.models.get('Guild').findOne({ guild_id: guildId });
+        if (guild == null) {
+            guild = await this.models.get('Guild').create({ guild_id: guildId });
+        }
+        return guild;
+    }
+    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)
+            .map((command) => {
+            let slashCommand = new SlashCommandBuilder()
+                .setName(command.name)
+                .setDescription(this.translations.get('commands.' + command.name + '.description', 'en'));
+            if (command.args) {
+                command.args.forEach((arg) => {
+                    let method;
+                    switch (arg.type) {
+                        case 'string':
+                            method = 'addStringOption';
+                            break;
+                        case 'user':
+                            method = 'addUserOption';
+                            break;
+                        case 'channel':
+                            method = 'addChannelOption';
+                            break;
+                        case 'role':
+                            method = 'addRoleOption';
+                            break;
+                    }
+                    slashCommand[method]((option) => {
+                        option.setName(arg.name);
+                        option.setDescription(this.translations.get('commands.' + command.name + '.args.' + arg.name + '.description', 'en'));
+                        option.setRequired(!arg.optional);
+                        return option;
+                    });
+                });
+            }
+            return slashCommand.toJSON();
+        });
+        const data = await rest.put(Routes.applicationCommands(this.settings.discordClientOptions.clientId), { body: commands });
+        console.debug(`Successfully reloaded ${data.length} of ${commands.length} application (/) commands.`);
+    }
 }
 function MergeRecursive(obj1, obj2) {
     for (var p in obj2) {

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

@@ -3,6 +3,10 @@ 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;
@@ -17,10 +21,10 @@ export class InteractionCreate extends FrameworkEvent {
             if (![CommandType.any, CommandType.separated, CommandType.slash].includes(commandInstance.type))
                 return;
             if (commandInstance.type === CommandType.separated || commandInstance.type === CommandType.slash) {
-                await commandInstance.executeSlashCommand({ client, interaction, args, framework });
+                await commandInstance.executeSlashCommand({ client, interaction, args, framework, guildSettings });
             }
             else {
-                await commandInstance.execute({ client, interaction, args, framework });
+                await commandInstance.execute({ client, interaction, args, framework, guildSettings });
             }
         }
         else if (interaction.isButton()) {
@@ -29,7 +33,7 @@ export class InteractionCreate extends FrameworkEvent {
             let path = interaction.customId.split('.');
             const command = framework.commands.get(path[0]);
             if (command.selectMenu) {
-                command.selectMenu({ path, interaction, client, framework });
+                command.selectMenu({ path, interaction, client, framework, guildSettings });
             }
         }
     }

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

@@ -62,15 +62,38 @@ export class MessageCreate extends FrameworkEvent {
                 }
             }
             try {
+                let guildSettings = await framework.getGuildSettings(message.guildId);
                 let parsedArgs = new Map();
-                args.forEach(function (arg, index) {
-                    parsedArgs.set(commandInstance.args?.[index]?.name || index, arg);
-                });
+                let userMentionCount = 0;
+                for (let i = 0; i < args.length; i++) {
+                    let arg = args[i];
+                    let type = commandInstance.args[i]?.type;
+                    if (type) {
+                        if (type == 'user') {
+                            const member = await message.guild.members.cache.get(arg.replace(/[<@!>]/g, ''));
+                            if (member) {
+                                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,
                 });
                 if (!message.channel.isDMBased && !message.deletable && (false)) { // false = settings.deleteCommands
                     try {

package/dist/baseModule/models/errors.json

@@ -0,0 +1,14 @@
+{
+    "id": "string",
+    "command": {
+        "command": "string",
+        "args": {
+            "type": "array"
+        }
+    },
+    "error": {
+        "title": "string",
+        "message": "string",
+        "stacktrace": "string"
+    }
+}

package/dist/baseModule/models/guild.json

@@ -0,0 +1,23 @@
+{
+    "guild_id": {
+        "type": "string",
+        "index": true,
+        "unique": true
+    },
+    "lang": {
+        "type": "string",
+        "default": "en"
+    },
+    "prefix": {
+        "type": "string",
+        "default": "z-"
+    },
+    "public": {
+        "type": "boolean",
+        "default": false
+    },
+    "deleteCommands": {
+        "type": "boolean",
+        "default": false
+    }
+}

package/dist/index.d.ts

@@ -8,4 +8,7 @@ import { FrameworkEvent } from './types/FrameworkEvent.js';
 import { Translation } from './types/Translation.js';
 import { TranslationManager } from './TranslationManager.js';
 import { ApiResponse } from './definitions/ApiResponse.js';
-export { ZumitoFramework, FrameworkSettings, Command, Module, CommandParameters, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse };
+import { SelectMenuParameters } from './types/SelectMenuParameters.js';
+import { CommandType } from './types/CommandType.js';
+import { CommandArgDefinition } from './types/CommandArgDefinition.js';
+export { ZumitoFramework, FrameworkSettings, Command, Module, CommandParameters, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, SelectMenuParameters, CommandType, CommandArgDefinition };

package/dist/index.js

@@ -6,4 +6,5 @@ import { FrameworkEvent } from './types/FrameworkEvent.js';
 import { Translation } from './types/Translation.js';
 import { TranslationManager } from './TranslationManager.js';
 import { ApiResponse } from './definitions/ApiResponse.js';
-export { ZumitoFramework, Command, Module, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse };
+import { CommandType } from './types/CommandType.js';
+export { ZumitoFramework, Command, Module, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, CommandType };

package/dist/managers/EmojiManager.d.ts

@@ -0,0 +1,11 @@
+import { Client } from "discord.js";
+export declare class EmojiManager {
+    /**
+     * @param {Client} client - The client client instance.
+     */
+    client: Client;
+    emojiFallbacks: Map<string, string>;
+    constructor(client: Client);
+    getEmojiByName(name: string): string;
+    registerEmojiFallback(id: string, fallback: string): void;
+}

package/dist/managers/EmojiManager.js

@@ -0,0 +1,32 @@
+export class EmojiManager {
+    /**
+     * @param {Client} client - The client client instance.
+     */
+    client;
+    emojiFallbacks = new Map();
+    constructor(client) {
+        this.client = client;
+    }
+    getEmojiByName(name) {
+        let emoji = this.client.emojis.cache.find((e) => e.name === name);
+        if (emoji) {
+            return emoji.toString();
+        }
+        else if (this.emojiFallbacks.has(name)) {
+            const fallback = this.emojiFallbacks.get(name);
+            emoji = this.client.emojis.cache.find((e) => e.name === fallback);
+            if (emoji) {
+                return emoji.toString();
+            }
+            else {
+                return fallback;
+            }
+        }
+        else {
+            throw new Error(`Emoji ${name} not found.`);
+        }
+    }
+    registerEmojiFallback(id, fallback) {
+        this.emojiFallbacks.set(id, fallback);
+    }
+}

package/dist/types/Command.d.ts

@@ -1,17 +1,18 @@
+import { CommandArgDefinition } from "./CommandArgDefinition.js";
 import { CommandParameters } from "./CommandParameters.js";
 import { SelectMenuParameters } from "./SelectMenuParameters.js";
 export declare abstract class Command {
     name: string;
     categories: string[];
-    aliases?: string[];
-    examples?: string[];
-    userPermissions?: bigint[];
-    botPermissions?: string[];
-    hidden?: boolean;
-    adminOnly?: boolean;
-    nsfw?: boolean;
-    cooldown?: number;
-    slashCommand?: boolean;
+    aliases: string[];
+    examples: string[];
+    userPermissions: bigint[];
+    botPermissions: string[];
+    hidden: boolean;
+    adminOnly: boolean;
+    nsfw: boolean;
+    cooldown: number;
+    slashCommand: boolean;
     dm: boolean;
     args: CommandArgDefinition[];
     type: string;

package/dist/types/CommandArgDefinition.d.ts

@@ -1,4 +1,5 @@
-interface CommandArgDefinition {
+export interface CommandArgDefinition {
     name: string;
     optional: boolean;
+    type: string;
 }

package/dist/types/CommandArgDefinition.js

@@ -0,0 +1 @@
+export {};

package/dist/types/CommandParameters.d.ts

@@ -1,4 +1,4 @@
-import { Client, Interaction, Message } from "discord.js";
+import { Client, CommandInteraction, Message } from "discord.js";
 import { ZumitoFramework } from "../ZumitoFramework.js";
 /**
  * @class CommandParameters
@@ -10,8 +10,9 @@ import { ZumitoFramework } from "../ZumitoFramework.js";
  */
 export interface CommandParameters {
     message?: Message;
-    interaction?: Interaction;
+    interaction?: CommandInteraction;
     args: Map<String, any>;
     client: Client;
     framework: ZumitoFramework;
+    guildSettings?: any;
 }

package/dist/types/Module.js

@@ -3,7 +3,7 @@ import chalk from 'chalk';
 import boxen from "boxen";
 import * as fs from 'fs';
 import path from 'path';
-import { SelectMenuInteraction } from "discord.js";
+import { CommandInteraction, SelectMenuInteraction } from "discord.js";
 export class Module {
     path;
     framework;
@@ -18,6 +18,7 @@ export class Module {
         await this.registerCommands();
         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 }));
     }
@@ -127,9 +128,9 @@ export class Module {
         args.forEach(arg => {
             finalArgs[arg.constructor.name.toLowerCase()] = arg;
         });
-        let selectMenuInteraction = args.find((arg) => arg instanceof SelectMenuInteraction);
-        if (selectMenuInteraction) {
-            finalArgs['interaction'] = selectMenuInteraction;
+        let interaction = args.find((arg) => arg instanceof SelectMenuInteraction || arg instanceof CommandInteraction);
+        if (interaction) {
+            finalArgs['interaction'] = interaction;
         }
         return finalArgs;
     }

package/dist/types/SelectMenuParameters.d.ts

@@ -5,4 +5,5 @@ export interface SelectMenuParameters {
     interaction: SelectMenuInteraction;
     client: Client;
     framework: ZumitoFramework;
+    guildSettings?: any;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zumito-framework",
-  "version": "1.1.34",
+  "version": "1.1.36",
   "description": "Discord.js bot framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,7 @@
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc-esm",
+    "build": "tsc",
     "publish": "npm publish",
     "docs": "typedoc --out docs src"
   },
@@ -35,13 +35,12 @@
     "express": "^4.18.1",
     "leven": "^4.0.0",
     "mongoose": "^6.5.2",
-    "plop": "^3.1.1",
-    "zumito-framework": "^1.1.16"
+    "plop": "^3.1.1"
   },
   "devDependencies": {
     "@types/node": "^18.7.16",
     "typedoc": "^0.23.14",
-    "typescript": "^4.8.2"
+    "typescript": "^4.8.3"
   },
   "type": "module"
 }

package/plop-templates/command.js.hbs

@@ -2,7 +2,7 @@ import { Command, CommandParameters } from "zumito-framework";
 
 export class {{capitalize command}} extends Command {
 
-    execute({ message, interaction, args, client, framework }: CommandParameters): void {
+    execute({ message, interaction, args, client, framework, guildSettings }: CommandParameters): void {
         (message || interaction!).reply({
             content: "Message content",
         });