@discordjs/voice 0.9.0-dev.1649505804-3c0bbac → 0.9.0

package/README.md

@@ -47,6 +47,7 @@ try installing another.
 
 **Encryption Libraries (npm install):**
 
+- `sodium-native`: ^3.3.0
 - `sodium`: ^3.0.2
 - `tweetnacl`: ^1.0.3
 - `libsodium-wrappers`: ^0.7.9

package/dist/index.d.ts

@@ -1,10 +1,8 @@
+import { TypedEmitter } from 'tiny-typed-emitter';
 import { Readable, ReadableOptions } from 'node:stream';
 import prism from 'prism-media';
-import { TypedEmitter } from 'tiny-typed-emitter';
-import { GatewayVoiceServerUpdateDispatchData, GatewayVoiceStateUpdateDispatchData } from 'discord-api-types/v10';
 import WebSocket, { MessageEvent } from 'ws';
-
-declare type Awaited<T> = T | Promise<T>;
+import { GatewayVoiceServerUpdateDispatchData, GatewayVoiceStateUpdateDispatchData } from 'discord-api-types/v10';
 
 /**
  * The different types of stream that can exist within the pipeline.
@@ -232,6 +230,8 @@ declare class PlayerSubscription {
     unsubscribe(): void;
 }
 
+declare type Awaited<T> = T | Promise<T>;
+
 /**
  * Describes the behavior of the player when an audio packet is played but there are no available
  * voice connections to play to.
@@ -542,54 +542,6 @@ declare function getVoiceConnections(group: string): Map<string, VoiceConnection
  */
 declare function getVoiceConnection(guildId: string, group?: string): VoiceConnection | undefined;
 
-/**
- * Methods that are provided by the @discordjs/voice library to implementations of
- * Discord gateway DiscordGatewayAdapters.
- */
-interface DiscordGatewayAdapterLibraryMethods {
-    /**
-     * Call this when you receive a VOICE_SERVER_UPDATE payload that is relevant to the adapter.
-     *
-     * @param data - The inner data of the VOICE_SERVER_UPDATE payload
-     */
-    onVoiceServerUpdate: (data: GatewayVoiceServerUpdateDispatchData) => void;
-    /**
-     * Call this when you receive a VOICE_STATE_UPDATE payload that is relevant to the adapter.
-     *
-     * @param data - The inner data of the VOICE_STATE_UPDATE payload
-     */
-    onVoiceStateUpdate: (data: GatewayVoiceStateUpdateDispatchData) => void;
-    /**
-     * Call this when the adapter can no longer be used (e.g. due to a disconnect from the main gateway)
-     */
-    destroy: () => void;
-}
-/**
- * Methods that are provided by the implementer of a Discord gateway DiscordGatewayAdapter.
- */
-interface DiscordGatewayAdapterImplementerMethods {
-    /**
-     * Implement this method such that the given payload is sent to the main Discord gateway connection.
-     *
-     * @param payload - The payload to send to the main Discord gateway connection
-     *
-     * @returns `false` if the payload definitely failed to send - in this case, the voice connection disconnects
-     */
-    sendPayload: (payload: any) => boolean;
-    /**
-     * This will be called by @discordjs/voice when the adapter can safely be destroyed as it will no
-     * longer be used.
-     */
-    destroy: () => void;
-}
-/**
- * A function used to build adapters. It accepts a methods parameter that contains functions that
- * can be called by the implementer when new data is received on its gateway connection. In return,
- * the implementer will return some methods that the library can call - e.g. to send messages on
- * the gateway, or to signal that the adapter can be removed.
- */
-declare type DiscordGatewayAdapterCreator = (methods: DiscordGatewayAdapterLibraryMethods) => DiscordGatewayAdapterImplementerMethods;
-
 /**
  * Stores an IP address and port. Used to store socket details for the local client as well as
  * for Discord.
@@ -1041,37 +993,6 @@ declare class AudioReceiveStream extends Readable {
     _read(): void;
 }
 
-/**
- * The events that a SpeakingMap can emit.
- */
-interface SpeakingMapEvents {
-    /**
-     * Emitted when a user starts speaking.
-     */
-    start: (userId: string) => Awaited<void>;
-    /**
-     * Emitted when a user stops speaking.
-     */
-    end: (userId: string) => Awaited<void>;
-}
-/**
- * Tracks the speaking states of users in a voice channel.
- */
-declare class SpeakingMap extends TypedEmitter<SpeakingMapEvents> {
-    /**
-     * The delay after a packet is received from a user until they're marked as not speaking anymore.
-     */
-    static readonly DELAY = 100;
-    /**
-     * The currently speaking users, mapped to the milliseconds since UNIX epoch at which they started speaking.
-     */
-    readonly users: Map<string, number>;
-    private readonly speakingTimeouts;
-    constructor();
-    onPacket(userId: string): void;
-    private startTimeout;
-}
-
 /**
  * The known data for a user in a Discord voice connection.
  */
