lavalink-client 1.0.2 → 1.0.4

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { EventEmitter } from "events";
 import { NodeManager } from "./NodeManager";
-import { QueueChangesWatcher, QueueSaverOptions, StoreManager } from "./Queue";
+import { QueueSaverOptions } from "./Queue";
 import { GuildShardPayload, LavalinkSearchPlatform, ManagerUitls, MiniMap, SearchPlatform, TrackEndEvent, TrackExceptionEvent, TrackStartEvent, TrackStuckEvent, VoicePacket, VoiceServer, VoiceState, WebSocketClosedEvent } from "./Utils";
 import { LavalinkNodeOptions } from "./Node";
 import { DestroyReasonsType, Player, PlayerOptions } from "./Player";
@@ -18,26 +18,37 @@ export interface BotClientOptions {
     [x: string | number | symbol | undefined]: any;
 }
 export interface LavalinkPlayerOptions {
+    /** If the Lavalink Volume should be decremented by x number */
     volumeDecrementer?: number;
-    clientBasedUpdateInterval?: 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) */
         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;
     };
 }
 export interface ManagerOptions {
     nodes: LavalinkNodeOptions[];
     queueOptions?: QueueSaverOptions;
-    queueStore?: StoreManager;
-    queueChangesWatcher?: QueueChangesWatcher;
     client?: BotClientOptions;
     playerOptions?: LavalinkPlayerOptions;
     autoSkip?: boolean;
+    defaultLeastUsedNodeSortType?: "memory" | "calls" | "players";
+    defaultLeastLoadNodeSortType?: "cpu" | "memory";
     /** @async */
     sendToShard: (guildId: string, payload: GuildShardPayload) => void;
 }

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

@@ -56,6 +56,17 @@ export declare class NodeManager extends EventEmitter {
     constructor(LavalinkManager: LavalinkManager);
     createNode(options: LavalinkNodeOptions): LavalinkNode;
     get leastUsedNodes(): LavalinkNode[];
+    /** Returns the least used Nodes sorted by amount of calls. */
+    private get leastUsedNodesCalls();
+    /** Returns the least used Nodes sorted by amount of players. */
+    private get leastUsedNodesPlayers();
+    /** Returns the least used Nodes sorted by amount of memory usage. */
+    private get leastUsedNodesMemory();
+    /** Returns the least system load Nodes. */
+    get leastLoadNodes(): LavalinkNode[];
+    get leastLoadNodesMemory(): LavalinkNode[];
+    /** Returns the least system load Nodes. */
+    get leastLoadNodesCpu(): LavalinkNode[];
     deleteNode(node: LavalinkNodeIdentifier | LavalinkNode): void;
 }
 export {};

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

