v3.2.0

# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

- Add the ability for button event interactions to be created
- Added a button event interaction which gives a user the role which is specified in the config `verification.role`
- Added a command to generate a button to activate the verify button event

#232

## Type of change

Please delete options that are not relevant.

- [x] New feature (non-breaking change which adds functionality)

# How Has This Been Tested?

Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration.

# Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that provde my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/vylbot-app/pulls/398
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>

.dev.env

@@ -7,7 +7,7 @@
 # any secret values.
 
 BOT_TOKEN=
-BOT_VER=3.1.3
+BOT_VER=3.2 DEV
 BOT_AUTHOR=Vylpes
 BOT_OWNERID=147392775707426816
 BOT_CLIENTID=682942374040961060

.drone.yml

@@ -54,11 +54,11 @@ steps:
   - yarn install --frozen-lockfile
   - yarn build
 
-- name: test
+# - name: test
-  image: node
+#   image: node
-  commands:
+#   commands:
-  - yarn install --frozen-lockfile
+#   - yarn install --frozen-lockfile
-  - yarn test
+#   - yarn test
 
 trigger:
   branch:

.gitea/PULL_REQUEST_TEMPLATE.md

@@ -24,6 +24,6 @@ Please describe the tests that you ran to verify the changes. Provide instructio
 - [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation
 - [ ] My changes generate no new warnings
-- [ ] I have added tests that provde my fix is effective or that my feature works
+- [ ] I have added tests that provide my fix is effective or that my feature works
 - [ ] New and existing unit tests pass locally with my changes
 - [ ] Any dependent changes have been merged and published in downstream modules

.prod.env

@@ -7,7 +7,7 @@
 # any secret values.
 
 BOT_TOKEN=
-BOT_VER=3.1.3
+BOT_VER=3.2
 BOT_AUTHOR=Vylpes
 BOT_OWNERID=147392775707426816
 BOT_CLIENTID=680083120896081954

.stage.env

@@ -7,7 +7,7 @@
 # any secret values.
 
 BOT_TOKEN=
-BOT_VER=3.1.3
+BOT_VER=3.2 BETA
 BOT_AUTHOR=Vylpes
 BOT_OWNERID=147392775707426816
 BOT_CLIENTID=1016767908740857949

data/usage/config.txt

@@ -26,11 +26,11 @@ event.message.delete.channel: Sets the channel the bot will log message delete e
 event.message.update.enabled: Enables/Disables the message delete log event (Default: "false")
 event.message.update.channel: Sets the channel the bot will log message delete events to (Default: "message-logs")
 
-event.member.add.enabled: Enables/Disables the message delete log event (Default: "false")
+event.member.add.enabled: Enables/Disables the member join log event (Default: "false")
-event.member.add.channel: Sets the channel the bot will log message delete events to (Default: "member-logs")
+event.member.add.channel: Sets the channel the bot will log member join events to (Default: "member-logs")
 
-event.member.remove.enabled: Enables/Disables the message delete log event (Default: "false")
+event.member.remove.enabled: Enables/Disables the member leave log event (Default: "false")
-event.member.remove.channel: Sets the channel the bot will log message delete events to (Default: "member-logs")
+event.member.remove.channel: Sets the channel the bot will log member leave events to (Default: "member-logs")
 
-event.member.update.enabled: Enables/Disables the message delete log event (Default: "false")
+event.member.update.enabled: Enables/Disables the member update log event (Default: "false")
-event.member.update.channel: Sets the channel the bot will log message delete events to (Default: "member-logs")
+event.member.update.channel: Sets the channel the bot will log member update events to (Default: "member-logs")

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vylbot-app",
-  "version": "3.1.3",
+  "version": "3.2.0",
   "description": "A discord bot made for Vylpes' Den",
   "main": "./dist/vylbot",
   "typings": "./dist",
@@ -26,7 +26,7 @@
   "homepage": "https://github.com/Vylpes/vylbot-app",
   "funding": "https://ko-fi.com/vylpes",
   "dependencies": {
-    "@discordjs/rest": "^1.1.0",
+    "@discordjs/rest": "^2.0.0",
     "@types/jest": "^29.0.0",
     "@types/uuid": "^9.0.0",
     "discord.js": "^14.3.0",
@@ -34,7 +34,7 @@
     "emoji-regex": "^10.0.0",
     "jest": "^29.0.0",
     "jest-mock-extended": "^3.0.0",
-    "minimatch": "9.0.2",
+    "minimatch": "9.0.3",
     "mysql": "^2.18.1",
     "random-bunny": "^2.0.5",
     "ts-jest": "^29.0.0",
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
-    "np": "^8.0.4",
+    "np": "^9.0.0",
     "typescript": "^5.0.0"
   }
 }

