distube 3.0.6 → 3.2.0

package/dist/plugin/youtube-dl.d.ts

@@ -1,11 +1,12 @@
-import ExtractorPlugin from "../struct/ExtractorPlugin";
-import { Playlist, Song } from "../struct";
+import { ExtractorPlugin, Playlist, Song } from "..";
 import type { GuildMember } from "discord.js";
 export declare class YouTubeDLPlugin extends ExtractorPlugin {
     constructor(updateYouTubeDL?: boolean);
     validate(): Promise<boolean>;
-    resolve(url: string, member: GuildMember): Promise<Song | Playlist>;
+    resolve(url: string, { member, metadata }: {
+        member?: GuildMember;
+        metadata?: any;
+    }): Promise<Playlist<any> | Song<any>>;
     getStreamURL(url: string): Promise<string>;
 }
-export default YouTubeDLPlugin;
 //# sourceMappingURL=youtube-dl.d.ts.map

package/dist/plugin/youtube-dl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"youtube-dl.d.ts","sourceRoot":"","sources":["../../src/plugin/youtube-dl.ts"],"names":[],"mappings":"AACA,OAAO,eAAe,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAG9C,qBAAa,eAAgB,SAAQ,eAAe;gBACtC,eAAe,UAAO;IAY5B,QAAQ;IAGR,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW;IAgBxC,YAAY,CAAC,GAAG,EAAE,MAAM;CAW/B;AAED,eAAe,eAAe,CAAC"}
+{"version":3,"file":"youtube-dl.d.ts","sourceRoot":"","sources":["../../src/plugin/youtube-dl.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAG9C,qBAAa,eAAgB,SAAQ,eAAe;gBACtC,eAAe,UAAO;IAY5B,QAAQ;IAIR,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;KAAE;IAkBnF,YAAY,CAAC,GAAG,EAAE,MAAM;CAW/B"}

package/dist/plugin/youtube-dl.js

@@ -18,15 +18,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.YouTubeDLPlugin = void 0;
 const youtube_dl_1 = __importStar(require("@distube/youtube-dl"));
-const ExtractorPlugin_1 = __importDefault(require("../struct/ExtractorPlugin"));
-const struct_1 = require("../struct");
-class YouTubeDLPlugin extends ExtractorPlugin_1.default {
+const __1 = require("..");
+class YouTubeDLPlugin extends __1.ExtractorPlugin {
     constructor(updateYouTubeDL = true) {
         super();
         if (updateYouTubeDL) {
@@ -42,7 +38,7 @@ class YouTubeDLPlugin extends ExtractorPlugin_1.default {
     async validate() {
         return true;
     }
-    async resolve(url, member) {
+    async resolve(url, { member, metadata }) {
         const info = await (0, youtube_dl_1.default)(url, {
             dumpSingleJson: true,
             noWarnings: true,
@@ -53,10 +49,10 @@ class YouTubeDLPlugin extends ExtractorPlugin_1.default {
         });
         if (Array.isArray(info.entries) && info.entries.length > 0) {
             info.source = info.extractor.match(/\w+/)[0];
-            info.songs = info.entries.map((i) => new struct_1.Song(i, member, i.extractor));
-            return new struct_1.Playlist(info, member);
+            info.songs = info.entries.map((i) => new __1.Song(i, { member, source: i.extractor, metadata }));
+            return new __1.Playlist(info, { member, metadata, properties: { source: info.songs[0]?.source } });
         }
-        return new struct_1.Song(info, member, info.extractor);
+        return new __1.Song(info, { member, source: info.extractor, metadata });
     }
     async getStreamURL(url) {
         const info = await (0, youtube_dl_1.default)(url, {
@@ -71,5 +67,4 @@ class YouTubeDLPlugin extends ExtractorPlugin_1.default {
     }
 }
 exports.YouTubeDLPlugin = YouTubeDLPlugin;
-exports.default = YouTubeDLPlugin;
 //# sourceMappingURL=youtube-dl.js.map

package/dist/plugin/youtube-dl.js.map

@@ -1 +1 @@
-{"version":3,"file":"youtube-dl.js","sourceRoot":"","sources":["../../src/plugin/youtube-dl.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kEAA8D;AAC9D,gFAAwD;AACxD,sCAA2C;AAK3C,MAAa,eAAgB,SAAQ,yBAAe;IAClD,YAAY,eAAe,GAAG,IAAI;QAChC,KAAK,EAAE,CAAC;QACR,IAAI,eAAe,EAAE;YACnB,+BAA+B;YAC/B,IAAA,qBAAQ,GAAE;iBACP,IAAI,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,OAAO,GAAG,CAAC,CAAC;iBAClF,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;iBACpB,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,+DAA+D,CAAC,CAAC,CAAC;YAC9F,8BAA8B;SAC/B;IACH,CAAC;IACD,4DAA4D;IAC5D,KAAK,CAAC,QAAQ;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,MAAmB;QAC5C,MAAM,IAAI,GAAQ,MAAM,IAAA,oBAAa,EAAC,GAAG,EAAE;YACzC,cAAc,EAAE,IAAI;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,IAAI;YAChB,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAA6B,EAAE,EAAE,CAAC,IAAI,aAAI,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;YACnG,OAAO,IAAI,iBAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SACnC;QACD,OAAO,IAAI,aAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAChD,CAAC;IACD,KAAK,CAAC,YAAY,CAAC,GAAW;QAC5B,MAAM,IAAI,GAAG,MAAM,IAAA,oBAAa,EAAC,GAAG,EAAE;YACpC,cAAc,EAAE,IAAI;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,IAAI;YAChB,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;CACF;AA3CD,0CA2CC;AAED,kBAAe,eAAe,CAAC","sourcesContent":["import youtubeDlExec, { download } from \"@distube/youtube-dl\";\nimport ExtractorPlugin from \"../struct/ExtractorPlugin\";\nimport { Playlist, Song } from \"../struct\";\nimport type { OtherSongInfo } from \"..\";\nimport type { GuildMember } from \"discord.js\";\nimport type { YtResponse } from \"@distube/youtube-dl\";\n\nexport class YouTubeDLPlugin extends ExtractorPlugin {\n  constructor(updateYouTubeDL = true) {\n    super();\n    if (updateYouTubeDL) {\n      /* eslint-disable no-console */\n      download()\n        .then((version: any) => console.log(`[DisTube] Updated youtube-dl to ${version}!`))\n        .catch(console.error)\n        .catch(() => console.warn(\"[DisTube] Unable to update youtube-dl, using default version.\"));\n      /* eslint-enable no-console */\n    }\n  }\n  // eslint-disable-next-line @typescript-eslint/require-await\n  async validate() {\n    return true;\n  }\n  async resolve(url: string, member: GuildMember) {\n    const info: any = await youtubeDlExec(url, {\n      dumpSingleJson: true,\n      noWarnings: true,\n      noCallHome: true,\n      preferFreeFormats: true,\n    }).catch(e => {\n      throw new Error(`[youtube-dl] ${e.stderr || e}`);\n    });\n    if (Array.isArray(info.entries) && info.entries.length > 0) {\n      info.source = info.extractor.match(/\\w+/)[0];\n      info.songs = info.entries.map((i: OtherSongInfo & YtResponse) => new Song(i, member, i.extractor));\n      return new Playlist(info, member);\n    }\n    return new Song(info, member, info.extractor);\n  }\n  async getStreamURL(url: string) {\n    const info = await youtubeDlExec(url, {\n      dumpSingleJson: true,\n      noWarnings: true,\n      noCallHome: true,\n      preferFreeFormats: true,\n    }).catch(e => {\n      throw new Error(`[youtube-dl] ${e.stderr || e}`);\n    });\n    return info.url;\n  }\n}\n\nexport default YouTubeDLPlugin;\n"]}
+{"version":3,"file":"youtube-dl.js","sourceRoot":"","sources":["../../src/plugin/youtube-dl.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,kEAA8D;AAC9D,0BAAqD;AAKrD,MAAa,eAAgB,SAAQ,mBAAe;IAClD,YAAY,eAAe,GAAG,IAAI;QAChC,KAAK,EAAE,CAAC;QACR,IAAI,eAAe,EAAE;YACnB,+BAA+B;YAC/B,IAAA,qBAAQ,GAAE;iBACP,IAAI,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,OAAO,GAAG,CAAC,CAAC;iBAClF,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;iBACpB,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,+DAA+D,CAAC,CAAC,CAAC;YAC9F,8BAA8B;SAC/B;IACH,CAAC;IACD,4DAA4D;IAC5D,KAAK,CAAC,QAAQ;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,EAAE,MAAM,EAAE,QAAQ,EAA4C;QACvF,MAAM,IAAI,GAAQ,MAAM,IAAA,oBAAa,EAAC,GAAG,EAAE;YACzC,cAAc,EAAE,IAAI;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,IAAI;YAChB,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAC3B,CAAC,CAA6B,EAAE,EAAE,CAAC,IAAI,QAAI,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC,CAC1F,CAAC;YACF,OAAO,IAAI,YAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;SAChG;QACD,OAAO,IAAI,QAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IACtE,CAAC;IACD,KAAK,CAAC,YAAY,CAAC,GAAW;QAC5B,MAAM,IAAI,GAAG,MAAM,IAAA,oBAAa,EAAC,GAAG,EAAE;YACpC,cAAc,EAAE,IAAI;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,IAAI;YAChB,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;CACF;AA9CD,0CA8CC","sourcesContent":["import youtubeDlExec, { download } from \"@distube/youtube-dl\";\nimport { ExtractorPlugin, Playlist, Song } from \"..\";\nimport type { OtherSongInfo } from \"..\";\nimport type { GuildMember } from \"discord.js\";\nimport type { YtResponse } from \"@distube/youtube-dl\";\n\nexport class YouTubeDLPlugin extends ExtractorPlugin {\n  constructor(updateYouTubeDL = true) {\n    super();\n    if (updateYouTubeDL) {\n      /* eslint-disable no-console */\n      download()\n        .then((version: any) => console.log(`[DisTube] Updated youtube-dl to ${version}!`))\n        .catch(console.error)\n        .catch(() => console.warn(\"[DisTube] Unable to update youtube-dl, using default version.\"));\n      /* eslint-enable no-console */\n    }\n  }\n  // eslint-disable-next-line @typescript-eslint/require-await\n  async validate() {\n    return true;\n  }\n\n  async resolve(url: string, { member, metadata }: { member?: GuildMember; metadata?: any }) {\n    const info: any = await youtubeDlExec(url, {\n      dumpSingleJson: true,\n      noWarnings: true,\n      noCallHome: true,\n      preferFreeFormats: true,\n    }).catch(e => {\n      throw new Error(`[youtube-dl] ${e.stderr || e}`);\n    });\n    if (Array.isArray(info.entries) && info.entries.length > 0) {\n      info.source = info.extractor.match(/\\w+/)[0];\n      info.songs = info.entries.map(\n        (i: OtherSongInfo & YtResponse) => new Song(i, { member, source: i.extractor, metadata }),\n      );\n      return new Playlist(info, { member, metadata, properties: { source: info.songs[0]?.source } });\n    }\n    return new Song(info, { member, source: info.extractor, metadata });\n  }\n  async getStreamURL(url: string) {\n    const info = await youtubeDlExec(url, {\n      dumpSingleJson: true,\n      noWarnings: true,\n      noCallHome: true,\n      preferFreeFormats: true,\n    }).catch(e => {\n      throw new Error(`[youtube-dl] ${e.stderr || e}`);\n    });\n    return info.url;\n  }\n}\n"]}

package/dist/struct/CustomPlugin.d.ts

@@ -1,27 +1,47 @@
-import Plugin from "./Plugin";
+import { Plugin } from ".";
 import { PluginType } from "..";
-import type { GuildMember, StageChannel, TextChannel, VoiceChannel } from "discord.js";
+import type { GuildMember, GuildTextBasedChannel, VoiceBasedChannel } from "discord.js";
 /**
  * Custom Plugin
  * @extends Plugin
  * @abstract
  */
 export declare abstract class CustomPlugin extends Plugin {
+    /**
+     * This method will be executed if the url is validated.
+     * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
+     * @param {string} song Validated url
+     * @param {Object} [options] Optional options
+     * @param {Discord.GuildMember} [options.member] Requested user
+     * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}
+     * @param {boolean} [options.skip] Skip the playing song (if exists) and play the added song/playlist instantly
+     * @param {boolean} [options.unshift] Add the song/playlist after the playing song if exists
+     * @param {*} [options.metadata] Metadata
+     * @returns {Promise<void>}
+     * @abstract
+     * @method play
+     * @memberof CustomPlugin#
+     */
     type: PluginType;
-    abstract play(voiceChannel: VoiceChannel | StageChannel, url: string, member: GuildMember, textChannel: TextChannel | undefined, skip: boolean, unshift: boolean): Promise<void>;
+    /**
+     * This method will be executed if the url is validated.
+     * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
+     * @param {string} song Validated url
+     * @param {Object} [options] Optional options
+     * @param {Discord.GuildMember} [options.member] Requested user
+     * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}
+     * @param {boolean} [options.skip] Skip the playing song (if exists) and play the added song/playlist instantly
+     * @param {boolean} [options.unshift] Add the song/playlist after the playing song if exists
+     * @param {*} [options.metadata] Metadata
+     * @returns {Promise<void>}
+     * @abstract
+     */
+    abstract play(voiceChannel: VoiceBasedChannel, song: string, options: {
+        skip?: boolean;
+        unshift?: boolean;
+        member?: GuildMember;
+        textChannel?: GuildTextBasedChannel;
+        metadata?: any;
+    }): Promise<void>;
 }
-/**
- * This method will be executed if the url is validated.
- * @param {Discord.VoiceChannel|Discord.StageChannel} voiceChannel The voice channel will be joined
- * @param {string} url Validated url
- * @param {Discord.GuildMember} member Requested user
- * @param {Discord.TextChannel?} textChannel Default {@link Queue#textChannel}
- * @param {boolean} skip Skip the playing song (if exists) and play the added song/playlist instantly
- * @param {boolean} unshift Add the song/playlist to the beginning of the queue (after the playing song if exists)
- * @returns {Promise<void>}
- * @method play
- * @memberof CustomPlugin#
- * @abstract
- */
-export default CustomPlugin;
 //# sourceMappingURL=CustomPlugin.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"CustomPlugin.d.ts","sourceRoot":"","sources":["../../src/struct/CustomPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAEvF;;;;GAIG;AACH,8BAAsB,YAAa,SAAQ,MAAM;IAC/C,IAAI,aAAqB;IACzB,QAAQ,CAAC,IAAI,CACX,YAAY,EAAE,YAAY,GAAG,YAAY,EACzC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,WAAW,GAAG,SAAS,EACpC,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,IAAI,CAAC;CACjB;AAED;;;;;;;;;;;;GAYG;AAEH,eAAe,YAAY,CAAC"}
+{"version":3,"file":"CustomPlugin.d.ts","sourceRoot":"","sources":["../../src/struct/CustomPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,KAAK,EAAE,WAAW,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAIxF;;;;GAIG;AACH,8BAAsB,YAAa,SAAQ,MAAM;IAC/C;;;;;;;;;;;;;;OAcG;IACH,IAAI,aAAqB;IACzB;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,IAAI,CACX,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,QAAQ,CAAC,EAAE,GAAG,CAAC;KAChB,GACA,OAAO,CAAC,IAAI,CAAC;CACjB"}

package/dist/struct/CustomPlugin.js

@@ -1,35 +1,34 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomPlugin = void 0;
-const Plugin_1 = __importDefault(require("./Plugin"));
+const _1 = require(".");
 const __1 = require("..");
+// TODO: Clean parameters on the next major version.
 /**
  * Custom Plugin
  * @extends Plugin
  * @abstract
  */
-class CustomPlugin extends Plugin_1.default {
+class CustomPlugin extends _1.Plugin {
     constructor() {
         super(...arguments);
+        /**
+         * This method will be executed if the url is validated.
+         * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
+         * @param {string} song Validated url
+         * @param {Object} [options] Optional options
+         * @param {Discord.GuildMember} [options.member] Requested user
+         * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}
+         * @param {boolean} [options.skip] Skip the playing song (if exists) and play the added song/playlist instantly
+         * @param {boolean} [options.unshift] Add the song/playlist after the playing song if exists
+         * @param {*} [options.metadata] Metadata
+         * @returns {Promise<void>}
+         * @abstract
+         * @method play
+         * @memberof CustomPlugin#
+         */
         this.type = __1.PluginType.CUSTOM;
     }
 }
 exports.CustomPlugin = CustomPlugin;
-/**
- * This method will be executed if the url is validated.
- * @param {Discord.VoiceChannel|Discord.StageChannel} voiceChannel The voice channel will be joined
- * @param {string} url Validated url
- * @param {Discord.GuildMember} member Requested user
- * @param {Discord.TextChannel?} textChannel Default {@link Queue#textChannel}
- * @param {boolean} skip Skip the playing song (if exists) and play the added song/playlist instantly
- * @param {boolean} unshift Add the song/playlist to the beginning of the queue (after the playing song if exists)
- * @returns {Promise<void>}
- * @method play
- * @memberof CustomPlugin#
- * @abstract
- */
-exports.default = CustomPlugin;
 //# sourceMappingURL=CustomPlugin.js.map

package/dist/struct/CustomPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"CustomPlugin.js","sourceRoot":"","sources":["../../src/struct/CustomPlugin.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAC9B,0BAAgC;AAGhC;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,gBAAM;IAAjD;;QACE,SAAI,GAAG,cAAU,CAAC,MAAM,CAAC;IAS3B,CAAC;CAAA;AAVD,oCAUC;AAED;;;;;;;;;;;;GAYG;AAEH,kBAAe,YAAY,CAAC","sourcesContent":["import Plugin from \"./Plugin\";\nimport { PluginType } from \"..\";\nimport type { GuildMember, StageChannel, TextChannel, VoiceChannel } from \"discord.js\";\n\n/**\n * Custom Plugin\n * @extends Plugin\n * @abstract\n */\nexport abstract class CustomPlugin extends Plugin {\n  type = PluginType.CUSTOM;\n  abstract play(\n    voiceChannel: VoiceChannel | StageChannel,\n    url: string,\n    member: GuildMember,\n    textChannel: TextChannel | undefined,\n    skip: boolean,\n    unshift: boolean,\n  ): Promise<void>;\n}\n\n/**\n * This method will be executed if the url is validated.\n * @param {Discord.VoiceChannel|Discord.StageChannel} voiceChannel The voice channel will be joined\n * @param {string} url Validated url\n * @param {Discord.GuildMember} member Requested user\n * @param {Discord.TextChannel?} textChannel Default {@link Queue#textChannel}\n * @param {boolean} skip Skip the playing song (if exists) and play the added song/playlist instantly\n * @param {boolean} unshift Add the song/playlist to the beginning of the queue (after the playing song if exists)\n * @returns {Promise<void>}\n * @method play\n * @memberof CustomPlugin#\n * @abstract\n */\n\nexport default CustomPlugin;\n"]}
+{"version":3,"file":"CustomPlugin.js","sourceRoot":"","sources":["../../src/struct/CustomPlugin.ts"],"names":[],"mappings":";;;AAAA,wBAA2B;AAC3B,0BAAgC;AAGhC,oDAAoD;AAEpD;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,SAAM;IAAjD;;QACE;;;;;;;;;;;;;;WAcG;QACH,SAAI,GAAG,cAAU,CAAC,MAAM,CAAC;IAyB3B,CAAC;CAAA;AAzCD,oCAyCC","sourcesContent":["import { Plugin } from \".\";\nimport { PluginType } from \"..\";\nimport type { GuildMember, GuildTextBasedChannel, VoiceBasedChannel } from \"discord.js\";\n\n// TODO: Clean parameters on the next major version.\n\n/**\n * Custom Plugin\n * @extends Plugin\n * @abstract\n */\nexport abstract class CustomPlugin extends Plugin {\n  /**\n   * This method will be executed if the url is validated.\n   * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined\n   * @param {string} song Validated url\n   * @param {Object} [options] Optional options\n   * @param {Discord.GuildMember} [options.member] Requested user\n   * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}\n   * @param {boolean} [options.skip] Skip the playing song (if exists) and play the added song/playlist instantly\n   * @param {boolean} [options.unshift] Add the song/playlist after the playing song if exists\n   * @param {*} [options.metadata] Metadata\n   * @returns {Promise<void>}\n   * @abstract\n   * @method play\n   * @memberof CustomPlugin#\n   */\n  type = PluginType.CUSTOM;\n  /**\n   * This method will be executed if the url is validated.\n   * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined\n   * @param {string} song Validated url\n   * @param {Object} [options] Optional options\n   * @param {Discord.GuildMember} [options.member] Requested user\n   * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}\n   * @param {boolean} [options.skip] Skip the playing song (if exists) and play the added song/playlist instantly\n   * @param {boolean} [options.unshift] Add the song/playlist after the playing song if exists\n   * @param {*} [options.metadata] Metadata\n   * @returns {Promise<void>}\n   * @abstract\n   */\n  abstract play(\n    voiceChannel: VoiceBasedChannel,\n    song: string,\n    options: {\n      skip?: boolean;\n      unshift?: boolean;\n      member?: GuildMember;\n      textChannel?: GuildTextBasedChannel;\n      metadata?: any;\n    },\n  ): Promise<void>;\n}\n"]}

package/dist/struct/DisTubeError.d.ts

@@ -3,13 +3,14 @@ declare const ERROR_MESSAGES: {
     NUMBER_COMPARE: (name: string, expected: string, value: number) => string;
     EMPTY_ARRAY: (name: string) => string;
     EMPTY_FILTERED_ARRAY: (name: string, type: string) => string;
-    INVALID_KEY: (obj: string, key: string) => string;
     EMPTY_STRING: (name: string) => string;
+    INVALID_KEY: (obj: string, key: string) => string;
+    MISSING_KEY: (obj: string, key: string) => string;
+    MISSING_KEYS: (obj: string, key: string[], all: boolean) => string;
     MISSING_INTENTS: (i: string) => string;
     DISABLED_OPTION: (o: string) => string;
     ENABLED_OPTION: (o: string) => string;
     NOT_IN_VOICE: string;
-    NOT_SUPPORTED_VOICE: string;
     VOICE_FULL: string;
     VOICE_CONNECT_FAILED: (s: number) => string;
     VOICE_MISSING_PERMS: string;
@@ -52,5 +53,5 @@ export declare class DisTubeError<T extends string> extends Error {
     get name(): string;
     get code(): string;
 }
-export default DisTubeError;
+export {};
 //# sourceMappingURL=DisTubeError.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"DisTubeError.d.ts","sourceRoot":"","sources":["../../src/struct/DisTubeError.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,cAAc;6BACO,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,OAAO,GAAG;2BAI5D,MAAM,YAAY,MAAM,SAAS,MAAM;wBAC1C,MAAM;iCACG,MAAM,QAAQ,MAAM;uBAC9B,MAAM,OAAO,MAAM;yBACjB,MAAM;yBAEN,MAAM;yBACN,MAAM;wBACP,MAAM;;;;8BAKA,MAAM;;;;;;;;;;;;;;;;;;;;;6BAyBP,MAAM;;;;CAMhC,CAAC;AAEF,aAAK,aAAa,GAAG,OAAO,cAAc,CAAC;AAC3C,aAAK,UAAU,GAAG,MAAM,aAAa,CAAC;AACtC,aAAK,SAAS,GAAG;KAAG,CAAC,IAAI,UAAU,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,UAAU,CAAC,CAAC;AAClG,aAAK,iBAAiB,GAAG,OAAO,CAAC,MAAM,OAAO,cAAc,EAAE,SAAS,CAAC,CAAC;AAMzE,qBAAa,YAAY,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,KAAK;IACvD,SAAS,EAAE,MAAM,CAAC;gBACN,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,CAAC,SAAS,iBAAiB,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,CAAC;gBAC9F,IAAI,EAAE,iBAAiB,EAAE,CAAC,EAAE,KAAK;gBACjC,IAAI,EAAE,CAAC,SAAS,UAAU,GAAG,6BAA6B,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM;IAS3F,IAAI,IAAI,WAEP;IAED,IAAI,IAAI,WAEP;CACF;AAED,eAAe,YAAY,CAAC"}
+{"version":3,"file":"DisTubeError.d.ts","sourceRoot":"","sources":["../../src/struct/DisTubeError.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,cAAc;6BACO,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,OAAO,GAAG;2BAI5D,MAAM,YAAY,MAAM,SAAS,MAAM;wBAC1C,MAAM;iCACG,MAAM,QAAQ,MAAM;yBAC5B,MAAM;uBACR,MAAM,OAAO,MAAM;uBACnB,MAAM,OAAO,MAAM;wBAClB,MAAM,OAAO,MAAM,EAAE,OAAO,OAAO;yBAGlC,MAAM;yBACN,MAAM;wBACP,MAAM;;;8BAIA,MAAM;;;;;;;;;;;;;;;;;;;;;6BAyBP,MAAM;;;;CAMhC,CAAC;AAEF,aAAK,aAAa,GAAG,OAAO,cAAc,CAAC;AAC3C,aAAK,UAAU,GAAG,MAAM,aAAa,CAAC;AACtC,aAAK,SAAS,GAAG;KAAG,CAAC,IAAI,UAAU,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,UAAU,CAAC,CAAC;AAClG,aAAK,iBAAiB,GAAG,OAAO,CAAC,MAAM,OAAO,cAAc,EAAE,SAAS,CAAC,CAAC;AAMzE,qBAAa,YAAY,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,KAAK;IACvD,SAAS,EAAE,MAAM,CAAC;gBACN,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,CAAC,SAAS,iBAAiB,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,CAAC;gBAC9F,IAAI,EAAE,iBAAiB,EAAE,CAAC,EAAE,KAAK;gBACjC,IAAI,EAAE,CAAC,SAAS,UAAU,GAAG,6BAA6B,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM;IAS3F,IAAI,IAAI,WAEP;IAED,IAAI,IAAI,WAEP;CACF"}

package/dist/struct/DisTubeError.js

@@ -1,21 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DisTubeError = void 0;
+const node_util_1 = require("node:util");
 const ERROR_MESSAGES = {
-    INVALID_TYPE: (expected, got, name) => {
-        var _a, _b;
-        return `Expected ${Array.isArray(expected) ? expected.map(e => (typeof e === "number" ? e : `'${e}'`)).join(" or ") : `'${expected}'`}${name ? ` for '${name}'` : ""}, but got ${JSON.stringify(got)} (${(_b = (_a = got === null || got === void 0 ? void 0 : got.constructor) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : typeof got})`;
-    },
+    INVALID_TYPE: (expected, got, name) => `Expected ${Array.isArray(expected) ? expected.map(e => (typeof e === "number" ? e : `'${e}'`)).join(" or ") : `'${expected}'`}${name ? ` for '${name}'` : ""}, but got ${(0, node_util_1.inspect)(got)}`,
     NUMBER_COMPARE: (name, expected, value) => `'${name}' must be ${expected} ${value}`,
     EMPTY_ARRAY: (name) => `'${name}' is an empty array`,
     EMPTY_FILTERED_ARRAY: (name, type) => `There is no valid '${type}' in the '${name}' array`,
-    INVALID_KEY: (obj, key) => `'${key}' does not need to be provided in ${obj}`,
     EMPTY_STRING: (name) => `'${name}' string must not be empty`,
+    INVALID_KEY: (obj, key) => `'${key}' does not need to be provided in ${obj}`,
+    MISSING_KEY: (obj, key) => `'${key}' needs to be provided in ${obj}`,
+    MISSING_KEYS: (obj, key, all) => `${key.map(k => `'${k}'`).join(all ? " and " : " or ")} need to be provided in ${obj}`,
     MISSING_INTENTS: (i) => `${i} intent must be provided for the Client`,
     DISABLED_OPTION: (o) => `DisTubeOptions.${o} is disabled`,
     ENABLED_OPTION: (o) => `DisTubeOptions.${o} is enabled`,
     NOT_IN_VOICE: "User is not in any voice channel",
-    NOT_SUPPORTED_VOICE: "DisTubeVoice only supports VoiceChannel or a StageChannel",
     VOICE_FULL: "The voice channel is full",
     VOICE_CONNECT_FAILED: (s) => `Cannot connect to the voice channel after ${s} seconds`,
     VOICE_MISSING_PERMS: "You do not have permission to join this voice channel",
@@ -65,5 +64,4 @@ class DisTubeError extends Error {
     }
 }
 exports.DisTubeError = DisTubeError;
-exports.default = DisTubeError;
 //# sourceMappingURL=DisTubeError.js.map

package/dist/struct/DisTubeError.js.map

@@ -1 +1 @@
-{"version":3,"file":"DisTubeError.js","sourceRoot":"","sources":["../../src/struct/DisTubeError.ts"],"names":[],"mappings":";;;AAAA,MAAM,cAAc,GAAG;IACrB,YAAY,EAAE,CAAC,QAA0D,EAAE,GAAQ,EAAE,IAAa,EAAE,EAAE;;QACpG,OAAA,YACE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,QAAQ,GACjH,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,aAAa,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,0CAAE,IAAI,mCAAI,OAAO,GAAG,GAAG,CAAA;KAAA;IAC7G,cAAc,EAAE,CAAC,IAAY,EAAE,QAAgB,EAAE,KAAa,EAAE,EAAE,CAAC,IAAI,IAAI,aAAa,QAAQ,IAAI,KAAK,EAAE;IAC3G,WAAW,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,IAAI,qBAAqB;IAC5D,oBAAoB,EAAE,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE,CAAC,sBAAsB,IAAI,aAAa,IAAI,SAAS;IAC1G,WAAW,EAAE,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,GAAG,qCAAqC,GAAG,EAAE;IAC5F,YAAY,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,IAAI,4BAA4B;IAEpE,eAAe,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,GAAG,CAAC,yCAAyC;IAC7E,eAAe,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,cAAc;IACjE,cAAc,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,aAAa;IAE/D,YAAY,EAAE,kCAAkC;IAChD,mBAAmB,EAAE,2DAA2D;IAChF,UAAU,EAAE,2BAA2B;IACvC,oBAAoB,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,6CAA6C,CAAC,UAAU;IAC7F,mBAAmB,EAAE,uDAAuD;IAC5E,sBAAsB,EAAE,uCAAuC;IAC/D,kBAAkB,EAAE,4CAA4C;IAChE,2BAA2B,EACzB,kFAAkF;QAClF,2EAA2E;IAE7E,QAAQ,EAAE,yCAAyC;IACnD,WAAW,EAAE,gCAAgC;IAC7C,kBAAkB,EAAE,yCAAyC;IAC7D,MAAM,EAAE,mCAAmC;IAC3C,OAAO,EAAE,oCAAoC;IAC7C,WAAW,EAAE,yCAAyC;IACtD,UAAU,EAAE,0BAA0B;IACtC,gBAAgB,EAAE,yCAAyC;IAC3D,UAAU,EAAE,uCAAuC;IAEnD,SAAS,EAAE,iBAAiB;IAC5B,UAAU,EAAE,+BAA+B;IAC3C,mBAAmB,EAAE,8BAA8B;IACnD,iBAAiB,EAAE,2BAA2B;IAC9C,kBAAkB,EAAE,0BAA0B;IAC9C,QAAQ,EAAE,wDAAwD;IAClE,iBAAiB,EAAE,2BAA2B;IAC9C,mBAAmB,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,YAAY;IACnE,aAAa,EAAE,iEAAiE;IAChF,uBAAuB,EACrB,2CAA2C;QAC3C,+EAA+E;IACjF,cAAc,EAAE,yCAAyC;CAC1D,CAAC;AAOF,MAAM,MAAM,GAAG,CAAC,GAAqC,EAAE,GAAG,IAAS,EAAE,EAAE,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;AAEvH,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAsB,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAElG,MAAa,YAA+B,SAAQ,KAAK;IAMvD,YAAY,IAAY,EAAE,GAAG,IAAS;QACpC,IAAI,QAAQ,CAAC,IAAI,CAAC;YAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;;YAC5D,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;QAEpB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,KAAK,CAAC,iBAAiB;YAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,IAAI;QACN,OAAO,iBAAiB,IAAI,CAAC,SAAS,GAAG,CAAC;IAC5C,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;CACF;AArBD,oCAqBC;AAED,kBAAe,YAAY,CAAC","sourcesContent":["const ERROR_MESSAGES = {\n  INVALID_TYPE: (expected: (number | string) | readonly (number | string)[], got: any, name?: string) =>\n    `Expected ${\n      Array.isArray(expected) ? expected.map(e => (typeof e === \"number\" ? e : `'${e}'`)).join(\" or \") : `'${expected}'`\n    }${name ? ` for '${name}'` : \"\"}, but got ${JSON.stringify(got)} (${got?.constructor?.name ?? typeof got})`,\n  NUMBER_COMPARE: (name: string, expected: string, value: number) => `'${name}' must be ${expected} ${value}`,\n  EMPTY_ARRAY: (name: string) => `'${name}' is an empty array`,\n  EMPTY_FILTERED_ARRAY: (name: string, type: string) => `There is no valid '${type}' in the '${name}' array`,\n  INVALID_KEY: (obj: string, key: string) => `'${key}' does not need to be provided in ${obj}`,\n  EMPTY_STRING: (name: string) => `'${name}' string must not be empty`,\n\n  MISSING_INTENTS: (i: string) => `${i} intent must be provided for the Client`,\n  DISABLED_OPTION: (o: string) => `DisTubeOptions.${o} is disabled`,\n  ENABLED_OPTION: (o: string) => `DisTubeOptions.${o} is enabled`,\n\n  NOT_IN_VOICE: \"User is not in any voice channel\",\n  NOT_SUPPORTED_VOICE: \"DisTubeVoice only supports VoiceChannel or a StageChannel\",\n  VOICE_FULL: \"The voice channel is full\",\n  VOICE_CONNECT_FAILED: (s: number) => `Cannot connect to the voice channel after ${s} seconds`,\n  VOICE_MISSING_PERMS: \"You do not have permission to join this voice channel\",\n  VOICE_RECONNECT_FAILED: \"Cannot reconnect to the voice channel\",\n  VOICE_CHANGE_GUILD: \"Cannot join a channel in a different guild\",\n  VOICE_DEPRECATED_CONNECTION:\n    \"Cannot connect to the voice channel due to a deprecated connection is created.\\n\" +\n    \"Read more: https://distube.js.org/guide/additional-info/update.html#voice\",\n\n  NO_QUEUE: \"There is no playing queue in this guild\",\n  QUEUE_EXIST: \"This guild has a Queue already\",\n  ADD_BEFORE_PLAYING: \"Cannot add Song before the playing Song\",\n  PAUSED: \"The queue has been paused already\",\n  RESUMED: \"The queue has been playing already\",\n  NO_PREVIOUS: \"There is no previous song in this queue\",\n  NO_UP_NEXT: \"There is no up next song\",\n  NO_SONG_POSITION: \"Does not have any song at this position\",\n  NO_PLAYING: \"There is no playing song in the queue\",\n\n  NO_RESULT: \"No result found\",\n  NO_RELATED: \"Cannot find any related songs\",\n  CANNOT_PLAY_RELATED: \"Cannot play the related song\",\n  UNAVAILABLE_VIDEO: \"This video is unavailable\",\n  UNPLAYABLE_FORMATS: \"No playable format found\",\n  NON_NSFW: \"Cannot play age-restricted content in non-NSFW channel\",\n  NOT_SUPPORTED_URL: \"This url is not supported\",\n  CANNOT_RESOLVE_SONG: (t: string) => `Cannot resolve ${t} to a Song`,\n  NO_VALID_SONG: \"'songs' array does not have any valid Song, SearchResult or url\",\n  EMPTY_FILTERED_PLAYLIST:\n    \"There is no valid video in the playlist\\n\" +\n    \"Maybe age-restricted contents is filtered because you are in non-NSFW channel\",\n  EMPTY_PLAYLIST: \"There is no valid video in the playlist\",\n};\n\ntype ErrorMessages = typeof ERROR_MESSAGES;\ntype ErrorCodes = keyof ErrorMessages;\ntype ErrorCode = { [K in ErrorCodes]-?: ErrorMessages[K] extends string ? K : never }[ErrorCodes];\ntype ErrorCodeTemplate = Exclude<keyof typeof ERROR_MESSAGES, ErrorCode>;\n\nconst errMsg = (msg: string | ((...x: any) => string), ...args: any) => (typeof msg === \"string\" ? msg : msg(...args));\n\nconst haveCode = (code: string): code is ErrorCodes => Object.keys(ERROR_MESSAGES).includes(code);\n\nexport class DisTubeError<T extends string> extends Error {\n  errorCode: string;\n  constructor(code: ErrorCode);\n  constructor(code: T extends ErrorCodeTemplate ? T : never, ...args: Parameters<ErrorMessages[typeof code]>);\n  constructor(code: ErrorCodeTemplate, _: never);\n  constructor(code: T extends ErrorCodes ? \"This is built-in error code\" : T, message: string);\n  constructor(code: string, ...args: any) {\n    if (haveCode(code)) super(errMsg(ERROR_MESSAGES[code], ...args));\n    else super(...args);\n\n    this.errorCode = code;\n    if (Error.captureStackTrace) Error.captureStackTrace(this, DisTubeError);\n  }\n\n  get name() {\n    return `DisTubeError [${this.errorCode}]`;\n  }\n\n  get code() {\n    return this.errorCode;\n  }\n}\n\nexport default DisTubeError;\n"]}
+{"version":3,"file":"DisTubeError.js","sourceRoot":"","sources":["../../src/struct/DisTubeError.ts"],"names":[],"mappings":";;;AAAA,yCAAoC;AAEpC,MAAM,cAAc,GAAG;IACrB,YAAY,EAAE,CAAC,QAA0D,EAAE,GAAQ,EAAE,IAAa,EAAE,EAAE,CACpG,YACE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,QAAQ,GACjH,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,aAAa,IAAA,mBAAO,EAAC,GAAG,CAAC,EAAE;IAC5D,cAAc,EAAE,CAAC,IAAY,EAAE,QAAgB,EAAE,KAAa,EAAE,EAAE,CAAC,IAAI,IAAI,aAAa,QAAQ,IAAI,KAAK,EAAE;IAC3G,WAAW,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,IAAI,qBAAqB;IAC5D,oBAAoB,EAAE,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE,CAAC,sBAAsB,IAAI,aAAa,IAAI,SAAS;IAC1G,YAAY,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,IAAI,4BAA4B;IACpE,WAAW,EAAE,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,GAAG,qCAAqC,GAAG,EAAE;IAC5F,WAAW,EAAE,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,GAAG,6BAA6B,GAAG,EAAE;IACpF,YAAY,EAAE,CAAC,GAAW,EAAE,GAAa,EAAE,GAAY,EAAE,EAAE,CACzD,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,2BAA2B,GAAG,EAAE;IAExF,eAAe,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,GAAG,CAAC,yCAAyC;IAC7E,eAAe,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,cAAc;IACjE,cAAc,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,aAAa;IAE/D,YAAY,EAAE,kCAAkC;IAChD,UAAU,EAAE,2BAA2B;IACvC,oBAAoB,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,6CAA6C,CAAC,UAAU;IAC7F,mBAAmB,EAAE,uDAAuD;IAC5E,sBAAsB,EAAE,uCAAuC;IAC/D,kBAAkB,EAAE,4CAA4C;IAChE,2BAA2B,EACzB,kFAAkF;QAClF,2EAA2E;IAE7E,QAAQ,EAAE,yCAAyC;IACnD,WAAW,EAAE,gCAAgC;IAC7C,kBAAkB,EAAE,yCAAyC;IAC7D,MAAM,EAAE,mCAAmC;IAC3C,OAAO,EAAE,oCAAoC;IAC7C,WAAW,EAAE,yCAAyC;IACtD,UAAU,EAAE,0BAA0B;IACtC,gBAAgB,EAAE,yCAAyC;IAC3D,UAAU,EAAE,uCAAuC;IAEnD,SAAS,EAAE,iBAAiB;IAC5B,UAAU,EAAE,+BAA+B;IAC3C,mBAAmB,EAAE,8BAA8B;IACnD,iBAAiB,EAAE,2BAA2B;IAC9C,kBAAkB,EAAE,0BAA0B;IAC9C,QAAQ,EAAE,wDAAwD;IAClE,iBAAiB,EAAE,2BAA2B;IAC9C,mBAAmB,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,YAAY;IACnE,aAAa,EAAE,iEAAiE;IAChF,uBAAuB,EACrB,2CAA2C;QAC3C,+EAA+E;IACjF,cAAc,EAAE,yCAAyC;CAC1D,CAAC;AAOF,MAAM,MAAM,GAAG,CAAC,GAAqC,EAAE,GAAG,IAAS,EAAE,EAAE,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;AAEvH,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAsB,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAElG,MAAa,YAA+B,SAAQ,KAAK;IAMvD,YAAY,IAAY,EAAE,GAAG,IAAS;QACpC,IAAI,QAAQ,CAAC,IAAI,CAAC;YAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;;YAC5D,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;QAEpB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,KAAK,CAAC,iBAAiB;YAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,IAAI;QACN,OAAO,iBAAiB,IAAI,CAAC,SAAS,GAAG,CAAC;IAC5C,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;CACF;AArBD,oCAqBC","sourcesContent":["import { inspect } from \"node:util\";\n\nconst ERROR_MESSAGES = {\n  INVALID_TYPE: (expected: (number | string) | readonly (number | string)[], got: any, name?: string) =>\n    `Expected ${\n      Array.isArray(expected) ? expected.map(e => (typeof e === \"number\" ? e : `'${e}'`)).join(\" or \") : `'${expected}'`\n    }${name ? ` for '${name}'` : \"\"}, but got ${inspect(got)}`,\n  NUMBER_COMPARE: (name: string, expected: string, value: number) => `'${name}' must be ${expected} ${value}`,\n  EMPTY_ARRAY: (name: string) => `'${name}' is an empty array`,\n  EMPTY_FILTERED_ARRAY: (name: string, type: string) => `There is no valid '${type}' in the '${name}' array`,\n  EMPTY_STRING: (name: string) => `'${name}' string must not be empty`,\n  INVALID_KEY: (obj: string, key: string) => `'${key}' does not need to be provided in ${obj}`,\n  MISSING_KEY: (obj: string, key: string) => `'${key}' needs to be provided in ${obj}`,\n  MISSING_KEYS: (obj: string, key: string[], all: boolean) =>\n    `${key.map(k => `'${k}'`).join(all ? \" and \" : \" or \")} need to be provided in ${obj}`,\n\n  MISSING_INTENTS: (i: string) => `${i} intent must be provided for the Client`,\n  DISABLED_OPTION: (o: string) => `DisTubeOptions.${o} is disabled`,\n  ENABLED_OPTION: (o: string) => `DisTubeOptions.${o} is enabled`,\n\n  NOT_IN_VOICE: \"User is not in any voice channel\",\n  VOICE_FULL: \"The voice channel is full\",\n  VOICE_CONNECT_FAILED: (s: number) => `Cannot connect to the voice channel after ${s} seconds`,\n  VOICE_MISSING_PERMS: \"You do not have permission to join this voice channel\",\n  VOICE_RECONNECT_FAILED: \"Cannot reconnect to the voice channel\",\n  VOICE_CHANGE_GUILD: \"Cannot join a channel in a different guild\",\n  VOICE_DEPRECATED_CONNECTION:\n    \"Cannot connect to the voice channel due to a deprecated connection is created.\\n\" +\n    \"Read more: https://distube.js.org/guide/additional-info/update.html#voice\",\n\n  NO_QUEUE: \"There is no playing queue in this guild\",\n  QUEUE_EXIST: \"This guild has a Queue already\",\n  ADD_BEFORE_PLAYING: \"Cannot add Song before the playing Song\",\n  PAUSED: \"The queue has been paused already\",\n  RESUMED: \"The queue has been playing already\",\n  NO_PREVIOUS: \"There is no previous song in this queue\",\n  NO_UP_NEXT: \"There is no up next song\",\n  NO_SONG_POSITION: \"Does not have any song at this position\",\n  NO_PLAYING: \"There is no playing song in the queue\",\n\n  NO_RESULT: \"No result found\",\n  NO_RELATED: \"Cannot find any related songs\",\n  CANNOT_PLAY_RELATED: \"Cannot play the related song\",\n  UNAVAILABLE_VIDEO: \"This video is unavailable\",\n  UNPLAYABLE_FORMATS: \"No playable format found\",\n  NON_NSFW: \"Cannot play age-restricted content in non-NSFW channel\",\n  NOT_SUPPORTED_URL: \"This url is not supported\",\n  CANNOT_RESOLVE_SONG: (t: string) => `Cannot resolve ${t} to a Song`,\n  NO_VALID_SONG: \"'songs' array does not have any valid Song, SearchResult or url\",\n  EMPTY_FILTERED_PLAYLIST:\n    \"There is no valid video in the playlist\\n\" +\n    \"Maybe age-restricted contents is filtered because you are in non-NSFW channel\",\n  EMPTY_PLAYLIST: \"There is no valid video in the playlist\",\n};\n\ntype ErrorMessages = typeof ERROR_MESSAGES;\ntype ErrorCodes = keyof ErrorMessages;\ntype ErrorCode = { [K in ErrorCodes]-?: ErrorMessages[K] extends string ? K : never }[ErrorCodes];\ntype ErrorCodeTemplate = Exclude<keyof typeof ERROR_MESSAGES, ErrorCode>;\n\nconst errMsg = (msg: string | ((...x: any) => string), ...args: any) => (typeof msg === \"string\" ? msg : msg(...args));\n\nconst haveCode = (code: string): code is ErrorCodes => Object.keys(ERROR_MESSAGES).includes(code);\n\nexport class DisTubeError<T extends string> extends Error {\n  errorCode: string;\n  constructor(code: ErrorCode);\n  constructor(code: T extends ErrorCodeTemplate ? T : never, ...args: Parameters<ErrorMessages[typeof code]>);\n  constructor(code: ErrorCodeTemplate, _: never);\n  constructor(code: T extends ErrorCodes ? \"This is built-in error code\" : T, message: string);\n  constructor(code: string, ...args: any) {\n    if (haveCode(code)) super(errMsg(ERROR_MESSAGES[code], ...args));\n    else super(...args);\n\n    this.errorCode = code;\n    if (Error.captureStackTrace) Error.captureStackTrace(this, DisTubeError);\n  }\n\n  get name() {\n    return `DisTubeError [${this.errorCode}]`;\n  }\n\n  get code() {\n    return this.errorCode;\n  }\n}\n"]}

package/dist/struct/ExtractorPlugin.d.ts

@@ -1,4 +1,4 @@
-import Plugin from "./Plugin";
+import { Plugin } from ".";
 import { PluginType } from "..";
 import type { Playlist, Song } from ".";
 import type { GuildMember } from "discord.js";
@@ -8,22 +8,32 @@ import type { GuildMember } from "discord.js";
  * @abstract
  */
 export declare abstract class ExtractorPlugin extends Plugin {
+    /**
+     * Resolve the validated url to a {@link Song} or a {@link Playlist}.
+     *
+     * @param {string} url URL
+     * @param {Object} [options] Optional options
+     * @param {Discord.GuildMember} [options.member] Requested user
+     * @param {*} [options.metadata] Metadata
+     * @returns {Promise<Song|Playlist>}
+     * @method resolve
+     * @memberof ExtractorPlugin#
+     * @abstract
+     */
     type: PluginType;
     /**
-     * Resolve the validated url to a {@link Song} or a {@link Playlist}.\
-     * Not needed to add {@link Song#related} because it will be added with {@link Plugin#getRelatedSongs}.
+     * Resolve the validated url to a {@link Song} or a {@link Playlist}.
+     *
+     * @param {string} url URL
+     * @param {Object} [options] Optional options
+     * @param {Discord.GuildMember} [options.member] Requested user
+     * @param {*} [options.metadata] Metadata
+     * @returns {Promise<Song|Playlist>}
+     * @abstract
      */
-    abstract resolve(url: string, member: GuildMember): Promise<Song | Playlist>;
+    abstract resolve<T = unknown>(url: string, options: {
+        member?: GuildMember;
+        metadata?: T;
+    }): Promise<Song<T> | Playlist<T>>;
 }
-/**
- * Resolve the validated url to a {@link Song} or a {@link Playlist}.\
- * Not needed to add {@link Song#related} because it will be added with {@link Plugin#getRelatedSongs}.
- * @param {string} url URL
- * @param {Discord.GuildMember} member Requested user
- * @returns {Promise<Song|Song[]|Playlist>}
- * @method resolve
- * @memberof ExtractorPlugin#
- * @abstract
- */
-export default ExtractorPlugin;
 //# sourceMappingURL=ExtractorPlugin.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ExtractorPlugin.d.ts","sourceRoot":"","sources":["../../src/struct/ExtractorPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;AACxC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;GAIG;AACH,8BAAsB,eAAgB,SAAQ,MAAM;IAClD,IAAI,aAAwB;IAC5B;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC;CAC7E;AAED;;;;;;;;;GASG;AAEH,eAAe,eAAe,CAAC"}
+{"version":3,"file":"ExtractorPlugin.d.ts","sourceRoot":"","sources":["../../src/struct/ExtractorPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;AACxC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;GAIG;AACH,8BAAsB,eAAgB,SAAQ,MAAM;IAClD;;;;;;;;;;;OAWG;IACH,IAAI,aAAwB;IAC5B;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,EAC1B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;KAAE,GAC9C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;CAClC"}

package/dist/struct/ExtractorPlugin.js

@@ -1,32 +1,30 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtractorPlugin = void 0;
-const Plugin_1 = __importDefault(require("./Plugin"));
+const _1 = require(".");
 const __1 = require("..");
 /**
  * Extractor Plugin
  * @extends Plugin
  * @abstract
  */
-class ExtractorPlugin extends Plugin_1.default {
+class ExtractorPlugin extends _1.Plugin {
     constructor() {
         super(...arguments);
+        /**
+         * Resolve the validated url to a {@link Song} or a {@link Playlist}.
+         *
+         * @param {string} url URL
+         * @param {Object} [options] Optional options
+         * @param {Discord.GuildMember} [options.member] Requested user
+         * @param {*} [options.metadata] Metadata
+         * @returns {Promise<Song|Playlist>}
+         * @method resolve
+         * @memberof ExtractorPlugin#
+         * @abstract
+         */
         this.type = __1.PluginType.EXTRACTOR;
     }
 }
 exports.ExtractorPlugin = ExtractorPlugin;
-/**
- * Resolve the validated url to a {@link Song} or a {@link Playlist}.\
- * Not needed to add {@link Song#related} because it will be added with {@link Plugin#getRelatedSongs}.
- * @param {string} url URL
- * @param {Discord.GuildMember} member Requested user
- * @returns {Promise<Song|Song[]|Playlist>}
- * @method resolve
- * @memberof ExtractorPlugin#
- * @abstract
- */
-exports.default = ExtractorPlugin;
 //# sourceMappingURL=ExtractorPlugin.js.map

package/dist/struct/ExtractorPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExtractorPlugin.js","sourceRoot":"","sources":["../../src/struct/ExtractorPlugin.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAC9B,0BAAgC;AAIhC;;;;GAIG;AACH,MAAsB,eAAgB,SAAQ,gBAAM;IAApD;;QACE,SAAI,GAAG,cAAU,CAAC,SAAS,CAAC;IAM9B,CAAC;CAAA;AAPD,0CAOC;AAED;;;;;;;;;GASG;AAEH,kBAAe,eAAe,CAAC","sourcesContent":["import Plugin from \"./Plugin\";\nimport { PluginType } from \"..\";\nimport type { Playlist, Song } from \".\";\nimport type { GuildMember } from \"discord.js\";\n\n/**\n * Extractor Plugin\n * @extends Plugin\n * @abstract\n */\nexport abstract class ExtractorPlugin extends Plugin {\n  type = PluginType.EXTRACTOR;\n  /**\n   * Resolve the validated url to a {@link Song} or a {@link Playlist}.\\\n   * Not needed to add {@link Song#related} because it will be added with {@link Plugin#getRelatedSongs}.\n   */\n  abstract resolve(url: string, member: GuildMember): Promise<Song | Playlist>;\n}\n\n/**\n * Resolve the validated url to a {@link Song} or a {@link Playlist}.\\\n * Not needed to add {@link Song#related} because it will be added with {@link Plugin#getRelatedSongs}.\n * @param {string} url URL\n * @param {Discord.GuildMember} member Requested user\n * @returns {Promise<Song|Song[]|Playlist>}\n * @method resolve\n * @memberof ExtractorPlugin#\n * @abstract\n */\n\nexport default ExtractorPlugin;\n"]}
+{"version":3,"file":"ExtractorPlugin.js","sourceRoot":"","sources":["../../src/struct/ExtractorPlugin.ts"],"names":[],"mappings":";;;AAAA,wBAA2B;AAC3B,0BAAgC;AAIhC;;;;GAIG;AACH,MAAsB,eAAgB,SAAQ,SAAM;IAApD;;QACE;;;;;;;;;;;WAWG;QACH,SAAI,GAAG,cAAU,CAAC,SAAS,CAAC;IAe9B,CAAC;CAAA;AA5BD,0CA4BC","sourcesContent":["import { Plugin } from \".\";\nimport { PluginType } from \"..\";\nimport type { Playlist, Song } from \".\";\nimport type { GuildMember } from \"discord.js\";\n\n/**\n * Extractor Plugin\n * @extends Plugin\n * @abstract\n */\nexport abstract class ExtractorPlugin extends Plugin {\n  /**\n   * Resolve the validated url to a {@link Song} or a {@link Playlist}.\n   *\n   * @param {string} url URL\n   * @param {Object} [options] Optional options\n   * @param {Discord.GuildMember} [options.member] Requested user\n   * @param {*} [options.metadata] Metadata\n   * @returns {Promise<Song|Playlist>}\n   * @method resolve\n   * @memberof ExtractorPlugin#\n   * @abstract\n   */\n  type = PluginType.EXTRACTOR;\n  /**\n   * Resolve the validated url to a {@link Song} or a {@link Playlist}.\n   *\n   * @param {string} url URL\n   * @param {Object} [options] Optional options\n   * @param {Discord.GuildMember} [options.member] Requested user\n   * @param {*} [options.metadata] Metadata\n   * @returns {Promise<Song|Playlist>}\n   * @abstract\n   */\n  abstract resolve<T = unknown>(\n    url: string,\n    options: { member?: GuildMember; metadata?: T },\n  ): Promise<Song<T> | Playlist<T>>;\n}\n"]}

package/dist/struct/Playlist.d.ts

@@ -4,23 +4,34 @@ import type { GuildMember, User } from "discord.js";
 /**
  * Class representing a playlist.
  * @prop {string} source Playlist source
+ * @template T - The type for the metadata (if any) of the playlist
  */
-export declare class Playlist implements PlaylistInfo {
+export declare class Playlist<T = unknown> implements PlaylistInfo {
     source: string;
-    member?: GuildMember;
-    user?: User;
     songs: Song[];
     name: string;
+    metadata: T;
+    member?: GuildMember;
+    user?: User;
     url?: string;
     thumbnail?: string;
     [x: string]: any;
+    constructor(playlist: Song[] | ytpl.result | PlaylistInfo);
+    /** @deprecated Passing GuildMember for DisTube#Playlist() is deprecated. */
+    constructor(playlist: Song[] | ytpl.result | PlaylistInfo, member?: GuildMember, properties?: Record<string, any>, metadata?: T);
     /**
      * Create a playlist
      * @param {Song[]|PlaylistInfo} playlist Playlist
-     * @param {Discord.GuildMember} member Requested user
-     * @param {Object} properties Custom properties
+     * @param {Object} [options] Optional options
+     * @param {Discord.GuildMember} [options.member] Requested user
+     * @param {Object} [options.properties] Custom properties
+     * @param {T} [options.metadata] Playlist metadata
      */
-    constructor(playlist: Song[] | ytpl.result | PlaylistInfo, member?: GuildMember, properties?: any);
+    constructor(playlist: Song[] | ytpl.result | PlaylistInfo, options?: {
+        member?: GuildMember;
+        properties?: Record<string, any>;
+        metadata?: T;
+    });
     /**
      * Playlist duration in second.
      * @type {number}
@@ -36,7 +47,12 @@ export declare class Playlist implements PlaylistInfo {
      * @private
      * @returns {Playlist}
      */
-    _patchMember(member?: GuildMember): Playlist;
+    _patchMember(member?: GuildMember): this;
+    /**
+     * @param {*} metadata Metadata
+     * @private
+     * @returns {Playlist}
+     */
+    _patchMetadata<S = unknown>(metadata: S): Playlist<S>;
 }
-export default Playlist;
 //# sourceMappingURL=Playlist.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Playlist.d.ts","sourceRoot":"","sources":["../../src/struct/Playlist.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAEpD;;;GAGG;AACH,qBAAa,QAAS,YAAW,YAAY;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACjB;;;;;OAKG;gBACS,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,GAAG,YAAY,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,UAAU,GAAE,GAAQ;IAgDrG;;;OAGG;IACH,IAAI,QAAQ,WAEX;IAED;;;OAGG;IACH,IAAI,iBAAiB,WAEpB;IAED;;;;OAIG;IACH,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,QAAQ;CAgB7C;AAED,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"Playlist.d.ts","sourceRoot":"","sources":["../../src/struct/Playlist.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAIpD;;;;GAIG;AACH,qBAAa,QAAQ,CAAC,CAAC,GAAG,OAAO,CAAE,YAAW,YAAY;IACxD,MAAM,EAAG,MAAM,CAAC;IAChB,KAAK,EAAG,IAAI,EAAE,CAAC;IACf,IAAI,EAAG,MAAM,CAAC;IACd,QAAQ,EAAG,CAAC,CAAC;IACb,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;gBACL,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,GAAG,YAAY;IACzD,4EAA4E;gBAE1E,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,GAAG,YAAY,EAC7C,MAAM,CAAC,EAAE,WAAW,EACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAChC,QAAQ,CAAC,EAAE,CAAC;IAEd;;;;;;;OAOG;gBAED,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,GAAG,YAAY,EAC7C,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,CAAC,CAAC;KACd;IA6EH;;;OAGG;IACH,IAAI,QAAQ,WAEX;IAED;;;OAGG;IACH,IAAI,iBAAiB,WAEpB;IAED;;;;OAIG;IACH,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW;IAiBjC;;;;OAIG;IACH,cAAc,CAAC,CAAC,GAAG,OAAO,EAAE,QAAQ,EAAE,CAAC;CAKxC"}

package/dist/struct/Playlist.js

@@ -2,19 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Playlist = void 0;
 const __1 = require("..");
+// TODO: Remove ! on the next major version
 /**
  * Class representing a playlist.
  * @prop {string} source Playlist source
+ * @template T - The type for the metadata (if any) of the playlist
  */
 class Playlist {
-    /**
-     * Create a playlist
-     * @param {Song[]|PlaylistInfo} playlist Playlist
-     * @param {Discord.GuildMember} member Requested user
-     * @param {Object} properties Custom properties
-     */
-    constructor(playlist, member, properties = {}) {
-        var _a;
+    constructor(playlist, options = {}, props = {}, meta) {
+        if ((0, __1.isMemberInstance)(options)) {
+            process.emitWarning("Passing GuildMember for DisTube#Playlist() is deprecated, read the docs for more.", "DeprecationWarning");
+            return new Playlist(playlist, { member: options, properties: props, metadata: meta });
+        }
+        const { member, properties, metadata } = Object.assign({ properties: {} }, options);
         if (typeof playlist !== "object") {
             throw new __1.DisTubeError("INVALID_TYPE", ["Array<Song>", "object"], playlist, "playlist");
         }
@@ -56,18 +56,23 @@ class Playlist {
          * Playlist thumbnail.
          * @type {?string}
          */
-        this.thumbnail = ((_a = info.thumbnail) === null || _a === void 0 ? void 0 : _a.url) || info.thumbnail || this.songs[0].thumbnail;
+        this.thumbnail = info.thumbnail?.url || info.thumbnail || this.songs[0].thumbnail;
         for (const [key, value] of Object.entries(properties)) {
             this[key] = value;
         }
+        /**
+         * Optional metadata that can be used to identify the playlist.
+         * @type {T}
+         */
+        this.metadata = metadata;
+        this._patchMetadata(metadata);
     }
     /**
      * Playlist duration in second.
      * @type {number}
      */
     get duration() {
-        var _a;
-        return ((_a = this.songs) === null || _a === void 0 ? void 0 : _a.reduce((prev, next) => prev + (next.duration || 0), 0)) || 0;
+        return this.songs?.reduce((prev, next) => prev + (next.duration || 0), 0) || 0;
     }
     /**
      * Formatted duration string `hh:mm:ss`.
@@ -82,7 +87,6 @@ class Playlist {
      * @returns {Playlist}
      */
     _patchMember(member) {
-        var _a;
         if (member) {
             /**
              * User requested.
@@ -93,12 +97,21 @@ class Playlist {
              * User requested.
              * @type {?Discord.User}
              */
-            this.user = (_a = this.member) === null || _a === void 0 ? void 0 : _a.user;
+            this.user = this.member?.user;
         }
         this.songs.map(s => s.constructor.name === "Song" && s._patchPlaylist(this, this.member));
         return this;
     }
+    /**
+     * @param {*} metadata Metadata
+     * @private
+     * @returns {Playlist}
+     */
+    _patchMetadata(metadata) {
+        this.metadata = metadata;
+        this.songs.map(s => s.constructor.name === "Song" && s._patchMetadata(metadata));
+        return this;
+    }
 }
 exports.Playlist = Playlist;
-exports.default = Playlist;
 //# sourceMappingURL=Playlist.js.map