lavalink-client 2.3.4 → 2.3.6

package/dist/esm/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/esm/structures/Player.js

@@ -1,8 +1,8 @@
-import { DebugEvents } from "./Constants";
-import { bandCampSearch } from "./CustomSearches/BandCampSearch";
-import { FilterManager } from "./Filters";
-import { Queue, QueueSaver } from "./Queue";
-import { queueTrackEnd } from "./Utils";
+import { DebugEvents } from "./Constants.js";
+import { bandCampSearch } from "./CustomSearches/BandCampSearch.js";
+import { FilterManager } from "./Filters.js";
+import { Queue, QueueSaver } from "./Queue.js";
+import { queueTrackEnd } from "./Utils.js";
 export class Player {
     /** Filter Manager per player */
     filterManager;
@@ -571,6 +571,56 @@ export 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/esm/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/esm/structures/Queue.js

@@ -1,4 +1,4 @@
-import { ManagerUtils, MiniMap, QueueSymbol } from "./Utils";
+import { ManagerUtils, MiniMap, QueueSymbol } from "./Utils.js";
 export class QueueSaver {
     /**
      * The queue store manager

package/dist/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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 */

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

@@ -1,9 +1,9 @@
-import type { LavalinkNodeOptions } from "./Types/Node";
-import type { LavalinkSearchPlatform, LavaSearchQuery, MiniMapConstructor, SearchPlatform, SearchQuery } from "./Types/Utils";
-import type { LavalinkManager } from "./LavalinkManager";
-import type { LavalinkNode } from "./Node";
-import type { Player } from "./Player";
-import type { LavalinkTrack, Track, UnresolvedQuery, UnresolvedTrack } from "./Types/Track";
+import type { LavalinkNodeOptions } from "./Types/Node.js";
+import type { LavalinkSearchPlatform, LavaSearchQuery, MiniMapConstructor, SearchPlatform, SearchQuery } from "./Types/Utils.js";
+import type { LavalinkManager } from "./LavalinkManager.js";
+import type { LavalinkNode } from "./Node.js";
+import type { Player } from "./Player.js";
+import type { LavalinkTrack, Track, UnresolvedQuery, UnresolvedTrack } from "./Types/Track.js";
 export declare const TrackSymbol: unique symbol;
 export declare const UnresolvedTrackSymbol: unique symbol;
 export declare const QueueSymbol: unique symbol;

package/dist/esm/structures/Utils.js

@@ -1,7 +1,7 @@
 import { URL } from "node:url";
 import { isRegExp } from "node:util/types";
-import { DebugEvents } from "./Constants";
-import { DefaultSources, LavalinkPlugins, SourceLinksRegexes } from "./LavalinkManagerStatics";
+import { DebugEvents } from "./Constants.js";
+import { DefaultSources, LavalinkPlugins, SourceLinksRegexes } from "./LavalinkManagerStatics.js";
 export const TrackSymbol = Symbol("LC-Track");
 export const UnresolvedTrackSymbol = Symbol("LC-Track-Unresolved");
 export const QueueSymbol = Symbol("LC-Queue");
@@ -302,6 +302,9 @@ export class ManagerUtils {
         if (SourceLinksRegexes.musicYandex.test(queryString) && !node.info?.sourceManagers?.includes("yandexmusic")) {
             throw new Error("Query / Link Provided for this Source but Lavalink Node has not 'yandexmusic' enabled");
         }
+        if (SourceLinksRegexes.jiosaavn.test(queryString) && !node.info?.sourceManagers?.includes("jiosaavn")) {
+            throw new Error("Query / Link Provided for this Source but Lavalink Node has not 'jiosaavn' (via jiosaavn-plugin) enabled");
+        }
         return;
     }
     transformQuery(query) {
@@ -357,6 +360,12 @@ export class ManagerUtils {
         if (source === "dzsearch" && node.info?.sourceManagers?.includes("deezer") && !node.info?.sourceManagers?.includes("http")) {
             throw new Error("Lavalink Node has not 'http' enabled, which is required to have 'dzsearch' to work");
         }
+        if (source === "jsrec" && !node.info?.sourceManagers?.includes("jiosaavn")) {
+            throw new Error("Lavalink Node has not 'jiosaavn' (via jiosaavn-plugin) enabled, which is required to have 'jsrec' to work");
+        }
+        if (source === "jssearch" && !node.info?.sourceManagers?.includes("jiosaavn")) {
+            throw new Error("Lavalink Node has not 'jiosaavn' (via jiosaavn-plugin) enabled, which is required to have 'jssearch' to work");
+        }
         if (source === "scsearch" && !node.info?.sourceManagers?.includes("soundcloud")) {
             throw new Error("Lavalink Node has not 'soundcloud' enabled, which is required to have 'scsearch' work");
         }

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

@@ -3,6 +3,7 @@ export declare enum DebugEvents {
     SetSponsorBlock = "SetSponsorBlock",
     DeleteSponsorBlock = "DeleteSponsorBlock",
     TrackEndReplaced = "TrackEndReplaced",
+    AutoplayExecution = "AutoplayExecution",
     AutoplayNoSongsAdded = "AutoplayNoSongsAdded",
     AutoplayThresholdSpamLimiter = "AutoplayThresholdSpamLimiter",
     TriggerQueueEmptyInterval = "TriggerQueueEmptyInterval",

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

@@ -7,7 +7,9 @@ export declare const LavalinkPlugins: {
     LavaSrc: string;
     GoogleCloudTTS: string;
     LavaSearch: string;
+    Jiosaavn_Plugin: string;
     LavalinkFilterPlugin: string;
+    JavaTimedLyricsPlugin: string;
 };
 /** Lavalink Sources regexes for url validations */
 export declare const SourceLinksRegexes: Record<SourcesRegex, RegExp>;

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

@@ -3,7 +3,7 @@ import type { DestroyReasonsType } from "./Types/Player";
 import type { Track } from "./Types/Track";
 import type { Base64, InvalidLavalinkRestRequest, LavalinkPlayer, LavaSearchQuery, LavaSearchResponse, PlayerUpdateInfo, RoutePlanner, SearchQuery, SearchResult, Session } from "./Types/Utils";
 import type { NodeManager } from "./NodeManager";
-import type { BaseNodeStats, LavalinkInfo, LavalinkNodeOptions, ModifyRequest, NodeStats, SponsorBlockSegment } from "./Types/Node";
+import type { BaseNodeStats, LavalinkInfo, LavalinkNodeOptions, LyricsResult, ModifyRequest, NodeStats, SponsorBlockSegment } from "./Types/Node";
 /**
  * Lavalink Node creator class
  */
@@ -271,6 +271,62 @@ export declare class LavalinkNode {
          */
         multipleTracks: (encodeds: Base64[], requester: unknown) => Promise<Track[]>;
     };
+    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: (track: Track, skipTrackSource?: boolean) => Promise<LyricsResult>;
+        /**
+         * 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: (guildId: string, skipTrackSource?: boolean) => Promise<LyricsResult>;
+        /**
+         * 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: (guildId: string) => Promise<any>;
+        /**
+         * 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: (guildId: string) => Promise<any>;
+    };
     /**
      * Request Lavalink statistics.
      * @returns the lavalink node stats
@@ -432,4 +488,28 @@ export declare class LavalinkNode {
     deleteSponsorBlock(player: Player): Promise<void>;
     /** private util function for handling the queue end event */
     private queueEnd;
+    /**
+     * 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
+     */
+    private LyricsLine;
+    /**
+     * 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
+     */
+    private LyricsFound;
+    /**
+     * 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
+     */
+    private LyricsNotFound;
 }

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

@@ -1,6 +1,7 @@
 import { FilterManager } from "./Filters";
 import { Queue } from "./Queue";
 import type { DestroyReasons } from "./Constants";
+import type { Track } from "./Types/Track";
 import type { LavalinkNode } from "./Node";
 import type { SponsorBlockSegment } from "./Types/Node";
 import type { PlayerJson, PlayerOptions, PlayOptions, RepeatMode } from "./Types/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").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").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