@discordjs/voice 1.0.0-dev.1690416599-8f4256d.0 → 1.0.0-dev.1732752782-e89c6b66a

package/README.md

@@ -32,12 +32,13 @@
 
 ## Installation
 
-**Node.js 16.9.0 or newer is required.**
+**Node.js 20 or newer is required.**
 
 ```sh
 npm install @discordjs/voice
 yarn add @discordjs/voice
 pnpm add @discordjs/voice
+bun add @discordjs/voice
 ```
 
 ## Dependencies
@@ -50,9 +51,13 @@ try installing another.
 
 **Encryption Libraries (npm install):**
 
+> [!NOTE]
+> You only need to install one of these libraries if your system does not support `aes-256-gcm` (verify by running `require('node:crypto').getCiphers().includes('aes-256-gcm')`).
+
 - `sodium-native`: ^3.3.0
 - `sodium`: ^3.0.2
-- `tweetnacl`: ^1.0.3
+- `@stablelib/xchacha20poly1305`: ^2.0.0
+- `@noble/ciphers`: ^1.0.0
 - `libsodium-wrappers`: ^0.7.9
 
 **Opus Libraries (npm install):**

package/dist/index.d.mts

@@ -76,9 +76,9 @@ declare class Node {
 /**
  * Options that are set when creating a new audio resource.
  *
- * @typeParam T - the type for the metadata (if any) of the audio resource
+ * @typeParam Metadata - the type for the metadata (if any) of the audio resource
  */
-interface CreateAudioResourceOptions<T> {
+interface CreateAudioResourceOptions<Metadata> {
     /**
      * Whether or not inline volume should be enabled. If enabled, you will be able to change the volume
      * of the stream on-the-fly. However, this also increases the performance cost of playback. Defaults to `false`.
@@ -93,7 +93,7 @@ interface CreateAudioResourceOptions<T> {
      * This is useful for identification purposes when the resource is passed around in events.
      * See {@link AudioResource.metadata}
      */
-    metadata?: T;
+    metadata?: Metadata;
     /**
      * The number of silence frames to append to the end of the resource's audio stream, to prevent interpolation glitches.
      * Defaults to 5.
@@ -103,9 +103,9 @@ interface CreateAudioResourceOptions<T> {
 /**
  * Represents an audio resource that can be played by an audio player.
  *
- * @typeParam T - the type for the metadata (if any) of the audio resource
+ * @typeParam Metadata - the type for the metadata (if any) of the audio resource
  */
-declare class AudioResource<T = unknown> {
+declare class AudioResource<Metadata = unknown> {
     /**
      * An object-mode Readable stream that emits Opus packets. This is what is played by audio players.
      */
@@ -119,7 +119,7 @@ declare class AudioResource<T = unknown> {
     /**
      * Optional metadata that can be used to identify the resource.
      */
-    metadata: T;
+    metadata: Metadata;
     /**
      * If the resource was created with inline volume transformation enabled, then this will be a
      * prism-media VolumeTransformer. You can use this to alter the volume of the stream.
@@ -150,7 +150,7 @@ declare class AudioResource<T = unknown> {
      * The number of remaining silence frames to play. If -1, the frames have not yet started playing.
      */
     silenceRemaining: number;
-    constructor(edges: readonly Edge[], streams: readonly Readable[], metadata: T, silencePaddingFrames: number);
+    constructor(edges: readonly Edge[], streams: readonly Readable[], metadata: Metadata, silencePaddingFrames: number);
     /**
      * Whether this resource is readable. If the underlying resource is no longer readable, this will still return true
      * while there are silence padding frames left to play.
@@ -183,9 +183,9 @@ declare class AudioResource<T = unknown> {
  * Opus transcoders, and Ogg/WebM demuxers.
  * @param input - The resource to play
  * @param options - Configurable options for creating the resource
- * @typeParam T - the type for the metadata (if any) of the audio resource
+ * @typeParam Metadata - the type for the metadata (if any) of the audio resource
  */
-declare function createAudioResource<T>(input: Readable | string, options: CreateAudioResourceOptions<T> & Pick<T extends null | undefined ? CreateAudioResourceOptions<T> : Required<CreateAudioResourceOptions<T>>, 'metadata'>): AudioResource<T extends null | undefined ? null : T>;
+declare function createAudioResource<Metadata>(input: Readable | string, options: CreateAudioResourceOptions<Metadata> & Pick<Metadata extends null | undefined ? CreateAudioResourceOptions<Metadata> : Required<CreateAudioResourceOptions<Metadata>>, 'metadata'>): AudioResource<Metadata extends null | undefined ? null : Metadata>;
 /**
  * Creates an audio resource that can be played by audio players.
  *
@@ -197,9 +197,9 @@ declare function createAudioResource<T>(input: Readable | string, options: Creat
  * Opus transcoders, and Ogg/WebM demuxers.
  * @param input - The resource to play
  * @param options - Configurable options for creating the resource
- * @typeParam T - the type for the metadata (if any) of the audio resource
+ * @typeParam Metadata - the type for the metadata (if any) of the audio resource
  */
-declare function createAudioResource<T extends null | undefined>(input: Readable | string, options?: Omit<CreateAudioResourceOptions<T>, 'metadata'>): AudioResource<null>;
+declare function createAudioResource<Metadata extends null | undefined>(input: Readable | string, options?: Omit<CreateAudioResourceOptions<Metadata>, 'metadata'>): AudioResource<null>;
 
 /**
  * An error emitted by an AudioPlayer. Contains an attached resource to aid with
@@ -381,8 +381,8 @@ interface AudioPlayer extends EventEmitter {
      *
      * @eventProperty
      */
-    on<T extends AudioPlayerStatus>(event: T, listener: (oldState: AudioPlayerState, newState: AudioPlayerState & {
-        status: T;
+    on<Event extends AudioPlayerStatus>(event: Event, listener: (oldState: AudioPlayerState, newState: AudioPlayerState & {
+        status: Event;
     }) => void): this;
 }
 /**
@@ -461,7 +461,7 @@ declare class AudioPlayer extends EventEmitter {
      * @param resource - The resource to play
      * @throws Will throw if attempting to play an audio resource that has already ended, or is being played by another player
      */
-    play<T>(resource: AudioResource<T>): void;
+    play<Metadata>(resource: AudioResource<Metadata>): void;
     /**
      * Pauses playback of the current resource, if any.
      *
@@ -1346,8 +1346,8 @@ interface VoiceConnection extends EventEmitter {
      *
      * @eventProperty
      */
-    on<T extends VoiceConnectionStatus>(event: T, listener: (oldState: VoiceConnectionState, newState: VoiceConnectionState & {
-        status: T;
+    on<Event extends VoiceConnectionStatus>(event: Event, listener: (oldState: VoiceConnectionState, newState: VoiceConnectionState & {
+        status: Event;
     }) => void): this;
 }
 /**
@@ -1636,9 +1636,9 @@ interface ProbeInfo {
 declare function demuxProbe(stream: Readable, probeSize?: number, validator?: typeof validateDiscordOpusHead): Promise<ProbeInfo>;
 
 /**
- * The {@link https://github.com/discordjs/discord.js/blob/main/packages/voice/#readme | @discordjs/voice} version
+ * The {@link https://github.com/discordjs/discord.js/blob/main/packages/voice#readme | @discordjs/voice} version
  * that you are currently using.
  */
 declare const version: string;
 
-export { AudioPlayer, AudioPlayerBufferingState, AudioPlayerError, AudioPlayerIdleState, AudioPlayerPausedState, AudioPlayerPlayingState, AudioPlayerState, AudioPlayerStatus, AudioReceiveStream, AudioReceiveStreamOptions, AudioResource, CreateAudioPlayerOptions, CreateAudioResourceOptions, CreateVoiceConnectionOptions, DiscordGatewayAdapterCreator, DiscordGatewayAdapterImplementerMethods, DiscordGatewayAdapterLibraryMethods, EndBehavior, EndBehaviorType, JoinConfig, JoinVoiceChannelOptions, NoSubscriberBehavior, PlayerSubscription, ProbeInfo, SSRCMap, SpeakingMap, StreamType, VoiceConnection, VoiceConnectionConnectingState, VoiceConnectionDestroyedState, VoiceConnectionDisconnectReason, VoiceConnectionDisconnectedBaseState, VoiceConnectionDisconnectedOtherState, VoiceConnectionDisconnectedState, VoiceConnectionDisconnectedWebSocketState, VoiceConnectionReadyState, VoiceConnectionSignallingState, VoiceConnectionState, VoiceConnectionStatus, VoiceReceiver, VoiceUserData, createAudioPlayer, createAudioResource, createDefaultAudioReceiveStreamOptions, demuxProbe, entersState, generateDependencyReport, getGroups, getVoiceConnection, getVoiceConnections, joinVoiceChannel, validateDiscordOpusHead, version };
+export { AudioPlayer, type AudioPlayerBufferingState, AudioPlayerError, type AudioPlayerIdleState, type AudioPlayerPausedState, type AudioPlayerPlayingState, type AudioPlayerState, AudioPlayerStatus, AudioReceiveStream, type AudioReceiveStreamOptions, AudioResource, type CreateAudioPlayerOptions, type CreateAudioResourceOptions, type CreateVoiceConnectionOptions, type DiscordGatewayAdapterCreator, type DiscordGatewayAdapterImplementerMethods, type DiscordGatewayAdapterLibraryMethods, type EndBehavior, EndBehaviorType, type JoinConfig, type JoinVoiceChannelOptions, NoSubscriberBehavior, PlayerSubscription, type ProbeInfo, SSRCMap, SpeakingMap, StreamType, VoiceConnection, type VoiceConnectionConnectingState, type VoiceConnectionDestroyedState, VoiceConnectionDisconnectReason, type VoiceConnectionDisconnectedBaseState, type VoiceConnectionDisconnectedOtherState, type VoiceConnectionDisconnectedState, type VoiceConnectionDisconnectedWebSocketState, type VoiceConnectionReadyState, type VoiceConnectionSignallingState, type VoiceConnectionState, VoiceConnectionStatus, VoiceReceiver, type VoiceUserData, createAudioPlayer, createAudioResource, createDefaultAudioReceiveStreamOptions, demuxProbe, entersState, generateDependencyReport, getGroups, getVoiceConnection, getVoiceConnections, joinVoiceChannel, validateDiscordOpusHead, version };

package/dist/index.d.ts

@@ -76,9 +76,9 @@ declare class Node {
 /**
  * Options that are set when creating a new audio resource.
  *
- * @typeParam T - the type for the metadata (if any) of the audio resource
+ * @typeParam Metadata - the type for the metadata (if any) of the audio resource
  */
-interface CreateAudioResourceOptions<T> {
+interface CreateAudioResourceOptions<Metadata> {
     /**
      * Whether or not inline volume should be enabled. If enabled, you will be able to change the volume
      * of the stream on-the-fly. However, this also increases the performance cost of playback. Defaults to `false`.
@@ -93,7 +93,7 @@ interface CreateAudioResourceOptions<T> {
      * This is useful for identification purposes when the resource is passed around in events.
      * See {@link AudioResource.metadata}
      */
-    metadata?: T;
+    metadata?: Metadata;
     /**
      * The number of silence frames to append to the end of the resource's audio stream, to prevent interpolation glitches.
      * Defaults to 5.
@@ -103,9 +103,9 @@ interface CreateAudioResourceOptions<T> {
 /**
  * Represents an audio resource that can be played by an audio player.
  *
- * @typeParam T - the type for the metadata (if any) of the audio resource
+ * @typeParam Metadata - the type for the metadata (if any) of the audio resource
  */
-declare class AudioResource<T = unknown> {
+declare class AudioResource<Metadata = unknown> {
     /**
      * An object-mode Readable stream that emits Opus packets. This is what is played by audio players.
      */
@@ -119,7 +119,7 @@ declare class AudioResource<T = unknown> {
     /**
      * Optional metadata that can be used to identify the resource.
      */
-    metadata: T;
+    metadata: Metadata;
     /**
      * If the resource was created with inline volume transformation enabled, then this will be a
      * prism-media VolumeTransformer. You can use this to alter the volume of the stream.
@@ -150,7 +150,7 @@ declare class AudioResource<T = unknown> {
      * The number of remaining silence frames to play. If -1, the frames have not yet started playing.
      */
     silenceRemaining: number;
-    constructor(edges: readonly Edge[], streams: readonly Readable[], metadata: T, silencePaddingFrames: number);
+    constructor(edges: readonly Edge[], streams: readonly Readable[], metadata: Metadata, silencePaddingFrames: number);
     /**
      * Whether this resource is readable. If the underlying resource is no longer readable, this will still return true
      * while there are silence padding frames left to play.
@@ -183,9 +183,9 @@ declare class AudioResource<T = unknown> {
  * Opus transcoders, and Ogg/WebM demuxers.
  * @param input - The resource to play
  * @param options - Configurable options for creating the resource
- * @typeParam T - the type for the metadata (if any) of the audio resource
+ * @typeParam Metadata - the type for the metadata (if any) of the audio resource
  */
-declare function createAudioResource<T>(input: Readable | string, options: CreateAudioResourceOptions<T> & Pick<T extends null | undefined ? CreateAudioResourceOptions<T> : Required<CreateAudioResourceOptions<T>>, 'metadata'>): AudioResource<T extends null | undefined ? null : T>;
+declare function createAudioResource<Metadata>(input: Readable | string, options: CreateAudioResourceOptions<Metadata> & Pick<Metadata extends null | undefined ? CreateAudioResourceOptions<Metadata> : Required<CreateAudioResourceOptions<Metadata>>, 'metadata'>): AudioResource<Metadata extends null | undefined ? null : Metadata>;
 /**
  * Creates an audio resource that can be played by audio players.
  *
@@ -197,9 +197,9 @@ declare function createAudioResource<T>(input: Readable | string, options: Creat
  * Opus transcoders, and Ogg/WebM demuxers.
  * @param input - The resource to play
  * @param options - Configurable options for creating the resource
- * @typeParam T - the type for the metadata (if any) of the audio resource
+ * @typeParam Metadata - the type for the metadata (if any) of the audio resource
  */
-declare function createAudioResource<T extends null | undefined>(input: Readable | string, options?: Omit<CreateAudioResourceOptions<T>, 'metadata'>): AudioResource<null>;
+declare function createAudioResource<Metadata extends null | undefined>(input: Readable | string, options?: Omit<CreateAudioResourceOptions<Metadata>, 'metadata'>): AudioResource<null>;
 
 /**
  * An error emitted by an AudioPlayer. Contains an attached resource to aid with
@@ -381,8 +381,8 @@ interface AudioPlayer extends EventEmitter {
      *
      * @eventProperty
      */
-    on<T extends AudioPlayerStatus>(event: T, listener: (oldState: AudioPlayerState, newState: AudioPlayerState & {
-        status: T;
+    on<Event extends AudioPlayerStatus>(event: Event, listener: (oldState: AudioPlayerState, newState: AudioPlayerState & {
+        status: Event;
     }) => void): this;
 }
 /**
@@ -461,7 +461,7 @@ declare class AudioPlayer extends EventEmitter {
      * @param resource - The resource to play
      * @throws Will throw if attempting to play an audio resource that has already ended, or is being played by another player
      */
-    play<T>(resource: AudioResource<T>): void;
+    play<Metadata>(resource: AudioResource<Metadata>): void;
     /**
      * Pauses playback of the current resource, if any.
      *
@@ -1346,8 +1346,8 @@ interface VoiceConnection extends EventEmitter {
      *
      * @eventProperty
      */
-    on<T extends VoiceConnectionStatus>(event: T, listener: (oldState: VoiceConnectionState, newState: VoiceConnectionState & {
-        status: T;
+    on<Event extends VoiceConnectionStatus>(event: Event, listener: (oldState: VoiceConnectionState, newState: VoiceConnectionState & {
+        status: Event;
     }) => void): this;
 }
 /**
@@ -1636,9 +1636,9 @@ interface ProbeInfo {
 declare function demuxProbe(stream: Readable, probeSize?: number, validator?: typeof validateDiscordOpusHead): Promise<ProbeInfo>;
 
 /**
- * The {@link https://github.com/discordjs/discord.js/blob/main/packages/voice/#readme | @discordjs/voice} version
+ * The {@link https://github.com/discordjs/discord.js/blob/main/packages/voice#readme | @discordjs/voice} version
  * that you are currently using.
  */
 declare const version: string;
 
-export { AudioPlayer, AudioPlayerBufferingState, AudioPlayerError, AudioPlayerIdleState, AudioPlayerPausedState, AudioPlayerPlayingState, AudioPlayerState, AudioPlayerStatus, AudioReceiveStream, AudioReceiveStreamOptions, AudioResource, CreateAudioPlayerOptions, CreateAudioResourceOptions, CreateVoiceConnectionOptions, DiscordGatewayAdapterCreator, DiscordGatewayAdapterImplementerMethods, DiscordGatewayAdapterLibraryMethods, EndBehavior, EndBehaviorType, JoinConfig, JoinVoiceChannelOptions, NoSubscriberBehavior, PlayerSubscription, ProbeInfo, SSRCMap, SpeakingMap, StreamType, VoiceConnection, VoiceConnectionConnectingState, VoiceConnectionDestroyedState, VoiceConnectionDisconnectReason, VoiceConnectionDisconnectedBaseState, VoiceConnectionDisconnectedOtherState, VoiceConnectionDisconnectedState, VoiceConnectionDisconnectedWebSocketState, VoiceConnectionReadyState, VoiceConnectionSignallingState, VoiceConnectionState, VoiceConnectionStatus, VoiceReceiver, VoiceUserData, createAudioPlayer, createAudioResource, createDefaultAudioReceiveStreamOptions, demuxProbe, entersState, generateDependencyReport, getGroups, getVoiceConnection, getVoiceConnections, joinVoiceChannel, validateDiscordOpusHead, version };
+export { AudioPlayer, type AudioPlayerBufferingState, AudioPlayerError, type AudioPlayerIdleState, type AudioPlayerPausedState, type AudioPlayerPlayingState, type AudioPlayerState, AudioPlayerStatus, AudioReceiveStream, type AudioReceiveStreamOptions, AudioResource, type CreateAudioPlayerOptions, type CreateAudioResourceOptions, type CreateVoiceConnectionOptions, type DiscordGatewayAdapterCreator, type DiscordGatewayAdapterImplementerMethods, type DiscordGatewayAdapterLibraryMethods, type EndBehavior, EndBehaviorType, type JoinConfig, type JoinVoiceChannelOptions, NoSubscriberBehavior, PlayerSubscription, type ProbeInfo, SSRCMap, SpeakingMap, StreamType, VoiceConnection, type VoiceConnectionConnectingState, type VoiceConnectionDestroyedState, VoiceConnectionDisconnectReason, type VoiceConnectionDisconnectedBaseState, type VoiceConnectionDisconnectedOtherState, type VoiceConnectionDisconnectedState, type VoiceConnectionDisconnectedWebSocketState, type VoiceConnectionReadyState, type VoiceConnectionSignallingState, type VoiceConnectionState, VoiceConnectionStatus, VoiceReceiver, type VoiceUserData, createAudioPlayer, createAudioResource, createDefaultAudioReceiveStreamOptions, demuxProbe, entersState, generateDependencyReport, getGroups, getVoiceConnection, getVoiceConnections, joinVoiceChannel, validateDiscordOpusHead, version };