lavalink-client 2.3.0 → 2.3.3

package/dist/structures/Queue.js

@@ -1,160 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Queue = exports.DefaultQueueStore = exports.QueueSaver = void 0;
-class QueueSaver {
-    constructor(storeManager, options) {
-        this._ = storeManager;
-        this.options = options;
-    }
-    async get(key) {
-        return new Queue(await this._.parse(await this._.get(key)), key, this);
-    }
-    async delete(key) {
-        return await this._.delete(key);
-    }
-    async set(key, value) {
-        return await this._.set(key, await this._.stringify(value));
-    }
-}
-exports.QueueSaver = QueueSaver;
-class DefaultQueueStore {
-    data = new Map();
-    constructor() {
-    }
-    get(key) {
-        return this.data.get(key);
-    }
-    set(key, value) {
-        return this.data.set(key, value);
-    }
-    delete(key) {
-        return this.data.delete(key);
-    }
-    stringify(value) {
-        return value;
-    }
-    parse(value) {
-        return value;
-    }
-}
-exports.DefaultQueueStore = DefaultQueueStore;
-class Queue {
-    _nextTracks = [];
-    _previousTracks = [];
-    _currentTrack = null;
-    _guildId = "";
-    _QueueSaver = null;
-    constructor(data = {}, guildId, QueueSaver) {
-        this._guildId = guildId;
-        this._QueueSaver = QueueSaver;
-        this._currentTrack = this.isTrack(data.currentTrack) ? data.currentTrack : null;
-        this._previousTracks = Array.isArray(data.previousTracks) && data.previousTracks.some(track => this.isTrack(track)) ? data.previousTracks.filter(track => this.isTrack(track)) : [];
-        this._nextTracks = Array.isArray(data.nextTracks) && data.nextTracks.some(track => this.isTrack(track)) ? data.nextTracks.filter(track => this.isTrack(track)) : [];
-        // TODO bind event Function for trackEnd
-    }
-    isTrack(data) {
-        return typeof data.encodedTrack === "string" && typeof data.info === "object";
-    }
-    /** The Current Playing Track */
-    get currentTrack() {
-        return this._currentTrack || null;
-    }
-    /** All Previous Track(s) [with the limited amount] */
-    get previousTracks() {
-        return this._previousTracks || [];
-    }
-    /** All Upcoming Track(s) */
-    get nextTracks() {
-        return this._nextTracks || [];
-    }
-    /** The Size of the upcoming Track(s) */
-    get size() {
-        return this.nextTracks.length;
-    }
-    /** The Size of the previous Track(s) */
-    get previousSize() {
-        return this.previousTracks.length;
-    }
-    /**
-     * @returns The Queue, but in a raw State, which allows easier handling for the storeManager
-     */
-    getRaw() {
-        return {
-            currentTrack: this.currentTrack,
-            previousTracks: this.previousTracks,
-            nextTracks: this.nextTracks,
-        };
-    }
-    /**
-     * Add a Track to the Queue, and after saved in the "db" it returns the amount of the Tracks
-     * @param Track
-     * @param index At what position to add the Track
-     * @returns Queue-Size (for the next Tracks)
-     */
-    async add(TrackOrTracks, index) {
-        if (typeof index === "number")
-            return await this.splice(index, 0, TrackOrTracks);
-        // add the track(s)
-        this._nextTracks.push(...(Array.isArray(TrackOrTracks) ? TrackOrTracks : [TrackOrTracks]).filter(v => this.isTrack(v)));
-        // save the queue
-        await this._QueueSaver.set(this._guildId, this.getRaw());
-        return this.size;
-    }
-    /**
-     *
-     * @param index Where to remove the Track
-     * @param amount How many Tracks to remove?
-     * @param TrackOrTracks Want to Add more Tracks?
-     */
-    async splice(index, amount, TrackOrTracks) {
-        if (!this.size)
-            return null;
-        let spliced = TrackOrTracks ? this._nextTracks.splice(index, amount, ...(Array.isArray(TrackOrTracks) ? TrackOrTracks : [TrackOrTracks]).filter(v => this.isTrack(v))) : this._nextTracks.splice(index, amount);
-        // save the queue
-        await this._QueueSaver.set(this._guildId, this.getRaw());
-        spliced = (Array.isArray(spliced) ? spliced : [spliced]);
-        return spliced.length === 1 ? spliced[0] : spliced;
-    }
-    /**
-     * Add a Track to the Previous Track list, and after saved in the "db" it returns the amount of the previous Tracks
-     * @param Track
-     * @returns PreviousTracksSize
-     */
-    async addPrevious(Track) {
-        if (!this.isTrack(Track))
-            return;
-        this._previousTracks.unshift(Track);
-        if (this.previousSize > this._QueueSaver.options.maxPreviousTracks)
-            this._previousTracks.pop();
-        await this._QueueSaver.set(this._guildId, this.getRaw());
-        return this.previousSize;
-    }
-    /**
-     * Add a Track to the Previous Track list, and after saved in the "db" it returns the amount of the previous Tracks
-     * @param Track
-     * @returns PreviousTracksSize
-     */
-    async setCurrent(Track) {
-        this._currentTrack = Track;
-        await this._QueueSaver.set(this._guildId, this.getRaw());
-        return this.currentTrack;
-    }
-    /** @private @hidden */
-    async _trackEnd(addBackToQueue = false) {
-        if (this.currentTrack) { // if there was a current Track -> Add it
-            this._previousTracks.unshift(this.currentTrack);
-            if (this.previousSize > this._QueueSaver.options.maxPreviousTracks)
-                this._previousTracks.pop();
-        }
-        // change the current Track to the next upcoming one
-        this._currentTrack = this._nextTracks.shift() || null;
-        // and if repeatMode == queue, add it back to the queue!
-        if (addBackToQueue && this.currentTrack)
-            this._nextTracks.push(this.currentTrack);
-        // save it in the DB
-        await this._QueueSaver.set(this._guildId, this.getRaw());
-        // return the new current Track
-        return this.currentTrack;
-    }
-}
-exports.Queue = Queue;

