First version of VC notifications

Author: EleosOS

package-lock.json

@@ -16,7 +16,7 @@
     "@typescript-eslint/parser": "^5.10.0",
     "cron-validator": "^1.3.1",
     "croner": "^4.1.95",
-    "detritus-client": "^0.16.4-beta.6",
+    "detritus-client": "^0.17.0-beta.1",
     "jimp": "^0.16.1",
     "mysql2": "^2.3.3",
     "reflect-metadata": "^0.1.13",

package.json

@@ -1,14 +1,17 @@
-import { ClusterClient, InteractionCommandClient, ShardClient, Utils } from "detritus-client";
+import { ClusterClient, InteractionCommandClient } from "detritus-client";
+import { MessageComponentButtonStyles, MessageComponentTypes } from "detritus-client/lib/constants";
 
-import { Config, Signale, Webhooks } from "./";
+import { Config, Signale, Webhooks, VCNotifyManager } from "./";
 
 export const InteractionBot = new InteractionCommandClient(Config.token, {
     gateway: {
-        intents: ["GUILDS", "GUILD_MEMBERS", "GUILD_WEBHOOKS"],
+        intents: ["GUILDS", "GUILD_MEMBERS", "GUILD_WEBHOOKS", "GUILD_VOICE_STATES"],
     },
 });
 
 // Events
+// Message Component Interactions are handled in InteractionHandling.ts
+
 InteractionBot.client.on("guildMemberRemove", async (gmr) => {
     const client = (InteractionBot.client as ClusterClient).shards.first()!;
 
@@ -31,6 +34,37 @@ InteractionBot.client.on("guildUpdate", (guildUpdate) => {
     }
 });
 
+InteractionBot.client.on("voiceStateUpdate", (vsu) => {
+    if (vsu.leftChannel || VCNotifyManager.watchers.length === 0) return;
+
+    let message = "";
+    let j = 0;
+
+    for (var i = VCNotifyManager.watchers.length; i--; ) {
+        const [key, value] = VCNotifyManager.watchers[i];
+
+        if (vsu.voiceState.userId === key) {
+            j++;
+            message += `<@${value}>`;
+            VCNotifyManager.watchers.splice(i, 1);
+        }
+    }
+
+    if (j <= 2) {
+        message += " - ";
+    } else {
+        message += "\n\n";
+    }
+
+    message += `<@${vsu.voiceState.userId}> has joined <#${vsu.voiceState.channelId}>. (You will not be notified again.)`;
+
+    const client = (InteractionBot.client as ClusterClient).shards.first()!;
+    Webhooks.execute(Webhooks.ids.voiceStateNotification, {
+        avatarUrl: client.user!.avatarUrl,
+        content: message,
+    });
+});
+
 // Helper Functions
 
 /**

src/Modules/Bot.ts

@@ -15,7 +15,7 @@ enum EoRStatus {
 }
 
 /**
- * Interaction.InteractionContext.editOrRespond(), but the response is forced to be ephemeral and edits strings into the normal form.
+ * Interaction.InteractionContext.editOrRespond(), but the response is forced to be ephemeral and edits strings into the project-defined normal form. Strings will not be edited when status is 0 or when options is an object.
  * @param ctx
  * @param options
  * @param status What icon to add to the content

src/Modules/Commands/Basecommand.ts

@@ -0,0 +1,44 @@
+import { Interaction } from "detritus-client";
+import { MessageComponentTypes, MessageComponentButtonStyles } from "detritus-client/lib/constants";
+
+import { BaseContextMenuUserCommand, ContextMenuUserArgs } from "..";
+import { VCNotifyManager } from "../..";
+import { VCNotifyToggleButtonComponent } from "../../Components";
+
+class VCNotifyContextCommand extends BaseContextMenuUserCommand {
+    constructor() {
+        super({
+            name: "Toggle VC Notification",
+        });
+    }
+
+    async run(ctx: Interaction.InteractionContext, args: ContextMenuUserArgs) {
+        const toggleString = VCNotifyManager.toggleMessage(args.user.id, ctx.userId);
+
+        this.ephEoR(
+            ctx,
+            {
+                content: toggleString,
+                components: [
+                    {
+                        type: MessageComponentTypes.ACTION_ROW,
+                        components: [
+                            /*{
+                                type: MessageComponentTypes.BUTTON,
+                                customId: `vcnotify:${args.user.id}`,
+                                emoji: { name: "🔔" },
+                                label: `Toggle VC Notification`,
+                                style: MessageComponentButtonStyles.PRIMARY,
+                            },*/
+
+                            new VCNotifyToggleButtonComponent(args.user.id),
+                        ],
+                    },
+                ],
+            },
+            0
+        );
+    }
+}
+
+export default VCNotifyContextCommand;

