lavalink-client 2.2.1 → 2.3.0

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

@@ -1,182 +1,47 @@
 /// <reference types="node" />
 import { EventEmitter } from "events";
-import { LavalinkNodeOptions } from "./Node";
 import { NodeManager } from "./NodeManager";
-import { DestroyReasonsType, Player, PlayerJson, PlayerOptions } from "./Player";
-import { ManagerQueueOptions } from "./Queue";
-import { Track, UnresolvedTrack } from "./Track";
-import { ChannelDeletePacket, GuildShardPayload, ManagerUtils, MiniMap, SearchPlatform, SponsorBlockChaptersLoaded, SponsorBlockChapterStarted, SponsorBlockSegmentSkipped, SponsorBlockSegmentsLoaded, TrackEndEvent, TrackExceptionEvent, TrackStartEvent, TrackStuckEvent, VoicePacket, VoiceServer, VoiceState, WebSocketClosedEvent } from "./Utils";
-/** How the botclient is allowed to be structured */
-export interface BotClientOptions {
-    /** Bot Client Id */
-    id: string;
-    /** Bot Client Username */
-    username?: string;
-    /** So users can pass entire objects / classes */
-    [x: string | number | symbol]: unknown;
-}
-/** Sub Manager Options, for player specific things */
-export interface ManagerPlayerOptions {
-    /** If the Lavalink Volume should be decremented by x number */
-    volumeDecrementer?: number;
-    /** How often it should update the the player Position */
-    clientBasedPositionUpdateInterval?: number;
-    /** What should be used as a searchPlatform, if no source was provided during the query */
-    defaultSearchPlatform?: SearchPlatform;
-    /** Applies the volume via a filter, not via the lavalink volume transformer */
-    applyVolumeAsFilter?: boolean;
-    /** Transforms the saved data of a requested user */
-    requesterTransformer?: (requester: unknown) => unknown;
-    /** What lavalink-client should do when the player reconnects */
-    onDisconnect?: {
-        /** Try to reconnect? -> If fails -> Destroy */
-        autoReconnect?: boolean;
-        /** Instantly destroy player (overrides autoReconnect) | Don't provide == disable feature*/
-        destroyPlayer?: boolean;
-    };
-    onEmptyQueue?: {
-        /** Get's executed onEmptyQueue -> You can do any track queue previous transformations, if you add a track to the queue -> it will play it, if not queueEnd will execute! */
-        autoPlayFunction?: (player: Player, lastPlayedTrack: Track) => Promise<void>;
-        destroyAfterMs?: number;
-    };
-    useUnresolvedData?: boolean;
-}
-/** Manager Options used to create the manager */
-export interface ManagerOptions {
-    /** The Node Options, for all Nodes! (on init) */
-    nodes: LavalinkNodeOptions[];
-    /** @async The Function to send the voice connection changes from Lavalink to Discord */
-    sendToShard: (guildId: string, payload: GuildShardPayload) => void;
-    /** The Bot Client's Data for Authorization */
-    client?: BotClientOptions;
-    /** QueueOptions for all Queues */
-    queueOptions?: ManagerQueueOptions;
-    /** PlayerOptions for all Players */
-    playerOptions?: ManagerPlayerOptions;
-    /** If it should skip to the next Track on TrackEnd / TrackError etc. events */
-    autoSkip?: boolean;
-    /** If it should skip to the next Track if track.resolve errors while trying to play a track. */
-    autoSkipOnResolveError?: boolean;
-    /** If it should emit only new (unique) songs and not when a looping track (or similar) is plaid, default false */
-    emitNewSongsOnly?: boolean;
-    /** Only allow link requests with links either matching some of that regExp or including some of that string */
-    linksWhitelist?: (RegExp | string)[];
-    /** Never allow link requests with links either matching some of that regExp or including some of that string (doesn't even allow if it's whitelisted) */
-    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;
-    /** 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 */
-        maxFilterFixDuration?: number;
-        /** optional */
-        debugOptions?: {
-            /** For logging custom searches */
-            logCustomSearches?: boolean;
-            /** logs for debugging the "no-Audio" playing error */
-            noAudio?: boolean;
-            /** For Logging the Destroy function */
-            playerDestroy?: {
-                /** To show the debug reason at all times. */
-                debugLog?: boolean;
-                /** If you get 'Error: Use Player#destroy("reason") not LavalinkManager#deletePlayer() to stop the Player' put it on true */
-                dontThrowError?: boolean;
-            };
-        };
-    };
-}
-export interface LavalinkManagerEvents {
-    /**
-     * Emitted when a Track started playing.
-     * @event Manager#trackStart
-     */
-    "trackStart": (player: Player, track: Track, payload: TrackStartEvent) => void;
-    /**
-     * Emitted when a Track finished.
-     * @event Manager#trackEnd
-     */
-    "trackEnd": (player: Player, track: Track, payload: TrackEndEvent) => void;
-    /**
-     * Emitted when a Track got stuck while playing.
-     * @event Manager#trackStuck
-     */
-    "trackStuck": (player: Player, track: Track | null, payload: TrackStuckEvent) => void;
-    /**
-     * Emitted when a Track errored.
-     * @event Manager#trackError
-     */
-    "trackError": (player: Player, track: Track | UnresolvedTrack | null, payload: TrackExceptionEvent) => void;
-    /**
-     * Emitted when the Playing finished and no more tracks in the queue.
-     * @event Manager#queueEnd
-     */
-    "queueEnd": (player: Player, track: Track, payload: TrackEndEvent | TrackStuckEvent | TrackExceptionEvent) => void;
-    /**
-     * Emitted when a Player is created.
-     * @event Manager#playerCreate
-     */
-    "playerCreate": (player: Player) => void;
-    /**
-     * Emitted when a Player is moved within the channel.
-     * @event Manager#playerMove
-     */
-    "playerMove": (player: Player, oldVoiceChannelId: string, newVoiceChannelId: string) => void;
-    /**
-     * Emitted when a Player is disconnected from a channel.
-     * @event Manager#playerDisconnect
-     */
-    "playerDisconnect": (player: Player, voiceChannelId: string) => void;
-    /**
-     * Emitted when a Node-Socket got closed for a specific Player.
-     * @event Manager#playerSocketClosed
-     */
-    "playerSocketClosed": (player: Player, payload: WebSocketClosedEvent) => void;
-    /**
-     * Emitted when a Player get's destroyed
-     * @event Manager#playerDestroy
-     */
-    "playerDestroy": (player: Player, destroyReason?: DestroyReasonsType) => void;
+import { Player } from "./Player";
+import { ManagerUtils, MiniMap } from "./Utils";
+import type { BotClientOptions, LavalinkManagerEvents, ManagerOptions } from "./Types/Manager";
+import type { PlayerOptions } from "./Types/Player";
+import type { ChannelDeletePacket, VoicePacket, VoiceServer, VoiceState } from "./Types/Utils";
+export declare class LavalinkManager extends EventEmitter {
     /**
-     * Always emits when the player (on lavalink side) got updated
-     * @event Manager#playerUpdate
+     * Emit an event
+     * @param event The event to emit
+     * @param args The arguments to pass to the event
+     * @returns
      */
-    "playerUpdate": (oldPlayerJson: PlayerJson, newPlayer: Player) => void;
+    emit<Event extends keyof LavalinkManagerEvents>(event: Event, ...args: Parameters<LavalinkManagerEvents[Event]>): boolean;
     /**
-     * SPONSORBLOCK-PLUGIN EVENT
-     * Emitted when Segments are loaded
-     * @link https://github.com/topi314/Sponsorblock-Plugin#segmentsloaded
-     * @event Manager#trackError
+     * Add an event listener
+     * @param event The event to listen to
+     * @param listener The listener to add
+     * @returns
      */
-    "SegmentsLoaded": (player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockSegmentsLoaded) => void;
+    on<Event extends keyof LavalinkManagerEvents>(event: Event, listener: LavalinkManagerEvents[Event]): this;
     /**
-     * SPONSORBLOCK-PLUGIN EVENT
-     * Emitted when a specific Segment was skipped
-     * @link https://github.com/topi314/Sponsorblock-Plugin#segmentskipped
-     * @event Manager#trackError
+     * Add an event listener that only fires once
+     * @param event The event to listen to
+     * @param listener The listener to add
+     * @returns
      */
-    "SegmentSkipped": (player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockSegmentSkipped) => void;
+    once<Event extends keyof LavalinkManagerEvents>(event: Event, listener: LavalinkManagerEvents[Event]): this;
     /**
-     * SPONSORBLOCK-PLUGIN EVENT
-     * Emitted when a specific Chapter starts playing
-     * @link https://github.com/topi314/Sponsorblock-Plugin#chapterstarted
-     * @event Manager#trackError
+     * Remove an event listener
+     * @param event The event to remove the listener from
+     * @param listener The listener to remove
+     * @returns
      */
-    "ChapterStarted": (player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockChapterStarted) => void;
+    off<Event extends keyof LavalinkManagerEvents>(event: Event, listener: LavalinkManagerEvents[Event]): this;
     /**
-     * SPONSORBLOCK-PLUGIN EVENT
-     * Emitted when Chapters are loaded
-     * @link https://github.com/topi314/Sponsorblock-Plugin#chaptersloaded
-     * @event Manager#trackError
+     * Remove an event listener
+     * @param event The event to remove the listener from
+     * @param listener The listener to remove
+     * @returns
      */
-    "ChaptersLoaded": (player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockChaptersLoaded) => void;
-}
-export interface LavalinkManager {
-    /** @private */
-    on<U extends keyof LavalinkManagerEvents>(event: U, listener: LavalinkManagerEvents[U]): this;
-    /** @private */
-    emit<U extends keyof LavalinkManagerEvents>(event: U, ...args: Parameters<LavalinkManagerEvents[U]>): boolean;
-}
-export declare class LavalinkManager extends EventEmitter {
+    removeListener<Event extends keyof LavalinkManagerEvents>(event: Event, listener: LavalinkManagerEvents[Event]): this;
     /** The Options of LavalinkManager (changeable) */
     options: ManagerOptions;
     /** LavalinkManager's NodeManager to manage all Nodes */

package/dist/cjs/structures/LavalinkManager.js

@@ -2,11 +2,57 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LavalinkManager = void 0;
 const events_1 = require("events");
+const Constants_1 = require("./Constants");
 const NodeManager_1 = require("./NodeManager");
 const Player_1 = require("./Player");
 const Queue_1 = require("./Queue");
 const Utils_1 = require("./Utils");
 class LavalinkManager extends events_1.EventEmitter {
+    /**
+     * Emit an event
+     * @param event The event to emit
+     * @param args The arguments to pass to the event
+     * @returns
+     */
+    emit(event, ...args) {
+        return super.emit(event, ...args);
+    }
+    /**
+     * Add an event listener
+     * @param event The event to listen to
+     * @param listener The listener to add
+     * @returns
+     */
+    on(event, listener) {
+        return super.on(event, listener);
+    }
+    /**
+     * Add an event listener that only fires once
+     * @param event The event to listen to
+     * @param listener The listener to add
+     * @returns
+     */
+    once(event, listener) {
+        return super.once(event, listener);
+    }
+    /**
+     * Remove an event listener
+     * @param event The event to remove the listener from
+     * @param listener The listener to remove
+     * @returns
+     */
+    off(event, listener) {
+        return super.off(event, listener);
+    }
+    /**
+     * Remove an event listener
+     * @param event The event to remove the listener from
+     * @param listener The listener to remove
+     * @returns
+     */
+    removeListener(event, listener) {
+        return super.removeListener(event, listener);
+    }
     /** The Options of LavalinkManager (changeable) */
     options;
     /** LavalinkManager's NodeManager to manage all Nodes */
@@ -257,7 +303,7 @@ class LavalinkManager extends events_1.EventEmitter {
         const oldPlayer = this.getPlayer(guildId);
         if (!oldPlayer)
             return;
-        // oldPlayer.connected is operational. you could also do oldPlayer.voice?.token 
+        // oldPlayer.connected is operational. you could also do oldPlayer.voice?.token
         if (oldPlayer.voiceChannelId === "string" && oldPlayer.connected && !oldPlayer.get("internal_destroywithoutdisconnect")) {
             if (!this.options?.advancedOptions?.debugOptions?.playerDestroy?.dontThrowError)
                 throw new Error(`Use Player#destroy() not LavalinkManager#deletePlayer() to stop the Player ${JSON.stringify(oldPlayer.toJSON?.())}`);
@@ -352,7 +398,7 @@ class LavalinkManager extends events_1.EventEmitter {
                 return;
             const player = this.getPlayer(update.guild_id);
             if (player && player.voiceChannelId === update.id)
-                return void player.destroy(Player_1.DestroyReasons.ChannelDeleted);
+                return void player.destroy(Constants_1.DestroyReasons.ChannelDeleted);
         }
         // for voice updates
         if (["VOICE_STATE_UPDATE", "VOICE_SERVER_UPDATE"].includes(data.t)) {
@@ -409,19 +455,25 @@ class LavalinkManager extends events_1.EventEmitter {
             }
             else {
                 if (this.options?.playerOptions?.onDisconnect?.destroyPlayer === true) {
-                    return void await player.destroy(Player_1.DestroyReasons.Disconnected);
+                    return void await player.destroy(Constants_1.DestroyReasons.Disconnected);
                 }
                 this.emit("playerDisconnect", player, player.voiceChannelId);
-                if (!player.paused)
-                    await player.pause();
                 if (this.options?.playerOptions?.onDisconnect?.autoReconnect === true) {
                     try {
+                        const positionPrevios = player.position;
+                        console.debug("Auto reconnect", positionPrevios, player.lastPosition);
                         await player.connect();
+                        // replay the current playing stream
+                        await player.play({
+                            position: positionPrevios,
+                            paused: player.paused,
+                            clientTrack: player.queue.current,
+                        });
                     }
-                    catch {
-                        return void await player.destroy(Player_1.DestroyReasons.PlayerReconnectFail);
+                    catch (e) {
+                        console.error(e);
+                        return void await player.destroy(Constants_1.DestroyReasons.PlayerReconnectFail);
                     }
-                    return void player.paused && await player.resume();
                 }
                 player.voiceChannelId = null;
                 player.voice = Object.assign({});

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

@@ -1,4 +1,4 @@
-import { ClientCustomSearchPlatformUtils, LavalinkSearchPlatform, SearchPlatform, SourcesRegex } from "./Utils";
+import type { ClientCustomSearchPlatformUtils, LavalinkSearchPlatform, SearchPlatform, SourcesRegex } from "./Types/Utils";
 /** Default Sources Record, to allow source parsing with multiple inputs. */
 export declare const DefaultSources: Record<SearchPlatform, LavalinkSearchPlatform | ClientCustomSearchPlatformUtils>;
 /** Lavalink Plugins definiton */

package/dist/cjs/structures/LavalinkManagerStatics.js

@@ -26,7 +26,7 @@ exports.DefaultSources = {
     "am": "amsearch",
     "musicapple": "amsearch",
     "music apple": "amsearch",
-    // spotify 
+    // spotify
     "spotify": "spsearch",
     "spsearch": "spsearch",
     "sp": "spsearch",

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

@@ -1,162 +1,18 @@
-/// <reference types="node" />
-import internal from "stream";
-import { NodeManager } from "./NodeManager";
-import { DestroyReasonsType, Player } from "./Player";
-import { Track } from "./Track";
-import { Base64, InvalidLavalinkRestRequest, LavalinkPlayer, LavaSearchQuery, LavaSearchResponse, PlayerUpdateInfo, RoutePlanner, SearchQuery, SearchResult, Session } from "./Utils";
-/** Ability to manipulate fetch requests */
-export type ModifyRequest = (options: RequestInit & {
-    path: string;
-    extraQueryUrlParams?: URLSearchParams;
-}) => void;
-export declare const validSponsorBlocks: string[];
-export type SponsorBlockSegment = "sponsor" | "selfpromo" | "interaction" | "intro" | "outro" | "preview" | "music_offtopic" | "filler";
-/**
- * Node Options for creating a lavalink node
- */
-export interface LavalinkNodeOptions {
-    /** The Lavalink Server-Ip / Domain-URL */
-    host: string;
-    /** The Lavalink Connection Port */
-    port: number;
-    /** The Lavalink Password / Authorization-Key */
-    authorization: string;
-    /** Does the Server use ssl (https) */
-    secure?: boolean;
-    /** RESUME THE PLAYER? by providing a sessionid on the node-creation */
-    sessionId?: string;
-    /** Add a Custom ID to the node, for later use */
-    id?: string;
-    /** Voice Regions of this Node */
-    regions?: string[];
-    /** The retryAmount for the node. */
-    retryAmount?: number;
-    /** The retryDelay for the node. */
-    retryDelay?: number;
-    /** signal for cancelling requests - default: AbortSignal.timeout(options.requestSignalTimeoutMS || 10000) - put <= 0 to disable */
-    requestSignalTimeoutMS?: number;
-}
-/**
- * Memory Stats object from lavalink
- */
-export interface MemoryStats {
-    /** The free memory of the allocated amount. */
-    free: number;
-    /** The used memory of the allocated amount. */
-    used: number;
-    /** The total allocated memory. */
-    allocated: number;
-    /** The reservable memory. */
-    reservable: number;
-}
-/**
- * CPU Stats object from lavalink
- */
-export interface CPUStats {
-    /** The core amount the host machine has. */
-    cores: number;
-    /** The system load. */
-    systemLoad: number;
-    /** The lavalink load. */
-    lavalinkLoad: number;
-}
-/**
- * FrameStats Object from lavalink
- */
-export interface FrameStats {
-    /** The amount of sent frames. */
-    sent?: number;
-    /** The amount of nulled frames. */
-    nulled?: number;
-    /** The amount of deficit frames. */
-    deficit?: number;
-}
-/**
- * BaseNodeStats object from Lavalink
- */
-export interface BaseNodeStats {
-    /** The amount of players on the node. */
-    players: number;
-    /** The amount of playing players on the node. */
-    playingPlayers: number;
-    /** The uptime for the node. */
-    uptime: number;
-    /** The memory stats for the node. */
-    memory: MemoryStats;
-    /** The cpu stats for the node. */
-    cpu: CPUStats;
-    /** The frame stats for the node. */
-    frameStats: FrameStats;
-}
-/**
- * Interface for nodeStats from lavalink
- */
-export interface NodeStats extends BaseNodeStats {
-    /** The frame stats for the node. */
-    frameStats: FrameStats;
-}
-/**
- * Entire lavalink information object from lavalink
- */
-export interface LavalinkInfo {
-    /** The version of this Lavalink server */
-    version: VersionObject;
-    /** The millisecond unix timestamp when this Lavalink jar was built */
-    buildTime: number;
-    /** The git information of this Lavalink server */
-    git: GitObject;
-    /** The JVM version this Lavalink server runs on */
-    jvm: string;
-    /** The Lavaplayer version being used by this server */
-    lavaplayer: string;
-    /** The enabled source managers for this server */
-    sourceManagers: string[];
-    /** The enabled filters for this server */
-    filters: string[];
-    /** The enabled plugins for this server */
-    plugins: PluginObject[];
-}
-/**
- * Lavalink's version object from lavalink
- */
-export interface VersionObject {
-    /** The full version string of this Lavalink server */
-    semver: string;
-    /** The major version of this Lavalink server */
-    major: number;
-    /** The minor version of this Lavalink server */
-    minor: number;
-    /** The patch version of this Lavalink server */
-    patch: internal;
-    /** The pre-release version according to semver as a . separated list of identifiers */
-    preRelease?: string;
-    /** The build metadata according to semver as a . separated list of identifiers */
-    build?: string;
-}
-/**
- * Git information object from lavalink
- */
-export interface GitObject {
-    /** The branch this Lavalink server was built on */
-    branch: string;
-    /** The commit this Lavalink server was built on */
-    commit: string;
-    /** The millisecond unix timestamp for when the commit was created */
-    commitTime: string;
-}
-/**
- * Lavalink's plugins object from lavalink's plugin
- */
-export interface PluginObject {
-    /** The name of the plugin */
-    name: string;
-    /** The version of the plugin */
-    version: string;
-}
+import type { Player } from "./Player";
+import type { DestroyReasonsType } 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";
 /**
  * Lavalink Node creator class
  */
 export declare class LavalinkNode {
+    private heartBeatPingTimestamp;
+    private heartBeatPongTimestamp;
+    get heartBeatPing(): number;
+    private heartBeatInterval?;
+    private pingTimeout?;
     /** The provided Options of the Node */
     options: LavalinkNodeOptions;
     /** The amount of rest calls the node has made. */
@@ -300,6 +156,7 @@ export declare class LavalinkNode {
      * ```
      */
     connect(sessionId?: string): void;
+    private heartBeat;
     /**
      * Get the id of the node
      *
@@ -332,6 +189,7 @@ export declare class LavalinkNode {
      * ```
      */
     get connected(): boolean;
+    isAlive: boolean;
     /**
      * Returns the current ConnectionStatus
      *
@@ -356,7 +214,7 @@ export declare class LavalinkNode {
      * const playersOfLavalink = await node?.fetchAllPlayers();
      * ```
      */
-    fetchAllPlayers(): Promise<LavalinkPlayer[]>;
+    fetchAllPlayers(): Promise<LavalinkPlayer[] | InvalidLavalinkRestRequest>;
     /**
      * Gets specific Player Information
      * @returns lavalink player object if player exists on lavalink
@@ -517,6 +375,7 @@ export declare class LavalinkNode {
     private message;
     /** @private middleware util function for handling all kind of events from websocket */
     private handleEvent;
+    private getTrackOfPayload;
     /** @private util function for handling trackStart event */
     private trackStart;
     /** @private util function for handling trackEnd event */