for-modules 1.1.4 → 1.1.6

package/dist/Structures/Player.d.ts

@@ -1,250 +0,0 @@
-import { Filters } from "./Filters";
-import { Manager, SearchQuery, SearchResult } from "./Manager";
-import { Node } from "./Node";
-import { Queue } from "./Queue";
-import { Sizes, State, TrackSourceName, VoiceState } from "./Utils";
-import { ClientUser, Message, User } from "discord.js";
-export declare class Player {
-    options: PlayerOptions;
-    /** The Queue for the Player. */
-    readonly queue: Queue;
-    /** 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 for the player. */
-    guild: string;
-    /** The voice channel for the player. */
-    voiceChannel: string | null;
-    /** The text channel for the player. */
-    textChannel: string | null;
-    /**The now playing message. */
-    nowPlayingMessage?: Message;
-    /** The current state of the player. */
-    state: State;
-    /** The equalizer bands array. */
-    bands: number[];
-    /** The voice state object from Discord. */
-    voiceState: VoiceState;
-    /** The Manager. */
-    manager: Manager;
-    /** The autoplay state of the player. */
-    isAutoplay: boolean;
-    private static _manager;
-    private readonly data;
-    private dynamicLoopInterval;
-    /**
-     * Set custom data.
-     * @param key
-     * @param value
-     */
-    set(key: string, value: unknown): void;
-    /**
-     * Get custom data.
-     * @param key
-     */
-    get<T>(key: string): T;
-    /** @hidden */
-    static init(manager: Manager): void;
-    /**
-     * Creates a new player, returns one if it already exists.
-     * @param options
-     */
-    constructor(options: PlayerOptions);
-    /**
-     * Same as Manager#search() but a shortcut on the player itself.
-     * @param query
-     * @param requester
-     */
-    search(query: string | SearchQuery, requester?: User | ClientUser): Promise<SearchResult>;
-    /** Connect to the voice channel. */
-    connect(): this;
-    /**
-     * Moves the player to a different node.
-     *
-     * @param {string} [node] - The ID of the node to move to.
-     * @returns {this} - The player instance.
-     */
-    moveNode(node?: string): Promise<this>;
-    /** Disconnect from the voice channel. */
-    disconnect(): this;
-    /** Destroys the player. */
-    destroy(disconnect?: boolean): void;
-    /**
-     * Sets the player voice channel.
-     * @param channel
-     */
-    setVoiceChannel(channel: string): this;
-    /**
-     * Sets the player text channel.
-     * @param channel
-     */
-    setTextChannel(channel: string): this;
-    /** Sets the now playing message. */
-    setNowPlayingMessage(message: Message): Message;
-    /** Plays the next track. */
-    play(): Promise<void>;
-    /**
-     * Plays the specified track.
-     * @param track
-     */
-    play(track: Track | UnresolvedTrack): Promise<void>;
-    /**
-     * Plays the next track with some options.
-     * @param options
-     */
-    play(options: PlayOptions): Promise<void>;
-    /**
-     * Plays the specified track with some options.
-     * @param track
-     * @param options
-     */
-    play(track: Track | UnresolvedTrack, options: PlayOptions): Promise<void>;
-    /**
-     * Sets the autoplay-state of the player.
-     * @param autoplayState
-     * @param botUser
-     */
-    setAutoplay(autoplayState: boolean, botUser: object): this;
-    /**
-     * Gets recommended tracks and returns an array of tracks.
-     * @param track
-     * @param requester
-     */
-    getRecommended(track: Track, requester?: User | ClientUser): Promise<Track[]>;
-    /**
-     * Sets the player volume.
-     * @param volume
-     */
-    setVolume(volume: number): this;
-    /**
-     * Sets the track repeat.
-     * @param repeat
-     */
-    setTrackRepeat(repeat: boolean): this;
-    /**
-     * Sets the queue repeat.
-     * @param repeat
-     */
-    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.
-     */
-    setDynamicRepeat(repeat: boolean, ms: number): this;
-    /** Restarts the current track to the start. */
-    restart(): void;
-    /** Stops the current track, optionally give an amount to skip to, e.g 5 would play the 5th song. */
-    stop(amount?: number): this;
-    /**
-     * Pauses the current track.
-     * @param pause
-     */
-    pause(pause: boolean): this;
-    /** Go back to the previous song. */
-    previous(): this;
-    /**
-     * Seeks to the position in the current track.
-     * @param position
-     */
-    seek(position: number): this;
-}
-export interface PlayerOptions {
-    /** The guild the Player belongs to. */
-    guild: string;
-    /** The text channel the Player belongs to. */
-    textChannel: string;
-    /** The voice channel the Player belongs to. */
-    voiceChannel?: string;
-    /** The node the Player uses. */
-    node?: string;
-    /** The initial volume the Player will use. */
-    volume?: number;
-    /** If the player should mute itself. */
-    selfMute?: boolean;
-    /** If the player should deaf itself. */
-    selfDeafen?: boolean;
-}
-/** If track partials are set some of these will be `undefined` as they were removed. */
-export interface Track {
-    /** The base64 encoded track. */
-    readonly track: string;
-    /** The artwork url of the track. */
-    readonly artworkUrl: string;
-    /** The track source name. */
-    readonly sourceName: TrackSourceName;
-    /** The title of the track. */
-    title: string;
-    /** The identifier of the track. */
-    readonly identifier: string;
-    /** The author of the track. */
-    author: string;
-    /** The duration of the track. */
-    readonly duration: number;
-    /** The ISRC of the track. */
-    readonly isrc: string;
-    /** If the track is seekable. */
-    readonly isSeekable: boolean;
-    /** If the track is a stream.. */
-    readonly isStream: boolean;
-    /** The uri of the track. */
-    readonly uri: string;
-    /** The thumbnail of the track or null if it's a unsupported source. */
-    readonly thumbnail: string | null;
-    /** The user that requested the track. */
-    readonly requester: User | ClientUser | null;
-    /** Displays the track thumbnail with optional size or null if it's a unsupported source. */
-    displayThumbnail(size?: Sizes): string;
-    /** Additional track info provided by plugins. */
-    pluginInfo: TrackPluginInfo;
-    /** Add your own data to the track. */
-    customData: Record<string, unknown>;
-}
-export interface TrackPluginInfo {
-    albumName?: string;
-    albumUrl?: string;
-    artistArtworkUrl?: string;
-    artistUrl?: string;
-    isPreview?: string;
-    previewUrl?: string;
-}
-/** Unresolved tracks can't be played normally, they will resolve before playing into a Track. */
-export interface UnresolvedTrack extends Partial<Track> {
-    /** The title to search against. */
-    title: string;
-    /** The author to search against. */
-    author?: string;
-    /** The duration to search within 1500 milliseconds of the results from YouTube. */
-    duration?: number;
-    /** Resolves into a Track. */
-    resolve(): Promise<void>;
-}
-export interface PlayOptions {
-    /** The position to start the track. */
-    readonly startTime?: number;
-    /** The position to end the track. */
-    readonly endTime?: number;
-    /** Whether to not replace the track if a play payload is sent. */
-    readonly noReplace?: boolean;
-}
-export interface EqualizerBand {
-    /** The band number being 0 to 14. */
-    band: number;
-    /** The gain amount being -0.25 to 1.00, 0.25 being double. */
-    gain: number;
-}

