xernerx 2.0.2 → 2.0.5

package/main.js

@@ -6,10 +6,10 @@ const { Client } = require('./models/Client.js'),
     { Event } = require('./models/commands/Event.js'),
     { LanguageHandler } = require('./models/handlers/LanguageHandler.js'),
     { ContextMenuCommand } = require('./models/commands/ContextMenuCommand.js'),
-    Discord = require('discord.js'),
     pkg = require('./package.json'),
     Dumfunctions = require('dumfunctions'),
-    { reply, selectMenuPaginator, buttonPaginator, commandName } = require('dumdiscord.js');
+    { reply, selectMenuPaginator, buttonPaginator, commandName } = require('dumdiscord.js'),
+    Discord = require('discord.js');
 
 module.exports = {
     // Client
@@ -39,5 +39,5 @@ module.exports = {
     commandName,
 
     // Details
-    version: pkg.version
+    version: pkg.version,
 } 

package/models/Client.js

@@ -1,6 +1,9 @@
 const Discord = require('discord.js');
 const { s } = require('@sapphire/shapeshift');
 const { color, config } = require('./data/Functions.js');
+const { CommandHandler } = require('./handlers/CommandHandler.js');
+const { EventHandler } = require('./handlers/EventHandler.js');
+const { LanguageHandler } = require('./handlers/LanguageHandler.js');
 
 /**
  * @param {string} guildId - Test guild ID. 
@@ -27,32 +30,48 @@ class Client extends Discord.Client {
             defaultCooldown: s.number.optional,
             logging: s.boolean.optional,
             cacheTime: s.number.optional,
-            dummi: s.boolean.optional
+            dummi: s.boolean.optional,
+            userPermissions: s.array(s.string).optional,
+            clientPermissions: s.array(s.string).optional
         }).parse(options)
 
         this.client = new Discord.Client({ intents: [options.intents], partials: [options.partials] });
 
-        this.client.messages = {};
+        this.client.settings = {
+            prefix: options.prefix,
+
+            ownerId: options.ownerId,
+
+            guildId: options.guildId,
+
+            global: options.global || false,
 
-        this.client.prefix = options.prefix;
+            ignoreOwner: options.ignoreOwner || false,
 
-        this.client.ownerId = options.ownerId;
+            defaultCooldown: options.defaultCooldown || 0,
 
-        this.client.guildId = options.guildId;
+            logging: options.logging || false,
 
-        this.client.global = options.global || false;
+            cacheTime: options.cacheTime || 300000,
 
-        this.client.ignoreOwner = options.ignoreOwner || false;
+            userPermissions: options.userPermissions || [],
 
-        this.client.defaultCooldown = options.defaultCooldown || 0;
+            clientPermissions: options.clientPermissions || []
+        }
 
         this.client.color = color({ client: this.client, options: options });
 
         this.client.config = config({ client: this.client, options: options });
 
-        this.client.logging = options.logging || false;
+        this.client.messages = {};
+
+        this.client.modules = {
+            commandHandler: new CommandHandler({ client: this.client }),
+
+            eventHandler: new EventHandler({ client: this.client }),
 
-        this.client.cacheTime = options.cacheTime || 300000;
+            // languageHandler: new LanguageHandler({ client: this.client })
+        }
 
         return this.client;
     }

package/models/commands/ContextMenuCommand.js

@@ -16,21 +16,33 @@ class ContextMenuCommand {
             admin: s.boolean.optional,
             info: s.string.optional,
             category: s.string.optional,
+            channels: s.array(s.string).optional,
+            guilds: s.array(s.string).optional,
+            userPermissions: s.array(s.string).optional,
+            clientPermissions: s.array(s.string).optional
         }).parse(options)
 
         this.data = new Builders.ContextMenuCommandBuilder()
             .setName(options.name)
             .setType(this.types(options.type))
 
-        this.inVoice = options.inVoice;
+        this.inVoice = options.inVoice || false;
 
-        this.category = options.category;
+        this.category = options.category || undefined;
 
-        this.owner = options.owner;
+        this.owner = options.owner || false;
 
-        this.admin = options.admin;
+        this.admin = options.admin || false;
 
-        this.info = options.info;
+        this.info = options.info || undefined;
+
+        this.channels = options.channels || [];
+
+        this.guilds = options.guilds || [];
+
+        this.userPermissions = options.userPermissions || [];
+
+        this.clientPermissions = options.clientPermissions || [];
 
         this.config = options.config;
     }

package/models/commands/InteractionCommand.js

@@ -23,7 +23,11 @@ class InteractionCommand {
             category: s.string.optional,
             cooldown: s.number.optional,
             ignoreOwner: s.boolean.optional,
-            inVoice: s.boolean.optional
+            inVoice: s.boolean.optional,
+            channels: s.array(s.string).optional,
+            guilds: s.array(s.string).optional,
+            userPermissions: s.array(s.string).optional,
+            clientPermissions: s.array(s.string).optional
         }).parse(options);
 
         this.data = new SlashCommandBuilder()
@@ -50,19 +54,27 @@ class InteractionCommand {
 
         this.admin = options.admin || false;
 
-        this.channel = options.channel;
+        this.channel = options.channel || undefined;
 
-        this.category = options.category;
+        this.category = options.category || undefined;
 
         this.config = options.config;
 
-        this.cooldown = options.cooldown;
+        this.cooldown = options.cooldown || 0;
 
         this.ignoreOwner = options.ignoreOwner || false;
 
         this.inVoice = options.inVoice || false;
 
-        this.info = options.info;
+        this.info = options.info || undefined;
+
+        this.channels = options.channels || [];
+
+        this.guilds = options.guilds || [];
+
+        this.userPermissions = options.userPermissions || [];
+
+        this.clientPermissions = options.clientPermissions || [];
     }
 
     exec(interaction) {

package/models/commands/MessageCommand.js

@@ -25,7 +25,11 @@ class MessageCommand {
             category: s.string.optional,
             cooldown: s.number.optional,
             ignoreOwner: s.boolean.optional,
-            inVoice: s.boolean.optional
+            inVoice: s.boolean.optional,
+            channels: s.array(s.string).optional,
+            guilds: s.array(s.string).optional,
+            userPermissions: s.array(s.string).optional,
+            clientPermissions: s.array(s.string).optional
         }).parse(options);
 
         this.id = id;
@@ -34,29 +38,37 @@ class MessageCommand {
 
         this.type = options.type;
 
-        this.description = options.description;
+        this.description = options.description || undefined;
 
-        this.owner = options.owner;
+        this.owner = options.owner || undefined;
 
-        this.admin = options.admin;
+        this.admin = options.admin || undefined;
 
-        this.channel = options.channel;
+        this.channel = options.channel || undefined;
 
-        this.separator = options.separator;
+        this.separator = options.separator || ' '
 
         this.args = options.args;
 
-        this.category = options.category;
+        this.category = options.category || undefined;
 
         this.config = options.config;
 
-        this.cooldown = options.cooldown;
+        this.cooldown = options.cooldown || 0;
 
         this.ignoreOwner = options.ignoreOwner || false;
 
         this.inVoice = options.inVoice || false;
 
-        this.info = options.info;
+        this.info = options.info || undefined;
+
+        this.channels = options.channels || [];
+
+        this.guilds = options.guilds || [];
+
+        this.userPermissions = options.userPermissions || [];
+
+        this.clientPermissions = options.clientPermissions || [];
     }
 
     exec(message) {

package/models/data/CommandValidation.js

@@ -0,0 +1,96 @@
+const Discord = require('discord.js');
+const { toPascalCase } = require('dumfunctions');
+
+const Cooldown = {};
+
+module.exports = function commandValidation(event, command, res = false) {
+    function emit(reason, extra) {
+        return event.client.emit('commandBlocked', event, reason, extra);
+    }
+
+    if ((command?.ignoreOwner || event?.client?.settings?.ignoreOwner) && event?.client?.settings?.ownerId?.includes((event.user || event.author).id)) return res;
+
+    if (Cooldown[(event.user || event.author).id]) {
+        res = true;
+        return emit("command on cooldown", (Cooldown[(event.user || event.author).id] - (event.editedTimestamp || event.createdTimestamp)));
+    }
+
+    if (!Cooldown[(event.user || event.author).id]) {
+        Cooldown[(event.user || event.author).id] = ((event.editedTimestamp || event.createdTimestamp) + (command.cooldown || event.client.settings.defaultCooldown || 0));
+
+        setTimeout(() => {
+            delete Cooldown[(event.user || event.author).id]
+        }, command.cooldown || event?.client?.settings?.defaultCooldown || 0);
+    }
+
+    if (command?.owner && event?.client?.settings?.ownerId != undefined && !event?.client?.settings?.ownerId?.includes((event.user || event.author).id)) {
+        res = true;
+        return emit("missing ownership", event?.client?.settings?.ownerId)
+    }
+
+    if (command?.admin && event?.member?.permissions?.has(Discord.PermissionFlagsBits.Administrator) == false) {
+        res = true;
+        return emit("missing admin permission", "Administrator")
+    }
+
+    if (command?.channel == "guild" && event?.channel?.type != "GUILD_TEXT") {
+        res = true
+        return emit("not a guild channel");
+    }
+
+    if (command?.channel == "dm" && event?.type != null) {
+        res = true;
+        return emit("not a dm channel");
+    }
+
+    if (command?.inVoice && !event?.member?.voice?.channelId) {
+        res = true;
+        return emit("not a in a voice channel");
+    }
+
+    if (event?.guild && command?.userPermissions?.length >= 1 || event?.client?.settings?.userPermissions?.length >= 1) {
+        let missingPerms = [];
+
+        for (const permission of command.userPermissions) {
+            if (!event?.member?.permissions?.has(Discord.PermissionFlagsBits[toPascalCase(permission)])) missingPerms.push(toPascalCase(permission));
+        }
+
+        for (const permission of event?.client?.settings?.userPermissions) {
+            if (!event?.member?.permissions?.has(Discord.PermissionFlagsBits[toPascalCase(permission)])) missingPerms.push(toPascalCase(permission));
+        }
+
+        if (missingPerms.length >= 1) {
+            res = true;
+            return emit("missing user permissions", missingPerms);
+        }
+    }
+
+    if (event?.guild && command?.clientPermissions.length >= 1 || event.client.settings.clientPermissions.length >= 1) {
+        let missingPerms = [];
+
+        for (const permission of command?.clientPermissions) {
+            if (!event?.guild?.members?.me?.permissions?.has(Discord.PermissionFlagsBits[toPascalCase(permission)])) missingPerms.push(toPascalCase(permission));
+        }
+
+        for (const permission of event?.client?.settings?.clientPermissions) {
+            if (!event?.guild?.members?.me?.permissions?.has(Discord.PermissionFlagsBits[toPascalCase(permission)])) missingPerms.push(toPascalCase(permission));
+        }
+
+        if (missingPerms.length >= 1) {
+            res = true;
+            return emit("missing client permissions", missingPerms);
+        }
+    }
+
+    if (command?.guilds?.length >= 1 && !command?.guilds?.includes(event.guild)) {
+        res = true;
+        return emit('not in a specified guild', command.guilds);
+    }
+
+    if (command?.channels?.length >= 1 && !command?.channels?.includes(event.channel.id)) {
+        res = true;
+        return emit('not in a specified channel', command.channels);
+    }
+
+    return res;
+}

package/models/data/Functions.js

@@ -1,12 +1,9 @@
-const { Message } = require('discord.js');
 const colors = require('./colors.json');
 
-const Cooldown = new Set();
 /**
  * @param {object} Functions - Build in functions of the bot hidden away in the handlers/setters.
  */
 class Functions {
-
     /**
      * 
      * @param {object} client - Client object.
@@ -100,25 +97,25 @@ class Functions {
 
                 else if (argument.type == 'user') {
                     let user;
-                    try { user = await message.client.users.fetch(content[0].replace(/<?@?!?|>?/g, "")) } catch (e) { user = e }
+                    try { user = await message.client.users.fetch(content[0].replace(/<@!?|>/g, "")) } catch (e) { user = e }
                     args[argument.name] = user;
                 }
 
                 else if (argument.type == 'role') {
                     let role;
-                    try { role = await message.guild.roles.fetch(content[0].replace(/<?@?&?|>?/g, "")) } catch (e) { role = e }
+                    try { role = await message.guild.roles.fetch(content[0].replace(/<@&?|>/g, "")) } catch (e) { role = e }
                     args[argument.name] = role;
                 }
 
                 else if (argument.type == 'member') {
                     let member;
-                    try { member = await message.guild.members.fetch(content[0].replace(/<?@?!?|>?/g, "")) } catch (e) { member = e }
+                    try { member = await message.guild.members.fetch(content[0].replace(/<@!?|>/g, "")) } catch (e) { member = e }
                     args[argument.name] = member;
                 }
 
                 else if (argument.type == 'channel') {
                     let channel;
-                    try { channel = await message.client.channels.fetch(content[0].replace(/<?#\?|>?/g, "")) } catch (e) { channel = e }
+                    try { channel = await message.client.channels.fetch(content[0].replace(/<#|>/g, "")) } catch (e) { channel = e }
                     args[argument.name] = channel;
                 }
 
@@ -143,55 +140,12 @@ class Functions {
         return args;
     }
 
-    access(event, command, res = false) {
-        if ((command.ignoreOwner || event.client.ignoreOwner) && event.client.ownerId.includes((event.user || event.author).id)) return res;
-
-        if (Cooldown.has((event.user || event.author).id)) {
-            res = false
-            return event.client.emit('commandBlocked', event, "command is on cooldown");
-        }
-
-        if (!Cooldown.has((event.user || event.author).id)) {
-            Cooldown.add((event.user || event.author).id);
-
-            setTimeout(() => {
-                Cooldown.delete((event.user || event.author).id);
-            }, command.cooldown || event.client.defaultCooldown || 0)
-        }
-
-        if (command.owner && event?.client?.ownerId != undefined && !event?.client?.ownerId?.includes((event.user || event.author).id)) {
-            res = true;
-            return event.client.emit('commandBlocked', event, "missing ownership")
-        }
-
-        if (command.admin && event?.member?.permissions?.has(Discord.Permissions.FLAGS.ADMINISTRATOR) == false) {
-            res = true;
-            return event.client.emit('commandBlocked', event, "missing admin permission")
-        }
-
-        if (command?.channel == "guild" && event?.channel?.type != "GUILD_TEXT") {
-            res = true
-            return event.client.emit('commandBlocked', event, "not a guild channel");
-        }
-
-        if (command?.channel == "dm" && event?.type != null) {
-            res = true;
-            return event.client.emit('commandBlocked', event, "not a dm channel");
-        }
-
-        if (command.inVoice && !event?.member?.voice?.channelId) {
-            res = true;
-            return event.client.emit('commandBlocked', event, "not a in a voice channel");
-        }
-
-        return res;
-    }
-
     async messageEdit(message, type) {
         setTimeout(() => {
             if (message.client.messages[message.id] === null || message.client.messages[message.id]) delete message.client.messages[message.id];
-            if (message.channel.messages.cache.has(message.id)) message.channel.messages.cache.delete(message.id)
-        }, message.client.cacheTime)
+
+            if (message.channel.messages.cache.has(message.id)) message.channel.messages.cache.delete(message.id);
+        }, message.client.settings.cacheTime);
 
         message.util = {};
 

package/models/events/interactionCreate.js

@@ -1,6 +1,7 @@
 const { Event } = require('../commands/Event.js');
-const { interactionArgs, access } = require('./../data/Functions.js');
+const { interactionArgs } = require('./../data/Functions.js');
 const { InteractionType } = require('discord.js')
+const commandValidation = require('./../data/CommandValidation.js');
 /**
  * @returns interaction command executor.
  */
@@ -26,7 +27,14 @@ class BuildInInteractionEvent extends Event {
 
                 const args = interactionArgs(interaction).options;
 
-                if (access(interaction, command)) return;
+                if (commandValidation(interaction, command)) return;
+
+                interaction.util = {}
+
+                interaction.util.reply = (text) => {
+                    if (interaction.replied || interaction.deferred) return interaction.editReply(text);
+                    else return interaction.reply(text);
+                }
 
                 try {
                     await command.exec(interaction, { group: group, subcommand: subcommand, args: args });

package/models/events/messageCreate.js

@@ -1,5 +1,6 @@
 const { Event } = require('../commands/Event.js');
-const { messageArgs, access, messageEdit } = require("./../data/Functions.js");
+const { messageArgs, messageEdit } = require("./../data/Functions.js");
+const commandValidation = require('./../data/CommandValidation.js');
 
 /**
  * @returns message command executor.
@@ -18,7 +19,7 @@ class BuildInMessageEvent extends Event {
 
             await messageEdit(message, "create");
 
-            for (const prefix of message.client.prefix) {
+            for (const prefix of message.client.settings.prefix) {
                 if (!message.content.startsWith(prefix)) continue;
 
                 let command = message.content.replace(prefix, "").split(/ +/).shift().toLowerCase();
@@ -31,7 +32,7 @@ class BuildInMessageEvent extends Event {
 
                 const args = await messageArgs({ message: message, command: command });
 
-                if (access(message, command)) return;
+                if (commandValidation(message, command)) return;
 
                 try {
                     await command.exec(message, args);

package/models/events/messageUpdate.js

@@ -1,5 +1,6 @@
 const { Event } = require('../commands/Event.js');
-const { messageArgs, access, messageEdit } = require("./../data/Functions.js");
+const { messageArgs, messageEdit } = require("./../data/Functions.js");
+const commandValidation = require('./../data/CommandValidation.js');
 
 /**
  * @returns message command executor.
@@ -21,7 +22,7 @@ class BuildInMessageUpdateEvent extends Event {
 
             if (!newMessage.client.messages[newMessage.id] == undefined) return;
 
-            for (const prefix of newMessage.client.prefix) {
+            for (const prefix of newMessage.client.settings.prefix) {
                 if (!newMessage.content.startsWith(prefix)) continue;
 
                 let command = newMessage.content.replace(prefix, "").split(/ +/).shift().toLowerCase();
@@ -34,7 +35,7 @@ class BuildInMessageUpdateEvent extends Event {
 
                 const args = await messageArgs({ message: newMessage, command: command });
 
-                if (access(newMessage, command)) return;
+                if (commandValidation(newMessage, command)) return;
 
                 try {
                     command.exec(newMessage, args);

package/models/events/readyOnce.js

@@ -8,7 +8,6 @@ class BuildInReadyOnceEvent extends Event {
     constructor() {
         super('ready', {
             name: 'ready',
-            type: 'client',
             once: true,
         })
     }

package/models/handlers/CommandHandler.js

@@ -23,16 +23,20 @@ class CommandHandler {
         client.contextMenuCommands = new Discord.Collection();
     }
 
-    loadInteractionCommands(path, logging = false) {
+    loadAllInteractionCommands(path, logging = false) {
         let commands = [];
 
         const commandFiles = fs.readdirSync(path).filter(file => file.endsWith('.js'))
 
         for (const file of commandFiles) {
-            let command = require(`${require("path").resolve(path)}/${file}`);
+            let filepath = `${require("path").resolve(path)}/${file}`
+
+            let command = require(filepath);
 
             command = new command;
 
+            command.filepath = filepath;
+
             this.commands.push(command.data.toJSON());
 
             commands.push(command.data.name);
@@ -42,19 +46,23 @@ class CommandHandler {
 
         this.#deployCommands("interaction commands", logging);
 
-        if (logging || this.client.logging) console.info(logStyle(`Loading interaction commands: ${commands.join(', ')}`, "text", "yellow"));
+        if (logging || this.client.settings.logging) console.info(logStyle(`Loading interaction commands: ${commands.join(', ')}`, "text", "yellow"));
     }
 
-    loadContextMenuCommands(path, logging = false) {
+    loadAllContextMenuCommands(path, logging = false) {
         let commands = [];
 
         const commandFiles = fs.readdirSync(path).filter(file => file.endsWith('.js'));
 
         for (const file of commandFiles) {
-            let command = require(`${require("path").resolve(path)}/${file}`);
+            let filepath = `${require("path").resolve(path)}/${file}`
+
+            let command = require(filepath);
 
             command = new command;
 
+            command.filepath = filepath;
+
             this.commands.push(command.data.toJSON());
 
             commands.push(command.data.name);
@@ -64,19 +72,23 @@ class CommandHandler {
 
         this.#deployCommands("context menu commands", logging);
 
-        if (logging || this.client.logging) console.info(logStyle(`Loading context menu commands: ${commands.join(', ')}`, 'text', 'yellow'));
+        if (logging || this.client.settings.logging) console.info(logStyle(`Loading context menu commands: ${commands.join(', ')}`, 'text', 'yellow'));
     }
 
-    loadMessageCommands(path, logging = false) {
+    loadAllMessageCommands(path, logging = false) {
         let commands = [];
 
         const commandFiles = fs.readdirSync(path).filter(file => file.endsWith('.js'));
 
         for (const file of commandFiles) {
-            let command = require(`${require("path").resolve(path)}/${file}`);
+            let filepath = `${require("path").resolve(path)}/${file}`
+
+            let command = require(filepath);
 
             command = new command;
 
+            command.filepath = filepath;
+
             command.aliases.forEach((alias) => {
                 if (this.client.messageCommands.has(alias)) throw new Error('Cannot have duplicated aliases.');
 
@@ -86,7 +98,7 @@ class CommandHandler {
             commands.push(command.name || command.id);
         }
 
-        if (logging || this.client.logging) console.info(logStyle(`Loaded message commands: ${commands.join(', ')}`, 'text', 'purple'));
+        if (logging || this.client.settings.logging) console.info(logStyle(`Loaded message commands: ${commands.join(', ')}`, 'text', 'purple'));
     }
 
     #deployCommands(type, logging = false) {
@@ -94,16 +106,18 @@ class CommandHandler {
             const rest = new REST({ version: GatewayVersion }).setToken(client.token);
 
             (async () => {
+                if (type === "interaction commands" && client.settings.logging) console.log(logStyle(`${client.user.tag} is online in ${(await client.guilds.fetch()).size} servers.`, "text", "cyan"));
+
                 try {
                     if (client.global == true) {
-                        if (logging || this.client.logging) console.info(logStyle(`Loaded ${type} in ${(await client.guilds.fetch()).size} server(s) globally.`, 'text', 'purple'));
+                        if (logging || this.client.settings.logging) console.info(logStyle(`Loaded ${type} in ${(await client.guilds.fetch()).size} server(s) globally.`, 'text', 'purple'));
                         rest.put(Routes.applicationCommands(client.user.id), {
                             body: this.commands
                         })
                     }
                     else {
-                        if (logging || this.client.logging) console.info(logStyle(`Loaded ${type} locally.`, 'text', 'purple'));
-                        rest.put(Routes.applicationGuildCommands(client.user.id, client.guildId), {
+                        if (logging || this.client.settings.logging) console.info(logStyle(`Loaded ${type} locally.`, 'text', 'purple'));
+                        rest.put(Routes.applicationGuildCommands(client.user.id, client.settings.guildId), {
                             body: this.commands
                         })
                     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xernerx",
-  "version": "2.0.2",
+  "version": "2.0.5",
   "description": "A bot framework for discord.js. [BETA]",
   "main": "main.js",
   "scripts": {
@@ -22,7 +22,7 @@
     "discord-api-types": "^0.36.3",
     "discord.js": "^14.0.3",
     "dumdiscord.js": "^1.0.5",
-    "dumfunctions": "^1.0.5",
+    "dumfunctions": "^1.0.6",
     "i18next": "^21.8.14"
   },
   "packageManager": "npm@8.5.5"