@@ -18,6 +18,8 @@ export interface StoreManager extends Record<any, any> {
 }
 export interface QueueSaverOptions {
     maxPreviousTracks: number;
+    queueStore?: StoreManager;
+    queueChangesWatcher?: QueueChangesWatcher;
 }
 export interface QueueSaver {
     /** @private */
@@ -26,7 +28,7 @@ export interface QueueSaver {
     options: QueueSaverOptions;
 }
 export declare class QueueSaver {
-    constructor(storeManager: StoreManager, options: QueueSaverOptions);
+    constructor(options: QueueSaverOptions);
     get(guildId: string): Promise<Partial<StoredQueue>>;
     delete(guildId: string): Promise<any>;
     set(guildId: string, value: any): Promise<any>;
@@ -59,7 +61,7 @@ export declare class Queue {
     static readonly StaticSymbol: Symbol;
     private managerUtils;
     private queueChanges;
-    constructor(guildId: string, data?: Partial<StoredQueue>, QueueSaver?: QueueSaver, queueChangesWatcher?: QueueChangesWatcher);
+    constructor(guildId: string, data?: Partial<StoredQueue>, QueueSaver?: QueueSaver, queueOptions?: QueueSaverOptions);
     /**
      * Utils for a Queue
      */

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

@@ -1,4 +1,7 @@
 import { Base64 } from "./Utils";
+type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
+type LavalinkPlugin_LavaSrc_SourceNames = "deezer" | "spotify" | "applemusic" | "yandexmusic" | "flowery-tts";
+type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames;
 export interface TrackInfo {
     identifier: string;
     title: string;
@@ -6,7 +9,7 @@ export interface TrackInfo {
     duration: number;
     artworkUrl: string | null;
     uri: string;
-    sourceName: string;
+    sourceName: SourceNames;
     isSeekable: boolean;
     isStream: boolean;
     isrc: string | null;
@@ -24,6 +27,10 @@ export interface PluginInfo {
     url?: string;
     /** The Url provided by a Plugin */
     uri?: string;
+    /** You can put specific track information here, to transform the tracks... */
+    clientData?: {
+        [key: string]: any;
+    };
 }
 export interface LavalinkTrack {
     /** The Base 64 encoded String */
@@ -45,3 +52,4 @@ export interface UnresolvedQuery {
     /** The Track's Requester */
     requester?: unknown;
 }
+export {};

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

@@ -1,6 +1,6 @@
 import { LavalinkFilterData } from "./Filters";
 import { LavalinkManager } from "./LavalinkManager";
-import { LavalinkNode, NodeStats } from "./Node";
+import { LavalinkNode, LavalinkNodeOptions, NodeStats } from "./Node";
 import { PlayOptions } from "./Player";
 import { Queue } from "./Queue";
 import { PluginInfo, Track } from "./Track";
@@ -8,7 +8,7 @@ export declare const TrackSymbol: unique symbol;
 export declare const UnresolvedTrackSymbol: unique symbol;
 export declare const QueueSymbol: unique symbol;
 export declare const NodeSymbol: unique symbol;
-export type LavalinkSearchPlatform = "ytsearch" | "ytmsearch" | "scsearch" | "spsearch" | "sprec" | "amsearch" | "dzsearch" | "dzisrc" | "sprec" | "ymsearch" | "speak" | "tts";
+export type LavalinkSearchPlatform = "ytsearch" | "ytmsearch" | "scsearch" | "spsearch" | "sprec" | "amsearch" | "dzsearch" | "dzisrc" | "sprec" | "ymsearch" | "speak" | "tts" | "ftts";
 export type ClientSearchPlatform = "youtube" | "yt" | "yt" | "youtube music" | "youtubemusic" | "ytm" | "soundcloud" | "sc" | "am" | "apple music" | "applemusic" | "apple" | "yandex music" | "sp" | "sprec" | "spsuggestion" | "spotify" | "dz" | "deezer" | "yandex" | "yandexmusic";
 export type SearchPlatform = LavalinkSearchPlatform | ClientSearchPlatform;
 export type SourcesRegex = "YoutubeRegex" | "YoutubeMusicRegex" | "SoundCloudRegex" | "SoundCloudMobileRegex" | "DeezerTrackRegex" | "DeezerArtistRegex" | "DeezerEpisodeRegex" | "DeezerMixesRegex" | "DeezerPageLinkRegex" | "DeezerPlaylistRegex" | "DeezerAlbumRegex" | "AllDeezerRegex" | "AllDeezerRegexWithoutPageLink" | "SpotifySongRegex" | "SpotifyPlaylistRegex" | "SpotifyArtistRegex" | "SpotifyEpisodeRegex" | "SpotifyShowRegex" | "SpotifyAlbumRegex" | "AllSpotifyRegex" | "mp3Url" | "m3uUrl" | "m3u8Url" | "mp4Url" | "m4aUrl" | "wavUrl" | "aacpUrl" | "tiktok" | "mixcloud" | "musicYandex" | "radiohost" | "bandcamp" | "appleMusic" | "TwitchTv" | "vimeo";
@@ -40,10 +40,20 @@ export interface ManagerUitls {
 export declare class ManagerUitls {
     constructor(LavalinkManager?: LavalinkManager);
     buildTrack(data: any, requester: any): Track;
+    /**
+     * Validate if a data is equal to a node
+     * @param data
+     */
+    isNode(data: LavalinkNode): boolean;
+    /**
+     * Validate if a data is equal to node options
+     * @param data
+     */
+    isNodeOptions(data: LavalinkNodeOptions | any): boolean;
     /**
      * Validate if a data is euqal to a track
-     * @param {Track|any} data the Track to validate
-     * @returns {boolean}
+     * @param data the Track to validate
+     * @returns
      */
     isTrack(data: Track | any): boolean;
     validatedQuery(queryString: string, node: LavalinkNode): void;
@@ -85,6 +95,8 @@ export declare class MiniMap<K, V> extends Map<K, V> {
     filter<This, K2 extends K>(fn: (this: This, value: V, key: K, miniMap: this) => key is K2, thisArg: This): MiniMap<K2, V>;
     filter<This, V2 extends V>(fn: (this: This, value: V, key: K, miniMap: this) => value is V2, thisArg: This): MiniMap<K, V2>;
     filter<This>(fn: (this: This, value: V, key: K, miniMap: this) => boolean, thisArg: This): MiniMap<K, V>;
+    toJSON(): V[];
+    private static defaultSort;
     /**
      * Maps each item to another value into an array. Identical in behavior to
      * [Array.map()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lavalink-client",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Easy and advanced lavalink client. Use it with lavalink plugins as well as latest lavalink versions",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",