@@ -1129,6 +1050,37 @@ declare class SSRCMap extends TypedEmitter<SSRCMapEvents> {
     delete(target: number | string): VoiceUserData | undefined;
 }
 
+/**
+ * The events that a SpeakingMap can emit.
+ */
+interface SpeakingMapEvents {
+    /**
+     * Emitted when a user starts speaking.
+     */
+    start: (userId: string) => Awaited<void>;
+    /**
+     * Emitted when a user stops speaking.
+     */
+    end: (userId: string) => Awaited<void>;
+}
+/**
+ * Tracks the speaking states of users in a voice channel.
+ */
+declare class SpeakingMap extends TypedEmitter<SpeakingMapEvents> {
+    /**
+     * The delay after a packet is received from a user until they're marked as not speaking anymore.
+     */
+    static readonly DELAY = 100;
+    /**
+     * The currently speaking users, mapped to the milliseconds since UNIX epoch at which they started speaking.
+     */
+    readonly users: Map<string, number>;
+    private readonly speakingTimeouts;
+    constructor();
+    onPacket(userId: string): void;
+    private startTimeout;
+}
+
 /**
  * Attaches to a VoiceConnection, allowing you to receive audio packets from other
  * users that are speaking.
@@ -1197,6 +1149,54 @@ declare class VoiceReceiver {
     subscribe(userId: string, options?: Partial<AudioReceiveStreamOptions>): AudioReceiveStream;
 }
 
+/**
+ * Methods that are provided by the @discordjs/voice library to implementations of
+ * Discord gateway DiscordGatewayAdapters.
+ */
+interface DiscordGatewayAdapterLibraryMethods {
+    /**
+     * Call this when you receive a VOICE_SERVER_UPDATE payload that is relevant to the adapter.
+     *
+     * @param data - The inner data of the VOICE_SERVER_UPDATE payload
+     */
+    onVoiceServerUpdate: (data: GatewayVoiceServerUpdateDispatchData) => void;
+    /**
+     * Call this when you receive a VOICE_STATE_UPDATE payload that is relevant to the adapter.
+     *
+     * @param data - The inner data of the VOICE_STATE_UPDATE payload
+     */
+    onVoiceStateUpdate: (data: GatewayVoiceStateUpdateDispatchData) => void;
+    /**
+     * Call this when the adapter can no longer be used (e.g. due to a disconnect from the main gateway)
+     */
+    destroy: () => void;
+}
+/**
+ * Methods that are provided by the implementer of a Discord gateway DiscordGatewayAdapter.
+ */
+interface DiscordGatewayAdapterImplementerMethods {
+    /**
+     * Implement this method such that the given payload is sent to the main Discord gateway connection.
+     *
+     * @param payload - The payload to send to the main Discord gateway connection
+     *
+     * @returns `false` if the payload definitely failed to send - in this case, the voice connection disconnects
+     */
+    sendPayload: (payload: any) => boolean;
+    /**
+     * This will be called by @discordjs/voice when the adapter can safely be destroyed as it will no
+     * longer be used.
+     */
+    destroy: () => void;
+}
+/**
+ * A function used to build adapters. It accepts a methods parameter that contains functions that
+ * can be called by the implementer when new data is received on its gateway connection. In return,
+ * the implementer will return some methods that the library can call - e.g. to send messages on
+ * the gateway, or to signal that the adapter can be removed.
+ */
+declare type DiscordGatewayAdapterCreator = (methods: DiscordGatewayAdapterLibraryMethods) => DiscordGatewayAdapterImplementerMethods;
+
 /**
  * The various status codes a voice connection can hold at any one time.
  */

package/dist/index.js

@@ -6,7 +6,6 @@ var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __commonJS = (cb, mod) => function __require() {
   return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
@@ -15,22 +14,16 @@ var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
 };
-var __reExport = (target, module2, copyDefault, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
-  return target;
-};
-var __toESM = (module2, isNodeMode) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", !isNodeMode && module2 && module2.__esModule ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
+  return to;
 };
