xernerx 1.2.6 → 2.0.2

package/docs/docs.md

@@ -0,0 +1,108 @@
+![Xernerx](./styles/banner.png)
+
+# A lightweight class based Discord.js framework.
+
+> - [Client](#Client)
+> - [Handlers](#Handlers)
+>   > - [Commands](#Commands)
+>   > - [Events](#Events)
+> - [Arguments](#Arguments)
+>   > - [Types](#Argument#Types)
+
+## Client
+
+> An extended discord.js client.
+>
+> ```js
+> const { Client } require('xernerx');
+>
+> const client = new Client({intents:[0]});
+> ```
+>
+> | parameter       | type     | default | required | description                                                     |
+> | --------------- | -------- | ------- | -------- | --------------------------------------------------------------- |
+> | intents         | Number[] | none    | true     | Discord#Intents                                                 |
+> | partials        | []       | none    | false    | Discord#Partials                                                |
+> | prefix          | String[] | none    | false    | Prefix for message commands                                     |
+> | ownerId         | String[] | none    | false    | Id(s) of the bot developer(s)                                   |
+> | guildId         | String   | none    | true     | local guild Id                                                  |
+> | global          | Boolean  | false   | true     | Whether the interaction commands are local or global            |
+> | ignoreOwner     | Boolean  | false   | false    | Whether the bot should ignore execute validation or not         |
+> | defaultCooldown | Number   | 0       | false    | The cooldown a user gets before executing another command       |
+> | color           | Object   | FLAGS   | false    | This appends colors to the bot                                  |
+> | config          | Object   | {}      | false    | Here you can save any info to the bot                           |
+> | logging         | Boolean  | false   | false    | Whether the bot should log any events on ready                  |
+> | cacheTime       | Number   | 300000  | false    | The amount of time before a message gets deleted from the cache |
+> | messages        | Object   | {}      | false    | The location where commands get linked with their executions    |
+
+## Handlers
+
+> Below you can see all the different types of handlers. Each command handler needs it's own folder.
+>
+> ### Commands
+>
+> > ```js
+> > const { Client, CommandHandler } = require("xernerx");
+> >
+> > const client = new Client({ intents: [0] });
+> >
+> > const commandHandler = new CommandHandler({ client: client });
+> > ```
+> >
+> > methods
+> >
+> > - [.loadMessageCommands()](<#.loadMessageCommands()>)
+> > - [.loadInteractionCommands()](<#.loadInteractionCommands()>)
+> > - [.loadContextMenuCommands()](<#.loadContextMenuCommands()>)
+> >
+> > #### .loadMessageCommands()
+> >
+> > The message command handler.
+> >
+> > | parameter | type    | default | required | description                              |
+> > | --------- | ------- | ------- | -------- | ---------------------------------------- |
+> > | path      | String  | none    | true     | The path of your message command folder. |
+> > | logging   | Boolean | false   | false    | Whether the bot logs commands on start.  |
+> >
+> > #### .loadInteractionCommands()
+> >
+> > The interaction command handler.
+> >
+> > | parameter | type    | default | required | description                                  |
+> > | --------- | ------- | ------- | -------- | -------------------------------------------- |
+> > | path      | String  | none    | true     | The path of your interaction command folder. |
+> > | logging   | Boolean | false   | false    | Whether the bot logs commands on start.      |
+> >
+> > #### .loadContextMenuCommands()
+> >
+> > The context menu command handler.
+> >
+> > | parameter | type    | default | required | description                                   |
+> > | --------- | ------- | ------- | -------- | --------------------------------------------- |
+> > | path      | String  | none    | true     | The path of your context menu command folder. |
+> > | logging   | Boolean | false   | false    | Whether the bot logs commands on start.       |
+>
+> ### Events
+>
+> > The event handler is much simpler than the command handler.
+> >
+> > ```js
+> > const { Client, EventHandler } = require("xernerx");
+> >
+> > const client = new Client({ intents: [0] });
+> >
+> > const eventHandler = new EventHandler({ client: client });
+> > ```
+> >
+> > methods
+> >
+> > - [.loadEvents()](<#.loadEvents()>)
+> >
+> > #### .loadEvents()
+> >
+> > The context menu command handler.
+> >
+> > | parameter | type    | default | required | description                           |
+> > | --------- | ------- | ------- | -------- | ------------------------------------- |
+> > | path      | String  | none    | true     | The path of your events folder.       |
+> > | logging   | Boolean | false   | false    | Whether the bot logs events on start. |

package/models/Client.js

@@ -26,10 +26,11 @@ class Client extends Discord.Client {
             ignoreOwner: s.boolean.optional,
             defaultCooldown: s.number.optional,
             logging: s.boolean.optional,
-            cacheTime: s.number.optional
+            cacheTime: s.number.optional,
+            dummi: s.boolean.optional
         }).parse(options)
 
-        this.client = new Discord.Client({ intents: [this.options.intents] });
+        this.client = new Discord.Client({ intents: [options.intents], partials: [options.partials] });
 
         this.client.messages = {};
 

package/models/commands/Event.js

@@ -4,21 +4,21 @@ const { s } = require('@sapphire/shapeshift')
  * @param {String} id - The id of the event. @required
  * @param {object} options - of the event. @required
  * @param {string} name - The name of the event. @required
- * @param {boolean} once - Whether the event should be ran once or continuesly.
+ * @param {boolean} once - Whether the event should be ran once or continuously.
  */
 class Event {
     constructor(id, options = {}) {
         s.object({
             name: s.string,
             once: s.boolean.optional,
-            process: s.boolean.optional
+            type: s.string.optional
         }).parse(options)
 
         this.name = options.name;
 
         this.once = options.once || false;
 
-        this.process = options.process || false;
+        this.type = options.type || 'client';
 
         this.config = options.config;
     }

package/models/commands/InteractionCommand.js

@@ -1,5 +1,5 @@
 const { s } = require('@sapphire/shapeshift');
-const Builders = require('@discordjs/builders');
+const { SlashCommandSubcommandGroupBuilder, SlashCommandSubcommandBuilder, SlashCommandBuilder } = require('discord.js');
 const { toTitleCase } = require('dumfunctions');
 
 /**
@@ -26,7 +26,7 @@ class InteractionCommand {
             inVoice: s.boolean.optional
         }).parse(options);
 
-        this.data = new Builders.SlashCommandBuilder()
+        this.data = new SlashCommandBuilder()
             .setName(options.name)
             .setDescription(options.description)
 
@@ -75,27 +75,23 @@ class InteractionCommand {
         const types = ["boolean", "integer", "number", "string", "user", "role", "channel", "mentionable"];
 
         for (const argument of args) {
-
             if (!types.includes(argument.type.toLowerCase())) throw new Error(`Expected one of ${types.join(', ')}, received ${argument.type} instead.`);
 
-            let build = new Builders[`SlashCommand${toTitleCase(argument.type, true)}Option`];
-
-            if (argument.options) {
-                for (const [key, value] of Object.entries(argument.options)) {
-                    if (key == 'choices') {
-                        build[`set${toTitleCase(key, true)}`](...value);
-                    }
-                    else build[`set${toTitleCase(key, true)}`](value);
-                }
-            }
+            where[`add${toTitleCase(argument.type, true)}Option`](option => {
+                option
+                    .setName(argument.name)
+                    .setDescription(argument.description)
+                    .setRequired(argument.required || false)
+                if (argument.choices) option.setChoices(...argument?.choices);
 
-            where[`add${toTitleCase(argument.type, true)}Option`](build);
+                return option;
+            })
         }
     }
 
     addSubcommands(where, subs) {
         for (const sub of subs) {
-            let subCommand = new Builders.SlashCommandSubcommandBuilder()
+            let subCommand = new SlashCommandSubcommandBuilder()
                 .setName(sub.name)
                 .setDescription(sub.description);
             if (sub?.args?.length > 0) {
@@ -107,7 +103,7 @@ class InteractionCommand {
 
     addSubcommandGroups(groups) {
         for (const group of groups) {
-            let subcommandGroup = new Builders.SlashCommandSubcommandGroupBuilder()
+            let subcommandGroup = new SlashCommandSubcommandGroupBuilder()
                 .setName(group.name)
                 .setDescription(group.description)
 

package/models/data/Functions.js

@@ -77,7 +77,7 @@ class Functions {
 
         for (const argument of command.args) {
 
-            let content = message.content.split(separator).slice(i + 1);
+            let content = message.content.replace(new RegExp(`${separator}${separator}+`, "g"), separator).split(separator).slice(i + 1);
 
             if (content.join(separator) != '') {
 
@@ -85,6 +85,10 @@ class Functions {
                     args[argument.name] = content[0];
                 }
 
+                else if (argument.type == 'string') {
+                    args[argument.name] = content[0];
+                }
+
                 else if (argument.type == 'number') {
                     args[argument.name] = parseInt(content[0]);
                 }
@@ -96,19 +100,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 }
+                    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;
                 }
 

package/models/events/interactionCreate.js

@@ -1,7 +1,6 @@
 const { Event } = require('../commands/Event.js');
 const { interactionArgs, access } = require('./../data/Functions.js');
-const Discord = require('discord.js')
-
+const { InteractionType } = require('discord.js')
 /**
  * @returns interaction command executor.
  */
@@ -9,50 +8,49 @@ class BuildInInteractionEvent extends Event {
     constructor() {
         super('interactionCreate', {
             name: 'interactionCreate',
+            type: 'client',
             once: false,
         })
     }
 
     async run(interaction) {
-        if (interaction.isCommand()) {
-            if (!interaction.client.interactionCommands.has(interaction.commandName)) return;
-
-            let command = interaction.client.interactionCommands.get(interaction.commandName);
+        if (interaction.type == InteractionType.ApplicationCommand) {
+            if (interaction.client.interactionCommands.has(interaction.commandName)) {
+                let command = interaction.client.interactionCommands.get(interaction.commandName);
 
-            command.client = interaction.client;
+                command.client = interaction.client;
 
-            let group = interactionArgs(interaction).group;
+                const group = interactionArgs(interaction).group;
 
-            let sub = interactionArgs(interaction).sub;
+                const subcommand = interactionArgs(interaction).sub;
 
-            let options = interactionArgs(interaction).options;
+                const args = interactionArgs(interaction).options;
 
-            if (access(interaction, command)) return;
+                if (access(interaction, command)) return;
 
-            try {
-                await command.exec(interaction, { group: group, sub: sub, options: options });
+                try {
+                    await command.exec(interaction, { group: group, subcommand: subcommand, args: args });
 
-                return interaction.client.emit('commandRun', interaction, "interaction", command)
-            }
-            catch (error) {
-                return interaction.client.emit("error", interaction, error);
+                    return interaction.client.emit('commandRun', interaction, "interaction", command)
+                }
+                catch (error) {
+                    return interaction.client.emit("error", interaction, error);
+                }
             }
-        }
-
-        if (interaction.isContextMenu()) {
-            if (!interaction.client.contextMenuCommands.has(interaction.commandName)) return;
 
-            let command = interaction.client.contextMenuCommands.get(interaction.commandName);
+            if (interaction.client.contextMenuCommands.has(interaction.commandName)) {
+                let command = interaction.client.contextMenuCommands.get(interaction.commandName);
 
-            command.client = interaction.client;
+                command.client = interaction.client;
 
-            try {
-                await command.exec(interaction);
+                try {
+                    await command.exec(interaction);
 
-                return interaction.client.emit('commandRun', interaction, 'contextMenu', command);
-            }
-            catch (error) {
-                return interaction.client.emit("error", interaction, error);
+                    return interaction.client.emit('commandRun', interaction, 'contextMenu', command);
+                }
+                catch (error) {
+                    return interaction.client.emit("error", interaction, error);
+                }
             }
         }
     }

package/models/events/messageCreate.js

@@ -8,6 +8,7 @@ class BuildInMessageEvent extends Event {
     constructor() {
         super('messageCreate', {
             name: 'messageCreate',
+            type: 'client',
             once: false,
         })
     }

package/models/events/messageUpdate.js

@@ -8,6 +8,7 @@ class BuildInMessageUpdateEvent extends Event {
     constructor() {
         super('messageUpdate', {
             name: 'messageUpdate',
+            type: 'client',
             once: false,
         })
     }

package/models/events/readyOnce.js

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

package/models/handlers/CommandHandler.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const Discord = require('discord.js');
 const { REST } = require('@discordjs/rest');
-const { Routes } = require('discord-api-types/v9');
+const { Routes, GatewayVersion } = require('discord-api-types/v10');
 const { delay, logStyle } = require('dumfunctions')
 const paths = require("path")
 
@@ -91,20 +91,25 @@ class CommandHandler {
 
     #deployCommands(type, logging = false) {
         this.client.once('ready', client => {
-            const rest = new REST({ version: '9' }).setToken(client.token);
+            const rest = new REST({ version: GatewayVersion }).setToken(client.token);
 
             (async () => {
-                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'));
-                    rest.put(Routes.applicationCommands(client.user.id), {
-                        body: this.commands
-                    })
+                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'));
+                        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), {
+                            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), {
-                        body: this.commands
-                    })
+                catch (e) {
+                    throw new Error(e)
                 }
             })();
         })

package/models/handlers/EventHandler.js

@@ -23,26 +23,19 @@ class EventHandler {
 
             events.push(event.name);
 
-            if (event.process) {
-                process.on(event.name, (...args) => {
-                    event.run(...args);
-                })
-            }
-
-            else if (event.once) {
-                this.client.once(event.name, (...args) => {
-                    event.run(...args);
+            if (event.once) {
+                this.emitter(event.type).once(event.name, (...args) => {
+                    event.run(...args)
                 })
             }
-
             else {
-                this.client.on(event.name, (...args) => {
+                this.emitter(event.type).on(event.name, (...args) => {
                     event.run(...args)
                 })
             }
         }
 
-        if (logging) console.info(logStyle(`Loaded events: ${events.join(', ')}`, 'text', 'purple'));
+        if (logging || this.client.logging) console.info(logStyle(`Loaded events: ${events.join(', ')}`, 'text', 'purple'));
 
         const builderFiles = fs.readdirSync(`${__dirname}/../events`).filter(file => file.endsWith('.js'))
 
@@ -51,25 +44,24 @@ class EventHandler {
 
             event = new event;
 
-            if (event.process) {
-                process.on(event.name, (...args) => {
-                    event.run(...args);
-                })
-            }
-
-            else if (event.once) {
-                this.client.once(event.name, (...args) => {
-                    event.run(...args);
+            if (event.once) {
+                this.emitter(event.type).once(event.name, (...args) => {
+                    event.run(...args)
                 })
             }
-
             else {
-                this.client.on(event.name, (...args) => {
-                    event.run(...args);
+                this.emitter(event.type).on(event.name, (...args) => {
+                    event.run(...args)
                 })
             }
         }
     }
+
+    emitter(type) {
+        if (type == 'client') return this.client;
+        if (type == 'rest') return this.client.rest;
+        else return eval(type)
+    }
 }
 
 module.exports = { EventHandler };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xernerx",
-  "version": "1.2.6",
+  "version": "2.0.2",
   "description": "A bot framework for discord.js. [BETA]",
   "main": "main.js",
   "scripts": {
@@ -17,11 +17,10 @@
   },
   "homepage": "https://github.com/TheDummi/xernerx#readme",
   "dependencies": {
-    "@discordjs/builders": "1.0.0",
     "@discordjs/rest": "1.0.0",
     "@sapphire/shapeshift": "3.5.1",
     "discord-api-types": "^0.36.3",
-    "discord.js": "^13.9.0",
+    "discord.js": "^14.0.3",
     "dumdiscord.js": "^1.0.5",
     "dumfunctions": "^1.0.5",
     "i18next": "^21.8.14"