discord.js 14.24.1 → 14.25.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "discord.js",
-  "version": "14.24.1",
+  "version": "14.25.0",
   "description": "A powerful library for interacting with the Discord API",
   "main": "./src/index.js",
   "types": "./typings/index.d.ts",
@@ -53,19 +53,19 @@
   "homepage": "https://discord.js.org",
   "funding": "https://github.com/discordjs/discord.js?sponsor",
   "dependencies": {
-    "@discordjs/builders": "^1.13.0",
     "@discordjs/collection": "1.5.3",
-    "@discordjs/formatters": "^0.6.1",
     "@discordjs/ws": "^1.2.3",
     "@sapphire/snowflake": "3.5.3",
-    "discord-api-types": "^0.38.31",
+    "discord-api-types": "^0.38.33",
     "fast-deep-equal": "3.1.3",
     "lodash.snakecase": "4.1.1",
     "magic-bytes.js": "^1.10.0",
     "tslib": "^2.6.3",
     "undici": "6.21.3",
+    "@discordjs/builders": "^1.13.0",
+    "@discordjs/formatters": "^0.6.2",
     "@discordjs/rest": "^2.6.0",
-    "@discordjs/util": "^1.1.1"
+    "@discordjs/util": "^1.2.0"
   },
   "devDependencies": {
     "@favware/cliff-jumper": "^4.1.0",

package/src/client/websocket/handlers/RATE_LIMITED.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const process = require('node:process');
+const { GatewayOpcodes } = require('discord-api-types/v10');
+
+const emittedFor = new Set();
+
+module.exports = (_, { d: data }) => {
+  switch (data.opcode) {
+    case GatewayOpcodes.RequestGuildMembers: {
+      break;
+    }
+
+    default: {
+      if (!emittedFor.has(data.opcode)) {
+        process.emitWarning(
+          // eslint-disable-next-line max-len
+          `Hit a gateway rate limit on opcode ${data.opcode} (${GatewayOpcodes[data.opcode]}). If the discord.js version you're using is up-to-date, please open an issue on GitHub.`,
+        );
+
+        emittedFor.add(data.opcode);
+      }
+    }
+  }
+};

package/src/client/websocket/handlers/index.js

@@ -52,6 +52,7 @@ const handlers = Object.fromEntries([
   ['MESSAGE_REACTION_REMOVE_EMOJI', require('./MESSAGE_REACTION_REMOVE_EMOJI')],
   ['MESSAGE_UPDATE', require('./MESSAGE_UPDATE')],
   ['PRESENCE_UPDATE', require('./PRESENCE_UPDATE')],
+  ['RATE_LIMITED', require('./RATE_LIMITED')],
   ['READY', require('./READY')],
   ['RESUMED', require('./RESUMED')],
   ['SOUNDBOARD_SOUNDS', require('./SOUNDBOARD_SOUNDS')],

package/src/managers/GuildBanManager.js

@@ -120,12 +120,12 @@ class GuildBanManager extends CachedManager {
     return this._add(data, cache);
   }
 
-  async _fetchMany(options = {}) {
+  async _fetchMany({ cache, ...apiOptions } = {}) {
     const data = await this.client.rest.get(Routes.guildBans(this.guild.id), {
-      query: makeURLSearchParams(options),
+      query: makeURLSearchParams(apiOptions),
     });
 
-    return data.reduce((col, ban) => col.set(ban.user.id, this._add(ban, options.cache)), new Collection());
+    return data.reduce((col, ban) => col.set(ban.user.id, this._add(ban, cache)), new Collection());
   }
 
   /**

package/src/managers/GuildEmojiRoleManager.js

@@ -31,7 +31,15 @@ class GuildEmojiRoleManager extends DataManager {
    * @readonly
    */
   get cache() {
-    return this.guild.roles.cache.filter(role => this.emoji._roles.includes(role.id));
+    const cache = new Collection();
+    for (const roleId of this.emoji._roles) {
+      const role = this.guild.roles.cache.get(roleId);
+      if (role !== undefined) {
+        cache.set(roleId, role);
+      }
+    }
+
+    return cache;
   }
 
   /**

package/src/managers/GuildMemberManager.js

@@ -4,8 +4,9 @@ const { process } = require('node:process');
 const { setTimeout, clearTimeout } = require('node:timers');
 const { Collection } = require('@discordjs/collection');
 const { makeURLSearchParams } = require('@discordjs/rest');
+const { GatewayRateLimitError } = require('@discordjs/util');
 const { DiscordSnowflake } = require('@sapphire/snowflake');
-const { Routes, GatewayOpcodes } = require('discord-api-types/v10');
+const { Routes, GatewayOpcodes, GatewayDispatchEvents } = require('discord-api-types/v10');
 const CachedManager = require('./CachedManager');
 const { DiscordjsError, DiscordjsTypeError, DiscordjsRangeError, ErrorCodes } = require('../errors');
 const BaseGuildVoiceChannel = require('../structures/BaseGuildVoiceChannel');
@@ -239,19 +240,25 @@ class GuildMemberManager extends CachedManager {
 
     return new Promise((resolve, reject) => {
       if (!query && !users) query = '';
-      this.guild.shard.send({
-        op: GatewayOpcodes.RequestGuildMembers,
-        d: {
-          guild_id: this.guild.id,
-          presences,
-          user_ids: users,
-          query,
-          nonce,
-          limit,
-        },
-      });
       const fetchedMembers = new Collection();
       let i = 0;
+
+      const cleanup = () => {
+        /* eslint-disable no-use-before-define */
+        clearTimeout(timeout);
+
+        this.client.removeListener(Events.Raw, rateLimitHandler);
+        this.client.decrementMaxListeners();
+        this.client.removeListener(Events.GuildMembersChunk, handler);
+        this.client.decrementMaxListeners();
+        /* eslint-enable no-use-before-define */
+      };
+
+      const timeout = setTimeout(() => {
+        cleanup();
+        reject(new DiscordjsError(ErrorCodes.GuildMembersTimeout));
+      }, time).unref();
+
       const handler = (members, _, chunk) => {
         if (chunk.nonce !== nonce) return;
         timeout.refresh();
@@ -260,19 +267,37 @@ class GuildMemberManager extends CachedManager {
           fetchedMembers.set(member.id, member);
         }
         if (members.size < 1_000 || (limit && fetchedMembers.size >= limit) || i === chunk.count) {
-          clearTimeout(timeout);
-          this.client.removeListener(Events.GuildMembersChunk, handler);
-          this.client.decrementMaxListeners();
+          cleanup();
           resolve(users && !Array.isArray(users) && fetchedMembers.size ? fetchedMembers.first() : fetchedMembers);
         }
       };
-      const timeout = setTimeout(() => {
-        this.client.removeListener(Events.GuildMembersChunk, handler);
-        this.client.decrementMaxListeners();
-        reject(new DiscordjsError(ErrorCodes.GuildMembersTimeout));
-      }, time).unref();
+
+      const requestData = {
+        guild_id: this.guild.id,
+        presences,
+        user_ids: users,
+        query,
+        nonce,
+        limit,
+      };
+
+      const rateLimitHandler = payload => {
+        if (payload.t === GatewayDispatchEvents.RateLimited && payload.d.meta.nonce === nonce) {
+          cleanup();
+          reject(new GatewayRateLimitError(payload.d, requestData));
+        }
+      };
+
+      this.client.incrementMaxListeners();
+      this.client.on(Events.Raw, rateLimitHandler);
+
       this.client.incrementMaxListeners();
       this.client.on(Events.GuildMembersChunk, handler);
+
+      this.guild.shard.send({
+        op: GatewayOpcodes.RequestGuildMembers,
+        d: requestData,
+      });
     });
   }
 

