lavalink-client 1.0.5 → 1.0.6

package/README.md

@@ -11,6 +11,7 @@ Latest stable Version: (currently, unreleased)
 npm install --save lavalink-client
 ```
 
+
 Dev Version: (Current)
 
 ```bash

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

@@ -11,7 +11,9 @@ export interface LavalinkManager {
     utils: ManagerUitls;
 }
 export interface BotClientOptions {
+    /** Bot Client Id */
     id: string;
+    /** Bot Client Username */
     username?: string;
     /** So users can pass entire objects / classes */
     [x: string | number | symbol | undefined]: any;
@@ -39,6 +41,7 @@ export interface LavalinkPlayerOptions {
         autoPlayFunction?: (player: Player, lastPlayedTrack: Track) => Promise<void>;
         destroyAfterMs?: number;
     };
+    useUnresolvedData?: boolean;
 }
 export interface ManagerOptions {
     nodes: LavalinkNodeOptions[];

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

@@ -4,7 +4,7 @@ import { NodeManager } from "./NodeManager";
 import internal from "stream";
 import { InvalidLavalinkRestRequest, LavalinkPlayer, PlayerUpdateInfo, RoutePlanner, Session, Base64 } from "./Utils";
 import { DestroyReasonsType } from "./Player";
-import { TrackInfo } from "./Track";
+import { Track } from "./Track";
 /** Modifies any outgoing REST requests. */
 export type ModifyRequest = (options: Dispatcher.RequestOptions) => void;
 export interface LavalinkNodeOptions {
@@ -185,13 +185,13 @@ export declare class LavalinkNode {
          * @param encoded
          * @returns
          */
-        singleTrack: (encoded: Base64) => Promise<TrackInfo>;
+        singleTrack: (encoded: Base64, requester: unknown) => Promise<Track>;
         /**
          *
          * @param encodeds Decodes multiple tracks into their info
          * @returns
          */
-        multipleTracks: (encodeds: Base64[]) => Promise<TrackInfo[]>;
+        multipleTracks: (encodeds: Base64[], requester: unknown) => Promise<Track[]>;
     };
     /**
      * Request Lavalink statistics.

package/dist/cjs/structures/Node.js

@@ -227,25 +227,27 @@ class LavalinkNode {
          * @param encoded
          * @returns
          */
-        singleTrack: async (encoded) => {
+        singleTrack: async (encoded, requester) => {
             if (!encoded)
                 throw new SyntaxError("No encoded (Base64 string) was provided");
-            return await this.request(`/decodetrack?encodedTrack=${encoded}`);
+            // return the decoded + builded track
+            return this.NodeManager.LavalinkManager.utils.buildTrack(await this.request(`/decodetrack?encodedTrack=${encoded}`), requester);
         },
         /**
          *
          * @param encodeds Decodes multiple tracks into their info
          * @returns
          */
-        multipleTracks: async (encodeds) => {
+        multipleTracks: async (encodeds, requester) => {
             if (!Array.isArray(encodeds) || !encodeds.every(v => typeof v === "string" && v.length > 1))
                 throw new SyntaxError("You need to provide encodeds, which is an array of base64 strings");
+            // return the decoded + builded tracks
             return await this.request(`/decodetracks`, r => {
                 r.method = "POST";
                 r.body = JSON.stringify(encodeds);
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 r.headers["Content-Type"] = "application/json";
-            });
+            }).then((r) => r.map(track => this.NodeManager.LavalinkManager.utils.buildTrack(track, requester)));
         }
     };
     /**

package/dist/cjs/structures/Utils.js

@@ -6,6 +6,8 @@ exports.TrackSymbol = Symbol("LC-Track");
 exports.UnresolvedTrackSymbol = Symbol("LC-Track-Unresolved");
 exports.QueueSymbol = Symbol("LC-Queue");
 exports.NodeSymbol = Symbol("LC-Node");
+/** @hidden */
+const escapeRegExp = (str) => str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 class ManagerUitls {
     constructor(LavalinkManager) {
         this.manager = LavalinkManager;
@@ -23,7 +25,7 @@ class ManagerUitls {
                     identifier: data.info?.identifier,
                     title: data.info?.title,
                     author: data.info?.author,
-                    duration: data.info?.length,
+                    duration: data.info?.length || data.info?.duration,
                     artworkUrl: data.info?.artworkUrl || data.pluginInfo?.artworkUrl || data.plugin?.artworkUrl,
                     uri: data.info?.uri,
                     sourceName: data.info?.sourceName,
@@ -95,13 +97,21 @@ class ManagerUitls {
      * @returns
      */
     isTrack(data) {
-        return typeof data?.encoded === "string" && typeof data?.info === "object";
+        if (!data)
+            return false;
+        if (data[exports.TrackSymbol] === true)
+            return true;
+        return typeof data?.encoded === "string" && typeof data?.info === "object" && !("resolve" in data);
     }
     /**
      * Checks if the provided argument is a valid UnresolvedTrack.
      * @param track
      */
     isUnresolvedTrack(data) {
+        if (!data)
+            return false;
+        if (data[exports.UnresolvedTrackSymbol] === true)
+            return true;
         return typeof data === "object" && "info" in data && typeof data.info.title === "string" && typeof data.resolve === "function";
     }
     /**
@@ -277,6 +287,32 @@ async function queueTrackEnd(player) {
     return player.queue.current;
 }
 exports.queueTrackEnd = queueTrackEnd;
+async function applyUnresolvedData(resTrack, data, utils) {
+    if (!resTrack?.info || !data?.info)
+        return;
+    if (utils.manager.options.playerOptions?.useUnresolvedData === true) { // overwrite values
+        if (data.info.uri)
+            resTrack.info.uri = data.info.uri;
+        if (data.info.artworkUrl?.length)
+            resTrack.info.artworkUrl = data.info.artworkUrl;
+        if (data.info.title?.length)
+            resTrack.info.title = data.info.title;
+        if (data.info.author?.length)
+            resTrack.info.author = data.info.author;
+    }
+    else { // only overwrite if undefined / invalid
+        if ((resTrack.info.title == 'Unknown title' || resTrack.info.title == "Unspecified description") && resTrack.info.title != data.info.title)
+            resTrack.info.title = data.info.title;
+        if (resTrack.info.author != data.info.author)
+            resTrack.info.author = data.info.author;
+        if (resTrack.info.artworkUrl != data.info.artworkUrl)
+            resTrack.info.artworkUrl = data.info.artworkUrl;
+    }
+    for (const key of Object.keys(data.info))
+        if (typeof resTrack.info[key] === "undefined" && key !== "resolve" && data.info[key])
+            resTrack.info[key] = data.info[key]; // add non-existing values
+    return resTrack;
+}
 async function getClosestTrack(data, player, utils) {
     if (!player || !player.node)
         throw new RangeError("No player with a lavalink node was provided");
@@ -288,19 +324,35 @@ async function getClosestTrack(data, player, utils) {
         throw new SyntaxError("the track title is required for unresolved tracks");
     if (!data.requester)
         throw new SyntaxError("The requester is required");
+    // try to decode the track, if possible
     if (typeof data.encoded === "string") {
-        const r = await player.node.decode.singleTrack(data.encoded);
+        const r = await player.node.decode.singleTrack(data.encoded, data.requester);
         if (r)
-            return utils.buildTrack(r, data.requester);
+            return applyUnresolvedData(r, data, utils);
     }
+    // try to fetch the track via a uri if possible
     if (typeof data.info.uri === "string") {
         const r = await player.search({ query: data?.info?.uri }, data.requester).then(v => v.tracks[0]);
         if (r)
-            return r;
+            return applyUnresolvedData(r, data, utils);
     }
+    // search the track as closely as possible
     const query = [data.info?.title, data.info?.author].filter(str => !!str).join(" by ");
     const sourceName = data.info?.sourceName;
     return await player.search({
         query, source: sourceName !== "bandcamp" && sourceName !== "twitch" && sourceName !== "flowery-tts" ? sourceName : player.LavalinkManager.options?.playerOptions?.defaultSearchPlatform,
-    }, data.requester).then(v => v.tracks[0]);
+    }, data.requester).then(res => {
+        let trackToUse = null;
+        // try to find via author name
+        if (data.info.author && !trackToUse)
+            trackToUse = res.tracks.find(track => [data.info.author, `${data.info.author} - Topic`].some(name => new RegExp(`^${escapeRegExp(name)}$`, "i").test(track.info.author)) || new RegExp(`^${escapeRegExp(data.info.title)}$`, "i").test(track.info.title));
+        // try to find via duration
+        if (data.info.duration && !trackToUse)
+            trackToUse = res.tracks.find(track => (track.info.duration >= (data.info.duration - 1500)) && (track.info.duration <= (data.info.duration + 1500)));
+        // try to find via isrc
+        if (data.info.isrc && !trackToUse)
+            trackToUse = res.tracks.find(track => track.info.isrc === data.info.isrc);
+        // apply unresolved data and return the track
+        return applyUnresolvedData(trackToUse || res.tracks[0], data, utils);
+    });
 }

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

@@ -11,7 +11,9 @@ export interface LavalinkManager {
     utils: ManagerUitls;
 }
 export interface BotClientOptions {
+    /** Bot Client Id */
     id: string;
+    /** Bot Client Username */
     username?: string;
     /** So users can pass entire objects / classes */
     [x: string | number | symbol | undefined]: any;
@@ -39,6 +41,7 @@ export interface LavalinkPlayerOptions {
         autoPlayFunction?: (player: Player, lastPlayedTrack: Track) => Promise<void>;
         destroyAfterMs?: number;
     };
+    useUnresolvedData?: boolean;
 }
 export interface ManagerOptions {
     nodes: LavalinkNodeOptions[];

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

@@ -4,7 +4,7 @@ import { NodeManager } from "./NodeManager";
 import internal from "stream";
 import { InvalidLavalinkRestRequest, LavalinkPlayer, PlayerUpdateInfo, RoutePlanner, Session, Base64 } from "./Utils";
 import { DestroyReasonsType } from "./Player";
-import { TrackInfo } from "./Track";
+import { Track } from "./Track";
 /** Modifies any outgoing REST requests. */
 export type ModifyRequest = (options: Dispatcher.RequestOptions) => void;
 export interface LavalinkNodeOptions {
@@ -185,13 +185,13 @@ export declare class LavalinkNode {
          * @param encoded
          * @returns
          */
-        singleTrack: (encoded: Base64) => Promise<TrackInfo>;
+        singleTrack: (encoded: Base64, requester: unknown) => Promise<Track>;
         /**
          *
          * @param encodeds Decodes multiple tracks into their info
          * @returns
          */
-        multipleTracks: (encodeds: Base64[]) => Promise<TrackInfo[]>;
+        multipleTracks: (encodeds: Base64[], requester: unknown) => Promise<Track[]>;
     };
     /**
      * Request Lavalink statistics.

package/dist/esm/structures/Node.js

@@ -223,25 +223,27 @@ export class LavalinkNode {
          * @param encoded
          * @returns
          */
-        singleTrack: async (encoded) => {
+        singleTrack: async (encoded, requester) => {
             if (!encoded)
                 throw new SyntaxError("No encoded (Base64 string) was provided");
-            return await this.request(`/decodetrack?encodedTrack=${encoded}`);
+            // return the decoded + builded track
+            return this.NodeManager.LavalinkManager.utils.buildTrack(await this.request(`/decodetrack?encodedTrack=${encoded}`), requester);
         },
         /**
          *
          * @param encodeds Decodes multiple tracks into their info
          * @returns
          */
-        multipleTracks: async (encodeds) => {
+        multipleTracks: async (encodeds, requester) => {
             if (!Array.isArray(encodeds) || !encodeds.every(v => typeof v === "string" && v.length > 1))
                 throw new SyntaxError("You need to provide encodeds, which is an array of base64 strings");
+            // return the decoded + builded tracks
             return await this.request(`/decodetracks`, r => {
                 r.method = "POST";
                 r.body = JSON.stringify(encodeds);
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 r.headers["Content-Type"] = "application/json";
-            });
+            }).then((r) => r.map(track => this.NodeManager.LavalinkManager.utils.buildTrack(track, requester)));
         }
     };
     /**

package/dist/esm/structures/Utils.js

@@ -3,6 +3,8 @@ export const TrackSymbol = Symbol("LC-Track");
 export const UnresolvedTrackSymbol = Symbol("LC-Track-Unresolved");
 export const QueueSymbol = Symbol("LC-Queue");
 export const NodeSymbol = Symbol("LC-Node");
+/** @hidden */
+const escapeRegExp = (str) => str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 export class ManagerUitls {
     constructor(LavalinkManager) {
         this.manager = LavalinkManager;
@@ -20,7 +22,7 @@ export class ManagerUitls {
                     identifier: data.info?.identifier,
                     title: data.info?.title,
                     author: data.info?.author,
-                    duration: data.info?.length,
+                    duration: data.info?.length || data.info?.duration,
                     artworkUrl: data.info?.artworkUrl || data.pluginInfo?.artworkUrl || data.plugin?.artworkUrl,
                     uri: data.info?.uri,
                     sourceName: data.info?.sourceName,
@@ -92,13 +94,21 @@ export class ManagerUitls {
      * @returns
      */
     isTrack(data) {
-        return typeof data?.encoded === "string" && typeof data?.info === "object";
+        if (!data)
+            return false;
+        if (data[TrackSymbol] === true)
+            return true;
+        return typeof data?.encoded === "string" && typeof data?.info === "object" && !("resolve" in data);
     }
     /**
      * Checks if the provided argument is a valid UnresolvedTrack.
      * @param track
      */
     isUnresolvedTrack(data) {
+        if (!data)
+            return false;
+        if (data[UnresolvedTrackSymbol] === true)
+            return true;
         return typeof data === "object" && "info" in data && typeof data.info.title === "string" && typeof data.resolve === "function";
     }
     /**
@@ -271,6 +281,32 @@ export async function queueTrackEnd(player) {
     // return the new current Track
     return player.queue.current;
 }
+async function applyUnresolvedData(resTrack, data, utils) {
+    if (!resTrack?.info || !data?.info)
+        return;
+    if (utils.manager.options.playerOptions?.useUnresolvedData === true) { // overwrite values
+        if (data.info.uri)
+            resTrack.info.uri = data.info.uri;
+        if (data.info.artworkUrl?.length)
+            resTrack.info.artworkUrl = data.info.artworkUrl;
+        if (data.info.title?.length)
+            resTrack.info.title = data.info.title;
+        if (data.info.author?.length)
+            resTrack.info.author = data.info.author;
+    }
+    else { // only overwrite if undefined / invalid
+        if ((resTrack.info.title == 'Unknown title' || resTrack.info.title == "Unspecified description") && resTrack.info.title != data.info.title)
+            resTrack.info.title = data.info.title;
+        if (resTrack.info.author != data.info.author)
+            resTrack.info.author = data.info.author;
+        if (resTrack.info.artworkUrl != data.info.artworkUrl)
+            resTrack.info.artworkUrl = data.info.artworkUrl;
+    }
+    for (const key of Object.keys(data.info))
+        if (typeof resTrack.info[key] === "undefined" && key !== "resolve" && data.info[key])
+            resTrack.info[key] = data.info[key]; // add non-existing values
+    return resTrack;
+}
 async function getClosestTrack(data, player, utils) {
     if (!player || !player.node)
         throw new RangeError("No player with a lavalink node was provided");
@@ -282,19 +318,35 @@ async function getClosestTrack(data, player, utils) {
         throw new SyntaxError("the track title is required for unresolved tracks");
     if (!data.requester)
         throw new SyntaxError("The requester is required");
+    // try to decode the track, if possible
     if (typeof data.encoded === "string") {
-        const r = await player.node.decode.singleTrack(data.encoded);
+        const r = await player.node.decode.singleTrack(data.encoded, data.requester);
         if (r)
-            return utils.buildTrack(r, data.requester);
+            return applyUnresolvedData(r, data, utils);
     }
+    // try to fetch the track via a uri if possible
     if (typeof data.info.uri === "string") {
         const r = await player.search({ query: data?.info?.uri }, data.requester).then(v => v.tracks[0]);
         if (r)
-            return r;
+            return applyUnresolvedData(r, data, utils);
     }
+    // search the track as closely as possible
     const query = [data.info?.title, data.info?.author].filter(str => !!str).join(" by ");
     const sourceName = data.info?.sourceName;
     return await player.search({
         query, source: sourceName !== "bandcamp" && sourceName !== "twitch" && sourceName !== "flowery-tts" ? sourceName : player.LavalinkManager.options?.playerOptions?.defaultSearchPlatform,
-    }, data.requester).then(v => v.tracks[0]);
+    }, data.requester).then(res => {
+        let trackToUse = null;
+        // try to find via author name
+        if (data.info.author && !trackToUse)
+            trackToUse = res.tracks.find(track => [data.info.author, `${data.info.author} - Topic`].some(name => new RegExp(`^${escapeRegExp(name)}$`, "i").test(track.info.author)) || new RegExp(`^${escapeRegExp(data.info.title)}$`, "i").test(track.info.title));
+        // try to find via duration
+        if (data.info.duration && !trackToUse)
+            trackToUse = res.tracks.find(track => (track.info.duration >= (data.info.duration - 1500)) && (track.info.duration <= (data.info.duration + 1500)));
+        // try to find via isrc
+        if (data.info.isrc && !trackToUse)
+            trackToUse = res.tracks.find(track => track.info.isrc === data.info.isrc);
+        // apply unresolved data and return the track
+        return applyUnresolvedData(trackToUse || res.tracks[0], data, utils);
+    });
 }

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

@@ -11,7 +11,9 @@ export interface LavalinkManager {
     utils: ManagerUitls;
 }
 export interface BotClientOptions {
+    /** Bot Client Id */
     id: string;
+    /** Bot Client Username */
     username?: string;
     /** So users can pass entire objects / classes */
     [x: string | number | symbol | undefined]: any;
@@ -39,6 +41,7 @@ export interface LavalinkPlayerOptions {
         autoPlayFunction?: (player: Player, lastPlayedTrack: Track) => Promise<void>;
         destroyAfterMs?: number;
     };
+    useUnresolvedData?: boolean;
 }
 export interface ManagerOptions {
     nodes: LavalinkNodeOptions[];

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

@@ -4,7 +4,7 @@ import { NodeManager } from "./NodeManager";
 import internal from "stream";
 import { InvalidLavalinkRestRequest, LavalinkPlayer, PlayerUpdateInfo, RoutePlanner, Session, Base64 } from "./Utils";
 import { DestroyReasonsType } from "./Player";
-import { TrackInfo } from "./Track";
+import { Track } from "./Track";
 /** Modifies any outgoing REST requests. */
 export type ModifyRequest = (options: Dispatcher.RequestOptions) => void;
 export interface LavalinkNodeOptions {
@@ -185,13 +185,13 @@ export declare class LavalinkNode {
          * @param encoded
          * @returns
          */
-        singleTrack: (encoded: Base64) => Promise<TrackInfo>;
+        singleTrack: (encoded: Base64, requester: unknown) => Promise<Track>;
         /**
          *
          * @param encodeds Decodes multiple tracks into their info
          * @returns
          */
-        multipleTracks: (encodeds: Base64[]) => Promise<TrackInfo[]>;
+        multipleTracks: (encodeds: Base64[], requester: unknown) => Promise<Track[]>;
     };
     /**
      * Request Lavalink statistics.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lavalink-client",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Easy and advanced lavalink client. Use it with lavalink plugins as well as latest lavalink versions",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",