src/Modules/Commands/contextUser/VCNotify.ts

@@ -6,4 +6,6 @@ import PingCommand from "./slash/Ping";
 import PurgeCommand from "./slash/Purge";
 import RoleGroupCommand from "./slash/RoleGroup";
 
-export default [new HelpCommand(), new HueGroupCommand(), new PingCommand(), new PurgeCommand(), new RoleGroupCommand()];
+import VCNotifyContextCommand from "./contextUser/VCNotify";
+
+export default [new HelpCommand(), new HueGroupCommand(), new PingCommand(), new PurgeCommand(), new RoleGroupCommand(), new VCNotifyContextCommand()];

src/Modules/Commands/index.ts

@@ -0,0 +1,35 @@
+import { MessageComponentButtonStyles, MessageFlags } from "detritus-client/lib/constants";
+import { InteractionEditOrRespond } from "detritus-client/lib/structures";
+import { ComponentActionData, ComponentActionRow, ComponentButton, ComponentContext } from "detritus-client/lib/utils";
+
+import { VCNotifyManager } from "..";
+
+new ComponentActionRow({});
+
+export class VCNotifyToggleButtonComponent extends ComponentButton {
+    componentId: string;
+    watchedId: string;
+
+    constructor(watchedId: string, data?: ComponentActionData) {
+        super(data);
+
+        this.componentId = "vcnotify:";
+        this.watchedId = watchedId;
+
+        this.customId = this.componentId + this.watchedId;
+        this.emoji = { name: "🔔" };
+        this.label = "Toggle VC Notification";
+        this.style = MessageComponentButtonStyles.PRIMARY;
+    }
+
+    run(ctx: ComponentContext) {
+        const toggleString = VCNotifyManager.toggleMessage(this.watchedId, ctx.userId);
+
+        const message: InteractionEditOrRespond = {
+            content: toggleString,
+            flags: MessageFlags.EPHEMERAL,
+        };
+
+        return ctx.editOrRespond(message);
+    }
+}

src/Modules/Components/VCNotifyToggleButton.ts

@@ -0,0 +1 @@
+export * from "./VCNotifyToggleButton";

src/Modules/Components/index.ts

@@ -0,0 +1,60 @@
+/**
+ * @key userId of the user to watch out for
+ * @value userId of the user that should be notified
+ */
+class VCNotifyManagerClass {
+    watchers: string[][];
+
+    constructor() {
+        this.watchers = [];
+    }
+
+    /**
+     * Toggles whether or not the user of notifiedId should recieve a notification when watchedId join a VC
+     *
+     * @param watchedId userId of the person to watch out for
+     * @param notifiedId userId of the user that should be notified
+     * @return True if user gets notified, False if not
+     */
+    toggle(watchedId: string, notifiedId: string): boolean {
+        let vswIndex: number | undefined;
+
+        for (var i = this.watchers.length; i--; ) {
+            const [key, value] = this.watchers[i];
+
+            if (key === watchedId && value === notifiedId) {
+                vswIndex = i;
+            }
+        }
+
+        // If a user is already watching for this person, disable the notification
+        if (typeof vswIndex !== "undefined") {
+            this.watchers.splice(vswIndex, 1);
+
+            return false;
+        } else {
+            this.watchers.push([watchedId, notifiedId]);
+
+            return true;
+        }
+    }
+
+    /**
+     * Calls VCNotifyManagerClass.toggle() and returns a string depending on the outcome
+     *
+     * @param watchedId userId of the person to watch out for
+     * @param notifiedId userId of the user that should be notified
+     * @return string
+     */
+    toggleMessage(watchedId: string, notifiedId: string) {
+        const toggle = VCNotifyManager.toggle(watchedId, notifiedId);
+
+        if (toggle) {
+            return `🔔 **You will recieve a ping when <@${watchedId}> joins a voice channel.**`;
+        } else {
+            return `🔕 **You will no longer be notified when <@${watchedId}> joins a voice channel.**`;
+        }
+    }
+}
+
+export const VCNotifyManager = new VCNotifyManagerClass();

src/Modules/VCNotifyManager.ts

@@ -7,6 +7,7 @@ interface WebhookIds {
     customRoles: string;
     commandUse: string;
     guildMemberRemove: string;
+    voiceStateNotification: string;
     [key: string]: string;
 }
 
@@ -19,6 +20,7 @@ class WebhooksClass {
             commandUse: Config.webhooks.commandUse,
             customRoles: Config.webhooks.customRoles,
             guildMemberRemove: Config.webhooks.guildMemberRemove,
+            voiceStateNotification: Config.webhooks.voiceStateNotification,
         };
     }