discord.js 15.0.0-dev.1748650424-ef2c1bfa7 → 15.0.0-dev.1748909646-d40ceedad

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "discord.js",
-  "version": "15.0.0-dev.1748650424-ef2c1bfa7",
+  "version": "15.0.0-dev.1748909646-d40ceedad",
   "description": "A powerful library for interacting with the Discord API",
   "main": "./src/index.js",
   "types": "./typings/index.d.ts",
@@ -61,9 +61,9 @@
     "magic-bytes.js": "^1.10.0",
     "tslib": "^2.8.1",
     "undici": "7.8.0",
-    "@discordjs/builders": "^1.11.1",
     "@discordjs/collection": "^2.1.1",
     "@discordjs/rest": "^2.5.0",
+    "@discordjs/builders": "^1.11.1",
     "@discordjs/formatters": "^0.6.1",
     "@discordjs/util": "^1.1.1",
     "@discordjs/ws": "^2.0.2"
@@ -71,11 +71,9 @@
   "devDependencies": {
     "@favware/cliff-jumper": "^4.1.0",
     "@types/node": "^22.15.2",
-    "@typescript-eslint/eslint-plugin": "^8.29.0",
-    "@typescript-eslint/parser": "^8.29.0",
     "cross-env": "^7.0.3",
-    "dtslint": "4.2.1",
     "eslint": "^9.25.1",
+    "eslint-config-neon": "^0.2.7",
     "eslint-formatter-compact": "^8.40.0",
     "eslint-formatter-pretty": "^5.0.0",
     "eslint-plugin-import": "^2.31.0",
@@ -83,11 +81,10 @@
     "jest": "29.7.0",
     "prettier": "^3.5.3",
     "tsd": "^0.31.2",
-    "tslint": "6.1.3",
     "turbo": "^2.5.2",
     "typescript": "~5.8.3",
-    "@discordjs/api-extractor": "^7.52.7",
     "@discordjs/docgen": "^0.12.1",
+    "@discordjs/api-extractor": "^7.52.7",
     "@discordjs/scripts": "^0.1.0"
   },
   "engines": {
@@ -99,8 +96,8 @@
   "scripts": {
     "test": "pnpm run docs:test && pnpm run test:typescript",
     "test:typescript": "tsc --noEmit && tsd",
-    "lint": "prettier --check . && tslint typings/index.d.ts && cross-env ESLINT_USE_FLAT_CONFIG=false eslint --format=pretty src typings",
-    "format": "prettier --write . && cross-env ESLINT_USE_FLAT_CONFIG=false eslint --fix --format=pretty src",
+    "lint": "prettier --check . && cross-env TIMING=1 eslint --format=pretty scripts src typings",
+    "format": "prettier --write . && cross-env TIMING=1 eslint --fix --format=pretty scripts src typings",
     "fmt": "pnpm run format",
     "docs": "docgen -i \"./src/*.js\" \"./src/**/*.js\" -c ./docs/index.json -r ../../ -o ./docs/docs.json && pnpm run docs:new",
     "docs:test": "docgen -i \"./src/*.js\" \"./src/**/*.js\" -c ./docs/index.json -r ../../",

package/src/client/BaseClient.js

@@ -10,6 +10,7 @@ const { flatten } = require('../util/Util.js');
 
 /**
  * The base class for all clients.
+ *
  * @extends {AsyncEventEmitter}
  */
 class BaseClient extends AsyncEventEmitter {
@@ -23,6 +24,7 @@ class BaseClient extends AsyncEventEmitter {
     const defaultOptions = Options.createDefault();
     /**
      * The options the client was instantiated with
+     *
      * @type {ClientOptions}
      */
     this.options = {
@@ -51,6 +53,7 @@ class BaseClient extends AsyncEventEmitter {
 
     /**
      * The REST manager of the client
+     *
      * @type {REST}
      */
     this.rest = new REST(this.options.rest);
@@ -60,6 +63,7 @@ class BaseClient extends AsyncEventEmitter {
 
   /**
    * Destroys all assets used by the base client.
+   *
    * @returns {void}
    */
   destroy() {
@@ -69,6 +73,7 @@ class BaseClient extends AsyncEventEmitter {
 
   /**
    * Options used for deleting a webhook.
+   *
    * @typedef {Object} WebhookDeleteOptions
    * @property {string} [token] Token of the webhook
    * @property {string} [reason] The reason for deleting the webhook
@@ -76,6 +81,7 @@ class BaseClient extends AsyncEventEmitter {
 
   /**
    * Deletes a webhook.
+   *
    * @param {Snowflake} id The webhook's id
    * @param {WebhookDeleteOptions} [options] Options for deleting the webhook
    * @returns {Promise<void>}
@@ -86,6 +92,7 @@ class BaseClient extends AsyncEventEmitter {
 
   /**
    * Increments max listeners by one, if they are not zero.
+   *
    * @private
    */
   incrementMaxListeners() {
@@ -97,6 +104,7 @@ class BaseClient extends AsyncEventEmitter {
 
   /**
    * Decrements max listeners by one, if they are not zero.
+   *
    * @private
    */
   decrementMaxListeners() {

package/src/client/Client.js

@@ -6,10 +6,6 @@ const { Collection } = require('@discordjs/collection');
 const { makeURLSearchParams } = require('@discordjs/rest');
 const { WebSocketManager, WebSocketShardEvents, WebSocketShardStatus } = require('@discordjs/ws');
 const { GatewayDispatchEvents, GatewayIntentBits, OAuth2Scopes, Routes } = require('discord-api-types/v10');
-const { BaseClient } = require('./BaseClient.js');
-const { ActionsManager } = require('./actions/ActionsManager.js');
-const { ClientVoiceManager } = require('./voice/ClientVoiceManager.js');
-const { PacketHandlers } = require('./websocket/handlers/index.js');
 const { DiscordjsError, DiscordjsTypeError, ErrorCodes } = require('../errors/index.js');
 const { ChannelManager } = require('../managers/ChannelManager.js');
 const { GuildManager } = require('../managers/GuildManager.js');
@@ -32,6 +28,10 @@ const { Options } = require('../util/Options.js');
 const { PermissionsBitField } = require('../util/PermissionsBitField.js');
 const { Status } = require('../util/Status.js');
 const { Sweepers } = require('../util/Sweepers.js');
+const { BaseClient } = require('./BaseClient.js');
+const { ActionsManager } = require('./actions/ActionsManager.js');
+const { ClientVoiceManager } = require('./voice/ClientVoiceManager.js');
+const { PacketHandlers } = require('./websocket/handlers/index.js');
 
 const WaitingForGuildEvents = [GatewayDispatchEvents.GuildCreate, GatewayDispatchEvents.GuildDelete];
 const BeforeReadyWhitelist = [
@@ -46,6 +46,7 @@ const BeforeReadyWhitelist = [
 
 /**
  * The main hub for interacting with the Discord API, and the starting point for any bot.
+ *
  * @extends {BaseClient}
  */
 class Client extends BaseClient {
@@ -69,6 +70,7 @@ class Client extends BaseClient {
 
     /**
      * The presence of the Client
+     *
      * @private
      * @type {ClientPresence}
      */
@@ -78,6 +80,7 @@ class Client extends BaseClient {
 
     /**
      * The current status of this Client
+     *
      * @type {Status}
      * @private
      */
@@ -85,6 +88,7 @@ class Client extends BaseClient {
 
     /**
      * A set of guild ids this Client expects to receive
+     *
      * @name Client#expectedGuilds
      * @type {Set<string>}
      * @private
@@ -93,6 +97,7 @@ class Client extends BaseClient {
 
     /**
      * The ready timeout
+     *
      * @name Client#readyTimeout
      * @type {?NodeJS.Timeout}
      * @private
@@ -101,6 +106,7 @@ class Client extends BaseClient {
 
     /**
      * The action manager of the client
+     *
      * @type {ActionsManager}
      * @private
      */
@@ -108,6 +114,7 @@ class Client extends BaseClient {
 
     /**
      * The user manager of this client
+     *
      * @type {UserManager}
      */
     this.users = new UserManager(this);
@@ -115,6 +122,7 @@ class Client extends BaseClient {
     /**
      * A manager of all the guilds the client is currently handling -
      * as long as sharding isn't being used, this will be *every* guild the bot is a member of
+     *
      * @type {GuildManager}
      */
     this.guilds = new GuildManager(this);
@@ -124,12 +132,14 @@ class Client extends BaseClient {
      * as long as sharding isn't being used, this will be *every* channel in *every* guild the bot
      * is a member of. Note that DM channels will not be initially cached, and thus not be present
      * in the Manager without their explicit fetching or use.
+     *
      * @type {ChannelManager}
      */
     this.channels = new ChannelManager(this);
 
     /**
      * The sweeping functions and their intervals used to periodically sweep caches
+     *
      * @type {Sweepers}
      */
     this.sweepers = new Sweepers(this, this.options.sweepers);
@@ -140,6 +150,7 @@ class Client extends BaseClient {
        * Authorization token for the logged in bot.
        * If present, this defaults to `process.env.DISCORD_TOKEN` when instantiating the client
        * <warn>This should be kept private at all times.</warn>
+       *
        * @type {?string}
        */
       this.token = process.env.DISCORD_TOKEN;
@@ -159,12 +170,14 @@ class Client extends BaseClient {
 
     /**
      * The WebSocket manager of the client
+     *
      * @type {WebSocketManager}
      */
     this.ws = new WebSocketManager(wsOptions);
 
     /**
      * Shard helpers for the client (only if the process was spawned from a {@link ShardingManager})
+     *
      * @type {?ShardClientUtil}
      */
     this.shard = process.env.SHARDING_MANAGER
@@ -173,42 +186,49 @@ class Client extends BaseClient {
 
     /**
      * The voice manager of the client
+     *
      * @type {ClientVoiceManager}
      */
     this.voice = new ClientVoiceManager(this);
 
     /**
      * User that the client is logged in as
+     *
      * @type {?ClientUser}
      */
     this.user = null;
 
     /**
      * The application of this bot
+     *
      * @type {?ClientApplication}
      */
     this.application = null;
 
     /**
      * The latencies of the WebSocketShard connections
+     *
      * @type {Collection<number, number>}
      */
     this.pings = new Collection();
 
     /**
      * The last time a ping was sent (a timestamp) for each WebSocketShard connection
+     *
      * @type {Collection<number, number>}
      */
     this.lastPingTimestamps = new Collection();
 
     /**
      * Timestamp of the time the client was last {@link Status.Ready} at
+     *
      * @type {?number}
      */
     this.readyTimestamp = null;
 
     /**
      * An array of queued events before this Client became ready
+     *
      * @type {Object[]}
      * @private
      * @name Client#incomingPacketQueue
@@ -221,6 +241,7 @@ class Client extends BaseClient {
   /**
    * Time at which the client was last regarded as being in the {@link Status.Ready} state
    * (each time the client disconnects and successfully reconnects, this will be overwritten)
+   *
    * @type {?Date}
    * @readonly
    */
@@ -230,6 +251,7 @@ class Client extends BaseClient {
 
   /**
    * How long it has been since the client last entered the {@link Status.Ready} state in milliseconds
+   *
    * @type {?number}
    * @readonly
    */
@@ -239,6 +261,7 @@ class Client extends BaseClient {
 
   /**
    * Logs the client in, establishing a WebSocket connection to Discord.
+   *
    * @param {string} [token=this.token] Token of the account to log in with
    * @returns {Promise<string>} Token of the account used
    * @example
@@ -246,7 +269,7 @@ class Client extends BaseClient {
    */
   async login(token = this.token) {
     if (!token || typeof token !== 'string') throw new DiscordjsError(ErrorCodes.TokenInvalid);
-    this.token = token.replace(/^(Bot|Bearer)\s*/i, '');
+    this.token = token.replace(/^bot\s*/i, '');
 
     this.rest.setToken(this.token);
 
@@ -266,6 +289,7 @@ class Client extends BaseClient {
 
   /**
    * Checks if the client can be marked as ready
+   *
    * @private
    */
   async _checkReady() {
@@ -274,6 +298,7 @@ class Client extends BaseClient {
       clearTimeout(this.readyTimeout);
       this.readyTimeout = null;
     }
+
     // Step 1. If we don't have any other guilds pending, we are ready
     if (
       !this.expectedGuilds.size &&
@@ -284,6 +309,7 @@ class Client extends BaseClient {
       this._triggerClientReady();
       return;
     }
+
     const hasGuildsIntent = this.options.intents.has(GatewayIntentBits.Guilds);
     // Step 2. Create a timeout that will mark the client as ready if there are still unavailable guilds
     // * The timeout is 15 seconds by default
@@ -311,6 +337,7 @@ class Client extends BaseClient {
 
   /**
    * Attaches event handlers to the WebSocketShardManager from `@discordjs/ws`.
+   *
    * @private
    */
   _attachEvents() {
@@ -319,12 +346,13 @@ class Client extends BaseClient {
     );
     this.ws.on(WebSocketShardEvents.Dispatch, this._handlePacket.bind(this));
 
-    this.ws.on(WebSocketShardEvents.Ready, data => {
+    this.ws.on(WebSocketShardEvents.Ready, async data => {
       for (const guild of data.guilds) {
         this.expectedGuilds.add(guild.id);
       }
+
       this.status = Status.WaitingForGuilds;
-      this._checkReady();
+      await this._checkReady();
     });
 
     this.ws.on(WebSocketShardEvents.HeartbeatComplete, ({ heartbeatAt, latency }, shardId) => {
@@ -336,18 +364,19 @@ class Client extends BaseClient {
 
   /**
    * Processes a packet and queues it if this WebSocketManager is not ready.
+   *
    * @param {GatewayDispatchPayload} packet The packet to be handled
    * @param {number} shardId The shardId that received this packet
    * @private
    */
-  _handlePacket(packet, shardId) {
+  async _handlePacket(packet, shardId) {
     if (this.status !== Status.Ready && !BeforeReadyWhitelist.includes(packet.t)) {
       this.incomingPacketQueue.push({ packet, shardId });
     } else {
       if (this.incomingPacketQueue.length) {
         const item = this.incomingPacketQueue.shift();
-        setImmediate(() => {
-          this._handlePacket(item.packet, item.shardId);
+        setImmediate(async () => {
+          await this._handlePacket(item.packet, item.shardId);
         }).unref();
       }
 
@@ -357,13 +386,14 @@ class Client extends BaseClient {
 
       if (this.status === Status.WaitingForGuilds && WaitingForGuildEvents.includes(packet.t)) {
         this.expectedGuilds.delete(packet.d.id);
-        this._checkReady();
+        await this._checkReady();
       }
     }
   }
 
   /**
    * Broadcasts a packet to every shard of this client handles.
+   *
    * @param {Object} packet The packet to send
    * @private
    */
@@ -374,6 +404,7 @@ class Client extends BaseClient {
 
   /**
    * Causes the client to be marked as ready and emits the ready event.
+   *
    * @private
    */
   _triggerClientReady() {
@@ -383,6 +414,7 @@ class Client extends BaseClient {
 
     /**
      * Emitted when the client becomes ready to start working.
+     *
      * @event Client#clientReady
      * @param {Client} client The client
      */
@@ -392,6 +424,7 @@ class Client extends BaseClient {
   /**
    * Returns whether the client has logged in, indicative of being able to access
    * properties such as `user` and `application`.
+   *
    * @returns {boolean}
    */
   isReady() {
@@ -400,6 +433,7 @@ class Client extends BaseClient {
 
   /**
    * The average ping of all WebSocketShards
+   *
    * @type {?number}
    * @readonly
    */
@@ -409,6 +443,7 @@ class Client extends BaseClient {
 
   /**
    * Logs out, terminates the connection to Discord, and destroys the client.
+   *
    * @returns {Promise<void>}
    */
   async destroy() {
@@ -422,6 +457,7 @@ class Client extends BaseClient {
 
   /**
    * Options used when fetching an invite from Discord.
+   *
    * @typedef {Object} ClientFetchInviteOptions
    * @property {Snowflake} [guildScheduledEventId] The id of the guild scheduled event to include with
    * the invite
@@ -429,6 +465,7 @@ class Client extends BaseClient {
 
   /**
    * Obtains an invite from Discord.
+   *
    * @param {InviteResolvable} invite Invite code or URL
    * @param {ClientFetchInviteOptions} [options] Options for fetching the invite
    * @returns {Promise<Invite>}
@@ -449,6 +486,7 @@ class Client extends BaseClient {
 
   /**
    * Obtains a template from Discord.
+   *
    * @param {GuildTemplateResolvable} template Template code or URL
    * @returns {Promise<GuildTemplate>}
    * @example
@@ -464,6 +502,7 @@ class Client extends BaseClient {
 
   /**
    * Obtains a webhook from Discord.
+   *
    * @param {Snowflake} id The webhook's id
    * @param {string} [token] Token for the webhook
    * @returns {Promise<Webhook>}
@@ -479,6 +518,7 @@ class Client extends BaseClient {
 
   /**
    * Obtains the available voice regions from Discord.
+   *
    * @returns {Promise<Collection<string, VoiceRegion>>}
    * @example
    * client.fetchVoiceRegions()
@@ -494,6 +534,7 @@ class Client extends BaseClient {
 
   /**
    * Obtains a sticker from Discord.
+   *
    * @param {Snowflake} id The sticker's id
    * @returns {Promise<Sticker>}
    * @example
@@ -508,12 +549,14 @@ class Client extends BaseClient {
 
   /**
    * Options for fetching sticker packs.
+   *
    * @typedef {Object} StickerPackFetchOptions
    * @property {Snowflake} [packId] The id of the sticker pack to fetch
    */
 
   /**
    * Obtains the list of available sticker packs.
+   *
    * @param {StickerPackFetchOptions} [options={}] Options for fetching sticker packs
    * @returns {Promise<Collection<Snowflake, StickerPack>|StickerPack>}
    * A collection of sticker packs, or a single sticker pack if a packId was provided
@@ -528,8 +571,8 @@ class Client extends BaseClient {
    */
   async fetchStickerPacks({ packId } = {}) {
     if (packId) {
-      const data = await this.rest.get(Routes.stickerPack(packId));
-      return new StickerPack(this, data);
+      const innerData = await this.rest.get(Routes.stickerPack(packId));
+      return new StickerPack(this, innerData);
     }
 
     const data = await this.rest.get(Routes.stickerPacks());
@@ -538,6 +581,7 @@ class Client extends BaseClient {
 
   /**
    * Obtains the list of default soundboard sounds.
+   *
    * @returns {Promise<Collection<string, SoundboardSound>>}
    * @example
    * client.fetchDefaultSoundboardSounds()
@@ -551,6 +595,7 @@ class Client extends BaseClient {
 
   /**
    * Obtains a guild preview from Discord, available for all guilds the bot is in and all Discoverable guilds.
+   *
    * @param {GuildResolvable} guild The guild to fetch the preview for
    * @returns {Promise<GuildPreview>}
    */
@@ -563,6 +608,7 @@ class Client extends BaseClient {
 
   /**
    * Obtains the widget data of a guild from Discord, available for guilds with the widget enabled.
+   *
    * @param {GuildResolvable} guild The guild to fetch the widget data for
    * @returns {Promise<Widget>}
    */
@@ -575,6 +621,7 @@ class Client extends BaseClient {
 
   /**
    * Options for {@link Client#generateInvite}.
+   *
    * @typedef {Object} InviteGenerationOptions
    * @property {OAuth2Scopes[]} scopes Scopes that should be requested
    * @property {PermissionResolvable} [permissions] Permissions to request
@@ -584,6 +631,7 @@ class Client extends BaseClient {
 
   /**
    * Generates a link that can be used to invite the bot to a guild.
+   *
    * @param {InviteGenerationOptions} [options={}] Options for the invite
    * @returns {string}
    * @example
@@ -610,15 +658,19 @@ class Client extends BaseClient {
     if (scopes === undefined) {
       throw new DiscordjsTypeError(ErrorCodes.InvalidMissingScopes);
     }
+
     if (!Array.isArray(scopes)) {
       throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'scopes', 'Array of Invite Scopes', true);
     }
+
     if (!scopes.some(scope => [OAuth2Scopes.Bot, OAuth2Scopes.ApplicationsCommands].includes(scope))) {
       throw new DiscordjsTypeError(ErrorCodes.InvalidMissingScopes);
     }
+
     if (!scopes.includes(OAuth2Scopes.Bot) && options.permissions) {
       throw new DiscordjsTypeError(ErrorCodes.InvalidScopesWithPermissions);
     }
+
     const validScopes = Object.values(OAuth2Scopes);
     const invalidScope = scopes.find(scope => !validScopes.includes(scope));
     if (invalidScope) {
@@ -654,6 +706,7 @@ class Client extends BaseClient {
 
   /**
    * Partially censored client token for debug logging purposes.
+   *
    * @type {?string}
    * @readonly
    * @private
@@ -663,23 +716,26 @@ class Client extends BaseClient {
 
     return this.token
       .split('.')
-      .map((val, i) => (i > 1 ? val.replace(/./g, '*') : val))
+      .map((val, index) => (index > 1 ? val.replaceAll(/./g, '*') : val))
       .join('.');
   }
 
   /**
    * Calls {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/eval} on a script
    * with the client as `this`.
+   *
    * @param {string} script Script to eval
    * @returns {*}
    * @private
    */
   _eval(script) {
+    // eslint-disable-next-line no-eval
     return eval(script);
   }
 
   /**
    * Validates the client options.
+   *
    * @param {ClientOptions} [options=this.options] Options to validate
    * @private
    */
@@ -689,30 +745,38 @@ class Client extends BaseClient {
     } else {
       options.intents = new IntentsBitField(options.intents ?? options.ws.intents).freeze();
     }
+
     if (typeof options.sweepers !== 'object' || options.sweepers === null) {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'sweepers', 'an object');
     }
+
     if (!Array.isArray(options.partials)) {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'partials', 'an Array');
     }
-    if (typeof options.waitGuildTimeout !== 'number' || isNaN(options.waitGuildTimeout)) {
+
+    if (typeof options.waitGuildTimeout !== 'number' || Number.isNaN(options.waitGuildTimeout)) {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'waitGuildTimeout', 'a number');
     }
+
     if (typeof options.failIfNotExists !== 'boolean') {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'failIfNotExists', 'a boolean');
     }
+
     if (typeof options.enforceNonce !== 'boolean') {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'enforceNonce', 'a boolean');
     }
+
     if (
       (typeof options.allowedMentions !== 'object' && options.allowedMentions !== undefined) ||
       options.allowedMentions === null
     ) {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'allowedMentions', 'an object');
     }
+
     if (typeof options.ws !== 'object' || options.ws === null) {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'ws', 'an object');
     }
+
     if (
       (typeof options.presence !== 'object' || options.presence === null) &&
       options.ws.initialPresence === undefined
@@ -721,9 +785,11 @@ class Client extends BaseClient {
     } else {
       options.ws.initialPresence = options.ws.initialPresence ?? this.presence._parse(this.options.presence);
     }
+
     if (typeof options.rest !== 'object' || options.rest === null) {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'rest', 'an object');
     }
+
     if (typeof options.jsonTransformer !== 'function') {
       throw new DiscordjsTypeError(ErrorCodes.ClientInvalidOption, 'jsonTransformer', 'a function');
     }
@@ -754,17 +820,20 @@ exports.Client = Client;
  *  000000111011000111100001101001000101000000  00001  00000  000000000000
  *  number of milliseconds since Discord epoch  worker  pid    increment
  * ```
+ *
  * @typedef {string} Snowflake
  */
 
 /**
  * Emitted for general debugging information.
+ *
  * @event Client#debug
  * @param {string} info The debug information
  */
 
 /**
  * Emitted for general warnings.
+ *
  * @event Client#warn
  * @param {string} info The warning
  */