package/src/managers/GuildMemberRoleManager.js

@@ -33,8 +33,17 @@ class GuildMemberRoleManager extends DataManager {
    * @readonly
    */
   get cache() {
-    const everyone = this.guild.roles.everyone;
-    return this.guild.roles.cache.filter(role => this.member._roles.includes(role.id)).set(everyone.id, everyone);
+    const cache = new Collection();
+    cache.set(this.guild.id, this.guild.roles.everyone);
+
+    for (const roleId of this.member._roles) {
+      const role = this.guild.roles.cache.get(roleId);
+      if (role !== undefined) {
+        cache.set(roleId, role);
+      }
+    }
+
+    return cache;
   }
 
   /**

package/src/managers/MessageManager.js

@@ -111,12 +111,12 @@ class MessageManager extends CachedManager {
     return this._add(data, cache);
   }
 
-  async _fetchMany(options = {}) {
+  async _fetchMany({ cache, ...apiOptions } = {}) {
     const data = await this.client.rest.get(Routes.channelMessages(this.channel.id), {
-      query: makeURLSearchParams(options),
+      query: makeURLSearchParams(apiOptions),
     });
 
-    return data.reduce((_data, message) => _data.set(message.id, this._add(message, options.cache)), new Collection());
+    return data.reduce((_data, message) => _data.set(message.id, this._add(message, cache)), new Collection());
   }
 
   /**
@@ -146,8 +146,8 @@ class MessageManager extends CachedManager {
    */
 
   /**
-   * Fetches the pinned messages of this channel and returns a collection of them.
-   * <info>The returned Collection does not contain any reaction data of the messages.
+   * Fetches the pinned messages of this channel, returning a paginated result.
+   * <info>The returned messages do not contain any reaction data.
    * Those need to be fetched separately.</info>
    *
    * @param {FetchPinnedMessagesOptions} [options={}] Options for fetching pinned messages
@@ -158,11 +158,11 @@ class MessageManager extends CachedManager {
    *   .then(messages => console.log(`Received ${messages.items.length} messages`))
    *   .catch(console.error);
    */
-  async fetchPins(options = {}) {
+  async fetchPins({ cache, ...apiOptions } = {}) {
     const data = await this.client.rest.get(Routes.channelMessagesPins(this.channel.id), {
       query: makeURLSearchParams({
-        ...options,
-        before: options.before && new Date(options.before).toISOString(),
+        ...apiOptions,
+        before: apiOptions.before && new Date(apiOptions.before).toISOString(),
       }),
     });
 
@@ -172,7 +172,7 @@ class MessageManager extends CachedManager {
         get pinnedAt() {
           return new Date(this.pinnedTimestamp);
         },
-        message: this._add(item.message, options.cache),
+        message: this._add(item.message, cache),
       })),
       hasMore: data.has_more,
     };

