distube 2.8.18 → 3.0.0-0

package/src/Playlist.js

@@ -1,107 +0,0 @@
-/* eslint no-unused-vars: "off" */
-const { formatDuration } = require("./duration"),
-  Discord = require("discord.js"),
-  Song = require("./Song"),
-  ytpl = require("@distube/ytpl");
-
-const deprecate = (obj, oldProp, value, newProp = null) => {
-  Object.defineProperty(obj, oldProp, {
-    get: () => {
-      if (newProp) console.warn(`\`playlist.${oldProp}\` will be removed in the next major release, use \`playlist.${newProp}\` instead.`);
-      else console.warn(`\`playlist.${oldProp}\` will be removed completely in the next major release.`);
-      return value;
-    },
-  });
-};
-
-const deprecateProps = {
-  title: "name",
-  items: "songs",
-};
-
-/** Class representing a playlist. */
-class Playlist {
-  /**
-   * Create a playlist
-   * @param {ytpl.result|Song[]} playlist Playlist
-   * @param {Discord.User} user Requested user
-   * @param {Object} properties Custom properties
-   */
-  constructor(playlist, user, properties = {}) {
-    /**
-     * User requested.
-     * @type {Discord.User}
-     */
-    this.user = user || playlist.user;
-    /**
-     * Playlist songs.
-     * @type {Song[]}
-     */
-    this.songs = Array.isArray(playlist) ? playlist : playlist.items;
-    if (!Array.isArray(this.songs) || !this.songs.length) throw new Error("Playlist is empty!");
-    /**
-     * Playlist name.
-     * @type {string}
-     */
-    this.name = playlist.name || playlist.title || this.songs[0].playlist_title || `${this.songs[0].name} and ${this.songs.length - 1} more songs.`;
-    /**
-     * Playlist URL.
-     * @type {string}
-     */
-    this.url = playlist.url;
-    /**
-     * Playlist thumbnail.
-     * @type {string}
-     */
-    this.thumbnail = playlist.thumbnail || this.songs[0].thumbnail;
-    for (let [key, value] of Object.entries(properties)) this[key] = value;
-
-    // Old version compatible
-    /**
-     * @deprecated use `Playlist.name` instead
-     * @type {string}
-     */
-    this.title = "";
-    /**
-     * @deprecated use `Playlist.songs` instead
-     * @type {Song[]}
-     */
-    this.items = [];
-    /**
-     * @deprecated use `Playlist.songs.length` instead
-     * @type {number}
-     */
-    this.total_items = this.songs.length || 0;
-    /**
-     * @deprecated
-     * @type {string}
-     */
-    this.id = playlist.id || "";
-    /**
-     * @deprecated
-     * @type {object}
-    */
-    this.author = playlist.author || {};
-    for (let [oldProp, newProp] of Object.entries(deprecateProps)) deprecate(this, oldProp, this[newProp], newProp);
-    for (let prop of ["id", "author", "total_items"]) deprecate(this, prop, this[prop]);
-  }
-
-  /**
-   * Playlist duration in second.
-   * @type {number}
-   */
-  get duration() {
-    if (!this.songs[0]) return 0;
-    return this.songs.reduce((prev, next) => prev + next.duration, 0)
-  }
-
-  /**
-   * Formatted duration string `hh:mm:ss`.
-   * @type {string}
-   */
-  get formattedDuration() {
-    return formatDuration(this.duration * 1000)
-  }
-}
-
-module.exports = Playlist;

package/src/Queue.js