src/buttonEvents/verify.ts

@@ -0,0 +1,42 @@
+import { ButtonInteraction, CacheType } from "discord.js";
+import { ButtonEvent } from "../type/buttonEvent";
+import SettingsHelper from "../helpers/SettingsHelper";
+
+export default class Verify extends ButtonEvent {
+    public override async execute(interaction: ButtonInteraction<CacheType>) {
+        if (!interaction.guildId || !interaction.guild) return;
+
+        const roleName = await SettingsHelper.GetSetting("verification.role", interaction.guildId);
+
+        if (!roleName) return;
+
+        const role = interaction.guild.roles.cache.find(x => x.name == roleName);
+
+        if (!role) {
+            await interaction.reply({
+                content: `Unable to find the role, ${roleName}`,
+                ephemeral: true,
+            });
+
+            return;
+        }
+
+        const member = interaction.guild.members.cache.find(x => x.id == interaction.user.id);
+
+        if (!member || !member.manageable) {
+            await interaction.reply({
+                content: "Unable to give role to user",
+                ephemeral: true,
+            });
+
+            return;
+        }
+
+        await member.roles.add(role);
+
+        await interaction.reply({
+            content: "Given role",
+            ephemeral: true,
+        });
+    }
+}

src/client/client.ts

@@ -1,4 +1,4 @@
-import { Client } from "discord.js";
+import { Client, Partials } from "discord.js";
 import * as dotenv from "dotenv";
 import { createConnection } from "typeorm";
 import { EventType } from "../constants/EventType";
@@ -9,10 +9,13 @@ import { Command } from "../type/command";
 import { Events } from "./events";
 import { Util } from "./util";
 import AppDataSource from "../database/dataSources/appDataSource";
