@velliajs/discord 1.0.2 → 1.0.4

package/src/structures/BaseGuildVoiceChannel.js

@@ -6,24 +6,14 @@ const GuildChannel = require('./GuildChannel');
 const TextBasedChannel = require('./interfaces/TextBasedChannel');
 const MessageManager = require('../managers/MessageManager');
 
-/**
- * Represents a voice-based guild channel on Discord.
- * @extends {GuildChannel}
- * @implements {TextBasedChannel}
- */
+
 class BaseGuildVoiceChannel extends GuildChannel {
   constructor(guild, data, client) {
     super(guild, data, client, false);
-    /**
-     * A manager of the messages sent to this channel
-     * @type {MessageManager}
-     */
+    
     this.messages = new MessageManager(this);
 
-    /**
-     * If the guild considers this channel NSFW
-     * @type {boolean}
-     */
+    
     this.nsfw = Boolean(data.nsfw);
 
     this._patch(data);
@@ -33,44 +23,29 @@ class BaseGuildVoiceChannel extends GuildChannel {
     super._patch(data);
 
     if ('rtc_region' in data) {
-      /**
-       * The RTC region for this voice-based channel. This region is automatically selected if `null`.
-       * @type {?string}
-       */
+      
       this.rtcRegion = data.rtc_region;
     }
 
     if ('bitrate' in data) {
-      /**
-       * The bitrate of this voice-based channel
-       * @type {number}
-       */
+      
       this.bitrate = data.bitrate;
     }
 
     if ('user_limit' in data) {
-      /**
-       * The maximum amount of users allowed in this channel.
-       * @type {number}
-       */
+      
       this.userLimit = data.user_limit;
     }
 
     if ('video_quality_mode' in data) {
-      /**
-       * The camera video quality mode of the channel.
-       * @type {?VideoQualityMode}
-       */
+      
       this.videoQualityMode = data.video_quality_mode;
     } else {
       this.videoQualityMode ??= null;
     }
 
     if ('last_message_id' in data) {
-      /**
-       * The last message id sent in the channel, if one was sent
-       * @type {?Snowflake}
-       */
+      
       this.lastMessageId = data.last_message_id;
     }
 
@@ -79,10 +54,7 @@ class BaseGuildVoiceChannel extends GuildChannel {
     }
 
     if ('rate_limit_per_user' in data) {
-      /**
-       * The rate limit per user (slowmode) for this channel in seconds
-       * @type {number}
-       */
+      
       this.rateLimitPerUser = data.rate_limit_per_user;
     }
 
@@ -91,11 +63,7 @@ class BaseGuildVoiceChannel extends GuildChannel {
     }
   }
 
-  /**
-   * The members in this voice-based channel
-   * @type {Collection<Snowflake, GuildMember>}
-   * @readonly
-   */
+  
   get members() {
     const coll = new Collection();
     for (const state of this.guild.voiceStates.cache.values()) {
@@ -106,26 +74,18 @@ class BaseGuildVoiceChannel extends GuildChannel {
     return coll;
   }
 
-  /**
-   * Checks if the voice-based channel is full
-   * @type {boolean}
-   * @readonly
-   */
+  
   get full() {
     return this.userLimit > 0 && this.members.size >= this.userLimit;
   }
 
-  /**
-   * Whether the channel is joinable by the client user
-   * @type {boolean}
-   * @readonly
-   */
+  
   get joinable() {
     if (!this.viewable) return false;
     const permissions = this.permissionsFor(this.client.user);
     if (!permissions) return false;
 
-    // This flag allows joining even if timed out
+    
     if (permissions.has(PermissionFlagsBits.Administrator, false)) return true;
 
     return (
@@ -134,87 +94,38 @@ class BaseGuildVoiceChannel extends GuildChannel {
     );
   }
 
-  /**
-   * Creates an invite to this guild channel.
-   * @param {InviteCreateOptions} [options={}] The options for creating the invite
-   * @returns {Promise<Invite>}
-   * @example
-   * // Create an invite to a channel
-   * channel.createInvite()
-   *   .then(invite => console.log(`Created an invite with a code of ${invite.code}`))
-   *   .catch(console.error);
-   */
+  
   createInvite(options) {
     return this.guild.invites.create(this.id, options);
   }
 
-  /**
-   * Fetches a collection of invites to this guild channel.
-   * @param {boolean} [cache=true] Whether to cache the fetched invites
-   * @returns {Promise<Collection<string, Invite>>}
-   */
+  
   fetchInvites(cache = true) {
     return this.guild.invites.fetch({ channelId: this.id, cache });
   }
 
-  /**
-   * Sets the bitrate of the channel.
-   * @param {number} bitrate The new bitrate
-   * @param {string} [reason] Reason for changing the channel's bitrate
-   * @returns {Promise<BaseGuildVoiceChannel>}
-   * @example
-   * // Set the bitrate of a voice channel
-   * channel.setBitrate(48_000)
-   *   .then(channel => console.log(`Set bitrate to ${channel.bitrate}bps for ${channel.name}`))
-   *   .catch(console.error);
-   */
+  
   setBitrate(bitrate, reason) {
     return this.edit({ bitrate, reason });
   }
 
-  /**
-   * Sets the RTC region of the channel.
-   * @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
-   * @param {string} [reason] The reason for modifying this region.
-   * @returns {Promise<BaseGuildVoiceChannel>}
-   * @example
-   * // Set the RTC region to sydney
-   * channel.setRTCRegion('sydney');
-   * @example
-   * // Remove a fixed region for this channel - let Discord decide automatically
-   * channel.setRTCRegion(null, 'We want to let Discord decide.');
-   */
+  
   setRTCRegion(rtcRegion, reason) {
     return this.edit({ rtcRegion, reason });
   }
 
-  /**
-   * Sets the user limit of the channel.
-   * @param {number} userLimit The new user limit
-   * @param {string} [reason] Reason for changing the user limit
-   * @returns {Promise<BaseGuildVoiceChannel>}
-   * @example
-   * // Set the user limit of a voice channel
-   * channel.setUserLimit(42)
-   *   .then(channel => console.log(`Set user limit to ${channel.userLimit} for ${channel.name}`))
-   *   .catch(console.error);
-   */
+  
   setUserLimit(userLimit, reason) {
     return this.edit({ userLimit, reason });
   }
 
-  /**
-   * Sets the camera video quality mode of the channel.
-   * @param {VideoQualityMode} videoQualityMode The new camera video quality mode.
-   * @param {string} [reason] Reason for changing the camera video quality mode.
-   * @returns {Promise<BaseGuildVoiceChannel>}
-   */
+  
   setVideoQualityMode(videoQualityMode, reason) {
     return this.edit({ videoQualityMode, reason });
   }
 
-  // These are here only for documentation purposes - they are implemented by TextBasedChannel
-  /* eslint-disable no-empty-function */
+  
+  
   get lastMessage() {}
   send() {}
   sendTyping() {}

package/src/structures/BaseInteraction.js

@@ -7,222 +7,106 @@ const Base = require('./Base');
 const { SelectMenuTypes } = require('../util/Constants');
 const PermissionsBitField = require('../util/PermissionsBitField');
 
-/**
- * Represents an interaction.
- * @extends {Base}
- * @abstract
- */
+
 class BaseInteraction extends Base {
   constructor(client, data) {
     super(client);
 
-    /**
-     * The interaction's type
-     * @type {InteractionType}
-     */
+    
     this.type = data.type;
 
-    /**
-     * The interaction's id
-     * @type {Snowflake}
-     */
+    
     this.id = data.id;
 
-    /**
-     * The interaction's token
-     * @type {string}
-     * @name BaseInteraction#token
-     * @readonly
-     */
+    
     Object.defineProperty(this, 'token', { value: data.token });
 
-    /**
-     * The application's id
-     * @type {Snowflake}
-     */
+    
     this.applicationId = data.application_id;
 
-    /**
-     * The id of the channel this interaction was sent in
-     * @type {?Snowflake}
-     */
+    
     this.channelId = data.channel?.id ?? null;
 
-    /**
-     * The id of the guild this interaction was sent in
-     * @type {?Snowflake}
-     */
+    
     this.guildId = data.guild_id ?? null;
 
-    /**
-     * The user who created this interaction
-     * @type {User}
-     */
+    
     this.user = this.client.users._add(data.user ?? data.member.user);
 
-    /**
-     * If this interaction was sent in a guild, the member which sent it
-     * @type {?(GuildMember|APIGuildMember)}
-     */
+    
     this.member = data.member ? this.guild?.members._add(data.member) ?? data.member : null;
 
-    /**
-     * The version
-     * @type {number}
-     */
+    
     this.version = data.version;
 
-    /**
-     * Set of permissions the application or bot has within the channel the interaction was sent from
-     * @type {?Readonly<PermissionsBitField>}
-     */
+    
     this.appPermissions = data.app_permissions ? new PermissionsBitField(data.app_permissions).freeze() : null;
 
-    /**
-     * The permissions of the member, if one exists, in the channel this interaction was executed in
-     * @type {?Readonly<PermissionsBitField>}
-     */
+    
     this.memberPermissions = data.member?.permissions
       ? new PermissionsBitField(data.member.permissions).freeze()
       : null;
 
-    /**
-     * A Discord locale string, possible values are:
-     * * en-US (English, US)
-     * * en-GB (English, UK)
-     * * bg (Bulgarian)
-     * * zh-CN (Chinese, China)
-     * * zh-TW (Chinese, Taiwan)
-     * * hr (Croatian)
-     * * cs (Czech)
-     * * da (Danish)
-     * * nl (Dutch)
-     * * fi (Finnish)
-     * * fr (French)
-     * * de (German)
-     * * el (Greek)
-     * * hi (Hindi)
-     * * hu (Hungarian)
-     * * it (Italian)
-     * * ja (Japanese)
-     * * ko (Korean)
-     * * lt (Lithuanian)
-     * * no (Norwegian)
-     * * pl (Polish)
-     * * pt-BR (Portuguese, Brazilian)
-     * * ro (Romanian, Romania)
-     * * ru (Russian)
-     * * es-ES (Spanish)
-     * * sv-SE (Swedish)
-     * * th (Thai)
-     * * tr (Turkish)
-     * * uk (Ukrainian)
-     * * vi (Vietnamese)
-     * @see {@link https://discord.com/developers/docs/reference#locales}
-     * @typedef {string} Locale
-     */
-
-    /**
-     * The locale of the user who invoked this interaction
-     * @type {Locale}
-     */
+    
+
+    
     this.locale = data.locale;
 
-    /**
-     * The preferred locale from the guild this interaction was sent in
-     * @type {?Locale}
-     */
+    
     this.guildLocale = data.guild_locale ?? null;
   }
 
-  /**
-   * The timestamp the interaction was created at
-   * @type {number}
-   * @readonly
-   */
+  
   get createdTimestamp() {
     return DiscordSnowflake.timestampFrom(this.id);
   }
 
-  /**
-   * The time the interaction was created at
-   * @type {Date}
-   * @readonly
-   */
+  
   get createdAt() {
     return new Date(this.createdTimestamp);
   }
 
-  /**
-   * The channel this interaction was sent in
-   * @type {?TextBasedChannels}
-   * @readonly
-   */
+  
   get channel() {
     return this.client.channels.cache.get(this.channelId) ?? null;
   }
 
-  /**
-   * The guild this interaction was sent in
-   * @type {?Guild}
-   * @readonly
-   */
+  
   get guild() {
     return this.client.guilds.cache.get(this.guildId) ?? null;
   }
 
-  /**
-   * Indicates whether this interaction is received from a guild.
-   * @returns {boolean}
-   */
+  
   inGuild() {
     return Boolean(this.guildId && this.member);
   }
 
-  /**
-   * Indicates whether or not this interaction is both cached and received from a guild.
-   * @returns {boolean}
-   */
+  
   inCachedGuild() {
     return Boolean(this.guild && this.member);
   }
 
-  /**
-   * Indicates whether or not this interaction is received from an uncached guild.
-   * @returns {boolean}
-   */
+  
   inRawGuild() {
     return Boolean(this.guildId && !this.guild && this.member);
   }
 
-  /**
-   * Indicates whether this interaction is an {@link AutocompleteInteraction}
-   * @returns {boolean}
-   */
+  
   isAutocomplete() {
     return this.type === InteractionType.ApplicationCommandAutocomplete;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link CommandInteraction}
-   * @returns {boolean}
-   */
+  
   isCommand() {
     return this.type === InteractionType.ApplicationCommand;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link ChatInputCommandInteraction}.
-   * @returns {boolean}
-   */
+  
   isChatInputCommand() {
     return this.type === InteractionType.ApplicationCommand && this.commandType === ApplicationCommandType.ChatInput;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link ContextMenuCommandInteraction}
-   * @returns {boolean}
-   */
+  
   isContextMenuCommand() {
     return (
       this.type === InteractionType.ApplicationCommand &&
@@ -230,107 +114,67 @@ class BaseInteraction extends Base {
     );
   }
 
-  /**
-   * Indicates whether this interaction is a {@link MessageComponentInteraction}
-   * @returns {boolean}
-   */
+  
   isMessageComponent() {
     return this.type === InteractionType.MessageComponent;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link ModalSubmitInteraction}
-   * @returns {boolean}
-   */
+  
   isModalSubmit() {
     return this.type === InteractionType.ModalSubmit;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link UserContextMenuCommandInteraction}
-   * @returns {boolean}
-   */
+  
   isUserContextMenuCommand() {
     return this.isContextMenuCommand() && this.commandType === ApplicationCommandType.User;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link MessageContextMenuCommandInteraction}
-   * @returns {boolean}
-   */
+  
   isMessageContextMenuCommand() {
     return this.isContextMenuCommand() && this.commandType === ApplicationCommandType.Message;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link ButtonInteraction}.
-   * @returns {boolean}
-   */
+  
   isButton() {
     return this.type === InteractionType.MessageComponent && this.componentType === ComponentType.Button;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link StringSelectMenuInteraction}.
-   * @returns {boolean}
-   * @deprecated Use {@link BaseInteraction#isStringSelectMenu} instead.
-   */
+  
   isSelectMenu() {
     return this.isStringSelectMenu();
   }
 
-  /**
-   * Indicates whether this interaction is a select menu of any known type.
-   * @returns {boolean}
-   */
+  
   isAnySelectMenu() {
     return this.type === InteractionType.MessageComponent && SelectMenuTypes.includes(this.componentType);
   }
 
-  /**
-   * Indicates whether this interaction is a {@link StringSelectMenuInteraction}.
-   * @returns {boolean}
-   */
+  
   isStringSelectMenu() {
     return this.type === InteractionType.MessageComponent && this.componentType === ComponentType.StringSelect;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link UserSelectMenuInteraction}
-   * @returns {boolean}
-   */
+  
   isUserSelectMenu() {
     return this.type === InteractionType.MessageComponent && this.componentType === ComponentType.UserSelect;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link RoleSelectMenuInteraction}
-   * @returns {boolean}
-   */
+  
   isRoleSelectMenu() {
     return this.type === InteractionType.MessageComponent && this.componentType === ComponentType.RoleSelect;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link ChannelSelectMenuInteraction}
-   * @returns {boolean}
-   */
+  
   isChannelSelectMenu() {
     return this.type === InteractionType.MessageComponent && this.componentType === ComponentType.ChannelSelect;
   }
 
-  /**
-   * Indicates whether this interaction is a {@link MentionableSelectMenuInteraction}
-   * @returns {boolean}
-   */
+  
   isMentionableSelectMenu() {
     return this.type === InteractionType.MessageComponent && this.componentType === ComponentType.MentionableSelect;
   }
 
-  /**
-   * Indicates whether this interaction can be replied to.
-   * @returns {boolean}
-   */
+  
   isRepliable() {
     return ![InteractionType.Ping, InteractionType.ApplicationCommandAutocomplete].includes(this.type);
   }

package/src/structures/BaseSelectMenuComponent.js

@@ -2,52 +2,29 @@
 
 const Component = require('./Component');
 
-/**
- * Represents a select menu component
- * @extends {Component}
- */
+
 class BaseSelectMenuComponent extends Component {
-  /**
-   * The placeholder for this select menu
-   * @type {?string}
-   * @readonly
-   */
+  
   get placeholder() {
     return this.data.placeholder ?? null;
   }
 
-  /**
-   * The maximum amount of options that can be selected
-   * @type {?number}
-   * @readonly
-   */
+  
   get maxValues() {
     return this.data.max_values ?? null;
   }
 
-  /**
-   * The minimum amount of options that must be selected
-   * @type {?number}
-   * @readonly
-   */
+  
   get minValues() {
     return this.data.min_values ?? null;
   }
 
-  /**
-   * The custom id of this select menu
-   * @type {string}
-   * @readonly
-   */
+  
   get customId() {
     return this.data.custom_id;
   }
 
-  /**
-   * Whether this select menu is disabled
-   * @type {boolean}
-   * @readonly
-   */
+  
   get disabled() {
     return this.data.disabled ?? false;
   }

package/src/structures/ButtonBuilder.js

@@ -5,20 +5,13 @@ const { isJSONEncodable } = require('@discordjs/util');
 const { toSnakeCase } = require('../util/Transformers');
 const { resolvePartialEmoji } = require('../util/Util');
 
-/**
- * Represents a button builder.
- * @extends {BuildersButton}
- */
+
 class ButtonBuilder extends BuildersButton {
   constructor({ emoji, ...data } = {}) {
     super(toSnakeCase({ ...data, emoji: emoji && typeof emoji === 'string' ? resolvePartialEmoji(emoji) : emoji }));
   }
 
-  /**
-   * Sets the emoji to display on this button
-   * @param {string|APIMessageComponentEmoji} emoji The emoji to display on this button
-   * @returns {ButtonBuilder}
-   */
+  
   setEmoji(emoji) {
     if (typeof emoji === 'string') {
       return super.setEmoji(resolvePartialEmoji(emoji));
@@ -26,11 +19,7 @@ class ButtonBuilder extends BuildersButton {
     return super.setEmoji(emoji);
   }
 
-  /**
-   * Creates a new button builder from JSON data
-   * @param {ButtonBuilder|ButtonComponent|APIButtonComponent} other The other data
-   * @returns {ButtonBuilder}
-   */
+  
   static from(other) {
     return new this(isJSONEncodable(other) ? other.toJSON() : other);
   }
@@ -38,7 +27,4 @@ class ButtonBuilder extends BuildersButton {
 
 module.exports = ButtonBuilder;
 
-/**
- * @external BuildersButton
- * @see {@link https://discord.js.org/docs/packages/builders/stable/ButtonBuilder:Class}
- */
+