magmastream 2.10.2-dev.4 → 2.10.2

package/dist/structures/Player.d.ts

@@ -1,347 +0,0 @@
-import { Filters } from "./Filters";
-import { Manager } from "./Manager";
-import { Node } from "./Node";
-import { AnyMessage, IQueue, Lyrics, PlayerOptions, PlayerVoiceState, PlayOptions, SearchQuery, SearchResult, Track } from "./Types";
-import { SponsorBlockSegment, StateTypes } from "./Enums";
-import { WebSocket } from "ws";
-export declare class Player {
-    options: PlayerOptions;
-    /** The Queue for the Player. */
-    queue: IQueue;
-    /** The filters applied to the audio. */
-    filters: Filters;
-    /** Whether the queue repeats the track. */
-    trackRepeat: boolean;
-    /** Whether the queue repeats the queue. */
-    queueRepeat: boolean;
-    /**Whether the queue repeats and shuffles after each song. */
-    dynamicRepeat: boolean;
-    /** The time the player is in the track. */
-    position: number;
-    /** Whether the player is playing. */
-    playing: boolean;
-    /** Whether the player is paused. */
-    paused: boolean;
-    /** The volume for the player */
-    volume: number;
-    /** The Node for the Player. */
-    node: Node;
-    /** The guild ID for the player. */
-    guildId: string;
-    /** The voice channel for the player. */
-    voiceChannelId: string | null;
-    /** The text channel for the player. */
-    textChannelId: string | null;
-    /**The now playing message. */
-    nowPlayingMessage?: AnyMessage;
-    /** The current state of the player. */
-    state: StateTypes;
-    /** The equalizer bands array. */
-    bands: number[];
-    /** The voice state object from the node. */
-    voiceState: PlayerVoiceState;
-    /** The Manager. */
-    manager: Manager;
-    /** The autoplay state of the player. */
-    isAutoplay: boolean;
-    /** The number of times to try autoplay before emitting queueEnd. */
-    autoplayTries: number;
-    /** The cluster ID for the player. */
-    clusterId: number;
-    private readonly data;
-    private dynamicLoopInterval;
-    dynamicRepeatIntervalMs: number | null;
-    private static _manager;
-    /** Should only be used when the node is a NodeLink */
-    protected voiceReceiverWsClient: WebSocket | null;
-    protected isConnectToVoiceReceiver: boolean;
-    protected voiceReceiverReconnectTimeout: NodeJS.Timeout | null;
-    protected voiceReceiverAttempt: number;
-    protected voiceReceiverReconnectTries: number;
-    /**
-     * Creates a new player, returns one if it already exists.
-     * @param options The player options.
-     * @see https://docs.magmastream.com/main/introduction/getting-started
-     */
-    constructor(options: PlayerOptions);
-    /**
-     * Initializes the static properties of the Player class.
-     * @hidden
-     * @param manager The Manager to use.
-     */
-    static init(manager: Manager): void;
-    /**
-     * Set custom data.
-     * @param key - The key to set the data for.
-     * @param value - The value to set the data to.
-     */
-    set(key: string, value: unknown): void;
-    /**
-     * Retrieves custom data associated with a given key.
-     * @template T - The expected type of the data.
-     * @param {string} key - The key to retrieve the data for.
-     * @returns {T} - The data associated with the key, cast to the specified type.
-     */
-    get<T>(key: string): T;
-    /**
-     * Same as Manager#search() but a shortcut on the player itself.
-     * @param query
-     * @param requester
-     */
-    search<T = unknown>(query: string | SearchQuery, requester?: T): Promise<SearchResult>;
-    /**
-     * Connects the player to the voice channel.
-     * @throws {RangeError} If no voice channel has been set.
-     * @returns {void}
-     */
-    connect(): void;
-    /**
-     * Disconnects the player from the voice channel.
-     * @returns {this} The player instance.
-     */
-    disconnect(): Promise<this>;
-    /**
-     * Destroys the player and clears the queue.
-     * @param {boolean} disconnect - Whether to disconnect the player from the voice channel.
-     * @returns {Promise<boolean>} - Whether the player was successfully destroyed.
-     * @emits {PlayerDestroy} - Emitted when the player is destroyed.
-     * @emits {PlayerStateUpdate} - Emitted when the player state is updated.
-     */
-    destroy(disconnect?: boolean): Promise<boolean>;
-    /**
-     * Sets the player voice channel.
-     * @param {string} channel - The new voice channel ID.
-     * @returns {this} - The player instance.
-     * @throws {TypeError} If the channel parameter is not a string.
-     */
-    setVoiceChannelId(channel: string): this;
-    /**
-     * Sets the player text channel.
-     *
-     * This method updates the text channel associated with the player. It also
-     * emits a player state update event indicating the change in the channel.
-     *
-     * @param {string} channel - The new text channel ID.
-     * @returns {this} - The player instance for method chaining.
-     * @throws {TypeError} If the channel parameter is not a string.
-     */
-    setTextChannelId(channel: string): this;
-    /**
-     * Sets the now playing message.
-     *
-     * @param message - The message of the now playing message.
-     * @returns The now playing message.
-     */
-    setNowPlayingMessage(message: AnyMessage): AnyMessage;
-    /**
-     * Plays the next track.
-     *
-     * If a track is provided, it will be played. Otherwise, the next track in the queue will be played.
-     * If the queue is not empty, but the current track has not finished yet, it will be replaced with the provided track.
-     *
-     * @param {object} [optionsOrTrack] - The track to play or the options to play with.
-     * @param {object} [playOptions] - The options to play with.
-     *
-     * @returns {Promise<void>}
-     */
-    play(): Promise<Player>;
-    play(track: Track): Promise<Player>;
-    play(options: PlayOptions): Promise<Player>;
-    play(track: Track, options: PlayOptions): Promise<Player>;
-    /**
-     * Sets the autoplay-state of the player.
-     *
-     * Autoplay is a feature that makes the player play a recommended
-     * track when the current track ends.
-     *
-     * @param {boolean} autoplayState - Whether or not autoplay should be enabled.
-     * @param {object} AutoplayUser - The user-object that should be used as the bot-user.
-     * @param {number} [tries=3] - The number of times the player should try to find a
-     * recommended track if the first one doesn't work.
-     * @returns {this} - The player instance.
-     */
-    setAutoplay<T = unknown>(autoplayState: boolean, AutoplayUser?: T, tries?: number): this;
-    /**
-     * Gets recommended tracks and returns an array of tracks.
-     * @param {Track} track - The track to find recommendations for.
-     * @returns {Promise<Track[]>} - Array of recommended tracks.
-     */
-    getRecommendedTracks(track: Track): Promise<Track[]>;
-    /**
-     * Sets the volume of the player.
-     * @param {number} volume - The new volume. Must be between 0 and 500 when using filter mode (100 = 100%).
-     * @returns {Promise<Player>} - The updated player.
-     * @throws {TypeError} If the volume is not a number.
-     * @throws {RangeError} If the volume is not between 0 and 500 when using filter mode (100 = 100%).
-     * @emits {PlayerStateUpdate} - Emitted when the volume is changed.
-     * @example
-     * player.setVolume(50);
-     */
-    setVolume(volume: number): Promise<this>;
-    /**
-     * Sets the sponsorblock for the player. This will set the sponsorblock segments for the player to the given segments.
-     * @param {SponsorBlockSegment[]} segments - The sponsorblock segments to set. Defaults to `[SponsorBlockSegment.Sponsor, SponsorBlockSegment.SelfPromo]` if not provided.
-     * @returns {Promise<void>} The promise is resolved when the operation is complete.
-     */
-    setSponsorBlock(segments?: SponsorBlockSegment[]): Promise<void>;
-    /**
-     * Gets the sponsorblock for the player.
-     * @returns {Promise<SponsorBlockSegment[]>} The sponsorblock segments.
-     */
-    getSponsorBlock(): Promise<SponsorBlockSegment[]>;
-    /**
-     * Deletes the sponsorblock for the player. This will remove all sponsorblock segments that have been set for the player.
-     * @returns {Promise<void>}
-     */
-    deleteSponsorBlock(): Promise<void>;
-    /**
-     * Sets the track repeat mode.
-     * When track repeat is enabled, the current track will replay after it ends.
-     * Disables queueRepeat and dynamicRepeat modes if enabled.
-     *
-     * @param repeat - A boolean indicating whether to enable track repeat.
-     * @returns {this} - The player instance.
-     * @throws {TypeError} If the repeat parameter is not a boolean.
-     */
-    setTrackRepeat(repeat: boolean): this;
-    /**
-     * Sets the queue repeat.
-     * @param repeat Whether to repeat the queue or not
-     * @returns {this} - The player instance.
-     * @throws {TypeError} If the repeat parameter is not a boolean
-     */
-    setQueueRepeat(repeat: boolean): this;
-    /**
-     * Sets the queue to repeat and shuffles the queue after each song.
-     * @param repeat "true" or "false".
-     * @param ms After how many milliseconds to trigger dynamic repeat.
-     * @returns {this} - The player instance.
-     * @throws {TypeError} If the repeat parameter is not a boolean.
-     * @throws {RangeError} If the queue size is less than or equal to 1.
-     */
-    setDynamicRepeat(repeat: boolean, ms: number): Promise<this>;
-    /**
-     * Restarts the currently playing track from the beginning.
-     * If there is no track playing, it will play the next track in the queue.
-     * @returns {Promise<Player>} The current instance of the Player class for method chaining.
-     */
-    restart(): Promise<Player>;
-    /**
-     * Stops the player and optionally removes tracks from the queue.
-     * @param {number} [amount] The amount of tracks to remove from the queue. If not provided, removes the current track if it exists.
-     * @returns {Promise<this>} - The player instance.
-     * @throws {RangeError} If the amount is greater than the queue length.
-     */
-    stop(amount?: number): Promise<this>;
-    /**
-     * Skips the current track.
-     * @returns {this} - The player instance.
-     * @throws {Error} If there are no tracks in the queue.
-     * @emits {PlayerStateUpdate} - With {@link PlayerStateEventTypes.TrackChange} as the change type.
-     */
-    pause(pause: boolean): Promise<this>;
-    /**
-     * Skips to the previous track in the queue.
-     * @returns {this} - The player instance.
-     * @throws {Error} If there are no previous tracks in the queue.
-     * @emits {PlayerStateUpdate} - With {@link PlayerStateEventTypes.TrackChange} as the change type.
-     */
-    previous(addBackToQueue?: boolean): Promise<this>;
-    /**
-     * Seeks to a given position in the currently playing track.
-     * @param position - The position in milliseconds to seek to.
-     * @returns {this} - The player instance.
-     * @throws {Error} If the position is invalid.
-     * @emits {PlayerStateUpdate} - With {@link PlayerStateEventTypes.TrackChange} as the change type.
-     */
-    seek(position: number): Promise<this>;
-    /**
-     * Returns the current repeat state of the player.
-     * @param player The player to get the repeat state from.
-     * @returns The repeat state of the player, or null if it is not repeating.
-     */
-    private getRepeatState;
-    /**
-     * Automatically moves the player to a usable node.
-     * @returns {Promise<Player | void>} - The player instance or void if not moved.
-     */
-    autoMoveNode(): Promise<Player | void>;
-    /**
-     * Moves the player to another node.
-     * @param {string} identifier - The identifier of the node to move to.
-     * @returns {Promise<Player>} - The player instance after being moved.
-     */
-    moveNode(identifier: string): Promise<Player>;
-    /**
-     * Retrieves the data associated with the player.
-     * @returns {Record<string, unknown>} - The data associated with the player.
-     */
-    getData(): Record<string, unknown>;
-    /**
-     * Retrieves the dynamic loop interval of the player.
-     * @returns {NodeJS.Timeout | null} - The dynamic loop interval of the player.
-     */
-    getDynamicLoopIntervalPublic(): NodeJS.Timeout | null;
-    /**
-     * Retrieves the data associated with the player.
-     * @returns {Record<string, unknown>} - The data associated with the player.
-     */
-    getSerializableData(): Record<string, unknown>;
-    /**
-     * Retrieves the current lyrics for the playing track.
-     * @param skipTrackSource - Indicates whether to skip the track source when fetching lyrics.
-     * @returns {Promise<Lyrics>} - The lyrics of the current track.
-     */
-    getCurrentLyrics(skipTrackSource?: boolean): Promise<Lyrics>;
-    /**
-     * Sets up the voice receiver for the player.
-     * @returns {Promise<void>} - A promise that resolves when the voice receiver is set up.
-     * @throws {Error} - If the node is not a NodeLink.
-     */
-    setupVoiceReceiver(): Promise<void>;
-    /**
-     * Removes the voice receiver for the player.
-     * @returns {Promise<void>} - A promise that resolves when the voice receiver is removed.
-     * @throws {Error} - If the node is not a NodeLink.
-     */
-    removeVoiceReceiver(): Promise<void>;
-    /**
-     * Closes the voice receiver for the player.
-     * @param {number} code - The code to close the voice receiver with.
-     * @param {string} reason - The reason to close the voice receiver with.
-     * @returns {Promise<void>} - A promise that resolves when the voice receiver is closed.
-     */
-    private closeVoiceReceiver;
-    /**
-     * Reconnects the voice receiver for the player.
-     * @returns {Promise<void>} - A promise that resolves when the voice receiver is reconnected.
-     */
-    private reconnectVoiceReceiver;
-    /**
-     * Disconnects the voice receiver for the player.
-     * @returns {Promise<void>} - A promise that resolves when the voice receiver is disconnected.
-     */
-    private disconnectVoiceReceiver;
-    /**
-     * Opens the voice receiver for the player.
-     * @returns {Promise<void>} - A promise that resolves when the voice receiver is opened.
-     */
-    private openVoiceReceiver;
-    /**
-     * Handles a voice receiver message.
-     * @param {string} payload - The payload to handle.
-     * @returns {Promise<void>} - A promise that resolves when the voice receiver message is handled.
-     */
-    private onVoiceReceiverMessage;
-    /**
-     * Handles a voice receiver error.
-     * @param {Error} error - The error to handle.
-     * @returns {Promise<void>} - A promise that resolves when the voice receiver error is handled.
-     */
-    private onVoiceReceiverError;
-    /**
-     * Updates the voice state for the player.
-     * @returns {Promise<void>} - A promise that resolves when the voice state is updated.
-     */
-    updateVoice(): Promise<void>;
-}

