@velliajs/discord 1.0.3 → 1.0.4

package/src/util/Util.js

@@ -8,12 +8,7 @@ const Colors = require('./Colors');
 const { DiscordjsError, DiscordjsRangeError, DiscordjsTypeError, ErrorCodes } = require('../errors');
 const isObject = d => typeof d === 'object' && d !== null;
 
-/**
- * Flatten an object. Any properties that are collections will get converted to an array of keys.
- * @param {Object} obj The object to flatten.
- * @param {...Object<string, boolean|string>} [props] Specific properties to include/exclude.
- * @returns {Object}
- */
+
 function flatten(obj, ...props) {
   if (!isObject(obj)) return obj;
 
@@ -34,37 +29,28 @@ function flatten(obj, ...props) {
     const valueOf = elemIsObj && typeof element.valueOf === 'function' ? element.valueOf() : null;
     const hasToJSON = elemIsObj && typeof element.toJSON === 'function';
 
-    // If it's a Collection, make the array of keys
+    
     if (element instanceof Collection) out[newProp] = Array.from(element.keys());
-    // If the valueOf is a Collection, use its array of keys
+    
     else if (valueOf instanceof Collection) out[newProp] = Array.from(valueOf.keys());
-    // If it's an array, call toJSON function on each element if present, otherwise flatten each element
+    
     else if (Array.isArray(element)) out[newProp] = element.map(e => e.toJSON?.() ?? flatten(e));
-    // If it's an object with a primitive `valueOf`, use that value
+    
     else if (typeof valueOf !== 'object') out[newProp] = valueOf;
-    // If it's an object with a toJSON function, use the return value of it
+    
     else if (hasToJSON) out[newProp] = element.toJSON();
-    // If element is an object, use the flattened version of it
+    
     else if (typeof element === 'object') out[newProp] = flatten(element);
-    // If it's a primitive
+    
     else if (!elemIsObj) out[newProp] = element;
   }
 
   return out;
 }
 
