lavalink-client 2.3.6 → 2.4.0

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

@@ -1,5 +1,5 @@
 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";
@@ -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
      */
@@ -285,7 +299,7 @@ export declare class LavalinkNode {
          * // const lyrics = await player.getLyrics(track, true);
          * ```
          */
-        get: (track: Track, skipTrackSource?: boolean) => Promise<LyricsResult>;
+        get: (track: Track, skipTrackSource?: boolean) => Promise<LyricsResult | null>;
         /**
          * Get the lyrics of the current playing track
          *
@@ -299,7 +313,7 @@ export declare class LavalinkNode {
          * // const lyrics = await player.getCurrentLyrics();
          * ```
          */
-        getCurrent: (guildId: string, skipTrackSource?: boolean) => Promise<LyricsResult>;
+        getCurrent: (guildId: string, skipTrackSource?: boolean) => Promise<LyricsResult | null>;
         /**
          * subscribe to lyrics updates for a guild
          * @param guildId the guild id of the player
@@ -312,7 +326,7 @@ export declare class LavalinkNode {
          * // const lyrics = await player.subscribeLyrics();
          * ```
          */
-        subscribe: (guildId: string) => Promise<any>;
+        subscribe: (guildId: string) => Promise<unknown>;
         /**
          * unsubscribe from lyrics updates for a guild
          * @param guildId the guild id of the player
@@ -325,7 +339,7 @@ export declare class LavalinkNode {
          * // const lyrics = await player.unsubscribeLyrics();
          * ```
          */
-        unsubscribe: (guildId: string) => Promise<any>;
+        unsubscribe: (guildId: string) => Promise<void>;
     };
     /**
      * Request Lavalink statistics.
@@ -385,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
@@ -395,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;

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

@@ -52,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;
     /**
@@ -97,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
@@ -196,7 +203,7 @@ export declare class Player {
      * const lyrics = await player.subscribeLyrics();
      * ```
      */