package/dist/structures/QueueManager.d.ts

@@ -1,77 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from "stream";
-import { LavalinkManager } from "./LavalinkManager";
-import { Queue } from "./Queue";
-interface QueueManagerEvents {
-    /**
-     * Emitted when a Queue is created.
-     * @event Manager.playerManager#create
-     */
-    "create": (queue: Queue) => void;
-}
-export interface QueueManager {
-    on<U extends keyof QueueManagerEvents>(event: U, listener: QueueManagerEvents[U]): this;
-    emit<U extends keyof QueueManagerEvents>(event: U, ...args: Parameters<QueueManagerEvents[U]>): boolean;
-    /** @private */
-    queues: QueueSaver;
-    /** @private */
-    LavalinkManager: LavalinkManager;
-}
-export interface QueueStoreManager extends Record<any, any> {
-    /** @async get a Value */
-    get: (key: unknown) => any;
-    /** @async Set a value inside a key */
-    set: (key: unknown, value: unknown) => any;
-    /** @async Delete a Database Value based of it's key */
-    delete: (key: unknown) => any;
-    /** @async Transform the value(s) inside of the QueueStoreManager */
-    stringify: (value: unknown) => any;
-    /** @async Parse the saved value back to the Queue */
-    parse: (value: unknown) => Queue;
-}
-export interface ManagerQueueOptions {
-    maxPreviousTracks: number;
-}
-export interface QueueSaver {
-    /** @private */
-    _: QueueStoreManager;
-    /** @private */
-    options: ManagerQueueOptions;
-}
-export declare class QueueSaver {
-    constructor(QueueStoreManager: QueueStoreManager, options: ManagerQueueOptions);
-    get(key: string): Promise<Queue>;
-    delete(key: string): Promise<any>;
-    set(key: string, value: any): Promise<any>;
-}
-export declare class DefaultQueueStore {
-    private data;
-    constructor();
-    get(key: any): any;
-    set(key: any, value: any): Map<any, any>;
-    delete(key: any): boolean;
-    stringify(value: any): any;
-    parse(value: any): any;
-}
-export declare class QueueManager extends EventEmitter {
-    constructor(LavalinkManager: LavalinkManager);
-    /**
-     * Generate a base Empty Queue, for easier use
-     * @param guildId
-     * @returns
-     */
-    private generateEmptyQueue;
-    /**
-     * Get a Queue of a Guild
-     * @param guildId
-     * @returns
-     */
-    getQueue(guildId: string): Promise<Queue>;
-    /**
-     * Delete a Queue
-     * @param guildId
-     * @returns
-     */
-    private deleteQueue;
-}
-export {};

