@velliajs/discord 1.0.2 → 1.0.4

package/src/structures/ButtonComponent.js

@@ -2,61 +2,34 @@
 
 const Component = require('./Component');
 
-/**
- * Represents a button component
- * @extends {Component}
- */
+
 class ButtonComponent extends Component {
-  /**
-   * The style of this button
-   * @type {ButtonStyle}
-   * @readonly
-   */
+  
   get style() {
     return this.data.style;
   }
 
-  /**
-   * The label of this button
-   * @type {?string}
-   * @readonly
-   */
+  
   get label() {
     return this.data.label ?? null;
   }
 
-  /**
-   * The emoji used in this button
-   * @type {?APIMessageComponentEmoji}
-   * @readonly
-   */
+  
   get emoji() {
     return this.data.emoji ?? null;
   }
 
-  /**
-   * Whether this button is disabled
-   * @type {boolean}
-   * @readonly
-   */
+  
   get disabled() {
     return this.data.disabled ?? false;
   }
 
-  /**
-   * The custom id of this button (only defined on non-link buttons)
-   * @type {?string}
-   * @readonly
-   */
+  
   get customId() {
     return this.data.custom_id ?? null;
   }
 
-  /**
-   * The URL of this button (only defined on link buttons)
-   * @type {?string}
-   * @readonly
-   */
+  
   get url() {
     return this.data.url ?? null;
   }

package/src/structures/ButtonInteraction.js

@@ -2,10 +2,7 @@
 
 const MessageComponentInteraction = require('./MessageComponentInteraction');
 
-/**
- * Represents a button interaction.
- * @extends {MessageComponentInteraction}
- */
+
 class ButtonInteraction extends MessageComponentInteraction {}
 
 module.exports = ButtonInteraction;

package/src/structures/CategoryChannel.js

@@ -3,40 +3,15 @@
 const GuildChannel = require('./GuildChannel');
 const CategoryChannelChildManager = require('../managers/CategoryChannelChildManager');
 
-/**
- * Represents a guild category channel on Discord.
- * @extends {GuildChannel}
- */
+
 class CategoryChannel extends GuildChannel {
-  /**
-   * The id of the parent of this channel.
-   * @name CategoryChannel#parentId
-   * @type {null}
-   */
+  
 
-  /**
-   * The parent of this channel.
-   * @name CategoryChannel#parent
-   * @type {null}
-   * @readonly
-   */
+  
 
-  /**
-   * Sets the category parent of this channel.
-   * <warn>It is not possible to set the parent of a CategoryChannel.</warn>
-   * @method setParent
-   * @memberof CategoryChannel
-   * @instance
-   * @param {?CategoryChannelResolvable} channel The channel to set as parent
-   * @param {SetParentOptions} [options={}] The options for setting the parent
-   * @returns {Promise<GuildChannel>}
-   */
+  
 
-  /**
-   * A manager of the channels belonging to this category
-   * @type {CategoryChannelChildManager}
-   * @readonly
-   */
+  
   get children() {
     return new CategoryChannelChildManager(this);
   }

package/src/structures/ChannelSelectMenuBuilder.js

@@ -4,20 +4,13 @@ const { ChannelSelectMenuBuilder: BuildersChannelSelectMenu } = require('@discor
 const { isJSONEncodable } = require('@discordjs/util');
 const { toSnakeCase } = require('../util/Transformers');
 
-/**
- * Class used to build select menu components to be sent through the API
- * @extends {BuildersChannelSelectMenu}
- */
+
 class ChannelSelectMenuBuilder extends BuildersChannelSelectMenu {
   constructor(data = {}) {
     super(toSnakeCase(data));
   }
 
-  /**
-   * Creates a new select menu builder from JSON data
-   * @param {ChannelSelectMenuBuilder|ChannelSelectMenuComponent|APIChannelSelectComponent} other The other data
-   * @returns {ChannelSelectMenuBuilder}
-   */
+  
   static from(other) {
     return new this(isJSONEncodable(other) ? other.toJSON() : other);
   }
@@ -25,7 +18,4 @@ class ChannelSelectMenuBuilder extends BuildersChannelSelectMenu {
 
 module.exports = ChannelSelectMenuBuilder;
 
-/**
- * @external BuildersChannelSelectMenu
- * @see {@link https://discord.js.org/docs/packages/builders/stable/ChannelSelectMenuBuilder:Class}
- */
+

package/src/structures/ChannelSelectMenuComponent.js

@@ -2,16 +2,9 @@
 
 const BaseSelectMenuComponent = require('./BaseSelectMenuComponent');
 
-/**
- * Represents a channel select menu component
- * @extends {BaseSelectMenuComponent}
- */
+
 class ChannelSelectMenuComponent extends BaseSelectMenuComponent {
-  /**
-   * The options in this select menu
-   * @type {?(ChannelType[])}
-   * @readonly
-   */
+  
   get channelTypes() {
     return this.data.channel_types ?? null;
   }

package/src/structures/ChannelSelectMenuInteraction.js

@@ -3,25 +3,16 @@
 const { Collection } = require('@discordjs/collection');
 const MessageComponentInteraction = require('./MessageComponentInteraction');
 
-/**
- * Represents a {@link ComponentType.ChannelSelect} select menu interaction.
- * @extends {MessageComponentInteraction}
- */
+
 class ChannelSelectMenuInteraction extends MessageComponentInteraction {
   constructor(client, data) {
     super(client, data);
     const { resolved, values } = data.data;
 
-    /**
-     * An array of the selected channel ids
-     * @type {Snowflake[]}
-     */
+    
     this.values = values ?? [];
 
-    /**
-     * Collection of the selected channels
-     * @type {Collection<Snowflake, Channel|APIChannel>}
-     */
+    
     this.channels = new Collection();
 
     for (const channel of Object.values(resolved?.channels ?? {})) {

package/src/structures/ChatInputCommandInteraction.js

@@ -3,18 +3,12 @@
 const CommandInteraction = require('./CommandInteraction');
 const CommandInteractionOptionResolver = require('./CommandInteractionOptionResolver');
 
-/**
- * Represents a command interaction.
- * @extends {CommandInteraction}
- */
+
 class ChatInputCommandInteraction extends CommandInteraction {
   constructor(client, data) {
     super(client, data);
 
-    /**
-     * The options passed to the command.
-     * @type {CommandInteractionOptionResolver}
-     */
+    
     this.options = new CommandInteractionOptionResolver(
       this.client,
       data.data.options?.map(option => this.transformOption(option, data.data.resolved)) ?? [],
@@ -22,11 +16,7 @@ class ChatInputCommandInteraction extends CommandInteraction {
     );
   }
 
-  /**
-   * Returns a string representation of the command interaction.
-   * This can then be copied by a user and executed again in a new command while keeping the option order.
-   * @returns {string}
-   */
+  
   toString() {
     const properties = [
       this.commandName,

package/src/structures/ClientApplication.js

@@ -8,41 +8,25 @@ const ApplicationCommandManager = require('../managers/ApplicationCommandManager
 const ApplicationFlagsBitField = require('../util/ApplicationFlagsBitField');
 const PermissionsBitField = require('../util/PermissionsBitField');
 
-/**
- * @typedef {Object} ClientApplicationInstallParams
- * @property {OAuth2Scopes[]} scopes The scopes to add the application to the server with
- * @property {Readonly<PermissionsBitField>} permissions The permissions this bot will request upon joining
- */
-
-/**
- * Represents a Client OAuth2 Application.
- * @extends {Application}
- */
+
+
+
 class ClientApplication extends Application {
   constructor(client, data) {
     super(client, data);
 
-    /**
-     * The application command manager for this application
-     * @type {ApplicationCommandManager}
-     */
+    
     this.commands = new ApplicationCommandManager(this.client);
   }
 
   _patch(data) {
     super._patch(data);
 
-    /**
-     * The tags this application has (max of 5)
-     * @type {string[]}
-     */
+    
     this.tags = data.tags ?? [];
 
     if ('install_params' in data) {
-      /**
-       * Settings for this application's default in-app authorization
-       * @type {?ClientApplicationInstallParams}
-       */
+      
       this.installParams = {
         scopes: data.install_params.scopes,
         permissions: new PermissionsBitField(data.install_params.permissions).freeze(),
@@ -52,77 +36,53 @@ class ClientApplication extends Application {
     }
 
     if ('custom_install_url' in data) {
-      /**
-       * This application's custom installation URL
-       * @type {?string}
-       */
+      
       this.customInstallURL = data.custom_install_url;
     } else {
       this.customInstallURL = null;
     }
 
     if ('flags' in data) {
-      /**
-       * The flags this application has
-       * @type {ApplicationFlagsBitField}
-       */
+      
       this.flags = new ApplicationFlagsBitField(data.flags).freeze();
     }
 
     if ('cover_image' in data) {
-      /**
-       * The hash of the application's cover image
-       * @type {?string}
-       */
+      
       this.cover = data.cover_image;
     } else {
       this.cover ??= null;
     }
 
     if ('rpc_origins' in data) {
-      /**
-       * The application's RPC origins, if enabled
-       * @type {string[]}
-       */
+      
       this.rpcOrigins = data.rpc_origins;
     } else {
       this.rpcOrigins ??= [];
     }
 
     if ('bot_require_code_grant' in data) {
-      /**
-       * If this application's bot requires a code grant when using the OAuth2 flow
-       * @type {?boolean}
-       */
+      
       this.botRequireCodeGrant = data.bot_require_code_grant;
     } else {
       this.botRequireCodeGrant ??= null;
     }
 
     if ('bot_public' in data) {
-      /**
-       * If this application's bot is public
-       * @type {?boolean}
-       */
+      
       this.botPublic = data.bot_public;
     } else {
       this.botPublic ??= null;
     }
 
     if ('role_connections_verification_url' in data) {
-      /**
-       * This application's role connection verification entry point URL
-       * @type {?string}
-       */
+      
       this.roleConnectionsVerificationURL = data.role_connections_verification_url;
     } else {
       this.roleConnectionsVerificationURL ??= null;
     }
 
-    /**
-     * The owner of this OAuth application
-     * @type {?(User|Team)}
-     */
+    
     this.owner = data.team
       ? new Team(this.client, data.team)
       : data.owner
@@ -130,50 +90,27 @@ class ClientApplication extends Application {
       : this.owner ?? null;
   }
 
-  /**
-   * Whether this application is partial
-   * @type {boolean}
-   * @readonly
-   */
+  
   get partial() {
     return !this.name;
   }
 
-  /**
-   * Obtains this application from Discord.
-   * @returns {Promise<ClientApplication>}
-   */
+  
   async fetch() {
     const app = await this.client.rest.get(Routes.oauth2CurrentApplication());
     this._patch(app);
     return this;
   }
 
-  /**
-   * Gets this application's role connection metadata records
-   * @returns {Promise<ApplicationRoleConnectionMetadata[]>}
-   */
+  
   async fetchRoleConnectionMetadataRecords() {
     const metadata = await this.client.rest.get(Routes.applicationRoleConnectionMetadata(this.client.user.id));
     return metadata.map(data => new ApplicationRoleConnectionMetadata(data));
   }
 
-  /**
-   * Data for creating or editing an application role connection metadata.
-   * @typedef {Object} ApplicationRoleConnectionMetadataEditOptions
-   * @property {string} name The name of the metadata field
-   * @property {?Object<Locale, string>} [nameLocalizations] The name localizations for the metadata field
-   * @property {string} description The description of the metadata field
-   * @property {?Object<Locale, string>} [descriptionLocalizations] The description localizations for the metadata field
-   * @property {string} key The dictionary key of the metadata field
-   * @property {ApplicationRoleConnectionMetadataType} type The type of the metadata field
-   */
-
-  /**
-   * Updates this application's role connection metadata records
-   * @param {ApplicationRoleConnectionMetadataEditOptions[]} records The new role connection metadata records
-   * @returns {Promise<ApplicationRoleConnectionMetadata[]>}
-   */
+  
+
+  
   async editRoleConnectionMetadataRecords(records) {
     const newRecords = await this.client.rest.put(Routes.applicationRoleConnectionMetadata(this.client.user.id), {
       body: records.map(record => ({

package/src/structures/ClientPresence.js

@@ -4,20 +4,13 @@ const { GatewayOpcodes } = require('discord-api-types/v10');
 const { Presence } = require('./Presence');
 const { DiscordjsTypeError, ErrorCodes } = require('../errors');
 
-/**
- * Represents the client's presence.
- * @extends {Presence}
- */
+
 class ClientPresence extends Presence {
   constructor(client, data = {}) {
     super(client, Object.assign(data, { status: data.status ?? 'online', user: { id: null } }));
   }
 
-  /**
-   * Sets the client's presence
-   * @param {PresenceData} presence The data to set the presence to
-   * @returns {ClientPresence}
-   */
+  
   set(presence) {
     const packet = this._parse(presence);
     this._patch(packet);
@@ -33,12 +26,7 @@ class ClientPresence extends Presence {
     return this;
   }
 
-  /**
-   * Parses presence data into a packet ready to be sent to Discord
-   * @param {PresenceData} presence The data to parse
-   * @returns {APIPresence}
-   * @private
-   */
+  
   _parse({ status, since, afk, activities }) {
     const data = {
       activities: [],
@@ -75,8 +63,5 @@ class ClientPresence extends Presence {
 
 module.exports = ClientPresence;
 
-/* eslint-disable max-len */
-/**
- * @external APIPresence
- * @see {@link https://discord.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields}
- */
+
+

package/src/structures/ClientUser.js

@@ -4,27 +4,18 @@ const { Routes } = require('discord-api-types/v10');
 const User = require('./User');
 const DataResolver = require('../util/DataResolver');
 
-/**
- * Represents the logged in client's Discord user.
- * @extends {User}
- */
+
 class ClientUser extends User {
   _patch(data) {
     super._patch(data);
 
     if ('verified' in data) {
-      /**
-       * Whether or not this account has been verified
-       * @type {boolean}
-       */
+      
       this.verified = data.verified;
     }
 
     if ('mfa_enabled' in data) {
-      /**
-       * If the bot's {@link ClientApplication#owner Owner} has MFA enabled on their account
-       * @type {?boolean}
-       */
+      
       this.mfaEnabled = typeof data.mfa_enabled === 'boolean' ? data.mfa_enabled : null;
     } else {
       this.mfaEnabled ??= null;
@@ -33,27 +24,14 @@ class ClientUser extends User {
     if ('token' in data) this.client.token = data.token;
   }
 
-  /**
-   * Represents the client user's presence
-   * @type {ClientPresence}
-   * @readonly
-   */
+  
   get presence() {
     return this.client.presence;
   }
 
-  /**
-   * Data used to edit the logged in client
-   * @typedef {Object} ClientUserEditOptions
-   * @property {string} [username] The new username
-   * @property {?(BufferResolvable|Base64Resolvable)} [avatar] The new avatar
-   */
-
-  /**
-   * Edits the logged in client.
-   * @param {ClientUserEditOptions} options The options to provide
-   * @returns {Promise<ClientUser>}
-   */
+  
+
+  
   async edit({ username, avatar }) {
     const data = await this.client.rest.patch(Routes.user(), {
       body: { username, avatar: avatar && (await DataResolver.resolveImage(avatar)) },
@@ -65,105 +43,35 @@ class ClientUser extends User {
     return updated ?? this;
   }
 
-  /**
-   * Sets the username of the logged in client.
-   * <info>Changing usernames in Discord is heavily rate limited, with only 2 requests
-   * every hour. Use this sparingly!</info>
-   * @param {string} username The new username
-   * @returns {Promise<ClientUser>}
-   * @example
-   * // Set username
-   * client.user.setUsername('discordjs')
-   *   .then(user => console.log(`My new username is ${user.username}`))
-   *   .catch(console.error);
-   */
+  
   setUsername(username) {
     return this.edit({ username });
   }
 
-  /**
-   * Sets the avatar of the logged in client.
-   * @param {?(BufferResolvable|Base64Resolvable)} avatar The new avatar
-   * @returns {Promise<ClientUser>}
-   * @example
-   * // Set avatar
-   * client.user.setAvatar('./avatar.png')
-   *   .then(user => console.log(`New avatar set!`))
-   *   .catch(console.error);
-   */
+  
   setAvatar(avatar) {
     return this.edit({ avatar });
   }
 
-  /**
-   * Options for setting activities
-   * @typedef {Object} ActivitiesOptions
-   * @property {string} [name] Name of the activity
-   * @property {ActivityType} [type] Type of the activity
-   * @property {string} [url] Twitch / YouTube stream URL
-   */
-
-  /**
-   * Data resembling a raw Discord presence.
-   * @typedef {Object} PresenceData
-   * @property {PresenceStatusData} [status] Status of the user
-   * @property {boolean} [afk] Whether the user is AFK
-   * @property {ActivitiesOptions[]} [activities] Activity the user is playing
-   * @property {number|number[]} [shardId] Shard id(s) to have the activity set on
-   */
-
-  /**
-   * Sets the full presence of the client user.
-   * @param {PresenceData} data Data for the presence
-   * @returns {ClientPresence}
-   * @example
-   * // Set the client user's presence
-   * client.user.setPresence({ activities: [{ name: 'with discord.js' }], status: 'idle' });
-   */
+  
+
+  
+
+  
   setPresence(data) {
     return this.client.presence.set(data);
   }
 
-  /**
-   * A user's status. Must be one of:
-   * * `online`
-   * * `idle`
-   * * `invisible`
-   * * `dnd` (do not disturb)
-   * @typedef {string} PresenceStatusData
-   */
-
-  /**
-   * Sets the status of the client user.
-   * @param {PresenceStatusData} status Status to change to
-   * @param {number|number[]} [shardId] Shard id(s) to have the activity set on
-   * @returns {ClientPresence}
-   * @example
-   * // Set the client user's status
-   * client.user.setStatus('idle');
-   */
+  
+
+  
   setStatus(status, shardId) {
     return this.setPresence({ status, shardId });
   }
 
-  /**
-   * Options for setting an activity.
-   * @typedef {Object} ActivityOptions
-   * @property {string} [name] Name of the activity
-   * @property {string} [url] Twitch / YouTube stream URL
-   * @property {ActivityType} [type] Type of the activity
-   * @property {number|number[]} [shardId] Shard Id(s) to have the activity set on
-   */
-
-  /**
-   * Sets the activity the client user is playing.
-   * @param {string|ActivityOptions} [name] Activity being played, or options for setting the activity
-   * @param {ActivityOptions} [options] Options for setting the activity
-   * @returns {ClientPresence}
-   * @example
-   * // Set the client user's activity
-   * client.user.setActivity('discord.js', { type: ActivityType.Watching });
-   */
+  
+
+  
   setActivity(name, options = {}) {
     if (!name) return this.setPresence({ activities: [], shardId: options.shardId });
 
@@ -171,12 +79,7 @@ class ClientUser extends User {
     return this.setPresence({ activities: [activity], shardId: activity.shardId });
   }
 
-  /**
-   * Sets/removes the AFK flag for the client user.
-   * @param {boolean} [afk=true] Whether or not the user is AFK
-   * @param {number|number[]} [shardId] Shard Id(s) to have the AFK flag set on
-   * @returns {ClientPresence}
-   */
+  
   setAFK(afk = true, shardId) {
     return this.setPresence({ afk, shardId });
   }