package/dist/structures/Plugin.d.ts

@@ -1,23 +0,0 @@
-import { Manager } from "./Manager";
-/**
- * Base abstract class for all plugins.
- * Users must extend this and implement load and unload methods.
- */
-export declare abstract class Plugin {
-    readonly name: string;
-    /**
-     * @param name The name of the plugin
-     */
-    constructor(name: string);
-    /**
-     * Load the plugin.
-     * @param manager The MagmaStream Manager instance
-     */
-    abstract load(manager: Manager): void;
-    /**
-     * Unload the plugin.
-     * Called on shutdown to gracefully cleanup resources or detach listeners.
-     * @param manager The MagmaStream Manager instance
-     */
-    abstract unload(manager: Manager): void;
-}

package/dist/structures/Rest.d.ts

@@ -1,95 +0,0 @@
-import { Node } from "./Node";
-import { Manager } from "./Manager";
-import { LavalinkSession, LavaPlayer, RestPlayOptions } from "./Types";
-/** Handles the requests sent to the Lavalink REST API. */
-export declare class Rest {
-    /** The Node that this Rest instance is connected to. */
-    private node;
-    /** The password for the Node. */
-    private readonly password;
-    /** The URL of the Node. */
-    private readonly url;
-    /** The Manager instance. */
-    manager: Manager;
-    /** Whether the node is a NodeLink. */
-    isNodeLink: boolean;
-    constructor(node: Node, manager: Manager);
-    /**
-     * Gets the session ID.
-     * @returns {string} Returns the session ID.
-     */
-    private get sessionId();
-    /**
-     * Sets the session ID.
-     * This method is used to set the session ID after a resume operation is done.
-     * @param {string} sessionId The session ID to set.
-     * @returns {string} Returns the set session ID.
-     */
-    setSessionId(sessionId: string): string;
-    /**
-     * Retrieves the player that is currently running on the node.
-     * @param {string} guildId The guild ID of the player to retrieve.
-     * @returns {Promise<LavaPlayer>} Returns the player.
-     */
-    getPlayer(guildId: string): Promise<LavaPlayer>;
-    /**
-     * Sends a PATCH request to update player related data.
-     * @param {RestPlayOptions} options The options to update the player with.
-     * @returns {Promise<LavaPlayer>} Returns the updated player.
-     */
-    updatePlayer(options: RestPlayOptions): Promise<LavaPlayer>;
-    /**
-     * Sends a DELETE request to the server to destroy the player.
-     * @param {string} guildId The guild ID of the player to destroy.
-     * @returns {Promise<void>} Returns void (204 No Content).
-     */
-    destroyPlayer(guildId: string): Promise<void>;
-    /**
-     * Updates the session status for resuming.
-     * @param {boolean} resuming - Indicates whether the session should be set to resuming.
-     * @param {number} timeout - The timeout duration for the session resume.
-     * @returns {Promise<LavalinkSession>} The updated session.
-     */
-    updateSession(resuming: boolean, timeout: number): Promise<LavalinkSession>;
-    /**
-     * Sends a request to the specified endpoint and returns the response data.
-     * @param {string} method The HTTP method to use for the request.
-     * @param {string} endpoint The endpoint to send the request to.
-     * @param {unknown} [body] The data to send in the request body.
-     * @returns {Promise<unknown>} The response data of the request.
-     */
-    private request;
-    /**
-     * Sends a GET request to the specified endpoint and returns the response data.
-     * @param {string} endpoint The endpoint to send the GET request to.
-     * @returns {Promise<T>} The response data of the GET request.
-     */
-    get<T>(endpoint: string): Promise<T>;
-    /**
-     * Sends a PATCH request to the specified endpoint and returns the response data.
-     * @param {string} endpoint The endpoint to send the PATCH request to.
-     * @param {unknown} body The data to send in the request body.
-     * @returns {Promise<T>} The response data of the PATCH request.
-     */
-    patch<T>(endpoint: string, body: unknown): Promise<T>;
-    /**
-     * Sends a POST request to the specified endpoint and returns the response data.
-     * @param {string} endpoint The endpoint to send the POST request to.
-     * @param {unknown} body The data to send in the request body.
-     * @returns {Promise<T>} The response data of the POST request.
-     */
-    post<T>(endpoint: string, body: unknown): Promise<T>;
-    /**
-     * Sends a PUT request to the specified endpoint and returns the response data.
-     * @param {string} endpoint The endpoint to send the PUT request to.
-     * @param {unknown} body The data to send in the request body.
-     * @returns {Promise<T>} The response data of the PUT request.
-     */
-    put<T>(endpoint: string, body: unknown): Promise<T>;
-    /**
-     * Sends a DELETE request to the specified endpoint.
-     * @param {string} endpoint - The endpoint to send the DELETE request to.
-     * @returns {Promise<void>} Void.
-     */
-    delete(endpoint: string): Promise<void>;
-}