fix: annotations for events

mariusbegby · Aug 27, 2023 · b118ebd · b118ebd
1 parent 39e8182
commit b118ebd
Show file tree

Hide file tree

Showing 26 changed files with 223 additions and 165 deletions.
diff --git a/src/commands/info/help.ts b/src/commands/info/help.ts
@@ -1,7 +1,7 @@
 import config from 'config';
 import { EmbedOptions } from '../../types/configTypes';
 const embedOptions: EmbedOptions = config.get('embedOptions');
-const botOptions = config.get('botOptions');
+const botOptions: BotOptions = config.get('botOptions');
 import { SlashCommandBuilder, EmbedBuilder } from 'discord.js';
 import loggerModule from '../../services/logger';
 

diff --git a/src/commands/player/filters.ts b/src/commands/player/filters.ts
@@ -1,7 +1,7 @@
 import config from 'config';
 import { EmbedOptions } from '../../types/configTypes';
 const embedOptions: EmbedOptions = config.get('embedOptions');
-const ffmpegFilterOptions = config.get('ffmpegFilterOptions');
+const ffmpegFilterOptions: FFmpegFilterOptions = config.get('ffmpegFilterOptions');
 import { notInVoiceChannel, notInSameVoiceChannel } from '../../utils/validation/voiceChannelValidator';
 import { queueDoesNotExist, queueNoCurrentTrack } from '../../utils/validation/queueValidator';
 import {

diff --git a/src/commands/player/loop.ts b/src/commands/player/loop.ts
@@ -1,7 +1,7 @@
 import config from 'config';
 import { EmbedOptions } from '../../types/configTypes';
 const embedOptions: EmbedOptions = config.get('embedOptions');
-const botOptions = config.get('botOptions');
+const botOptions: BotOptions = config.get('botOptions');
 import { notInVoiceChannel, notInSameVoiceChannel } from '../../utils/validation/voiceChannelValidator';
 import { queueDoesNotExist } from '../../utils/validation/queueValidator';
 import{ SlashCommandBuilder, EmbedBuilder } from 'discord.js';

diff --git a/src/commands/player/nowplaying.ts b/src/commands/player/nowplaying.ts
@@ -1,7 +1,7 @@
 import config from 'config';
 import { EmbedOptions } from '../../types/configTypes';
 const embedOptions: EmbedOptions = config.get('embedOptions');
-const playerOptions = config.get('playerOptions');
+const playerOptions: PlayerOptions = config.get('playerOptions');
 import { notInVoiceChannel, notInSameVoiceChannel } from '../../utils/validation/voiceChannelValidator';
 import { queueDoesNotExist, queueNoCurrentTrack } from '../../utils/validation/queueValidator';
 import { SlashCommandBuilder, EmbedBuilder, ActionRowBuilder, ButtonBuilder } from 'discord.js';

diff --git a/src/commands/player/play.ts b/src/commands/player/play.ts
@@ -1,7 +1,7 @@
 import config from 'config';
 const embedOptions: EmbedOptions = config.get('embedOptions');
-const botOptions = config.get('botOptions');
-const playerOptions = config.get('playerOptions');
+const botOptions: BotOptions = config.get('botOptions');
+const playerOptions: PlayerOptions = config.get('playerOptions');
 import { notInVoiceChannel, notInSameVoiceChannel } from '../../utils/validation/voiceChannelValidator';
 import { cannotJoinVoiceOrTalk } from '../../utils/validation/permissionValidator';
 import { transformQuery } from '../../utils/validation/searchQueryValidator';

diff --git a/src/commands/player/queue.ts b/src/commands/player/queue.ts
@@ -1,7 +1,7 @@
 import config from 'config';
 import { EmbedOptions } from '../../types/configTypes';
 const embedOptions: EmbedOptions = config.get('embedOptions');
-const playerOptions = config.get('playerOptions');
+const playerOptions: PlayerOptions = config.get('playerOptions');
 import { notInVoiceChannel, notInSameVoiceChannel } from '../../utils/validation/voiceChannelValidator';
 import{ SlashCommandBuilder, EmbedBuilder } from 'discord.js';
 import { useQueue } from 'discord-player';

diff --git a/src/events/client/debug.ts b/src/events/client/debug.ts
@@ -6,7 +6,7 @@ module.exports = {
     name: Events.Debug,
     isDebug: true,
     once: false,
-    execute: async (message) => {
+    execute: async (message: string) => {
         const executionId = uuidv4();
         const logger = loggerModule.child({
             source: 'debug.js',

diff --git a/src/events/client/disconnect.ts b/src/events/client/disconnect.ts
@@ -1,36 +1,39 @@
 import { v4 as uuidv4 } from 'uuid';
 import config from 'config';
-import { EmbedOptions } from '../../types/configTypes';
+import { EmbedOptions, SystemOptions } from '../../types/configTypes';
 const embedOptions: EmbedOptions = config.get('embedOptions');
-const systemOptions = config.get('systemOptions');
-import { EmbedBuilder } from 'discord.js';
+const systemOptions: SystemOptions = config.get('systemOptions');
+import { BaseGuildTextChannel, EmbedBuilder } from 'discord.js';
 import loggerModule from '../../services/logger';
+import { ExtendedClient } from '../../types/clientTypes';
 
 module.exports = {
     name: 'disconnect',
     isDebug: false,
     once: false,
-    execute: async (client) => {
+    execute: async (client: ExtendedClient) => {
         const executionId = uuidv4();
         const logger = loggerModule.child({
             source: 'disconnect.js',
             module: 'event',
             name: 'clientDisconnect',
             executionId: executionId,
-            shardId: client.shard.ids[0]
+            shardId: client.shard?.ids[0]
         });
 
-        logger.warn(`${client.user.tag} lost connection to Discord APIs. Disconnected.`);
+        logger.warn(`${client.user?.tag} lost connection to Discord APIs. Disconnected.`);
 
         // send message to system message channel for event
         if (systemOptions.systemMessageChannelId && systemOptions.systemUserId) {
-            const channel = await client.channels.cache.get(systemOptions.systemMessageChannelId);
+            const channel = (await client.channels.cache.get(
+                systemOptions.systemMessageChannelId
+            )) as BaseGuildTextChannel;
             if (channel) {
                 await channel.send({
                     embeds: [
                         new EmbedBuilder()
                             .setDescription(
-                                `${embedOptions.icons.warning} **${client.user.tag}** is **\`disconnected\`**!` +
+                                `${embedOptions.icons.warning} **${client.user?.tag}** is **\`disconnected\`**!` +
                                     `\n\n<@${systemOptions.systemUserId}>`
                             )
                             .setColor(embedOptions.colors.warning)

diff --git a/src/events/client/error.ts b/src/events/client/error.ts
@@ -6,7 +6,7 @@ module.exports = {
     name: Events.Error,
     isDebug: false,
     once: false,
-    execute: async (error) => {
+    execute: async (error: Error) => {
         const executionId = uuidv4();
         const logger = loggerModule.child({
             source: 'error.js',

diff --git a/src/events/client/guildCreate.ts b/src/events/client/guildCreate.ts
@@ -1,12 +1,12 @@
-import { Events } from 'discord.js';
+import { Events, Guild } from 'discord.js';
 import { v4 as uuidv4 } from 'uuid';
 import loggerModule from '../../services/logger';
 
 module.exports = {
     name: Events.GuildCreate,
     isDebug: false,
     once: false,
-    execute: async (guild) => {
+    execute: async (guild: Guild) => {
         const executionId = uuidv4();
         const logger = loggerModule.child({
             source: 'guildCreate.js',

diff --git a/src/events/client/guildDelete.ts b/src/events/client/guildDelete.ts
@@ -1,12 +1,12 @@
-import { Events } from 'discord.js';
+import { Events, Guild } from 'discord.js';
 import { v4 as uuidv4 } from 'uuid';
 import loggerModule from '../../services/logger';
 
 module.exports = {
     name: Events.GuildDelete,
     isDebug: false,
     once: false,
-    execute: async (guild) => {
+    execute: async (guild: Guild) => {
         const executionId = uuidv4();
         const logger = loggerModule.child({
             source: 'guildDelete.js',

diff --git a/src/events/client/ready.ts b/src/events/client/ready.ts
@@ -1,42 +1,43 @@
 import config from 'config';
-import { EmbedOptions } from '../../types/configTypes';
+import { EmbedOptions, LoadTestOptions, SystemOptions } from '../../types/configTypes';
 const embedOptions: EmbedOptions = config.get('embedOptions');
-const systemOptions = config.get('systemOptions');
-const presenceStatusOptions = config.get('presenceStatusOptions');
-const loadTestOptions = config.get('loadTestOptions');
+const systemOptions: SystemOptions = config.get('systemOptions');
+const presenceStatusOptions: PresenceData = config.get('presenceStatusOptions');
+const loadTestOptions: LoadTestOptions = config.get('loadTestOptions');
 import { postBotStats } from '../../utils/other/postBotStats';
 import { startLoadTest } from '../../utils/other/startLoadTest';
-import { Events, EmbedBuilder } from 'discord.js';
+import { Events, EmbedBuilder, PresenceData, BaseGuildTextChannel } from 'discord.js';
 import { v4 as uuidv4 } from 'uuid';
 import loggerModule from '../../services/logger';
+import { ExtendedClient } from '../../types/clientTypes';
 
 module.exports = {
     name: Events.ClientReady,
     isDebug: false,
     once: false,
-    execute: async (client) => {
+    execute: async (client: ExtendedClient) => {
         const executionId = uuidv4();
         const logger = loggerModule.child({
             source: 'ready.js',
             module: 'event',
             name: 'clientReady',
             executionId: executionId,
-            shardId: client.shard.ids[0]
+            shardId: client.shard?.ids[0]
         });
 
-        logger.debug('Client \'ready\' event received after \'allShardsReady\' event.');
-        await client.user.setPresence(presenceStatusOptions);
+        logger.debug("Client 'ready' event received after 'allShardsReady' event.");
+        await client.user?.setPresence(presenceStatusOptions);
 
         if (loadTestOptions.enabled) {
             // Only call function from shard with id 0
             // The function uses broadcastEval() to call itself on all shards
-            if (client.shard.ids[0] === 0) {
+            if (client.shard?.ids[0] === 0) {
                 logger.info('Initiating load test for bot client.');
                 await startLoadTest({ client, executionId });
             }
         }
 
-        const channel = await client.channels.cache.get(systemOptions.systemMessageChannelId);
+        const channel = (await client.channels.cache.get(systemOptions.systemMessageChannelId)) as BaseGuildTextChannel;
 
         // Check if the channel exists in curent shard and send a message
         if (channel) {
@@ -45,7 +46,7 @@ module.exports = {
                 embeds: [
                     new EmbedBuilder()
                         .setDescription(
-                            `**${embedOptions.icons.success} All shards ready**\n**${client.user.tag}** is now **\`online\`**!`
+                            `**${embedOptions.icons.success} All shards ready**\n**${client.user?.tag}** is now **\`online\`**!`
                         )
                         .setColor(embedOptions.colors.success)
                 ]

diff --git a/src/events/client/reconnecting.ts b/src/events/client/reconnecting.ts
@@ -1,37 +1,40 @@
 import { v4 as uuidv4 } from 'uuid';
 import config from 'config';
-import { EmbedOptions } from '../../types/configTypes';
+import { EmbedOptions, SystemOptions } from '../../types/configTypes';
 const embedOptions: EmbedOptions = config.get('embedOptions');
-const systemOptions = config.get('systemOptions');
-import { EmbedBuilder } from 'discord.js';
+const systemOptions: SystemOptions = config.get('systemOptions');
+import { BaseGuildTextChannel, EmbedBuilder } from 'discord.js';
 import loggerModule from '../../services/logger';
+import { ExtendedClient } from '../../types/clientTypes';
 
 module.exports = {
     name: 'reconnecting',
     isDebug: false,
     once: false,
-    execute: async (client) => {
+    execute: async (client: ExtendedClient) => {
         const executionId = uuidv4();
         const logger = loggerModule.child({
             source: 'reconnecting.js',
             module: 'event',
             name: 'clientReconnecting',
             executionId: executionId,
-            shardId: client.shard.ids[0]
+            shardId: client.shard?.ids[0]
         });
 
         logger.warn('Client is reconnecting to Discord APIs.');
 
         // send message to system message channel for event
         if (systemOptions.systemMessageChannelId && systemOptions.systemUserId) {
             if (systemOptions.systemMessageChannelId && systemOptions.systemUserId) {
-                const channel = await client.channels.cache.get(systemOptions.systemMessageChannelId);
+                const channel = (await client.channels.cache.get(
+                    systemOptions.systemMessageChannelId
+                )) as BaseGuildTextChannel;
                 if (channel) {
                     await channel.send({
                         embeds: [
                             new EmbedBuilder()
                                 .setDescription(
-                                    `${embedOptions.icons.warning} **${client.user.tag}** is **\`reconnecting\`**!` +
+                                    `${embedOptions.icons.warning} **${client.user?.tag}** is **\`reconnecting\`**!` +
                                         `\n\n<@${systemOptions.systemUserId}>`
                                 )
                                 .setColor(embedOptions.colors.warning)

diff --git a/src/events/client/warn.ts b/src/events/client/warn.ts
@@ -6,7 +6,7 @@ module.exports = {
     name: Events.Warn,
     isDebug: false,
     once: false,
-    execute: async (warning) => {
+    execute: async (warning: string) => {
         const executionId = uuidv4();
         const logger = loggerModule.child({
             source: 'warn.js',