@discordjs/ws 3.0.0-dev.1753316119-f2fec9177 → 3.0.0-dev.1753613929-c0c1ac287

package/dist/index.d.mts

@@ -1,7 +1,6 @@
 import { Awaitable } from '@discordjs/util';
-import { GatewayDispatchPayload, GatewayReadyDispatchData, GatewaySendPayload, GatewayOpcodes, GatewayIntentBits, APIGatewayBotInfo, RESTGetAPIGatewayBotResult, GatewayIdentifyProperties, GatewayPresenceUpdateData } from 'discord-api-types/v10';
+import { GatewayDispatchPayload, GatewayReadyDispatchData, GatewaySendPayload, GatewayOpcodes, RESTGetAPIGatewayBotResult, GatewayIntentBits, APIGatewayBotInfo, GatewayIdentifyProperties, GatewayPresenceUpdateData } from 'discord-api-types/v10';
 import { Collection } from '@discordjs/collection';
-import { REST } from '@discordjs/rest';
 import { AsyncEventEmitter } from '@vladfrangu/async_event_emitter';
 import { AsyncQueue } from '@sapphire/async-queue';
 
@@ -273,6 +272,22 @@ interface SessionInfo {
  * Required options for the WebSocketManager
  */
 interface RequiredWebSocketManagerOptions {
+    /**
+     * Function for retrieving the information returned by the `/gateway/bot` endpoint.
+     * We recommend using a REST client that respects Discord's rate limits, such as `@discordjs/rest`.
+     *
+     * @example
+     * ```ts
+     * const rest = new REST().setToken(process.env.DISCORD_TOKEN);
+     * const manager = new WebSocketManager({
+     *  token: process.env.DISCORD_TOKEN,
+     *  fetchGatewayInformation() {
+     *    return rest.get(Routes.gatewayBot()) as Promise<RESTGetAPIGatewayBotResult>;
+     *  },
+     * });
+     * ```
+     */
+    fetchGatewayInformation(): Awaitable<RESTGetAPIGatewayBotResult>;
     /**
      * The intents to request
      */
@@ -291,10 +306,13 @@ interface OptionalWebSocketManagerOptions {
      *
      * @example
      * ```ts
+     * const rest = new REST().setToken(process.env.DISCORD_TOKEN);
      * const manager = new WebSocketManager({
      *  token: process.env.DISCORD_TOKEN,
      *  intents: 0, // for no intents
-     *  rest,
+     *  fetchGatewayInformation() {
+     *    return rest.get(Routes.gatewayBot()) as Promise<RESTGetAPIGatewayBotResult>;
+     *  },
      *  buildStrategy: (manager) => new WorkerShardingStrategy(manager, { shardsPerWorker: 2 }),
      * });
      * ```
@@ -312,21 +330,6 @@ interface OptionalWebSocketManagerOptions {
      * @defaultValue `'json'`
      */
     encoding: Encoding;
-    /**
-     * Fetches the initial gateway URL used to connect to Discord. When missing, this will default to the gateway URL
-     * that Discord returns from the `/gateway/bot` route.
-     *
-     * @example
-     * ```ts
-     * const manager = new WebSocketManager({
-     *  token: process.env.DISCORD_TOKEN,
-     *  fetchGatewayInformation() {
-     *    return rest.get(Routes.gatewayBot());
-     *  },
-     * })
-     * ```
-     */
-    fetchGatewayInformation(): Awaitable<RESTGetAPIGatewayBotResult>;
     /**
      * How long to wait for a shard to connect before giving up
      */
@@ -351,12 +354,6 @@ interface OptionalWebSocketManagerOptions {
      * How long to wait for a shard's READY packet before giving up
      */
     readyTimeout: number | null;
-    /**
-     * The REST instance to use for fetching gateway information
-     *
-     * @deprecated Providing a REST instance is deprecated. Provide the `fetchGatewayInformation` function instead.
-     */
-    rest?: REST;
     /**
      * Function used to retrieve session information (and attempt to resume) for a given shard
      *

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import { Awaitable } from '@discordjs/util';
-import { GatewayDispatchPayload, GatewayReadyDispatchData, GatewaySendPayload, GatewayOpcodes, GatewayIntentBits, APIGatewayBotInfo, RESTGetAPIGatewayBotResult, GatewayIdentifyProperties, GatewayPresenceUpdateData } from 'discord-api-types/v10';
+import { GatewayDispatchPayload, GatewayReadyDispatchData, GatewaySendPayload, GatewayOpcodes, RESTGetAPIGatewayBotResult, GatewayIntentBits, APIGatewayBotInfo, GatewayIdentifyProperties, GatewayPresenceUpdateData } from 'discord-api-types/v10';
 import { Collection } from '@discordjs/collection';
-import { REST } from '@discordjs/rest';
 import { AsyncEventEmitter } from '@vladfrangu/async_event_emitter';
 import { AsyncQueue } from '@sapphire/async-queue';
 
@@ -273,6 +272,22 @@ interface SessionInfo {
  * Required options for the WebSocketManager
  */
 interface RequiredWebSocketManagerOptions {
+    /**
+     * Function for retrieving the information returned by the `/gateway/bot` endpoint.
+     * We recommend using a REST client that respects Discord's rate limits, such as `@discordjs/rest`.
+     *
+     * @example
+     * ```ts
+     * const rest = new REST().setToken(process.env.DISCORD_TOKEN);
+     * const manager = new WebSocketManager({
+     *  token: process.env.DISCORD_TOKEN,
+     *  fetchGatewayInformation() {
+     *    return rest.get(Routes.gatewayBot()) as Promise<RESTGetAPIGatewayBotResult>;
+     *  },
+     * });
+     * ```
+     */
+    fetchGatewayInformation(): Awaitable<RESTGetAPIGatewayBotResult>;
     /**
      * The intents to request
      */
@@ -291,10 +306,13 @@ interface OptionalWebSocketManagerOptions {
      *
      * @example
      * ```ts
+     * const rest = new REST().setToken(process.env.DISCORD_TOKEN);
      * const manager = new WebSocketManager({
      *  token: process.env.DISCORD_TOKEN,
      *  intents: 0, // for no intents
-     *  rest,
+     *  fetchGatewayInformation() {
+     *    return rest.get(Routes.gatewayBot()) as Promise<RESTGetAPIGatewayBotResult>;
+     *  },
      *  buildStrategy: (manager) => new WorkerShardingStrategy(manager, { shardsPerWorker: 2 }),
      * });
      * ```
@@ -312,21 +330,6 @@ interface OptionalWebSocketManagerOptions {
      * @defaultValue `'json'`
      */
     encoding: Encoding;
-    /**
-     * Fetches the initial gateway URL used to connect to Discord. When missing, this will default to the gateway URL
-     * that Discord returns from the `/gateway/bot` route.
-     *
-     * @example
-     * ```ts
-     * const manager = new WebSocketManager({
-     *  token: process.env.DISCORD_TOKEN,
-     *  fetchGatewayInformation() {
-     *    return rest.get(Routes.gatewayBot());
-     *  },
-     * })
-     * ```
-     */
-    fetchGatewayInformation(): Awaitable<RESTGetAPIGatewayBotResult>;
     /**
      * How long to wait for a shard to connect before giving up
      */
@@ -351,12 +354,6 @@ interface OptionalWebSocketManagerOptions {
      * How long to wait for a shard's READY packet before giving up
      */
     readyTimeout: number | null;
-    /**
-     * The REST instance to use for fetching gateway information
-     *
-     * @deprecated Providing a REST instance is deprecated. Provide the `fetchGatewayInformation` function instead.
-     */
-    rest?: REST;
     /**
      * Function used to retrieve session information (and attempt to resume) for a given shard
      *

package/dist/index.js

@@ -518,7 +518,7 @@ var CompressionMethod = /* @__PURE__ */ ((CompressionMethod2) => {
   CompressionMethod2[CompressionMethod2["ZlibSync"] = 1] = "ZlibSync";
   return CompressionMethod2;
 })(CompressionMethod || {});
-var DefaultDeviceProperty = `@discordjs/ws 3.0.0-dev.1753316119-f2fec9177`;
+var DefaultDeviceProperty = `@discordjs/ws 3.0.0-dev.1753613929-c0c1ac287`;
 var getDefaultSessionStore = (0, import_util.lazy)(() => new import_collection4.Collection());
 var CompressionParameterMap = {
   [0 /* ZlibNative */]: "zlib-stream",
@@ -1449,7 +1449,6 @@ var WorkerBootstrapper = class {
 // src/ws/WebSocketManager.ts
 var import_util3 = require("@discordjs/util");
 var import_async_event_emitter2 = require("@vladfrangu/async_event_emitter");
-var import_v103 = require("discord-api-types/v10");
 var WebSocketManager = class extends import_async_event_emitter2.AsyncEventEmitter {
   static {
     __name(this, "WebSocketManager");
@@ -1487,18 +1486,12 @@ var WebSocketManager = class extends import_async_event_emitter2.AsyncEventEmitt
     return this.#token;
   }
   constructor(options) {
-    if (!options.rest && !options.fetchGatewayInformation) {
-      throw new RangeError("Either a REST instance or a fetchGatewayInformation function must be provided");
+    if (typeof options.fetchGatewayInformation !== "function") {
+      throw new TypeError("fetchGatewayInformation is required");
     }
     super();
     this.options = {
       ...DefaultWebSocketManagerOptions,
-      fetchGatewayInformation: options.fetchGatewayInformation ?? (async () => {
-        if (!options.rest) {
-          throw new RangeError("A REST instance must be provided if no fetchGatewayInformation function is provided");
-        }
-        return options.rest.get(import_v103.Routes.gatewayBot());
-      }),
       ...options
     };
     this.strategy = this.options.buildStrategy(this);
@@ -1598,7 +1591,7 @@ var WebSocketManager = class extends import_async_event_emitter2.AsyncEventEmitt
 };
 
 // src/index.ts
-var version = "3.0.0-dev.1753316119-f2fec9177";
+var version = "3.0.0-dev.1753613929-c0c1ac287";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CloseCodes,