feat(CommandInteraction): add CommandInteractionOptionResolver

src/structures/CommandInteraction.js

@@ -1,9 +1,9 @@
 'use strict';
 
+const CommandInteractionOptionResolver = require('./CommandInteractionOptionResolver');
 const Interaction = require('./Interaction');
 const InteractionWebhook = require('./InteractionWebhook');
 const InteractionResponses = require('./interfaces/InteractionResponses');
-const Collection = require('../util/Collection');
 const { ApplicationCommandOptionTypes } = require('../util/Constants');
 
 /**
@@ -48,9 +48,11 @@ class CommandInteraction extends Interaction {
 
     /**
      * The options passed to the command.
-     * @type {Collection<string, CommandInteractionOption>}
+     * @type {CommandInteractionOptionResolver}
      */
-    this.options = this._createOptionsCollection(data.data.options, data.data.resolved);
+    this.options = new CommandInteractionOptionResolver(
+      this._createOptionsArray(data.data.options, data.data.resolved),
+    );
 
     /**
      * Whether this interaction has already been replied to
@@ -108,7 +110,7 @@ class CommandInteraction extends Interaction {
     };
 
     if ('value' in option) result.value = option.value;
-    if ('options' in option) result.options = this._createOptionsCollection(option.options, resolved);
+    if ('options' in option) result.options = this._createOptionsArray(option.options, resolved);
 
     if (resolved) {
       const user = resolved.users?.[option.value];
@@ -128,19 +130,19 @@ class CommandInteraction extends Interaction {
   }
 
   /**
-   * Creates a collection of options from the received options array.
+   * Creates an array of options from the received API options array.
    * @param {APIApplicationCommandOption[]} options The received options
    * @param {APIApplicationCommandOptionResolved} resolved The resolved interaction data
-   * @returns {Collection<string, CommandInteractionOption>}
+   * @returns {CommandInteractionOption[]}
    * @private
    */
