change: partial giveaway refactor

GetUsernameFromDatabase · GetUsernameFromDatabase · commit fdf227f042e0 · 2024-01-11T03:23:21.000+02:00
change: update deprecated Command.Context usage
diff --git a/src/commands/giveaways/fetch-giveaways.ts b/src/commands/giveaways/fetch-giveaways.ts
@@ -1,15 +1,11 @@
 import { getTextBasedChannel } from '#lib/discord-fetch';
-import { getEmbedBuilder, stringsToEmbedField } from '#lib/discord-messaging';
-import {
-  GetGiveaways,
-  GiveawayStatuses,
-  isGiveawayStatus,
-} from '@/services/giveaway/index.js';
+import { FetchAndSendGiveaways } from '@/services/giveaway';
+import { GiveawayStatusEnum } from '@/services/giveaway/giveaway-status';
 import { Command } from '@sapphire/framework';
 import { PermissionsBitField } from 'discord.js';
 
 export class FetchGiveawaysCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Send giveaways to this channel',
@@ -44,34 +40,11 @@ export class FetchGiveawaysCommand extends Command {
     }
 
     await interaction.editReply('Will search for new giveaways');
-    const giveaways = await GetGiveaways();
-    if (isGiveawayStatus(giveaways)) {
-      const status = GiveawayStatuses[giveaways];
-      return interaction.editReply(status.log_message);
-    }
+    const giveawayStatus = await FetchAndSendGiveaways(channel);
 
-    for (const giveaway of giveaways) {
-      const embedFields = stringsToEmbedField(giveaway.body);
-      const builder = getEmbedBuilder()
-        .setTitle(giveaway.title)
-        .addFields(embedFields);
-      if (giveaway.imageURL) {
-        builder.setImage(giveaway.imageURL);
-      }
-      const builtEmbed = builder.toJSON();
-      await channel.send({ embeds: [builtEmbed] });
-      return;
+    if (giveawayStatus.status === GiveawayStatusEnum.SUCCESS) {
+      return interaction.followUp('Giveaway fetch finished!');
     }
-    return;
-    // const result = await GetGiveaways(channel, {
-    //   noFilter: true,
-    //   ignorePreviousMessage: force,
-    // });
-
-    // if (result === 'SUCCESS') {
-    //   void interaction.followUp('Giveaway fetch finished!');
-    // } else {
-    //   void interaction.editReply(GiveawayFetchMessages[result]);
-    // }
+    return interaction.editReply(giveawayStatus.statusInformation.log_message);
   }
 }
