lavalink-client 2.4.1 → 2.4.3

package/README.md

@@ -789,3 +789,11 @@ if(previousTrack) {
     *Allows you to inmplement a custom playerVoiceEmpty handler*
 
 - Added the new events and configuration to the docs
+
+## **Version 2.4.3**
+- `managerOptions#playerOptions.onDisconnect.autoReconnect`:
+  - Added the option `managerOptions#playerOptions.onDisconnect.autoReconnectOnlyWithTracks` to control wether to try reconnecting only when there are tracks in the queue / current track or not
+  - Added a new debug log for that
+  - Added the try to play the next track if there is no current track
+  - *There was a problem trying to auto-reconnect on "empty-queue" events, which caused the player to get destroyed by that and log the error in console "`There is no Track in the Queue, nor provided in the PlayOptions`"*
+  - *Now you have to handle that case manually if you want to or set autoReconnectOnlyWithTracks to false (default)*

package/dist/cjs/structures/Filters.js

@@ -150,7 +150,7 @@ class FilterManager {
         sendData.equalizer = [...this.equalizerBands];
         if (sendData.equalizer.length === 0)
             delete sendData.equalizer;
-        for (const key of [...Object.keys(sendData)]) {
+        for (const key of Object.keys(sendData)) {
             // delete disabled filters
             if (key === "pluginFilters") {
                 // for(const key of [...Object.keys(sendData.pluginFilters)]) {
@@ -181,7 +181,7 @@ class FilterManager {
         this.filters.rotation = this.data.rotation.rotationHz !== 0;
         this.filters.vibrato = this.data.vibrato.frequency !== 0 || this.data.vibrato.depth !== 0;
         this.filters.tremolo = this.data.tremolo.frequency !== 0 || this.data.tremolo.depth !== 0;
-        const lavalinkFilterData = (this.data.pluginFilters?.["lavalink-filter-plugin"] || { echo: { decay: this.data.pluginFilters?.echo?.decay && !this.data.pluginFilters?.echo?.echoLength ? this.data.pluginFilters.echo.decay : 0, delay: this.data.pluginFilters?.echo?.delay || 0 }, reverb: { gains: [], delays: [], ...((this.data.pluginFilters.reverb) || {}) } });
+        const lavalinkFilterData = (this.data.pluginFilters?.["lavalink-filter-plugin"] || { echo: { decay: this.data.pluginFilters?.echo?.decay && !this.data.pluginFilters?.echo?.echoLength ? this.data.pluginFilters.echo.decay : 0, delay: this.data.pluginFilters?.echo?.delay || 0 }, reverb: { gains: [], delays: [], ...(this.data.pluginFilters.reverb) } });
         this.filters.lavalinkFilterPlugin.echo = lavalinkFilterData.echo.decay !== 0 || lavalinkFilterData.echo.delay !== 0;
         this.filters.lavalinkFilterPlugin.reverb = lavalinkFilterData.reverb?.delays?.length !== 0 || lavalinkFilterData.reverb?.gains?.length !== 0;
         this.filters.lavalinkLavaDspxPlugin.highPass = Object.values(this.data.pluginFilters["high-pass"] || {}).length > 0;

package/dist/cjs/structures/LavalinkManager.js

@@ -83,7 +83,8 @@ class LavalinkManager extends events_1.EventEmitter {
                 defaultSearchPlatform: options?.playerOptions?.defaultSearchPlatform ?? "ytsearch",
                 onDisconnect: {
                     destroyPlayer: options?.playerOptions?.onDisconnect?.destroyPlayer ?? true,
-                    autoReconnect: options?.playerOptions?.onDisconnect?.autoReconnect ?? false
+                    autoReconnect: options?.playerOptions?.onDisconnect?.autoReconnect ?? false,
+                    autoReconnectOnlyWithTracks: options?.playerOptions?.onDisconnect?.autoReconnectOnlyWithTracks ?? false,
                 },
                 onEmptyQueue: {
                     autoPlayFunction: options?.playerOptions?.onEmptyQueue?.autoPlayFunction ?? null,
@@ -569,13 +570,14 @@ class LavalinkManager extends events_1.EventEmitter {
                     this.emit("playerSuppressChange", player, player.voiceState.suppress);
             }
             else {
-                if (this.options?.playerOptions?.onDisconnect?.destroyPlayer === true) {
+                const { autoReconnectOnlyWithTracks, destroyPlayer, autoReconnect } = this.options?.playerOptions?.onDisconnect ?? {};
+                if (destroyPlayer === true) {
                     return void await player.destroy(Constants_1.DestroyReasons.Disconnected);
                 }
-                this.emit("playerDisconnect", player, player.voiceChannelId);
-                if (this.options?.playerOptions?.onDisconnect?.autoReconnect === true) {
+                if (autoReconnect === true) {
                     try {
-                        const positionPrevios = player.position;
+                        const previousPosition = player.position;
+                        const previousPaused = player.paused;
                         if (this.options?.advancedOptions?.enableDebugEvents) {
                             this.emit("debug", Constants_1.DebugEvents.PlayerAutoReconnect, {
                                 state: "log",
@@ -583,12 +585,23 @@ class LavalinkManager extends events_1.EventEmitter {
                                 functionLayer: "LavalinkManager > sendRawData()",
                             });
                         }
-                        await player.connect();
+                        // connect if there are tracks & autoReconnectOnlyWithTracks = true or autoReconnectOnlyWithTracks is false
+                        if (!autoReconnectOnlyWithTracks || (autoReconnectOnlyWithTracks && (player.queue.current || player.queue.tracks.length))) {
+                            await player.connect();
+                        }
                         // replay the current playing stream
-                        await player.play({
-                            position: positionPrevios,
-                            paused: player.paused,
-                            clientTrack: player.queue.current,
+                        if (player.queue.current) {
+                            return void await player.play({ position: previousPosition, paused: previousPaused, clientTrack: player.queue.current, });
+                        }
+                        // try to play the next track
+                        if (player.queue.tracks.length) {
+                            return void await player.play({ paused: previousPaused });
+                        }
+                        // debug log if nothing was possible
+                        this.emit("debug", Constants_1.DebugEvents.PlayerAutoReconnect, {
+                            state: "log",
+                            message: `Auto reconnected, but nothing to play`,
+                            functionLayer: "LavalinkManager > sendRawData()",
                         });
                     }
                     catch (e) {
@@ -596,6 +609,7 @@ class LavalinkManager extends events_1.EventEmitter {
                         return void await player.destroy(Constants_1.DestroyReasons.PlayerReconnectFail);
                     }
                 }
+                this.emit("playerDisconnect", player, player.voiceChannelId);
                 player.voiceChannelId = null;
                 player.voice = Object.assign({});
                 return;

package/dist/cjs/structures/Node.js

@@ -811,7 +811,7 @@ class LavalinkNode {
      * @returns boolean
      */
     syncPlayerData(data, res) {
-        if (typeof data === "object" && typeof data?.guildId === "string" && typeof data.playerOptions === "object" && Object.keys(data.playerOptions).length > 1) {
+        if (typeof data === "object" && typeof data?.guildId === "string" && typeof data.playerOptions === "object" && Object.keys(data.playerOptions).length > 0) {
             const player = this.NodeManager.LavalinkManager.getPlayer(data.guildId);
             if (!player)
                 return;
@@ -837,7 +837,7 @@ class LavalinkNode {
                 }
             }
             if (typeof data.playerOptions.filters !== "undefined") {
-                const oldFilterTimescale = { ...(player.filterManager.data.timescale || {}) };
+                const oldFilterTimescale = { ...player.filterManager.data.timescale };
                 Object.freeze(oldFilterTimescale);
                 if (data.playerOptions.filters.timescale)
                     player.filterManager.data.timescale = data.playerOptions.filters.timescale;

package/dist/cjs/structures/Types/Manager.d.ts

@@ -200,6 +200,8 @@ export interface ManagerPlayerOptions {
     onDisconnect?: {
         /** Try to reconnect? -> If fails -> Destroy */
         autoReconnect?: boolean;
+        /** Only try to reconnect if there are tracks in the queue */
+        autoReconnectOnlyWithTracks?: boolean;
         /** Instantly destroy player (overrides autoReconnect) | Don't provide == disable feature*/
         destroyPlayer?: boolean;
     };

package/dist/cjs/structures/Types/Node.d.ts

@@ -230,7 +230,7 @@ export interface NodeManagerEvents {
      * Aka for that you need to be able to save player data like vc channel + text channel in a db and then sync it again
      * @event Manager.nodeManager#nodeResumed
      */
-    "resumed": (node: LavalinkNode, paylaod: {
+    "resumed": (node: LavalinkNode, payload: {
         resumed: true;
         sessionId: string;
         op: "ready";

package/dist/cjs/structures/Utils.js

@@ -37,7 +37,7 @@ class ManagerUtils {
     buildPluginInfo(data, clientData = {}) {
         return {
             clientData: clientData,
-            ...(data.pluginInfo || data.plugin || {})
+            ...(data.pluginInfo || data.plugin),
         };
     }
     buildTrack(data, requester) {
@@ -67,7 +67,7 @@ class ManagerUtils {
                     isrc: data.info.isrc,
                 },
                 userData: {
-                    ...(data.userData || {}),
+                    ...data.userData,
                     requester: transformedRequester
                 },
                 pluginInfo: this.buildPluginInfo(data, "clientData" in data ? data.clientData : {}),

package/dist/esm/structures/Filters.js

@@ -147,7 +147,7 @@ export class FilterManager {
         sendData.equalizer = [...this.equalizerBands];
         if (sendData.equalizer.length === 0)
             delete sendData.equalizer;
-        for (const key of [...Object.keys(sendData)]) {
+        for (const key of Object.keys(sendData)) {
             // delete disabled filters
             if (key === "pluginFilters") {
                 // for(const key of [...Object.keys(sendData.pluginFilters)]) {
@@ -178,7 +178,7 @@ export class FilterManager {
         this.filters.rotation = this.data.rotation.rotationHz !== 0;
         this.filters.vibrato = this.data.vibrato.frequency !== 0 || this.data.vibrato.depth !== 0;
         this.filters.tremolo = this.data.tremolo.frequency !== 0 || this.data.tremolo.depth !== 0;
-        const lavalinkFilterData = (this.data.pluginFilters?.["lavalink-filter-plugin"] || { echo: { decay: this.data.pluginFilters?.echo?.decay && !this.data.pluginFilters?.echo?.echoLength ? this.data.pluginFilters.echo.decay : 0, delay: this.data.pluginFilters?.echo?.delay || 0 }, reverb: { gains: [], delays: [], ...((this.data.pluginFilters.reverb) || {}) } });
+        const lavalinkFilterData = (this.data.pluginFilters?.["lavalink-filter-plugin"] || { echo: { decay: this.data.pluginFilters?.echo?.decay && !this.data.pluginFilters?.echo?.echoLength ? this.data.pluginFilters.echo.decay : 0, delay: this.data.pluginFilters?.echo?.delay || 0 }, reverb: { gains: [], delays: [], ...(this.data.pluginFilters.reverb) } });
         this.filters.lavalinkFilterPlugin.echo = lavalinkFilterData.echo.decay !== 0 || lavalinkFilterData.echo.delay !== 0;
         this.filters.lavalinkFilterPlugin.reverb = lavalinkFilterData.reverb?.delays?.length !== 0 || lavalinkFilterData.reverb?.gains?.length !== 0;
         this.filters.lavalinkLavaDspxPlugin.highPass = Object.values(this.data.pluginFilters["high-pass"] || {}).length > 0;

package/dist/esm/structures/LavalinkManager.js

@@ -80,7 +80,8 @@ export class LavalinkManager extends EventEmitter {
                 defaultSearchPlatform: options?.playerOptions?.defaultSearchPlatform ?? "ytsearch",
                 onDisconnect: {
                     destroyPlayer: options?.playerOptions?.onDisconnect?.destroyPlayer ?? true,
-                    autoReconnect: options?.playerOptions?.onDisconnect?.autoReconnect ?? false
+                    autoReconnect: options?.playerOptions?.onDisconnect?.autoReconnect ?? false,
+                    autoReconnectOnlyWithTracks: options?.playerOptions?.onDisconnect?.autoReconnectOnlyWithTracks ?? false,
                 },
                 onEmptyQueue: {
                     autoPlayFunction: options?.playerOptions?.onEmptyQueue?.autoPlayFunction ?? null,
@@ -566,13 +567,14 @@ export class LavalinkManager extends EventEmitter {
                     this.emit("playerSuppressChange", player, player.voiceState.suppress);
             }
             else {
-                if (this.options?.playerOptions?.onDisconnect?.destroyPlayer === true) {
+                const { autoReconnectOnlyWithTracks, destroyPlayer, autoReconnect } = this.options?.playerOptions?.onDisconnect ?? {};
+                if (destroyPlayer === true) {
                     return void await player.destroy(DestroyReasons.Disconnected);
                 }
-                this.emit("playerDisconnect", player, player.voiceChannelId);
-                if (this.options?.playerOptions?.onDisconnect?.autoReconnect === true) {
+                if (autoReconnect === true) {
                     try {
-                        const positionPrevios = player.position;
+                        const previousPosition = player.position;
+                        const previousPaused = player.paused;
                         if (this.options?.advancedOptions?.enableDebugEvents) {
                             this.emit("debug", DebugEvents.PlayerAutoReconnect, {
                                 state: "log",
@@ -580,12 +582,23 @@ export class LavalinkManager extends EventEmitter {
                                 functionLayer: "LavalinkManager > sendRawData()",
                             });
                         }
-                        await player.connect();
+                        // connect if there are tracks & autoReconnectOnlyWithTracks = true or autoReconnectOnlyWithTracks is false
+                        if (!autoReconnectOnlyWithTracks || (autoReconnectOnlyWithTracks && (player.queue.current || player.queue.tracks.length))) {
+                            await player.connect();
+                        }
                         // replay the current playing stream
-                        await player.play({
-                            position: positionPrevios,
-                            paused: player.paused,
-                            clientTrack: player.queue.current,
+                        if (player.queue.current) {
+                            return void await player.play({ position: previousPosition, paused: previousPaused, clientTrack: player.queue.current, });
+                        }
+                        // try to play the next track
+                        if (player.queue.tracks.length) {
+                            return void await player.play({ paused: previousPaused });
+                        }
+                        // debug log if nothing was possible
+                        this.emit("debug", DebugEvents.PlayerAutoReconnect, {
+                            state: "log",
+                            message: `Auto reconnected, but nothing to play`,
+                            functionLayer: "LavalinkManager > sendRawData()",
                         });
                     }
                     catch (e) {
@@ -593,6 +606,7 @@ export class LavalinkManager extends EventEmitter {
                         return void await player.destroy(DestroyReasons.PlayerReconnectFail);
                     }
                 }
+                this.emit("playerDisconnect", player, player.voiceChannelId);
                 player.voiceChannelId = null;
                 player.voice = Object.assign({});
                 return;

package/dist/esm/structures/Node.js

@@ -807,7 +807,7 @@ export class LavalinkNode {
      * @returns boolean
      */
     syncPlayerData(data, res) {
-        if (typeof data === "object" && typeof data?.guildId === "string" && typeof data.playerOptions === "object" && Object.keys(data.playerOptions).length > 1) {
+        if (typeof data === "object" && typeof data?.guildId === "string" && typeof data.playerOptions === "object" && Object.keys(data.playerOptions).length > 0) {
             const player = this.NodeManager.LavalinkManager.getPlayer(data.guildId);
             if (!player)
                 return;
@@ -833,7 +833,7 @@ export class LavalinkNode {
                 }
             }
             if (typeof data.playerOptions.filters !== "undefined") {
-                const oldFilterTimescale = { ...(player.filterManager.data.timescale || {}) };
+                const oldFilterTimescale = { ...player.filterManager.data.timescale };
                 Object.freeze(oldFilterTimescale);
                 if (data.playerOptions.filters.timescale)
                     player.filterManager.data.timescale = data.playerOptions.filters.timescale;

package/dist/esm/structures/Types/Manager.d.ts

@@ -200,6 +200,8 @@ export interface ManagerPlayerOptions {
     onDisconnect?: {
         /** Try to reconnect? -> If fails -> Destroy */
         autoReconnect?: boolean;
+        /** Only try to reconnect if there are tracks in the queue */
+        autoReconnectOnlyWithTracks?: boolean;
         /** Instantly destroy player (overrides autoReconnect) | Don't provide == disable feature*/
         destroyPlayer?: boolean;
     };

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

@@ -230,7 +230,7 @@ export interface NodeManagerEvents {
      * Aka for that you need to be able to save player data like vc channel + text channel in a db and then sync it again
      * @event Manager.nodeManager#nodeResumed
      */
-    "resumed": (node: LavalinkNode, paylaod: {
+    "resumed": (node: LavalinkNode, payload: {
         resumed: true;
         sessionId: string;
         op: "ready";

package/dist/esm/structures/Utils.js

@@ -32,7 +32,7 @@ export class ManagerUtils {
     buildPluginInfo(data, clientData = {}) {
         return {
             clientData: clientData,
-            ...(data.pluginInfo || data.plugin || {})
+            ...(data.pluginInfo || data.plugin),
         };
     }
     buildTrack(data, requester) {
@@ -62,7 +62,7 @@ export class ManagerUtils {
                     isrc: data.info.isrc,
                 },
                 userData: {
-                    ...(data.userData || {}),
+                    ...data.userData,
                     requester: transformedRequester
                 },
                 pluginInfo: this.buildPluginInfo(data, "clientData" in data ? data.clientData : {}),

package/dist/types/structures/Types/Manager.d.ts

@@ -200,6 +200,8 @@ export interface ManagerPlayerOptions {
     onDisconnect?: {
         /** Try to reconnect? -> If fails -> Destroy */
         autoReconnect?: boolean;
+        /** Only try to reconnect if there are tracks in the queue */
+        autoReconnectOnlyWithTracks?: boolean;
         /** Instantly destroy player (overrides autoReconnect) | Don't provide == disable feature*/
         destroyPlayer?: boolean;
     };

package/dist/types/structures/Types/Node.d.ts

@@ -230,7 +230,7 @@ export interface NodeManagerEvents {
      * Aka for that you need to be able to save player data like vc channel + text channel in a db and then sync it again
      * @event Manager.nodeManager#nodeResumed
      */
-    "resumed": (node: LavalinkNode, paylaod: {
+    "resumed": (node: LavalinkNode, payload: {
         resumed: true;
         sessionId: string;
         op: "ready";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lavalink-client",
-  "version": "2.4.1",
+  "version": "2.4.3",
   "description": "Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Proficients.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",