package/dist/Structures/Queue.d.ts

@@ -1,38 +0,0 @@
-import { Track, UnresolvedTrack } from "./Player";
-/**
- * The player's queue, the `current` property is the currently playing track, think of the rest as the up-coming tracks.
- */
-export declare class Queue extends Array<Track | UnresolvedTrack> {
-    /** The total duration of the queue. */
-    get duration(): number;
-    /** The total size of tracks in the queue including the current track. */
-    get totalSize(): number;
-    /** The size of tracks in the queue. */
-    get size(): number;
-    /** The current track */
-    current: Track | UnresolvedTrack | null;
-    /** The previous track */
-    previous: Track | UnresolvedTrack | null;
-    /**
-     * Adds a track to the queue.
-     * @param track
-     * @param [offset=null]
-     */
-    add(track: (Track | UnresolvedTrack) | (Track | UnresolvedTrack)[], offset?: number): void;
-    /**
-     * Removes a track from the queue. Defaults to the first track, returning the removed track, EXCLUDING THE `current` TRACK.
-     * @param [position=0]
-     */
-    remove(position?: number): (Track | UnresolvedTrack)[];
-    /**
-     * Removes an amount of tracks using a exclusive start and end exclusive index, returning the removed tracks, EXCLUDING THE `current` TRACK.
-     * @param start
-     * @param end
-     */
-    remove(start: number, end: number): (Track | UnresolvedTrack)[];
-    /** Clears the queue. */
-    clear(): void;
-    /** Shuffles the queue. */
-    shuffle(): void;
-    equalizedShuffle(): void;
-}

package/dist/Structures/Rest.d.ts

