distube 3.0.0-beta.8 → 3.0.2

package/src/Plugin/ExtractorPlugin.js

@@ -1,25 +0,0 @@
-/* eslint-disable */
-const Plugin = require("./Plugin");
-const Discord = require("discord.js");
-const Song = require("../Song");
-const Playlist = require("../Playlist");
-
-/**
- * Extractor Plugin
- * @extends Plugin
- */
-class ExtractorPlugin extends Plugin {
-  /** Create a extractor plugin */
-  constructor() {
-    super("extractor");
-  }
-  /**
-   * Execute if the url is validated
-   * @param {string} url URL
-   * @param {Discord.GuildMember} member Requested user
-   * @returns {Promise<Song|Song[]|Playlist>}
-   */
-  async resolve(url, member) { }
-}
-
-module.exports = ExtractorPlugin;

package/src/Plugin/Plugin.js

@@ -1,36 +0,0 @@
-/* eslint-disable */
-const DisTube = require("../DisTube");
-
-/**
- * DisTube Plugin
- * @private
- */
-class Plugin {
-  constructor(type) {
-    /**
-     * Type of plugin (`"custom"` | `"extractor"`)
-     * @type {string}
-     */
-    this.type = type;
-  }
-  init(distube) {
-    /**
-     * DisTube
-     * @type {DisTube}
-     */
-    this.distube = distube;
-    /**
-     * Handler
-     * @type {DisTubeHandler}
-     */
-    this.handler = this.distube.handler;
-  }
-  /**
-   * Check if the url is working with this plugin
-   * @param {string} url Input url
-   * @returns {Promise<boolean>}
-   */
-  async validate(url) { return false }
-}
-
-module.exports = Plugin;

package/src/Plugin/http.js