@@ -1,120 +0,0 @@
-/* eslint no-unused-vars: "off" */
-const { formatDuration } = require("./duration"),
-  Discord = require("discord.js"),
-  Song = require("./Song"),
-  DisTube = require("./DisTube");
-
-/**
- * Represents a queue.
- */
-class Queue {
-  /**
-  * Create a queue.
-  * @param {Discord.Message} message Discord.Message
-  * @param {Song} song The first Song of the Queue
-  */
-  constructor(message, song) {
-    /**
-     * Stream dispatcher.
-     * @type {Discord.StreamDispatcher}
-     */
-    this.dispatcher = null;
-    /**
-     * Voice connection.
-     * @type {Discord.VoiceConnection}
-     */
-    this.connection = null;
-    /**
-     * Stream volume.
-     * @type {number}
-     */
-    this.volume = 50;
-    /**
-     * List of songs
-     * @type {Song[]}
-     */
-    this.songs = [song];
-    /**
-     * Whether stream is currently stopped.
-     * @type {boolean}
-     */
-    this.stopped = false;
-    /**
-     * Whether or not the last song was skipped.
-     * @type {boolean}
-     */
-    this.skipped = 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.pause = false;
-    /**
-     * Type of repeat mode (0 is disabled, 1 is repeating a song, 2 is repeating all the playlist)
-     * @type {number}
-     */
-    this.repeatMode = 0;
-    /**
-     * Whether or not the autoplay mode is enabled.
-     * @type {boolean}
-     */
-    this.autoplay = true;
-    /**
-     * `@2.0.0` Queue audio filter.
-     * Available filters: {@link Filter}
-     * @type {DisTube.Filter}
-     */
-    this.filter = null;
-    /**
-     * `@2.2.0` Message which initialize the queue
-     * @type {Discord.Message}
-     */
-    this.initMessage = message;
-    /**
-     * `@2.5.0` ytdl stream
-     * @type {Readable}
-     */
-    this.stream = null;
-    /**
-     * `@2.7.0` What time in the song to begin (in milliseconds).
-     * @type {number}
-     */
-    this.beginTime = 0;
-    this.previousSongs = [];
-  }
-  /**
-   * Formatted duration string.
-   * @type {string}
-   */
-  get formattedDuration() {
-    return formatDuration(this.duration * 1000)
-  }
-  /**
-   * Queue's duration.
-   * @type {number}
-   */
-  get duration() {
-    return this.songs.reduce((prev, next) => prev + next.duration, 0)
-  }
-  /**
-   * `@2.7.0` What time in the song is playing (in milliseconds).
-   * @type {number}
-   */
-  get currentTime() {
-    return this.dispatcher.streamTime + this.beginTime;
-  }
-  /**
-   * `@2.8.0` Formatted {@link Queue#currentTime} string.
-   * @type {string}
-   */
-  get formattedCurrentTime() {
-    return formatDuration(this.currentTime);
-  }
-}
-
-module.exports = Queue;

package/src/SearchResult.js

@@ -1,81 +0,0 @@
-/* eslint no-unused-vars: "off" */
-const { toSecond } = require("./duration"),
-  ytsr = require("@distube/ytsr");
-
-const deprecate = (obj, oldProp, value, newProp = null) => {
-  Object.defineProperty(obj, oldProp, {
-    get: () => {
-      if (newProp) console.warn(`\`${obj.constructor.name}.${oldProp}\` will be removed in the next major release, use \`${obj.constructor.name}.${newProp}\` instead.`);
-      else console.warn(`\`${obj.constructor.name}.${oldProp}\` will be removed completely in the next major release.`)
-      return value;
-    },
-  });
-};
-
-const deprecateProps = {
-  title: "name",
-  link: "url",
-};
-
-/** `@2.7.0` Class representing a search result. */
-class SearchResult {
-  /**
-   * Create a search result.
-   * @param {ytsr.Video} info Video info
-   */
-  constructor(info) {
-    /**
-     * Youtube video id
-     * @type {string}
-     */
-    this.id = info.id;
-    /**
-     * Song name aka video title.
-     * @type {string}
-     */
-    this.name = info.name;
-    /**
-     * Song duration.
-     * @type {number}
-     */
-    this.duration = toSecond(info.duration) || 0;
-    /**
-     * Formatted duration string `hh:mm:ss` or `mm:ss`.
-     * @type {string}
-     */
-    this.formattedDuration = info.duration;
-    /**
-     * Song URL.
-     * @type {string}
-     */
-    this.url = info.url;
-    /**
-     * Song thumbnail.
-     * @type {string}
-     */
-    this.thumbnail = info.thumbnail;
-    /**
-     * Indicates if the video is an active live.
-     * @type {boolean}
-     */
-    this.isLive = info.isLive;
-    /**
-     * Song views count
-     * @type {number}
-     */
-    this.views = info.views;
-    /**
-     * @deprecated use `Song.name` instead
-     * @type {string}
-     */
-    this.title = "";
-    /**
-     * @deprecated use `Song.url` instead
-     * @type {string}
-     */
-    this.link = "";
-    for (let [oldProp, newProp] of Object.entries(deprecateProps)) deprecate(this, oldProp, this[newProp], newProp);
-  }
-}
-
-module.exports = SearchResult;

package/src/Song.js