+import ButtonEventItem from "../contracts/ButtonEventItem";
+import { ButtonEvent } from "../type/buttonEvent";
 
 export class CoreClient extends Client {
     private static _commandItems: ICommandItem[];
     private static _eventItems: IEventItem[];
+    private static _buttonEvents: ButtonEventItem[];
 
     private _events: Events;
     private _util: Util;
@@ -25,12 +28,17 @@ export class CoreClient extends Client {
         return this._eventItems;
     }
 
-    constructor(intents: number[]) {
+    public static get buttonEvents(): ButtonEventItem[] {
-        super({ intents: intents });
+        return this._buttonEvents;
+    }
+
+    constructor(intents: number[], partials: Partials[]) {
+        super({ intents: intents, partials: partials });
         dotenv.config();
 
         CoreClient._commandItems = [];
         CoreClient._eventItems = [];
+        CoreClient._buttonEvents = [];
 
         this._events = new Events();
         this._util = new Util();
@@ -73,4 +81,13 @@ export class CoreClient extends Client {
 
         CoreClient._eventItems.push(item);
     }
+
+    public static RegisterButtonEvent(buttonId: string, event: ButtonEvent) {
+        const item: ButtonEventItem = {
+            ButtonId: buttonId,
+            Event: event,
+        };
+
+        CoreClient._buttonEvents.push(item);
+    }
 }

src/client/events.ts

@@ -1,40 +1,18 @@
 import { Interaction } from "discord.js";
-import ICommandItem from "../contracts/ICommandItem";
+import ChatInputCommand from "./interactionCreate/chatInputCommand";
-import SettingsHelper from "../helpers/SettingsHelper";
+import Button from "./interactionCreate/button";
-import { CoreClient } from "./client";
 
 export class Events {
     public async onInteractionCreate(interaction: Interaction) {
-        if (!interaction.isChatInputCommand()) return;
         if (!interaction.guildId) return;
 
-        const disabledCommandsString = await SettingsHelper.GetSetting("commands.disabled", interaction.guildId);
+        if (interaction.isChatInputCommand()) {
-        const disabledCommands = disabledCommandsString?.split(",");
+            ChatInputCommand.onChatInput(interaction);
-
-        const disabledCommandsMessage = await SettingsHelper.GetSetting("commands.disabled.message", interaction.guildId);
-
-        if (disabledCommands?.find(x => x == interaction.commandName)) {
-            await interaction.reply(disabledCommandsMessage || "This command is disabled.");
-            return;
         }
 
-        const item = CoreClient.commandItems.find(x => x.Name == interaction.commandName && !x.ServerId);
+        if (interaction.isButton()) {
-        const itemForServer = CoreClient.commandItems.find(x => x.Name == interaction.commandName && x.ServerId == interaction.guildId);
+            Button.onButtonClicked(interaction);
-
-        let itemToUse: ICommandItem;
-
-        if (!itemForServer) {
-            if (!item) {
-                await interaction.reply('Command not found');
-                return;
-            }
-
-            itemToUse = item;
-        } else {
-            itemToUse = itemForServer;
         }
-
-        itemToUse.Command.execute(interaction);
     }
 
     // Emit when bot is logged in and ready to use

src/client/interactionCreate/button.ts

@@ -0,0 +1,17 @@
+import { ButtonInteraction } from "discord.js";
+import { CoreClient } from "../client";
+
+export default class Button {
+    public static async onButtonClicked(interaction: ButtonInteraction) {
+        if (!interaction.isButton) return;
+
+        const item = CoreClient.buttonEvents.find(x => x.ButtonId == interaction.customId.split(" ")[0]);
+
+        if (!item) {
+            await interaction.reply("Event not found.");
+            return;
+        }
+
+        item.Event.execute(interaction);
+    }
+}

src/client/interactionCreate/chatInputCommand.ts

@@ -0,0 +1,27 @@
+import { Interaction } from "discord.js";
+import { CoreClient } from "../client";
+import ICommandItem from "../../contracts/ICommandItem";
+
+export default class ChatInputCommand {
+    public static async onChatInput(interaction: Interaction) {
+        if (!interaction.isChatInputCommand()) return;
+
+        const item = CoreClient.commandItems.find(x => x.Name == interaction.commandName && !x.ServerId);
+        const itemForServer = CoreClient.commandItems.find(x => x.Name == interaction.commandName && x.ServerId == interaction.guildId);
+
+        let itemToUse: ICommandItem;
+
+        if (!itemForServer) {
+            if (!item) {
+                await interaction.reply("Command not found.");
+                return;
+            }
+
+            itemToUse = item;
+        } else {
+            itemToUse = itemForServer;
+        }
+
+        itemToUse.Command.execute(interaction);
+    }
+}

src/client/util.ts

@@ -37,7 +37,7 @@ export class Util {
                 .flatMap(x => x.Command.CommandBuilder);
 
             if (!client.guilds.cache.has(guild)) continue;
-            
+
             rest.put(
                 Routes.applicationGuildCommands(process.env.BOT_CLIENTID!, guild),
                 {

src/commands/ban.ts

@@ -44,6 +44,7 @@ export default class Ban extends Command {
             .setColor(EmbedColours.Ok)
             .setTitle("Member Banned")
             .setDescription(`<@${targetUser.user.id}> \`${targetUser.user.tag}\``)
+            .setThumbnail(targetUser.user.avatarURL())
             .addFields([
                 {
                     name: "Moderator",

src/commands/config.ts

@@ -116,9 +116,15 @@ export default class Config extends Command {
         const setting = server.Settings.filter(x => x.Key == key.value)[0];
 
         if (setting) {
-            await interaction.reply(`\`${key}\`: \`${setting.Value}\``);
+            await interaction.reply(`\`${key.value}\`: \`${setting.Value}\``);
         } else {
-            await interaction.reply(`\`${key}\`: \`${DefaultValues.GetValue(key.value.toString())}\` <DEFAULT>`);
+            var defaultValue = DefaultValues.GetValue(key.value.toString());
+
+            if (defaultValue) {
+                await interaction.reply(`\`${key.value}\`: \`${defaultValue}\` <DEFAULT>`);
+            } else {
+                await interaction.reply(`\`${key.value}\`: <NONE>`);
+            }
         }
     }
 
@@ -191,4 +197,4 @@ export default class Config extends Command {
 
         await interaction.reply('Setting has been set.');
     }
-}
+}

src/commands/kick.ts

@@ -44,6 +44,7 @@ export default class Kick extends Command {
             .setColor(EmbedColours.Ok)
             .setTitle("Member Kicked")
             .setDescription(`<@${targetUser.user.id}> \`${targetUser.user.tag}\``)
+            .setThumbnail(targetUser.user.avatarURL())
             .addFields([
                 {
                     name: "Moderator",

src/commands/mute.ts

@@ -42,6 +42,7 @@ export default class Mute extends Command {
             .setColor(EmbedColours.Ok)
             .setTitle("Member Muted")
             .setDescription(`<@${targetUser.user.id}> \`${targetUser.user.tag}\``)
+            .setThumbnail(targetUser.user.avatarURL())
             .addFields([
                 {
                     name: "Moderator",
@@ -53,7 +54,14 @@ export default class Mute extends Command {
                 },
             ]);
 
-        const mutedRole = interaction.guild.roles.cache.find(role => role.name == process.env.ROLES_MUTED);
+        const mutedRoleName = await SettingsHelper.GetSetting('role.muted', interaction.guildId);
+
+        if (!mutedRoleName) {
+            await interaction.reply('Unable to find configuration. Please contact the bot author.');
+            return;
+        }
+
+        const mutedRole = interaction.guild.roles.cache.find(role => role.name == mutedRoleName);
 
         if (!mutedRole) {
             await interaction.reply('Muted role not found.');

src/commands/rules.ts

@@ -1,7 +1,8 @@
-import { CommandInteraction, EmbedBuilder, PermissionsBitField, SlashCommandBuilder } from "discord.js";
+import { ActionRowBuilder, ButtonBuilder, ButtonStyle, CommandInteraction, EmbedBuilder, PermissionsBitField, SlashCommandBuilder } from "discord.js";
 import { existsSync, readFileSync } from "fs";
 import EmbedColours from "../constants/EmbedColours";
 import { Command } from "../type/command";
+import SettingsHelper from "../helpers/SettingsHelper";
 
 interface IRules {
     title?: string;
@@ -14,13 +15,36 @@ export default class Rules extends Command {
     constructor() {
         super();
 
-        super.CommandBuilder = new SlashCommandBuilder()
+        this.CommandBuilder = new SlashCommandBuilder()
-            .setName("rules")
+            .setName('rules')
-            .setDescription("Send the rules embeds for this server")
+            .setDescription("Rules-related commands")
-            .setDefaultMemberPermissions(PermissionsBitField.Flags.Administrator);
+            .setDefaultMemberPermissions(PermissionsBitField.Flags.Administrator)
+            .addSubcommand(x =>
+                x
+                    .setName('embeds')
+                    .setDescription('Send the rules embeds for this server'))
+            .addSubcommand(x =>
+                x
+                    .setName('access')
+                    .setDescription('Send the server verification embed button'));
     }
 
     public override async execute(interaction: CommandInteraction) {
+        if (!interaction.isChatInputCommand()) return;
+
+        switch (interaction.options.getSubcommand()) {
+            case "embeds":
+                await this.SendEmbeds(interaction);
+                break;
+            case "access":
+                await this.SendAccessButton(interaction);
+                break;
+            default:
+                await interaction.reply("Subcommand doesn't exist.");
+        }
+    }
+
+    private async SendEmbeds(interaction: CommandInteraction) {
         if (!interaction.guildId) return;
 
         if (!existsSync(`${process.cwd()}/data/rules/${interaction.guildId}.json`)) {
@@ -71,4 +95,27 @@ export default class Rules extends Command {
 
         await interaction.reply({ embeds: [ successEmbed ], ephemeral: true });
     }
+
+    private async SendAccessButton(interaction: CommandInteraction) {
+        if (!interaction.guildId) return;
+
+        const buttonLabel = await SettingsHelper.GetSetting("rules.access.label", interaction.guildId);
+
+        const row = new ActionRowBuilder<ButtonBuilder>()
+            .addComponents([
+                new ButtonBuilder()
+                    .setCustomId('verify')
+                    .setStyle(ButtonStyle.Primary)
+                    .setLabel(buttonLabel || "Verify")
+            ]);
+
+        await interaction.channel?.send({
+            components: [ row ]
+        });
+
+        await interaction.reply({
+            content: "Success",
+            ephemeral: true,
+        });
+    }
 }

src/commands/timeout.ts

@@ -64,6 +64,7 @@ export default class Timeout extends Command {
             .setColor(EmbedColours.Ok)
             .setTitle("Member Timed Out")
             .setDescription(`<@${targetUser.user.id}> \`${targetUser.user.tag}\``)
+            .setThumbnail(targetUser.user.avatarURL())
             .addFields([
                 {
                     name: "Moderator",

src/commands/unmute.ts

@@ -40,6 +40,7 @@ export default class Unmute extends Command {
             .setColor(EmbedColours.Ok)
             .setTitle("Member Unmuted")
             .setDescription(`<@${targetUser.user.id}> \`${targetUser.user.tag}\``)
+            .setThumbnail(targetUser.user.avatarURL())
             .addFields([
                 {
                     name: "Moderator",
@@ -51,7 +52,14 @@ export default class Unmute extends Command {
                 },
             ]);
 
-        const mutedRole = interaction.guild.roles.cache.find(role => role.name == process.env.ROLES_MUTED);
+        const mutedRoleName = await SettingsHelper.GetSetting('role.muted', interaction.guildId);
+
+        if (!mutedRoleName) {
+            await interaction.reply('Unable to find configuration. Please contact the bot author.');
+            return;
+        }
+
+        const mutedRole = interaction.guild.roles.cache.find(role => role.name == mutedRoleName);
 
         if (!mutedRole) {
             await interaction.reply('Muted role not found.');

src/commands/warn.ts

@@ -41,6 +41,7 @@ export default class Warn extends Command {
             .setColor(EmbedColours.Ok)
             .setTitle("Member Warned")
             .setDescription(`<@${targetUser.user.id}> \`${targetUser.user.tag}\``)
+            .setThumbnail(targetUser.user.avatarURL())
             .addFields([
                 {
                     name: "Moderator",

src/constants/DefaultValues.ts

@@ -6,7 +6,7 @@ export default class DefaultValues {
         this.SetValues();
 
         const res = this.values.find(x => x.Key == key);
-        
+
         if (!res) {
             return undefined;
         }
@@ -31,6 +31,7 @@ export default class DefaultValues {
 
             // Rules (Command)
             this.values.push({ Key: "rules.file", Value: "data/rules/rules" });
+            this.values.push({ Key: "rules.access.label", Value: "Verify" });
 
             // Channels
             this.values.push({ Key: "channels.logs.message", Value: "message-logs" });
@@ -46,18 +47,18 @@ export default class DefaultValues {
             // Event
             this.values.push({ Key: "event.message.delete.enabled", Value: "false" });
             this.values.push({ Key: "event.message.delete.channel", Value: "message-logs" });
-            
+
             this.values.push({ Key: "event.message.update.enabled", Value: "false" });
             this.values.push({ Key: "event.message.update.channel", Value: "message-logs" });
-            
+
             this.values.push({ Key: "event.member.add.enabled", Value: "false" });
             this.values.push({ Key: "event.member.add.channel", Value: "member-logs" });
-             
+
             this.values.push({ Key: "event.member.remove.enabled", Value: "false" });
             this.values.push({ Key: "event.member.remove.channel", Value: "member-logs" });
-            
+
             this.values.push({ Key: "event.member.update.enabled", Value: "false" });
-            this.values.push({ Key: "event.member.remove.channel", Value: "member-logs" });
+            this.values.push({ Key: "event.member.update.channel", Value: "member-logs" });
 
         }
     }

src/contracts/ButtonEventItem.ts

@@ -0,0 +1,8 @@
+import { ButtonEvent } from "../type/buttonEvent";
+
+interface ButtonEventItem {
+    ButtonId: string,
+    Event: ButtonEvent,
+}
+
+export default ButtonEventItem;

src/events/MessageEvents/MessageDelete.ts

@@ -33,8 +33,8 @@ export default async function MessageDelete(message: Message) {
     if (message.attachments.size > 0) {
         embed.addFields([
             {
-                name: "Attachments",
+                name: `Attachments (${message.attachments.size})`,
-                value: `\`\`\`${message.attachments.map(x => x.url).join("\n")}\`\`\``
+                value: `\`\`\`${message.attachments.map(x => x.name).join("\n")}\`\`\``
             }
         ]);
     }

src/registry.ts

@@ -37,6 +37,9 @@ import MessageDelete from "./events/MessageEvents/MessageDelete";
 import MessageUpdate from "./events/MessageEvents/MessageUpdate";
 import MessageCreate from "./events/MessageEvents/MessageCreate";
 
+// Button Event Imports
+import Verify from "./buttonEvents/verify";
+
 export default class Registry {
     public static RegisterCommands() {
         CoreClient.RegisterCommand("about", new About());
@@ -84,4 +87,8 @@ export default class Registry {
         CoreClient.RegisterEvent(EventType.MessageUpdate, MessageUpdate);
         CoreClient.RegisterEvent(EventType.MessageCreate, MessageCreate);
     }
+
+    public static RegisterButtonEvents() {
+        CoreClient.RegisterButtonEvent("verify", new Verify());
+    }
 }

src/type/buttonEvent.ts

@@ -0,0 +1,5 @@
+import { ButtonInteraction } from "discord.js";
+
+export abstract class ButtonEvent {
+    abstract execute(interaction: ButtonInteraction): Promise<void>;
+}

src/vylbot.ts

@@ -1,7 +1,7 @@
 import { CoreClient } from "./client/client";
 import * as dotenv from "dotenv";
 import registry from "./registry";
-import { IntentsBitField } from "discord.js";
+import { IntentsBitField, Partials } from "discord.js";
 
 dotenv.config();
 
@@ -30,9 +30,13 @@ const client = new CoreClient([
     IntentsBitField.Flags.GuildMessages,
     IntentsBitField.Flags.GuildMembers,
     IntentsBitField.Flags.MessageContent,
+], [
+    Partials.GuildMember,
+    Partials.User,
 ]);
 
 registry.RegisterCommands();
 registry.RegisterEvents();
+registry.RegisterButtonEvents();
 
 client.start();