-/**
- * @typedef {Object} FetchRecommendedShardCountOptions
- * @property {number} [guildsPerShard=1000] Number of guilds assigned per shard
- * @property {number} [multipleOf=1] The multiple the shard count should round up to. (16 for large bot sharding)
- */
-
-/**
- * Gets the recommended shard count from Discord.
- * @param {string} token Discord auth token
- * @param {FetchRecommendedShardCountOptions} [options] Options for fetching the recommended shard count
- * @returns {Promise<number>} The recommended number of shards
- */
+
+
+
 async function fetchRecommendedShardCount(token, { guildsPerShard = 1_000, multipleOf = 1 } = {}) {
   if (!token) throw new DiscordjsError(ErrorCodes.TokenMissing);
   const response = await fetch(RouteBases.api + Routes.gatewayBot(), {
@@ -79,14 +65,7 @@ async function fetchRecommendedShardCount(token, { guildsPerShard = 1_000, multi
   return Math.ceil((shards * (1_000 / guildsPerShard)) / multipleOf) * multipleOf;
 }
 
-/**
- * Parses emoji info out of a string. The string must be one of:
- * * A UTF-8 emoji (no id)
- * * A URL-encoded UTF-8 emoji (no id)
- * * A Discord custom emoji (`<:name:id>` or `<a:name:id>`)
- * @param {string} text Emoji string to parse
- * @returns {APIEmoji} Object with `animated`, `name`, and `id` properties
- */
+
 function parseEmoji(text) {
   if (text.includes('%')) text = decodeURIComponent(text);
   if (!text.includes(':')) return { animated: false, name: text, id: undefined };
@@ -94,12 +73,7 @@ function parseEmoji(text) {
   return match && { animated: Boolean(match[1]), name: match[2], id: match[3] };
 }
 
-/**
- * Resolves a partial emoji object from an {@link EmojiIdentifierResolvable}, without checking a Client.
- * @param {EmojiIdentifierResolvable} emoji Emoji identifier to resolve
- * @returns {?RawEmoji}
- * @private
- */
+
 function resolvePartialEmoji(emoji) {
   if (!emoji) return null;
   if (typeof emoji === 'string') return /^\d{17,19}$/.test(emoji) ? { id: emoji } : parseEmoji(emoji);
@@ -108,13 +82,7 @@ function resolvePartialEmoji(emoji) {
   return { id, name, animated: Boolean(animated) };
 }
 
-/**
- * Sets default properties on an object that aren't already specified.
- * @param {Object} def Default properties
- * @param {Object} given Object to assign defaults to
- * @returns {Object}
- * @private
- */
+
 function mergeDefault(def, given) {
   if (!given) return def;
   for (const key in def) {
@@ -128,20 +96,9 @@ function mergeDefault(def, given) {
   return given;
 }
 
-/**
- * Options used to make an error object.
- * @typedef {Object} MakeErrorOptions
- * @property {string} name Error type
- * @property {string} message Message for the error
- * @property {string} stack Stack for the error
- */
-
-/**
- * Makes an Error from a plain info object.
- * @param {MakeErrorOptions} obj Error info
- * @returns {Error}
- * @private
- */
+
+
+
 function makeError(obj) {
   const err = new Error(obj.message);
   err.name = obj.name;
@@ -149,12 +106,7 @@ function makeError(obj) {
   return err;
 }
 
-/**
- * Makes a plain error info object from an Error.
- * @param {Error} err Error to get info from
- * @returns {MakeErrorOptions}
- * @private
- */
+
 function makePlainError(err) {
   return {
     name: err.name,
@@ -163,15 +115,7 @@ function makePlainError(err) {
   };
 }
 
-/**
- * Moves an element in an array *in place*.
- * @param {Array<*>} array Array to modify
- * @param {*} element Element to move
- * @param {number} newIndex Index or offset to move the element to
- * @param {boolean} [offset=false] Move the element by an offset amount rather than to a set index
- * @returns {number}
- * @private
- */
+
 function moveElementInArray(array, element, newIndex, offset = false) {
   const index = array.indexOf(element);
   newIndex = (offset ? index : 0) + newIndex;
@@ -182,14 +126,7 @@ function moveElementInArray(array, element, newIndex, offset = false) {
   return array.indexOf(element);
 }
 
-/**
- * Verifies the provided data is a string, otherwise throws provided error.
- * @param {string} data The string resolvable to resolve
- * @param {Function} [error] The Error constructor to instantiate. Defaults to Error
- * @param {string} [errorMessage] The error message to throw with. Defaults to "Expected string, got <data> instead."
- * @param {boolean} [allowEmpty=true] Whether an empty string should be allowed
- * @returns {string}
- */
+
 function verifyString(
   data,
   error = Error,
@@ -201,51 +138,9 @@ function verifyString(
   return data;
 }
 
-/**
- * Can be a number, hex string, an RGB array like:
- * ```js
- * [255, 0, 255] // purple
- * ```
- * or one of the following strings:
- * - `Default`
- * - `White`
- * - `Aqua`
- * - `Green`
- * - `Blue`
- * - `Yellow`
- * - `Purple`
- * - `LuminousVividPink`
- * - `Fuchsia`
- * - `Gold`
- * - `Orange`
- * - `Red`
- * - `Grey`
- * - `Navy`
- * - `DarkAqua`
- * - `DarkGreen`
- * - `DarkBlue`
- * - `DarkPurple`
- * - `DarkVividPink`
- * - `DarkGold`
- * - `DarkOrange`
- * - `DarkRed`
- * - `DarkGrey`
- * - `DarkerGrey`
- * - `LightGrey`
- * - `DarkNavy`
- * - `Blurple`
- * - `Greyple`
- * - `DarkButNotBlack`
- * - `NotQuiteBlack`
- * - `Random`
- * @typedef {string|number|number[]} ColorResolvable
- */
-
-/**
- * Resolves a ColorResolvable into a color number.
- * @param {ColorResolvable} color Color to resolve
- * @returns {number} A color
- */
+
+
+
 function resolveColor(color) {
   if (typeof color === 'string') {
     if (color === 'Random') return Math.floor(Math.random() * (0xffffff + 1));
@@ -262,11 +157,7 @@ function resolveColor(color) {
   return color;
 }
 
-/**
- * Sorts by Discord's position and id.
- * @param {Collection} collection Collection of objects to sort
- * @returns {Collection}
- */
+
 function discordSort(collection) {
   const isGuildChannel = collection.first() instanceof GuildChannel;
   return collection.sorted(
@@ -276,18 +167,7 @@ function discordSort(collection) {
   );
 }
 
-/**
- * Sets the position of a Channel or Role.
- * @param {BaseChannel|Role} item Object to set the position of
- * @param {number} position New position for the object
- * @param {boolean} relative Whether `position` is relative to its current position
- * @param {Collection<string, BaseChannel|Role>} sorted A collection of the objects sorted properly
- * @param {Client} client The client to use to patch the data
- * @param {string} route Route to call PATCH on
- * @param {string} [reason] Reason for the change
- * @returns {Promise<BaseChannel[]|Role[]>} Updated item list, with `id` and `position` properties
- * @private
- */
+
 async function setPosition(item, position, relative, sorted, client, route, reason) {
   let updatedItems = [...sorted.values()];
   moveElementInArray(updatedItems, item, position, relative);
@@ -296,24 +176,13 @@ async function setPosition(item, position, relative, sorted, client, route, reas
   return updatedItems;
 }
 
-/**
- * Alternative to Node's `path.basename`, removing query string after the extension if it exists.
- * @param {string} path Path to get the basename of
- * @param {string} [ext] File extension to remove
- * @returns {string} Basename of the path
- * @private
- */
+
 function basename(path, ext) {
   const res = parse(path);
   return ext && res.ext.startsWith(ext) ? res.name : res.base.split('?')[0];
 }
 
-/**
- * The content to have all mentions replaced by the equivalent text.
- * @param {string} str The string to be converted
- * @param {TextBasedChannels} channel The channel the string was sent in
- * @returns {string}
- */
+
 function cleanContent(str, channel) {
   return str.replaceAll(/<(@[!&]?|#)(\d{17,19})>/g, (match, type, id) => {
     switch (type) {
@@ -343,20 +212,12 @@ function cleanContent(str, channel) {
   });
 }
 
-/**
- * The content to put in a code block with all code block fences replaced by the equivalent backticks.
- * @param {string} text The string to be converted
- * @returns {string}
- */
+
 function cleanCodeBlockContent(text) {
   return text.replaceAll('```', '`\u200b``');
 }
 
-/**
- * Parses a webhook URL for the id and token.
- * @param {string} url The URL to parse
- * @returns {?WebhookClientDataIdWithToken} `null` if the URL is invalid, otherwise the id and the token
- */
+
 function parseWebhookURL(url) {
   const matches = url.match(
     /https?:\/\/(?:ptb\.|canary\.)?discord\.com\/api(?:\/v\d{1,2})?\/webhooks\/(\d{17,19})\/([\w-]{68})/i,
@@ -390,5 +251,5 @@ module.exports = {
   parseWebhookURL,
 };
 
-// Fixes Circular
+
 const GuildChannel = require('../structures/GuildChannel');

package/src/util/WebSocketShardEvents.js

@@ -1,20 +1,9 @@
 'use strict';
 
-/**
- * @typedef {Object} WebSocketShardEvents
- * @property {string} Close close
- * @property {string} Destroyed destroyed
- * @property {string} InvalidSession invalidSession
- * @property {string} Ready ready
- * @property {string} Resumed resumed
- * @property {string} AllReady allReady
- */
 
-// JSDoc for IntelliSense purposes
-/**
- * @type {WebSocketShardEvents}
- * @ignore
- */
+
+
+
 module.exports = {
   Close: 'close',
   Destroyed: 'destroyed',