package/dist/structures/QueueManager.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QueueManager = exports.DefaultQueueStore = exports.QueueSaver = void 0;
-const stream_1 = require("stream");
-const Queue_1 = require("./Queue");
-class QueueSaver {
-    constructor(storeManager, options) {
-        this._ = storeManager;
-        this.options = options;
-    }
-    async get(key) {
-        return new Queue_1.Queue(await this._.parse(await this._.get(key)), key, this);
-    }
-    async delete(key) {
-        return await this._.delete(key);
-    }
-    async set(key, value) {
-        return await this._.set(key, await this._.stringify(value));
-    }
-}
-exports.QueueSaver = QueueSaver;
-class DefaultQueueStore {
-    data = new Map();
-    constructor() {
-    }
-    get(key) {
-        return this.data.get(key);
-    }
-    set(key, value) {
-        return this.data.set(key, value);
-    }
-    delete(key) {
-        return this.data.delete(key);
-    }
-    stringify(value) {
-        return value;
-    }
-    parse(value) {
-        return value;
-    }
-}
-exports.DefaultQueueStore = DefaultQueueStore;
-class QueueManager extends stream_1.EventEmitter {
-    constructor(LavalinkManager) {
-        super();
-        this.LavalinkManager = LavalinkManager;
-        this.queues = new QueueSaver(this.LavalinkManager.options.queueStore || new DefaultQueueStore(), this.LavalinkManager.options.queueOptions);
-    }
-    /**
-     * Generate a base Empty Queue, for easier use
-     * @param guildId
-     * @returns
-     */
-    generateEmptyQueue(guildId) {
-        return new Queue_1.Queue({}, guildId, this.queues);
-    }
-    /**
-     * Get a Queue of a Guild
-     * @param guildId
-     * @returns
-     */
-    async getQueue(guildId) {
-        return await this.queues.get(guildId) || this.generateEmptyQueue(guildId);
-    }
-    /**
-     * Delete a Queue
-     * @param guildId
-     * @returns
-     */
-    async deleteQueue(guildId) {
-        return await this.queues.delete(guildId);
-    }
-}
-exports.QueueManager = QueueManager;

package/dist/structures/Track.d.ts

@@ -1,27 +0,0 @@
-export interface LavalinkTrackDataInfo {
-    identifier: string;
-    title: string;
-    author: string;
-    duration: number;
-    artworkUrl: string | null;
-    uri: string;
-    sourceName: string;
-    isSeekable: boolean;
-    isStream: boolean;
-    isrc: string | null;
-}
-export interface LavalinkTrackDataInfoExtended extends LavalinkTrackDataInfo {
-    requester?: unknown;
-}
-export interface Track {
-    encodedTrack?: string;
-    info: LavalinkTrackDataInfoExtended;
-    pluginInfo: Partial<PluginDataInfo> | Record<string, string | number>;
-}
-export interface PluginDataInfo {
-    type?: string;
-    identifier?: string;
-    artworkUrl?: string;
-    author?: string;
-    url?: string;
-}

