@discordjs/ws 2.0.3 → 3.0.0-core-gateway-rl.1762368996-5fa92a1ea

package/README.md

@@ -5,12 +5,13 @@
 	</p>
 	<br />
 	<p>
-		<a href="https://discord.gg/djs"><img src="https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
+		<a href="https://discord.gg/djs"><img src="https://img.shields.io/badge/join_us-on_discord-5865F2?logo=discord&logoColor=white" alt="Discord server" /></a>
 		<a href="https://www.npmjs.com/package/@discordjs/ws"><img src="https://img.shields.io/npm/v/@discordjs/ws.svg?maxAge=3600" alt="npm version" /></a>
 		<a href="https://www.npmjs.com/package/@discordjs/ws"><img src="https://img.shields.io/npm/dt/@discordjs/ws.svg?maxAge=3600" alt="npm downloads" /></a>
-		<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Build status" /></a>
-		<a href="https://github.com/discordjs/discord.js/commits/main/packages/ws"><img alt="Last commit." src="https://img.shields.io/github/last-commit/discordjs/discord.js?logo=github&logoColor=ffffff&path=packages%2Fws"></a>
+		<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/tests.yml/badge.svg" alt="Build status" /></a>
+		<a href="https://github.com/discordjs/discord.js/commits/main/packages/ws"><img alt="Last commit." src="https://img.shields.io/github/last-commit/discordjs/discord.js?logo=github&logoColor=ffffff&path=packages%2Fws" /></a>
 		<a href="https://codecov.io/gh/discordjs/discord.js"><img src="https://codecov.io/gh/discordjs/discord.js/branch/main/graph/badge.svg?precision=2&flag=ws" alt="Code coverage" /></a>
+		<a href="https://opencollective.com/discordjs"><img src="https://img.shields.io/opencollective/backers/discordjs?maxAge=3600&logo=opencollective" alt="backers" /></a>
 	</p>
 	<p>
 		<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
@@ -24,7 +25,7 @@
 
 ## Installation
 
-**Node.js 20 or newer is required.**
+**Node.js 22.12.0 or newer is required.**
 
 ```sh
 npm install @discordjs/ws
@@ -40,16 +41,21 @@ bun add @discordjs/ws
 
 ## Example usage
 
+The example uses [ES modules](https://nodejs.org/api/esm.html#enabling).
+
 ```ts
 import { WebSocketManager, WebSocketShardEvents, CompressionMethod } from '@discordjs/ws';
 import { REST } from '@discordjs/rest';
