distube 3.3.0 → 4.0.0-dev.0

package/README.md

@@ -7,7 +7,7 @@
     <img alt="node-current" src="https://img.shields.io/node/v/distube?logo=node.js&logoColor=white&style=flat-square">
     <img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/distube/peer/discord.js?label=discord.js&logo=discord&logoColor=white&style=flat-square">
     <img alt="Depfu" src="https://img.shields.io/depfu/skick1234/DisTube?style=flat-square">
-    <img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/skick1234/DisTube?logo=codecov&logoColor=white&style=flat-square&token=WWDYRRSEQW">
+    <img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/skick1234/DisTube/main?logo=codecov&logoColor=white&style=flat-square&token=WWDYRRSEQW">
     <br>
     <img alt="npm" src="https://img.shields.io/npm/dt/distube?logo=npm&style=flat-square">
     <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/skick1234/DisTube?logo=github&logoColor=white&style=flat-square">
@@ -25,25 +25,24 @@ A Discord.js module to simplify your music commands and play songs with audio fi
 
 - Build on `@discordjs/voice`
 - Easy to use and customize
-- Support YouTube, SoundCloud, Facebook, and [700+ more sites](https://ytdl-org.github.io/youtube-dl/supportedsites.html)
+- Support YouTube and audio link
 - Audio filters (bassboost, nightcore, vaporwave,...)
 - Autoplay related songs
 - Plugin system to support more sites ([Plugin List](https://distube.js.org/#/docs/DisTube/stable/plugin/list))
 
-### Requirement
+## Requirement
 
-- Node v12 or higher
-- [discord.js](https://discord.js.org) v12 or **v13 _(Recommended)_**
+- Node.js 16.9.0 or higher
+- [discord.js](https://discord.js.org) v14
 - [@discordjs/voice](https://github.com/discordjs/voice)
 - [FFmpeg](https://www.ffmpeg.org/download.html)
 - [@discordjs/opus](https://github.com/discordjs/opus)
 - [sodium](https://www.npmjs.com/package/sodium) or [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers)
-- [python](https://www.python.org/) _(Optional - For [`youtube-dl`](https://youtube-dl.org/) to support [700+ more sites](https://ytdl-org.github.io/youtube-dl/supportedsites.html).)_
 
 ## Installation
 
 ```npm
-npm install distube@latest
+npm install distube@dev
 ```
 
 ## Documentation
@@ -61,4 +60,3 @@ Read DisTube's definitions, properties and events details in the [Documentation
 - [node-ytdl-core](https://github.com/fent/node-ytdl-core): YouTube scraper ([DisTube Fork](https://github.com/distubejs/node-ytdl-core))
 - [node-ytsr](https://github.com/TimeForANinja/node-ytsr): YouTube search scraper ([DisTube Fork](https://github.com/distubejs/ytsr))
 - [node-ytpl](https://github.com/TimeForANinja/node-ytpl): YouTube playlist resolver ([DisTube Fork](https://github.com/distubejs/ytpl))
-- [youtube-dl-exec](https://github.com/microlinkhq/youtube-dl-exec): [`youtube-dl`](https://youtube-dl.org/) wrapper

package/dist/DisTube.d.ts

@@ -70,55 +70,7 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
      * });
      * @returns {Promise<void>}
      */
-    play(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist | null, options?: {
-        skip?: boolean;
-        position?: number;
-        member?: GuildMember;
-        textChannel?: GuildTextBasedChannel;
-        message?: Message;
-        metadata?: any;
-    }): Promise<void>;
-    /** @deprecated Message parameter is deprecated, use VoiceChannel instead. */
-    play(message: Message<true>, song: string | Song | SearchResult | Playlist, options?: {
-        skip?: boolean;
-        unshift?: boolean;
-        metadata?: any;
-    }): Promise<void>;
-    /** @deprecated `options.unshift` is deprecated, use `options.position` instead */
-    play(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist | null, options?: {
-        skip?: boolean;
-        /** @deprecated Use `options.position` instead */
-        unshift?: boolean;
-        position?: number;
-        member?: GuildMember;
-        textChannel?: GuildTextBasedChannel;
-        message?: Message;
-        metadata?: any;
-    }): Promise<void>;
-    /**
-     * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
-     *
-     * @returns {Promise<void>}
-     * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
-     * @param {string|Song|SearchResult|Playlist} song URL | Search string |
-     * {@link Song} | {@link SearchResult} | {@link Playlist}
-     * @param {Object} [options] Optional options
-     * @param {boolean} [options.skip=false]
-     * Skip the playing song (if exists) and play the added song/playlist if `position` is 1.
-     * If `position` is defined and not equal to 1, it will skip to the next song instead of the added song
-     * @param {number} [options.position=0] Position of the song/playlist to add to the queue,
-     * <= 0 to add to the end of the queue.
-     * @param {boolean} [options.unshift=false] (DEPRECATED) Add the song/playlist to the beginning of the queue
-     * (after the playing song if exists)
-     * @param {Discord.GuildMember} [options.member] Requested user (default is your bot)
-     * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}
-     * @param {Discord.Message} [options.message] Called message (For built-in search events. If this is a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy|falsy value}, it will play the first result instead)
-     * @param {*} [options.metadata] Optional metadata that can be attached to the song/playlist will be played,
-     * This is useful for identification purposes when the song/playlist is passed around in events.
-     * See {@link Song#metadata} or {@link Playlist#metadata}
-     * @deprecated Use {@link DisTube#play} instead
-     */
-    playVoiceChannel(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist | null, options?: {
+    play(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist, options?: {
         skip?: boolean;
         unshift?: boolean;
         position?: number;
@@ -133,7 +85,7 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
      * @param {Array<string|Song|SearchResult>} songs Array of url, Song or SearchResult
      * @param {Object} [options] Optional options
      * @param {Discord.GuildMember} [options.message] A message from guild channel | A guild member
-     * @param {Object} [options.properties={}] Additional properties such as `name`
+     * @param {Object} [options.properties] Additional properties such as `name`
      * @param {boolean} [options.parallel=true] Whether or not fetch the songs in parallel
      * @param {*} [options.metadata] Metadata
      * @example
@@ -151,35 +103,6 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
         parallel?: boolean;
         metadata?: any;
     }): Promise<Playlist>;
-    /**
-     * <info>Shorthand method of {@link DisTube#createCustomPlaylist} and {@link DisTube#play}
-     *
-     * If you doesn't have a user message (interaction,...),
-     * see {@link DisTube#createCustomPlaylist} example</info>
-     *
-     * Play or add array of video urls.
-     * {@link DisTube#event:playSong} or {@link DisTube#event:addList} will be emitted
-     * with `playlist`'s properties include `properties` parameter's properties such as
-     * `user`, `songs`, `duration`, `formattedDuration`, `thumbnail` like {@link Playlist}
-     * @returns {Promise<void>}
-     * @param {Discord.Message} message A message from guild channel
-     * @param {Array<string|Song|SearchResult>} songs Array of url, Song or SearchResult
-     * @param {Object} [properties={}] Additional properties for playlist such as `name`
-     * @param {Object} [options] Optional options
-     * @param {boolean} [options.skip=false] Skip the playing song (if exists) and play the added song/playlist instantly
-     * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue
-     * (after the playing song if exists)
-     * @param {boolean} [options.parallel=true] Whether or not fetch the songs in parallel
-     * @deprecated Use {@link DisTube#createCustomPlaylist} and {@link DisTube#play} instead
-     */
-    playCustomPlaylist(message: Message<true>, songs: Array<string | Song | SearchResult>, properties?: Record<string, any>, options?: {
-        skip?: boolean;
-        /** @deprecated */
-        unshift?: boolean;
-        position?: number;
-        parallel?: boolean;
-        metadata?: any;
-    }): Promise<void>;
     /**
      * Search for a song. You can customize how user answers instead of send a number.
      * Then use {@link DisTube#play} to play it.

package/dist/DisTube.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DisTube.d.ts","sourceRoot":"","sources":["../src/DisTube.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,cAAc,EACd,mBAAmB,EAGnB,OAAO,EACP,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,IAAI,EAQL,MAAM,GAAG,CAAC;AACX,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,OAAO,EAAe,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACtH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAMlH,eAAO,MAAQ,OAAO,QAAoD,CAAC;AAE3E;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAY,CAAC,aAAa,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,gBAAgB,EAAE,eAAe,EAAE,CAAC;IAC7C,QAAQ,CAAC,aAAa,EAAE,YAAY,EAAE,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;OAYG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,GAAE,cAAmB;IAuDpD,MAAM,KAAK,OAAO,WAEjB;IAED;;;OAGG;IACH,IAAI,OAAO,WAEV;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,IAAI,CACR,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,GAAG,IAAI,EACpD,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KAChB,GACA,OAAO,CAAC,IAAI,CAAC;IAChB,6EAA6E;IACvE,IAAI,CACR,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EACtB,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,EAC7C,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAChB,kFAAkF;IAC5E,IAAI,CACR,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,GAAG,IAAI,EACpD,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,iDAAiD;QACjD,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KAChB,GACA,OAAO,CAAC,IAAI,CAAC;IAiIhB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,gBAAgB,CACpB,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,GAAG,IAAI,EACpD,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;;;;;;;;;OAiBG;IACG,oBAAoB,CACxB,KAAK,EAAE,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAAE,EACvC,OAAO,GAAE;QACP,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,QAAQ,CAAC;IA4BpB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,kBAAkB,CACtB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EACtB,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAC1C,UAAU,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EACpC,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,kBAAkB;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,IAAI,CAAC;IAgDhB;;;;;;;;;;;OAWG;IACG,MAAM,CACV,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GACrG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAuB/B;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,GAAG,SAAS;IAIrD;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAMtC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAMvC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK;IAM3D;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;IAMjD;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAM3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM;IAM9D;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAOjD;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,KAAK,UAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;IAMzF;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK;IAOnD;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;CAe/D;AAED,eAAe,OAAO,CAAC;AAEvB;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG"}
+{"version":3,"file":"DisTube.d.ts","sourceRoot":"","sources":["../src/DisTube.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,cAAc,EACd,mBAAmB,EAGnB,OAAO,EACP,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,IAAI,EAOL,MAAM,GAAG,CAAC;AACX,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,OAAO,EAAe,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACtH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAIlH,eAAO,MAAQ,OAAO,QAAoD,CAAC;AAE3E;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAY,CAAC,aAAa,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,gBAAgB,EAAE,eAAe,EAAE,CAAC;IAC7C,QAAQ,CAAC,aAAa,EAAE,YAAY,EAAE,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;OAYG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,GAAE,cAAmB;IAqDpD,MAAM,KAAK,OAAO,WAEjB;IAED;;;OAGG;IACH,IAAI,OAAO,WAEV;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,IAAI,CACR,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,EAC7C,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,IAAI,CAAC;IAsFhB;;;;;;;;;;;;;;;;;OAiBG;IACG,oBAAoB,CACxB,KAAK,EAAE,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAAE,EACvC,OAAO,GAAE;QACP,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,QAAQ,CAAC;IA4BpB;;;;;;;;;;;OAWG;IACG,MAAM,CACV,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GACrG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAuB/B;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,GAAG,SAAS;IAIrD;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAMtC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAMvC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK;IAM3D;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;IAMjD;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAM3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM;IAM9D;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAOjD;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,KAAK,UAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;IAMzF;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK;IAOnD;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;CAe/D;AAED,eAAe,OAAO,CAAC;AAEvB;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG"}

package/dist/DisTube.js

@@ -9,7 +9,6 @@ const ytsr_1 = __importDefault(require("@distube/ytsr"));
 const util_1 = require("./util");
 const tiny_typed_emitter_1 = require("tiny-typed-emitter");
 const _1 = require(".");
-// TODO: remove deprecated stuff on the next major version
 // Cannot be `import` as it's not under TS root dir
 // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
 exports.version = require("../package.json").version;
@@ -67,12 +66,9 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
          * DisTube filters
          * @type {Filters}
          */
-        this.filters = _1.defaultFilters;
-        Object.assign(this.filters, this.options.customFilters);
+        this.filters = { ..._1.defaultFilters, ...this.options.customFilters };
         // Default plugin
         this.options.plugins.push(new _1.HTTPPlugin(), new _1.HTTPSPlugin());
-        if (this.options.youtubeDL)
-            this.options.plugins.push(new _1.YouTubeDLPlugin(this.options.updateYouTubeDL));
         this.options.plugins.map(p => p.init(this));
         /**
          * Extractor Plugins
@@ -97,45 +93,52 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     get version() {
         return exports.version;
     }
+    /**
+     * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
+     *
+     * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
+     * @param {string|Song|SearchResult|Playlist} song URL | Search string |
+     * {@link Song} | {@link SearchResult} | {@link Playlist}
+     * @param {Object} [options] Optional options
+     * @param {boolean} [options.skip=false]
+     * Skip the playing song (if exists) and play the added song/playlist if `position` is 1.
+     * If `position` is defined and not equal to 1, it will skip to the next song instead of the added song
+     * @param {number} [options.position=0] Position of the song/playlist to add to the queue,
+     * <= 0 to add to the end of the queue.
+     * @param {boolean} [options.unshift=false] (DEPRECATED) Add the song/playlist to the beginning of the queue
+     * (after the playing song if exists)
+     * @param {Discord.GuildMember} [options.member] Requested user (default is your bot)
+     * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}
+     * @param {Discord.Message} [options.message] Called message (For built-in search events. If this is a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy|falsy value}, it will play the first result instead)
+     * @param {*} [options.metadata] Optional metadata that can be attached to the song/playlist will be played,
+     * This is useful for identification purposes when the song/playlist is passed around in events.
+     * See {@link Song#metadata} or {@link Playlist#metadata}
+     * @example
+     * client.on('message', (message) => {
+     *     if (!message.content.startsWith(config.prefix)) return;
+     *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
+     *     const command = args.shift();
+     *     if (command == "play")
+     *         distube.play(message.member.voice?.channel, args.join(" "), {
+     *             member: message.member,
+     *             textChannel: message.channel,
+     *             message
+     *         });
+     * });
+     * @returns {Promise<void>}
+     */
     async play(voiceChannel, song, options = {}) {
-        if ((0, _1.isMessageInstance)(voiceChannel)) {
-            process.emitWarning("Passing Message for DisTube#play is deprecated, use BaseGuildVoiceChannel instead.", "DeprecationWarning");
-            const message = voiceChannel;
-            if (!song)
-                throw new _1.DisTubeError("INVALID_TYPE", ["string", "Song", "SearchResult", "Playlist"], song, "song");
-            if (!(0, _1.isMessageInstance)(message))
-                throw new _1.DisTubeError("INVALID_TYPE", "Discord.Message", message, "message");
-            if (typeof options !== "object" || Array.isArray(options)) {
-                throw new _1.DisTubeError("INVALID_TYPE", "object", options, "options");
-            }
-            const textChannel = message.channel;
-            const { skip, unshift, metadata } = Object.assign({ skip: false, unshift: false }, options);
-            const member = message.member;
-            const vc = member.voice.channel;
-            if (!vc)
-                throw new _1.DisTubeError("NOT_IN_VOICE");
-            // eslint-disable-next-line deprecation/deprecation
-            return this.play(vc, song, {
-                member,
-                textChannel,
-                skip,
-                message,
-                unshift,
-                metadata,
-            });
-        }
         if (!(0, _1.isSupportedVoiceChannel)(voiceChannel)) {
             throw new _1.DisTubeError("INVALID_TYPE", "BaseGuildVoiceChannel", voiceChannel, "voiceChannel");
         }
-        if (typeof options !== "object" || Array.isArray(options)) {
+        if (!(0, util_1.isObject)(options))
             throw new _1.DisTubeError("INVALID_TYPE", "object", options, "options");
-        }
-        // eslint-disable-next-line deprecation/deprecation
-        const { textChannel, member, skip, message, unshift, metadata } = Object.assign({
-            member: voiceChannel.guild.me,
+        const { textChannel, member, skip, message, metadata } = {
+            member: voiceChannel.guild.me ?? undefined,
+            textChannel: options?.message?.channel,
             skip: false,
-            unshift: false,
-        }, options);
+            ...options,
+        };
         let position = Number(options.position);
         if (!position) {
             if (skip && position !== 0)
@@ -143,13 +146,15 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
             else
                 position = 0;
         }
-        if (unshift) {
-            process.emitWarning("'unshift' option in DisTube#play is deprecated, use 'position' instead.", "DeprecationWarning");
-            position = 1;
-        }
         if (message && !(0, _1.isMessageInstance)(message)) {
             throw new _1.DisTubeError("INVALID_TYPE", ["Discord.Message", "a falsy value"], message, "options.message");
         }
+        if (textChannel && !(0, _1.isTextChannelInstance)(textChannel)) {
+            throw new _1.DisTubeError("INVALID_TYPE", "Discord.GuildTextBasedChannel", textChannel, "options.textChannel");
+        }
+        if (member && !(0, _1.isMemberInstance)(member)) {
+            throw new _1.DisTubeError("INVALID_TYPE", "Discord.GuildMember", member, "options.member");
+        }
         try {
             if (typeof song === "string") {
                 for (const plugin of this.customPlugins) {
@@ -169,14 +174,17 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
                     song = await this.handler.resolvePlaylist(song, { member, metadata });
                 }
                 if (typeof song === "string" && !(0, util_1.isURL)(song)) {
-                    if (!message)
+                    if (!message) {
                         song = (await this.search(song, { limit: 1 }))[0];
-                    else
-                        song = await this.handler.searchSong(message, song);
+                    }
+                    else {
+                        const result = await this.handler.searchSong(message, song);
+                        if (!result)
+                            return;
+                        song = result;
+                    }
                 }
                 song = await this.handler.resolveSong(song, { member, metadata });
-                if (!song)
-                    return;
                 if (song instanceof _1.Playlist) {
                     await this.handler.handlePlaylist(voiceChannel, song, { textChannel, skip, position });
                 }
@@ -218,40 +226,13 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
             this.emitError(e, textChannel);
         }
     }
-    /**
-     * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
-     *
-     * @returns {Promise<void>}
-     * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
-     * @param {string|Song|SearchResult|Playlist} song URL | Search string |
-     * {@link Song} | {@link SearchResult} | {@link Playlist}
-     * @param {Object} [options] Optional options
-     * @param {boolean} [options.skip=false]
-     * Skip the playing song (if exists) and play the added song/playlist if `position` is 1.
-     * If `position` is defined and not equal to 1, it will skip to the next song instead of the added song
-     * @param {number} [options.position=0] Position of the song/playlist to add to the queue,
-     * <= 0 to add to the end of the queue.
-     * @param {boolean} [options.unshift=false] (DEPRECATED) Add the song/playlist to the beginning of the queue
-     * (after the playing song if exists)
-     * @param {Discord.GuildMember} [options.member] Requested user (default is your bot)
-     * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}
-     * @param {Discord.Message} [options.message] Called message (For built-in search events. If this is a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy|falsy value}, it will play the first result instead)
-     * @param {*} [options.metadata] Optional metadata that can be attached to the song/playlist will be played,
-     * This is useful for identification purposes when the song/playlist is passed around in events.
-     * See {@link Song#metadata} or {@link Playlist#metadata}
-     * @deprecated Use {@link DisTube#play} instead
-     */
-    async playVoiceChannel(voiceChannel, song, options = {}) {
-        process.emitWarning("DisTube#playVoiceChannel is deprecated, use DisTube#play instead.", "DeprecationWarning");
-        return this.play(voiceChannel, song, options);
-    }
     /**
      * Create a custom playlist
      * @returns {Promise<Playlist>}
      * @param {Array<string|Song|SearchResult>} songs Array of url, Song or SearchResult
      * @param {Object} [options] Optional options
      * @param {Discord.GuildMember} [options.message] A message from guild channel | A guild member
-     * @param {Object} [options.properties={}] Additional properties such as `name`
+     * @param {Object} [options.properties] Additional properties such as `name`
      * @param {boolean} [options.parallel=true] Whether or not fetch the songs in parallel
      * @param {*} [options.metadata] Metadata
      * @example
@@ -264,7 +245,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
      * distube.play(voiceChannel, playlist, { ... });
      */
     async createCustomPlaylist(songs, options = {}) {
-        const { member, properties, parallel, metadata } = Object.assign({ parallel: true }, options);
+        const { member, properties, parallel, metadata } = { parallel: true, ...options };
         if (!Array.isArray(songs))
             throw new _1.DisTubeError("INVALID_TYPE", "Array", songs, "songs");
         if (!songs.length)
@@ -291,73 +272,6 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
         }
         return new _1.Playlist(resolvedSongs, { member, properties, metadata });
     }
-    /**
-     * <info>Shorthand method of {@link DisTube#createCustomPlaylist} and {@link DisTube#play}
-     *
-     * If you doesn't have a user message (interaction,...),
-     * see {@link DisTube#createCustomPlaylist} example</info>
-     *
-     * Play or add array of video urls.
-     * {@link DisTube#event:playSong} or {@link DisTube#event:addList} will be emitted
-     * with `playlist`'s properties include `properties` parameter's properties such as
-     * `user`, `songs`, `duration`, `formattedDuration`, `thumbnail` like {@link Playlist}
-     * @returns {Promise<void>}
-     * @param {Discord.Message} message A message from guild channel
-     * @param {Array<string|Song|SearchResult>} songs Array of url, Song or SearchResult
-     * @param {Object} [properties={}] Additional properties for playlist such as `name`
-     * @param {Object} [options] Optional options
-     * @param {boolean} [options.skip=false] Skip the playing song (if exists) and play the added song/playlist instantly
-     * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue
-     * (after the playing song if exists)
-     * @param {boolean} [options.parallel=true] Whether or not fetch the songs in parallel
-     * @deprecated Use {@link DisTube#createCustomPlaylist} and {@link DisTube#play} instead
-     */
-    async playCustomPlaylist(message, songs, properties = {}, options = {}) {
-        process.emitWarning("DisTube#playCustomPlaylist is deprecated, use DisTube#createCustomPlaylist and DisTube#play instead.", "DeprecationWarning");
-        try {
-            if (typeof options !== "object" || Array.isArray(options)) {
-                throw new _1.DisTubeError("INVALID_TYPE", "object", options, "options");
-            }
-            // eslint-disable-next-line deprecation/deprecation
-            const { skip, unshift, parallel, metadata } = Object.assign({
-                skip: false,
-                unshift: false,
-                parallel: true,
-            }, options);
-            let position = Number(options.position);
-            if (!position) {
-                if (skip && position !== 0)
-                    position = 1;
-                else
-                    position = 0;
-            }
-            if (unshift)
-                position = 1;
-            const queue = this.getQueue(message);
-            const queuing = queue && !queue.taskQueue.hasResolveTask;
-            if (queuing)
-                await queue?.taskQueue.queuing(true);
-            try {
-                const playlist = await this.createCustomPlaylist(songs, {
-                    member: message.member ?? undefined,
-                    properties,
-                    parallel,
-                    metadata,
-                });
-                const voice = message.member?.voice?.channel;
-                if (!voice)
-                    throw new _1.DisTubeError("NOT_IN_VOICE");
-                await this.play(voice, playlist, { textChannel: message.channel, skip, position, metadata });
-            }
-            finally {
-                if (queuing)
-                    queue?.taskQueue.resolve();
-            }
-        }
-        catch (e) {
-            this.emitError(e, message.channel);
-        }
-    }
     /**
      * Search for a song. You can customize how user answers instead of send a number.
      * Then use {@link DisTube#play} to play it.
@@ -371,7 +285,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
      * @returns {Promise<Array<SearchResult>>} Array of results
      */
     async search(string, options = {}) {
-        const opts = Object.assign({ type: "video", limit: 10, safeSearch: false }, options);
+        const opts = { type: "video", limit: 10, safeSearch: false, ...options };
         if (typeof opts.type !== "string" || !["video", "playlist"].includes(opts.type)) {
             throw new _1.DisTubeError("INVALID_TYPE", ["video", "playlist"], opts.type, "options.type");
         }