@velliajs/discord 1.0.2 → 1.0.4

package/src/structures/CommandInteraction.js

@@ -6,97 +6,47 @@ const BaseInteraction = require('./BaseInteraction');
 const InteractionWebhook = require('./InteractionWebhook');
 const InteractionResponses = require('./interfaces/InteractionResponses');
 
-/**
- * Represents a command interaction.
- * @extends {BaseInteraction}
- * @implements {InteractionResponses}
- * @abstract
- */
+
 class CommandInteraction extends BaseInteraction {
   constructor(client, data) {
     super(client, data);
 
-    /**
-     * The id of the channel this interaction was sent in
-     * @type {Snowflake}
-     * @name CommandInteraction#channelId
-     */
+    
 
-    /**
-     * The invoked application command's id
-     * @type {Snowflake}
-     */
+    
     this.commandId = data.data.id;
 
-    /**
-     * The invoked application command's name
-     * @type {string}
-     */
+    
     this.commandName = data.data.name;
 
-    /**
-     * The invoked application command's type
-     * @type {ApplicationCommandType}
-     */
+    
     this.commandType = data.data.type;
 
-    /**
-     * The id of the guild the invoked application command is registered to
-     * @type {?Snowflake}
-     */
+    
     this.commandGuildId = data.data.guild_id ?? null;
 
-    /**
-     * Whether the reply to this interaction has been deferred
-     * @type {boolean}
-     */
+    
     this.deferred = false;
 
-    /**
-     * Whether this interaction has already been replied to
-     * @type {boolean}
-     */
+    
     this.replied = false;
 
-    /**
-     * Whether the reply to this interaction is ephemeral
-     * @type {?boolean}
-     */
+    
     this.ephemeral = null;
 
-    /**
-     * An associated interaction webhook, can be used to further interact with this interaction
-     * @type {InteractionWebhook}
-     */
+    
     this.webhook = new InteractionWebhook(this.client, this.applicationId, this.token);
   }
 
-  /**
-   * The invoked application command, if it was fetched before
-   * @type {?ApplicationCommand}
-   */
+  
   get command() {
     const id = this.commandId;
     return this.guild?.commands.cache.get(id) ?? this.client.application.commands.cache.get(id) ?? null;
   }
 
-  /**
-   * Represents the resolved data of a received command interaction.
-   * @typedef {Object} CommandInteractionResolvedData
-   * @property {Collection<Snowflake, User>} [users] The resolved users
-   * @property {Collection<Snowflake, GuildMember|APIGuildMember>} [members] The resolved guild members
-   * @property {Collection<Snowflake, Role|APIRole>} [roles] The resolved roles
-   * @property {Collection<Snowflake, BaseChannel|APIChannel>} [channels] The resolved channels
-   * @property {Collection<Snowflake, Message|APIMessage>} [messages] The resolved messages
-   * @property {Collection<Snowflake, Attachment>} [attachments] The resolved attachments
-   */
-
-  /**
-   * Transforms the resolved received from the API.
-   * @param {APIInteractionDataResolved} resolved The received resolved objects
-   * @returns {CommandInteractionResolvedData}
-   * @private
-   */
+  
+
+  
   transformResolved({ members, users, channels, roles, messages, attachments }) {
     const result = {};
 
@@ -147,31 +97,9 @@ class CommandInteraction extends BaseInteraction {
     return result;
   }
 
-  /**
-   * Represents an option of a received command interaction.
-   * @typedef {Object} CommandInteractionOption
-   * @property {string} name The name of the option
-   * @property {ApplicationCommandOptionType} type The type of the option
-   * @property {boolean} [autocomplete] Whether the autocomplete interaction is enabled for a
-   * {@link ApplicationCommandOptionType.String}, {@link ApplicationCommandOptionType.Integer} or
-   * {@link ApplicationCommandOptionType.Number} option
-   * @property {string|number|boolean} [value] The value of the option
-   * @property {CommandInteractionOption[]} [options] Additional options if this option is a
-   * subcommand (group)
-   * @property {User} [user] The resolved user
-   * @property {GuildMember|APIGuildMember} [member] The resolved member
-   * @property {GuildChannel|ThreadChannel|APIChannel} [channel] The resolved channel
-   * @property {Role|APIRole} [role] The resolved role
-   * @property {Attachment} [attachment] The resolved attachment
-   */
-
-  /**
-   * Transforms an option received from the API.
-   * @param {APIApplicationCommandOption} option The received option
-   * @param {APIInteractionDataResolved} resolved The resolved interaction data
-   * @returns {CommandInteractionOption}
-   * @private
-   */
+  
+
+  
   transformOption(option, resolved) {
     const result = {
       name: option.name,
@@ -201,8 +129,8 @@ class CommandInteraction extends BaseInteraction {
     return result;
   }
 
-  // These are here only for documentation purposes - they are implemented by InteractionResponses
-  /* eslint-disable no-empty-function */
+  
+  
   deferReply() {}
   reply() {}
   fetchReply() {}
@@ -217,8 +145,5 @@ InteractionResponses.applyToClass(CommandInteraction, ['deferUpdate', 'update'])
 
 module.exports = CommandInteraction;
 
-/* eslint-disable max-len */
-/**
- * @external APIInteractionDataResolved
- * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure}
- */
+
+

package/src/structures/CommandInteractionOptionResolver.js

@@ -3,74 +3,40 @@
 const { ApplicationCommandOptionType } = require('discord-api-types/v10');
 const { DiscordjsTypeError, ErrorCodes } = require('../errors');
 
-/**
- * A resolver for command interaction options.
- */
+
 class CommandInteractionOptionResolver {
   constructor(client, options, resolved) {
-    /**
-     * The client that instantiated this.
-     * @name CommandInteractionOptionResolver#client
-     * @type {Client}
-     * @readonly
-     */
+    
     Object.defineProperty(this, 'client', { value: client });
 
-    /**
-     * The name of the subcommand group.
-     * @type {?string}
-     * @private
-     */
+    
     this._group = null;
 
-    /**
-     * The name of the subcommand.
-     * @type {?string}
-     * @private
-     */
+    
     this._subcommand = null;
 
-    /**
-     * The bottom-level options for the interaction.
-     * If there is a subcommand (or subcommand and group), this is the options for the subcommand.
-     * @type {CommandInteractionOption[]}
-     * @private
-     */
+    
     this._hoistedOptions = options;
 
-    // Hoist subcommand group if present
+    
     if (this._hoistedOptions[0]?.type === ApplicationCommandOptionType.SubcommandGroup) {
       this._group = this._hoistedOptions[0].name;
       this._hoistedOptions = this._hoistedOptions[0].options ?? [];
     }
-    // Hoist subcommand if present
+    
     if (this._hoistedOptions[0]?.type === ApplicationCommandOptionType.Subcommand) {
       this._subcommand = this._hoistedOptions[0].name;
       this._hoistedOptions = this._hoistedOptions[0].options ?? [];
     }
 
-    /**
-     * The interaction options array.
-     * @name CommandInteractionOptionResolver#data
-     * @type {ReadonlyArray<CommandInteractionOption>}
-     * @readonly
-     */
+    
     Object.defineProperty(this, 'data', { value: Object.freeze([...options]) });
 
-    /**
-     * The interaction resolved data
-     * @name CommandInteractionOptionResolver#resolved
-     * @type {?Readonly<CommandInteractionResolvedData>}
-     */
+    
     Object.defineProperty(this, 'resolved', { value: resolved ? Object.freeze(resolved) : null });
   }
 
-  /**
-   * Gets an option by its name.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @returns {?CommandInteractionOption} The option, if found.
-   */
+  
   get(name, required = false) {
     const option = this._hoistedOptions.find(opt => opt.name === name);
     if (!option) {
@@ -82,15 +48,7 @@ class CommandInteractionOptionResolver {
     return option;
   }
 
-  /**
-   * Gets an option by name and property and checks its type.
-   * @param {string} name The name of the option.
-   * @param {ApplicationCommandOptionType[]} allowedTypes The allowed types of the option.
-   * @param {string[]} properties The properties to check for for `required`.
-   * @param {boolean} required Whether to throw an error if the option is not found.
-   * @returns {?CommandInteractionOption} The option, if found.
-   * @private
-   */
+  
   _getTypedOption(name, allowedTypes, properties, required) {
     const option = this.get(name, required);
     if (!option) {
@@ -103,11 +61,7 @@ class CommandInteractionOptionResolver {
     return option;
   }
 
-  /**
-   * Gets the selected subcommand.
-   * @param {boolean} [required=true] Whether to throw an error if there is no subcommand.
-   * @returns {?string} The name of the selected subcommand, or null if not set and not required.
-   */
+  
   getSubcommand(required = true) {
     if (required && !this._subcommand) {
       throw new DiscordjsTypeError(ErrorCodes.CommandInteractionOptionNoSubcommand);
@@ -115,11 +69,7 @@ class CommandInteractionOptionResolver {
     return this._subcommand;
   }
 
-  /**
-   * Gets the selected subcommand group.
-   * @param {boolean} [required=false] Whether to throw an error if there is no subcommand group.
-   * @returns {?string} The name of the selected subcommand group, or null if not set and not required.
-   */
+  
   getSubcommandGroup(required = false) {
     if (required && !this._group) {
       throw new DiscordjsTypeError(ErrorCodes.CommandInteractionOptionNoSubcommandGroup);
@@ -127,25 +77,13 @@ class CommandInteractionOptionResolver {
     return this._group;
   }
 
-  /**
-   * Gets a boolean option.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @returns {?boolean} The value of the option, or null if not set and not required.
-   */
+  
   getBoolean(name, required = false) {
     const option = this._getTypedOption(name, [ApplicationCommandOptionType.Boolean], ['value'], required);
     return option?.value ?? null;
   }
 
-  /**
-   * Gets a channel option.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @param {ChannelType[]} [channelTypes=[]] The allowed types of channels. If empty, all channel types are allowed.
-   * @returns {?(GuildChannel|ThreadChannel|APIChannel)}
-   * The value of the option, or null if not set and not required.
-   */
+  
   getChannel(name, required = false, channelTypes = []) {
     const option = this._getTypedOption(name, [ApplicationCommandOptionType.Channel], ['channel'], required);
     const channel = option?.channel ?? null;
@@ -162,45 +100,25 @@ class CommandInteractionOptionResolver {
     return channel;
   }
 
-  /**
-   * Gets a string option.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @returns {?string} The value of the option, or null if not set and not required.
-   */
+  
   getString(name, required = false) {
     const option = this._getTypedOption(name, [ApplicationCommandOptionType.String], ['value'], required);
     return option?.value ?? null;
   }
 
-  /**
-   * Gets an integer option.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @returns {?number} The value of the option, or null if not set and not required.
-   */
+  
   getInteger(name, required = false) {
     const option = this._getTypedOption(name, [ApplicationCommandOptionType.Integer], ['value'], required);
     return option?.value ?? null;
   }
 
-  /**
-   * Gets a number option.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @returns {?number} The value of the option, or null if not set and not required.
-   */
+  
   getNumber(name, required = false) {
     const option = this._getTypedOption(name, [ApplicationCommandOptionType.Number], ['value'], required);
     return option?.value ?? null;
   }
 
-  /**
-   * Gets a user option.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @returns {?User} The value of the option, or null if not set and not required.
-   */
+  
   getUser(name, required = false) {
     const option = this._getTypedOption(
       name,
@@ -211,12 +129,7 @@ class CommandInteractionOptionResolver {
     return option?.user ?? null;
   }
 
-  /**
-   * Gets a member option.
-   * @param {string} name The name of the option.
-   * @returns {?(GuildMember|APIGuildMember)}
-   * The value of the option, or null if the user is not present in the guild or the option is not set.
-   */
+  
   getMember(name) {
     const option = this._getTypedOption(
       name,
@@ -227,12 +140,7 @@ class CommandInteractionOptionResolver {
     return option?.member ?? null;
   }
 
-  /**
-   * Gets a role option.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @returns {?(Role|APIRole)} The value of the option, or null if not set and not required.
-   */
+  
   getRole(name, required = false) {
     const option = this._getTypedOption(
       name,
@@ -243,24 +151,13 @@ class CommandInteractionOptionResolver {
     return option?.role ?? null;
   }
 
-  /**
-   * Gets an attachment option.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @returns {?Attachment} The value of the option, or null if not set and not required.
-   */
+  
   getAttachment(name, required = false) {
     const option = this._getTypedOption(name, [ApplicationCommandOptionType.Attachment], ['attachment'], required);
     return option?.attachment ?? null;
   }
 
-  /**
-   * Gets a mentionable option.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @returns {?(User|GuildMember|APIGuildMember|Role|APIRole)}
-   * The value of the option, or null if not set and not required.
-   */
+  
   getMentionable(name, required = false) {
     const option = this._getTypedOption(
       name,
@@ -271,33 +168,15 @@ class CommandInteractionOptionResolver {
     return option?.member ?? option?.user ?? option?.role ?? null;
   }
 
-  /**
-   * Gets a message option.
-   * @param {string} name The name of the option.
-   * @param {boolean} [required=false] Whether to throw an error if the option is not found.
-   * @returns {?Message}
-   * The value of the option, or null if not set and not required.
-   */
+  
   getMessage(name, required = false) {
     const option = this._getTypedOption(name, ['_MESSAGE'], ['message'], required);
     return option?.message ?? null;
   }
 
-  /**
-   * The full autocomplete option object.
-   * @typedef {Object} AutocompleteFocusedOption
-   * @property {string} name The name of the option
-   * @property {ApplicationCommandOptionType} type The type of the application command option
-   * @property {string} value The value of the option
-   * @property {boolean} focused Whether this option is currently in focus for autocomplete
-   */
+  
 
-  /**
-   * Gets the focused option.
-   * @param {boolean} [getFull=false] Whether to get the full option object
-   * @returns {string|AutocompleteFocusedOption}
-   * The value of the option, or the whole option if getFull is true
-   */
+  
   getFocused(getFull = false) {
     const focusedOption = this._hoistedOptions.find(option => option.focused);
     if (!focusedOption) throw new DiscordjsTypeError(ErrorCodes.AutocompleteInteractionOptionNoFocusedOption);

package/src/structures/Component.js

@@ -2,32 +2,19 @@
 
 const isEqual = require('fast-deep-equal');
 
-/**
- * Represents a component
- */
+
 class Component {
   constructor(data) {
-    /**
-     * The API data associated with this component
-     * @type {APIMessageComponent}
-     */
+    
     this.data = data;
   }
 
-  /**
-   * The type of the component
-   * @type {ComponentType}
-   * @readonly
-   */
+  
   get type() {
     return this.data.type;
   }
 
-  /**
-   * Whether or not the given components are equal
-   * @param {Component|APIMessageComponent} other The component to compare against
-   * @returns {boolean}
-   */
+  
   equals(other) {
     if (other instanceof Component) {
       return isEqual(other.data, this.data);
@@ -35,10 +22,7 @@ class Component {
     return isEqual(other, this.data);
   }
 
-  /**
-   * Returns the API-compatible JSON for this component
-   * @returns {APIMessageComponent}
-   */
+  
   toJSON() {
     return { ...this.data };
   }

package/src/structures/ContextMenuCommandInteraction.js

@@ -7,36 +7,22 @@ const CommandInteractionOptionResolver = require('./CommandInteractionOptionReso
 
 const getMessage = lazy(() => require('./Message').Message);
 
-/**
- * Represents a context menu interaction.
- * @extends {CommandInteraction}
- */
+
 class ContextMenuCommandInteraction extends CommandInteraction {
   constructor(client, data) {
     super(client, data);
-    /**
-     * The target of the interaction, parsed into options
-     * @type {CommandInteractionOptionResolver}
-     */
+    
     this.options = new CommandInteractionOptionResolver(
       this.client,
       this.resolveContextMenuOptions(data.data),
       this.transformResolved(data.data.resolved),
     );
 
-    /**
-     * The id of the target of this interaction
-     * @type {Snowflake}
-     */
+    
     this.targetId = data.data.target_id;
   }
 
-  /**
-   * Resolves and transforms options received from the API for a context menu interaction.
-   * @param {APIApplicationCommandInteractionData} data The interaction data
-   * @returns {CommandInteractionOption[]}
-   * @private
-   */
+  
   resolveContextMenuOptions({ target_id, resolved }) {
     const result = [];
 

package/src/structures/DMChannel.js

@@ -7,22 +7,15 @@ const TextBasedChannel = require('./interfaces/TextBasedChannel');
 const MessageManager = require('../managers/MessageManager');
 const Partials = require('../util/Partials');
 
-/**
- * Represents a direct message channel between two users.
- * @extends {BaseChannel}
- * @implements {TextBasedChannel}
- */
+
 class DMChannel extends BaseChannel {
   constructor(client, data) {
     super(client, data);
 
-    // Override the channel type so partials have a known type
+    
     this.type = ChannelType.DM;
 
-    /**
-     * A manager of the messages belonging to this channel
-     * @type {MessageManager}
-     */
+    
     this.messages = new MessageManager(this);
   }
 
@@ -32,10 +25,7 @@ class DMChannel extends BaseChannel {
     if (data.recipients) {
       const recipient = data.recipients[0];
 
-      /**
-       * The recipient's id
-       * @type {Snowflake}
-       */
+      
       this.recipientId = recipient.id;
 
       if ('username' in recipient || this.client.options.partials.includes(Partials.Users)) {
@@ -44,65 +34,40 @@ class DMChannel extends BaseChannel {
     }
 
     if ('last_message_id' in data) {
-      /**
-       * The channel's last message id, if one was sent
-       * @type {?Snowflake}
-       */
+      
       this.lastMessageId = data.last_message_id;
     }
 
     if ('last_pin_timestamp' in data) {
-      /**
-       * The timestamp when the last pinned message was pinned, if there was one
-       * @type {?number}
-       */
+      
       this.lastPinTimestamp = Date.parse(data.last_pin_timestamp);
     } else {
       this.lastPinTimestamp ??= null;
     }
   }
 
-  /**
-   * Whether this DMChannel is a partial
-   * @type {boolean}
-   * @readonly
-   */
+  
   get partial() {
     return this.lastMessageId === undefined;
   }
 
-  /**
-   * The recipient on the other end of the DM
-   * @type {?User}
-   * @readonly
-   */
+  
   get recipient() {
     return this.client.users.resolve(this.recipientId);
   }
 
-  /**
-   * Fetch this DMChannel.
-   * @param {boolean} [force=true] Whether to skip the cache check and request the API
-   * @returns {Promise<DMChannel>}
-   */
+  
   fetch(force = true) {
     return this.client.users.createDM(this.recipientId, { force });
   }
 
-  /**
-   * When concatenated with a string, this automatically returns the recipient's mention instead of the
-   * DMChannel object.
-   * @returns {string}
-   * @example
-   * // Logs: Hello from <@123456789012345678>!
-   * console.log(`Hello from ${channel}!`);
-   */
+  
   toString() {
     return userMention(this.recipientId);
   }
 
-  // These are here only for documentation purposes - they are implemented by TextBasedChannel
-  /* eslint-disable no-empty-function */
+  
+  
   get lastMessage() {}
   get lastPinAt() {}
   send() {}
@@ -111,11 +76,11 @@ class DMChannel extends BaseChannel {
   awaitMessages() {}
   createMessageComponentCollector() {}
   awaitMessageComponent() {}
-  // Doesn't work on DM channels; bulkDelete() {}
-  // Doesn't work on DM channels; fetchWebhooks() {}
-  // Doesn't work on DM channels; createWebhook() {}
-  // Doesn't work on DM channels; setRateLimitPerUser() {}
-  // Doesn't work on DM channels; setNSFW() {}
+  
+  
+  
+  
+  
 }
 
 TextBasedChannel.applyToClass(DMChannel, true, [