@velliajs/discord 1.0.3 → 1.0.4

package/src/structures/Role.js

@@ -6,94 +6,58 @@ const Base = require('./Base');
 const { DiscordjsError, ErrorCodes } = require('../errors');
 const PermissionsBitField = require('../util/PermissionsBitField');
 
-/**
- * Represents a role on Discord.
- * @extends {Base}
- */
+
 class Role extends Base {
   constructor(client, data, guild) {
     super(client);
 
-    /**
-     * The guild that the role belongs to
-     * @type {Guild}
-     */
+    
     this.guild = guild;
 
-    /**
-     * The icon hash of the role
-     * @type {?string}
-     */
+    
     this.icon = null;
 
-    /**
-     * The unicode emoji for the role
-     * @type {?string}
-     */
+    
     this.unicodeEmoji = null;
 
     if (data) this._patch(data);
   }
 
   _patch(data) {
-    /**
-     * The role's id (unique to the guild it is part of)
-     * @type {Snowflake}
-     */
+    
     this.id = data.id;
     if ('name' in data) {
-      /**
-       * The name of the role
-       * @type {string}
-       */
+      
       this.name = data.name;
     }
 
     if ('color' in data) {
-      /**
-       * The base 10 color of the role
-       * @type {number}
-       */
+      
       this.color = data.color;
     }
 
     if ('hoist' in data) {
-      /**
-       * If true, users that are part of this role will appear in a separate category in the users list
-       * @type {boolean}
-       */
+      
       this.hoist = data.hoist;
     }
 
     if ('position' in data) {
-      /**
-       * The raw position of the role from the API
-       * @type {number}
-       */
+      
       this.rawPosition = data.position;
     }
 
     if ('permissions' in data) {
-      /**
-       * The permissions of the role
-       * @type {Readonly<PermissionsBitField>}
-       */
+      
       this.permissions = new PermissionsBitField(BigInt(data.permissions)).freeze();
     }
 
     if ('managed' in data) {
-      /**
-       * Whether or not the role is managed by an external service
-       * @type {boolean}
-       */
+      
       this.managed = data.managed;
     }
 
     if ('mentionable' in data) {
-      /**
-       * Whether or not the role can be mentioned by anyone
-       * @type {boolean}
-       */
+      
       this.mentionable = data.mentionable;
     }
 
@@ -101,16 +65,7 @@ class Role extends Base {
 
     if ('unicode_emoji' in data) this.unicodeEmoji = data.unicode_emoji;
 
-    /**
-     * The tags this role has
-     * @type {?Object}
-     * @property {Snowflake} [botId] The id of the bot this role belongs to
-     * @property {Snowflake|string} [integrationId] The id of the integration this role belongs to
-     * @property {true} [premiumSubscriberRole] Whether this is the guild's premium subscription role
-     * @property {Snowflake} [subscriptionListingId] The id of this role's subscription SKU and listing
-     * @property {true} [availableForPurchase] Whether this role is available for purchase
-     * @property {true} [guildConnections] Whether this role is a guild's linked role
-     */
+    
     this.tags = data.tags ? {} : null;
     if (data.tags) {
       if ('bot_id' in data.tags) {
@@ -134,47 +89,27 @@ class Role extends Base {
     }
   }
 
-  /**
-   * The timestamp the role was created at
-   * @type {number}
-   * @readonly
-   */
+  
   get createdTimestamp() {
     return DiscordSnowflake.timestampFrom(this.id);
   }
 
-  /**
-   * The time the role was created at
-   * @type {Date}
-   * @readonly
-   */
+  
   get createdAt() {
     return new Date(this.createdTimestamp);
   }
 
-  /**
-   * The hexadecimal version of the role color, with a leading hashtag
-   * @type {string}
-   * @readonly
-   */
+  
   get hexColor() {
     return `#${this.color.toString(16).padStart(6, '0')}`;
   }
 
-  /**
-   * The cached guild members that have this role
-   * @type {Collection<Snowflake, GuildMember>}
-   * @readonly
-   */
+  
   get members() {
     return this.guild.members.cache.filter(m => m.roles.cache.has(this.id));
   }
 
-  /**
-   * Whether the role is editable by the client user
-   * @type {boolean}
-   * @readonly
-   */
+  
   get editable() {
     if (this.managed) return false;
     const clientMember = this.guild.members.resolve(this.client.user);
@@ -182,11 +117,7 @@ class Role extends Base {
     return clientMember.roles.highest.comparePositionTo(this) > 0;
   }
 
-  /**
-   * The position of the role in the role manager
-   * @type {number}
-   * @readonly
-   */
+  
   get position() {
     return this.guild.roles.cache.reduce(
       (acc, role) =>
@@ -198,223 +129,79 @@ class Role extends Base {
     );
   }
 
-  /**
-   * Compares this role's position to another role's.
-   * @param {RoleResolvable} role Role to compare to this one
-   * @returns {number} Negative number if this role's position is lower (other role's is higher),
-   * positive number if this one is higher (other's is lower), 0 if equal
-   * @example
-   * // Compare the position of a role to another
-   * const roleCompare = role.comparePositionTo(otherRole);
-   * if (roleCompare >= 1) console.log(`${role.name} is higher than ${otherRole.name}`);
-   */
+  
   comparePositionTo(role) {
     return this.guild.roles.comparePositions(this, role);
   }
 
-  /**
-   * The data for a role.
-   * @typedef {Object} RoleData
-   * @property {string} [name] The name of the role
-   * @property {ColorResolvable} [color] The color of the role, either a hex string or a base 10 number
-   * @property {boolean} [hoist] Whether or not the role should be hoisted
-   * @property {number} [position] The position of the role
-   * @property {PermissionResolvable} [permissions] The permissions of the role
-   * @property {boolean} [mentionable] Whether or not the role should be mentionable
-   * @property {?(BufferResolvable|Base64Resolvable|EmojiResolvable)} [icon] The icon for the role
-   * <warn>The `EmojiResolvable` should belong to the same guild as the role.
-   * If not, pass the emoji's URL directly</warn>
-   * @property {?string} [unicodeEmoji] The unicode emoji for the role
-   */
-
-  /**
-   * Edits the role.
-   * @param {RoleEditOptions} options The options to provide
-   * @returns {Promise<Role>}
-   * @example
-   * // Edit a role
-   * role.edit({ name: 'new role' })
-   *   .then(updated => console.log(`Edited role name to ${updated.name}`))
-   *   .catch(console.error);
-   */
+  
+
+  
   edit(options) {
     return this.guild.roles.edit(this, options);
   }
 
-  /**
-   * Returns `channel.permissionsFor(role)`. Returns permissions for a role in a guild channel,
-   * taking into account permission overwrites.
-   * @param {GuildChannel|Snowflake} channel The guild channel to use as context
-   * @param {boolean} [checkAdmin=true] Whether having the {@link PermissionFlagsBits.Administrator} permission
-   * will return all permissions
-   * @returns {Readonly<PermissionsBitField>}
-   */
+  
   permissionsIn(channel, checkAdmin = true) {
     channel = this.guild.channels.resolve(channel);
     if (!channel) throw new DiscordjsError(ErrorCodes.GuildChannelResolve);
     return channel.rolePermissions(this, checkAdmin);
   }
 
-  /**
-   * Sets a new name for the role.
-   * @param {string} name The new name of the role
-   * @param {string} [reason] Reason for changing the role's name
-   * @returns {Promise<Role>}
-   * @example
-   * // Set the name of the role
-   * role.setName('new role')
-   *   .then(updated => console.log(`Updated role name to ${updated.name}`))
-   *   .catch(console.error);
-   */
+  
   setName(name, reason) {
     return this.edit({ name, reason });
   }
 
-  /**
-   * Sets a new color for the role.
-   * @param {ColorResolvable} color The color of the role
-   * @param {string} [reason] Reason for changing the role's color
-   * @returns {Promise<Role>}
-   * @example
-   * // Set the color of a role
-   * role.setColor('#FF0000')
-   *   .then(updated => console.log(`Set color of role to ${updated.color}`))
-   *   .catch(console.error);
-   */
+  
   setColor(color, reason) {
     return this.edit({ color, reason });
   }
 
-  /**
-   * Sets whether or not the role should be hoisted.
-   * @param {boolean} [hoist=true] Whether or not to hoist the role
-   * @param {string} [reason] Reason for setting whether or not the role should be hoisted
-   * @returns {Promise<Role>}
-   * @example
-   * // Set the hoist of the role
-   * role.setHoist(true)
-   *   .then(updated => console.log(`Role hoisted: ${updated.hoist}`))
-   *   .catch(console.error);
-   */
+  
   setHoist(hoist = true, reason) {
     return this.edit({ hoist, reason });
   }
 
-  /**
-   * Sets the permissions of the role.
-   * @param {PermissionResolvable} permissions The permissions of the role
-   * @param {string} [reason] Reason for changing the role's permissions
-   * @returns {Promise<Role>}
-   * @example
-   * // Set the permissions of the role
-   * role.setPermissions([PermissionFlagsBits.KickMembers, PermissionFlagsBits.BanMembers])
-   *   .then(updated => console.log(`Updated permissions to ${updated.permissions.bitfield}`))
-   *   .catch(console.error);
-   * @example
-   * // Remove all permissions from a role
-   * role.setPermissions(0n)
-   *   .then(updated => console.log(`Updated permissions to ${updated.permissions.bitfield}`))
-   *   .catch(console.error);
-   */
+  
   setPermissions(permissions, reason) {
     return this.edit({ permissions, reason });
   }
 
-  /**
-   * Sets whether this role is mentionable.
-   * @param {boolean} [mentionable=true] Whether this role should be mentionable
-   * @param {string} [reason] Reason for setting whether or not this role should be mentionable
-   * @returns {Promise<Role>}
-   * @example
-   * // Make the role mentionable
-   * role.setMentionable(true)
-   *   .then(updated => console.log(`Role updated ${updated.name}`))
-   *   .catch(console.error);
-   */
+  
   setMentionable(mentionable = true, reason) {
     return this.edit({ mentionable, reason });
   }
 
-  /**
-   * Sets a new icon for the role.
-   * @param {?(BufferResolvable|Base64Resolvable|EmojiResolvable)} icon The icon for the role
-   * <warn>The `EmojiResolvable` should belong to the same guild as the role.
-   * If not, pass the emoji's URL directly</warn>
-   * @param {string} [reason] Reason for changing the role's icon
-   * @returns {Promise<Role>}
-   */
+  
   setIcon(icon, reason) {
     return this.edit({ icon, reason });
   }
 
-  /**
-   * Sets a new unicode emoji for the role.
-   * @param {?string} unicodeEmoji The new unicode emoji for the role
-   * @param {string} [reason] Reason for changing the role's unicode emoji
-   * @returns {Promise<Role>}
-   * @example
-   * // Set a new unicode emoji for the role
-   * role.setUnicodeEmoji('🤖')
-   *   .then(updated => console.log(`Set unicode emoji for the role to ${updated.unicodeEmoji}`))
-   *   .catch(console.error);
-   */
+  
   setUnicodeEmoji(unicodeEmoji, reason) {
     return this.edit({ unicodeEmoji, reason });
   }
 
-  /**
-   * Options used to set the position of a role.
-   * @typedef {Object} SetRolePositionOptions
-   * @property {boolean} [relative=false] Whether to change the position relative to its current value or not
-   * @property {string} [reason] The reason for changing the position
-   */
-
-  /**
-   * Sets the new position of the role.
-   * @param {number} position The new position for the role
-   * @param {SetRolePositionOptions} [options] Options for setting the position
-   * @returns {Promise<Role>}
-   * @example
-   * // Set the position of the role
-   * role.setPosition(1)
-   *   .then(updated => console.log(`Role position: ${updated.position}`))
-   *   .catch(console.error);
-   */
+  
+
+  
   setPosition(position, options = {}) {
     return this.guild.roles.setPosition(this, position, options);
   }
 
-  /**
-   * Deletes the role.
-   * @param {string} [reason] Reason for deleting this role
-   * @returns {Promise<Role>}
-   * @example
-   * // Delete a role
-   * role.delete('The role needed to go')
-   *   .then(deleted => console.log(`Deleted role ${deleted.name}`))
-   *   .catch(console.error);
-   */
+  
   async delete(reason) {
     await this.guild.roles.delete(this.id, reason);
     return this;
   }
 
-  /**
-   * A link to the role's icon
-   * @param {ImageURLOptions} [options={}] Options for the image URL
-   * @returns {?string}
-   */
+  
   iconURL(options = {}) {
     return this.icon && this.client.rest.cdn.roleIcon(this.id, this.icon, options);
   }
 
-  /**
-   * Whether this role equals another role. It compares all properties, so for most operations
-   * it is advisable to just compare `role.id === role2.id` as it is much faster and is often
-   * what most users need.
-   * @param {Role} role Role to compare with
-   * @returns {boolean}
-   */
+  
   equals(role) {
     return (
       role &&
@@ -430,13 +217,7 @@ class Role extends Base {
     );
   }
 
-  /**
-   * When concatenated with a string, this automatically returns the role's mention instead of the Role object.
-   * @returns {string}
-   * @example
-   * // Logs: Role: <@&123456789012345678>
-   * console.log(`Role: ${role}`);
-   */
+  
   toString() {
     if (this.id === this.guild.id) return '@everyone';
     return `<@&${this.id}>`;
@@ -452,7 +233,4 @@ class Role extends Base {
 
 exports.Role = Role;
 
-/**
- * @external APIRole
- * @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
- */
+

package/src/structures/RoleSelectMenuBuilder.js

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

package/src/structures/RoleSelectMenuComponent.js

@@ -2,10 +2,7 @@
 
 const BaseSelectMenuComponent = require('./BaseSelectMenuComponent');
 
-/**
- * Represents a role select menu component
- * @extends {BaseSelectMenuComponent}
- */
+
 class RoleSelectMenuComponent extends BaseSelectMenuComponent {}
 
 module.exports = RoleSelectMenuComponent;

package/src/structures/RoleSelectMenuInteraction.js

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

package/src/structures/SelectMenuBuilder.js

@@ -5,10 +5,7 @@ const StringSelectMenuBuilder = require('./StringSelectMenuBuilder');
 
 let deprecationEmitted = false;
 
-/**
- * @deprecated Use {@link StringSelectMenuBuilder} instead.
- * @extends {StringSelectMenuBuilder}
- */
+
 class SelectMenuBuilder extends StringSelectMenuBuilder {
   constructor(...params) {
     super(...params);

package/src/structures/SelectMenuComponent.js

@@ -5,10 +5,7 @@ const StringSelectMenuComponent = require('./StringSelectMenuComponent');
 
 let deprecationEmitted = false;
 
-/**
- * @deprecated Use {@link StringSelectMenuComponent} instead.
- * @extends {StringSelectMenuComponent}
- */
+
 class SelectMenuComponent extends StringSelectMenuComponent {
   constructor(...params) {
     super(...params);

package/src/structures/SelectMenuInteraction.js

@@ -5,10 +5,7 @@ const StringSelectMenuInteraction = require('./StringSelectMenuInteraction');
 
 let deprecationEmitted = false;
 
-/**
- * @deprecated Use {@link StringSelectMenuInteraction} instead.
- * @extends {StringSelectMenuInteraction}
- */
+
 class SelectMenuInteraction extends StringSelectMenuInteraction {
   constructor(...params) {
     super(...params);

package/src/structures/SelectMenuOptionBuilder.js

@@ -5,10 +5,7 @@ const StringSelectMenuOptionBuilder = require('./StringSelectMenuOptionBuilder')
 
 let deprecationEmitted = false;
 
-/**
- * @deprecated Use {@link StringSelectMenuOptionBuilder} instead.
- * @extends {StringSelectMenuOptionBuilder}
- */
+
 class SelectMenuOptionBuilder extends StringSelectMenuOptionBuilder {
   constructor(...params) {
     super(...params);