lavalink-client 2.3.4 → 2.3.6

package/dist/cjs/structures/Node.js

@@ -4,8 +4,8 @@ exports.LavalinkNode = void 0;
 const tslib_1 = require("tslib");
 const path_1 = require("path");
 const ws_1 = tslib_1.__importDefault(require("ws"));
-const Constants_1 = require("./Constants");
-const Utils_1 = require("./Utils");
+const Constants_1 = require("./Constants.js");
+const Utils_1 = require("./Utils.js");
 /**
  * Lavalink Node creator class
  */
@@ -590,6 +590,104 @@ class LavalinkNode {
             }).then((r) => r.map(track => this.NodeManager.LavalinkManager.utils.buildTrack(track, requester)));
         }
     };
+    lyrics = {
+        /**
+         * Get the lyrics of a track
+         * @param track the track to get the lyrics for
+         * @param skipTrackSource wether to skip the track source or not
+         * @returns the lyrics of the track
+         * @example
+         *
+         * ```ts
+         * const lyrics = await player.node.lyrics.get(track, true);
+         * // use it of player instead:
+         * // const lyrics = await player.getLyrics(track, true);
+         * ```
+         */
+        get: async (track, skipTrackSource = false) => {
+            if (!this.sessionId)
+                throw new Error("the Lavalink-Node is either not ready, or not up to date!");
+            if (!this.info.plugins.find(v => v.name === "lavalyrics-plugin"))
+                throw new RangeError(`there is no lavalyrics-plugin available in the lavalink node (required for lyrics): ${this.id}`);
+            if (!this.info.plugins.find(v => v.name === "lavasrc-plugin") &&
+                !this.info.plugins.find(v => v.name === "java-lyrics-plugin"))
+                throw new RangeError(`there is no lyrics source (via lavasrc-plugin / java-lyrics-plugin) available in the lavalink node (required for lyrics): ${this.id}`);
+            const url = `/lyrics?track=${track.encoded}&skipTrackSource=${skipTrackSource}`;
+            return (await this.request(url));
+        },
+        /**
+         * Get the lyrics of the current playing track
+         *
+         * @param guildId the guild id of the player
+         * @param skipTrackSource wether to skip the track source or not
+         * @returns the lyrics of the current playing track
+         * @example
+         * ```ts
+         * const lyrics = await player.node.lyrics.getCurrent(guildId);
+         * // use it of player instead:
+         * // const lyrics = await player.getCurrentLyrics();
+         * ```
+         */
+        getCurrent: async (guildId, skipTrackSource = false) => {
+            if (!this.sessionId)
+                throw new Error("the Lavalink-Node is either not ready, or not up to date!");
+            if (!this.info.plugins.find(v => v.name === "lavalyrics-plugin"))
+                throw new RangeError(`there is no lavalyrics-plugin available in the lavalink node (required for lyrics): ${this.id}`);
+            if (!this.info.plugins.find(v => v.name === "lavasrc-plugin") &&
+                !this.info.plugins.find(v => v.name === "java-lyrics-plugin"))
+                throw new RangeError(`there is no lyrics source (via lavasrc-plugin / java-lyrics-plugin) available in the lavalink node (required for lyrics): ${this.id}`);
+            const url = `/sessions/${this.sessionId}/players/${guildId}/track/lyrics?skipTrackSource=${skipTrackSource}`;
+            return (await this.request(url));
+        },
+        /**
+         * subscribe to lyrics updates for a guild
+         * @param guildId the guild id of the player
+         * @returns request data of the request
+         *
+         * @example
+         * ```ts
+         * await player.node.lyrics.subscribe(guildId);
+         * // use it of player instead:
+         * // const lyrics = await player.subscribeLyrics();
+         * ```
+         */
+        subscribe: async (guildId) => {
+            if (!this.sessionId)
+                throw new Error("the Lavalink-Node is either not ready, or not up to date!");
+            if (!this.info.plugins.find(v => v.name === "lavalyrics-plugin"))
+                throw new RangeError(`there is no lavalyrics-plugin available in the lavalink node (required for lyrics): ${this.id}`);
+            if (!this.info.plugins.find(v => v.name === "lavasrc-plugin") &&
+                !this.info.plugins.find(v => v.name === "java-lyrics-plugin"))
+                throw new RangeError(`there is no lyrics source (via lavasrc-plugin / java-lyrics-plugin) available in the lavalink node (required for lyrics): ${this.id}`);
+            return await this.request(`/sessions/${this.sessionId}/players/${guildId}/lyrics/subscribe`, (options) => {
+                options.method = "POST";
+            }).catch(() => { });
+        },
+        /**
+         * unsubscribe from lyrics updates for a guild
+         * @param guildId the guild id of the player
+         * @returns request data of the request
+         *
+         * @example
+         * ```ts
+         * await player.node.lyrics.unsubscribe(guildId);
+         * // use it of player instead:
+         * // const lyrics = await player.unsubscribeLyrics();
+         * ```
+         */
+        unsubscribe: async (guildId) => {
+            if (!this.sessionId)
+                throw new Error("the Lavalink-Node is either not ready, or not up to date!");
+            if (!this.info.plugins.find(v => v.name === "lavalyrics-plugin"))
+                throw new RangeError(`there is no lavalyrics-plugin available in the lavalink node (required for lyrics): ${this.id}`);
+            if (!this.info.plugins.find(v => v.name === "lavasrc-plugin") &&
+                !this.info.plugins.find(v => v.name === "java-lyrics-plugin"))
+                throw new RangeError(`there is no lyrics source (via lavasrc-plugin / java-lyrics-plugin) available in the lavalink node (required for lyrics): ${this.id}`);
+            return await this.request(`/sessions/${this.sessionId}/players/${guildId}/lyrics/unsubscribe`, (options) => {
+                options.method = "DELETE";
+            }).catch(() => { });
+        },
+    };
     /**
      * Request Lavalink statistics.
      * @returns the lavalink node stats
@@ -986,6 +1084,15 @@ class LavalinkNode {
             case "ChapterStarted":
                 this.SponsorBlockChapterStarted(player, player.queue.current, payload);
                 break;
+            case "LyricsLineEvent":
+                this.LyricsLine(player, player.queue.current, payload);
+                break;
+            case "LyricsFoundEvent":
+                this.LyricsFound(player, player.queue.current, payload);
+                break;
+            case "LyricsNotFoundEvent":
+                this.LyricsNotFound(player, player.queue.current, payload);
+                break;
             default:
                 this.NodeManager.emit("error", this, new Error(`Node#event unknown event '${payload.type}'.`), payload);
                 break;
@@ -1256,9 +1363,16 @@ class LavalinkNode {
             });
         }
         if (typeof this.NodeManager.LavalinkManager.options?.playerOptions?.onEmptyQueue?.autoPlayFunction === "function" && typeof player.get("internal_autoplayStopPlaying") === "undefined") {
+            if (this.NodeManager.LavalinkManager.options?.advancedOptions?.enableDebugEvents) {
+                this.NodeManager.LavalinkManager.emit("debug", Constants_1.DebugEvents.AutoplayExecution, {
+                    state: "log",
+                    message: `Now Triggering Autoplay.`,
+                    functionLayer: "LavalinkNode > queueEnd() > autoplayFunction",
+                });
+            }
             const previousAutoplayTime = player.get("internal_previousautoplay");
             const duration = previousAutoplayTime ? Date.now() - previousAutoplayTime : 0;
-            if ((duration && duration > this.NodeManager.LavalinkManager.options.playerOptions.minAutoPlayMs) || !!player.get("internal_skipped")) {
+            if (!duration || duration > this.NodeManager.LavalinkManager.options.playerOptions.minAutoPlayMs || !!player.get("internal_skipped")) {
                 await this.NodeManager.LavalinkManager.options?.playerOptions?.onEmptyQueue?.autoPlayFunction(player, track);
                 player.set("internal_previousautoplay", Date.now());
                 if (player.queue.tracks.length > 0)
@@ -1319,5 +1433,35 @@ class LavalinkNode {
         }
         return this.NodeManager.LavalinkManager.emit("queueEnd", player, track, payload);
     }
+    /**
+     * Emitted whenever a line of lyrics gets emitted
+     * @event
+     * @param {Player} player The player that emitted the event
+     * @param {Track} track The track that emitted the event
+     * @param {LyricsLineEvent} payload The payload of the event
+     */
+    LyricsLine(player, track, payload) {
+        return this.NodeManager.LavalinkManager.emit("LyricsLine", player, track, payload);
+    }
+    /**
+     * Emitted whenever the lyrics for a track got found
+     * @event
+     * @param {Player} player The player that emitted the event
+     * @param {Track} track The track that emitted the event
+     * @param {LyricsFoundEvent} payload The payload of the event
+     */
+    LyricsFound(player, track, payload) {
+        return this.NodeManager.LavalinkManager.emit("LyricsFound", player, track, payload);
+    }
+    /**
+     * Emitted whenever the lyrics for a track got not found
+     * @event
+     * @param {Player} player The player that emitted the event
+     * @param {Track} track The track that emitted the event
+     * @param {LyricsNotFoundEvent} payload The payload of the event
+     */
+    LyricsNotFound(player, track, payload) {
+        return this.NodeManager.LavalinkManager.emit("LyricsNotFound", player, track, payload);
+    }
 }
 exports.LavalinkNode = LavalinkNode;

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

