refactor: simpler command categorization

commands/custom_vc/slash.js

@@ -4,7 +4,7 @@ import {
 	SlashCommandBuilder,
 	ChatInputCommandInteraction
 } from 'discord.js';
-import { Guild, VoiceChannel } from '../../../database.js';
+import { Guilds, VoiceChannels } from '../../../database.js';
 
 export const data = new SlashCommandBuilder()
 	.setName('custom_vc')
@@ -68,12 +68,12 @@ export async function execute(interaction) {
 
 				step = 'save';
 				// Create guild if not exists
-				await Guild.findOrCreate({
+				await Guilds.findOrCreate({
 					where: guildData,
 					defaults: guildData
 				});
 				// Save channel data
-				await VoiceChannel.create({
+				await VoiceChannels.create({
 					id: channel.id,
 					guild: guild.id,
 					create: true
@@ -94,12 +94,12 @@ export async function execute(interaction) {
 
 				step = 'save';
 				// Create guild if not exists
-				await Guild.findOrCreate({
+				await Guilds.findOrCreate({
 					where: guildData,
 					defaults: guildData
 				});
 				// Save channel data
-				await VoiceChannel.create({
+				await VoiceChannels.create({
 					id,
 					guild: guild.id,
 					create: true
@@ -120,7 +120,7 @@ export async function execute(interaction) {
 
 				// Remove channel from guild
 				step = 'remove';
-				const count = await VoiceChannel.destroy({
+				const count = await VoiceChannels.destroy({
 					where: {
 						id,
 						create: true

commands/member_roles/slash.js

@@ -1,20 +1,20 @@
 import { SlashCommandBuilder, PermissionFlagsBits, ChatInputCommandInteraction } from 'discord.js';
-import { Role, Guild } from '../../../database.js';
+import { Roles, Guilds } from '../../../database.js';
 
 /**
- * @param {Guild} guild
+ * @param {Guilds} guild
- * @param {Role} role
+ * @param {Roles} role
  */
 const registerRole = async (guild, role) => {
 	// Check if guild exists in database, otherwise create it
 	const guildData = { id: guild.id };
-	await Guild.findOrCreate({
+	await Guilds.findOrCreate({
 		where: guildData,
 		defaults: guildData
 	});
 
 	// Register role in database
-	await Role.create({
+	await Roles.create({
 		guild: guild.id,
 		id: role.id,
 		assign: true
@@ -57,18 +57,20 @@ export async function execute(interaction) {
 	switch (options.getSubcommand()) {
 		case 'add': {
 			// Search for role in database
-			const found = await Role.findOne({
+			/** @type {import('../../../models/roles.js').Role|null} */
+			const found = await Roles.findOne({
 				where: {
 					id: role.id
 				}
 			});
 
 			// Toggle role assignment if found
-			if (found) {
+			if (found !== null) {
 				found.assign = true;
 				await found.save();
 				// Otherwise create new database entry
 			} else await registerRole(interaction.guild, role);
+
 			// Reply successfully to acknowledge command
 			await interaction.reply({
 				content: 'Successfully registered role.',
@@ -80,7 +82,7 @@ export async function execute(interaction) {
 		}
 		case 'remove': {
 			// Remove role from database
-			const count = await Role.destroy({
+			const count = await Roles.destroy({
 				where: {
 					id: role.id,
 					assign: true

commands/self_roles/context/register.js

@@ -4,7 +4,7 @@ import {
 	PermissionFlagsBits,
 	ContextMenuCommandInteraction
 } from 'discord.js';
-import { Message } from '../../../../database.js';
+import { Messages } from '../../../../database.js';
 
 export const data = new ContextMenuCommandBuilder()
 	.setDMPermission(false)
@@ -17,7 +17,7 @@ export async function execute(interaction) {
 
 	try {
 		// Create database entry
-		await Message.create({ id });
+		await Messages.create({ id });
 
 		// Reply successfully to acknowledge command
 		await interaction.reply({

commands/self_roles/slash.js

@@ -1,6 +1,6 @@
 import { PermissionFlagsBits, SlashCommandBuilder, ChatInputCommandInteraction } from 'discord.js';
 import { addSelfRoles, removeSelfRoles } from '../../../shared.js';
-import { Guild, Message } from '../../../database.js';
+import { Guilds, Messages } from '../../../database.js';
 
 /**
  * Sends a `Message` in the current channel and registers for self roles.
@@ -48,11 +48,12 @@ const registerSelfRoles = async (interaction) => {
 		await channel.messages.fetch(id);
 
 		// Check if message is already registered
-		const found = await Message.findOne({
+		/** @type {import('../../../models/messages.js').Message|null} */
+		const found = await Messages.findOne({
 			where: { id }
 		});
 
-		if (found) throw new Error('Message already registered!');
+		if (found !== null) throw new Error('Messages already registered!');
 
 		// Reply successfully to acknowledge command
 		await interaction.reply({
@@ -196,13 +197,13 @@ export async function execute(interaction) {
 		try {
 			// Create guild if not exists
 			const guildData = { id: interaction.guild.id };
-			await Guild.findOrCreate({
+			await Guilds.findOrCreate({
 				where: guildData,
 				defaults: guildData
 			});
 
 			// Create database entry
-			await Message.create({
+			await Messages.create({
 				id,
 				guild: interaction.guild.id
 			});

database.js

@@ -18,26 +18,26 @@ const sequelize = new Sequelize({
 	logging: false
 });
 
-const Response = defineResponse(sequelize);
+const Responses = defineResponse(sequelize);
 
-const Keyword = defineKeyword(sequelize);
+const Keywords = defineKeyword(sequelize);
-Keyword.hasMany(Response, { foreignKey: 'keyword', onDelete: 'CASCADE' });
+Keywords.hasMany(Responses, { foreignKey: 'keyword', onDelete: 'CASCADE' });
 
-const RoleEmojiPair = defineRoleEmojiPair(sequelize);
+const RoleEmojiPairs = defineRoleEmojiPair(sequelize);
 
-const VoiceChannel = defineVoiceChannel(sequelize);
+const VoiceChannels = defineVoiceChannel(sequelize);
 
-const Message = defineMessage(sequelize);
+const Messages = defineMessage(sequelize);
-Message.hasMany(RoleEmojiPair, { foreignKey: 'message', onDelete: 'CASCADE' });
+Messages.hasMany(RoleEmojiPairs, { foreignKey: 'message', onDelete: 'CASCADE' });
 
-const Role = defineRole(sequelize);
+const Roles = defineRole(sequelize);
-Role.hasMany(RoleEmojiPair, { foreignKey: 'role', onDelete: 'CASCADE' });
+Roles.hasMany(RoleEmojiPairs, { foreignKey: 'role', onDelete: 'CASCADE' });
 
-const Guild = defineGuild(sequelize);
+const Guilds = defineGuild(sequelize);
-Guild.hasMany(Keyword, { foreignKey: 'guild', onDelete: 'CASCADE' });
+Guilds.hasMany(Keywords, { foreignKey: 'guild', onDelete: 'CASCADE' });
-Guild.hasMany(VoiceChannel, { foreignKey: 'guild', onDelete: 'CASCADE' });
+Guilds.hasMany(VoiceChannels, { foreignKey: 'guild', onDelete: 'CASCADE' });
-Guild.hasMany(Message, { foreignKey: 'guild', onDelete: 'CASCADE' });
+Guilds.hasMany(Messages, { foreignKey: 'guild', onDelete: 'CASCADE' });
-Guild.hasMany(Role, { foreignKey: 'guild', onDelete: 'CASCADE' });
+Guilds.hasMany(Roles, { foreignKey: 'guild', onDelete: 'CASCADE' });
 
 sequelize.sync();
-export { sequelize, Guild, Role, RoleEmojiPair, VoiceChannel, Message };
+export { sequelize, Guilds, Roles, Messages, VoiceChannels, RoleEmojiPairs, Keywords, Responses };

events/channels/channelDelete.js

@@ -1,5 +1,5 @@
 import { ChannelType, Events, GuildChannel } from 'discord.js';
-import { VoiceChannel } from '../../database.js';
+import { VoiceChannels } from '../../database.js';
 
 export const name = Events.ChannelDelete;
 /** @param {GuildChannel} channel */
@@ -7,7 +7,7 @@ export async function execute(channel) {
 	if (channel.type !== ChannelType.GuildVoice) return;
 
 	// Delete channel entry once channel is deleted itself
-	const count = await VoiceChannel.destroy({
+	const count = await VoiceChannels.destroy({
 		where: {
 			id: channel.id
 		}

events/channels/voiceStateUpdate.js

@@ -7,7 +7,7 @@ import {
 	VoiceState,
 	PermissionsBitField
 } from 'discord.js';
-import { VoiceChannel } from '../../database.js';
+import { VoiceChannels } from '../../database.js';
 
 /**
  * Function that either creates a new custom channel or gets an existing one registered in the database.
@@ -18,7 +18,8 @@ import { VoiceChannel } from '../../database.js';
  */
 const getChannel = async (member, guildChs, channel) => {
 	// Check database for existing channel
-	const ownCh = await VoiceChannel.findOne({
+	/** @type {import('../../models/voiceChannels.js').VoiceChannel|null} */
+	const ownCh = await VoiceChannels.findOne({
 		where: {
 			owner: member.id
 		}
@@ -35,7 +36,7 @@ const getChannel = async (member, guildChs, channel) => {
 	});
 
 	// Save newly created channel
-	await VoiceChannel.create({
+	await VoiceChannels.create({
 		id: privCh.id,
 		owner: member.id
 	});
@@ -58,7 +59,8 @@ const leftVoiceChat = async (state) => {
 	if (members.length > 0) return;
 
 	// Find channel by id, return if not registered as custom
-	const custom = await VoiceChannel.findOne({
+	/** @type {import('../../models/voiceChannels.js').VoiceChannel|null} */
+	const custom = await VoiceChannels.findOne({
 		where: {
 			id: channel.id,
 			create: false
@@ -84,7 +86,8 @@ export async function execute(oldState, newState) {
 		if (!channel) return;
 
 		// Find channel by id, return if not registered for customs
-		const createCh = await VoiceChannel.findOne({
+		/** @type {import('../../models/voiceChannels.js').VoiceChannel|null} */
+		const createCh = await VoiceChannels.findOne({
 			where: {
 				id: channel.id,
 				create: true

events/members/guildMemberAdd.js

@@ -1,11 +1,12 @@
 import { Events, GuildMember } from 'discord.js';
-import { Role } from '../../database.js';
+import { Roles } from '../../database.js';
 
 export const name = Events.GuildMemberAdd;
 /** @param {GuildMember} member */
 export async function execute(member) {
 	// Find roles to be assigned in guild from database
-	const roles = await Role.findAll({
+	/** @type {import('../../models/roles.js').Role[]} */
+	const roles = await Roles.findAll({
 		where: {
 			guild: member.guild.id,
 			assign: true

events/messages/messageDelete.js

@@ -1,11 +1,11 @@
-import { Message } from '../../database.js';
+import { Messages } from '../../database.js';
 import { Events } from 'discord.js';
 
 export const name = Events.MessageDelete;
 /** @param {import('discord.js').Message} message */
 export async function execute(message) {
 	// Delete message entry once message is deleted itself
-	const count = await Message.destroy({
+	const count = await Messages.destroy({
 		where: {
 			id: message.id
 		}

events/messages/reactionAdd.js

@@ -1,5 +1,5 @@
 import { Events, MessageReaction, User } from 'discord.js';
-import { Message, RoleEmojiPair } from '../../database.js';
+import { Messages, RoleEmojiPairs } from '../../database.js';
 import { config } from 'dotenv';
 
 config();
@@ -14,7 +14,8 @@ export async function execute(reaction, user) {
 
 	// Get message
 	const msgID = reaction.message.id;
-	const message = await Message.findOne({
+	/** @type {import('../../models/messages.js').Message|null} */
+	const message = await Messages.findOne({
 		where: {
 			id: msgID
 		}
@@ -24,7 +25,8 @@ export async function execute(reaction, user) {
 
 	// Get emoji
 	const emoji = reaction.emoji.toString();
-	const rep = await RoleEmojiPair.findOne({
+	/** @type {import('../../models/roleEmojiPairs.js').RoleEmojiPair|null} */
+	const rep = await RoleEmojiPairs.findOne({
 		where: {
 			message: msgID,
 			emoji
@@ -34,7 +36,7 @@ export async function execute(reaction, user) {
 	if (rep === null) {
 		// Remove reaction and quit
 		try {
-			reaction.remove();
+			await reaction.remove();
 		} catch (error) {
 			// Missing permissions
 			console.error(error);

events/messages/reactionRemove.js

@@ -1,5 +1,5 @@
 import { Events, MessageReaction, User } from 'discord.js';
-import { Message, RoleEmojiPair } from '../../database.js';
+import { Messages, RoleEmojiPairs } from '../../database.js';
 import { config } from 'dotenv';
 
 config();
@@ -14,7 +14,8 @@ export async function execute(reaction, user) {
 
 	// Get message
 	const msgID = reaction.message.id;
-	const message = await Message.findOne({
+	/** @type {import('../../models/messages.js').Message|null} */
+	const message = await Messages.findOne({
 		where: {
 			id: msgID
 		}
@@ -24,7 +25,8 @@ export async function execute(reaction, user) {
 
 	// Get emoji
 	const emoji = reaction.emoji.toString();
-	const rep = await RoleEmojiPair.findOne({
+	/** @type {import('../../models/roleEmojiPairs.js').RoleEmojiPair|null} */
+	const rep = await RoleEmojiPairs.findOne({
 		where: {
 			message: msgID,
 			emoji

models/guilds.js

@@ -6,7 +6,7 @@ import { DataTypes, Sequelize } from 'sequelize';
  */
 
 /**
- * The definition of the `Guild` table in the database.
+ * The definition of the `Guilds` table in the database.
  * @param {Sequelize} sequelize
  */
 export default function (sequelize) {

models/messages.js

@@ -7,7 +7,7 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize';
  */
 
 /**
- * The definition of the `Message` table in the database.
+ * The definition of the `Messages` table in the database.
  * @param {Sequelize} sequelize
  */
 export default function (sequelize) {

models/roleEmojiPairs.js

@@ -9,7 +9,7 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize';
  */
 
 /**
- * The definition of the `RoleEmojiPair` table in the database.
+ * The definition of the `RoleEmojiPairs` table in the database.
  * @param {Sequelize} sequelize
  */
 export default function (sequelize) {

models/roles.js

@@ -8,7 +8,7 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize';
  */
 
 /**
- * The definition of the `Role` table in the database.
+ * The definition of the `Roles` table in the database.
  * @param {Sequelize} sequelize
  */
 export default function (sequelize) {

models/voiceChannels.js

@@ -9,7 +9,7 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize';
  */
 
 /**
- * The definition of the `VoiceChannel` table in the database.
+ * The definition of the `VoiceChannels` table in the database.
  * @param {Sequelize} sequelize
  */
 export default function (sequelize) {

package-lock.json

@@ -1,12 +1,12 @@
 {
 	"name": "discord-bot",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"lockfileVersion": 3,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "discord-bot",
-			"version": "0.2.0",
+			"version": "0.3.0",
 			"license": "ISC",
 			"dependencies": {
 				"discord.js": "^14.14.1",
@@ -1424,6 +1424,12 @@
 			"resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz",
 			"integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew=="
 		},
+		"node_modules/ip": {
+			"version": "2.0.1",
+			"resolved": "https://registry.npmjs.org/ip/-/ip-2.0.1.tgz",
+			"integrity": "sha512-lJUL9imLTNi1ZfXT+DU6rBBdbiKGBuay9B6xGSPVjUeQwaH1RIGqef8RZkUtHioLmSNpPR5M4HVKJGm1j8FWVQ==",
+			"optional": true
+		},
 		"node_modules/is-builtin-module": {
 			"version": "3.2.1",
 			"resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-3.2.1.tgz",
@@ -2476,12 +2482,6 @@
 				"npm": ">= 3.0.0"
 			}
 		},
-		"node_modules/socks/node_modules/ip": {
-			"version": "2.0.0",
-			"resolved": "https://registry.npmjs.org/ip/-/ip-2.0.0.tgz",
-			"integrity": "sha512-WKa+XuLG1A1R0UWhl2+1XQSi+fZWMsYKffMZTTYsiZaUD8k2yDAj5atimTUD2TZkyCkNEeYE5NhFZmupOGtjYQ==",
-			"optional": true
-		},
 		"node_modules/spdx-exceptions": {
 			"version": "2.4.0",
 			"resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.4.0.tgz",

shared.js

@@ -1,5 +1,5 @@
 import { ChatInputCommandInteraction, ContextMenuCommandInteraction, Role } from 'discord.js';
-import { Message, RoleEmojiPair, Guild } from './database.js';
+import { Messages, RoleEmojiPairs, Guilds } from './database.js';
 import { readdir } from 'fs/promises';
 import { config } from 'dotenv';
 import { Op } from 'sequelize';
@@ -15,7 +15,7 @@ config();
  */
 export const removeSelfRoles = async (interaction, id) => {
 	// Try deleting message from database
-	const count = await Message.destroy({
+	const count = await Messages.destroy({
 		where: {
 			id: id
 		}
@@ -35,18 +35,20 @@ export const removeSelfRoles = async (interaction, id) => {
 };
 
 /**
- * Function to handle saving all the corresponding data for `Message` and `RoleEmojiPair` tables.
+ * Function to handle saving all the corresponding data for `Messages` and `RoleEmojiPairs` tables.
  * @param {string} id A Discord message ID.
  * @param {Role} role
  * @param {string} emoji Either a unicode emoji or a string representation in Discord custom emoji format.
  */
 const saveMessageData = async (id, role, emoji) => {
 	// Try finding message
-	const msg = await Message.findOne({ where: { id } });
+	/** @type {import('./models/messages.js').Message|null} */
+	const msg = await Messages.findOne({ where: { id } });
 	if (msg === null) throw new Error(`No message with ID '${id}' could be found!`);
 
 	// Try finding existing entry
-	const rep = await RoleEmojiPair.findOne({
+	/** @type {import('./models/roleEmojiPairs.js').RoleEmojiPair|null} */
+	const rep = await RoleEmojiPairs.findOne({
 		where: {
 			[Op.or]: [
 				{
@@ -67,13 +69,13 @@ const saveMessageData = async (id, role, emoji) => {
 
 	// Create guild if not exists
 	const guildData = { id: role.guild.id };
-	await Guild.findOrCreate({
+	await Guilds.findOrCreate({
 		where: guildData,
 		defaults: guildData
 	});
 
 	// Create database entry for pair
-	await RoleEmojiPair.create({
+	await RoleEmojiPairs.create({
 		message: id,
 		role: role.id,
 		guild: guildData.id,
@@ -92,7 +94,8 @@ const editMessage = async (message, role, emoji) => {
 
 	// Find out whether to pad message or already present
 	let padding = '\n';
-	const reps = await RoleEmojiPair.findAll({ where: { message: message.id } });
+	/** @type {import('./models/roleEmojiPairs.js').RoleEmojiPair[]} */
+	const reps = await RoleEmojiPairs.findAll({ where: { message: message.id } });
 	if (reps.length === 0) padding += '\n';
 
 	// Get old and build new content of message