package/dist/structures/Track.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/structures/Utils.d.ts

@@ -1,183 +0,0 @@
-import { LavalinkFilterData } from "./Filters";
-import { LavalinkManager } from "./LavalinkManager";
-import { NodeStats } from "./Node";
-import { PlayOptions } from "./Player";
-import { PluginDataInfo, Track } from "./Track";
-export declare const TrackSymbol: 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 ClientSearchPlatform = "youtube" | "youtube music" | "soundcloud" | "ytm" | "yt" | "sc" | "am" | "sp" | "sprec" | "spsuggestion" | "ds" | "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";
-export interface PlaylistInfo {
-    /** The playlist name. */
-    name: string;
-    /** The Playlist Author */
-    author?: string;
-    /** The Playlist Thumbnail */
-    thumbnail?: string;
-    /** A Uri to the playlist */
-    uri?: string;
-    /** The playlist selected track. */
-    selectedTrack: Track | null;
-    /** The duration of the entire playlist. (calcualted) */
-    duration: number;
-}
-export interface SearchResult {
-    loadType: LoadTypes;
-    exception: Exception | null;
-    pluginInfo: PluginDataInfo;
-    playlist: PlaylistInfo | null;
-    tracks: Track[];
-}
-export interface ManagerUtils {
-    /** @private */
-    manager: LavalinkManager;
-}
-export declare class ManagerUtils {
-    constructor(LavalinkManager: LavalinkManager);
-    buildTrack(data: any, requester: any): Track;
-}
-export type PlayerEvents = TrackStartEvent | TrackEndEvent | TrackStuckEvent | TrackExceptionEvent | WebSocketClosedEvent;
-export type Severity = "COMMON" | "SUSPICIOUS" | "FAULT";
-export interface Exception {
-    severity: Severity;
-    message: string;
-    cause: string;
-}
-export interface PlayerEvent {
-    op: "event";
-    type: PlayerEventType;
-    guildId: string;
-}
-export interface TrackStartEvent extends PlayerEvent {
-    type: "TrackStartEvent";
-    track: string;
-}
-export interface TrackEndEvent extends PlayerEvent {
-    type: "TrackEndEvent";
-    track: string;
-    reason: TrackEndReason;
-}
-export interface TrackExceptionEvent extends PlayerEvent {
-    type: "TrackExceptionEvent";
-    exception?: Exception;
-    error: string;
-}
-export interface TrackStuckEvent extends PlayerEvent {
-    type: "TrackStuckEvent";
-    thresholdMs: number;
-}
-export interface WebSocketClosedEvent extends PlayerEvent {
-    type: "WebSocketClosedEvent";
-    code: number;
-    byRemote: boolean;
-    reason: string;
-}
-export type LoadTypes = "track" | "playlist" | "search" | "error" | "empty";
-export type State = "CONNECTED" | "CONNECTING" | "DISCONNECTED" | "DISCONNECTING" | "DESTROYING";
-export type PlayerEventType = "TrackStartEvent" | "TrackEndEvent" | "TrackExceptionEvent" | "TrackStuckEvent" | "WebSocketClosedEvent";
-export type TrackEndReason = "FINISHED" | "LOAD_FAILED" | "STOPPED" | "REPLACED" | "CLEANUP";
-export interface InvalidLavalinkRestRequest {
-    timestamp: number;
-    status: number;
-    error: string;
-    message?: string;
-    path: string;
-}
-export interface LavalinkPlayerVoice {
-    token: string;
-    endpoint: string;
-    sessionId: string;
-    connected?: boolean;
-    ping?: number;
-}
-export interface LavalinkPlayerVoiceOptions extends Omit<LavalinkPlayerVoice, 'connected' | 'ping'> {
-}
-export interface Address {
-    address: string;
-    failingTimestamp: number;
-    failingTime: string;
-}
-export interface RoutePlanner {
-    class?: string;
-    details?: {
-        ipBlock: {
-            type: string;
-            size: string;
-        };
-        failingAddresses: Address[];
-    };
-    rotateIndex?: string;
-    ipIndex?: string;
-    currentAddress?: string;
-    blockIndex?: string;
-    currentAddressIndex?: string;
-}
-export interface Session {
-    resumingKey?: string;
-    timeout: number;
-}
-export interface GuildShardPayload {
-    /** The OP code */
-    op: number;
-    d: {
-        guild_id: string;
-        channel_id: string | null;
-        self_mute: boolean;
-        self_deaf: boolean;
-    };
-}
-export interface PlayerUpdateInfo {
-    guildId: string;
-    playerOptions: PlayOptions;
-    noReplace?: boolean;
-}
-export interface LavalinkPlayer {
-    guildId: string;
-    track?: {
-        encoded?: string;
-        info: {
-            identifier: string;
-            title: string;
-            author: string;
-            length: number;
-            artworkUrl: string | null;
-            uri: string;
-            sourceName: string;
-            isSeekable: boolean;
-            isStream: boolean;
-            isrc: string | null;
-            position?: number;
-        };
-    };
-    volume: number;
-    paused: boolean;
-    voice: LavalinkPlayerVoice;
-    filters: Partial<LavalinkFilterData>;
-}
-export interface VoiceState {
-    op: "voiceUpdate";
-    guildId: string;
-    event: VoiceServer;
-    sessionId?: string;
-    guild_id: string;
-    user_id: string;
-    session_id: string;
-    channel_id: string;
-}
-export interface VoiceServer {
-    token: string;
-    guild_id: string;
-    endpoint: string;
-}
-export interface VoicePacket {
-    t?: "VOICE_SERVER_UPDATE" | "VOICE_STATE_UPDATE";
-    d: VoiceState | VoiceServer;
-}
-export interface NodeMessage extends NodeStats {
-    type: PlayerEventType;
-    op: "stats" | "playerUpdate" | "event";
-    guildId: string;
-}