-  _createOptionsCollection(options, resolved) {
-    const optionsCollection = new Collection();
-    if (typeof options === 'undefined') return optionsCollection;
+  _createOptionsArray(options, resolved) {
+    const optionsArray = [];
+    if (typeof options === 'undefined') return optionsArray;
     for (const option of options) {
-      optionsCollection.set(option.name, this.transformOption(option, resolved));
+      optionsArray.push(this.transformOption(option, resolved));
     }
-    return optionsCollection;
+    return optionsArray;
   }
 
   // These are here only for documentation purposes - they are implemented by InteractionResponses

src/structures/CommandInteractionOptionResolver.js

@@ -0,0 +1,159 @@
+'use strict';
+
+/**
+ * A resolver for command interaction options.
+ */
+class CommandInteractionOptionResolver {
+  constructor(options) {
+    /**
+     * The interaction options array.
+     * @type {CommandInteractionOption[]}
+     * @private
+     */
+    this.options = options ?? [];
+  }
+
+  /**
+   * Gets an option by its name.
+   * @param {string} name The name of the option.
+   * @param {boolean} required Whether to throw an error if the option is not found.
+   * @returns {?CommandInteractionOption} The option, if found.
+   */
+  get(name, required = false) {
+    const option = this.options.find(opt => opt.name === name);
+    if (option) {
+      return option;
+    } else if (required) {
+      throw new Error(`Missing required option "${name}"`);
+    } else {
+      return null;
+    }
+  }
+
+  /**
+   * Gets an option by name and property and checks its type.
+   * @param {string} name The name of the option.
+   * @param {ApplicationCommandOptionType[]} types The type of the option.
+   * @param {string[]} properties The property to check for for `required`.
+   * @param {boolean} required Whether to throw an error if the option is not found.
+   * @returns {*|null} The value of `property`.
+   * @private
+   */
+  _getTypedOption(name, types, properties, required) {
+    const option = this.get(name, required);
+    if (option) {
+      if (!types.includes(option.type)) {
+        throw new Error(`Option "${name}" is of type "${option.type}"; expected ${types.join('|')}.`);
+      } else if (required && properties.every(prop => option[prop] === null || typeof option[prop] === 'undefined')) {
+        throw new Error(`Option "${name}" of type "${option.type}" is required, but is empty.`);
+      } else {
+        return option;
+      }
+    } else {
+      return option;
+    }
+  }
+
+  /**
+   * Gets a sub-command or sub-command group.
+   * @param {string} name The name of the sub-command or sub-command group.
+   * @returns {CommandInteractionOptionResolver|null}
+   * A new resolver for the sub-command/group's options, or null if empty
+   */
+  getSubCommand(name) {
+    const option = this._getTypedOption(name, ['SUB_COMMAND', 'SUB_COMMAND_GROUP'], ['options'], false);
+    return option ? new CommandInteractionOptionResolver(option.options) : null;
+  }
+
+  /**
+   * Gets a boolean option.
+   * @param {string} name The name of the option.
+   * @param {boolean} required Whether to throw an error if the option is not found.
+   * @returns {boolean|null} The value of the option, or null if not set and not required.
+   */
+  getBoolean(name, required = false) {
+    const option = this._getTypedOption(name, ['BOOLEAN'], ['value'], required);
+    return option?.value ?? null;
+  }
+
+  /**
+   * Gets a channel option.
+   * @param {string} name The name of the option.
+   * @param {boolean} required Whether to throw an error if the option is not found.
+   * @returns {GuildChannel|APIInteractionDataResolvedChannel|null}
+   * The value of the option, or null if not set and not required.
+   */
+  getChannel(name, required = false) {
+    const option = this._getTypedOption(name, ['CHANNEL'], ['channel'], required);
+    return option?.channel ?? null;
+  }
+
+  /**
+   * Gets a string option.
+   * @param {string} name The name of the option.
+   * @param {boolean} required Whether to throw an error if the option is not found.
+   * @returns {string|null} The value of the option, or null if not set and not required.
+   */
+  getString(name, required = false) {
+    const option = this._getTypedOption(name, ['STRING'], ['value'], required);
+    return option?.value ?? null;
+  }
+
+  /**
+   * Gets an integer option.
+   * @param {string} name The name of the option.
+   * @param {boolean} required Whether to throw an error if the option is not found.
+   * @returns {number|null} The value of the option, or null if not set and not required.
+   */
+  getInteger(name, required = false) {
+    const option = this._getTypedOption(name, ['INTEGER'], ['value'], required);
+    return option?.value ?? null;
+  }
+
+  /**
+   * Gets a user option.
+   * @param {string} name The name of the option.
+   * @param {boolean} required Whether to throw an error if the option is not found.
+   * @returns {User|null} The value of the option, or null if not set and not required.
+   */
+  getUser(name, required = false) {
+    const option = this._getTypedOption(name, ['USER'], ['user'], required);
+    return option?.user ?? null;
+  }
+
+  /**
+   * Gets a member option.
+   * @param {string} name The name of the option.
+   * @param {boolean} required Whether to throw an error if the option is not found.
+   * @returns {GuildMember|APIInteractionDataResolvedGuildMember|null}
+   * The value of the option, or null if not set and not required.
+   */
+  getMember(name, required = false) {
+    const option = this._getTypedOption(name, ['MEMBER'], ['member'], required);
+    return option?.member ?? null;
+  }
+
+  /**
+   * Gets a role option.
+   * @param {string} name The name of the option.
+   * @param {boolean} required Whether to throw an error if the option is not found.
+   * @returns {Role|APIRole|null} The value of the option, or null if not set and not required.
+   */
+  getRole(name, required = false) {
+    const option = this._getTypedOption(name, ['ROLE'], ['role'], required);
+    return option?.role ?? null;
+  }
+
+  /**
+   * Gets a mentionable option.
+   * @param {string} name The name of the option.
+   * @param {boolean} required Whether to throw an error if the option is not found.
+   * @returns {User|GuildMember|Role|null} The value of the option, or null if not set and not required.
+   */
+  getMentionable(name, required = false) {
+    const option = this._getTypedOption(name, ['MENTIONABLE'], ['user', 'member', 'role'], required);
+    return option?.user ?? option?.member ?? option?.role ?? null;
+  }
+}
+
+module.exports = CommandInteractionOptionResolver;

typings/index.d.ts

@@ -416,7 +416,7 @@ export class CommandInteraction extends Interaction {
   public commandName: string;
   public deferred: boolean;
   public ephemeral: boolean | null;
-  public options: Collection<string, CommandInteractionOption>;
+  public options: CommandInteractionOptionResolver;
   public replied: boolean;
   public webhook: InteractionWebhook;
   public defer(options?: InteractionDeferOptions & { fetchReply: true }): Promise<Message | APIMessage>;
@@ -431,6 +431,56 @@ export class CommandInteraction extends Interaction {
   private _createOptionsCollection(options: unknown, resolved: unknown): Collection<string, CommandInteractionOption>;
 }
 
+export class CommandInteractionOptionResolver {
+  constructor(options: CommandInteractionOption[]);
+  private options: CommandInteractionOption[];
+  private _getTypedOption(
+    name: string,
+    types: ApplicationCommandOptionType[],
+    properties: (keyof ApplicationCommandOption)[],
+    required: true,
+  ): CommandInteractionOption;
+  private _getTypedOption(
+    name: string,
+    types: ApplicationCommandOptionType[],
+    properties: (keyof ApplicationCommandOption)[],
+    required: boolean,
+  ): CommandInteractionOption | null;
+
+  public get(name: string, required: true): CommandInteractionOption;
+  public get(name: string, required?: boolean): CommandInteractionOption | null;
+  public getSubCommand(name: string): CommandInteractionOptionResolver | null;
+  public getBoolean(name: string, required: true): boolean;
+  public getBoolean(name: string, required?: boolean): boolean | null;
+  public getChannel(name: string, required: true): NonNullable<CommandInteractionOption['channel']>;
+  public getChannel(name: string, required?: boolean): NonNullable<CommandInteractionOption['channel']> | null;
+  public getString(name: string, required: true): string;
+  public getString(name: string, required?: boolean): string | null;
+  public getInteger(name: string, required: true): number;
+  public getInteger(name: string, required?: boolean): number | null;
+  public getUser(name: string, required: true): NonNullable<CommandInteractionOption['user']>;
+  public getUser(name: string, required?: boolean): NonNullable<CommandInteractionOption['user']> | null;
+  public getMember(name: string, required: true): NonNullable<CommandInteractionOption['member']>;
+  public getMember(name: string, required?: boolean): NonNullable<CommandInteractionOption['member']> | null;
+  public getRole(name: string, required: true): NonNullable<CommandInteractionOption['role']>;
+  public getRole(name: string, required?: boolean): NonNullable<CommandInteractionOption['role']> | null;
+  public getMentionable(
+    name: string,
+    required: true,
+  ):
+    | NonNullable<CommandInteractionOption['member']>
+    | NonNullable<CommandInteractionOption['role']>
+    | NonNullable<CommandInteractionOption['user']>;
+  public getMentionable(
+    name: string,
+    required?: boolean,
+  ):
+    | NonNullable<CommandInteractionOption['member']>
+    | NonNullable<CommandInteractionOption['role']>
+    | NonNullable<CommandInteractionOption['user']>
+    | null;
+}
+
 export class DataResolver extends null {
   private constructor();
   public static resolveBase64(data: Base64Resolvable): string;