distube 4.0.0-dev.0 → 4.0.0-dev.3

package/dist/struct/Plugin.js

@@ -1,99 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Plugin = void 0;
-/**
- * DisTube Plugin
- * @abstract
- * @private
- */
-class Plugin {
-    init(distube) {
-        /**
-         * DisTube
-         * @type {DisTube}
-         */
-        this.distube = distube;
-    }
-    /**
-     * Type of the plugin
-     * @name Plugin#type
-     * @type {PluginType}
-     */
-    /**
-     * Emit the {@link DisTube} of this base
-     * @param {string} eventName Event name
-     * @param {...any} args arguments
-     * @returns {boolean}
-     */
-    emit(eventName, ...args) {
-        return this.distube.emit(eventName, ...args);
-    }
-    /**
-     * Emit error event
-     * @param {Error} error error
-     * @param {Discord.BaseGuildTextChannel} [channel] Text channel where the error is encountered.
-     */
-    emitError(error, channel) {
-        this.distube.emitError(error, channel);
-    }
-    /**
-     * The queue manager
-     * @type {QueueManager}
-     * @readonly
-     */
-    get queues() {
-        return this.distube.queues;
-    }
-    /**
-     * The voice manager
-     * @type {DisTubeVoiceManager}
-     * @readonly
-     */
-    get voices() {
-        return this.distube.voices;
-    }
-    /**
-     * Discord.js client
-     * @type {Discord.Client}
-     * @readonly
-     */
-    get client() {
-        return this.distube.client;
-    }
-    /**
-     * DisTube options
-     * @type {DisTubeOptions}
-     * @readonly
-     */
-    get options() {
-        return this.distube.options;
-    }
-    /**
-     * DisTube handler
-     * @type {DisTubeHandler}
-     * @readonly
-     */
-    get handler() {
-        return this.distube.handler;
-    }
-    /**
-     * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
-     * Not needed if the plugin plays song from YouTube.
-     * @param {string} url Input url
-     * @returns {string|Promise<string>}
-     */
-    getStreamURL(url) {
-        return url;
-    }
-    /**
-     * Get related songs from a supported url. {@link Song#member} should be `undefined`.
-     * Not needed to add {@link Song#related} because it will be added with this function later.
-     * @param {string} url Input url
-     * @returns {Song[]|Promise<Song[]>}
-     */
-    getRelatedSongs(url) {
-        return [];
-    }
-}
-exports.Plugin = Plugin;
-//# sourceMappingURL=Plugin.js.map

package/dist/struct/Plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../../src/struct/Plugin.ts"],"names":[],"mappings":";;;AAcA;;;;GAIG;AACH,MAAsB,MAAM;IAG1B,IAAI,CAAC,OAAgB;QACnB;;;WAGG;QACH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IACD;;;;OAIG;IACH;;;;;OAKG;IACH,IAAI,CAAC,SAA8B,EAAE,GAAG,IAAS;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IAC/C,CAAC;IACD;;;;OAIG;IACH,SAAS,CAAC,KAAY,EAAE,OAA+B;QACrD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IACD;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IACD;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IACD;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IACD;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IACD;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IACD;;;;;OAKG;IACH,YAAY,CAAC,GAAW;QACtB,OAAO,GAAG,CAAC;IACb,CAAC;IACD;;;;;OAKG;IACH,eAAe,CAAC,GAAW;QACzB,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AA1FD,wBA0FC","sourcesContent":["/* eslint-disable  @typescript-eslint/no-unused-vars */\nimport type { Client, GuildTextBasedChannel } from \"discord.js\";\nimport type {\n  Awaitable,\n  DisTube,\n  DisTubeEvents,\n  DisTubeHandler,\n  DisTubeVoiceManager,\n  Options,\n  PluginType,\n  QueueManager,\n  RelatedSong,\n} from \"..\";\n\n/**\n * DisTube Plugin\n * @abstract\n * @private\n */\nexport abstract class Plugin {\n  type!: PluginType;\n  distube!: DisTube;\n  init(distube: DisTube) {\n    /**\n     * DisTube\n     * @type {DisTube}\n     */\n    this.distube = distube;\n  }\n  /**\n   * Type of the plugin\n   * @name Plugin#type\n   * @type {PluginType}\n   */\n  /**\n   * Emit the {@link DisTube} of this base\n   * @param {string} eventName Event name\n   * @param {...any} args arguments\n   * @returns {boolean}\n   */\n  emit(eventName: keyof DisTubeEvents, ...args: any): boolean {\n    return this.distube.emit(eventName, ...args);\n  }\n  /**\n   * Emit error event\n   * @param {Error} error error\n   * @param {Discord.BaseGuildTextChannel} [channel] Text channel where the error is encountered.\n   */\n  emitError(error: Error, channel?: GuildTextBasedChannel) {\n    this.distube.emitError(error, channel);\n  }\n  /**\n   * The queue manager\n   * @type {QueueManager}\n   * @readonly\n   */\n  get queues(): QueueManager {\n    return this.distube.queues;\n  }\n  /**\n   * The voice manager\n   * @type {DisTubeVoiceManager}\n   * @readonly\n   */\n  get voices(): DisTubeVoiceManager {\n    return this.distube.voices;\n  }\n  /**\n   * Discord.js client\n   * @type {Discord.Client}\n   * @readonly\n   */\n  get client(): Client {\n    return this.distube.client;\n  }\n  /**\n   * DisTube options\n   * @type {DisTubeOptions}\n   * @readonly\n   */\n  get options(): Options {\n    return this.distube.options;\n  }\n  /**\n   * DisTube handler\n   * @type {DisTubeHandler}\n   * @readonly\n   */\n  get handler(): DisTubeHandler {\n    return this.distube.handler;\n  }\n  /**\n   * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.\n   * Not needed if the plugin plays song from YouTube.\n   * @param {string} url Input url\n   * @returns {string|Promise<string>}\n   */\n  getStreamURL(url: string): Awaitable<string> {\n    return url;\n  }\n  /**\n   * Get related songs from a supported url. {@link Song#member} should be `undefined`.\n   * Not needed to add {@link Song#related} because it will be added with this function later.\n   * @param {string} url Input url\n   * @returns {Song[]|Promise<Song[]>}\n   */\n  getRelatedSongs(url: string): Awaitable<RelatedSong[]> {\n    return [];\n  }\n}\n"]}