@@ -1,135 +0,0 @@
-/* eslint-disable complexity */
-/* eslint no-unused-vars: "off" */
-const { formatDuration, toSecond } = require("./duration"),
-  Discord = require("discord.js"),
-  ytdl = require("ytdl-core");
-
-const deprecate = (obj, oldProp, value, newProp = null) => {
-  Object.defineProperty(obj, oldProp, {
-    get: () => {
-      if (newProp) console.warn(`\`${obj.constructor.name}.${oldProp}\` will be removed in the next major release, use \`${obj.constructor.name}.${newProp}\` instead.`);
-      else console.warn(`\`${obj.constructor.name}.${oldProp}\` will be removed completely in the next major release.`)
-      return value;
-    },
-  });
-};
-
-const deprecateProps = {
-  title: "name",
-  link: "url",
-  plays: "views",
-};
-
-const parseNumber = string => (typeof string === "string" ? Number(string.replace(/\D+/g, "")) : Number(string)) || 0;
-
-/** Class representing a song. */
-class Song {
-  /**
-   * Create a song.
-   * @param {ytdl.videoInfo|Object} info Video info
-   * @param {Discord.User} user Requested user
-   * @param {boolean} [youtube=false] Weather or not the video is a Youtube video.
-   */
-  constructor(info, user, youtube = false) {
-    /**
-     * `@2.6.0` Weather or not the video is a Youtube video.
-     * @type {boolean}
-     */
-    this.youtube = info.youtube || youtube;
-    if (this.youtube && info.full) {
-      this.info = info;
-      info = info.videoDetails;
-    }
-    /**
-     * User requested
-     * @type {Discord.User}
-     */
-    this.user = user;
-    /**
-     * `@2.1.4` Youtube video id
-     * @type {string}
-     */
-    this.id = info.videoId || info.id;
-    /**
-     * Song name aka video title.
-     * @type {string}
-     */
-    this.name = info.title;
-    /**
-     * `@2.5.0` Indicates if the video is an active live.
-     * @type {boolean}
-     */
-    this.isLive = info.isLive || info.is_live || false;
-    /**
-     * Song duration.
-     * @type {number}
-     */
-    this.duration = toSecond(Number(info.lengthSeconds) || info._duration_raw || info.duration) || 0;
-    /**
-     * Formatted duration string `hh:mm:ss` or `mm:ss`.
-     * @type {string}
-     */
-    this.formattedDuration = this.isLive ? "Live" : formatDuration(this.duration * 1000)
-    /**
-     * Song URL.
-     * @type {string}
-     */
-    this.url = this.youtube ? `https://www.youtube.com/watch?v=${this.id}` : info.webpage_url;
-    /**
-     * `@2.6.0` Stream / Download URL.
-     * @type {?string}
-     */
-    this.streamURL = this.info && 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 ? info.thumbnails.sort((a, b) => b.width - a.width)[0].url : info.thumbnail || null;
-    /**
-     * Related videos (Only available with YouTube video)
-     * @type {?ytdl.relatedVideo[]}
-     */
-    this.related = info.related_videos;
-    /**
-     * `@2.6.0` Song views count
-     * @type {number}
-     */
-    this.views = parseNumber(info.viewCount || info.view_count || info.views);
-    /**
-     * @deprecated use `Song.views` instead
-     * @type {number}
-     */
-    this.plays = this.views;
-    /**
-     * `@2.6.0` Song like count
-     * @type {number}
-     */
-    this.likes = parseNumber(info.likes || info.like_count);
-    /**
-     * `@2.6.0` Song dislike count
-     * @type {number}
-     */
-    this.dislikes = parseNumber(info.dislikes || info.dislike_count);
-    /**
-     * `@2.6.0` Song repost count
-     * @type {number}
-     */
-    this.reposts = parseNumber(info.repost_count);
-    /**
-     * @deprecated use `Song.name` instead
-     * @type {string}
-     */
-    this.title = "";
-    /**
-     * @deprecated use `Song.url` instead
-     * @type {string}
-     */
-    this.link = "";
-    for (let [oldProp, newProp] of Object.entries(deprecateProps)) deprecate(this, oldProp, this[newProp], newProp);
-  }
-}
-
-module.exports = Song;

package/src/duration.js

@@ -1,39 +0,0 @@
-const formatInt = int => {
-  if (int < 10) return `0${int}`;
-  return `${int}`;
-};
-
-module.exports.formatDuration = milliseconds => {
-  if (!milliseconds || !parseInt(milliseconds)) return "00:00";
-  const seconds = Math.floor(milliseconds % 60000 / 1000);
-  const minutes = Math.floor(milliseconds % 3600000 / 60000);
-  const hours = Math.floor(milliseconds / 3600000);
-  if (hours > 0) {
-    return `${formatInt(hours)}:${formatInt(minutes)}:${formatInt(seconds)}`;
-  }
-  if (minutes > 0) {
-    return `${formatInt(minutes)}:${formatInt(seconds)}`;
-  }
-  return `00:${formatInt(seconds)}`;
-};
-
-module.exports.toSecond = string => {
-  if (!string) return 0;
-  if (typeof string !== "string") return parseInt(string);
-  let h = 0,
-    m = 0,
-    s = 0;
-  if (string.match(/:/g)) {
-    let time = string.split(":");
-    if (time.length === 2) {
-      m = parseInt(time[0], 10);
-      s = parseInt(time[1], 10);
-    } else if (time.length === 3) {
-      h = parseInt(time[0], 10);
-      m = parseInt(time[1], 10);
-      s = parseInt(time[2], 10);
-    }
-  } else s = parseInt(string, 10);
-  // eslint-disable-next-line no-mixed-operators
-  return h * 60 * 60 + m * 60 + s;
-};