-var __toCommonJS = /* @__PURE__ */ ((cache) => {
-  return (module2, temp) => {
-    return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
-  };
-})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var __publicField = (obj, key, value) => {
   __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
@@ -41,7 +34,7 @@ var require_package = __commonJS({
   "package.json"(exports, module2) {
     module2.exports = {
       name: "@discordjs/voice",
-      version: "0.9.0-dev",
+      version: "0.9.0",
       description: "Implementation of the Discord Voice API for node.js",
       scripts: {
         build: "tsup && node scripts/postbuild.mjs",
@@ -91,7 +84,7 @@ var require_package = __commonJS({
       },
       homepage: "https://discord.js.org",
       dependencies: {
-        "@types/ws": "^8.2.2",
+        "@types/ws": "^8.5.3",
         "discord-api-types": "^0.29.0",
         "prism-media": "^1.3.2",
         "tiny-typed-emitter": "^2.1.0",
@@ -99,26 +92,26 @@ var require_package = __commonJS({
         ws: "^8.5.0"
       },
       devDependencies: {
-        "@babel/core": "^7.17.2",
+        "@babel/core": "^7.17.9",
         "@babel/preset-env": "^7.16.11",
         "@babel/preset-typescript": "^7.16.7",
-        "@discordjs/ts-docgen": "^0.3.4",
-        "@types/jest": "^27.4.0",
-        "@types/node": "^16.11.24",
-        "@typescript-eslint/eslint-plugin": "^5.11.0",
-        "@typescript-eslint/parser": "^5.11.0",
-        eslint: "^8.9.0",
-        "eslint-config-marine": "^9.3.2",
-        "eslint-config-prettier": "^8.3.0",
-        "eslint-plugin-prettier": "^4.0.0",
+        "@discordjs/ts-docgen": "^0.4.1",
+        "@types/jest": "^27.4.1",
+        "@types/node": "^16.11.27",
+        "@typescript-eslint/eslint-plugin": "^5.19.0",
+        "@typescript-eslint/parser": "^5.19.0",
+        eslint: "^8.13.0",
+        "eslint-config-marine": "^9.4.1",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-import": "^2.26.0",
         jest: "^27.5.1",
         "jest-websocket-mock": "^2.3.0",
         "mock-socket": "^9.1.2",
-        prettier: "^2.5.1",
-        tsup: "^5.11.13",
+        prettier: "^2.6.2",
+        tsup: "^5.12.5",
         tweetnacl: "^1.0.3",
-        typedoc: "^0.22.11",
-        typescript: "^4.5.5"
+        typedoc: "^0.22.15",
+        typescript: "^4.6.3"
       },
       engines: {
         node: ">=16.9.0"
@@ -160,6 +153,10 @@ __export(src_exports, {
   joinVoiceChannel: () => joinVoiceChannel,
   validateDiscordOpusHead: () => validateDiscordOpusHead
 });
+module.exports = __toCommonJS(src_exports);
+
+// src/VoiceConnection.ts
+var import_tiny_typed_emitter7 = require("tiny-typed-emitter");
 
 // src/DataStore.ts
 var import_v10 = require("discord-api-types/v10");
@@ -261,6 +258,7 @@ __name(deleteAudioPlayer, "deleteAudioPlayer");
 
 // src/networking/Networking.ts
 var import_v42 = require("discord-api-types/voice/v4");
+var import_tiny_typed_emitter3 = require("tiny-typed-emitter");
 
 // src/networking/VoiceUDPSocket.ts
 var import_node_dgram = require("dgram");
@@ -365,8 +363,8 @@ __name(VoiceUDPSocket, "VoiceUDPSocket");
 
 // src/networking/VoiceWebSocket.ts
 var import_v4 = require("discord-api-types/voice/v4");
-var import_ws = __toESM(require("ws"));
 var import_tiny_typed_emitter2 = require("tiny-typed-emitter");
+var import_ws = __toESM(require("ws"));
 var VoiceWebSocket = class extends import_tiny_typed_emitter2.TypedEmitter {
   constructor(address, debug) {
     super();
@@ -452,12 +450,29 @@ __name(VoiceWebSocket, "VoiceWebSocket");
 
 // src/util/Secretbox.ts
 var libs = {
+  "sodium-native": (sodium) => ({
+    open: (buffer, nonce2, secretKey) => {
+      if (buffer) {
+        const output = Buffer.allocUnsafe(buffer.length - sodium.crypto_box_MACBYTES);
+        if (sodium.crypto_secretbox_open_easy(output, buffer, nonce2, secretKey))
+          return output;
+      }
+      return null;
+    },
+    close: (opusPacket, nonce2, secretKey) => {
+      const output = Buffer.allocUnsafe(opusPacket.length + sodium.crypto_box_MACBYTES);
+      sodium.crypto_secretbox_easy(output, opusPacket, nonce2, secretKey);
+      return output;
+    },
+    random: (n, buffer = Buffer.allocUnsafe(n)) => {
+      sodium.randombytes_buf(buffer);
+      return buffer;
+    }
+  }),
   sodium: (sodium) => ({
     open: sodium.api.crypto_secretbox_open_easy,
     close: sodium.api.crypto_secretbox_easy,
-    random: (n, buffer) => {
-      if (!buffer)
-        buffer = Buffer.allocUnsafe(n);
+    random: (n, buffer = Buffer.allocUnsafe(n)) => {
       sodium.api.randombytes_buf(buffer);
       return buffer;
     }
@@ -465,12 +480,12 @@ var libs = {
   "libsodium-wrappers": (sodium) => ({
     open: sodium.crypto_secretbox_open_easy,
     close: sodium.crypto_secretbox_easy,
-    random: (n) => sodium.randombytes_buf(n)
+    random: sodium.randombytes_buf
   }),
   tweetnacl: (tweetnacl) => ({
     open: tweetnacl.secretbox.open,
     close: tweetnacl.secretbox,
-    random: (n) => tweetnacl.randomBytes(n)
+    random: tweetnacl.randomBytes
   })
 };
 var fallbackError = /* @__PURE__ */ __name(() => {
@@ -502,7 +517,6 @@ var noop = /* @__PURE__ */ __name(() => {
 }, "noop");
 
 // src/networking/Networking.ts
-var import_tiny_typed_emitter3 = require("tiny-typed-emitter");
 var CHANNELS = 2;
 var TIMESTAMP_INC = 48e3 / 100 * CHANNELS;
 var MAX_NONCE_SIZE = 2 ** 32 - 1;
@@ -792,15 +806,15 @@ to ${stringifyState(newState)}`);
 };
 __name(Networking, "Networking");
 
-// src/VoiceConnection.ts
-var import_tiny_typed_emitter7 = require("tiny-typed-emitter");
-
 // src/receive/VoiceReceiver.ts
 var import_v43 = require("discord-api-types/voice/v4");
 
 // src/receive/AudioReceiveStream.ts
 var import_node_stream = require("stream");
 
+// src/audio/AudioPlayer.ts
+var import_tiny_typed_emitter4 = require("tiny-typed-emitter");
+
 // src/audio/AudioPlayerError.ts
 var AudioPlayerError = class extends Error {
   constructor(error, resource) {
@@ -829,7 +843,6 @@ var PlayerSubscription = class {
 __name(PlayerSubscription, "PlayerSubscription");
 
 // src/audio/AudioPlayer.ts
-var import_tiny_typed_emitter4 = require("tiny-typed-emitter");
 var SILENCE_FRAME = Buffer.from([248, 255, 254]);
 var NoSubscriberBehavior = /* @__PURE__ */ ((NoSubscriberBehavior2) => {
   NoSubscriberBehavior2["Pause"] = "pause";
@@ -1145,41 +1158,9 @@ var AudioReceiveStream = class extends import_node_stream.Readable {
 };
 __name(AudioReceiveStream, "AudioReceiveStream");
 
-// src/receive/SpeakingMap.ts
-var import_tiny_typed_emitter5 = require("tiny-typed-emitter");
-var _SpeakingMap = class extends import_tiny_typed_emitter5.TypedEmitter {
-  constructor() {
-    super();
-    __publicField(this, "users");
-    __publicField(this, "speakingTimeouts");
-    this.users = /* @__PURE__ */ new Map();
-    this.speakingTimeouts = /* @__PURE__ */ new Map();
-  }
-  onPacket(userId) {
-    const timeout = this.speakingTimeouts.get(userId);
-    if (timeout) {
-      clearTimeout(timeout);
-    } else {
-      this.users.set(userId, Date.now());
-      this.emit("start", userId);
-    }
-    this.startTimeout(userId);
-  }
-  startTimeout(userId) {
-    this.speakingTimeouts.set(userId, setTimeout(() => {
-      this.emit("end", userId);
-      this.speakingTimeouts.delete(userId);
-      this.users.delete(userId);
-    }, _SpeakingMap.DELAY));
-  }
-};
-var SpeakingMap = _SpeakingMap;
-__name(SpeakingMap, "SpeakingMap");
-__publicField(SpeakingMap, "DELAY", 100);
-
 // src/receive/SSRCMap.ts
-var import_tiny_typed_emitter6 = require("tiny-typed-emitter");
-var SSRCMap = class extends import_tiny_typed_emitter6.TypedEmitter {
+var import_tiny_typed_emitter5 = require("tiny-typed-emitter");
+var SSRCMap = class extends import_tiny_typed_emitter5.TypedEmitter {
   constructor() {
     super();
     __publicField(this, "map");
@@ -1228,6 +1209,38 @@ var SSRCMap = class extends import_tiny_typed_emitter6.TypedEmitter {
 };
 __name(SSRCMap, "SSRCMap");
 
+// src/receive/SpeakingMap.ts
+var import_tiny_typed_emitter6 = require("tiny-typed-emitter");
+var _SpeakingMap = class extends import_tiny_typed_emitter6.TypedEmitter {
+  constructor() {
+    super();
+    __publicField(this, "users");
+    __publicField(this, "speakingTimeouts");
+    this.users = /* @__PURE__ */ new Map();
+    this.speakingTimeouts = /* @__PURE__ */ new Map();
+  }
+  onPacket(userId) {
+    const timeout = this.speakingTimeouts.get(userId);
+    if (timeout) {
+      clearTimeout(timeout);
+    } else {
+      this.users.set(userId, Date.now());
+      this.emit("start", userId);
+    }
+    this.startTimeout(userId);
+  }
+  startTimeout(userId) {
+    this.speakingTimeouts.set(userId, setTimeout(() => {
+      this.emit("end", userId);
+      this.speakingTimeouts.delete(userId);
+      this.users.delete(userId);
+    }, _SpeakingMap.DELAY));
+  }
+};
+var SpeakingMap = _SpeakingMap;
+__name(SpeakingMap, "SpeakingMap");
+__publicField(SpeakingMap, "DELAY", 100);
+
 // src/receive/VoiceReceiver.ts
 var VoiceReceiver = class {
   constructor(voiceConnection) {
@@ -1685,6 +1698,10 @@ function joinVoiceChannel(options) {
 }
 __name(joinVoiceChannel, "joinVoiceChannel");
 
+// src/audio/AudioResource.ts
+var import_node_stream2 = require("stream");
+var import_prism_media2 = __toESM(require("prism-media"));
+
 // src/audio/TransformerGraph.ts
 var import_prism_media = __toESM(require("prism-media"));
 var FFMPEG_PCM_ARGUMENTS = ["-analyzeduration", "0", "-loglevel", "0", "-f", "s16le", "-ar", "48000", "-ac", "2"];
@@ -1829,8 +1846,6 @@ function findPipeline(from, constraint) {
 __name(findPipeline, "findPipeline");
 
 // src/audio/AudioResource.ts
-var import_node_stream2 = require("stream");
-var import_prism_media2 = __toESM(require("prism-media"));
 var AudioResource = class {
   constructor(edges, streams, metadata, silencePaddingFrames) {
     __publicField(this, "playStream");
@@ -1963,6 +1978,7 @@ function generateDependencyReport() {
   addVersion("opusscript");
   report.push("");
   report.push("Encryption Libraries");
+  addVersion("sodium-native");
   addVersion("sodium");
   addVersion("libsodium-wrappers");
   addVersion("tweetnacl");
@@ -1979,6 +1995,9 @@ function generateDependencyReport() {
 }
 __name(generateDependencyReport, "generateDependencyReport");
 
+// src/util/entersState.ts
+var import_node_events = require("events");
+
 // src/util/abortAfter.ts
 function abortAfter(delay) {
   const ac = new AbortController();
@@ -1989,7 +2008,6 @@ function abortAfter(delay) {
 __name(abortAfter, "abortAfter");
 
 // src/util/entersState.ts
-var import_node_events = require("events");
 async function entersState(target, status, timeoutOrSignal) {
   if (target.state.status !== status) {
     const [ac, signal] = typeof timeoutOrSignal === "number" ? abortAfter(timeoutOrSignal) : [void 0, timeoutOrSignal];
@@ -2074,7 +2092,6 @@ function demuxProbe(stream, probeSize = 1024, validator = validateDiscordOpusHea
   });
 }
 __name(demuxProbe, "demuxProbe");
-module.exports = __toCommonJS(src_exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AudioPlayer,