@@ -1,60 +0,0 @@
-import { Node } from "./Node";
-/** 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 ID of the current session. */
-    private sessionId;
-    /** The password for the Node. */
-    private readonly password;
-    /** The URL of the Node. */
-    private readonly url;
-    constructor(node: Node);
-    /**
-     * Sets the session ID.
-     * @returns {string} Returns the session ID.
-     */
-    setSessionId(sessionId: string): string;
-    /** Retrieves all the players that are currently running on the node. */
-    getAllPlayers(): Promise<unknown>;
-    /** Sends a PATCH request to update player related data. */
-    updatePlayer(options: playOptions): Promise<unknown>;
-    /** Sends a DELETE request to the server to destroy the player. */
-    destroyPlayer(guildId: string): Promise<unknown>;
-    private request;
-    get(endpoint: string): Promise<unknown>;
-    patch(endpoint: string, body: unknown): Promise<unknown>;
-    post(endpoint: string, body: unknown): Promise<unknown>;
-    delete(endpoint: string): Promise<unknown>;
-}
-interface playOptions {
-    guildId: string;
-    data: {
-        /** The base64 encoded track. */
-        encodedTrack?: string;
-        /** The track ID. */
-        identifier?: string;
-        /** The track time to start at. */
-        startTime?: number;
-        /** The track time to end at. */
-        endTime?: number;
-        /** The player volume level. */
-        volume?: number;
-        /** The player position in a track. */
-        position?: number;
-        /** Whether the player is paused. */
-        paused?: boolean;
-        /** The audio effects. */
-        filters?: object;
-        /** voice payload. */
-        voice?: {
-            token: string;
-            sessionId: string;
-            endpoint: string;
-        };
-        /** Whether to not replace the track if a play payload is sent. */
-        noReplace?: boolean;
-    };
-}
-export type Method = "GET" | "POST" | "PATCH" | "DELETE";
-export {};

package/dist/Structures/Utils.d.ts

@@ -1,174 +0,0 @@
-import { ClientUser, User } from "discord.js";
-import { Manager } from "./Manager";
-import { Node, NodeStats } from "./Node";
-import { Player, Track, UnresolvedTrack } from "./Player";
-import { Queue } from "./Queue";
-export declare abstract class TrackUtils {
-    static trackPartial: string[] | null;
-    private static manager;
-    /** @hidden */
-    static init(manager: Manager): void;
-    static setTrackPartial(partial: string[]): void;
-    /**
-     * Checks if the provided argument is a valid Track or UnresolvedTrack, if provided an array then every element will be checked.
-     * @param trackOrTracks
-     */
-    static validate(trackOrTracks: unknown): boolean;
-    /**
-     * Checks if the provided argument is a valid UnresolvedTrack.
-     * @param track
-     */
-    static isUnresolvedTrack(track: unknown): boolean;
-    /**
-     * Checks if the provided argument is a valid Track.
-     * @param track
-     */
-    static isTrack(track: unknown): boolean;
-    /**
-     * Builds a Track from the raw data from Lavalink and a optional requester.
-     * @param data
-     * @param requester
-     */
-    static build(data: TrackData, requester?: User | ClientUser): Track;
-    /**
-     * Builds a UnresolvedTrack to be resolved before being played  .
-     * @param query
-     * @param requester
-     */
-    static buildUnresolved(query: string | UnresolvedQuery, requester?: User | ClientUser): UnresolvedTrack;
-    static getClosestTrack(unresolvedTrack: UnresolvedTrack): Promise<Track>;
-}
-/** Gets or extends structures to extend the built in, or already extended, classes to add more functionality. */
-export declare abstract class Structure {
-    /**
-     * Extends a class.
-     * @param name
-     * @param extender
-     */
-    static extend<K extends keyof Extendable, T extends Extendable[K]>(name: K, extender: (target: Extendable[K]) => T): T;
-    /**
-     * Get a structure from available structures by name.
-     * @param name
-     */
-    static get<K extends keyof Extendable>(name: K): Extendable[K];
-}
-export declare class Plugin {
-    load(manager: Manager): void;
-    unload(manager: Manager): void;
-}
-export interface UnresolvedQuery {
-    /** The title of the unresolved track. */
-    title: string;
-    /** The author of the unresolved track. If provided it will have a more precise search. */
-    author?: string;
-    /** The duration of the unresolved track. If provided it will have a more precise search. */
-    duration?: number;
-}
-export type Sizes = "0" | "1" | "2" | "3" | "default" | "mqdefault" | "hqdefault" | "maxresdefault";
-export type LoadType = "track" | "playlist" | "search" | "empty" | "error";
-export type State = "CONNECTED" | "CONNECTING" | "DISCONNECTED" | "DISCONNECTING" | "DESTROYING" | "MOVING";
-export type PlayerEvents = TrackStartEvent | TrackEndEvent | TrackStuckEvent | TrackExceptionEvent | WebSocketClosedEvent;
-export type PlayerEventType = "TrackStartEvent" | "TrackEndEvent" | "TrackExceptionEvent" | "TrackStuckEvent" | "WebSocketClosedEvent";
-export type TrackEndReason = "finished" | "loadFailed" | "stopped" | "replaced" | "cleanup";
-export type Severity = "common" | "suspicious" | "fault";
-export interface TrackData {
-    /** The track information. */
-    encoded: string;
-    /** The detailed information of the track. */
-    info: TrackDataInfo;
-    /** Additional track info provided by plugins. */
-    pluginInfo: Record<string, string>;
-}
-export interface TrackDataInfo {
-    identifier: string;
-    isSeekable: boolean;
-    author: string;
-    length: number;
-    isrc?: string;
-    isStream: boolean;
-    title: string;
-    uri?: string;
-    artworkUrl?: string;
-    sourceName?: TrackSourceName;
-}
-export type TrackSourceName = "deezer" | "spotify" | "soundcloud" | "youtube";
-export interface Extendable {
-    Player: typeof Player;
-    Queue: typeof Queue;
-    Node: typeof Node;
-}
-export interface VoiceState {
-    op: "voiceUpdate";
-    guildId: string;
-    event: VoiceServer;
-    sessionId?: string;
-}
-export interface VoiceServer {
-    token: string;
-    guild_id: string;
-    endpoint: string;
-}
-export interface VoiceState {
-    guild_id: string;
-    user_id: string;
-    session_id: string;
-    channel_id: 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;
-}
-export interface PlayerEvent {
-    op: "event";
-    type: PlayerEventType;
-    guildId: string;
-}
-export interface Exception {
-    message: string;
-    severity: Severity;
-    cause: string;
-}
-export interface TrackStartEvent extends PlayerEvent {
-    type: "TrackStartEvent";
-    track: TrackData;
-}
-export interface TrackEndEvent extends PlayerEvent {
-    type: "TrackEndEvent";
-    track: TrackData;
-    reason: TrackEndReason;
-}
-export interface TrackExceptionEvent extends PlayerEvent {
-    exception?: Exception;
-    guildId: string;
-    type: "TrackExceptionEvent";
-}
-export interface TrackStuckEvent extends PlayerEvent {
-    type: "TrackStuckEvent";
-    thresholdMs: number;
-}
-export interface WebSocketClosedEvent extends PlayerEvent {
-    type: "WebSocketClosedEvent";
-    code: number;
-    reason: string;
-    byRemote: boolean;
-}
-export interface PlayerUpdate {
-    op: "playerUpdate";
-    /** The guild id of the player. */
-    guildId: string;
-    state: {
-        /** Unix timestamp in milliseconds. */
-        time: number;
-        /** The position of the track in milliseconds. */
-        position: number;
-        /** Whether Lavalink is connected to the voice gateway. */
-        connected: boolean;
-        /** The ping of the node to the Discord voice server in milliseconds (-1 if not connected). */
-        ping: number;
-    };
-}