@@ -1,9 +1,9 @@
 /// <reference types="node" />
 import { EventEmitter } from "events";
-import { LavalinkNode } from "./Node";
-import { MiniMap } from "./Utils";
-import type { LavalinkNodeIdentifier, LavalinkNodeOptions, NodeManagerEvents } from "./Types/Node";
-import type { LavalinkManager } from "./LavalinkManager";
+import { LavalinkNode } from "./Node.js";
+import { MiniMap } from "./Utils.js";
+import type { LavalinkNodeIdentifier, LavalinkNodeOptions, NodeManagerEvents } from "./Types/Node.js";
+import type { LavalinkManager } from "./LavalinkManager.js";
 export declare class NodeManager extends EventEmitter {
     /**
      * Emit an event

package/dist/cjs/structures/NodeManager.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeManager = void 0;
 const events_1 = require("events");
-const Constants_1 = require("./Constants");
-const Node_1 = require("./Node");
-const Utils_1 = require("./Utils");
+const Constants_1 = require("./Constants.js");
+const Node_1 = require("./Node.js");
+const Utils_1 = require("./Utils.js");
 class NodeManager extends events_1.EventEmitter {
     /**
      * Emit an event

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

@@ -1,11 +1,12 @@
-import { FilterManager } from "./Filters";
-import { Queue } from "./Queue";
-import type { DestroyReasons } from "./Constants";
-import type { LavalinkNode } from "./Node";
-import type { SponsorBlockSegment } from "./Types/Node";
-import type { PlayerJson, PlayerOptions, PlayOptions, RepeatMode } from "./Types/Player";
-import type { LavalinkManager } from "./LavalinkManager";
-import type { LavalinkPlayerVoiceOptions, LavaSearchQuery, SearchQuery } from "./Types/Utils";
+import { FilterManager } from "./Filters.js";
+import { Queue } from "./Queue.js";
+import type { DestroyReasons } from "./Constants.js";
+import type { Track } from "./Types/Track.js";
+import type { LavalinkNode } from "./Node.js";
+import type { SponsorBlockSegment } from "./Types/Node.js";
+import type { PlayerJson, PlayerOptions, PlayOptions, RepeatMode } from "./Types/Player.js";
+import type { LavalinkManager } from "./LavalinkManager.js";
+import type { LavalinkPlayerVoiceOptions, LavaSearchQuery, SearchQuery } from "./Types/Utils.js";
 export declare class Player {
     /** Filter Manager per player */
     filterManager: FilterManager;
@@ -96,7 +97,7 @@ export declare class Player {
      * @param throwOnEmpty If an error should be thrown if no track is found
      * @returns The search result
      */
-    lavaSearch(query: LavaSearchQuery, requestUser: unknown, throwOnEmpty?: boolean): Promise<import("./Types/Utils").SearchResult | import("./Types/Utils").LavaSearchResponse>;
+    lavaSearch(query: LavaSearchQuery, requestUser: unknown, throwOnEmpty?: boolean): Promise<import("./Types/Utils.js").SearchResult | import("./Types/Utils.js").LavaSearchResponse>;
     /**
      * Set the SponsorBlock
      * @param segments The segments to set
@@ -115,7 +116,7 @@ export declare class Player {
      * @param query Query for your data
      * @param requestUser
      */
-    search(query: SearchQuery, requestUser: unknown, throwOnEmpty?: boolean): Promise<import("./Types/Utils").UnresolvedSearchResult | import("./Types/Utils").SearchResult>;
+    search(query: SearchQuery, requestUser: unknown, throwOnEmpty?: boolean): Promise<import("./Types/Utils.js").UnresolvedSearchResult | import("./Types/Utils.js").SearchResult>;
     /**
      * Pause the player
      */
@@ -164,6 +165,48 @@ export declare class Player {
      * Destroy the player and disconnect from the voice channel
      */
     destroy(reason?: DestroyReasons | string, disconnect?: boolean): Promise<this>;
+    /**
+     * Get the current lyrics of the track currently playing on the guild
+     * @param guildId The guild id to get the current lyrics for
+     * @param skipTrackSource If true, it will not try to get the lyrics from the track source
+     * @returns The current lyrics
+     * @example
+     * ```ts
+     * const lyrics = await player.getCurrentLyrics();
+     * ```
+     */
+    getCurrentLyrics(skipTrackSource?: boolean): Promise<import("./Types/Node.js").LyricsResult>;
+    /**
+     * Get the lyrics of a specific track
+     * @param track The track to get the lyrics for
+     * @param skipTrackSource If true, it will not try to get the lyrics from the track source
+     * @returns The lyrics of the track
+     * @example
+     * ```ts
+     * const lyrics = await player.getLyrics(player.queue.tracks[0], true);
+     * ```
+     */
+    getLyrics(track: Track, skipTrackSource?: boolean): Promise<import("./Types/Node.js").LyricsResult>;
+    /**
+     * Subscribe to the lyrics event on a specific guild to active live lyrics events
+     * @param guildId The guild id to subscribe to
+     * @returns The unsubscribe function
+     * @example
+     * ```ts
+     * const lyrics = await player.subscribeLyrics();
+     * ```
+     */
+    subscribeLyrics(): Promise<any>;
+    /**
+     * Unsubscribe from the lyrics event on a specific guild to disable live lyrics events
+     * @param guildId The guild id to unsubscribe from
+     * @returns The unsubscribe function
+     * @example
+     * ```ts
+     * const lyrics = await player.unsubscribeLyrics();
+     * ```
+     */
+    unsubscribeLyrics(guildId: string): Promise<any>;
     /**
      * Move the player on a different Audio-Node
      * @param newNode New Node / New Node Id

package/dist/cjs/structures/Player.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Player = void 0;
-const Constants_1 = require("./Constants");
-const BandCampSearch_1 = require("./CustomSearches/BandCampSearch");
-const Filters_1 = require("./Filters");
-const Queue_1 = require("./Queue");
-const Utils_1 = require("./Utils");
+const Constants_1 = require("./Constants.js");
+const BandCampSearch_1 = require("./CustomSearches/BandCampSearch.js");
+const Filters_1 = require("./Filters.js");
+const Queue_1 = require("./Queue.js");
+const Utils_1 = require("./Utils.js");
 class Player {
     /** Filter Manager per player */
     filterManager;
@@ -574,6 +574,56 @@ class Player {
         // return smt
         return this;
     }
+    /**
+     * Get the current lyrics of the track currently playing on the guild
+     * @param guildId The guild id to get the current lyrics for
+     * @param skipTrackSource If true, it will not try to get the lyrics from the track source
+     * @returns The current lyrics
+     * @example
+     * ```ts
+     * const lyrics = await player.getCurrentLyrics();
+     * ```
+     */
+    async getCurrentLyrics(skipTrackSource) {
+        return await this.node.lyrics.getCurrent(this.guildId, skipTrackSource);
+    }
+    /**
+     * Get the lyrics of a specific track
+     * @param track The track to get the lyrics for
+     * @param skipTrackSource If true, it will not try to get the lyrics from the track source
+     * @returns The lyrics of the track
+     * @example
+     * ```ts
+     * const lyrics = await player.getLyrics(player.queue.tracks[0], true);
+     * ```
+     */
+    async getLyrics(track, skipTrackSource) {
+        return await this.node.lyrics.get(track, skipTrackSource);
+    }
+    /**
+     * Subscribe to the lyrics event on a specific guild to active live lyrics events
+     * @param guildId The guild id to subscribe to
+     * @returns The unsubscribe function
+     * @example
+     * ```ts
+     * const lyrics = await player.subscribeLyrics();
+     * ```
+     */
+    subscribeLyrics() {
+        return this.node.lyrics.subscribe(this.guildId);
+    }
+    /**
+     * Unsubscribe from the lyrics event on a specific guild to disable live lyrics events
+     * @param guildId The guild id to unsubscribe from
+     * @returns The unsubscribe function
+     * @example
+     * ```ts
+     * const lyrics = await player.unsubscribeLyrics();
+     * ```
+     */
+    unsubscribeLyrics(guildId) {
+        return this.node.lyrics.unsubscribe(guildId);
+    }
     /**
      * Move the player on a different Audio-Node
      * @param newNode New Node / New Node Id

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

@@ -1,6 +1,6 @@
-import { MiniMap } from "./Utils";
-import type { Track, UnresolvedTrack } from "./Types/Track";
-import type { ManagerQueueOptions, QueueStoreManager, StoredQueue } from "./Types/Queue";
+import { MiniMap } from "./Utils.js";
+import type { Track, UnresolvedTrack } from "./Types/Track.js";
+import type { ManagerQueueOptions, QueueStoreManager, StoredQueue } from "./Types/Queue.js";
 export declare class QueueSaver {
     /**
      * The queue store manager

package/dist/cjs/structures/Queue.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Queue = exports.DefaultQueueStore = exports.QueueSaver = void 0;
-const Utils_1 = require("./Utils");
+const Utils_1 = require("./Utils.js");
 class QueueSaver {
     /**
      * The queue store manager

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

@@ -1,4 +1,4 @@
-import type { FloatNumber, IntegerNumber } from "./Utils";
+import type { FloatNumber, IntegerNumber } from "./Utils.js";
 /** The Audio Outputs type */
 export type AudioOutputs = "mono" | "stereo" | "left" | "right";
 /** The "active" / "disabled" Player Filters */

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

@@ -1,10 +1,10 @@
-import type { DebugEvents } from "../Constants";
-import type { Player } from "../Player";
-import type { LavalinkNodeOptions } from "./Node";
-import type { DestroyReasonsType, PlayerJson } from "./Player";
-import type { ManagerQueueOptions } from "./Queue";
-import type { Track, UnresolvedTrack } from "./Track";
-import type { GuildShardPayload, SearchPlatform, SponsorBlockChaptersLoaded, SponsorBlockChapterStarted, SponsorBlockSegmentSkipped, SponsorBlockSegmentsLoaded, TrackExceptionEvent, TrackEndEvent, TrackStuckEvent, WebSocketClosedEvent, TrackStartEvent } from "./Utils";
+import type { DebugEvents } from "../Constants.js";
+import type { Player } from "../Player.js";
+import type { LavalinkNodeOptions } from "./Node.js";
+import type { DestroyReasonsType, PlayerJson } from "./Player.js";
+import type { ManagerQueueOptions } from "./Queue.js";
+import type { Track, UnresolvedTrack } from "./Track.js";
+import type { GuildShardPayload, SearchPlatform, SponsorBlockChaptersLoaded, SponsorBlockChapterStarted, SponsorBlockSegmentSkipped, SponsorBlockSegmentsLoaded, TrackExceptionEvent, TrackEndEvent, TrackStuckEvent, WebSocketClosedEvent, TrackStartEvent, LyricsFoundEvent, LyricsNotFoundEvent, LyricsLineEvent } from "./Utils.js";
 /**
  * The events from the lavalink Manager
  */
@@ -114,6 +114,24 @@ export interface LavalinkManagerEvents {
         error?: Error | string;
         functionLayer: string;
     }) => void;
+    /**
+     * Emitted when a Lyrics line is received
+     * @link https://github.com/topi314/LavaLyrics
+     * @event Manager#LyricsLine
+     */
+    "LyricsLine": (player: Player, track: Track | UnresolvedTrack | null, payload: LyricsLineEvent) => void;
+    /**
+     * Emitted when a Lyrics is found
+     * @link https://github.com/topi314/LavaLyrics
+     * @event Manager#LyricsFound
+     */
+    "LyricsFound": (player: Player, track: Track | UnresolvedTrack | null, payload: LyricsFoundEvent) => void;
+    /**
+     * Emitted when a Lyrics is not found
+     * @link https://github.com/topi314/LavaLyrics
+     * @event Manager#LyricsNotFound
+     */
+    "LyricsNotFound": (player: Player, track: Track | UnresolvedTrack | null, payload: LyricsNotFoundEvent) => void;
 }
 /**
  * The Bot client Options needed for the manager

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

@@ -1,8 +1,9 @@
 /// <reference types="node" />
 import type internal from "stream";
-import type { LavalinkNode } from "../Node";
-import type { DestroyReasonsType } from "./Player";
-import type { InvalidLavalinkRestRequest, LavalinkPlayer } from "./Utils";
+import type { LavalinkNode } from "../Node.js";
+import type { DestroyReasonsType } from "./Player.js";
+import type { InvalidLavalinkRestRequest, LavalinkPlayer } from "./Utils.js";
+import type { PluginInfo } from "./Track.js";
 /** Ability to manipulate fetch requests */
 export type ModifyRequest = (options: RequestInit & {
     path: string;
@@ -157,6 +158,28 @@ export interface PluginObject {
     /** The version of the plugin */
     version: string;
 }
+export interface LyricsResult {
+    /**The name of the source */
+    sourceName: string;
+    /**The name of the provider */
+    provider: string;
+    /**The result text */
+    text: string | null;
+    /**The lyrics lines */
+    lines: LyricsLine[];
+    /**Information about the plugin */
+    plugin: PluginInfo;
+}
+export interface LyricsLine {
+    /**The millisecond timestamp */
+    timestamp: number;
+    /**The line duration in milliseconds */
+    duration: number | null;
+    /**The line text */
+    line: string;
+    /**Information about the plugin */
+    plugin: PluginInfo;
+}
 export type LavalinkNodeIdentifier = string;
 export interface NodeManagerEvents {
     /**

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

@@ -1,8 +1,8 @@
-import type { DestroyReasons } from "../Constants";
-import type { LavalinkNode } from "../Node";
-import type { EQBand, FilterData, LavalinkFilterData } from "./Filters";
-import type { Track, UnresolvedTrack } from "./Track";
-import type { Base64, LavalinkPlayerVoiceOptions } from "./Utils";
+import type { DestroyReasons } from "../Constants.js";
+import type { LavalinkNode } from "../Node.js";
+import type { EQBand, FilterData, LavalinkFilterData } from "./Filters.js";
+import type { Track, UnresolvedTrack } from "./Track.js";
+import type { Base64, LavalinkPlayerVoiceOptions } from "./Utils.js";
 export type DestroyReasonsType = keyof typeof DestroyReasons | string;
 export interface PlayerJson {
     /** Guild Id where the player was playing in */

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

@@ -1,4 +1,4 @@
-import type { Track, UnresolvedTrack } from "./Track";
+import type { Track, UnresolvedTrack } from "./Track.js";
 export interface StoredQueue {
     current: Track | null;
     previous: Track[];

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

@@ -1,6 +1,6 @@
-import type { Player } from "../Player";
-import type { anyObject } from "./Player";
-import type { Base64 } from "./Utils";
+import type { Player } from "../Player.js";
+import type { anyObject } from "./Player.js";
+import type { Base64 } from "./Utils.js";
 /** Sourcenames provided by lavalink server */
 export type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
 /** Source Names provided by lava src plugin */

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

@@ -1,8 +1,8 @@
-import type { MiniMap } from "../Utils";
-import type { LavalinkFilterData } from "./Filters";
-import type { NodeStats } from "./Node";
-import type { LavalinkPlayOptions } from "./Player";
-import type { LavalinkTrack, PluginInfo, Track, UnresolvedTrack } from "./Track";
+import type { MiniMap } from "../Utils.js";
+import type { LavalinkFilterData } from "./Filters.js";
+import type { LyricsLine, LyricsResult, NodeStats } from "./Node.js";
+import type { LavalinkPlayOptions } from "./Player.js";
+import type { LavalinkTrack, PluginInfo, Track, UnresolvedTrack } from "./Track.js";
 /** Helper for generating Opaque types. */
 export type Opaque<T, K> = T & {
     __opaque__: K;
@@ -13,15 +13,16 @@ export type IntegerNumber = Opaque<number, 'Int'>;
 export type FloatNumber = Opaque<number, 'Float'>;
 export type LavaSrcSearchPlatformBase = "spsearch" | "sprec" | "amsearch" | "dzsearch" | "dzisrc" | "ymsearch";
 export type LavaSrcSearchPlatform = LavaSrcSearchPlatformBase | "ftts";
+export type JioSaavnSearchPlatform = "jssearch" | "jsrec";
 export type DuncteSearchPlatform = "speak" | "phsearch" | "pornhub" | "porn" | "tts";
 export type LavalinkClientSearchPlatform = "bcsearch";
 export type LavalinkClientSearchPlatformResolve = "bandcamp" | "bc";
-export type LavalinkSearchPlatform = "ytsearch" | "ytmsearch" | "scsearch" | "bcsearch" | LavaSrcSearchPlatform | DuncteSearchPlatform | LavalinkClientSearchPlatform;
+export type LavalinkSearchPlatform = "ytsearch" | "ytmsearch" | "scsearch" | "bcsearch" | LavaSrcSearchPlatform | DuncteSearchPlatform | JioSaavnSearchPlatform | LavalinkClientSearchPlatform;
 export type ClientCustomSearchPlatformUtils = "local" | "http" | "https" | "link" | "uri";
 export type ClientSearchPlatform = ClientCustomSearchPlatformUtils | // for file/link requests
-"youtube" | "yt" | "youtube music" | "youtubemusic" | "ytm" | "musicyoutube" | "music youtube" | "soundcloud" | "sc" | "am" | "apple music" | "applemusic" | "apple" | "musicapple" | "music apple" | "sp" | "spsuggestion" | "spotify" | "spotify.com" | "spotifycom" | "dz" | "deezer" | "yandex" | "yandex music" | "yandexmusic" | "flowerytts" | "flowery" | "flowery.tts" | LavalinkClientSearchPlatformResolve | LavalinkClientSearchPlatform;
+"youtube" | "yt" | "youtube music" | "youtubemusic" | "ytm" | "musicyoutube" | "music youtube" | "soundcloud" | "sc" | "am" | "apple music" | "applemusic" | "apple" | "musicapple" | "music apple" | "sp" | "spsuggestion" | "spotify" | "spotify.com" | "spotifycom" | "dz" | "deezer" | "yandex" | "yandex music" | "yandexmusic" | "flowerytts" | "flowery" | "flowery.tts" | LavalinkClientSearchPlatformResolve | LavalinkClientSearchPlatform | "js" | "jiosaavn";
 export type SearchPlatform = LavalinkSearchPlatform | ClientSearchPlatform;
-export type SourcesRegex = "YoutubeRegex" | "YoutubeMusicRegex" | "SoundCloudRegex" | "SoundCloudMobileRegex" | "DeezerTrackRegex" | "DeezerArtistRegex" | "DeezerEpisodeRegex" | "DeezerMixesRegex" | "DeezerPageLinkRegex" | "DeezerPlaylistRegex" | "DeezerAlbumRegex" | "AllDeezerRegex" | "AllDeezerRegexWithoutPageLink" | "SpotifySongRegex" | "SpotifyPlaylistRegex" | "SpotifyArtistRegex" | "SpotifyEpisodeRegex" | "SpotifyShowRegex" | "SpotifyAlbumRegex" | "AllSpotifyRegex" | "mp3Url" | "m3uUrl" | "m3u8Url" | "mp4Url" | "m4aUrl" | "wavUrl" | "aacpUrl" | "tiktok" | "mixcloud" | "musicYandex" | "radiohost" | "bandcamp" | "appleMusic" | "TwitchTv" | "vimeo";
+export type SourcesRegex = "YoutubeRegex" | "YoutubeMusicRegex" | "SoundCloudRegex" | "SoundCloudMobileRegex" | "DeezerTrackRegex" | "DeezerArtistRegex" | "DeezerEpisodeRegex" | "DeezerMixesRegex" | "DeezerPageLinkRegex" | "DeezerPlaylistRegex" | "DeezerAlbumRegex" | "AllDeezerRegex" | "AllDeezerRegexWithoutPageLink" | "SpotifySongRegex" | "SpotifyPlaylistRegex" | "SpotifyArtistRegex" | "SpotifyEpisodeRegex" | "SpotifyShowRegex" | "SpotifyAlbumRegex" | "AllSpotifyRegex" | "mp3Url" | "m3uUrl" | "m3u8Url" | "mp4Url" | "m4aUrl" | "wavUrl" | "aacpUrl" | "tiktok" | "mixcloud" | "musicYandex" | "radiohost" | "bandcamp" | "jiosaavn" | "appleMusic" | "TwitchTv" | "vimeo";
 export interface PlaylistInfo {
     /** The playlist name */
     name: string;
@@ -62,7 +63,7 @@ export interface MiniMapConstructor {
     readonly prototype: MiniMap<unknown, unknown>;
     readonly [Symbol.species]: MiniMapConstructor;
 }
-export type PlayerEvents = TrackStartEvent | TrackEndEvent | TrackStuckEvent | TrackExceptionEvent | WebSocketClosedEvent | SponsorBlockSegmentEvents;
+export type PlayerEvents = TrackStartEvent | TrackEndEvent | TrackStuckEvent | TrackExceptionEvent | WebSocketClosedEvent | SponsorBlockSegmentEvents | LyricsEvent;
 export type Severity = "COMMON" | "SUSPICIOUS" | "FAULT";
 export interface Exception {
     /** Severity of the error */
@@ -148,9 +149,66 @@ export interface SponsorBlockChaptersLoaded extends PlayerEvent {
         duration: number;
     }[];
 }
+/**
+ * Types & Events for Lyrics plugin from Lavalink: https://github.com/topi314/LavaLyrics
+ */
+export type LyricsEvent = LyricsFoundEvent | LyricsNotFoundEvent | LyricsLineEvent;
+export type LyricsEventType = "LyricsFoundEvent" | "LyricsNotFoundEvent" | "LyricsLineEvent";
+export interface LyricsFoundEvent extends PlayerEvent {
+    /** The lyricsfound event */
+    type: "LyricsFoundEvent";
+    /** The guildId */
+    guildId: string;
+    /** The lyrics */
+    lyrics: LyricsResult;
+}
+export interface LyricsNotFoundEvent extends PlayerEvent {
+    /**The lyricsnotfound event*/
+    type: "LyricsNotFoundEvent";
+    /**The guildId*/
+    guildId: string;
+}
+export interface LyricsLineEvent extends PlayerEvent {
+    /**The lyricsline event*/
+    type: "LyricsLineEvent";
+    /** The guildId */
+    guildId: string;
+    /** The line number */
+    lineIndex: number;
+    /** The line */
+    line: LyricsLine;
+    /**skipped is true if the line was skipped */
+    skipped: boolean;
+}
+export interface LyricsFoundEvent extends PlayerEvent {
+    /** The lyricsfound event */
+    type: "LyricsFoundEvent";
+    /** The guildId */
+    guildId: string;
+    /** The lyrics */
+    lyrics: LyricsResult;
+}
+export interface LyricsNotFoundEvent extends PlayerEvent {
+    /**The lyricsnotfound event*/
+    type: "LyricsNotFoundEvent";
+    /**The guildId*/
+    guildId: string;
+}
+export interface LyricsLineEvent extends PlayerEvent {
+    /**The lyricsline event*/
+    type: "LyricsLineEvent";
+    /** The guildId */
+    guildId: string;
+    /** The line number */
+    lineIndex: number;
+    /** The line */
+    line: LyricsLine;
+    /**skipped is true if the line was skipped */
+    skipped: boolean;
+}
 export type LoadTypes = "track" | "playlist" | "search" | "error" | "empty";
 export type State = "CONNECTED" | "CONNECTING" | "DISCONNECTED" | "DISCONNECTING" | "DESTROYING";
-export type PlayerEventType = "TrackStartEvent" | "TrackEndEvent" | "TrackExceptionEvent" | "TrackStuckEvent" | "WebSocketClosedEvent" | SponsorBlockSegmentEventType;
+export type PlayerEventType = "TrackStartEvent" | "TrackEndEvent" | "TrackExceptionEvent" | "TrackStuckEvent" | "WebSocketClosedEvent" | SponsorBlockSegmentEventType | LyricsEventType;
 export type TrackEndReason = "finished" | "loadFailed" | "stopped" | "replaced" | "cleanup";
 export interface InvalidLavalinkRestRequest {
     /** Rest Request Data for when it was made */