@velliajs/discord 1.0.3 → 1.0.4

package/src/client/WebhookClient.js

@@ -5,41 +5,17 @@ const { DiscordjsError, ErrorCodes } = require('../errors');
 const Webhook = require('../structures/Webhook');
 const { parseWebhookURL } = require('../util/Util');
 
-/**
- * The webhook client.
- * @implements {Webhook}
- * @extends {BaseClient}
- */
+
 class WebhookClient extends BaseClient {
-  /**
-   * Represents the credentials used for a webhook in the form of its id and token.
-   * @typedef {Object} WebhookClientDataIdWithToken
-   * @property {Snowflake} id The webhook's id
-   * @property {string} token The webhook's token
-   */
-
-  /**
-   * Represents the credentials used for a webhook in the form of a URL.
-   * @typedef {Object} WebhookClientDataURL
-   * @property {string} url The full URL for the webhook
-   */
-
-  /**
-   * Represents the credentials used for a webhook.
-   * @typedef {WebhookClientDataIdWithToken|WebhookClientDataURL} WebhookClientData
-   */
-
-  /**
-   * Options for a webhook client.
-   * @typedef {Object} WebhookClientOptions
-   * @property {MessageMentionOptions} [allowedMentions] Default value for {@link BaseMessageOptions#allowedMentions}
-   * @property {RESTOptions} [rest] Options for the REST manager
-   */
-
-  /**
-   * @param {WebhookClientData} data The data of the webhook
-   * @param {WebhookClientOptions} [options] Options for the webhook client
-   */
+  
+
+  
+
+  
+
+  
+
+  
   constructor(data, options) {
     super(options);
     Object.defineProperty(this, 'client', { value: this });
@@ -58,35 +34,17 @@ class WebhookClient extends BaseClient {
     Object.defineProperty(this, 'token', { value: token, writable: true, configurable: true });
   }
 
-  /**
-   * The options the webhook client was instantiated with.
-   * @type {WebhookClientOptions}
-   * @name WebhookClient#options
-   */
-
-  // These are here only for documentation purposes - they are implemented by Webhook
-  /* eslint-disable no-empty-function, valid-jsdoc */
-  /**
-   * Sends a message with this webhook.
-   * @param {string|MessagePayload|WebhookMessageCreateOptions} options The content for the reply
-   * @returns {Promise<APIMessage>}
-   */
+  
+
+  
+  
+  
   send() {}
 
-  /**
-   * Gets a message that was sent by this webhook.
-   * @param {Snowflake} message The id of the message to fetch
-   * @param {WebhookFetchMessageOptions} [options={}] The options to provide to fetch the message.
-   * @returns {Promise<APIMessage>} Returns the message sent by this webhook
-   */
+  
   fetchMessage() {}
 
-  /**
-   * Edits a message that was sent by this webhook.
-   * @param {MessageResolvable} message The message to edit
-   * @param {string|MessagePayload|WebhookMessageEditOptions} options The options to provide
-   * @returns {Promise<APIMessage>} Returns the message edited by this webhook
-   */
+  
   editMessage() {}
 
   sendSlackMessage() {}

package/src/client/actions/Action.js

@@ -2,17 +2,7 @@
 
 const Partials = require('../../util/Partials');
 
-/*
 
-ABOUT ACTIONS
-
-Actions are similar to WebSocket Packet Handlers, but since introducing
-the REST API methods, in order to prevent rewriting code to handle data,
-"actions" have been introduced. They're basically what Packet Handlers
-used to be but they're strictly for manipulating data and making sure
-that WebSocket events don't clash with REST methods.
-
-*/
 
 class GenericAction {
   constructor(client) {

package/src/client/actions/ActionsManager.js

@@ -1,9 +1,9 @@
 'use strict';
 
 class ActionsManager {
-  // These symbols represent fully built data that we inject at times when calling actions manually.
-  // Action#getUser, for example, will return the injected data (which is assumed to be a built structure)
-  // instead of trying to make it from provided data
+  
+  
+  
   injectedUser = Symbol('djs.actions.injectedUser');
   injectedChannel = Symbol('djs.actions.injectedChannel');
   injectedMessage = Symbol('djs.actions.injectedMessage');

package/src/client/actions/ApplicationCommandPermissionsUpdate.js

@@ -3,25 +3,12 @@
 const Action = require('./Action');
 const Events = require('../../util/Events');
 
-/**
- * The data received in the {@link Client#event:applicationCommandPermissionsUpdate} event
- * @typedef {Object} ApplicationCommandPermissionsUpdateData
- * @property {Snowflake} id The id of the command or global entity that was updated
- * @property {Snowflake} guildId The id of the guild in which permissions were updated
- * @property {Snowflake} applicationId The id of the application that owns the command or entity being updated
- * @property {ApplicationCommandPermissions[]} permissions The updated permissions
- */
+
 
 class ApplicationCommandPermissionsUpdateAction extends Action {
   handle(data) {
     const client = this.client;
-    /**
-     * Emitted whenever permissions for an application command in a guild were updated.
-     * <warn>This includes permission updates for other applications in addition to the logged in client,
-     * check `data.applicationId` to verify which application the update is for</warn>
-     * @event Client#applicationCommandPermissionsUpdate
-     * @param {ApplicationCommandPermissionsUpdateData} data The updated permissions
-     */
+    
     client.emit(Events.ApplicationCommandPermissionsUpdate, {
       permissions: data.permissions,
       id: data.id,

package/src/client/actions/AutoModerationActionExecution.js

@@ -10,12 +10,7 @@ class AutoModerationActionExecutionAction extends Action {
     const guild = client.guilds.cache.get(data.guild_id);
 
     if (guild) {
-      /**
-       * Emitted whenever an auto moderation rule is triggered.
-       * <info>This event requires the {@link PermissionFlagsBits.ManageGuild} permission.</info>
-       * @event Client#autoModerationActionExecution
-       * @param {AutoModerationActionExecution} autoModerationActionExecution The data of the execution
-       */
+      
       client.emit(Events.AutoModerationActionExecution, new AutoModerationActionExecution(data, guild));
     }
 

package/src/client/actions/AutoModerationRuleCreate.js

@@ -11,12 +11,7 @@ class AutoModerationRuleCreateAction extends Action {
     if (guild) {
       const autoModerationRule = guild.autoModerationRules._add(data);
 
-      /**
-       * Emitted whenever an auto moderation rule is created.
-       * <info>This event requires the {@link PermissionFlagsBits.ManageGuild} permission.</info>
-       * @event Client#autoModerationRuleCreate
-       * @param {AutoModerationRule} autoModerationRule The created auto moderation rule
-       */
+      
       client.emit(Events.AutoModerationRuleCreate, autoModerationRule);
     }
 

package/src/client/actions/AutoModerationRuleDelete.js

@@ -14,12 +14,7 @@ class AutoModerationRuleDeleteAction extends Action {
       if (autoModerationRule) {
         guild.autoModerationRules.cache.delete(autoModerationRule.id);
 
-        /**
-         * Emitted whenever an auto moderation rule is deleted.
-         * <info>This event requires the {@link PermissionFlagsBits.ManageGuild} permission.</info>
-         * @event Client#autoModerationRuleDelete
-         * @param {AutoModerationRule} autoModerationRule The deleted auto moderation rule
-         */
+        
         client.emit(Events.AutoModerationRuleDelete, autoModerationRule);
       }
     }

package/src/client/actions/AutoModerationRuleUpdate.js

@@ -12,13 +12,7 @@ class AutoModerationRuleUpdateAction extends Action {
       const oldAutoModerationRule = guild.autoModerationRules.cache.get(data.id)?._clone() ?? null;
       const newAutoModerationRule = guild.autoModerationRules._add(data);
 
-      /**
-       * Emitted whenever an auto moderation rule gets updated.
-       * <info>This event requires the {@link PermissionFlagsBits.ManageGuild} permission.</info>
-       * @event Client#autoModerationRuleUpdate
-       * @param {?AutoModerationRule} oldAutoModerationRule The auto moderation rule before the update
-       * @param {AutoModerationRule} newAutoModerationRule The auto moderation rule after the update
-       */
+      
       client.emit(Events.AutoModerationRuleUpdate, oldAutoModerationRule, newAutoModerationRule);
     }
 

package/src/client/actions/ChannelCreate.js

@@ -9,11 +9,7 @@ class ChannelCreateAction extends Action {
     const existing = client.channels.cache.has(data.id);
     const channel = client.channels._add(data);
     if (!existing && channel) {
-      /**
-       * Emitted whenever a guild channel is created.
-       * @event Client#channelCreate
-       * @param {GuildChannel} channel The channel that was created
-       */
+      
       client.emit(Events.ChannelCreate, channel);
     }
     return { channel };

package/src/client/actions/ChannelDelete.js

@@ -10,11 +10,7 @@ class ChannelDeleteAction extends Action {
 
     if (channel) {
       client.channels._remove(channel.id);
-      /**
-       * Emitted whenever a channel is deleted.
-       * @event Client#channelDelete
-       * @param {DMChannel|GuildChannel} channel The channel that was deleted
-       */
+      
       client.emit(Events.ChannelDelete, channel);
     }
   }

package/src/client/actions/GuildAuditLogEntryCreate.js

@@ -13,12 +13,7 @@ class GuildAuditLogEntryCreateAction extends Action {
     if (guild) {
       auditLogEntry = new GuildAuditLogsEntry(guild, data);
 
-      /**
-       * Emitted whenever a guild audit log entry is created.
-       * @event Client#guildAuditLogEntryCreate
-       * @param {GuildAuditLogsEntry} auditLogEntry The entry that was created
-       * @param {Guild} guild The guild where the entry was created
-       */
+      
       client.emit(Events.GuildAuditLogEntryCreate, auditLogEntry, guild);
     }
 

package/src/client/actions/GuildBanAdd.js

@@ -8,11 +8,7 @@ class GuildBanAdd extends Action {
     const client = this.client;
     const guild = client.guilds.cache.get(data.guild_id);
 
-    /**
-     * Emitted whenever a member is banned from a guild.
-     * @event Client#guildBanAdd
-     * @param {GuildBan} ban The ban that occurred
-     */
+    
     if (guild) client.emit(Events.GuildBanAdd, guild.bans._add(data));
   }
 }

package/src/client/actions/GuildBanRemove.js

@@ -9,11 +9,7 @@ class GuildBanRemove extends Action {
     const client = this.client;
     const guild = client.guilds.cache.get(data.guild_id);
 
-    /**
-     * Emitted whenever a member is unbanned from a guild.
-     * @event Client#guildBanRemove
-     * @param {GuildBan} ban The ban that was removed
-     */
+    
     if (guild) {
       const ban = guild.bans.cache.get(data.user.id) ?? new GuildBan(client, data, guild);
       guild.bans.cache.delete(ban.user.id);

package/src/client/actions/GuildDelete.js

@@ -10,32 +10,24 @@ class GuildDeleteAction extends Action {
     let guild = client.guilds.cache.get(data.id);
     if (guild) {
       if (data.unavailable) {
-        // Guild is unavailable
+        
         guild.available = false;
 
-        /**
-         * Emitted whenever a guild becomes unavailable, likely due to a server outage.
-         * @event Client#guildUnavailable
-         * @param {Guild} guild The guild that has become unavailable
-         */
+        
         client.emit(Events.GuildUnavailable, guild);
 
-        // Stops the GuildDelete packet thinking a guild was actually deleted,
-        // handles emitting of event itself
+        
+        
         return;
       }
 
       for (const channel of guild.channels.cache.values()) this.client.channels._remove(channel.id);
       client.voice.adapters.get(data.id)?.destroy();
 
-      // Delete guild
+      
       client.guilds.cache.delete(guild.id);
 
-      /**
-       * Emitted whenever a guild kicks the client or the guild is deleted/left.
-       * @event Client#guildDelete
-       * @param {Guild} guild The guild that was deleted
-       */
+      
       client.emit(Events.GuildDelete, guild);
     }
   }

package/src/client/actions/GuildEmojiCreate.js

@@ -7,11 +7,7 @@ class GuildEmojiCreateAction extends Action {
   handle(guild, createdEmoji) {
     const already = guild.emojis.cache.has(createdEmoji.id);
     const emoji = guild.emojis._add(createdEmoji);
-    /**
-     * Emitted whenever a custom emoji is created in a guild.
-     * @event Client#emojiCreate
-     * @param {GuildEmoji} emoji The emoji that was created
-     */
+    
     if (!already) this.client.emit(Events.GuildEmojiCreate, emoji);
     return { emoji };
   }

package/src/client/actions/GuildEmojiDelete.js

@@ -6,11 +6,7 @@ const Events = require('../../util/Events');
 class GuildEmojiDeleteAction extends Action {
   handle(emoji) {
     emoji.guild.emojis.cache.delete(emoji.id);
-    /**
-     * Emitted whenever a custom emoji is deleted in a guild.
-     * @event Client#emojiDelete
-     * @param {GuildEmoji} emoji The emoji that was deleted
-     */
+    
     this.client.emit(Events.GuildEmojiDelete, emoji);
     return { emoji };
   }

package/src/client/actions/GuildEmojiUpdate.js

@@ -6,12 +6,7 @@ const Events = require('../../util/Events');
 class GuildEmojiUpdateAction extends Action {
   handle(current, data) {
     const old = current._update(data);
-    /**
-     * Emitted whenever a custom emoji is updated in a guild.
-     * @event Client#emojiUpdate
-     * @param {GuildEmoji} oldEmoji The old emoji
-     * @param {GuildEmoji} newEmoji The new emoji
-     */
+    
     this.client.emit(Events.GuildEmojiUpdate, old, current);
     return { emoji: current };
   }

package/src/client/actions/GuildEmojisUpdate.js

@@ -10,22 +10,22 @@ class GuildEmojisUpdateAction extends Action {
     const deletions = new Map(guild.emojis.cache);
 
     for (const emoji of data.emojis) {
-      // Determine type of emoji event
+      
       const cachedEmoji = guild.emojis.cache.get(emoji.id);
       if (cachedEmoji) {
         deletions.delete(emoji.id);
         if (!cachedEmoji.equals(emoji)) {
-          // Emoji updated
+          
           this.client.actions.GuildEmojiUpdate.handle(cachedEmoji, emoji);
         }
       } else {
-        // Emoji added
+        
         this.client.actions.GuildEmojiCreate.handle(guild, emoji);
       }
     }
 
     for (const emoji of deletions.values()) {
-      // Emoji deleted
+      
       this.client.actions.GuildEmojiDelete.handle(emoji);
     }
   }

package/src/client/actions/GuildIntegrationsUpdate.js

@@ -7,11 +7,7 @@ class GuildIntegrationsUpdate extends Action {
   handle(data) {
     const client = this.client;
     const guild = client.guilds.cache.get(data.guild_id);
-    /**
-     * Emitted whenever a guild integration is updated
-     * @event Client#guildIntegrationsUpdate
-     * @param {Guild} guild The guild whose integrations were updated
-     */
+    
     if (guild) client.emit(Events.GuildIntegrationsUpdate, guild);
   }
 }

package/src/client/actions/GuildMemberRemove.js

@@ -14,11 +14,7 @@ class GuildMemberRemoveAction extends Action {
       guild.memberCount--;
       if (member) {
         guild.members.cache.delete(member.id);
-        /**
-         * Emitted whenever a member leaves a guild, or is kicked.
-         * @event Client#guildMemberRemove
-         * @param {GuildMember} member The member that has left/been kicked from the guild
-         */
+        
         if (shard.status === Status.Ready) client.emit(Events.GuildMemberRemove, member);
       }
       guild.presences.cache.delete(data.user.id);

package/src/client/actions/GuildMemberUpdate.js

@@ -21,20 +21,11 @@ class GuildMemberUpdateAction extends Action {
       const member = this.getMember({ user: data.user }, guild);
       if (member) {
         const old = member._update(data);
-        /**
-         * Emitted whenever a guild member changes - i.e. new role, removed role, nickname.
-         * @event Client#guildMemberUpdate
-         * @param {GuildMember} oldMember The member before the update
-         * @param {GuildMember} newMember The member after the update
-         */
+        
         if (shard.status === Status.Ready && !member.equals(old)) client.emit(Events.GuildMemberUpdate, old, member);
       } else {
         const newMember = guild.members._add(data);
-        /**
-         * Emitted whenever a member becomes available.
-         * @event Client#guildMemberAvailable
-         * @param {GuildMember} member The member that became available
-         */
+        
         this.client.emit(Events.GuildMemberAvailable, newMember);
       }
     }

package/src/client/actions/GuildRoleCreate.js

@@ -11,11 +11,7 @@ class GuildRoleCreate extends Action {
     if (guild) {
       const already = guild.roles.cache.has(data.role.id);
       role = guild.roles._add(data.role);
-      /**
-       * Emitted whenever a role is created.
-       * @event Client#roleCreate
-       * @param {Role} role The role that was created
-       */
+      
       if (!already) client.emit(Events.GuildRoleCreate, role);
     }
     return { role };

package/src/client/actions/GuildRoleDelete.js

@@ -13,11 +13,7 @@ class GuildRoleDeleteAction extends Action {
       role = guild.roles.cache.get(data.role_id);
       if (role) {
         guild.roles.cache.delete(data.role_id);
-        /**
-         * Emitted whenever a guild role is deleted.
-         * @event Client#roleDelete
-         * @param {Role} role The role that was deleted
-         */
+        
         client.emit(Events.GuildRoleDelete, role);
       }
     }

package/src/client/actions/GuildRoleUpdate.js

@@ -14,12 +14,7 @@ class GuildRoleUpdateAction extends Action {
       const role = guild.roles.cache.get(data.role.id);
       if (role) {
         old = role._update(data.role);
-        /**
-         * Emitted whenever a guild role is updated.
-         * @event Client#roleUpdate
-         * @param {Role} oldRole The role before the update
-         * @param {Role} newRole The role after the update
-         */
+        
         client.emit(Events.GuildRoleUpdate, old, role);
       }
 

package/src/client/actions/GuildScheduledEventCreate.js

@@ -10,11 +10,7 @@ class GuildScheduledEventCreateAction extends Action {
     if (guild) {
       const guildScheduledEvent = guild.scheduledEvents._add(data);
 
-      /**
-       * Emitted whenever a guild scheduled event is created.
-       * @event Client#guildScheduledEventCreate
-       * @param {GuildScheduledEvent} guildScheduledEvent The created guild scheduled event
-       */
+      
       client.emit(Events.GuildScheduledEventCreate, guildScheduledEvent);
 
       return { guildScheduledEvent };

package/src/client/actions/GuildScheduledEventDelete.js

@@ -13,11 +13,7 @@ class GuildScheduledEventDeleteAction extends Action {
       if (guildScheduledEvent) {
         guild.scheduledEvents.cache.delete(guildScheduledEvent.id);
 
-        /**
-         * Emitted whenever a guild scheduled event is deleted.
-         * @event Client#guildScheduledEventDelete
-         * @param {GuildScheduledEvent} guildScheduledEvent The deleted guild scheduled event
-         */
+        
         client.emit(Events.GuildScheduledEventDelete, guildScheduledEvent);
 
         return { guildScheduledEvent };

package/src/client/actions/GuildScheduledEventUpdate.js

@@ -12,12 +12,7 @@ class GuildScheduledEventUpdateAction extends Action {
       const oldGuildScheduledEvent = guild.scheduledEvents.cache.get(data.id)?._clone() ?? null;
       const newGuildScheduledEvent = guild.scheduledEvents._add(data);
 
-      /**
-       * Emitted whenever a guild scheduled event gets updated.
-       * @event Client#guildScheduledEventUpdate
-       * @param {?GuildScheduledEvent} oldGuildScheduledEvent The guild scheduled event object before the update
-       * @param {GuildScheduledEvent} newGuildScheduledEvent The guild scheduled event object after the update
-       */
+      
       client.emit(Events.GuildScheduledEventUpdate, oldGuildScheduledEvent, newGuildScheduledEvent);
 
       return { oldGuildScheduledEvent, newGuildScheduledEvent };

package/src/client/actions/GuildScheduledEventUserAdd.js

@@ -13,12 +13,7 @@ class GuildScheduledEventUserAddAction extends Action {
       const user = this.getUser(data);
 
       if (guildScheduledEvent && user) {
-        /**
-         * Emitted whenever a user subscribes to a guild scheduled event
-         * @event Client#guildScheduledEventUserAdd
-         * @param {GuildScheduledEvent} guildScheduledEvent The guild scheduled event
-         * @param {User} user The user who subscribed
-         */
+        
         client.emit(Events.GuildScheduledEventUserAdd, guildScheduledEvent, user);
 
         return { guildScheduledEvent, user };

package/src/client/actions/GuildScheduledEventUserRemove.js

@@ -13,12 +13,7 @@ class GuildScheduledEventUserRemoveAction extends Action {
       const user = this.getUser(data);
 
       if (guildScheduledEvent && user) {
-        /**
-         * Emitted whenever a user unsubscribes from a guild scheduled event
-         * @event Client#guildScheduledEventUserRemove
-         * @param {GuildScheduledEvent} guildScheduledEvent The guild scheduled event
-         * @param {User} user The user who unsubscribed
-         */
+        
         client.emit(Events.GuildScheduledEventUserRemove, guildScheduledEvent, user);
 
         return { guildScheduledEvent, user };

package/src/client/actions/GuildStickerCreate.js

@@ -7,11 +7,7 @@ class GuildStickerCreateAction extends Action {
   handle(guild, createdSticker) {
     const already = guild.stickers.cache.has(createdSticker.id);
     const sticker = guild.stickers._add(createdSticker);
-    /**
-     * Emitted whenever a custom sticker is created in a guild.
-     * @event Client#stickerCreate
-     * @param {Sticker} sticker The sticker that was created
-     */
+    
     if (!already) this.client.emit(Events.GuildStickerCreate, sticker);
     return { sticker };
   }

package/src/client/actions/GuildStickerDelete.js

@@ -6,11 +6,7 @@ const Events = require('../../util/Events');
 class GuildStickerDeleteAction extends Action {
   handle(sticker) {
     sticker.guild.stickers.cache.delete(sticker.id);
-    /**
-     * Emitted whenever a custom sticker is deleted in a guild.
-     * @event Client#stickerDelete
-     * @param {Sticker} sticker The sticker that was deleted
-     */
+    
     this.client.emit(Events.GuildStickerDelete, sticker);
     return { sticker };
   }

package/src/client/actions/GuildStickerUpdate.js

@@ -6,12 +6,7 @@ const Events = require('../../util/Events');
 class GuildStickerUpdateAction extends Action {
   handle(current, data) {
     const old = current._update(data);
-    /**
-     * Emitted whenever a custom sticker is updated in a guild.
-     * @event Client#stickerUpdate
-     * @param {Sticker} oldSticker The old sticker
-     * @param {Sticker} newSticker The new sticker
-     */
+    
     this.client.emit(Events.GuildStickerUpdate, old, current);
     return { sticker: current };
   }

package/src/client/actions/GuildStickersUpdate.js

@@ -10,22 +10,22 @@ class GuildStickersUpdateAction extends Action {
     const deletions = new Map(guild.stickers.cache);
 
     for (const sticker of data.stickers) {
-      // Determine type of sticker event
+      
       const cachedSticker = guild.stickers.cache.get(sticker.id);
       if (cachedSticker) {
         deletions.delete(sticker.id);
         if (!cachedSticker.equals(sticker)) {
-          // Sticker updated
+          
           this.client.actions.GuildStickerUpdate.handle(cachedSticker, sticker);
         }
       } else {
-        // Sticker added
+        
         this.client.actions.GuildStickerCreate.handle(guild, sticker);
       }
     }
 
     for (const sticker of deletions.values()) {
-      // Sticker deleted
+      
       this.client.actions.GuildStickerDelete.handle(sticker);
     }
   }

package/src/client/actions/GuildUpdate.js

@@ -10,12 +10,7 @@ class GuildUpdateAction extends Action {
     const guild = client.guilds.cache.get(data.id);
     if (guild) {
       const old = guild._update(data);
-      /**
-       * Emitted whenever a guild is updated - e.g. name change.
-       * @event Client#guildUpdate
-       * @param {Guild} oldGuild The guild before the update
-       * @param {Guild} newGuild The guild after the update
-       */
+      
       client.emit(Events.GuildUpdate, old, guild);
       return {
         old,