lavalink-client 2.6.7 → 2.7.1

package/README.md

@@ -108,17 +108,21 @@ pnpm add tomato6966/lavalink-client
 ## 💖 Used In
 This client powers various Discord bots:
 - **[Mivator](https://discord.gg/5dUb7M2qCj)** (Public Bot by @Tomato6966)
-- **[Betty](https://betty.cx/)** (Public Bot by fb_sean)
+- **[Betty](https://betty.bot/?utm_source=lavalink-client)** (Public Bot by @fb_sean)
+- **[Nero](https://betty.bot/?utm_source=lavalink-client)** (Public Bot by @fb_sean)
 - **Bots by Contributors:**
   - [Mintone](https://mintone.tech/) (@appujet)
   - [Stelle](https://github.com/Ganyu-Studios/stelle-music) (@EvilG-MC)
   - [Panais](https://panais.xyz/) (@LucasB25)
   - [Akyn](https://akynbot.vercel.app/) (@notdeltaxd)
   - [ARINO](https://site.arinoapp.qzz.io/) (@ryanwtf88)
+  - [iHorizon](https://github.com/ihrz/ihrz) (@iHorizon)
 - **Bots Community (Users):**
   - [Soundy](https://github.com/idMJA/Soundy) (@idMJA)
-  - [BeatBot ](https://getbeatbot.vercel.app/) (@zenitsujs)
+  - [BeatBot](https://getbeatbot.vercel.app/) (@zenitsujs)
   - [Atom Music](https://top.gg/bot/1320469557411971165) (@sakshamyep)
+  - [All Time Bot](https://top.gg/bot/1163027457671180418) (@PeterGamez)
+  - [BeatDock](https://github.com/lazaroagomez/BeatDock) (@lazaroagomez)
 
 ***
 
@@ -459,5 +463,3 @@ if (response.tracks.length > 0) {
 </details>
 
 </div>
-
-

package/dist/index.d.mts

@@ -210,6 +210,7 @@ declare enum DebugEvents {
     PlayerUpdateSuccess = "PlayerUpdateSuccess",
     HeartBeatTriggered = "HeartBeatTriggered",
     NoSocketOnDestroy = "NoSocketOnDestroy",
+    SocketCleanupError = "SocketCleanupError",
     SocketTerminateHeartBeatTimeout = "SocketTerminateHeartBeatTimeout",
     TryingConnectWhileConnected = "TryingConnectWhileConnected",
     LavaSearchNothingFound = "LavaSearchNothingFound",
@@ -704,138 +705,6 @@ declare class FilterManager {
     clearEQ(): Promise<this>;
 }
 
-/** Sourcenames provided by lavalink server */
-type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
-/** Source Names provided by lava src plugin */
-type LavalinkPlugin_LavaSrc_SourceNames = "deezer" | "spotify" | "applemusic" | "yandexmusic" | "flowery-tts" | "vkmusic" | "tidal" | "qobuz" | "pandora";
-/** Source Names provided by jiosaavan plugin */
-type LavalinkPlugin_JioSaavn_SourceNames = "jiosaavn";
-/** The SourceNames provided by lavalink */
-type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames | LavalinkPlugin_JioSaavn_SourceNames;
-interface LavalinkTrackInfo {
-    /** The Identifier of the Track */
-    identifier: string;
-    /** The Track Title / Name */
-    title: string;
-    /** The Name of the Author */
-    author: string;
-    /** The duration of the Track */
-    length: number;
-    /** The URL of the artwork if available */
-    artworkUrl: string | null;
-    /** The URL (aka Link) of the Track called URI */
-    uri: string;
-    /** The Source name of the Track, e.g. soundcloud, youtube, spotify */
-    sourceName: SourceNames;
-    /** Wether the audio is seekable */
-    isSeekable: boolean;
-    /** Wether the audio is of a live stream */
-    isStream: boolean;
-    /** If isrc code is available, it's provided */
-    isrc: string | null;
-}
-interface TrackInfo {
-    /** The Identifier of the Track */
-    identifier: string;
-    /** The Track Title / Name */
-    title: string;
-    /** The Name of the Author */
-    author: string;
-    /** The duration of the Track */
-    duration: number;
-    /** The URL of the artwork if available */
-    artworkUrl: string | null;
-    /** The URL (aka Link) of the Track called URI */
-    uri: string;
-    /** The Source name of the Track, e.g. soundcloud, youtube, spotify */
-    sourceName: SourceNames;
-    /** Wether the audio is seekable */
-    isSeekable: boolean;
-    /** Wether the audio is of a live stream */
-    isStream: boolean;
-    /** If isrc code is available, it's provided */
-    isrc: string | null;
-}
-interface PluginInfo {
-    /** The Type provided by a plugin */
-    type?: "album" | "playlist" | "artist" | "recommendations" | string;
-    /** The Identifier provided by a plugin */
-    albumName?: string;
-    /** The url of the album */
-    albumUrl?: string;
-    /** The url of the album art */
-    albumArtUrl?: string;
-    /** The url of the artist */
-    artistUrl?: string;
-    /** The url of the artist artwork */
-    artistArtworkUrl?: string;
-    /** The url of the preview */
-    previewUrl?: string;
-    /** Whether the track is a preview */
-    isPreview?: boolean;
-    /** The total number of tracks in the playlist */
-    totalTracks?: number;
-    /** The Identifier provided by a plugin */
-    identifier?: string;
-    /** The ArtworkUrl provided by a plugin */
-    artworkUrl?: string;
-    /** The Author Information provided by a plugin */
-    author?: string;
-    /** The Url provided by a Plugin */
-    url?: string;
-    /** The Url provided by a Plugin */
-    uri?: string;
-    /** You can put specific track information here, to transform the tracks... */
-    clientData?: {
-        previousTrack?: boolean;
-        [key: string]: any;
-    };
-}
-interface LavalinkTrack {
-    /** The Base 64 encoded String */
-    encoded?: Base64;
-    /** Track Information */
-    info: LavalinkTrackInfo;
-    /** Plugin Information from Lavalink */
-    pluginInfo: Partial<PluginInfo>;
-    /** The userData Object from when you provide to the lavalink request */
-    userData?: anyObject;
-}
-interface Track {
-    /** The Base 64 encoded String */
-    encoded?: Base64;
-    /** Track Information */
-    info: TrackInfo;
-    /** Plugin Information from Lavalink */
-    pluginInfo: Partial<PluginInfo>;
-    /** The Track's Requester */
-    requester?: unknown;
-    /** The userData Object from when you provide to the lavalink request */
-    userData?: anyObject;
-}
-interface UnresolvedTrackInfo extends Partial<TrackInfo> {
-    /** Required */
-    title: string;
-}
-interface UnresolvedQuery extends UnresolvedTrackInfo {
-    /** The base64 of the unresolved track to "encode" */
-    encoded?: Base64;
-}
-interface UnresolvedTrack {
-    /** Required */
-    resolve: (player: Player) => Promise<void>;
-    /** The Base 64 encoded String */
-    encoded?: Base64;
-    /** Track Information */
-    info: UnresolvedTrackInfo;
-    /** Plugin Information from Lavalink */
-    pluginInfo: Partial<PluginInfo>;
-    /** The userData Object from when you provide to the lavalink request */
-    userData?: anyObject;
-    /** The Track's Requester */
-    requester?: unknown;
-}
-
 declare class QueueSaver {
     /**
      * The queue store manager
@@ -977,6 +846,7 @@ declare class Queue {
      *  - single Track | UnresolvedTrack
      *  - multiple Track | UnresovedTrack
      *  - at the index or multiple indexes
+     *  - Since v2.7 the removed tracks get unshifted into the previous queue state instead of pushed (indexed at the start instead of end - as it should)
      * @param removeQueryTrack
      * @returns null (if nothing was removed) / { removed } where removed is an array with all removed elements
      *
@@ -1249,6 +1119,138 @@ declare class Player {
     toJSON(): PlayerJson;
 }
 
+/** Sourcenames provided by lavalink server */
+type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
+/** Source Names provided by lava src plugin */
+type LavalinkPlugin_LavaSrc_SourceNames = "deezer" | "spotify" | "applemusic" | "yandexmusic" | "flowery-tts" | "vkmusic" | "tidal" | "qobuz" | "pandora";
+/** Source Names provided by jiosaavan plugin */
+type LavalinkPlugin_JioSaavn_SourceNames = "jiosaavn";
+/** The SourceNames provided by lavalink */
+type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames | LavalinkPlugin_JioSaavn_SourceNames;
+interface LavalinkTrackInfo {
+    /** The Identifier of the Track */
+    identifier: string;
+    /** The Track Title / Name */
+    title: string;
+    /** The Name of the Author */
+    author: string;
+    /** The duration of the Track */
+    length: number;
+    /** The URL of the artwork if available */
+    artworkUrl: string | null;
+    /** The URL (aka Link) of the Track called URI */
+    uri: string;
+    /** The Source name of the Track, e.g. soundcloud, youtube, spotify */
+    sourceName: SourceNames;
+    /** Wether the audio is seekable */
+    isSeekable: boolean;
+    /** Wether the audio is of a live stream */
+    isStream: boolean;
+    /** If isrc code is available, it's provided */
+    isrc: string | null;
+}
+interface TrackInfo {
+    /** The Identifier of the Track */
+    identifier: string;
+    /** The Track Title / Name */
+    title: string;
+    /** The Name of the Author */
+    author: string;
+    /** The duration of the Track */
+    duration: number;
+    /** The URL of the artwork if available */
+    artworkUrl: string | null;
+    /** The URL (aka Link) of the Track called URI */
+    uri: string;
+    /** The Source name of the Track, e.g. soundcloud, youtube, spotify */
+    sourceName: SourceNames;
+    /** Wether the audio is seekable */
+    isSeekable: boolean;
+    /** Wether the audio is of a live stream */
+    isStream: boolean;
+    /** If isrc code is available, it's provided */
+    isrc: string | null;
+}
+interface PluginInfo {
+    /** The Type provided by a plugin */
+    type?: "album" | "playlist" | "artist" | "recommendations" | string;
+    /** The Identifier provided by a plugin */
+    albumName?: string;
+    /** The url of the album */
+    albumUrl?: string;
+    /** The url of the album art */
+    albumArtUrl?: string;
+    /** The url of the artist */
+    artistUrl?: string;
+    /** The url of the artist artwork */
+    artistArtworkUrl?: string;
+    /** The url of the preview */
+    previewUrl?: string;
+    /** Whether the track is a preview */
+    isPreview?: boolean;
+    /** The total number of tracks in the playlist */
+    totalTracks?: number;
+    /** The Identifier provided by a plugin */
+    identifier?: string;
+    /** The ArtworkUrl provided by a plugin */
+    artworkUrl?: string;
+    /** The Author Information provided by a plugin */
+    author?: string;
+    /** The Url provided by a Plugin */
+    url?: string;
+    /** The Url provided by a Plugin */
+    uri?: string;
+    /** You can put specific track information here, to transform the tracks... */
+    clientData?: {
+        previousTrack?: boolean;
+        [key: string]: any;
+    };
+}
+interface LavalinkTrack {
+    /** The Base 64 encoded String */
+    encoded?: Base64;
+    /** Track Information */
+    info: LavalinkTrackInfo;
+    /** Plugin Information from Lavalink */
+    pluginInfo: Partial<PluginInfo>;
+    /** The userData Object from when you provide to the lavalink request */
+    userData?: anyObject;
+}
+interface Track {
+    /** The Base 64 encoded String */
+    encoded?: Base64;
+    /** Track Information */
+    info: TrackInfo;
+    /** Plugin Information from Lavalink */
+    pluginInfo: Partial<PluginInfo>;
+    /** The Track's Requester */
+    requester?: unknown;
+    /** The userData Object from when you provide to the lavalink request */
+    userData?: anyObject;
+}
+interface UnresolvedTrackInfo extends Partial<TrackInfo> {
+    /** Required */
+    title: string;
+}
+interface UnresolvedQuery extends UnresolvedTrackInfo {
+    /** The base64 of the unresolved track to "encode" */
+    encoded?: Base64;
+}
+interface UnresolvedTrack {
+    /** Required */
+    resolve: (player: Player) => Promise<void>;
+    /** The Base 64 encoded String */
+    encoded?: Base64;
+    /** Track Information */
+    info: UnresolvedTrackInfo;
+    /** Plugin Information from Lavalink */
+    pluginInfo: Partial<PluginInfo>;
+    /** The userData Object from when you provide to the lavalink request */
+    userData?: anyObject;
+    /** The Track's Requester */
+    requester?: unknown;
+}
+
 interface StoredQueue {
     current: Track | null;
     previous: Track[];
@@ -1266,7 +1268,7 @@ interface QueueStoreManager {
     /** @async Parse the saved value back to the Queue (IF YOU DON'T NEED PARSING/STRINGIFY, then just return the value) */
     parse: (value: StoredQueue | string) => Awaitable<Partial<StoredQueue>>;
 }
-interface ManagerQueueOptions<CustomPlayerT extends Player = Player> {
+interface ManagerQueueOptions {
     /** Maximum Amount of tracks for the queue.previous array. Set to 0 to not save previous songs. Defaults to 25 Tracks */
     maxPreviousTracks?: number;
     /** Custom Queue Store option */
@@ -1916,20 +1918,6 @@ interface LyricsFoundEvent extends PlayerEvent {
     /** The lyrics */
     lyrics: LyricsResult;
 }
-interface LyricsFoundEvent extends PlayerEvent {
-    /** The lyricsfound event */
-    type: "LyricsFoundEvent";
-    /** The guildId */
-    guildId: string;
-    /** The lyrics */
-    lyrics: LyricsResult;
-}
-interface LyricsNotFoundEvent extends PlayerEvent {
-    /**The lyricsnotfound event*/
-    type: "LyricsNotFoundEvent";
-    /**The guildId*/
-    guildId: string;
-}
 interface LyricsNotFoundEvent extends PlayerEvent {
     /**The lyricsnotfound event*/
     type: "LyricsNotFoundEvent";
@@ -1948,18 +1936,6 @@ interface LyricsLineEvent extends PlayerEvent {
     /**skipped is true if the line was skipped */
     skipped: boolean;
 }
-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;
-}
 type LoadTypes = "track" | "playlist" | "search" | "error" | "empty";
 type State = "CONNECTED" | "CONNECTING" | "DISCONNECTED" | "DISCONNECTING" | "DESTROYING";
 type PlayerEventType = "TrackStartEvent" | "TrackEndEvent" | "TrackExceptionEvent" | "TrackStuckEvent" | "WebSocketClosedEvent" | SponsorBlockSegmentEventType | LyricsEventType;
@@ -2619,6 +2595,18 @@ declare class LavalinkNode {
      * ```
      */
     private reconnect;
+    /**
+     * Private function to reset the reconnection attempts
+     * @returns
+     */
+    private resetReconnectionAttempts;
+    /**
+     * Private function to reset timeouts/intervals for heartbeating/pinging
+     * @param heartbeat
+     * @param ping
+     * @returns
+     */
+    private resetAckTimeouts;
     /** @private util function for handling opening events from websocket */
     private open;
     /** @private util function for handling closing events from websocket */
@@ -3040,7 +3028,7 @@ interface ManagerOptions<CustomPlayerT extends Player = Player> {
     /** The Bot Client's Data for Authorization */
     client?: BotClientOptions;
     /** QueueOptions for all Queues */
-    queueOptions?: ManagerQueueOptions<CustomPlayerT>;
+    queueOptions?: ManagerQueueOptions;
     /** PlayerOptions for all Players */
     playerOptions?: ManagerPlayerOptions<CustomPlayerT>;
     /** The player class you want to use when creating a player. (can be extendable) */