package/dist/struct/Queue.d.ts

@@ -1,216 +0,0 @@
-/// <reference types="node" />
-import { DisTubeBase } from "../core";
-import { RepeatMode, Song, TaskQueue } from "..";
-import type { DisTube, DisTubeVoice, DisTubeVoiceEvents } from "..";
-import type { GuildMember, GuildTextBasedChannel, Snowflake } from "discord.js";
-/**
- * Represents a queue.
- * @extends DisTubeBase
- */
-export declare class Queue extends DisTubeBase {
-    readonly id: Snowflake;
-    /**
-     * Voice connection of this queue
-     */
-    voice: DisTubeVoice;
-    /**
-     * List of songs in the queue (The first one is the playing song)
-     */
-    songs: Song[];
-    /**
-     * List of the previous songs.
-     */
-    previousSongs: Song[];
-    /**
-     * Whether stream is currently stopped.
-     * @private
-     */
-    stopped: boolean;
-    /**
-     * Whether or not the last song was skipped to next song.
-     * @private
-     */
-    next: boolean;
-    /**
-     * Whether or not the last song was skipped to previous song.
-     * @private
-     */
-    prev: boolean;
-    /**
-     * Whether or not the stream is currently playing.
-     */
-    playing: boolean;
-    /**
-     * Whether or not the stream is currently paused.
-     */
-    paused: boolean;
-    /**
-     * Type of repeat mode (`0` is disabled, `1` is repeating a song, `2` is repeating all the queue).
-     * Default value: `0` (disabled)
-     */
-    repeatMode: RepeatMode;
-    /**
-     * Whether or not the autoplay mode is enabled.
-     * Default value: `false`
-     */
-    autoplay: boolean;
-    /**
-     * Enabled audio filters.
-     * Available filters: {@link Filters}
-     */
-    filters: string[];
-    /**
-     * What time in the song to begin (in seconds).
-     */
-    beginTime: number;
-    /**
-     * The text channel of the Queue. (Default: where the first command is called).
-     */
-    textChannel?: GuildTextBasedChannel;
-    /**
-     * Timeout for checking empty channel
-     * @private
-     */
-    emptyTimeout?: NodeJS.Timeout;
-    /**
-     * The client user as a `GuildMember` of this queue's guild
-     */
-    clientMember: GuildMember;
-    /**
-     * Task queuing system
-     */
-    taskQueue: TaskQueue;
-    listeners?: DisTubeVoiceEvents;
-    /**
-     * Create a queue for the guild
-     * @param {DisTube} distube DisTube
-     * @param {DisTubeVoice} voice Voice connection
-     * @param {Song|Song[]} song First song(s)
-     * @param {Discord.BaseGuildTextChannel?} textChannel Default text channel
-     */
-    constructor(distube: DisTube, voice: DisTubeVoice, song: Song | Song[], textChannel?: GuildTextBasedChannel);
-    /**
-     * Formatted duration string.
-     * @type {string}
-     */
-    get formattedDuration(): string;
-    /**
-     * Queue's duration.
-     * @type {number}
-     */
-    get duration(): number;
-    /**
-     * What time in the song is playing (in seconds).
-     * @type {number}
-     */
-    get currentTime(): number;
-    /**
-     * Formatted {@link Queue#currentTime} string.
-     * @type {string}
-     */
-    get formattedCurrentTime(): string;
-    /**
-     * The voice channel playing in.
-     * @type {Discord.VoiceChannel|Discord.StageChannel|null}
-     */
-    get voiceChannel(): import("discord.js").VoiceBasedChannel | null;
-    get volume(): number;
-    set volume(value: number);
-    /**
-     * @private
-     * Add a Song or an array of Song to the queue
-     * @param {Song|Song[]} song Song to add
-     * @param {number} [position=0] Position to add, <= 0 to add to the end of the queue
-     * @throws {Error}
-     * @returns {Queue} The guild queue
-     */
-    addToQueue(song: Song | Song[], position?: number): Queue;
-    /**
-     * Pause the guild stream
-     * @returns {Queue} The guild queue
-     */
-    pause(): Queue;
-    /**
-     * Resume the guild stream
-     * @returns {Queue} The guild queue
-     */
-    resume(): Queue;
-    /**
-     * Set the guild stream's volume
-     * @param {number} percent The percentage of volume you want to set
-     * @returns {Queue} The guild queue
-     */
-    setVolume(percent: number): Queue;
-    /**
-     * Skip the playing song if there is a next song in the queue.
-     * <info>If {@link Queue#autoplay} is `true` and there is no up next song,
-     * DisTube will add and play a related song.</info>
-     * @returns {Promise<Song>} The song will skip to
-     * @throws {Error}
-     */
-    skip(): Promise<Song>;
-    /**
-     * Play the previous song if exists
-     * @returns {Song} The guild queue
-     * @throws {Error}
-     */
-    previous(): Promise<Song>;
-    /**
-     * Shuffle the queue's songs
-     * @returns {Promise<Queue>} The guild queue
-     */
-    shuffle(): Promise<Queue>;
-    /**
-     * Jump to the song position in the queue.
-     * The next one is 1, 2,...
-     * The previous one is -1, -2,...
-     * @param {number} position The song position to play
-     * @returns {Promise<Queue>} The guild queue
-     * @throws {Error} if `num` is invalid number
-     */
-    jump(position: number): Promise<Queue>;
-    /**
-     * Set the repeat mode of the guild queue.\
-     * Toggle mode `(Disabled -> Song -> Queue -> Disabled ->...)` if `mode` is `undefined`
-     * @param {RepeatMode?} [mode] The repeat modes (toggle if `undefined`)
-     * @returns {RepeatMode} The new repeat mode
-     */
-    setRepeatMode(mode?: RepeatMode): RepeatMode;
-    /**
-     * Enable or disable filter(s) of the queue.
-     * Available filters: {@link Filters}
-     * @param {string|string[]|false} filter A filter name, an array of filter name or `false` to clear all the filters
-     * @param {boolean} [force=false] Force enable the input filter(s) even if it's enabled
-     * @returns {Array<string>} Enabled filters.
-     * @throws {Error}
-     */
-    setFilter(filter: string | string[] | false, force?: boolean): Array<string>;
-    /**
-     * Set the playing time to another position
-     * @param {number} time Time in seconds
-     * @returns {Queue} The guild queue
-     */
-    seek(time: number): Queue;
-    /**
-     * Add a related song of the playing song to the queue
-     * @returns {Promise<Song>} The added song
-     * @throws {Error}
-     */
-    addRelatedSong(): Promise<Song>;
-    /**
-     * Stop the guild stream and delete the queue
-     */
-    stop(): Promise<void>;
-    /**
-     * Delete the queue from the manager
-     * (This does not leave the voice channel even if {@link DisTubeOptions|DisTubeOptions.leaveOnStop} is enabled)
-     * @private
-     */
-    delete(): void;
-    /**
-     * Toggle autoplay mode
-     * @returns {boolean} Autoplay mode state
-     */
-    toggleAutoplay(): boolean;
-}
-//# sourceMappingURL=Queue.d.ts.map