@@ -1,27 +0,0 @@
-const { ExtractorPlugin, Song } = require("../DisTube");
-const http = require("http");
-const { URL } = require("url");
-const getResponseHeaders = url => new Promise((resolve, reject) => {
-  http.get(url)
-    .on("response", res => resolve(res.headers))
-    .on("error", reject);
-});
-
-class HTTPPlugin extends ExtractorPlugin {
-  async validate(url) {
-    if (new URL(url).protocol.toLowerCase() !== "http:") return false;
-    const headers = await getResponseHeaders(url);
-    const type = headers["content-type"];
-    if (type.startsWith("audio")) return true;
-    return false;
-  }
-  resolve(url, member) {
-    url = url.replace(/\/+$/, "");
-    return new Song({
-      name: url.substring(url.lastIndexOf("/") + 1).replace(/((\?|#).*)?$/, ""),
-      url,
-    }, member, "http");
-  }
-}
-
-module.exports = HTTPPlugin;

package/src/Plugin/https.js

@@ -1,27 +0,0 @@
-const { ExtractorPlugin, Song } = require("../DisTube");
-const https = require("https");
-const { URL } = require("url");
-const getResponseHeaders = url => new Promise((resolve, reject) => {
-  https.get(url)
-    .on("response", res => resolve(res.headers))
-    .on("error", reject);
-});
-
-class HTTPSPlugin extends ExtractorPlugin {
-  async validate(url) {
-    if (new URL(url).protocol.toLowerCase() !== "https:") return false;
-    const headers = await getResponseHeaders(url);
-    const type = headers["content-type"];
-    if (type.startsWith("audio")) return true;
-    return false;
-  }
-  resolve(url, member) {
-    url = url.replace(/\/+$/, "");
-    return new Song({
-      name: url.substring(url.lastIndexOf("/") + 1).replace(/((\?|#).*)?$/, ""),
-      url,
-    }, member, "https");
-  }
-}
-
-module.exports = HTTPSPlugin;

package/src/Queue.js

@@ -1,340 +0,0 @@
-const { formatDuration } = require("./util"),
-  Song = require("./Song"),
-  DisTubeBase = require("./DisTubeBase"),
-  // eslint-disable-next-line no-unused-vars
-  Discord = require("discord.js"),
-  // eslint-disable-next-line no-unused-vars
-  { Readable } = require("stream"),
-  // eslint-disable-next-line no-unused-vars
-  DisTubeHandler = require("./DisTubeHandler");
-
-/**
- * Represents a queue.
- * @extends DisTubeBase
- */
-class Queue extends DisTubeBase {
-  constructor(distube, message, song, textChannel = null) {
-    super(distube);
-    /**
-     * Queue id (Guild id)
-     * @type {Discord.Snowflake}
-     */
-    this.id = message.guild.id;
-    /**
-     * Stream dispatcher.
-     * @type {Discord.StreamDispatcher?}
-     */
-    this.dispatcher = null;
-    /**
-     * Voice connection.
-     * @type {Discord.VoiceConnection?}
-     */
-    this.connection = null;
-    /**
-     * Stream volume. Default value: `50`.
-     * @type {number}
-     */
-    this.volume = 50;
-    /**
-     * List of songs in the queue (The first one is the playing song)
-     * @type {Array<Song>}
-     */
-    this.songs = Array.isArray(song) ? song : [song];
-    if (this.options.savePreviousSongs) {
-      /**
-       * List of the previous songs.
-       * @type {Array<Song>?}
-       */
-      this.previousSongs = [];
-    }
-    /**
-     * Whether stream is currently stopped.
-     * @type {boolean}
-     * @private
-     */
-    this.stopped = false;
-    /**
-     * Whether or not the last song was skipped to next song.
-     * @type {boolean}
-     * @private
-     */
-    this.next = false;
-    /**
-     * Whether or not the last song was skipped to previous song.
-     * @type {boolean}
-     * @private
-     */
-    this.prev = false;
-    /**
-     * Whether or not the stream is currently playing.
-     * @type {boolean}
-     */
-    this.playing = true;
-    /**
-     * Whether or not the stream is currently paused.
-     * @type {boolean}
-     */
-    this.paused = false;
-    /**
-     * Type of repeat mode (`0` is disabled, `1` is repeating a song, `2` is repeating all the queue).
-     * Default value: `0` (disabled)
-     * @type {number}
-     */
-    this.repeatMode = 0;
-    /**
-     * Whether or not the autoplay mode is enabled.
-     * Default value: `false`
-     * @type {boolean}
-     */
-    this.autoplay = false;
-    /**
-     * Enabled audio filters.
-     * Available filters: {@link Filters}
-     * @type {Array<string>}
-     */
-    this.filters = [];
-    /**
-     * Should be an opus stream
-     * @type {Readable?}
-     * @private
-     */
-    this.stream = null;
-    /**
-     * What time in the song to begin (in seconds).
-     * @type {number}
-     */
-    this.beginTime = 0;
-    /**
-     * The text channel of the Queue. (Default: where the first command is called).
-     * @type {Discord.TextChannel?}
-     */
-    this.textChannel = message?.channel || textChannel;
-    /**
-     * @type {DisTubeHandler}
-     * @private
-     */
-    this.handler = this.distube.handler;
-    /**
-     * Timeout for checking empty channel
-     * @type {NodeJS.Timeout?}
-     * @private
-     */
-    this.emptyTimeout = null;
-  }
-  /**
-   * Formatted duration string.
-   * @type {string}
-   */
-  get formattedDuration() {
-    return formatDuration(this.duration);
-  }
-  /**
-   * Queue's duration.
-   * @type {number}
-   */
-  get duration() {
-    return this.songs.length ? this.songs.reduce((prev, next) => prev + next.duration, 0) : 0;
-  }
-  /**
-   * What time in the song is playing (in seconds).
-   * @type {number}
-   */
-  get currentTime() {
-    return this.dispatcher ? (this.dispatcher.streamTime / 1000) + this.beginTime : 0;
-  }
-  /**
-   * Formatted {@link Queue#currentTime} string.
-   * @type {string}
-   */
-  get formattedCurrentTime() {
-    return formatDuration(this.currentTime);
-  }
-  /**
-   * The voice channel playing in.
-   * @type {Discord.VoiceChannel|Discord.StageChannel}
-   */
-  get voiceChannel() {
-    return this.connection?.voice?.channel;
-  }
-  /**
-   * Add a Song or an array of Song to the queue
-   * @param {Song|Array<Song>} song Song to add
-   * @param {boolean} [unshift=false] Unshift?
-   * @throws {Error}
-   * @returns {Queue}
-   */
-  addToQueue(song, unshift = false) {
-    const isArray = Array.isArray(song);
-    if (!song || (isArray && !song.length)) throw new Error("No Song provided.");
-    if (unshift) {
-      const playing = this.songs.shift();
-      if (isArray) this.songs.unshift(playing, ...song);
-      else this.songs.unshift(playing, song);
-    } else if (isArray) this.songs.push(...song);
-    else this.songs.push(song);
-    return this;
-  }
-  /**
-   * Pause the guild stream
-   * @returns {Queue} The guild queue
-   */
-  pause() {
-    this.playing = false;
-    this.paused = true;
-    this.dispatcher.pause();
-    return this;
-  }
-  /**
-   * Resume the guild stream
-   * @returns {Queue} The guild queue
-   */
-  resume() {
-    this.playing = true;
-    this.paused = false;
-    this.dispatcher.resume();
-    return this;
-  }
-  /**
-   * Stop the guild stream
-   */
-  stop() {
-    this.stopped = true;
-    try { this.dispatcher?.end() } catch { }
-    if (this.options.leaveOnStop) try { this.connection?.channel?.leave() } catch { }
-  }
-  /**
-   * Set the guild stream's volume
-   * @param {number} percent The percentage of volume you want to set
-   * @returns {Queue} The guild queue
-   */
-  setVolume(percent) {
-    if (typeof percent !== "number") throw new Error("Volume percent must be a number.");
-    this.volume = percent;
-    this.dispatcher.setVolume(this.volume / 100);
-    return this;
-  }
-
-  /**
-   * Skip the playing song
-   * @returns {Song} The song will skip to
-   * @throws {Error}
-   */
-  skip() {
-    if (this.songs.length <= 1 && !this.autoplay) throw new Error("There is no song to skip.");
-    const song = this.songs[1];
-    this.next = true;
-    this.dispatcher.end();
-    return song;
-  }
-
-  /**
-   * Play the previous song
-   * @returns {Song} The guild queue
-   * @throws {Error}
-   */
-  previous() {
-    if (!this.options.savePreviousSongs) throw new Error("savePreviousSongs is disabled.");
-    if (this.previousSongs?.length === 0 && this.repeatMode !== 2) throw new Error("There is no previous song.");
-    const song = this.repeatMode === 2 ? this.songs[this.songs.length - 1] : this.previousSongs[this.previousSongs.length - 1];
-    this.prev = true;
-    this.dispatcher.end();
-    return song;
-  }
-  /**
-   * Shuffle the queue's songs
-   * @returns {Queue} The guild queue
-   */
-  shuffle() {
-    const playing = this.songs.shift();
-    for (let i = this.songs.length - 1; i > 0; i--) {
-      const j = Math.floor(Math.random() * (i + 1));
-      [this.songs[i], this.songs[j]] = [this.songs[j], this.songs[i]];
-    }
-    this.songs.unshift(playing);
-    return this;
-  }
-  /**
-   * Jump to the song number in the queue.
-   * The next one is 1, 2,...
-   * The previous one is -1, -2,...
-   * @param {number} num The song number to play
-   * @returns {Queue} The guild queue
-   * @throws {InvalidSong} if `num` is invalid number (0 < num < {@link Queue#songs}.length)
-   */
-  jump(num) {
-    if (num > this.songs.length || -num > this.previousSongs.length || num === 0) throw new RangeError("InvalidSong");
-    if (num > 0) {
-      this.songs = this.songs.splice(num - 1);
-      this.next = true;
-    } else if (num === -1) this.prev = true;
-    else {
-      this.songs.unshift(...this.previousSongs.splice(num + 1));
-      this.prev = true;
-    }
-    if (this.dispatcher) this.dispatcher.end();
-    return this;
-  }
-  /**
-   * Set the repeat mode of the guild queue.
-   * Turn off if repeat mode is the same value as new mode.
-   * Toggle mode: `mode = null` `(0 -> 1 -> 2 -> 0...)`
-   * @param {number?} [mode] The repeat modes `(0: disabled, 1: Repeat a song, 2: Repeat all the queue)`
-   * @returns {number} The new repeat mode
-   */
-  setRepeatMode(mode = null) {
-    mode = parseInt(mode, 10);
-    if (!mode && mode !== 0) this.repeatMode = (this.repeatMode + 1) % 3;
-    else if (this.repeatMode === mode) this.repeatMode = 0;
-    else this.repeatMode = mode;
-    return this.repeatMode;
-  }
-  /**
-   * Enable or disable filter of the queue.
-   * Available filters: {@link Filters}
-   * @param {string|false} filter A filter name, `false` to clear all the filters
-   * @returns {Array<string>} Enabled filters.
-   * @throws {Error}
-   */
-  setFilter(filter) {
-    if (filter === false) this.filters = [];
-    else if (!Object.prototype.hasOwnProperty.call(this.distube.filters, filter)) throw new TypeError(`${filter} is not a filter name.`);
-    else if (this.filters.includes(filter)) this.filters = this.filters.filter(f => f !== filter);
-    else this.filters.push(filter);
-    this.beginTime = this.currentTime;
-    this.handler.playSong(this);
-    return this.filters;
-  }
-  /**
-   * Set the playing time to another position
-   * @param {number} time Time in seconds
-   * @returns {Queue}
-   */
-  seek(time) {
-    this.beginTime = time;
-    this.handler.playSong(this);
-    return this;
-  }
-  /**
-   * Add a related song to the queue
-   * @param {Song} [song] A song to get the related one
-   * @returns {Promise<Queue>} The guild queue
-   * @throws {Error}
-   */
-  async addRelatedVideo(song = this.songs[0]) {
-    const related = (await this.handler.getRelatedVideo(song))
-      .find(v => !this.previousSongs.map(s => s.id).includes(v.id));
-    if (!related) throw new Error("Cannot find any related songs.");
-    this.addToQueue(new Song(await this.handler.getYouTubeInfo(related.id), this.voiceChannel?.guild?.me));
-    return this;
-  }
-  /**
-   * Toggle autoplay mode
-   * @returns {boolean} Autoplay mode state
-   */
-  toggleAutoplay() {
-    this.autoplay = !this.autoplay;
-    return this.autoplay;
-  }
-}
-
-module.exports = Queue;

package/src/SearchResult.js

@@ -1,57 +0,0 @@
-const { toSecond, formatDuration } = require("./util");
-
-/** Class representing a search result. */
-class SearchResult {
-  constructor(info) {
-    this.source = "youtube";
-    /**
-     * Type of SearchResult (video or playlist)
-     * @type {string}
-     */
-    this.type = info.type;
-    /**
-     * YouTube video or playlist id
-     * @type {string}
-     */
-    this.id = info.id;
-    /**
-     * Video or playlist title.
-     * @type {string}
-     */
-    this.name = info.name;
-    /**
-     * Video or playlist URL.
-     * @type {string}
-     */
-    this.url = info.url;
-    /**
-     * Video / Playlist views count
-     * @type {number}
-     */
-    this.views = info.views;
-    if (this.type === "video") {
-      /**
-       * Indicates if the video is an active live.
-       * @type {boolean?}
-       */
-      this.isLive = info.isLive;
-      /**
-       * Video duration.
-       * @type {number}
-       */
-      this.duration = this.isLive ? 0 : toSecond(info.duration);
-      /**
-       * Formatted duration string `hh:mm:ss` or `mm:ss`.
-       * @type {string}
-       */
-      this.formattedDuration = this.isLive ? "Live" : formatDuration(this.duration);
-      /**
-       * Video thumbnail.
-       * @type {string?}
-       */
-      this.thumbnail = info.thumbnail;
-    } else if (this.type !== "playlist") throw new TypeError("Unsupported info");
-  }
-}
-
-module.exports = SearchResult;

package/src/Song.js

@@ -1,169 +0,0 @@
-const { formatDuration, toSecond, parseNumber } = require("./util"),
-  ytdl = require("ytdl-core"),
-  Playlist = require("./Playlist"),
-  // eslint-disable-next-line no-unused-vars
-  Discord = require("discord.js");
-
-/** Class representing a song. */
-class Song {
-  /**
-   * Create a Song
-   * @param {ytdl.videoInfo|Object} info Raw info
-   * @param {Discord.GuildMember} member Requested user
-   * @param {string} src Song source
-   */
-  constructor(info, member = null, src = "youtube") {
-    if (typeof src !== "string") throw new TypeError("Source must be a string");
-    /**
-     * The source of the song
-     * @type {string}
-     */
-    this.source = src;
-    /**
-     * User requested
-     * @type {Discord.GuildMember?}
-     */
-    this.member = member;
-    /**
-     * User requested
-     * @type {Discord.User?}
-     */
-    this.user = this.member?.user;
-    if (this.source === "youtube" && info.full) {
-      /**
-       * `ytdl-core` raw info (If the song is from YouTube)
-       * @type {ytdl.videoInfo?}
-       * @private
-       */
-      this.info = info;
-      info = info.videoDetails;
-    }
-    this._patch(info);
-  }
-
-  /**
-   * Patch data
-   * @param {ytdl.MoreVideoDetails|Object} info Video info
-   * @private
-   */
-  _patch(info) {
-    /**
-     * YouTube video id
-     * @type {string}
-     */
-    this.id = info.videoId || info.id;
-    /**
-     * Song name aka video title.
-     * @type {string}
-     */
-    this.name = info.title || info.name;
-    /**
-     * Indicates if the video is an active live.
-     * @type {boolean}
-     */
-    this.isLive = info.isLive || info.is_live || false;
-    /**
-     * Song duration.
-     * @type {number}
-     */
-    this.duration = this.isLive ? 0 : toSecond(info.lengthSeconds || info._duration_raw || info.duration);
-    /**
-     * Formatted duration string (`hh:mm:ss`, `mm:ss` or `Live`).
-     * @type {string}
-     */
-    this.formattedDuration = this.isLive ? "Live" : formatDuration(this.duration);
-    /**
-     * Song URL.
-     * @type {string}
-     */
-    this.url = this.source === "youtube" ? `https://www.youtube.com/watch?v=${this.id}` : info.webpage_url || info.url;
-    /**
-     * Stream / Download URL.
-     * @type {string?}
-     */
-    this.streamURL = this.info?.formats.length ? ytdl.chooseFormat(this.info.formats, {
-      filter: this.isLive ? "audioandvideo" : "audioonly",
-      quality: "highestaudio",
-    }).url : info.url;
-    /**
-     * Song thumbnail.
-     * @type {string?}
-     */
-    this.thumbnail = info.thumbnails?.sort((a, b) => b.width - a.width)[0].url ||
-      info.thumbnail?.url || info.thumbnail || null;
-    /**
-     * Related videos (Only available with YouTube video)
-     * @type {Array<ytdl.relatedVideo>?}
-     */
-    this.related = this.info?.related_videos;
-    /**
-     * Song views count
-     * @type {number}
-     */
-    this.views = parseNumber(info.viewCount || info.view_count || info.views);
-    /**
-     * Song like count
-     * @type {number}
-     */
-    this.likes = parseNumber(info.likes || info.like_count);
-    /**
-     * Song dislike count
-     * @type {number}
-     */
-    this.dislikes = parseNumber(info.dislikes || info.dislike_count);
-    /**
-     * Song repost count
-     * @type {number}
-     */
-    this.reposts = parseNumber(info.repost_count);
-    /**
-     * Song uploader
-     * @type {Object}
-     * @prop {string?} name Uploader name
-     * @prop {string?} url Uploader url
-     */
-    this.uploader = {
-      name: info.author?.name || info.uploader || null,
-      url: info.author?.channel_url || info.uploader_url || null,
-    };
-    /**
-     * Whether or not an age-restricted content
-     * @type {boolean}
-     */
-    this.age_restricted = info.age_restricted ||
-      (info.age_limit && parseNumber(info.age_limit) >= 18) ||
-      (typeof info.media?.notice === "string" && (
-        info.media.notice.includes("Age-restricted") || info.media.notice.includes("age-restricted")
-      )) || false;
-    /**
-     * @typedef {Object} Chapter
-     * @prop {string} title Chapter title
-     * @prop {number} start_time Chapter start time in seconds
-     */
-    /**
-     * Chapters information (YouTube only)
-     * @type {Chapter[]}
-     */
-    this.chapters = info.chapters || [];
-  }
-
-  /**
-   * @param {Playlist} playlist Playlist
-   * @param {Discord.GuildMember} [member] User requested
-   * @private
-   * @returns {Song}
-   */
-  _patchPlaylist(playlist, member = this.member) {
-    if (!(playlist instanceof Playlist)) throw new TypeError("playlist is not a valid Playlist");
-    /**
-     * The playlist added this song
-     * @type {Playlist?}
-     */
-    this.playlist = playlist;
-    this.member = member;
-    this.user = this.member?.user;
-    return this;
-  }
-}
-
-module.exports = Song;