diff --git a/src/commands/giveaways/subscribe-to-giveaways.ts b/src/commands/giveaways/subscribe-to-giveaways.ts
@@ -5,7 +5,7 @@ import cronstrue from 'cronstrue';
 import { GiveawayNotifier } from '../../jobs/giveaways';
 
 export class SubscribeToGiveawaysCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: `Start sending giveaways here ${cronstrue.toString(
diff --git a/src/commands/giveaways/unsubscribe-from-giveaways.ts b/src/commands/giveaways/unsubscribe-from-giveaways.ts
@@ -3,7 +3,7 @@ import { Command } from '@sapphire/framework';
 import { PermissionsBitField } from 'discord.js';
 
 export class UnsubscribeToGiveawaysCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Stop sending giveaways here.',
diff --git a/src/commands/music/biquad.ts b/src/commands/music/biquad.ts
@@ -8,7 +8,7 @@ type SupportedBiquadFilters = keyof typeof BiquadFilterType | 'Off';
 
 // TODO: add run `runIn: 'GUILD_TEXT'` to all music commands
 export class BiquadCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'The biquad filter that can be applied to tracks',
diff --git a/src/commands/music/clear.ts b/src/commands/music/clear.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue } from 'discord-player';
 
 export class ClearCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Clears the current queue and removes all enqueued tracks',
diff --git a/src/commands/music/connect.ts b/src/commands/music/connect.ts
@@ -5,7 +5,7 @@ import { useMainPlayer, useQueue } from 'discord-player';
 import { GuildMember } from 'discord.js';
 
 export class DisconnectCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description:
diff --git a/src/commands/music/disconnect.ts b/src/commands/music/disconnect.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue } from 'discord-player';
 
 export class DisconnectCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description:
diff --git a/src/commands/music/dsp.ts b/src/commands/music/dsp.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { PCMAudioFilters, PCMFilters, useQueue } from 'discord-player';
 
 export class PulsatorCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'The DSP filters that can be applied to tracks',
diff --git a/src/commands/music/equaliser.ts b/src/commands/music/equaliser.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { EqualizerConfigurationPreset, useQueue } from 'discord-player';
 
 export class EqualizerCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'The equaliser filter that can be applied to tracks',
diff --git a/src/commands/music/filters.ts b/src/commands/music/filters.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { FiltersName, useQueue } from 'discord-player';
 
 export class FiltersCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'The FFmpeg filters that can be applied to tracks',
diff --git a/src/commands/music/history.ts b/src/commands/music/history.ts
@@ -5,7 +5,7 @@ import { Command } from '@sapphire/framework';
 import { useHistory, useQueue } from 'discord-player';
 
 export class HistoryCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Displays the queue history in an embed',
diff --git a/src/commands/music/jump.ts b/src/commands/music/jump.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue } from 'discord-player';
 
 export class JumpCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description:
diff --git a/src/commands/music/loop.ts b/src/commands/music/loop.ts
@@ -11,7 +11,7 @@ const repeatModes = [
 ];
 
 export class LoopCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Loops the current playing track or the entire queue',
diff --git a/src/commands/music/lyrics.ts b/src/commands/music/lyrics.ts
@@ -8,7 +8,7 @@ import { EmbedBuilder } from 'discord.js';
 const genius = lyricsExtractor();
 
 export class LyricsCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Displays lyrics of the given track',
diff --git a/src/commands/music/move.ts b/src/commands/music/move.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue } from 'discord-player';
 
 export class moveCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: "Moves the given track's position to the position requested",
diff --git a/src/commands/music/nowplaying.ts b/src/commands/music/nowplaying.ts
@@ -3,7 +3,7 @@ import { useQueue, useTimeline } from 'discord-player';
 import { EmbedBuilder } from 'discord.js';
 
 export class NowPlayingCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Displays the current track in an embed',
diff --git a/src/commands/music/pause.ts b/src/commands/music/pause.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue, useTimeline } from 'discord-player';
 
 export class PauseCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Pauses or resumes the current track',
diff --git a/src/commands/music/ping.ts b/src/commands/music/ping.ts
@@ -5,7 +5,7 @@ import { Command } from '@sapphire/framework';
 import { ApplicationCommandType } from 'discord.js';
 
 export class PingCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Returns the round trip and heartbeat',
diff --git a/src/commands/music/play.ts b/src/commands/music/play.ts
@@ -5,7 +5,7 @@ import { useMainPlayer } from 'discord-player';
 import type { GuildMember } from 'discord.js';
 
 export class PlayCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Plays and enqueues track(s) of the query provided',
diff --git a/src/commands/music/previous.ts b/src/commands/music/previous.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useHistory, useQueue } from 'discord-player';
 
 export class PreviousCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Plays the previous track',
diff --git a/src/commands/music/queue.ts b/src/commands/music/queue.ts
@@ -5,7 +5,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue } from 'discord-player';
 
 export class QueueCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Displays the queue in an embed',
diff --git a/src/commands/music/remove.ts b/src/commands/music/remove.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue } from 'discord-player';
 
 export class RemoveCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Removes the given track',
diff --git a/src/commands/music/shuffle.ts b/src/commands/music/shuffle.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue } from 'discord-player';
 
 export class ShuffleCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Shuffles the tracks in the queue',
diff --git a/src/commands/music/skip.ts b/src/commands/music/skip.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue } from 'discord-player';
 
 export class SkipCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Skips the current track and automatically plays the next',
diff --git a/src/commands/music/skipto.ts b/src/commands/music/skipto.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue } from 'discord-player';
 
 export class SkipToCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Skips to the given track whilst removing previous tracks',
diff --git a/src/commands/music/volume.ts b/src/commands/music/volume.ts
@@ -4,7 +4,7 @@ import { Command } from '@sapphire/framework';
 import { useQueue, useTimeline } from 'discord-player';
 
 export class VolumeCommand extends Command {
-  public constructor(context: Command.Context, options: Command.Options) {
+  public constructor(context: Command.LoaderContext, options: Command.Options) {
     super(context, {
       ...options,
       description: 'Changes the volume of the track and entire queue',
diff --git a/src/index.ts b/src/index.ts
@@ -5,7 +5,7 @@ async function main() {
 
   try {
     client.logger.info('Logging in...');
-    return client.login();
+    await client.login();
   } catch (error) {
     client.logger.fatal(error);
     await client.destroy();
diff --git a/src/services/giveaway/giveaway-status.ts b/src/services/giveaway/giveaway-status.ts
@@ -0,0 +1,68 @@
+import { LogLevel } from '@sapphire/framework';
+
+export type TGiveawayStatus = {
+  log_message: string;
+  log_level: LogLevel;
+};
+export type TGiveawayStatuses = Record<GiveawayStatusEnum, TGiveawayStatus>;
+export enum GiveawayStatusEnum {
+  SUCCESS = 'SUCCESS',
+  NONE_FOUND = 'NONE_FOUND',
+  NO_NEW = 'NO_NEW',
+  FAILED_TO_SEND = 'FAILED_TO_SEND',
+}
+
+export class GiveawayStatus {
+  static enum = GiveawayStatusEnum;
+  static statusInformation: Readonly<TGiveawayStatuses> = {
+    SUCCESS: {
+      log_message: 'Giveaways successfully sent',
+      log_level: LogLevel.Info,
+    },
+    NONE_FOUND: {
+      log_message: 'No giveaways were found',
+      log_level: LogLevel.Error,
+    },
+    NO_NEW: {
+      log_message: 'No new giveaways',
+      log_level: LogLevel.Info,
+    },
+    FAILED_TO_SEND: {
+      log_message: 'Failed to send giveaways',
+      log_level: LogLevel.Error,
+    },
+  };
+
+  static isGiveawayStatusEnum(value: unknown): value is GiveawayStatusEnum {
+    return typeof value === 'string' && value in GiveawayStatusEnum;
+  }
+
+  static logGiveawayFetchResult(giveawayStatus: GiveawayStatusEnum) {
+    const { log_level, log_message } = this.statusInformation[giveawayStatus];
+
+    if (log_level >= LogLevel.Error) {
+      globalThis.logger.error(new Error(log_message));
+    } else if (log_level >= LogLevel.Info) {
+      globalThis.logger.info(log_message);
+    }
+    return giveawayStatus;
+  }
+
+  // --- static part ends
+  status: GiveawayStatusEnum;
+  constructor(status: GiveawayStatusEnum, logOnCreate: boolean = false) {
+    this.status = status;
+
+    if (logOnCreate) {
+      this.logGiveawayStatusResult();
+    }
+  }
+
+  logGiveawayStatusResult() {
+    return GiveawayStatus.logGiveawayFetchResult(this.status);
+  }
+
+  get statusInformation() {
+    return GiveawayStatus.statusInformation[this.status];
+  }
+}
diff --git a/src/services/giveaway/giveaway.ts b/src/services/giveaway/giveaway.ts
diff --git a/src/services/giveaway/index.ts b/src/services/giveaway/index.ts
diff --git a/src/services/giveaway/site-fetchers/base.ts b/src/services/giveaway/site-fetchers/base.ts
diff --git a/src/services/giveaway/site-fetchers/grab-free-games-steam.ts b/src/services/giveaway/site-fetchers/grab-free-games-steam.ts
diff --git a/src/services/giveaway/site-fetchers/grab-free-games.ts b/src/services/giveaway/site-fetchers/grab-free-games.ts
diff --git a/templates/command.ts.sapphire b/templates/command.ts.sapphire