package/dist/struct/Queue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Queue.d.ts","sourceRoot":"","sources":["../../src/struct/Queue.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAgB,UAAU,EAAE,IAAI,EAAE,SAAS,EAAkB,MAAM,IAAI,CAAC;AAC/E,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,IAAI,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEhF;;;GAGG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;IACpB;;OAEG;IACH,KAAK,EAAE,IAAI,EAAE,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,IAAI,EAAE,CAAC;IACtB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,qBAAqB,CAAC;IACpC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAC9B;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B;;;;;;OAMG;gBACS,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,EAAE,WAAW,CAAC,EAAE,qBAAqB;IA+G3G;;;OAGG;IACH,IAAI,iBAAiB,WAEpB;IACD;;;OAGG;IACH,IAAI,QAAQ,WAEX;IACD;;;OAGG;IACH,IAAI,WAAW,WAEd;IACD;;;OAGG;IACH,IAAI,oBAAoB,WAEvB;IACD;;;OAGG;IACH,IAAI,YAAY,kDAEf;IACD,IAAI,MAAM,IAGQ,MAAM,CADvB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IACD;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,EAAE,QAAQ,SAAI,GAAG,KAAK;IAmBpD;;;OAGG;IACH,KAAK,IAAI,KAAK;IAOd;;;OAGG;IACH,MAAM,IAAI,KAAK;IAOf;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK;IAKjC;;;;;;OAMG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB3B;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB/B;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC;IAe/B;;;;;;;OAOG;IACG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IA4B5C;;;;;OAKG;IACH,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,UAAU;IAS5C;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,KAAK,UAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;IAwB1E;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK;IAOzB;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IASrC;;OAEG;IACG,IAAI;IAWV;;;;OAIG;IACH,MAAM;IAYN;;;OAGG;IACH,cAAc,IAAI,OAAO;CAI1B"}