lavalink-client 2.3.5 → 2.4.0

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

@@ -1,9 +1,9 @@
 import type { Player } from "./Player.js";
-import type { DestroyReasonsType } from "./Types/Player.js";
+import type { DestroyReasonsType, DisconnectReasonsType } from "./Types/Player.js";
 import type { Track } from "./Types/Track.js";
 import type { Base64, InvalidLavalinkRestRequest, LavalinkPlayer, LavaSearchQuery, LavaSearchResponse, PlayerUpdateInfo, RoutePlanner, SearchQuery, SearchResult, Session } from "./Types/Utils.js";
 import type { NodeManager } from "./NodeManager.js";
-import type { BaseNodeStats, LavalinkInfo, LavalinkNodeOptions, ModifyRequest, NodeStats, SponsorBlockSegment } from "./Types/Node.js";
+import type { BaseNodeStats, LavalinkInfo, LavalinkNodeOptions, LyricsResult, ModifyRequest, NodeStats, SponsorBlockSegment } from "./Types/Node.js";
 /**
  * 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;
 }