package/dist/structures/Utils.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ManagerUitls = exports.NodeSymbol = exports.QueueSymbol = exports.TrackSymbol = void 0;
-exports.TrackSymbol = Symbol("LC-Track");
-exports.QueueSymbol = Symbol("LC-Queue");
-exports.NodeSymbol = Symbol("LC-Node");
-class ManagerUitls {
-    constructor(LavalinkManager) {
-        this.manager = LavalinkManager;
-    }
-    buildTrack(data, requester) {
-        const encodedTrack = data.encoded || data.encodedTrack || typeof data.track === "string" ? data.track : undefined;
-        if (!encodedTrack)
-            throw new RangeError("Argument 'data.encoded' / 'data.encodedTrack' / 'data.track' must be present.");
-        if (!data.info)
-            data.info = {};
-        try {
-            const r = {
-                info: {
-                    identifier: data.info?.identifier,
-                    title: data.info?.title,
-                    author: data.info?.author,
-                    duration: data.info?.duration,
-                    artworkUrl: data.info?.artworkUrl || ["youtube.", "youtu.be"].some(d => data.info?.uri?.includes?.(d)) ? `https://img.youtube.com/vi/${data.info?.identifier}/mqdefault.jpg` : undefined,
-                    uri: data.info?.uri,
-                    sourceName: data.info?.sourceName,
-                    isSeekable: data.info?.isSeekable,
-                    isStream: data.info?.isStream,
-                    isrc: data.info?.isrc,
-                    requester: data.info?.requester || requester,
-                },
-                pluginInfo: data.pluginInfo || data.plugin || {},
-                encodedTrack
-            };
-            Object.defineProperty(r, exports.TrackSymbol, { configurable: true, value: true });
-            return r;
-        }
-        catch (error) {
-            throw new RangeError(`Argument "data" is not a valid track: ${error.message}`);
-        }
-    }
-}
-exports.ManagerUitls = ManagerUitls;