lavalink-client 2.3.3 → 2.3.4

package/README.md

@@ -189,28 +189,10 @@ client.lavalink = new LavalinkManager({
 
 ## How to do resuming
 
-```js
-// 1. while the player is playing, make sure to enable it:
-const durationToKeepPlayingInMS = 600_000;
-await player.node.updateSession(true, durationToKeepPlayingInMS);
-```
-
-```js
-// 2. make sure to have an eventlistener for resuming events somewhere
-client.lavalink.nodeManager.on("resumed", (node, payload, fetchedPlayers) => {
-  // create players:
-  for(const fetchedPlayer of fetchedPlayers) {
-    const player = client.lavalink.createPlayer({
-       guildId: fetchedPlayer.guildId,
-    });
-    player.setVolume(fetchedPlayer.volume);
-    // and apply other things (e.g. paused, voice, filters, state, ...) (stuff like vc channel, text channel you need to store somewhere)
-    await player.queue.utils.sync(); // only works with a queuestore
-    // you can now overwride the player.queue.current track from the fetchedPlayer, or use the one from the queue.uztils.sync function
-    // continue with your resuming code...
-  }
-})
-```
+1. You need to enable resuming on a __connected__ Lavalink node : **` node.updateSession(true, 360e3) `**
+2. The NodeManager#resumed event will emit when the node resumes, you retrieves all fetchedPlayers (fetched by the client), and thus all you need to do is re-create all player instances (and possibly the queues too)
+  - For that is the queuestore useful
+  - To save the playerData you can utilize smt like playerUpdate event.
 
 ## Resuming full Example
 Full code sample: can be found on the [Testbot in here](https://github.com/Tomato6966/lavalink-client/blob/main/testBot/Utils/handleResuming.ts)

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/cjs/structures/NodeManager.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { EventEmitter } from "stream";
+import { EventEmitter } from "events";
 import { LavalinkNode } from "./Node";
 import { MiniMap } from "./Utils";
 import type { LavalinkNodeIdentifier, LavalinkNodeOptions, NodeManagerEvents } from "./Types/Node";

package/dist/cjs/structures/NodeManager.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeManager = void 0;
-const stream_1 = require("stream");
+const events_1 = require("events");
 const Constants_1 = require("./Constants");
 const Node_1 = require("./Node");
 const Utils_1 = require("./Utils");
-class NodeManager extends stream_1.EventEmitter {
+class NodeManager extends events_1.EventEmitter {
     /**
      * Emit an event
      * @param event The event to emit

package/dist/cjs/structures/Player.js

@@ -138,7 +138,7 @@ class Player {
      */
     async play(options = {}) {
         if (this.get("internal_queueempty")) {
-            if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                 this.LavalinkManager.emit("debug", Constants_1.DebugEvents.PlayerPlayQueueEmptyTimeoutClear, {
                     state: "log",
                     message: `Player was called to play something, while there was a queueEmpty Timeout set, clearing the timeout.`,
@@ -150,8 +150,31 @@ class Player {
         }
         // if clientTrack provided, override options.track object
         if (options?.clientTrack && (this.LavalinkManager.utils.isTrack(options?.clientTrack) || this.LavalinkManager.utils.isUnresolvedTrack(options.clientTrack))) {
-            if (this.LavalinkManager.utils.isUnresolvedTrack(options.clientTrack))
-                await options.clientTrack.resolve(this);
+            if (this.LavalinkManager.utils.isUnresolvedTrack(options.clientTrack)) {
+                try {
+                    // resolve the unresolved track
+                    await options.clientTrack.resolve(this);
+                }
+                catch (error) {
+                    if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+                        this.LavalinkManager.emit("debug", Constants_1.DebugEvents.PlayerPlayUnresolvedTrackFailed, {
+                            state: "error",
+                            error: error,
+                            message: `Player Play was called with clientTrack, Song is unresolved, but couldn't resolve it`,
+                            functionLayer: "Player > play() > resolve currentTrack",
+                        });
+                    }
+                    this.LavalinkManager.emit("trackError", this, this.queue.current, error);
+                    if (options && "clientTrack" in options)
+                        delete options.clientTrack;
+                    if (options && "track" in options)
+                        delete options.track;
+                    // try to play the next track if possible
+                    if (this.LavalinkManager.options?.autoSkipOnResolveError === true && this.queue.tracks[0])
+                        return this.play(options);
+                    return this;
+                }
+            }
             if ((typeof options.track?.userData === "object" || typeof options.clientTrack?.userData === "object") && options.clientTrack)
                 options.clientTrack.userData = { ...(options?.clientTrack.userData || {}), ...(options.track?.userData || {}) };
             options.track = {
@@ -185,7 +208,7 @@ class Player {
                     ...(track.userData || {}),
                     requester: this.LavalinkManager.utils.getTransformedRequester(options?.track?.requester || {})
                 };
-            if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                 this.LavalinkManager.emit("debug", Constants_1.DebugEvents.PlayerPlayWithTrackReplace, {
                     state: "log",
                     message: `Player was called to play something, with a specific track provided. Replacing the current Track and resolving the track on trackStart Event.`,
@@ -209,7 +232,7 @@ class Player {
         if (!this.queue.current && this.queue.tracks.length)
             await (0, Utils_1.queueTrackEnd)(this);
         if (this.queue.current && this.LavalinkManager.utils.isUnresolvedTrack(this.queue.current)) {
-            if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                 this.LavalinkManager.emit("debug", Constants_1.DebugEvents.PlayerPlayUnresolvedTrack, {
                     state: "log",
                     message: `Player Play was called, current Queue Song is unresolved, resolving the track.`,
@@ -223,7 +246,7 @@ class Player {
                     this.queue.current.userData = { ...(this.queue.current?.userData || {}), ...(options.track?.userData || {}) };
             }
             catch (error) {
-                if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+                if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                     this.LavalinkManager.emit("debug", Constants_1.DebugEvents.PlayerPlayUnresolvedTrackFailed, {
                         state: "error",
                         error: error,
@@ -297,7 +320,7 @@ class Player {
             : this.volume), 1000), 0));
         const now = performance.now();
         if (this.LavalinkManager.options.playerOptions.applyVolumeAsFilter) {
-            if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                 this.LavalinkManager.emit("debug", Constants_1.DebugEvents.PlayerVolumeAsFilter, {
                     state: "log",
                     message: `Player Volume was set as a Filter, because LavalinkManager option "playerOptions.applyVolumeAsFilter" is true`,
@@ -349,7 +372,7 @@ class Player {
     async search(query, requestUser, throwOnEmpty = false) {
         const Query = this.LavalinkManager.utils.transformQuery(query);
         if (["bcsearch", "bandcamp"].includes(Query.source) && !this.node.info.sourceManagers.includes("bandcamp")) {
-            if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                 this.LavalinkManager.emit("debug", Constants_1.DebugEvents.BandcampSearchLokalEngine, {
                     state: "log",
                     message: `Player.search was called with a Bandcamp Query, but no bandcamp search was enabled on lavalink, searching with the custom Search Engine.`,
@@ -559,7 +582,7 @@ class Player {
         const updateNode = typeof newNode === "string" ? this.LavalinkManager.nodeManager.nodes.get(newNode) : newNode;
         if (!updateNode)
             throw new Error("Could not find the new Node");
-        if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+        if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
             this.LavalinkManager.emit("debug", Constants_1.DebugEvents.PlayerChangeNode, {
                 state: "log",
                 message: `Player.changeNode() was executed, trying to change from "${this.node.id}" to "${updateNode.id}"`,

package/dist/cjs/structures/Utils.js

@@ -427,11 +427,27 @@ async function queueTrackEnd(player) {
         player.queue.tracks.push(player.queue.current);
     // change the current Track to the next upcoming one
     const nextSong = player.queue.tracks.shift();
-    if (player.LavalinkManager.utils.isUnresolvedTrack(nextSong))
-        await nextSong.resolve(player);
-    player.queue.current = nextSong || null;
-    // save it in the DB
-    await player.queue.utils.save();
+    try {
+        if (player.LavalinkManager.utils.isUnresolvedTrack(nextSong))
+            await nextSong.resolve(player);
+        player.queue.current = nextSong || null;
+        // save it in the DB
+        await player.queue.utils.save();
+    }
+    catch (error) {
+        if (player.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            player.LavalinkManager.emit("debug", Constants_1.DebugEvents.PlayerPlayUnresolvedTrackFailed, {
+                state: "error",
+                error: error,
+                message: `queueTrackEnd Util was called, tried to resolve the next track, but failed to find the closest matching song`,
+                functionLayer: "Player > play() > resolve currentTrack",
+            });
+        }
+        player.LavalinkManager.emit("trackError", player, player.queue.current, error);
+        // try to play the next track if possible
+        if (player.LavalinkManager.options?.autoSkipOnResolveError === true && player.queue.tracks[0])
+            return queueTrackEnd(player);
+    }
     // return the new current Track
     return player.queue.current;
 }

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

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

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { EventEmitter } from "stream";
+import { EventEmitter } from "events";
 import { LavalinkNode } from "./Node";
 import { MiniMap } from "./Utils";
 import type { LavalinkNodeIdentifier, LavalinkNodeOptions, NodeManagerEvents } from "./Types/Node";

package/dist/esm/structures/NodeManager.js

@@ -1,4 +1,4 @@
-import { EventEmitter } from "stream";
+import { EventEmitter } from "events";
 import { DestroyReasons } from "./Constants";
 import { LavalinkNode } from "./Node";
 import { MiniMap } from "./Utils";

package/dist/esm/structures/Player.js

@@ -135,7 +135,7 @@ export class Player {
      */
     async play(options = {}) {
         if (this.get("internal_queueempty")) {
-            if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                 this.LavalinkManager.emit("debug", DebugEvents.PlayerPlayQueueEmptyTimeoutClear, {
                     state: "log",
                     message: `Player was called to play something, while there was a queueEmpty Timeout set, clearing the timeout.`,
@@ -147,8 +147,31 @@ export class Player {
         }
         // if clientTrack provided, override options.track object
         if (options?.clientTrack && (this.LavalinkManager.utils.isTrack(options?.clientTrack) || this.LavalinkManager.utils.isUnresolvedTrack(options.clientTrack))) {
-            if (this.LavalinkManager.utils.isUnresolvedTrack(options.clientTrack))
-                await options.clientTrack.resolve(this);
+            if (this.LavalinkManager.utils.isUnresolvedTrack(options.clientTrack)) {
+                try {
+                    // resolve the unresolved track
+                    await options.clientTrack.resolve(this);
+                }
+                catch (error) {
+                    if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+                        this.LavalinkManager.emit("debug", DebugEvents.PlayerPlayUnresolvedTrackFailed, {
+                            state: "error",
+                            error: error,
+                            message: `Player Play was called with clientTrack, Song is unresolved, but couldn't resolve it`,
+                            functionLayer: "Player > play() > resolve currentTrack",
+                        });
+                    }
+                    this.LavalinkManager.emit("trackError", this, this.queue.current, error);
+                    if (options && "clientTrack" in options)
+                        delete options.clientTrack;
+                    if (options && "track" in options)
+                        delete options.track;
+                    // try to play the next track if possible
+                    if (this.LavalinkManager.options?.autoSkipOnResolveError === true && this.queue.tracks[0])
+                        return this.play(options);
+                    return this;
+                }
+            }
             if ((typeof options.track?.userData === "object" || typeof options.clientTrack?.userData === "object") && options.clientTrack)
                 options.clientTrack.userData = { ...(options?.clientTrack.userData || {}), ...(options.track?.userData || {}) };
             options.track = {
@@ -182,7 +205,7 @@ export class Player {
                     ...(track.userData || {}),
                     requester: this.LavalinkManager.utils.getTransformedRequester(options?.track?.requester || {})
                 };
-            if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                 this.LavalinkManager.emit("debug", DebugEvents.PlayerPlayWithTrackReplace, {
                     state: "log",
                     message: `Player was called to play something, with a specific track provided. Replacing the current Track and resolving the track on trackStart Event.`,
@@ -206,7 +229,7 @@ export class Player {
         if (!this.queue.current && this.queue.tracks.length)
             await queueTrackEnd(this);
         if (this.queue.current && this.LavalinkManager.utils.isUnresolvedTrack(this.queue.current)) {
-            if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                 this.LavalinkManager.emit("debug", DebugEvents.PlayerPlayUnresolvedTrack, {
                     state: "log",
                     message: `Player Play was called, current Queue Song is unresolved, resolving the track.`,
@@ -220,7 +243,7 @@ export class Player {
                     this.queue.current.userData = { ...(this.queue.current?.userData || {}), ...(options.track?.userData || {}) };
             }
             catch (error) {
-                if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+                if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                     this.LavalinkManager.emit("debug", DebugEvents.PlayerPlayUnresolvedTrackFailed, {
                         state: "error",
                         error: error,
@@ -294,7 +317,7 @@ export class Player {
             : this.volume), 1000), 0));
         const now = performance.now();
         if (this.LavalinkManager.options.playerOptions.applyVolumeAsFilter) {
-            if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                 this.LavalinkManager.emit("debug", DebugEvents.PlayerVolumeAsFilter, {
                     state: "log",
                     message: `Player Volume was set as a Filter, because LavalinkManager option "playerOptions.applyVolumeAsFilter" is true`,
@@ -346,7 +369,7 @@ export class Player {
     async search(query, requestUser, throwOnEmpty = false) {
         const Query = this.LavalinkManager.utils.transformQuery(query);
         if (["bcsearch", "bandcamp"].includes(Query.source) && !this.node.info.sourceManagers.includes("bandcamp")) {
-            if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
                 this.LavalinkManager.emit("debug", DebugEvents.BandcampSearchLokalEngine, {
                     state: "log",
                     message: `Player.search was called with a Bandcamp Query, but no bandcamp search was enabled on lavalink, searching with the custom Search Engine.`,
@@ -556,7 +579,7 @@ export class Player {
         const updateNode = typeof newNode === "string" ? this.LavalinkManager.nodeManager.nodes.get(newNode) : newNode;
         if (!updateNode)
             throw new Error("Could not find the new Node");
-        if (typeof this.options.node === "string" && this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+        if (this.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
             this.LavalinkManager.emit("debug", DebugEvents.PlayerChangeNode, {
                 state: "log",
                 message: `Player.changeNode() was executed, trying to change from "${this.node.id}" to "${updateNode.id}"`,

package/dist/esm/structures/Utils.js

@@ -421,11 +421,27 @@ export async function queueTrackEnd(player) {
         player.queue.tracks.push(player.queue.current);
     // change the current Track to the next upcoming one
     const nextSong = player.queue.tracks.shift();
-    if (player.LavalinkManager.utils.isUnresolvedTrack(nextSong))
-        await nextSong.resolve(player);
-    player.queue.current = nextSong || null;
-    // save it in the DB
-    await player.queue.utils.save();
+    try {
+        if (player.LavalinkManager.utils.isUnresolvedTrack(nextSong))
+            await nextSong.resolve(player);
+        player.queue.current = nextSong || null;
+        // save it in the DB
+        await player.queue.utils.save();
+    }
+    catch (error) {
+        if (player.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+            player.LavalinkManager.emit("debug", DebugEvents.PlayerPlayUnresolvedTrackFailed, {
+                state: "error",
+                error: error,
+                message: `queueTrackEnd Util was called, tried to resolve the next track, but failed to find the closest matching song`,
+                functionLayer: "Player > play() > resolve currentTrack",
+            });
+        }
+        player.LavalinkManager.emit("trackError", player, player.queue.current, error);
+        // try to play the next track if possible
+        if (player.LavalinkManager.options?.autoSkipOnResolveError === true && player.queue.tracks[0])
+            return queueTrackEnd(player);
+    }
     // return the new current Track
     return player.queue.current;
 }

package/dist/types/structures/NodeManager.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { EventEmitter } from "stream";
+import { EventEmitter } from "events";
 import { LavalinkNode } from "./Node";
 import { MiniMap } from "./Utils";
 import type { LavalinkNodeIdentifier, LavalinkNodeOptions, NodeManagerEvents } from "./Types/Node";

package/package.json

@@ -1,21 +1,27 @@
 {
   "name": "lavalink-client",
-  "version": "2.3.3",
+  "version": "2.3.4",
   "description": "Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Proficients.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.js",
   "scripts": {
     "build": "npm run build:cjs && npm run build:esm && npm run build:types",
-    "build:cjs": "node tools/cleanup cjs && tsc -p config/tsconfig.cjs.json",
-    "build:esm": "node tools/cleanup esm && tsc -p config/tsconfig.esm.json",
-    "build:types": "node tools/cleanup types && tsc -p config/tsconfig.types.json",
+    "build:cjs": "node tools/cleanup cjs && tsc -p config/tsconfig.cjs.json && tsc-alias -p config/tsconfig.cjs.json && node tools/fixup cjs",
+    "build:esm": "node tools/cleanup esm && tsc -p config/tsconfig.esm.json && tsc-alias -p config/tsconfig.esm.json && node tools/fixup esm",
+    "build:types": "node tools/cleanup types && tsc -p config/tsconfig.types.json && tsc-alias -p config/tsconfig.types.json",
     "clean": "node tools/cleanup",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
     "test": "node -v",
     "docs": "npx typedoc"
   },
+  "exports": {
+    "require": "./dist/cjs/index.js",
+    "import": "./dist/esm/index.js",
+    "types": "./dist/types/index.d.js",
+    "default": "./dist/cjs/index.js"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -52,7 +58,7 @@
     "@typescript-eslint/eslint-plugin": "^6.4.0",
     "@typescript-eslint/parser": "^6.4.0",
     "eslint": "^8.47.0",
-    "ts-loader": "^9.4.4",
+    "tsc-alias": "^1.8.10",
     "typedoc": "^0.25.4",
     "typedoc-theme-hierarchy": "^4.1.2",
     "typescript": "^5.1.6"
@@ -62,6 +68,7 @@
     "ws": "^8.13.0"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=18.0.0",
+    "bun": ">=1.0.0"
   }
 }