Merge pull request #72 from greencoast-studios/develop

Version 3.0.1

__mocks__/local/dataProvider.ts

@@ -1,6 +1,6 @@
-import { DataProvider } from '../../src';
+import { DataProvider, ClearableDataProvider } from '../../src';
 
-export class ConcreteDataProvider extends DataProvider {
+export class ConcreteDataProvider extends DataProvider implements ClearableDataProvider {
   public override init(): Promise<this> {
     return Promise.resolve(this);
   }
@@ -25,10 +25,10 @@ export class ConcreteDataProvider extends DataProvider {
   public override deleteGlobal(): Promise<any> {
     return Promise.resolve();
   }
-  public override clear(): Promise<void> {
+  public clear(): Promise<void> {
     return Promise.resolve();
   }
-  public override clearGlobal(): Promise<void> {
+  public clearGlobal(): Promise<void> {
     return Promise.resolve();
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@greencoast/discord.js-extended",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "An utility to facilitate the repetitive tasks when creating discord bots. Used by Greencoast Studios.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/classes/ExtendedClient.ts

@@ -207,7 +207,7 @@ export class ExtendedClient extends Client {
 
   /**
    * Test whether the specified user is the client's owner.
-   * @param user The [user](https://discord.js.org/#/docs/discord.js/stable/class/User) to test.
+   * @param user The [user](https://old.discordjs.dev/#/docs/discord.js/main/class/User) to test.
    * @returns Whether the tested user is the client's owner.
    * @throws Throws if the user cannot be resolved.
    */

src/classes/command/Command.ts

@@ -70,7 +70,7 @@ export abstract class Command<T extends CommandTrigger> {
   public readonly ownerOnly: boolean;
 
   /**
-   * The [permissions resolvable](https://discord.js.org/#/docs/main/stable/typedef/PermissionResolvable) that
+   * The [permissions resolvable](https://old.discordjs.dev/#/docs/discord.js/main/typedef/PermissionResolvablee) that
    * defines the permissions that a user requires to execute this command.
    * @type {(PermissionResolvable | null)}
    * @memberof Command
@@ -124,17 +124,17 @@ export abstract class Command<T extends CommandTrigger> {
 
   /**
    * Check whether the message author can execute this command.
-   * @param trigger The [message](https://discord.js.org/#/docs/discord.js/stable/class/Message) or
-   * [interaction](https://discord.js.org/#/docs/discord.js/stable/class/Interaction) that triggered this command.
+   * @param trigger The [message](https://old.discordjs.dev/#/docs/discord.js/main/class/Message) or
+   * [interaction](https://old.discordjs.dev/#/docs/discord.js/main/class/ChatInputCommandInteraction) that triggered this command.
    * @returns `true` if the user has enough permissions, or a string with the reason why they cannot execute this command.
    */
   public abstract hasPermission(trigger: T): boolean | string;
 
   /**
    * Handle command error.
    * @param error The error that was thrown inside the command's run method.
-   * @param trigger The [message](https://discord.js.org/#/docs/discord.js/stable/class/Message) or
-   * [interaction](https://discord.js.org/#/docs/discord.js/stable/class/Interaction) that triggered this command.
+   * @param trigger The [message](https://old.discordjs.dev/#/docs/discord.js/main/class/Message) or
+   * [interaction](https://old.discordjs.dev/#/docs/discord.js/main/class/ChatInputCommandInteraction) that triggered this command.
    * @returns A promise that resolves the message that was replied to the original message author (if available).
    * @emits `client#commandError`
    */

src/classes/command/CommandDispatcher.ts

@@ -33,7 +33,7 @@ export class CommandDispatcher {
 
   /**
    * Handles command fetching and execution for message based commands (RegularCommand).
-   * @param message The [message](https://discord.js.org/#/docs/discord.js/stable/class/Message) that triggered this handler.
+   * @param message The [message](https://old.discordjs.dev/#/docs/discord.js/main/class/Message) that triggered this handler.
    * @emits `client#commandExecute`
    */
   public async handleMessage(message: Message): Promise<void> {
@@ -72,7 +72,7 @@ export class CommandDispatcher {
 
   /**
    * Handles command fetching and execution for slash commands.
-   * @param interaction The [interaction](https://discord.js.org/#/docs/discord.js/stable/class/Interaction) that triggered this handler.
+   * @param interaction The [interaction](https://old.discordjs.dev/#/docs/discord.js/main/class/ChatInputCommandInteraction) that triggered this handler.
    * @emits `client#commandExecute`
    */
   public async handleInteraction(interaction: Interaction): Promise<void> {

src/classes/command/CommandGroup.ts

@@ -21,7 +21,7 @@ export class CommandGroup {
   public readonly name: string;
 
   /**
-   * A [collection](https://discord.js.org/#/docs/collection/master/class/Collection) of the commands
+   * A [collection](https://discord.js.org/docs/packages/collection/main/Collection:Class) of the commands
    * registered to this group, mapped by the command's name and the command.
    * @type {Collection<string, Command>}
    * @memberof CommandGroup

src/classes/command/CommandRegistry.ts

@@ -19,15 +19,15 @@ export class CommandRegistry {
   public readonly client: ExtendedClient;
 
   /**
-   * A [collection](https://discord.js.org/#/docs/collection/master/class/Collection) of the commands registered
+   * A [collection](https://discord.js.org/docs/packages/collection/main/Collection:Class) of the commands registered
    * to this registry, mapped by the command's name and the command.
    * @type {Collection<string, Command>}
    * @memberof CommandRegistry
    */
   public readonly commands: Collection<string, Command<CommandTrigger>>;
 
   /**
-   * A [collection](https://discord.js.org/#/docs/collection/master/class/Collection) of the groups registered
+   * A [collection](https://discord.js.org/docs/packages/collection/main/Collection:Class) of the groups registered
    * to this registry, mapped by the group's ID and the group.
    * @type {Collection<string, CommandGroup>}
    * @memberof CommandRegistry

src/classes/command/RegularCommand.ts

@@ -10,14 +10,14 @@ import { Command } from './Command';
 export abstract class RegularCommand extends Command<Message> {
   /**
    * Abstract method. You need to implement this method in order for the command to work. This defines the execution behavior of the command.
-   * @param message The [message](https://discord.js.org/#/docs/discord.js/stable/class/Message) that triggered this command.
+   * @param message The [message](https://old.discordjs.dev/#/docs/discord.js/main/class/Message) that triggered this command.
    * @param args The arguments passed to this command.
    */
   public abstract run(message: Message, args: string[]): Promise<void>;
 
   /**
    * Check whether the message author can execute this command.
-   * @param message The [message](https://discord.js.org/#/docs/discord.js/stable/class/Message) that triggered this command.
+   * @param message The [message](https://old.discordjs.dev/#/docs/discord.js/main/class/Message) that triggered this command.
    * @returns `true` if the user has enough permissions, or a string with the reason why they cannot execute this command.
    */
   public override hasPermission(message: Message): boolean | string {
@@ -57,7 +57,7 @@ export abstract class RegularCommand extends Command<Message> {
   /**
    * Handle command error.
    * @param error The error that was thrown inside the command's run method.
-   * @param message The [message](https://discord.js.org/#/docs/discord.js/stable/class/Message) that triggered this command.
+   * @param message The [message](https://old.discordjs.dev/#/docs/discord.js/main/class/Message) that triggered this command.
    * @emits `client#commandError`
    */
   public override async onError(error: unknown, message: Message): Promise<void> {

src/classes/command/SlashCommand.ts

@@ -66,13 +66,13 @@ export abstract class SlashCommand extends Command<ChatInputCommandInteraction>
 
   /**
    * Abstract method. You need to implement this method in order for the command to work. This defines the execution behavior of the command.
-   * @param interaction The [interaction](https://discord.js.org/#/docs/discord.js/stable/class/ChatInputCommandInteraction) that triggered this command.
+   * @param interaction The [interaction](https://old.discordjs.dev/#/docs/discord.js/main/class/ChatInputCommandInteraction) that triggered this command.
    */
   public abstract run(interaction: ChatInputCommandInteraction): Promise<void>;
 
   /**
    * Check whether the interaction author can execute this command.
-   * @param interaction The [interaction](https://discord.js.org/#/docs/discord.js/stable/class/ChatInputCommandInteraction) that triggered this command.
+   * @param interaction The [interaction](https://old.discordjs.dev/#/docs/discord.js/main/class/ChatInputCommandInteraction) that triggered this command.
    * @returns `true` if the user has enough permissions, or a string with the reason why they cannot execute this command.
    */
   public override hasPermission(interaction: ChatInputCommandInteraction): boolean | string {
@@ -112,7 +112,7 @@ export abstract class SlashCommand extends Command<ChatInputCommandInteraction>
   /**
    * Handle command error.
    * @param error The error that was thrown inside the command's run method.
-   * @param interaction The [interaction](https://discord.js.org/#/docs/discord.js/stable/class/ChatInputCommandInteraction) that triggered this command.
+   * @param interaction The [interaction](https://old.discordjs.dev/#/docs/discord.js/main/class/ChatInputCommandInteraction) that triggered this command.
    * @emits `client#commandError`
    */
   public override async onError(error: unknown, interaction: ChatInputCommandInteraction): Promise<void> {

src/classes/command/SlashCommandDeployer.ts

@@ -56,7 +56,7 @@ export class SlashCommandDeployer {
 
   /**
    * Deploy the commands registered to this deployer's client registry to a given guild.
-   * @param guildID The ID of the [guild](https://discord.js.org/#/docs/discord.js/stable/class/Guild) to deploy the commands to.
+   * @param guildID The ID of the [guild](https://old.discordjs.dev/#/docs/discord.js/main/class/Guild) to deploy the commands to.
    * @returns A promise that resolves once all the commands have been deployed.
    * @emits `client#commandDeployed`
    * @emits `client#error`
@@ -77,7 +77,7 @@ export class SlashCommandDeployer {
 
   /**
    * Deploy the commands registered to this deployer's client registry to multiple guilds.
-   * @param guildIDs An array with the IDs of the [guilds](https://discord.js.org/#/docs/discord.js/stable/class/Guild) to deploy the commands to.
+   * @param guildIDs An array with the IDs of the [guilds](https://old.discordjs.dev/#/docs/discord.js/main/class/Guild) to deploy the commands to.
    * @returns A promise that resolves once all the commands have been deployed.
    * @emits `client#commandDeployed`
    * @emits `client#error`

src/classes/command/default/regular/HelpRegularCommand.ts

@@ -60,8 +60,8 @@ export class HelpRegularCommand extends RegularCommand {
    * ```text
    * $help
    * ```
-   * @param message The [message](https://discord.js.org/#/docs/discord.js/stable/class/Message) that triggered this command.
-   * @returns The [message](https://discord.js.org/#/docs/discord.js/stable/class/Message) where the help message embed was sent.
+   * @param message The [message](https://old.discordjs.dev/#/docs/discord.js/main/class/Message) that triggered this command.
+   * @returns The [message](https://old.discordjs.dev/#/docs/discord.js/main/class/Message) where the help message embed was sent.
    */
   public async run(message: Message): Promise<void> {
     const embed = new EmbedBuilder();

src/classes/command/default/regular/SetLocaleRegularCommand.ts

@@ -28,7 +28,7 @@ export class SetLocaleRegularCommand extends RegularCommand {
    * ```text
    * /set_locale <locale>
    * ```
-   * @param message The [message](https://discord.js.org/#/docs/discord.js/stable/class/Message) that triggered this command.
+   * @param message The [message](https://old.discordjs.dev/#/docs/discord.js/main/class/Message) that triggered this command.
    * @param args The arguments passed to this command.
    */
   public async run(message: Message, args: string[]): Promise<void> {

src/classes/command/default/slash/HelpSlashCommand.ts

@@ -61,7 +61,7 @@ export class HelpSlashCommand extends SlashCommand {
    * ```text
    * $help
    * ```
-   * @param interaction The [interaction](https://discord.js.org/#/docs/discord.js/stable/class/CommandInteraction) that triggered this command.
+   * @param interaction The [interaction](https://old.discordjs.dev/#/docs/discord.js/main/class/ChatInputCommandInteraction) that triggered this command.
    */
   public async run(interaction: ChatInputCommandInteraction): Promise<void> {
     const embed = new EmbedBuilder();

src/classes/command/default/slash/SetLocaleSlashCommand.ts

@@ -34,7 +34,7 @@ export class SetLocaleSlashCommand extends SlashCommand {
    * ```text
    * /set_locale <locale>
    * ```
-   * @param interaction The [interaction](https://discord.js.org/#/docs/discord.js/stable/class/CommandInteraction) that triggered this command.
+   * @param interaction The [interaction](https://old.discordjs.dev/#/docs/discord.js/main/class/ChatInputCommandInteraction) that triggered this command.
    */
   public async run(interaction: ChatInputCommandInteraction): Promise<void> {
     const localizer = this.client.localizer!.getLocalizer(interaction.guild!)!; // We know it comes from a guild because of guildOnly.