lavalink-client 2.3.5 → 2.4.0

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

@@ -1,6 +1,6 @@
 import type { MiniMap } from "../Utils.js";
 import type { LavalinkFilterData } from "./Filters.js";
-import type { NodeStats } from "./Node.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. */
@@ -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 */
@@ -178,8 +236,7 @@ export interface LavalinkPlayerVoice {
     /** The Ping to the voice server */
     ping?: number;
 }
-export interface LavalinkPlayerVoiceOptions extends Omit<LavalinkPlayerVoice, 'connected' | 'ping'> {
-}
+export type LavalinkPlayerVoiceOptions = Omit<LavalinkPlayerVoice, 'connected' | 'ping'>;
 export interface FailingAddress {
     /** The failing address */
     failingAddress: string;
@@ -295,6 +352,22 @@ export interface VoiceState {
     session_id: string;
     /** Voice Channel Id */
     channel_id: string;
+    /** Server Mute status */
+    mute: boolean;
+    /** Server Deaf status */
+    deaf: boolean;
+    /** Self Deaf status */
+    self_deaf: boolean;
+    /** Self Mute status */
+    self_mute: boolean;
+    /** Self Video (Camera) status */
+    self_video: boolean;
+    /** Self Stream status */
+    self_stream: boolean;
+    /** Wether the user requests to speak (stage channel) */
+    request_to_speak_timestamp: boolean;
+    /** Self suppressed status (stage channel) */
+    suppress: boolean;
 }
 /** The Base64 decodes tring by lavalink */
 export type Base64 = string;

package/dist/esm/structures/Utils.js

@@ -296,12 +296,12 @@ export class ManagerUtils {
         if (SourceLinksRegexes.AllDeezerRegex.test(queryString) && !node.info?.sourceManagers?.includes("deezer")) {
             throw new Error("Query / Link Provided for this Source but Lavalink Node has not 'deezer' enabled");
         }
-        if (SourceLinksRegexes.AllDeezerRegex.test(queryString) && node.info?.sourceManagers?.includes("deezer") && !node.info?.sourceManagers?.includes("http")) {
-            throw new Error("Query / Link Provided for this Source but Lavalink Node has not 'http' enabled, which is required to have 'deezer' to work");
-        }
         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) {
@@ -354,8 +354,11 @@ export class ManagerUtils {
         if (source === "dzisrc" && node.info?.sourceManagers?.includes("deezer") && !node.info?.sourceManagers?.includes("http")) {
             throw new Error("Lavalink Node has not 'http' enabled, which is required to have 'dzisrc' to work");
         }
-        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");
@@ -404,7 +407,6 @@ export class MiniMap extends Map {
         const iter = this.entries();
         return Array.from({ length: this.size }, () => {
             const [key, value] = iter.next().value;
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             return fn(value, key, this);
         });
     }

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

@@ -55,6 +55,10 @@ export declare enum DestroyReasons {
     TrackErrorMaxTracksErroredPerTime = "TrackErrorMaxTracksErroredPerTime",
     TrackStuckMaxTracksErroredPerTime = "TrackStuckMaxTracksErroredPerTime"
 }
+export declare enum DisconnectReasons {
+    Disconnected = "Disconnected",
+    DisconnectAllNodes = "DisconnectAllNodes"
+}
 export declare const validSponsorBlocks: string[];
 /**  The audio Outputs Data map declaration */
 export declare const audioOutputsData: Record<AudioOutputs, ChannelMixFilter>;

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

@@ -87,9 +87,33 @@ export declare class FilterManager {
      */
     toggleLowPass(smoothing?: number): Promise<boolean>;
     lavalinkLavaDspxPlugin: {
+        /**
+         * Enables / Disables the LowPass effect, (Optional: provide your Own Data)
+         * @param boostFactor
+         * @param cutoffFrequency
+         * @returns
+         */
         toggleLowPass: (boostFactor?: number, cutoffFrequency?: number) => Promise<boolean>;
+        /**
+         * Enables / Disables the HighPass effect, (Optional: provide your Own Data)
+         * @param boostFactor
+         * @param cutoffFrequency
+         * @returns
+         */
         toggleHighPass: (boostFactor?: number, cutoffFrequency?: number) => Promise<boolean>;
+        /**
+         * Enables / Disables the Normalization effect.
+         * @param {number} [maxAmplitude=0.75] - The maximum amplitude of the audio.
+         * @param {boolean} [adaptive=true] - Whether to use adaptive normalization or not.
+         * @returns {Promise<boolean>} - The state of the filter after execution.
+         */
         toggleNormalization: (maxAmplitude?: number, adaptive?: boolean) => Promise<boolean>;
+        /**
+         * Enables / Disables the Echo effect, IMPORTANT! Only works with the correct Lavalink Plugin installed. (Optional: provide your Own Data)
+         * @param {number} [decay=0.5] - The decay of the echo effect.
+         * @param {number} [echoLength=0.5] - The length of the echo effect.
+         * @returns {Promise<boolean>} - The state of the filter after execution.
+         */
         toggleEcho: (decay?: number, echoLength?: number) => Promise<boolean>;
     };
     lavalinkFilterPlugin: {

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from "events";
 import { NodeManager } from "./NodeManager";
 import { Player } from "./Player";
@@ -137,7 +136,7 @@ export declare class LavalinkManager extends EventEmitter {
      * ```
      * @returns
      */
-    getPlayer(guildId: string): Player;
+    getPlayer(guildId: string): Player | undefined;
     /**
      * Create a Music-Player. If a player exists, then it returns it before creating a new one
      * @param options
@@ -175,7 +174,7 @@ export declare class LavalinkManager extends EventEmitter {
      * // recommend to do it on the player tho: player.destroy("forcefully destroyed the player");
      * ```
      */
-    destroyPlayer(guildId: string, destroyReason?: string): Promise<Player>;
+    destroyPlayer(guildId: string, destroyReason?: string): Promise<void | Player>;
     /**
      * Delete's a player from the cache without destroying it on lavalink (only works when it's disconnected)
      * @param guildId
@@ -187,7 +186,7 @@ export declare class LavalinkManager extends EventEmitter {
      * // shouldn't be used except you know what you are doing.
      * ```
      */
-    deletePlayer(guildId: string): boolean;
+    deletePlayer(guildId: string): boolean | void;
     /**
      * Checks wether the the lib is useable based on if any node is connected
      *
@@ -213,7 +212,7 @@ export declare class LavalinkManager extends EventEmitter {
      * });
      * ```
      */
-    init(clientData: BotClientOptions): Promise<this>;
+    init(clientData: BotClientOptions): Promise<LavalinkManager>;
     /**
      * Sends voice data to the Lavalink server.
      * ! Without this the library won't work

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

@@ -1,9 +1,9 @@
 import type { Player } from "./Player";
-import type { DestroyReasonsType } from "./Types/Player";
+import type { DestroyReasonsType, DisconnectReasonsType } 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
  */
@@ -13,6 +13,7 @@ export declare class LavalinkNode {
     get heartBeatPing(): number;
     private heartBeatInterval?;
     private pingTimeout?;
+    isAlive: boolean;
     /** The provided Options of the Node */
     options: LavalinkNodeOptions;
     /** The amount of rest calls the node has made. */
@@ -88,7 +89,8 @@ export declare class LavalinkNode {
      * player.node.request(`/loadtracks?identifier=Never gonna give you up`, (options) => options.method = "GET", false);
      * ```
      */
-    request(endpoint: string, modify?: ModifyRequest, parseAsText?: boolean): Promise<any>;
+    request(endpoint: string, modify: ModifyRequest | undefined, parseAsText: true): Promise<string>;
+    request(endpoint: string, modify?: ModifyRequest, parseAsText?: false): Promise<any>;
     /**
      * Search something raw on the node, please note only add tracks to players of that node
      * @param query SearchQuery Object
@@ -109,7 +111,7 @@ export declare class LavalinkNode {
      * @param query LavaSearchQuery Object
      * @param requestUser Request User for creating the player(s)
      * @param throwOnEmpty Wether to throw on an empty result or not
-     * @returns LavaSearchresult
+     * @returns LavaSearchresult (SearchResult if link is provided)
      *
      * @example
      * ```ts
@@ -117,7 +119,7 @@ export declare class LavalinkNode {
      * player.node.lavaSearch({ types: ["playlist", "album"], query: "Rick Astley", source: "spotify" }, interaction.user);
      * ```
      */
-    lavaSearch(query: LavaSearchQuery, requestUser: unknown, throwOnEmpty?: boolean): Promise<SearchResult | LavaSearchResponse>;
+    lavaSearch(query: LavaSearchQuery, requestUser: unknown, throwOnEmpty?: boolean): Promise<LavaSearchResponse | SearchResult>;
     /**
      * Update the Player State on the Lavalink Server
      * @param data data to send to lavalink and sync locally
@@ -141,7 +143,7 @@ export declare class LavalinkNode {
      * player.node.destroyPlayer(player.guildId);
      * ```
      */
-    destroyPlayer(guildId: any): Promise<any>;
+    destroyPlayer(guildId: any): Promise<void>;
     /**
      * Connect to the Lavalink Node
      * @param sessionId Provide the Session Id of the previous connection, to resume the node and it's player(s)
@@ -169,7 +171,7 @@ export declare class LavalinkNode {
     get id(): string;
     /**
      * Destroys the Node-Connection (Websocket) and all player's of the node
-     * @param destroyReason Destroyreason to use when destroying the players
+     * @param destroyReason Destroy Reason to use when destroying the players
      * @param deleteNode wether to delete the nodte from the nodes list too, if false it will emit a disconnect. @default true
      * @returns void
      *
@@ -179,6 +181,19 @@ export declare class LavalinkNode {
      * ```
      */
     destroy(destroyReason?: DestroyReasonsType, deleteNode?: boolean): void;
+    /**
+     * Disconnects the Node-Connection (Websocket)
+     * @param disconnectReason Disconnect Reason to use when disconnecting Node
+     * @returns void
+     *
+     * Also the node will not get re-connected again.
+     *
+     * @example
+     * ```ts
+     * player.node.destroy("custom Player Destroy Reason", true);
+     * ```
+     */
+    disconnect(disconnectReason?: DisconnectReasonsType): void;
     /**
      * Returns if connected to the Node.
      *
@@ -189,7 +204,6 @@ export declare class LavalinkNode {
      * ```
      */
     get connected(): boolean;
-    isAlive: boolean;
     /**
      * Returns the current ConnectionStatus
      *
@@ -214,7 +228,7 @@ export declare class LavalinkNode {
      * const playersOfLavalink = await node?.fetchAllPlayers();
      * ```
      */
-    fetchAllPlayers(): Promise<LavalinkPlayer[] | InvalidLavalinkRestRequest>;
+    fetchAllPlayers(): Promise<LavalinkPlayer[] | InvalidLavalinkRestRequest | null>;
     /**
      * Gets specific Player Information
      * @returns lavalink player object if player exists on lavalink
@@ -225,7 +239,7 @@ export declare class LavalinkNode {
      * const playerInformation = await node?.fetchPlayer("guildId");
      * ```
      */
-    fetchPlayer(guildId: string): Promise<LavalinkPlayer | InvalidLavalinkRestRequest>;
+    fetchPlayer(guildId: string): Promise<LavalinkPlayer | InvalidLavalinkRestRequest | null>;
     /**
      * Updates the session with and enables/disables resuming and timeout
      * @param resuming Whether resuming is enabled for this session or not
@@ -238,7 +252,7 @@ export declare class LavalinkNode {
      * await node?.updateSession(true, 180e3); // will enable resuming for 180seconds
      * ```
      */
-    updateSession(resuming?: boolean, timeout?: number): Promise<InvalidLavalinkRestRequest | Session>;
+    updateSession(resuming?: boolean, timeout?: number): Promise<Session | InvalidLavalinkRestRequest | null>;
     /**
      * Decode Track or Tracks
      */
@@ -271,6 +285,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 | null>;
+        /**
+         * 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 | null>;
+        /**
+         * 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<unknown>;
+        /**
+         * 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<void>;
+    };
     /**
      * Request Lavalink statistics.
      * @returns the lavalink node stats
@@ -329,7 +399,7 @@ export declare class LavalinkNode {
          * await player.node.routePlannerApi.unmarkFailedAddress("ipv6address");
          * ```
          */
-        unmarkFailedAddress: (address: string) => Promise<void>;
+        unmarkFailedAddress: (address: string) => Promise<unknown>;
         /**
          * Release all blacklisted IP addresses into pool of IPs
          * @returns request data of the request
@@ -339,7 +409,7 @@ export declare class LavalinkNode {
          * await player.node.routePlannerApi.unmarkAllFailedAddresses();
          * ```
          */
-        unmarkAllFailedAddresses: () => Promise<any>;
+        unmarkAllFailedAddresses: () => Promise<unknown>;
     };
     /** @private Utils for validating the */
     private validate;
@@ -432,4 +502,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/NodeManager.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from "events";
 import { LavalinkNode } from "./Node";
 import { MiniMap } from "./Utils";
@@ -55,9 +54,10 @@ export declare class NodeManager extends EventEmitter {
     /**
      * Disconnects all Nodes from lavalink ws sockets
      * @param deleteAllNodes if the nodes should also be deleted from nodeManager.nodes
+     * @param destroyPlayers if the players should be destroyed
      * @returns amount of disconnected Nodes
      */
-    disconnectAll(deleteAllNodes?: boolean): Promise<number>;
+    disconnectAll(deleteAllNodes?: boolean, destroyPlayers?: boolean): Promise<number>;
     /**
      * Connects all not connected nodes
      * @returns Amount of connected Nodes

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";
@@ -51,6 +52,13 @@ export declare class Player {
     connected: boolean | undefined;
     /** Voice Server Data (from Lavalink) */
     voice: LavalinkPlayerVoiceOptions;
+    voiceState: {
+        selfDeaf: boolean;
+        selfMute: boolean;
+        serverDeaf: boolean;
+        serverMute: boolean;
+        suppress: boolean;
+    };
     /** Custom data for the player */
     private readonly data;
     /**
@@ -96,7 +104,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").LavaSearchResponse | import("./Types/Utils").SearchResult>;
     /**
      * Set the SponsorBlock
      * @param segments The segments to set
@@ -164,6 +172,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<unknown>;
+    /**
+     * 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<void>;
     /**
      * Move the player on a different Audio-Node
      * @param newNode New Node / New Node Id