@velliajs/discord 1.0.2 → 1.0.4

package/src/util/BitField.js

@@ -2,88 +2,47 @@
 
 const { DiscordjsRangeError, ErrorCodes } = require('../errors');
 
-/**
- * Data structure that makes it easy to interact with a bitfield.
- */
+
 class BitField {
-  /**
-   * Numeric bitfield flags.
-   * <info>Defined in extension classes</info>
-   * @type {Object}
-   * @memberof BitField
-   * @abstract
-   */
+  
   static Flags = {};
 
-  /**
-   * @type {number|bigint}
-   * @memberof BitField
-   * @private
-   */
+  
   static DefaultBit = 0;
 
-  /**
-   * @param {BitFieldResolvable} [bits=this.constructor.DefaultBit] Bit(s) to read from
-   */
+  
   constructor(bits = this.constructor.DefaultBit) {
-    /**
-     * Bitfield of the packed bits
-     * @type {number|bigint}
-     */
+    
     this.bitfield = this.constructor.resolve(bits);
   }
 
-  /**
-   * Checks whether the bitfield has a bit, or any of multiple bits.
-   * @param {BitFieldResolvable} bit Bit(s) to check for
-   * @returns {boolean}
-   */
+  
   any(bit) {
     return (this.bitfield & this.constructor.resolve(bit)) !== this.constructor.DefaultBit;
   }
 
-  /**
-   * Checks if this bitfield equals another
-   * @param {BitFieldResolvable} bit Bit(s) to check for
-   * @returns {boolean}
-   */
+  
   equals(bit) {
     return this.bitfield === this.constructor.resolve(bit);
   }
 
-  /**
-   * Checks whether the bitfield has a bit, or multiple bits.
-   * @param {BitFieldResolvable} bit Bit(s) to check for
-   * @returns {boolean}
-   */
+  
   has(bit) {
     bit = this.constructor.resolve(bit);
     return (this.bitfield & bit) === bit;
   }
 
-  /**
-   * Gets all given bits that are missing from the bitfield.
-   * @param {BitFieldResolvable} bits Bit(s) to check for
-   * @param {...*} hasParams Additional parameters for the has method, if any
-   * @returns {string[]}
-   */
+  
   missing(bits, ...hasParams) {
     return new this.constructor(bits).remove(this).toArray(...hasParams);
   }
 
-  /**
-   * Freezes these bits, making them immutable.
-   * @returns {Readonly<BitField>}
-   */
+  
   freeze() {
     return Object.freeze(this);
   }
 
-  /**
-   * Adds bits to these ones.
-   * @param {...BitFieldResolvable} [bits] Bits to add
-   * @returns {BitField} These bits or new BitField if the instance is frozen.
-   */
+  
   add(...bits) {
     let total = this.constructor.DefaultBit;
     for (const bit of bits) {
@@ -94,11 +53,7 @@ class BitField {
     return this;
   }
 
-  /**
-   * Removes bits from these.
-   * @param {...BitFieldResolvable} [bits] Bits to remove
-   * @returns {BitField} These bits or new BitField if the instance is frozen.
-   */
+  
   remove(...bits) {
     let total = this.constructor.DefaultBit;
     for (const bit of bits) {
@@ -109,12 +64,7 @@ class BitField {
     return this;
   }
 
-  /**
-   * Gets an object mapping field names to a {@link boolean} indicating whether the
-   * bit is available.
-   * @param {...*} hasParams Additional parameters for the has method, if any
-   * @returns {Object}
-   */
+  
   serialize(...hasParams) {
     const serialized = {};
     for (const [flag, bit] of Object.entries(this.constructor.Flags)) {
@@ -123,11 +73,7 @@ class BitField {
     return serialized;
   }
 
-  /**
-   * Gets an {@link Array} of bitfield names based on the bits available.
-   * @param {...*} hasParams Additional parameters for the has method, if any
-   * @returns {string[]}
-   */
+  
   toArray(...hasParams) {
     return [...this[Symbol.iterator](...hasParams)];
   }
@@ -146,20 +92,9 @@ class BitField {
     }
   }
 
-  /**
-   * Data that can be resolved to give a bitfield. This can be:
-   * * A bit number (this can be a number literal or a value taken from {@link BitField.Flags})
-   * * A string bit number
-   * * An instance of BitField
-   * * An Array of BitFieldResolvable
-   * @typedef {number|string|bigint|BitField|BitFieldResolvable[]} BitFieldResolvable
-   */
-
-  /**
-   * Resolves bitfields to their numeric form.
-   * @param {BitFieldResolvable} [bit] bit(s) to resolve
-   * @returns {number|bigint}
-   */
+  
+
+  
   static resolve(bit) {
     const { DefaultBit } = this;
     if (typeof DefaultBit === typeof bit && bit >= DefaultBit) return bit;

package/src/util/ChannelFlagsBitField.js

@@ -3,39 +3,16 @@
 const { ChannelFlags } = require('discord-api-types/v10');
 const BitField = require('./BitField');
 
-/**
- * Data structure that makes it easy to interact with a {@link BaseChannel#flags} bitfield.
- * @extends {BitField}
- */
+
 class ChannelFlagsBitField extends BitField {
-  /**
-   * Numeric guild channel flags.
-   * @type {ChannelFlags}
-   * @memberof ChannelFlagsBitField
-   */
+  
   static Flags = ChannelFlags;
 }
 
-/**
- * @name ChannelFlagsBitField
- * @kind constructor
- * @memberof ChannelFlagsBitField
- * @param {BitFieldResolvable} [bits=0] Bit(s) to read from
- */
-
-/**
- * Bitfield of the packed bits
- * @type {number}
- * @name ChannelFlagsBitField#bitfield
- */
-
-/**
- * Data that can be resolved to give a channel flag bitfield. This can be:
- * * A string (see {@link ChannelFlagsBitField.Flags})
- * * A channel flag
- * * An instance of ChannelFlagsBitField
- * * An Array of ChannelFlagsResolvable
- * @typedef {string|number|ChannelFlagsBitField|ChannelFlagsResolvable[]} ChannelFlagsResolvable
- */
+
+
+
+
+
 
 module.exports = ChannelFlagsBitField;

package/src/util/Channels.js

@@ -14,15 +14,7 @@ const getDirectoryChannel = lazy(() => require('../structures/DirectoryChannel')
 const getPartialGroupDMChannel = lazy(() => require('../structures/PartialGroupDMChannel'));
 const getForumChannel = lazy(() => require('../structures/ForumChannel'));
 
-/**
- * Creates a discord.js channel from data received from the API.
- * @param {Client} client The client
- * @param {APIChannel} data The data of the channel to create
- * @param {Guild} [guild] The guild where this channel belongs
- * @param {Object} [extras] Extra information to supply for creating this channel
- * @returns {Channel} Any kind of channel.
- * @ignore
- */
+
 function createChannel(client, data, guild, { allowUnknownGuild } = {}) {
   let channel;
   if (!data.guild_id && !guild) {
@@ -76,12 +68,7 @@ function createChannel(client, data, guild, { allowUnknownGuild } = {}) {
   return channel;
 }
 
-/**
- * Transforms an API guild forum tag to camel-cased guild forum tag.
- * @param {APIGuildForumTag} tag The tag to transform
- * @returns {GuildForumTag}
- * @ignore
- */
+
 function transformAPIGuildForumTag(tag) {
   return {
     id: tag.id,
@@ -97,12 +84,7 @@ function transformAPIGuildForumTag(tag) {
   };
 }
 
-/**
- * Transforms a camel-cased guild forum tag to an API guild forum tag.
- * @param {GuildForumTag} tag The tag to transform
- * @returns {APIGuildForumTag}
- * @ignore
- */
+
 function transformGuildForumTag(tag) {
   return {
     id: tag.id,
@@ -113,13 +95,7 @@ function transformGuildForumTag(tag) {
   };
 }
 
-/**
- * Transforms an API guild forum default reaction object to a
- * camel-cased guild forum default reaction object.
- * @param {APIGuildForumDefaultReactionEmoji} defaultReaction The default reaction to transform
- * @returns {DefaultReactionEmoji}
- * @ignore
- */
+
 function transformAPIGuildDefaultReaction(defaultReaction) {
   return {
     id: defaultReaction.emoji_id,
@@ -127,13 +103,7 @@ function transformAPIGuildDefaultReaction(defaultReaction) {
   };
 }
 
-/**
- * Transforms a camel-cased guild forum default reaction object to an
- * API guild forum default reaction object.
- * @param {DefaultReactionEmoji} defaultReaction The default reaction to transform
- * @returns {APIGuildForumDefaultReactionEmoji}
- * @ignore
- */
+
 function transformGuildDefaultReaction(defaultReaction) {
   return {
     emoji_id: defaultReaction.id,

package/src/util/Colors.js

@@ -1,44 +1,9 @@
 'use strict';
 
-/**
- * @typedef {Object} Colors
- * @property {number} Default 0x000000 | rgb(0,0,0)
- * @property {number} White 0xFFFFFF | rgb(255,255,255)
- * @property {number} Aqua 0x1ABC9C | rgb(26,188,156)
- * @property {number} Green 0x57F287 | rgb(87,242,135)
- * @property {number} Blue 0x3498DB | rgb(52,152,219)
- * @property {number} Yellow 0xFEE75C | rgb(254,231,92)
- * @property {number} Purple 0x9B59B6 | rgb(155,89,182)
- * @property {number} LuminousVividPink 0xE91E63 | rgb(233,30,99)
- * @property {number} Fuchsia 0xEB459E | rgb(235,69,158)
- * @property {number} Gold 0xF1C40F | rgb(241,196,15)
- * @property {number} Orange 0xE67E22 | rgb(230,126,34)
- * @property {number} Red 0xED4245 | rgb(237,66,69)
- * @property {number} Grey 0x95A5A6 | rgb(149,165,166)
- * @property {number} Navy 0x34495E | rgb(52,73,94)
- * @property {number} DarkAqua 0x11806A | rgb(17,128,106)
- * @property {number} DarkGreen 0x1F8B4C | rgb(31,139,76)
- * @property {number} DarkBlue 0x206694 | rgb(32,102,148)
- * @property {number} DarkPurple 0x71368A | rgb(113,54,138)
- * @property {number} DarkVividPink 0xAD1457 | rgb(173,20,87)
- * @property {number} DarkGold 0xC27C0E | rgb(194,124,14)
- * @property {number} DarkOrange 0xA84300 | rgb(168,67,0)
- * @property {number} DarkRed 0x992D22 | rgb(153,45,34)
- * @property {number} DarkGrey 0x979C9F | rgb(151,156,159)
- * @property {number} DarkerGrey 0x7F8C8D | rgb(127,140,141)
- * @property {number} LightGrey 0xBCC0C0 | rgb(188,192,192)
- * @property {number} DarkNavy 0x2C3E50 | rgb(44,62,80)
- * @property {number} Blurple 0x5865F2 | rgb(88,101,242)
- * @property {number} Greyple 0x99AAb5 | rgb(153,170,181)
- * @property {number} DarkButNotBlack 0x2C2F33 | rgb(44,47,51)
- * @property {number} NotQuiteBlack 0x23272A | rgb(35,39,42)
- */
 
-// JSDoc for IntelliSense purposes
-/**
- * @type {Colors}
- * @ignore
- */
+
+
+
 module.exports = {
   Default: 0x000000,
   White: 0xffffff,

package/src/util/Components.js

@@ -1,77 +1,27 @@
 'use strict';
 
-// This file contains the typedefs for camel-cased JSON data
+
 const { ComponentBuilder } = require('@discordjs/builders');
 const { ComponentType } = require('discord-api-types/v10');
-/**
- * @typedef {Object} BaseComponentData
- * @property {ComponentType} type The type of component
- */
-
-/**
- * @typedef {BaseComponentData} ActionRowData
- * @property {ComponentData[]} components The components in this action row
- */
-
-/**
- * @typedef {BaseComponentData} ButtonComponentData
- * @property {ButtonStyle} style The style of the button
- * @property {?boolean} disabled Whether this button is disabled
- * @property {string} label The label of this button
- * @property {?APIMessageComponentEmoji} emoji The emoji on this button
- * @property {?string} customId The custom id of the button
- * @property {?string} url The URL of the button
- */
-
-/**
- * @typedef {object} SelectMenuComponentOptionData
- * @property {string} label The label of the option
- * @property {string} value The value of the option
- * @property {?string} description The description of the option
- * @property {?APIMessageComponentEmoji} emoji The emoji on the option
- * @property {?boolean} default Whether this option is selected by default
- */
-
-/**
- * @typedef {BaseComponentData} SelectMenuComponentData
- * @property {string} customId The custom id of the select menu
- * @property {?boolean} disabled Whether the select menu is disabled or not
- * @property {?number} maxValues The maximum amount of options that can be selected
- * @property {?number} minValues The minimum amount of options that can be selected
- * @property {?SelectMenuComponentOptionData[]} options The options in this select menu
- * @property {?string} placeholder The placeholder of the select menu
- */
-
-/**
- * @typedef {ActionRowData|ButtonComponentData|SelectMenuComponentData} MessageComponentData
- */
-
-/**
- * @typedef {BaseComponentData} TextInputComponentData
- * @property {string} customId The custom id of the text input
- * @property {TextInputStyle} style The style of the text input
- * @property {string} label The text that appears on top of the text input field
- * @property {?number} minLength The minimum number of characters that can be entered in the text input
- * @property {?number} maxLength The maximum number of characters that can be entered in the text input
- * @property {?boolean} required Whether or not the text input is required or not
- * @property {?string} value The pre-filled text in the text input
- * @property {?string} placeholder Placeholder for the text input
- */
-
-/**
- * @typedef {ActionRowData|ButtonComponentData|SelectMenuComponentData|TextInputComponentData} ComponentData
- */
-
-/**
- * Any emoji data that can be used within a button
- * @typedef {APIMessageComponentEmoji|string} ComponentEmojiResolvable
- */
-
-/**
- * Transforms API data into a component
- * @param {APIMessageComponent|Component} data The data to create the component from
- * @returns {Component}
- */
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 function createComponent(data) {
   if (data instanceof Component) {
     return data;
@@ -99,11 +49,7 @@ function createComponent(data) {
   }
 }
 
-/**
- * Transforms API data into a component builder
- * @param {APIMessageComponent|ComponentBuilder} data The data to create the component from
- * @returns {ComponentBuilder}
- */
+
 function createComponentBuilder(data) {
   if (data instanceof ComponentBuilder) {
     return data;

package/src/util/Constants.js

@@ -2,31 +2,10 @@
 
 const { ChannelType, MessageType, ComponentType, ImageFormat, StickerFormatType } = require('discord-api-types/v10');
 
-/**
- * Max bulk deletable message age
- * @typedef {number} MaxBulkDeletableMessageAge
- */
+
 exports.MaxBulkDeletableMessageAge = 1_209_600_000;
 
-/**
- * The name of an item to be swept in Sweepers
- * * `autoModerationRules`
- * * `applicationCommands` - both global and guild commands
- * * `bans`
- * * `emojis`
- * * `invites` - accepts the `lifetime` property, using it will sweep based on expires timestamp
- * * `guildMembers`
- * * `messages` - accepts the `lifetime` property, using it will sweep based on edited or created timestamp
- * * `presences`
- * * `reactions`
- * * `stageInstances`
- * * `stickers`
- * * `threadMembers`
- * * `threads` - accepts the `lifetime` property, using it will sweep archived threads based on archived timestamp
- * * `users`
- * * `voiceStates`
- * @typedef {string} SweeperKey
- */
+
 exports.SweeperKeys = [
   'autoModerationRules',
   'applicationCommands',
@@ -45,14 +24,7 @@ exports.SweeperKeys = [
   'voiceStates',
 ];
 
-/**
- * The types of messages that are not `System`. The available types are:
- * * {@link MessageType.Default}
- * * {@link MessageType.Reply}
- * * {@link MessageType.ChatInputCommand}
- * * {@link MessageType.ContextMenuCommand}
- * @typedef {MessageType[]} NonSystemMessageTypes
- */
+
 exports.NonSystemMessageTypes = [
   MessageType.Default,
   MessageType.Reply,
@@ -60,27 +32,9 @@ exports.NonSystemMessageTypes = [
   MessageType.ContextMenuCommand,
 ];
 
-/**
- * The guild channels that are text-based.
- * * TextChannel
- * * NewsChannel
- * * ThreadChannel
- * * VoiceChannel
- * * StageChannel
- * @typedef {TextChannel|NewsChannel|ThreadChannel|VoiceChannel|StageChannel} GuildTextBasedChannel
- */
-
-/**
- * The types of guild channels that are text-based. The available types are:
- * * {@link ChannelType.GuildText}
- * * {@link ChannelType.GuildAnnouncement}
- * * {@link ChannelType.AnnouncementThread}
- * * {@link ChannelType.PublicThread}
- * * {@link ChannelType.PrivateThread}
- * * {@link ChannelType.GuildVoice}
- * * {@link ChannelType.GuildStageVoice}
- * @typedef {ChannelType[]} GuildTextBasedChannelTypes
- */
+
+
+
 exports.GuildTextBasedChannelTypes = [
   ChannelType.GuildText,
   ChannelType.GuildAnnouncement,
@@ -91,60 +45,20 @@ exports.GuildTextBasedChannelTypes = [
   ChannelType.GuildStageVoice,
 ];
 
-/**
- * The channels that are text-based.
- * * DMChannel
- * * GuildTextBasedChannel
- * @typedef {DMChannel|GuildTextBasedChannel} TextBasedChannels
- */
-
-/**
- * Data that resolves to give a text-based channel. This can be:
- * * A text-based channel
- * * A snowflake
- * @typedef {TextBasedChannels|Snowflake} TextBasedChannelsResolvable
- */
-
-/**
- * The types of channels that are text-based. The available types are:
- * * {@link ChannelType.DM}
- * * {@link ChannelType.GuildText}
- * * {@link ChannelType.GuildAnnouncement}
- * * {@link ChannelType.AnnouncementThread}
- * * {@link ChannelType.PublicThread}
- * * {@link ChannelType.PrivateThread}
- * * {@link ChannelType.GuildVoice}
- * * {@link ChannelType.GuildStageVoice}
- * @typedef {ChannelType[]} TextBasedChannelTypes
- */
+
+
+
+
+
 exports.TextBasedChannelTypes = [...exports.GuildTextBasedChannelTypes, ChannelType.DM];
 
-/**
- * The types of channels that are threads. The available types are:
- * * {@link ChannelType.AnnouncementThread}
- * * {@link ChannelType.PublicThread}
- * * {@link ChannelType.PrivateThread}
- * @typedef {ChannelType[]} ThreadChannelTypes
- */
+
 exports.ThreadChannelTypes = [ChannelType.AnnouncementThread, ChannelType.PublicThread, ChannelType.PrivateThread];
 
-/**
- * The types of channels that are voice-based. The available types are:
- * * {@link ChannelType.GuildVoice}
- * * {@link ChannelType.GuildStageVoice}
- * @typedef {ChannelType[]} VoiceBasedChannelTypes
- */
+
 exports.VoiceBasedChannelTypes = [ChannelType.GuildVoice, ChannelType.GuildStageVoice];
 
-/**
- * The types of select menus. The available types are:
- * * {@link ComponentType.StringSelect}
- * * {@link ComponentType.UserSelect}
- * * {@link ComponentType.RoleSelect}
- * * {@link ComponentType.MentionableSelect}
- * * {@link ComponentType.ChannelSelect}
- * @typedef {ComponentType[]} SelectMenuTypes
- */
+
 exports.SelectMenuTypes = [
   ComponentType.StringSelect,
   ComponentType.UserSelect,
@@ -153,31 +67,7 @@ exports.SelectMenuTypes = [
   ComponentType.ChannelSelect,
 ];
 
-/**
- * The types of messages that can be deleted. The available types are:
- * * {@link MessageType.AutoModerationAction}
- * * {@link MessageType.ChannelFollowAdd}
- * * {@link MessageType.ChannelPinnedMessage}
- * * {@link MessageType.ChatInputCommand}
- * * {@link MessageType.ContextMenuCommand}
- * * {@link MessageType.Default}
- * * {@link MessageType.GuildBoost}
- * * {@link MessageType.GuildBoostTier1}
- * * {@link MessageType.GuildBoostTier2}
- * * {@link MessageType.GuildBoostTier3}
- * * {@link MessageType.GuildInviteReminder}
- * * {@link MessageType.InteractionPremiumUpsell}
- * * {@link MessageType.Reply}
- * * {@link MessageType.RoleSubscriptionPurchase}
- * * {@link MessageType.StageEnd}
- * * {@link MessageType.StageRaiseHand}
- * * {@link MessageType.StageSpeaker}
- * * {@link MessageType.StageStart}
- * * {@link MessageType.StageTopic}
- * * {@link MessageType.ThreadCreated}
- * * {@link MessageType.UserJoin}
- * @typedef {MessageType[]} DeletableMessageTypes
- */
+
 exports.DeletableMessageTypes = [
   MessageType.AutoModerationAction,
   MessageType.ChannelFollowAdd,
@@ -202,14 +92,7 @@ exports.DeletableMessageTypes = [
   MessageType.UserJoin,
 ];
 
-/**
- * A mapping between sticker formats and their respective image formats.
- * * {@link StickerFormatType.PNG} -> {@link ImageFormat.PNG}
- * * {@link StickerFormatType.APNG} -> {@link ImageFormat.PNG}
- * * {@link StickerFormatType.Lottie} -> {@link ImageFormat.Lottie}
- * * {@link StickerFormatType.GIF} -> {@link ImageFormat.GIF}
- * @typedef {Object} StickerFormatExtensionMap
- */
+
 exports.StickerFormatExtensionMap = {
   [StickerFormatType.PNG]: ImageFormat.PNG,
   [StickerFormatType.APNG]: ImageFormat.PNG,
@@ -217,14 +100,4 @@ exports.StickerFormatExtensionMap = {
   [StickerFormatType.GIF]: ImageFormat.GIF,
 };
 
-/**
- * @typedef {Object} Constants Constants that can be used in an enum or object-like way.
- * @property {number} MaxBulkDeletableMessageAge Max bulk deletable message age
- * @property {SweeperKey[]} SweeperKeys The possible names of items that can be swept in sweepers
- * @property {NonSystemMessageTypes} NonSystemMessageTypes The types of messages that are not deemed a system type
- * @property {TextBasedChannelTypes} TextBasedChannelTypes The types of channels that are text-based
- * @property {ThreadChannelTypes} ThreadChannelTypes The types of channels that are threads
- * @property {VoiceBasedChannelTypes} VoiceBasedChannelTypes The types of channels that are voice-based
- * @property {SelectMenuTypes} SelectMenuTypes The types of components that are select menus.
- * @property {Object} StickerFormatExtensionMap A mapping between sticker formats and their respective image formats.
- */
+