-    subscribeLyrics(): Promise<any>;
+    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
@@ -206,7 +213,7 @@ export declare class Player {
      * const lyrics = await player.unsubscribeLyrics();
      * ```
      */
-    unsubscribeLyrics(guildId: string): Promise<any>;
+    unsubscribeLyrics(guildId: string): Promise<void>;
     /**
      * Move the player on a different Audio-Node
      * @param newNode New Node / New Node Id

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

@@ -1,4 +1,3 @@
-import { MiniMap } from "./Utils";
 import type { Track, UnresolvedTrack } from "./Types/Track";
 import type { ManagerQueueOptions, QueueStoreManager, StoredQueue } from "./Types/Queue";
 export declare class QueueSaver {
@@ -24,14 +23,14 @@ export declare class QueueSaver {
      * @param guildId The guild ID
      * @returns The queue for the guild
      */
-    delete(guildId: string): Promise<unknown>;
+    delete(guildId: string): Promise<boolean | void>;
     /**
      * Set the queue for a guild
      * @param guildId The guild ID
      * @param valueToStringify The queue to set
      * @returns The queue for the guild
      */
-    set(guildId: string, valueToStringify: StoredQueue): Promise<unknown>;
+    set(guildId: string, valueToStringify: StoredQueue): Promise<boolean | void>;
     /**
      * Sync the queue for a guild
      * @param guildId The guild ID
@@ -47,32 +46,32 @@ export declare class DefaultQueueStore implements QueueStoreManager {
      * @param guildId The guild ID
      * @returns The queue for the guild
      */
-    get(guildId: any): Promise<unknown>;
+    get(guildId: string): Promise<StoredQueue>;
     /**
      * Set the queue for a guild
      * @param guildId The guild ID
      * @param valueToStringify The queue to set
      * @returns The queue for the guild
      */
-    set(guildId: any, valueToStringify: any): Promise<MiniMap<unknown, unknown>>;
+    set(guildId: string, valueToStringify: any): Promise<boolean>;
     /**
      * Delete the queue for a guild
      * @param guildId The guild ID
      * @returns The queue for the guild
      */
-    delete(guildId: any): Promise<boolean>;
+    delete(guildId: string): Promise<boolean>;
     /**
      * Stringify the queue for a guild
      * @param value The queue to stringify
      * @returns The stringified queue
      */
-    stringify(value: any): Promise<any>;
+    stringify(value: StoredQueue): Promise<StoredQueue>;
     /**
      * Parse the queue for a guild
      * @param value The queue to parse
      * @returns The parsed queue
      */
-    parse(value: any): Promise<Partial<StoredQueue>>;
+    parse(value: StoredQueue): Promise<StoredQueue>;
 }
 export declare class Queue {
     readonly tracks: (Track | UnresolvedTrack)[];
@@ -100,13 +99,13 @@ export declare class Queue {
         /**
          * Save the current cached Queue on the database/server (overides the server)
          */
-        save: () => Promise<unknown>;
+        save: () => Promise<boolean | void>;
         /**
          * Sync the current queue database/server with the cached one
          * @returns {void}
          */
         sync: (override?: boolean, dontSyncCurrent?: boolean) => Promise<void>;
-        destroy: () => Promise<unknown>;
+        destroy: () => Promise<boolean | void>;
         /**
          * @returns {{current:Track|null, previous:Track[], tracks:Track[]}}The Queue, but in a raw State, which allows easier handling for the QueueStoreManager
          */

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

@@ -73,6 +73,46 @@ export interface LavalinkManagerEvents {
      * @event Manager#playerUpdate
      */
     "playerUpdate": (oldPlayerJson: PlayerJson, newPlayer: Player) => void;
+    /**
+     * Emitted when the player's selfMuted or serverMuted state changed (true -> false | false -> true)
+     * @event Manager#playerMuteChange
+     */
+    "playerMuteChange": (player: Player, selfMuted: boolean, serverMuted: boolean) => void;
+    /**
+     * Emitted when the player's selfDeafed or serverDeafed state changed (true -> false | false -> true)
+     * @event Manager#playerDeafChange
+     */
+    "playerDeafChange": (player: Player, selfDeafed: boolean, serverDeafed: boolean) => void;
+    /**
+     * Emitted when the player's suppressed (true -> false | false -> true)
+     * @event Manager#playerSuppressChange
+     */
+    "playerSuppressChange": (player: Player, suppress: boolean) => void;
+    /**
+     * Emitted when the player's queue got empty, and the timeout started
+     * @event Manager#playerQueueEmptyStart
+     */
+    "playerQueueEmptyStart": (player: Player, timeoutMs: number) => void;
+    /**
+     * Emitted when the player's queue got empty, and the timeout finished leading to destroying the player
+     * @event Manager#playerQueueEmptyEnd
+     */
+    "playerQueueEmptyEnd": (player: Player) => void;
+    /**
+     * Emitted when the player's queue got empty, and the timeout got cancelled becuase a track got re-added to it.
+     * @event Manager#playerQueueEmptyEnd
+     */
+    "playerQueueEmptyCancel": (player: Player) => void;
+    /**
+     * Emitted, when a user joins the voice channel, while there is a player existing
+     * @event Manager#playerQueueEmptyStart
+     */
+    "playerVoiceJoin": (player: Player, userId: string) => void;
+    /**
+     * Emitted, when a user leaves the voice channel, while there is a player existing
+     * @event Manager#playerQueueEmptyEnd
+     */
+    "playerVoiceLeave": (player: Player, userId: string) => void;
     /**
      * SPONSORBLOCK-PLUGIN EVENT
      * Emitted when Segments are loaded

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type internal from "stream";
 import type { LavalinkNode } from "../Node";
 import type { DestroyReasonsType } from "./Player";

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

@@ -1,9 +1,11 @@
-import type { DestroyReasons } from "../Constants";
+import type { DestroyReasons, DisconnectReasons } from "../Constants";
 import type { LavalinkNode } from "../Node";
 import type { EQBand, FilterData, LavalinkFilterData } from "./Filters";
+import type { StoredQueue } from "./Queue";
 import type { Track, UnresolvedTrack } from "./Track";
 import type { Base64, LavalinkPlayerVoiceOptions } from "./Utils";
 export type DestroyReasonsType = keyof typeof DestroyReasons | string;
+export type DisconnectReasonsType = keyof typeof DisconnectReasons | string;
 export interface PlayerJson {
     /** Guild Id where the player was playing in */
     guildId: string;
@@ -46,6 +48,8 @@ export interface PlayerJson {
     nodeId?: string;
     /** The SessionId of the node */
     nodeSessionId?: string;
+    /** The stored queue */
+    queue?: StoredQueue;
 }
 export type RepeatMode = "queue" | "track" | "off";
 export interface PlayerOptions {

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

@@ -4,17 +4,17 @@ export interface StoredQueue {
     previous: Track[];
     tracks: (Track | UnresolvedTrack)[];
 }
-export interface QueueStoreManager extends Record<string, any> {
+export interface QueueStoreManager {
     /** @async get a Value (MUST RETURN UNPARSED!) */
-    get: (guildId: unknown) => Promise<unknown>;
+    get: (guildId: string) => Promise<StoredQueue | string>;
     /** @async Set a value inside a guildId (MUST BE UNPARSED) */
-    set: (guildId: unknown, value: unknown) => Promise<unknown>;
+    set: (guildId: string, value: StoredQueue | string) => Promise<void | boolean>;
     /** @async Delete a Database Value based of it's guildId */
-    delete: (guildId: unknown) => Promise<unknown>;
+    delete: (guildId: string) => Promise<void | boolean>;
     /** @async Transform the value(s) inside of the QueueStoreManager (IF YOU DON'T NEED PARSING/STRINGIFY, then just return the value) */
-    stringify: (value: unknown) => Promise<unknown>;
+    stringify: (value: StoredQueue | string) => Promise<StoredQueue | string>;
     /** @async Parse the saved value back to the Queue (IF YOU DON'T NEED PARSING/STRINGIFY, then just return the value) */
-    parse: (value: unknown) => Promise<Partial<StoredQueue>>;
+    parse: (value: StoredQueue | string) => Promise<Partial<StoredQueue>>;
 }
 export interface ManagerQueueOptions {
     /** Maximum Amount of tracks for the queue.previous array. Set to 0 to not save previous songs. Defaults to 25 Tracks */

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

@@ -5,8 +5,10 @@ import type { Base64 } from "./Utils";
 export type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
 /** Source Names provided by lava src plugin */
 export type LavalinkPlugin_LavaSrc_SourceNames = "deezer" | "spotify" | "applemusic" | "yandexmusic" | "flowery-tts";
+/** Source Names provided by jiosaavan plugin */
+export type LavalinkPlugin_JioSaavn_SourceNames = "jiosaavn";
 /** The SourceNames provided by lavalink */
-export type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames;
+export type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames | LavalinkPlugin_JioSaavn_SourceNames;
 export interface LavalinkTrackInfo {
     /** The Identifier of the Track */
     identifier: string;

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

@@ -236,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;
@@ -353,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/package.json

@@ -1,20 +1,31 @@
 {
   "name": "lavalink-client",
-  "version": "2.3.6",
+  "version": "2.4.0",
   "description": "Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Proficients.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.js",
   "scripts": {
-    "build": "npm run build:cjs && npm run build:esm && npm run build:types",
-    "build:cjs": "node tools/cleanup cjs && tsc -p config/tsconfig.cjs.json && tsc-alias -p config/tsconfig.cjs.json && node tools/fixup cjs",
-    "build:esm": "node tools/cleanup esm && tsc -p config/tsconfig.esm.json && tsc-alias -p config/tsconfig.esm.json && node tools/fixup esm",
-    "build:types": "node tools/cleanup types && tsc -p config/tsconfig.types.json && tsc-alias -p config/tsconfig.types.json",
-    "clean": "node tools/cleanup",
+    "build": "npm run tool:clean && npm run build:all && npm run tool:fixbuild",
+
+    "build:bun": "bun run tool:clean && bun run build:all:bun && bun run tool:fixbuild",
+    "build:all:bun": "bun run build:cjs && bun run build:esm && bun run build:types",
+
+    "build:all": "npm run build:cjs && npm run build:esm && npm run build:types",
+    "build:cjs": "tsc -p tools/config/tsconfig.cjs.json && tsc-alias -p tools/config/tsconfig.cjs.json",
+    "build:esm": "tsc -p tools/config/tsconfig.esm.json && tsc-alias -p tools/config/tsconfig.esm.json",
+    "build:types": "tsc -p tools/config/tsconfig.types.json && tsc-alias -p tools/config/tsconfig.types.json",
+
+    "tool:clean": "node tools/cleanup.js",
+    "tool:fixbuild": "node tools/fixup.js",
+
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
+
     "test": "node -v",
-    "docs": "npx typedoc"
+
+    "prepublishOnly": "npm run build",
+    "prepare": "npm run build"
   },
   "exports": {
     "require": "./dist/cjs/index.js",
@@ -51,21 +62,21 @@
   "bugs": {
     "url": "https://github.com/tomato6966/lavalink-client/issues"
   },
-  "homepage": "https://lc4.gitbook.io/lavalink-client/",
+  "homepage": "https://tomato6966.github.io/lavalink-client/",
   "devDependencies": {
-    "@types/node": "^20.4.8",
-    "@types/ws": "^8.5.5",
-    "@typescript-eslint/eslint-plugin": "^6.4.0",
-    "@typescript-eslint/parser": "^6.4.0",
-    "eslint": "^8.47.0",
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.11.0",
+    "@types/node": "^22.5.5",
+    "@types/ws": "^8.5.12",
+    "@typescript-eslint/eslint-plugin": "^8.6.0",
+    "@typescript-eslint/parser": "^8.6.0",
+    "eslint": "^9.11.0",
     "tsc-alias": "^1.8.10",
-    "typedoc": "^0.25.4",
-    "typedoc-theme-hierarchy": "^4.1.2",
-    "typescript": "^5.1.6"
+    "typescript": "^5.6.2"
   },
   "dependencies": {
-    "tslib": "^2.6.1",
-    "ws": "^8.13.0"
+    "tslib": "^2.7.0",
+    "ws": "^8.18.0"
   },
   "engines": {
     "node": ">=18.0.0",