lavalink-client 2.7.3 → 2.7.5

package/dist/index.d.mts

@@ -24,6 +24,15 @@ declare class FilterManager {
     data: FilterData;
     /** The Player assigned to this Filter Manager */
     player: Player;
+    private get _LManager();
+    /**
+     * Returns wether the plugin validations are enabled or not
+     */
+    private get _checkForPlugins();
+    /**
+     * Returns wether the source validations are enabled or not
+     */
+    private get _checkForSources();
     /** The Constructor for the FilterManager */
     constructor(player: Player);
     /**
@@ -820,6 +829,12 @@ declare class Player {
     };
     /** Custom data for the player */
     private readonly data;
+    /**
+     * Emits a debug event to the LavalinkManager
+     * @param name name of the event
+     * @param eventData event data
+     */
+    private _emitDebugEvent;
     /**
      * Create a new Player
      * @param options
@@ -983,11 +998,15 @@ declare class Player {
      */
     changeNode(newNode: LavalinkNode | string, checkSources?: boolean): Promise<string>;
     /**
-     * Move the player to a different node. If no node is provided, it will find the least used node that is not the same as the current node.
+     * (Wrapper-FN for changeNode) Move the player to a different node. If no node is provided, it will find the least used node that is not the same as the current node.
      * @param node the id of the node to move to
      * @returns the player
      * @throws RangeError if there is no available nodes.
      * @throws Error if the node to move to is the same as the current node.
+     * @example
+     * ```ts
+     * const newNodeMovedTo = await player.moveNode(); // no need to specify the new node, it will find a least used node automatically, but you can ofc. use a custom node id.
+     * ```
      */
     moveNode(node?: string): Promise<string | this>;
     /** Converts the Player including Queue to a Json state */
@@ -1770,7 +1789,10 @@ declare enum DebugEvents {
     PlayerDeleteInsteadOfDestroy = "PlayerDeleteInsteadOfDestroy",
     FailedToConnectToNodes = "FailedToConnectToNodes",
     NoAudioDebug = "NoAudioDebug",
-    PlayerAutoReconnect = "PlayerAutoReconnect"
+    PlayerAutoReconnect = "PlayerAutoReconnect",
+    PlayerDestroyFail = "PlayerDestroyFail",
+    PlayerChangeNodeFailNoEligibleNode = "PlayerChangeNodeFailNoEligibleNode",
+    PlayerChangeNodeFail = "PlayerChangeNodeFail"
 }
 /**
  * Reasons why a player got destroyed
@@ -2185,7 +2207,6 @@ declare enum ReconnectionState {
 declare class LavalinkNode {
     private heartBeatPingTimestamp;
     private heartBeatPongTimestamp;
-    get heartBeatPing(): number;
     private heartBeatInterval?;
     private pingTimeout?;
     isAlive: boolean;
@@ -2216,6 +2237,52 @@ declare class LavalinkNode {
     private socket;
     /** Version of what the Lavalink Server should be */
     private version;
+    /**
+     * Returns the LavalinkManager of the Node
+     */
+    private get _LManager();
+    /**
+     * Returns the Heartbeat Ping of the Node
+     */
+    get heartBeatPing(): number;
+    /**
+     * Returns wether the plugin validations are enabled or not
+     */
+    private get _checkForPlugins();
+    /**
+     * Returns wether the source validations are enabled or not
+     */
+    private get _checkForSources();
+    /**
+     * Emits a debug event to the LavalinkManager
+     * @param name name of the event
+     * @param eventData event data
+     */
+    private _emitDebugEvent;
+    /**
+     * Returns if connected to the Node.
+     *
+     * @example
+     * ```ts
+     * const isConnected = player.node.connected;
+     * console.log("node is connected: ", isConnected ? "yes" : "no")
+     * ```
+     */
+    get connected(): boolean;
+    /**
+     * Returns the current ConnectionStatus
+     *
+     * @example
+     * ```ts
+     * try {
+     *     const statusOfConnection = player.node.connectionStatus;
+     *     console.log("node's connection status is:", statusOfConnection)
+     * } catch (error) {
+     *     console.error("no socket available?", error)
+     * }
+     * ```
+     */
+    get connectionStatus(): string;
     /**
      * Create a new Node
      * @param options Lavalink Node Options
@@ -2361,34 +2428,10 @@ declare class LavalinkNode {
      *
      * @example
      * ```ts
-     * player.node.destroy("custom Player Destroy Reason", true);
+     * player.node.disconnect("Forcefully disconnect the connection to the node.");
      * ```
      */
     disconnect(disconnectReason?: DisconnectReasonsType): void;
-    /**
-     * Returns if connected to the Node.
-     *
-     * @example
-     * ```ts
-     * const isConnected = player.node.connected;
-     * console.log("node is connected: ", isConnected ? "yes" : "no")
-     * ```
-     */
-    get connected(): boolean;
-    /**
-     * Returns the current ConnectionStatus
-     *
-     * @example
-     * ```ts
-     * try {
-     *     const statusOfConnection = player.node.connectionStatus;
-     *     console.log("node's connection status is:", statusOfConnection)
-     * } catch (error) {
-     *     console.error("no socket available?", error)
-     * }
-     * ```
-     */
-    get connectionStatus(): string;
     /**
      * Gets all Players of a Node
      * @returns array of players inside of lavalink
@@ -3067,6 +3110,13 @@ interface ManagerOptions<CustomPlayerT extends Player = Player> {
     linksBlacklist?: (RegExp | string)[];
     /** If links should be allowed or not. If set to false, it will throw an error if a link was provided. */
     linksAllowed?: boolean;
+    /** If the library should automatically check something, on default everything is enabled */
+    autoChecks?: {
+        /** Wether or not the client should check if the requested source's plugin is available on the node. */
+        pluginValidations?: boolean;
+        /** Wether or not the client should check if the requested source is available on the node */
+        sourcesValidations?: boolean;
+    };
     /** Advanced Options for the Library, which may or may not be "library breaking" */
     advancedOptions?: {
         /** Max duration for that the filter fix duration works (in ms) - default is 8mins */
@@ -3147,6 +3197,12 @@ declare class LavalinkManager<CustomPlayerT extends Player = Player> extends Eve
      * @param options
      */
     private validateOptions;
+    /**
+     * Emits a debug event to the LavalinkManager
+     * @param name name of the event
+     * @param eventData event data
+     */
+    private _emitDebugEvent;
     /**
      * Create the Lavalink Manager
      * @param options

package/dist/index.d.ts

@@ -24,6 +24,15 @@ declare class FilterManager {
     data: FilterData;
     /** The Player assigned to this Filter Manager */
     player: Player;
+    private get _LManager();
+    /**
+     * Returns wether the plugin validations are enabled or not
+     */
+    private get _checkForPlugins();
+    /**
+     * Returns wether the source validations are enabled or not
+     */
+    private get _checkForSources();
     /** The Constructor for the FilterManager */
     constructor(player: Player);
     /**
@@ -820,6 +829,12 @@ declare class Player {
     };
     /** Custom data for the player */
     private readonly data;
+    /**
+     * Emits a debug event to the LavalinkManager
+     * @param name name of the event
+     * @param eventData event data
+     */
+    private _emitDebugEvent;
     /**
      * Create a new Player
      * @param options
@@ -983,11 +998,15 @@ declare class Player {
      */
     changeNode(newNode: LavalinkNode | string, checkSources?: boolean): Promise<string>;
     /**
-     * Move the player to a different node. If no node is provided, it will find the least used node that is not the same as the current node.
+     * (Wrapper-FN for changeNode) Move the player to a different node. If no node is provided, it will find the least used node that is not the same as the current node.
      * @param node the id of the node to move to
      * @returns the player
      * @throws RangeError if there is no available nodes.
      * @throws Error if the node to move to is the same as the current node.
+     * @example
+     * ```ts
+     * const newNodeMovedTo = await player.moveNode(); // no need to specify the new node, it will find a least used node automatically, but you can ofc. use a custom node id.
+     * ```
      */
     moveNode(node?: string): Promise<string | this>;
     /** Converts the Player including Queue to a Json state */
@@ -1770,7 +1789,10 @@ declare enum DebugEvents {
     PlayerDeleteInsteadOfDestroy = "PlayerDeleteInsteadOfDestroy",
     FailedToConnectToNodes = "FailedToConnectToNodes",
     NoAudioDebug = "NoAudioDebug",
-    PlayerAutoReconnect = "PlayerAutoReconnect"
+    PlayerAutoReconnect = "PlayerAutoReconnect",
+    PlayerDestroyFail = "PlayerDestroyFail",
+    PlayerChangeNodeFailNoEligibleNode = "PlayerChangeNodeFailNoEligibleNode",
+    PlayerChangeNodeFail = "PlayerChangeNodeFail"
 }
 /**
  * Reasons why a player got destroyed
@@ -2185,7 +2207,6 @@ declare enum ReconnectionState {
 declare class LavalinkNode {
     private heartBeatPingTimestamp;
     private heartBeatPongTimestamp;
-    get heartBeatPing(): number;
     private heartBeatInterval?;
     private pingTimeout?;
     isAlive: boolean;
@@ -2216,6 +2237,52 @@ declare class LavalinkNode {
     private socket;
     /** Version of what the Lavalink Server should be */
     private version;
+    /**
+     * Returns the LavalinkManager of the Node
+     */
+    private get _LManager();
+    /**
+     * Returns the Heartbeat Ping of the Node
+     */
+    get heartBeatPing(): number;
+    /**
+     * Returns wether the plugin validations are enabled or not
+     */
+    private get _checkForPlugins();
+    /**
+     * Returns wether the source validations are enabled or not
+     */
+    private get _checkForSources();
+    /**
+     * Emits a debug event to the LavalinkManager
+     * @param name name of the event
+     * @param eventData event data
+     */
+    private _emitDebugEvent;
+    /**
+     * Returns if connected to the Node.
+     *
+     * @example
+     * ```ts
+     * const isConnected = player.node.connected;
+     * console.log("node is connected: ", isConnected ? "yes" : "no")
+     * ```
+     */
+    get connected(): boolean;
+    /**
+     * Returns the current ConnectionStatus
+     *
+     * @example
+     * ```ts
+     * try {
+     *     const statusOfConnection = player.node.connectionStatus;
+     *     console.log("node's connection status is:", statusOfConnection)
+     * } catch (error) {
+     *     console.error("no socket available?", error)
+     * }
+     * ```
+     */
+    get connectionStatus(): string;
     /**
      * Create a new Node
      * @param options Lavalink Node Options
@@ -2361,34 +2428,10 @@ declare class LavalinkNode {
      *
      * @example
      * ```ts
-     * player.node.destroy("custom Player Destroy Reason", true);
+     * player.node.disconnect("Forcefully disconnect the connection to the node.");
      * ```
      */
     disconnect(disconnectReason?: DisconnectReasonsType): void;
-    /**
-     * Returns if connected to the Node.
-     *
-     * @example
-     * ```ts
-     * const isConnected = player.node.connected;
-     * console.log("node is connected: ", isConnected ? "yes" : "no")
-     * ```
-     */
-    get connected(): boolean;
-    /**
-     * Returns the current ConnectionStatus
-     *
-     * @example
-     * ```ts
-     * try {
-     *     const statusOfConnection = player.node.connectionStatus;
-     *     console.log("node's connection status is:", statusOfConnection)
-     * } catch (error) {
-     *     console.error("no socket available?", error)
-     * }
-     * ```
-     */
-    get connectionStatus(): string;
     /**
      * Gets all Players of a Node
      * @returns array of players inside of lavalink
@@ -3067,6 +3110,13 @@ interface ManagerOptions<CustomPlayerT extends Player = Player> {
     linksBlacklist?: (RegExp | string)[];
     /** If links should be allowed or not. If set to false, it will throw an error if a link was provided. */
     linksAllowed?: boolean;
+    /** If the library should automatically check something, on default everything is enabled */
+    autoChecks?: {
+        /** Wether or not the client should check if the requested source's plugin is available on the node. */
+        pluginValidations?: boolean;
+        /** Wether or not the client should check if the requested source is available on the node */
+        sourcesValidations?: boolean;
+    };
     /** Advanced Options for the Library, which may or may not be "library breaking" */
     advancedOptions?: {
         /** Max duration for that the filter fix duration works (in ms) - default is 8mins */
@@ -3147,6 +3197,12 @@ declare class LavalinkManager<CustomPlayerT extends Player = Player> extends Eve
      * @param options
      */
     private validateOptions;
+    /**
+     * Emits a debug event to the LavalinkManager
+     * @param name name of the event
+     * @param eventData event data
+     */
+    private _emitDebugEvent;
     /**
      * Create the Lavalink Manager
      * @param options