@velliajs/discord 1.0.2 → 1.0.4

package/src/structures/MessageReaction.js

@@ -6,35 +6,19 @@ const ReactionEmoji = require('./ReactionEmoji');
 const ReactionUserManager = require('../managers/ReactionUserManager');
 const { flatten } = require('../util/Util');
 
-/**
- * Represents a reaction to a message.
- */
+
 class MessageReaction {
   constructor(client, data, message) {
-    /**
-     * The client that instantiated this message reaction
-     * @name MessageReaction#client
-     * @type {Client}
-     * @readonly
-     */
+    
     Object.defineProperty(this, 'client', { value: client });
 
-    /**
-     * The message that this reaction refers to
-     * @type {Message}
-     */
+    
     this.message = message;
 
-    /**
-     * Whether the client has given this reaction
-     * @type {boolean}
-     */
+    
     this.me = data.me;
 
-    /**
-     * A manager of the users that have given this reaction
-     * @type {ReactionUserManager}
-     */
+    
     this.users = new ReactionUserManager(this, this.me ? [client.user] : []);
 
     this._emoji = new ReactionEmoji(this, data.emoji);
@@ -44,26 +28,17 @@ class MessageReaction {
 
   _patch(data) {
     if ('count' in data) {
-      /**
-       * The number of people that have given the same reaction
-       * @type {?number}
-       */
+      
       this.count ??= data.count;
     }
   }
 
-  /**
-   * Makes the client user react with this reaction
-   * @returns {Promise<MessageReaction>}
-   */
+  
   react() {
     return this.message.react(this.emoji);
   }
 
-  /**
-   * Removes all users from this reaction.
-   * @returns {Promise<MessageReaction>}
-   */
+  
   async remove() {
     await this.client.rest.delete(
       Routes.channelMessageReaction(this.message.channelId, this.message.id, this._emoji.identifier),
@@ -71,16 +46,10 @@ class MessageReaction {
     return this;
   }
 
-  /**
-   * The emoji of this reaction. Either a {@link GuildEmoji} object for known custom emojis, or a {@link ReactionEmoji}
-   * object which has fewer properties. Whatever the prototype of the emoji, it will still have
-   * `name`, `id`, `identifier` and `toString()`
-   * @type {GuildEmoji|ReactionEmoji}
-   * @readonly
-   */
+  
   get emoji() {
     if (this._emoji instanceof GuildEmoji) return this._emoji;
-    // Check to see if the emoji has become known to the client
+    
     if (this._emoji.id) {
       const emojis = this.message.client.emojis.cache;
       if (emojis.has(this._emoji.id)) {
@@ -92,23 +61,16 @@ class MessageReaction {
     return this._emoji;
   }
 
-  /**
-   * Whether or not this reaction is a partial
-   * @type {boolean}
-   * @readonly
-   */
+  
   get partial() {
     return this.count === null;
   }
 
-  /**
-   * Fetch this reaction.
-   * @returns {Promise<MessageReaction>}
-   */
+  
   async fetch() {
     const message = await this.message.fetch();
     const existing = message.reactions.cache.get(this.emoji.id ?? this.emoji.name);
-    // The reaction won't get set when it has been completely removed
+    
     this._patch(existing ?? { count: 0 });
     return this;
   }

package/src/structures/ModalBuilder.js

@@ -4,10 +4,7 @@ const { ModalBuilder: BuildersModal, ComponentBuilder } = require('@discordjs/bu
 const { isJSONEncodable } = require('@discordjs/util');
 const { toSnakeCase } = require('../util/Transformers');
 
-/**
- * Represents a modal builder.
- * @extends {BuildersModal}
- */
+
 class ModalBuilder extends BuildersModal {
   constructor({ components, ...data } = {}) {
     super({
@@ -16,11 +13,7 @@ class ModalBuilder extends BuildersModal {
     });
   }
 
-  /**
-   * Creates a new modal builder from JSON data
-   * @param {ModalBuilder|APIModalComponent} other The other data
-   * @returns {ModalBuilder}
-   */
+  
   static from(other) {
     return new this(isJSONEncodable(other) ? other.toJSON() : other);
   }
@@ -28,7 +21,4 @@ class ModalBuilder extends BuildersModal {
 
 module.exports = ModalBuilder;
 
-/**
- * @external BuildersModal
- * @see {@link https://discord.js.org/docs/packages/builders/stable/ModalBuilder:Class}
- */
+

package/src/structures/ModalSubmitFields.js

@@ -4,33 +4,20 @@ const { Collection } = require('@discordjs/collection');
 const { ComponentType } = require('discord-api-types/v10');
 const { DiscordjsTypeError, ErrorCodes } = require('../errors');
 
-/**
- * Represents the serialized fields from a modal submit interaction
- */
+
 class ModalSubmitFields {
   constructor(components) {
-    /**
-     * The components within the modal
-     * @type {ActionRowModalData[]}
-     */
+    
     this.components = components;
 
-    /**
-     * The extracted fields from the modal
-     * @type {Collection<string, ModalData>}
-     */
+    
     this.fields = components.reduce((accumulator, next) => {
       next.components.forEach(c => accumulator.set(c.customId, c));
       return accumulator;
     }, new Collection());
   }
 
-  /**
-   * Gets a field given a custom id from a component
-   * @param {string} customId The custom id of the component
-   * @param {ComponentType} [type] The type of the component
-   * @returns {ModalData}
-   */
+  
   getField(customId, type) {
     const field = this.fields.get(customId);
     if (!field) throw new DiscordjsTypeError(ErrorCodes.ModalSubmitInteractionFieldNotFound, customId);
@@ -42,11 +29,7 @@ class ModalSubmitFields {
     return field;
   }
 
-  /**
-   * Gets the value of a text input component given a custom id
-   * @param {string} customId The custom id of the text input component
-   * @returns {string}
-   */
+  
   getTextInputValue(customId) {
     return this.getField(customId, ComponentType.TextInput).value;
   }

package/src/structures/ModalSubmitInteraction.js

@@ -8,85 +8,44 @@ const InteractionResponses = require('./interfaces/InteractionResponses');
 
 const getMessage = lazy(() => require('./Message').Message);
 
-/**
- * @typedef {Object} ModalData
- * @property {string} value The value of the field
- * @property {ComponentType} type The component type of the field
- * @property {string} customId The custom id of the field
- */
-
-/**
- * @typedef {Object} ActionRowModalData
- * @property {ModalData[]} components The components of this action row
- * @property {ComponentType} type The component type of the action row
- */
-
-/**
- * Represents a modal interaction
- * @extends {BaseInteraction}
- * @implements {InteractionResponses}
- */
+
+
+
+
+
 class ModalSubmitInteraction extends BaseInteraction {
   constructor(client, data) {
     super(client, data);
-    /**
-     * The custom id of the modal.
-     * @type {string}
-     */
+    
     this.customId = data.data.custom_id;
 
     if ('message' in data) {
-      /**
-       * The message associated with this interaction
-       * @type {?Message}
-       */
+      
       this.message = this.channel?.messages._add(data.message) ?? new (getMessage())(this.client, data.message);
     } else {
       this.message = null;
     }
 
-    /**
-     * The components within the modal
-     * @type {ActionRowModalData[]}
-     */
+    
     this.components = data.data.components?.map(c => ModalSubmitInteraction.transformComponent(c));
 
-    /**
-     * The fields within the modal
-     * @type {ModalSubmitFields}
-     */
+    
     this.fields = new ModalSubmitFields(this.components);
 
-    /**
-     * 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);
   }
 
-  /**
-   * Transforms component data to discord.js-compatible data
-   * @param {*} rawComponent The data to transform
-   * @returns {ModalData[]}
-   */
+  
   static transformComponent(rawComponent) {
     return {
       value: rawComponent.value,
@@ -96,16 +55,13 @@ class ModalSubmitInteraction extends BaseInteraction {
     };
   }
 
-  /**
-   * Whether this is from a {@link MessageComponentInteraction}.
-   * @returns {boolean}
-   */
+  
   isFromMessage() {
     return Boolean(this.message);
   }
 
-  // These are here only for documentation purposes - they are implemented by InteractionResponses
-  /* eslint-disable no-empty-function */
+  
+  
   deferReply() {}
   reply() {}
   fetchReply() {}

package/src/structures/NewsChannel.js

@@ -4,23 +4,9 @@ const { Routes } = require('discord-api-types/v10');
 const BaseGuildTextChannel = require('./BaseGuildTextChannel');
 const { DiscordjsError, ErrorCodes } = require('../errors');
 
-/**
- * Represents a guild news channel on Discord.
- * @extends {BaseGuildTextChannel}
- */
+
 class NewsChannel extends BaseGuildTextChannel {
-  /**
-   * Adds the target to this channel's followers.
-   * @param {TextChannelResolvable} channel The channel where the webhook should be created
-   * @param {string} [reason] Reason for creating the webhook
-   * @returns {Promise<NewsChannel>}
-   * @example
-   * if (channel.type === ChannelType.GuildAnnouncement) {
-   *   channel.addFollower('222197033908436994', 'Important announcements')
-   *     .then(() => console.log('Added follower'))
-   *     .catch(console.error);
-   * }
-   */
+  
   async addFollower(channel, reason) {
     const channelId = this.guild.channels.resolveId(channel);
     if (!channelId) throw new DiscordjsError(ErrorCodes.GuildChannelResolve);

package/src/structures/OAuth2Guild.js

@@ -3,24 +3,15 @@
 const BaseGuild = require('./BaseGuild');
 const PermissionsBitField = require('../util/PermissionsBitField');
 
-/**
- * A partial guild received when using {@link GuildManager#fetch} to fetch multiple guilds.
- * @extends {BaseGuild}
- */
+
 class OAuth2Guild extends BaseGuild {
   constructor(client, data) {
     super(client, data);
 
-    /**
-     * Whether the client user is the owner of the guild
-     * @type {boolean}
-     */
+    
     this.owner = data.owner;
 
-    /**
-     * The permissions that the client user has in this guild
-     * @type {Readonly<PermissionsBitField>}
-     */
+    
     this.permissions = new PermissionsBitField(BigInt(data.permissions)).freeze();
   }
 }

package/src/structures/PartialGroupDMChannel.js

@@ -3,47 +3,27 @@
 const { BaseChannel } = require('./BaseChannel');
 const { DiscordjsError, ErrorCodes } = require('../errors');
 
-/**
- * Represents a Partial Group DM Channel on Discord.
- * @extends {BaseChannel}
- */
+
 class PartialGroupDMChannel extends BaseChannel {
   constructor(client, data) {
     super(client, data);
 
-    // No flags are present when fetching partial group DM channels.
+    
     this.flags = null;
 
-    /**
-     * The name of this Group DM Channel
-     * @type {?string}
-     */
+    
     this.name = data.name;
 
-    /**
-     * The hash of the channel icon
-     * @type {?string}
-     */
+    
     this.icon = data.icon;
 
-    /**
-     * Recipient data received in a {@link PartialGroupDMChannel}.
-     * @typedef {Object} PartialRecipient
-     * @property {string} username The username of the recipient
-     */
+    
 
-    /**
-     * The recipients of this Group DM Channel.
-     * @type {PartialRecipient[]}
-     */
+    
     this.recipients = data.recipients;
   }
 
-  /**
-   * The URL to this channel's icon.
-   * @param {ImageURLOptions} [options={}] Options for the image URL
-   * @returns {?string}
-   */
+  
   iconURL(options = {}) {
     return this.icon && this.client.rest.cdn.channelIcon(this.id, this.icon, options);
   }

package/src/structures/PermissionOverwrites.js

@@ -6,80 +6,44 @@ const { Role } = require('./Role');
 const { DiscordjsTypeError, ErrorCodes } = require('../errors');
 const PermissionsBitField = require('../util/PermissionsBitField');
 
-/**
- * Represents a permission overwrite for a role or member in a guild channel.
- * @extends {Base}
- */
+
 class PermissionOverwrites extends Base {
   constructor(client, data, channel) {
     super(client);
 
-    /**
-     * The GuildChannel this overwrite is for
-     * @name PermissionOverwrites#channel
-     * @type {GuildChannel}
-     * @readonly
-     */
+    
     Object.defineProperty(this, 'channel', { value: channel });
 
     if (data) this._patch(data);
   }
 
   _patch(data) {
-    /**
-     * The overwrite's id, either a {@link User} or a {@link Role} id
-     * @type {Snowflake}
-     */
+    
     this.id = data.id;
 
     if ('type' in data) {
-      /**
-       * The type of this overwrite
-       * @type {OverwriteType}
-       */
+      
       this.type = data.type;
     }
 
     if ('deny' in data) {
-      /**
-       * The permissions that are denied for the user or role.
-       * @type {Readonly<PermissionsBitField>}
-       */
+      
       this.deny = new PermissionsBitField(BigInt(data.deny)).freeze();
     }
 
     if ('allow' in data) {
-      /**
-       * The permissions that are allowed for the user or role.
-       * @type {Readonly<PermissionsBitField>}
-       */
+      
       this.allow = new PermissionsBitField(BigInt(data.allow)).freeze();
     }
   }
 
-  /**
-   * Edits this Permission Overwrite.
-   * @param {PermissionOverwriteOptions} options The options for the update
-   * @param {string} [reason] Reason for creating/editing this overwrite
-   * @returns {Promise<PermissionOverwrites>}
-   * @example
-   * // Update permission overwrites
-   * permissionOverwrites.edit({
-   *   SendMessages: false
-   * })
-   *   .then(channel => console.log(channel.permissionOverwrites.get(message.author.id)))
-   *   .catch(console.error);
-   */
+  
   async edit(options, reason) {
     await this.channel.permissionOverwrites.upsert(this.id, options, { type: this.type, reason }, this);
     return this;
   }
 
-  /**
-   * Deletes this Permission Overwrite.
-   * @param {string} [reason] Reason for deleting this overwrite
-   * @returns {Promise<PermissionOverwrites>}
-   */
+  
   async delete(reason) {
     await this.channel.permissionOverwrites.delete(this.id, reason);
     return this;
@@ -94,30 +58,11 @@ class PermissionOverwrites extends Base {
     };
   }
 
-  /**
-   * An object mapping permission flags to `true` (enabled), `null` (unset) or `false` (disabled).
-   * ```js
-   * {
-   *  'SendMessages': true,
-   *  'EmbedLinks': null,
-   *  'AttachFiles': false,
-   * }
-   * ```
-   * @typedef {Object} PermissionOverwriteOptions
-   */
-
-  /**
-   * @typedef {Object} ResolvedOverwriteOptions
-   * @property {PermissionsBitField} allow The allowed permissions
-   * @property {PermissionsBitField} deny The denied permissions
-   */
-
-  /**
-   * Resolves bitfield permissions overwrites from an object.
-   * @param {PermissionOverwriteOptions} options The options for the update
-   * @param {ResolvedOverwriteOptions} initialPermissions The initial permissions
-   * @returns {ResolvedOverwriteOptions}
-   */
+  
+
+  
+
+  
   static resolveOverwriteOptions(options, { allow, deny } = {}) {
     allow = new PermissionsBitField(allow);
     deny = new PermissionsBitField(deny);
@@ -138,37 +83,13 @@ class PermissionOverwrites extends Base {
     return { allow, deny };
   }
 
-  /**
-   * The raw data for a permission overwrite
-   * @typedef {Object} RawOverwriteData
-   * @property {Snowflake} id The id of the {@link Role} or {@link User} this overwrite belongs to
-   * @property {string} allow The permissions to allow
-   * @property {string} deny The permissions to deny
-   * @property {number} type The type of this OverwriteData
-   */
-
-  /**
-   * Data that can be resolved into {@link RawOverwriteData}. This can be:
-   * * PermissionOverwrites
-   * * OverwriteData
-   * @typedef {PermissionOverwrites|OverwriteData} OverwriteResolvable
-   */
-
-  /**
-   * Data that can be used for a permission overwrite
-   * @typedef {Object} OverwriteData
-   * @property {GuildMemberResolvable|RoleResolvable} id Member or role this overwrite is for
-   * @property {PermissionResolvable} [allow] The permissions to allow
-   * @property {PermissionResolvable} [deny] The permissions to deny
-   * @property {OverwriteType} [type] The type of this OverwriteData
-   */
-
-  /**
-   * Resolves an overwrite into {@link RawOverwriteData}.
-   * @param {OverwriteResolvable} overwrite The overwrite-like data to resolve
-   * @param {Guild} [guild] The guild to resolve from
-   * @returns {RawOverwriteData}
-   */
+  
+
+  
+
+  
+
+  
   static resolve(overwrite, guild) {
     if (overwrite instanceof this) return overwrite.toJSON();
     if (typeof overwrite.id === 'string' && overwrite.type in OverwriteType) {