package/src/structures/GuildMember.js

@@ -24,12 +24,6 @@ class GuildMember extends Base {
      */
     this.guild = guild;
 
-    /**
-     * The timestamp the member joined the guild at
-     * @type {?number}
-     */
-    this.joinedTimestamp = null;
-
     /**
      * The last timestamp this member started boosting the guild
      * @type {?number}
@@ -62,7 +56,7 @@ class GuildMember extends Base {
      */
     Object.defineProperty(this, '_roles', { value: [], writable: true });
 
-    if (data) this._patch(data);
+    this._patch(data);
   }
 
   _patch(data) {
@@ -95,7 +89,17 @@ class GuildMember extends Base {
       this.banner ??= null;
     }
 
-    if ('joined_at' in data) this.joinedTimestamp = Date.parse(data.joined_at);
+    if ('joined_at' in data) {
+      /**
+       * The timestamp the member joined the guild at
+       *
+       * @type {?number}
+       */
+      this.joinedTimestamp = data.joined_at && Date.parse(data.joined_at);
+    } else {
+      this.joinedTimestamp ??= null;
+    }
+
     if ('premium_since' in data) {
       this.premiumSinceTimestamp = data.premium_since ? Date.parse(data.premium_since) : null;
     }

package/src/structures/PermissionOverwrites.js

@@ -22,7 +22,7 @@ class PermissionOverwrites extends Base {
      */
     Object.defineProperty(this, 'channel', { value: channel });
 
-    if (data) this._patch(data);
+    this._patch(data);
   }
 
   _patch(data) {

package/src/structures/Role.js

@@ -34,7 +34,7 @@ class Role extends Base {
      */
     this.unicodeEmoji = null;
 
-    if (data) this._patch(data);
+    this._patch(data);
   }
 
   _patch(data) {

package/src/structures/ThreadChannel.js

@@ -49,7 +49,7 @@ class ThreadChannel extends BaseChannel {
      * @type {ThreadMemberManager}
      */
     this.members = new ThreadMemberManager(this);
-    if (data) this._patch(data);
+    this._patch(data);
   }
 
   _patch(data) {

package/src/structures/Webhook.js

@@ -22,7 +22,7 @@ class Webhook {
      * @readonly
      */
     Object.defineProperty(this, 'client', { value: client });
-    if (data) this._patch(data);
+    this._patch(data);
   }
 
   _patch(data) {

package/typings/index.d.mts

@@ -3841,7 +3841,7 @@ export interface PrivateThreadChannel extends ThreadChannel<false> {
 export interface ThreadChannel<ThreadOnly extends boolean = boolean>
   extends Omit<TextBasedChannelFields<true>, 'fetchWebhooks' | 'createWebhook' | 'setNSFW'> {}
 export class ThreadChannel<ThreadOnly extends boolean = boolean> extends BaseChannel {
-  private constructor(guild: Guild, data?: RawThreadChannelData, client?: Client<true>);
+  private constructor(guild: Guild, data: RawThreadChannelData, client?: Client<true>);
   public archived: boolean | null;
   public get archivedAt(): Date | null;
   public archiveTimestamp: number | null;
@@ -4234,7 +4234,7 @@ export class VoiceState extends Base {
 // tslint:disable-next-line no-empty-interface
 export interface Webhook<Type extends WebhookType = WebhookType> extends WebhookFields {}
 export class Webhook<Type extends WebhookType = WebhookType> {
-  private constructor(client: Client<true>, data?: RawWebhookData);
+  private constructor(client: Client<true>, data: RawWebhookData);
   public avatar: string | null;
   public avatarURL(options?: ImageURLOptions): string | null;
   public channelId: Snowflake;

package/typings/index.d.ts

@@ -3841,7 +3841,7 @@ export interface PrivateThreadChannel extends ThreadChannel<false> {
 export interface ThreadChannel<ThreadOnly extends boolean = boolean>
   extends Omit<TextBasedChannelFields<true>, 'fetchWebhooks' | 'createWebhook' | 'setNSFW'> {}
 export class ThreadChannel<ThreadOnly extends boolean = boolean> extends BaseChannel {
-  private constructor(guild: Guild, data?: RawThreadChannelData, client?: Client<true>);
+  private constructor(guild: Guild, data: RawThreadChannelData, client?: Client<true>);
   public archived: boolean | null;
   public get archivedAt(): Date | null;
   public archiveTimestamp: number | null;
@@ -4234,7 +4234,7 @@ export class VoiceState extends Base {
 // tslint:disable-next-line no-empty-interface
 export interface Webhook<Type extends WebhookType = WebhookType> extends WebhookFields {}
 export class Webhook<Type extends WebhookType = WebhookType> {
-  private constructor(client: Client<true>, data?: RawWebhookData);
+  private constructor(client: Client<true>, data: RawWebhookData);
   public avatar: string | null;
   public avatarURL(options?: ImageURLOptions): string | null;
   public channelId: Snowflake;