lavalink-client 2.3.6 → 2.4.1

package/dist/esm/structures/Filters.js

@@ -42,29 +42,29 @@ export class FilterManager {
             filterWidth: 0
         },
         timescale: {
-            speed: 1,
-            pitch: 1,
+            speed: 1, // 0 = x
+            pitch: 1, // 0 = x
             rate: 1 // 0 = x
         },
         rotation: {
             rotationHz: 0
         },
         tremolo: {
-            frequency: 0,
+            frequency: 0, // 0 < x
             depth: 0 // 0 < x = 1
         },
         vibrato: {
-            frequency: 0,
+            frequency: 0, // 0 < x <= 14
             depth: 0 // 0 < x <= 1
         },
         pluginFilters: {
             "lavalink-filter-plugin": {
                 echo: {
-                    delay: 0,
+                    delay: 0, // in seconds
                     decay: 0 // 0 < 1
                 },
                 reverb: {
-                    delays: [],
+                    delays: [], // [0.037, 0.042, 0.048, 0.053]
                     gains: [] // [0.84, 0.83, 0.82, 0.81]
                 }
             },
@@ -228,8 +228,8 @@ export class FilterManager {
                 filterWidth: 0
             },
             timescale: {
-                speed: 1,
-                pitch: 1,
+                speed: 1, // 0 = x
+                pitch: 1, // 0 = x
                 rate: 1 // 0 = x
             },
             pluginFilters: {
@@ -264,11 +264,11 @@ export class FilterManager {
                 rotationHz: 0
             },
             tremolo: {
-                frequency: 0,
+                frequency: 0, // 0 < x
                 depth: 0 // 0 < x = 1
             },
             vibrato: {
-                frequency: 0,
+                frequency: 0, // 0 < x = 14
                 depth: 0 // 0 < x = 1
             },
             channelMix: audioOutputsData.stereo,
@@ -428,6 +428,12 @@ export class FilterManager {
         return this.filters.lowPass;
     }
     lavalinkLavaDspxPlugin = {
+        /**
+         * Enables / Disables the LowPass effect, (Optional: provide your Own Data)
+         * @param boostFactor
+         * @param cutoffFrequency
+         * @returns
+         */
         toggleLowPass: async (boostFactor = 1.0, cutoffFrequency = 80) => {
             if (this.player.node.info && !this.player.node.info?.plugins?.find(v => v.name === "lavadspx-plugin"))
                 throw new Error("Node#Info#plugins does not include the lavadspx plugin");
@@ -452,6 +458,12 @@ export class FilterManager {
             await this.applyPlayerFilters();
             return this.filters.lavalinkLavaDspxPlugin.lowPass;
         },
+        /**
+         * Enables / Disables the HighPass effect, (Optional: provide your Own Data)
+         * @param boostFactor
+         * @param cutoffFrequency
+         * @returns
+         */
         toggleHighPass: async (boostFactor = 1.0, cutoffFrequency = 80) => {
             if (this.player.node.info && !this.player.node.info?.plugins?.find(v => v.name === "lavadspx-plugin"))
                 throw new Error("Node#Info#plugins does not include the lavadspx plugin");
@@ -476,6 +488,12 @@ export class FilterManager {
             await this.applyPlayerFilters();
             return this.filters.lavalinkLavaDspxPlugin.highPass;
         },
+        /**
+         * Enables / Disables the Normalization effect.
+         * @param {number} [maxAmplitude=0.75] - The maximum amplitude of the audio.
+         * @param {boolean} [adaptive=true] - Whether to use adaptive normalization or not.
+         * @returns {Promise<boolean>} - The state of the filter after execution.
+         */
         toggleNormalization: async (maxAmplitude = 0.75, adaptive = true) => {
             if (this.player.node.info && !this.player.node.info?.plugins?.find(v => v.name === "lavadspx-plugin"))
                 throw new Error("Node#Info#plugins does not include the lavadspx plugin");
@@ -500,6 +518,12 @@ export class FilterManager {
             await this.applyPlayerFilters();
             return this.filters.lavalinkLavaDspxPlugin.normalization;
         },
+        /**
+         * Enables / Disables the Echo effect, IMPORTANT! Only works with the correct Lavalink Plugin installed. (Optional: provide your Own Data)
+         * @param {number} [decay=0.5] - The decay of the echo effect.
+         * @param {number} [echoLength=0.5] - The length of the echo effect.
+         * @returns {Promise<boolean>} - The state of the filter after execution.
+         */
         toggleEcho: async (decay = 0.5, echoLength = 0.5) => {
             if (this.player.node.info && !this.player.node.info?.plugins?.find(v => v.name === "lavadspx-plugin"))
                 throw new Error("Node#Info#plugins does not include the lavadspx plugin");

package/dist/esm/structures/LavalinkManager.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from "events";
 import { NodeManager } from "./NodeManager.js";
 import { Player } from "./Player.js";
@@ -137,7 +136,7 @@ export declare class LavalinkManager extends EventEmitter {
      * ```
      * @returns
      */
-    getPlayer(guildId: string): Player;
+    getPlayer(guildId: string): Player | undefined;
     /**
      * Create a Music-Player. If a player exists, then it returns it before creating a new one
      * @param options
@@ -175,7 +174,7 @@ export declare class LavalinkManager extends EventEmitter {
      * // recommend to do it on the player tho: player.destroy("forcefully destroyed the player");
      * ```
      */
-    destroyPlayer(guildId: string, destroyReason?: string): Promise<Player>;
+    destroyPlayer(guildId: string, destroyReason?: string): Promise<void | Player>;
     /**
      * Delete's a player from the cache without destroying it on lavalink (only works when it's disconnected)
      * @param guildId
@@ -187,7 +186,7 @@ export declare class LavalinkManager extends EventEmitter {
      * // shouldn't be used except you know what you are doing.
      * ```
      */
-    deletePlayer(guildId: string): boolean;
+    deletePlayer(guildId: string): boolean | void;
     /**
      * Checks wether the the lib is useable based on if any node is connected
      *
@@ -213,7 +212,7 @@ export declare class LavalinkManager extends EventEmitter {
      * });
      * ```
      */
-    init(clientData: BotClientOptions): Promise<this>;
+    init(clientData: BotClientOptions): Promise<LavalinkManager>;
     /**
      * Sends voice data to the Lavalink server.
      * ! Without this the library won't work

package/dist/esm/structures/LavalinkManager.js

@@ -89,9 +89,9 @@ export class LavalinkManager extends EventEmitter {
                 volumeDecrementer: options?.playerOptions?.volumeDecrementer ?? 1,
                 requesterTransformer: options?.playerOptions?.requesterTransformer ?? null,
                 useUnresolvedData: options?.playerOptions?.useUnresolvedData ?? false,
-                minAutoPlayMs: options?.playerOptions?.minAutoPlayMs ?? 10000,
+                minAutoPlayMs: options?.playerOptions?.minAutoPlayMs ?? 10_000,
                 maxErrorsPerTime: {
-                    threshold: options?.playerOptions?.maxErrorsPerTime?.threshold ?? 35000,
+                    threshold: options?.playerOptions?.maxErrorsPerTime?.threshold ?? 35_000,
                     maxAmount: options?.playerOptions?.maxErrorsPerTime?.maxAmount ?? 3
                 }
             },
@@ -108,7 +108,7 @@ export class LavalinkManager extends EventEmitter {
             },
             advancedOptions: {
                 enableDebugEvents: options?.advancedOptions?.enableDebugEvents ?? false,
-                maxFilterFixDuration: options?.advancedOptions?.maxFilterFixDuration ?? 600000,
+                maxFilterFixDuration: options?.advancedOptions?.maxFilterFixDuration ?? 600_000,
                 debugOptions: {
                     logCustomSearches: options?.advancedOptions?.debugOptions?.logCustomSearches ?? false,
                     noAudio: options?.advancedOptions?.debugOptions?.noAudio ?? false,
@@ -483,34 +483,51 @@ export class LavalinkManager extends EventEmitter {
             if ("token" in update) {
                 if (!player.node?.sessionId)
                     throw new Error("Lavalink Node is either not ready or not up to date");
-                await player.node.updatePlayer({
-                    guildId: player.guildId,
-                    playerOptions: {
-                        voice: {
-                            token: update.token,
-                            endpoint: update.endpoint,
-                            sessionId: player.voice?.sessionId,
-                        }
-                    }
-                });
-                if (this.options?.advancedOptions?.enableDebugEvents) {
+                const sessionId2Use = player.voice?.sessionId || ("sessionId" in update ? update.sessionId : undefined);
+                if (!sessionId2Use) {
                     this.emit("debug", DebugEvents.NoAudioDebug, {
-                        state: "log",
-                        message: `Sent updatePlayer for voice token session :: ${JSON.stringify({ voice: { token: update.token, endpoint: update.endpoint, sessionId: player.voice?.sessionId, }, update }, null, 2)}`,
+                        state: "error",
+                        message: `Can't send updatePlayer for voice token session - Missing sessionId :: ${JSON.stringify({ voice: { token: update.token, endpoint: update.endpoint, sessionId: sessionId2Use, }, update, playerVoice: player.voice }, null, 2)}`,
                         functionLayer: "LavalinkManager > sendRawData()",
                     });
+                    if (this.options?.advancedOptions?.debugOptions?.noAudio === true)
+                        console.debug("Lavalink-Client-Debug | NO-AUDIO [::] sendRawData function, Sent updatePlayer for voice token session", { voice: { token: update.token, endpoint: update.endpoint, sessionId: sessionId2Use, }, playerVoice: player.voice, update });
+                }
+                else {
+                    await player.node.updatePlayer({
+                        guildId: player.guildId,
+                        playerOptions: {
+                            voice: {
+                                token: update.token,
+                                endpoint: update.endpoint,
+                                sessionId: sessionId2Use,
+                            }
+                        }
+                    });
+                    if (this.options?.advancedOptions?.enableDebugEvents) {
+                        this.emit("debug", DebugEvents.NoAudioDebug, {
+                            state: "log",
+                            message: `Sent updatePlayer for voice token session :: ${JSON.stringify({ voice: { token: update.token, endpoint: update.endpoint, sessionId: sessionId2Use, }, update, playerVoice: player.voice }, null, 2)}`,
+                            functionLayer: "LavalinkManager > sendRawData()",
+                        });
+                    }
+                    if (this.options?.advancedOptions?.debugOptions?.noAudio === true)
+                        console.debug("Lavalink-Client-Debug | NO-AUDIO [::] sendRawData function, Can't send updatePlayer for voice token session - Missing sessionId", { voice: { token: update.token, endpoint: update.endpoint, sessionId: sessionId2Use, } });
                 }
-                if (this.options?.advancedOptions?.debugOptions?.noAudio === true)
-                    console.debug("Lavalink-Client-Debug | NO-AUDIO [::] sendRawData function, Sent updatePlayer for voice token session", { voice: { token: update.token, endpoint: update.endpoint, sessionId: player.voice?.sessionId, } });
                 return;
             }
             /* voice state update */
             if (update.user_id !== this.options?.client.id) {
-                this.emit("debug", DebugEvents.NoAudioDebug, {
-                    state: "warn",
-                    message: `voice update user is not equal to provided client id of the LavalinkManager.options.client.id :: user: "${update.user_id}" manager client id: "${this.options?.client.id}"`,
-                    functionLayer: "LavalinkManager > sendRawData()",
-                });
+                if (update.user_id && player.voiceChannelId) {
+                    this.emit(update.channel_id === player.voiceChannelId ? "playerVoiceJoin" : "playerVoiceLeave", player, update.user_id);
+                }
+                if (this.options?.advancedOptions?.enableDebugEvents) {
+                    this.emit("debug", DebugEvents.NoAudioDebug, {
+                        state: "warn",
+                        message: `voice update user is not equal to provided client id of the LavalinkManager.options.client.id :: user: "${update.user_id}" manager client id: "${this.options?.client.id}"`,
+                        functionLayer: "LavalinkManager > sendRawData()",
+                    });
+                }
                 if (this.options?.advancedOptions?.debugOptions?.noAudio === true)
                     console.debug("Lavalink-Client-Debug | NO-AUDIO [::] sendRawData function, voice update user is not equal to provided client id of the manageroptions#client#id", "user:", update.user_id, "manager client id:", this.options?.client.id);
                 return;
@@ -518,8 +535,35 @@ export class LavalinkManager extends EventEmitter {
             if (update.channel_id) {
                 if (player.voiceChannelId !== update.channel_id)
                     this.emit("playerMove", player, player.voiceChannelId, update.channel_id);
-                player.voice.sessionId = update.session_id;
+                player.voice.sessionId = update.session_id || player.voice.sessionId;
+                if (!player.voice.sessionId) {
+                    if (this.options?.advancedOptions?.enableDebugEvents) {
+                        this.emit("debug", DebugEvents.NoAudioDebug, {
+                            state: "warn",
+                            message: `Function to assing sessionId provided, but no found in Payload: ${JSON.stringify({ update, playerVoice: player.voice }, null, 2)}`,
+                            functionLayer: "LavalinkManager > sendRawData()",
+                        });
+                    }
+                    if (this.options?.advancedOptions?.debugOptions?.noAudio === true)
+                        console.debug(`Lavalink-Client-Debug | NO-AUDIO [::] sendRawData function, Function to assing sessionId provided, but no found in Payload: ${JSON.stringify(update, null, 2)}`);
+                }
                 player.voiceChannelId = update.channel_id;
+                const selfMuteChanged = typeof update.self_mute === "boolean" && player.voiceState.selfMute !== update.self_mute;
+                const serverMuteChanged = typeof update.mute === "boolean" && player.voiceState.serverMute !== update.mute;
+                const selfDeafChanged = typeof update.self_deaf === "boolean" && player.voiceState.selfDeaf !== update.self_deaf;
+                const serverDeafChanged = typeof update.deaf === "boolean" && player.voiceState.serverDeaf !== update.deaf;
+                const suppressChange = typeof update.suppress === "boolean" && player.voiceState.suppress !== update.suppress;
+                player.voiceState.selfDeaf = update.self_deaf ?? player.voiceState?.selfDeaf;
+                player.voiceState.selfMute = update.self_mute ?? player.voiceState?.selfMute;
+                player.voiceState.serverDeaf = update.deaf ?? player.voiceState?.serverDeaf;
+                player.voiceState.serverMute = update.mute ?? player.voiceState?.serverMute;
+                player.voiceState.suppress = update.suppress ?? player.voiceState?.suppress;
+                if (selfMuteChanged || serverMuteChanged)
+                    this.emit("playerMuteChange", player, player.voiceState.selfMute, player.voiceState.serverMute);
+                if (selfDeafChanged || serverDeafChanged)
+                    this.emit("playerDeafChange", player, player.voiceState.selfDeaf, player.voiceState.serverDeaf);
+                if (suppressChange)
+                    this.emit("playerSuppressChange", player, player.voiceState.suppress);
             }
             else {
                 if (this.options?.playerOptions?.onDisconnect?.destroyPlayer === true) {
@@ -529,11 +573,13 @@ export class LavalinkManager extends EventEmitter {
                 if (this.options?.playerOptions?.onDisconnect?.autoReconnect === true) {
                     try {
                         const positionPrevios = player.position;
-                        this.emit("debug", DebugEvents.PlayerAutoReconnect, {
-                            state: "log",
-                            message: `Auto reconnecting player because LavalinkManager.options.playerOptions.onDisconnect.autoReconnect is true`,
-                            functionLayer: "LavalinkManager > sendRawData()",
-                        });
+                        if (this.options?.advancedOptions?.enableDebugEvents) {
+                            this.emit("debug", DebugEvents.PlayerAutoReconnect, {
+                                state: "log",
+                                message: `Auto reconnecting player because LavalinkManager.options.playerOptions.onDisconnect.autoReconnect is true`,
+                                functionLayer: "LavalinkManager > sendRawData()",
+                            });
+                        }
                         await player.connect();
                         // replay the current playing stream
                         await player.play({
@@ -551,7 +597,6 @@ export class LavalinkManager extends EventEmitter {
                 player.voice = Object.assign({});
                 return;
             }
-            return;
         }
     }
 }

package/dist/esm/structures/Node.d.ts

@@ -1,5 +1,5 @@
 import type { Player } from "./Player.js";
-import type { DestroyReasonsType } from "./Types/Player.js";
+import type { DestroyReasonsType, DisconnectReasonsType } from "./Types/Player.js";
 import type { Track } from "./Types/Track.js";
 import type { Base64, InvalidLavalinkRestRequest, LavalinkPlayer, LavaSearchQuery, LavaSearchResponse, PlayerUpdateInfo, RoutePlanner, SearchQuery, SearchResult, Session } from "./Types/Utils.js";
 import type { NodeManager } from "./NodeManager.js";
@@ -13,6 +13,7 @@ export declare class LavalinkNode {
     get heartBeatPing(): number;
     private heartBeatInterval?;
     private pingTimeout?;
+    isAlive: boolean;
     /** The provided Options of the Node */
     options: LavalinkNodeOptions;
     /** The amount of rest calls the node has made. */
@@ -88,7 +89,8 @@ export declare class LavalinkNode {
      * player.node.request(`/loadtracks?identifier=Never gonna give you up`, (options) => options.method = "GET", false);
      * ```
      */
-    request(endpoint: string, modify?: ModifyRequest, parseAsText?: boolean): Promise<any>;
+    request(endpoint: string, modify: ModifyRequest | undefined, parseAsText: true): Promise<string>;
+    request(endpoint: string, modify?: ModifyRequest, parseAsText?: false): Promise<any>;
     /**
      * Search something raw on the node, please note only add tracks to players of that node
      * @param query SearchQuery Object
@@ -109,7 +111,7 @@ export declare class LavalinkNode {
      * @param query LavaSearchQuery Object
      * @param requestUser Request User for creating the player(s)
      * @param throwOnEmpty Wether to throw on an empty result or not
-     * @returns LavaSearchresult
+     * @returns LavaSearchresult (SearchResult if link is provided)
      *
      * @example
      * ```ts
@@ -117,7 +119,7 @@ export declare class LavalinkNode {
      * player.node.lavaSearch({ types: ["playlist", "album"], query: "Rick Astley", source: "spotify" }, interaction.user);
      * ```
      */
-    lavaSearch(query: LavaSearchQuery, requestUser: unknown, throwOnEmpty?: boolean): Promise<SearchResult | LavaSearchResponse>;
+    lavaSearch(query: LavaSearchQuery, requestUser: unknown, throwOnEmpty?: boolean): Promise<LavaSearchResponse | SearchResult>;
     /**
      * Update the Player State on the Lavalink Server
      * @param data data to send to lavalink and sync locally
@@ -141,7 +143,7 @@ export declare class LavalinkNode {
      * player.node.destroyPlayer(player.guildId);
      * ```
      */
-    destroyPlayer(guildId: any): Promise<any>;
+    destroyPlayer(guildId: any): Promise<void>;
     /**
      * Connect to the Lavalink Node
      * @param sessionId Provide the Session Id of the previous connection, to resume the node and it's player(s)
@@ -169,7 +171,7 @@ export declare class LavalinkNode {
     get id(): string;
     /**
      * Destroys the Node-Connection (Websocket) and all player's of the node
-     * @param destroyReason Destroyreason to use when destroying the players
+     * @param destroyReason Destroy Reason to use when destroying the players
      * @param deleteNode wether to delete the nodte from the nodes list too, if false it will emit a disconnect. @default true
      * @returns void
      *
@@ -179,6 +181,19 @@ export declare class LavalinkNode {
      * ```
      */
     destroy(destroyReason?: DestroyReasonsType, deleteNode?: boolean): void;
+    /**
+     * Disconnects the Node-Connection (Websocket)
+     * @param disconnectReason Disconnect Reason to use when disconnecting Node
+     * @returns void
+     *
+     * Also the node will not get re-connected again.
+     *
+     * @example
+     * ```ts
+     * player.node.destroy("custom Player Destroy Reason", true);
+     * ```
+     */
+    disconnect(disconnectReason?: DisconnectReasonsType): void;
     /**
      * Returns if connected to the Node.
      *
@@ -189,7 +204,6 @@ export declare class LavalinkNode {
      * ```
      */
     get connected(): boolean;
-    isAlive: boolean;
     /**
      * Returns the current ConnectionStatus
      *
@@ -214,7 +228,7 @@ export declare class LavalinkNode {
      * const playersOfLavalink = await node?.fetchAllPlayers();
      * ```
      */
-    fetchAllPlayers(): Promise<LavalinkPlayer[] | InvalidLavalinkRestRequest>;
+    fetchAllPlayers(): Promise<LavalinkPlayer[] | InvalidLavalinkRestRequest | null>;
     /**
      * Gets specific Player Information
      * @returns lavalink player object if player exists on lavalink
@@ -225,7 +239,7 @@ export declare class LavalinkNode {
      * const playerInformation = await node?.fetchPlayer("guildId");
      * ```
      */
-    fetchPlayer(guildId: string): Promise<LavalinkPlayer | InvalidLavalinkRestRequest>;
+    fetchPlayer(guildId: string): Promise<LavalinkPlayer | InvalidLavalinkRestRequest | null>;
     /**
      * Updates the session with and enables/disables resuming and timeout
      * @param resuming Whether resuming is enabled for this session or not
@@ -238,7 +252,7 @@ export declare class LavalinkNode {
      * await node?.updateSession(true, 180e3); // will enable resuming for 180seconds
      * ```
      */
-    updateSession(resuming?: boolean, timeout?: number): Promise<InvalidLavalinkRestRequest | Session>;
+    updateSession(resuming?: boolean, timeout?: number): Promise<Session | InvalidLavalinkRestRequest | null>;
     /**
      * Decode Track or Tracks
      */
@@ -285,7 +299,7 @@ export declare class LavalinkNode {
          * // const lyrics = await player.getLyrics(track, true);
          * ```
          */
-        get: (track: Track, skipTrackSource?: boolean) => Promise<LyricsResult>;
+        get: (track: Track, skipTrackSource?: boolean) => Promise<LyricsResult | null>;
         /**
          * Get the lyrics of the current playing track
          *
@@ -299,7 +313,7 @@ export declare class LavalinkNode {
          * // const lyrics = await player.getCurrentLyrics();
          * ```
          */
-        getCurrent: (guildId: string, skipTrackSource?: boolean) => Promise<LyricsResult>;
+        getCurrent: (guildId: string, skipTrackSource?: boolean) => Promise<LyricsResult | null>;
         /**
          * subscribe to lyrics updates for a guild
          * @param guildId the guild id of the player
@@ -312,7 +326,7 @@ export declare class LavalinkNode {
          * // const lyrics = await player.subscribeLyrics();
          * ```
          */
-        subscribe: (guildId: string) => Promise<any>;
+        subscribe: (guildId: string) => Promise<unknown>;
         /**
          * unsubscribe from lyrics updates for a guild
          * @param guildId the guild id of the player
@@ -325,7 +339,7 @@ export declare class LavalinkNode {
          * // const lyrics = await player.unsubscribeLyrics();
          * ```
          */
-        unsubscribe: (guildId: string) => Promise<any>;
+        unsubscribe: (guildId: string) => Promise<void>;
     };
     /**
      * Request Lavalink statistics.
@@ -385,7 +399,7 @@ export declare class LavalinkNode {
          * await player.node.routePlannerApi.unmarkFailedAddress("ipv6address");
          * ```
          */
-        unmarkFailedAddress: (address: string) => Promise<void>;
+        unmarkFailedAddress: (address: string) => Promise<unknown>;
         /**
          * Release all blacklisted IP addresses into pool of IPs
          * @returns request data of the request
@@ -395,7 +409,7 @@ export declare class LavalinkNode {
          * await player.node.routePlannerApi.unmarkAllFailedAddresses();
          * ```
          */
-        unmarkAllFailedAddresses: () => Promise<any>;
+        unmarkAllFailedAddresses: () => Promise<unknown>;
     };
     /** @private Utils for validating the */
     private validate;