package/dist/Utils/FiltersEqualizers.d.ts

@@ -1,12 +0,0 @@
-/** Represents an equalizer band. */
-export interface Band {
-    /** The index of the equalizer band. */
-    band: number;
-    /** The gain value of the equalizer band. */
-    gain: number;
-}
-export declare const bassBoostEqualizer: Band[];
-export declare const softEqualizer: Band[];
-export declare const tvEqualizer: Band[];
-export declare const trebleBassEqualizer: Band[];
-export declare const vaporwaveEqualizer: Band[];

package/dist/Utils/ManagerCheck.d.ts

@@ -1,2 +0,0 @@
-import { ManagerOptions } from "../Structures/Manager";
-export default function ManagerCheck(options: ManagerOptions): void;

package/dist/Utils/NodeCheck.d.ts

@@ -1,2 +0,0 @@
-import { NodeOptions } from "../Structures/Node";
-export default function NodeCheck(options: NodeOptions): void;

package/dist/Utils/PlayerCheck.d.ts

@@ -1,2 +0,0 @@
-import { PlayerOptions } from "../Structures/Player";
-export default function PlayerCheck(options: PlayerOptions): void;

package/dist/index.d.ts

@@ -1,11 +0,0 @@
-export * from "./Structures/Manager";
-export * from "./Structures/Node";
-export * from "./Structures/Player";
-export * from "./Structures/Queue";
-export * from "./Structures/Utils";
-export * from "./Structures/Filters";
-export * from "./Structures/Rest";
-export * from "./Utils/FiltersEqualizers";
-export * from "./Utils/ManagerCheck";
-export * from "./Utils/NodeCheck";
-export * from "./Utils/PlayerCheck";