+import type { RESTGetAPIGatewayBotResult } from 'discord-api-types/v10';
 
 const rest = new REST().setToken(process.env.DISCORD_TOKEN);
 // This example will spawn Discord's recommended shard count, all under the current process.
 const manager = new WebSocketManager({
 	token: process.env.DISCORD_TOKEN,
 	intents: 0, // for no intents
-	rest,
+	fetchGatewayInformation() {
+		return rest.get(Routes.gatewayBot()) as Promise<RESTGetAPIGatewayBotResult>;
+	},
 	// uncomment if you have zlib-sync installed and want to use compression
 	// compression: CompressionMethod.ZlibSync,
 
@@ -71,8 +77,10 @@ await manager.connect();
 const manager = new WebSocketManager({
 	token: process.env.DISCORD_TOKEN,
 	intents: 0,
-	rest,
 	shardCount: 4,
+	fetchGatewayInformation() {
+		return rest.get(Routes.gatewayBot()) as Promise<RESTGetAPIGatewayBotResult>;
+	},
 });
 
 // The manager also supports being responsible for only a subset of your shards:
@@ -82,21 +90,25 @@ const manager = new WebSocketManager({
 const manager = new WebSocketManager({
 	token: process.env.DISCORD_TOKEN,
 	intents: 0,
-	rest,
 	shardCount: 8,
 	shardIds: [0, 2, 4, 6],
+	fetchGatewayInformation() {
+		return rest.get(Routes.gatewayBot()) as Promise<RESTGetAPIGatewayBotResult>;
+	},
 });
 
 // Alternatively, if your shards are consecutive, you can pass in a range
 const manager = new WebSocketManager({
 	token: process.env.DISCORD_TOKEN,
 	intents: 0,
-	rest,
 	shardCount: 8,
 	shardIds: {
 		start: 0,
 		end: 4,
 	},
+	fetchGatewayInformation() {
+		return rest.get(Routes.gatewayBot()) as Promise<RESTGetAPIGatewayBotResult>;
+	},
 });
 ```
 
@@ -112,8 +124,10 @@ const rest = new REST().setToken(process.env.DISCORD_TOKEN);
 const manager = new WebSocketManager({
 	token: process.env.DISCORD_TOKEN,
 	intents: 0,
-	rest,
 	shardCount: 6,
+	fetchGatewayInformation() {
+		return rest.get(Routes.gatewayBot()) as Promise<RESTGetAPIGatewayBotResult>;
+	},
 	// This will cause 3 workers to spawn, 2 shards per each
 	buildStrategy: (manager) => new WorkerShardingStrategy(manager, { shardsPerWorker: 2 }),
 	// Or maybe you want all your shards under a single worker
@@ -131,7 +145,9 @@ const rest = new REST().setToken(process.env.DISCORD_TOKEN);
 const manager = new WebSocketManager({
 	token: process.env.DISCORD_TOKEN,
 	intents: 0,
-	rest,
+	fetchGatewayInformation() {
+		return rest.get(Routes.gatewayBot()) as Promise<RESTGetAPIGatewayBotResult>;
+	},
 	buildStrategy: (manager) =>
 		new WorkerShardingStrategy(manager, {
 			shardsPerWorker: 2,
@@ -179,7 +195,7 @@ parentPort!.postMessage({ custom: 'data' });
 - [Guide][guide] ([source][guide-source])
   Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
 - [discord.js Discord server][discord]
-- [Discord API Discord server][discord-api]
+- [Discord Developers Discord server][discord-developers]
 - [GitHub][source]
 - [npm][npm]
 - [Related libraries][related-libs]
@@ -197,11 +213,11 @@ If you don't understand something in the documentation, you are experiencing pro
 [website]: https://discord.js.org
 [website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
 [documentation]: https://discord.js.org/docs/packages/ws/stable
-[guide]: https://discordjs.guide/
-[guide-source]: https://github.com/discordjs/guide
-[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html
+[guide]: https://discordjs.guide
+[guide-source]: https://github.com/discordjs/discord.js/tree/main/apps/guide
+[guide-update]: https://discordjs.guide/legacy/additional-info/changes-in-v14
 [discord]: https://discord.gg/djs
-[discord-api]: https://discord.gg/discord-api
+[discord-developers]: https://discord.gg/discord-developers
 [source]: https://github.com/discordjs/discord.js/tree/main/packages/ws
 [npm]: https://www.npmjs.com/package/@discordjs/ws
 [related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries

package/dist/defaultWorker.js

@@ -39,19 +39,19 @@ var import_collection = require("@discordjs/collection");
 
 // src/strategies/context/IContextFetchingStrategy.ts
 async function managerToFetchingStrategyOptions(manager) {
-  const {
-    buildIdentifyThrottler,
-    buildStrategy,
-    retrieveSessionInfo,
-    updateSessionInfo,
-    shardCount,
-    shardIds,
-    rest,
-    ...managerOptions
-  } = manager.options;
   return {
-    ...managerOptions,
+    compression: manager.options.compression,
+    encoding: manager.options.encoding,
+    handshakeTimeout: manager.options.handshakeTimeout,
+    helloTimeout: manager.options.helloTimeout,
+    identifyProperties: manager.options.identifyProperties,
+    initialPresence: manager.options.initialPresence,
+    intents: manager.options.intents,
+    largeThreshold: manager.options.largeThreshold,
+    readyTimeout: manager.options.readyTimeout,
     token: manager.token,
+    useIdentifyCompression: manager.options.useIdentifyCompression,
+    version: manager.options.version,
     gatewayInformation: await manager.fetchGatewayInformation(),
     shardCount: await manager.getShardCount()
   };
@@ -271,16 +271,14 @@ var SimpleIdentifyThrottler = class {
    */
   async waitForIdentify(shardId, signal) {
     const key = shardId % this.maxConcurrency;
-    const state = this.states.ensure(key, () => {
-      return {
-        queue: new import_async_queue.AsyncQueue(),
-        resetsAt: Number.POSITIVE_INFINITY
-      };
-    });
+    const state = this.states.ensure(key, () => ({
+      queue: new import_async_queue.AsyncQueue(),
+      resetsAt: Number.POSITIVE_INFINITY
+    }));
     await state.queue.wait({ signal });
     try {
       const diff = state.resetsAt - Date.now();
-      if (diff <= 5e3) {
+      if (diff > 0 && diff <= 5e3) {
         const time = diff + Math.random() * 1500;
         await (0, import_promises.setTimeout)(time);
       }
@@ -431,8 +429,6 @@ var WebSocketShard = class extends import_async_event_emitter.AsyncEventEmitter
     void this.internalConnect();
     try {
       await promise;
-    } catch ({ error }) {
-      throw error;
     } finally {
       controller.abort();
     }
@@ -789,10 +785,20 @@ var WebSocketShard = class extends import_async_event_emitter.AsyncEventEmitter
         const zLibSync = await getZlibSync();
         this.zLibSyncInflate.push(import_node_buffer.Buffer.from(decompressable), flush ? zLibSync.Z_SYNC_FLUSH : zLibSync.Z_NO_FLUSH);
         if (this.zLibSyncInflate.err) {
-          this.emit(
-            "error" /* Error */,
-            new Error(`${this.zLibSyncInflate.err}${this.zLibSyncInflate.msg ? `: ${this.zLibSyncInflate.msg}` : ""}`)
-          );
+          const ZlibErrorCodes = {
+            [zLibSync.Z_NEED_DICT]: "Z_NEED_DICT",
+            [zLibSync.Z_STREAM_END]: "Z_STREAM_END",
+            [zLibSync.Z_ERRNO]: "Z_ERRNO",
+            [zLibSync.Z_STREAM_ERROR]: "Z_STREAM_ERROR",
+            [zLibSync.Z_DATA_ERROR]: "Z_DATA_ERROR",
+            [zLibSync.Z_MEM_ERROR]: "Z_MEM_ERROR",
+            [zLibSync.Z_BUF_ERROR]: "Z_BUF_ERROR",
+            [zLibSync.Z_VERSION_ERROR]: "Z_VERSION_ERROR"
+          };
+          const error = new Error(this.zLibSyncInflate.msg ?? void 0);
+          error.errno = this.zLibSyncInflate.err;
+          error.code = ZlibErrorCodes[this.zLibSyncInflate.err];
+          this.emit("error" /* Error */, error);
         }
         if (!flush) {
           return null;