distube 3.2.1 → 3.3.1

package/dist/struct/CustomPlugin.d.ts

@@ -1,47 +1,51 @@
 import { Plugin } from ".";
 import { PluginType } from "..";
-import type { GuildMember, GuildTextBasedChannel, VoiceBasedChannel } from "discord.js";
+import type { VoiceBasedChannel } from "discord.js";
+import type { Awaitable, CustomPluginPlayOptions } from "..";
 /**
  * Custom Plugin
  * @extends Plugin
  * @abstract
  */
 export declare abstract class CustomPlugin extends Plugin {
+    type: PluginType;
     /**
-     * This method will be executed if the url is validated.
+     * This method will be executed if the `song` string 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
+     * @param {string} song Validated `song`
+     * @param {CustomPluginPlayOptions} [options] Optional options
      * @returns {Promise<void>}
      * @abstract
-     * @method play
-     * @memberof CustomPlugin#
      */
-    type: PluginType;
+    abstract play(voiceChannel: VoiceBasedChannel, song: string, options: CustomPluginPlayOptions): Awaitable<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
+     * Check if the {@link DisTube#play} `song` parameter is working with this plugin
+     * @param {string} song String need to validate
+     * @returns {boolean|Promise<boolean>}
      */
-    abstract play(voiceChannel: VoiceBasedChannel, song: string, options: {
-        skip?: boolean;
-        unshift?: boolean;
-        member?: GuildMember;
-        textChannel?: GuildTextBasedChannel;
-        metadata?: any;
-    }): Promise<void>;
+    validate(song: string): Awaitable<boolean>;
 }
+/**
+ * @typedef {Object} CustomPluginPlayOptions
+ * @param {Discord.GuildMember} [member] Requested user
+ * @param {Discord.BaseGuildTextChannel} [textChannel] Default {@link Queue#textChannel}
+ * @param {boolean} [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} [position=0] Position of the song/playlist to add to the queue,
+ * <= 0 to add to the end of the queue.
+ * @param {boolean} [unshift=false] (DEPRECATED) Add the song/playlist to the beginning of the queue
+ * (after the playing song if exists)
+ * @param {*} [metadata] Optional metadata that can be attached to the song/playlist will be played.
+ */
+/**
+ * This method will be executed if the url is validated.
+ * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
+ * @param {string} song Validated `song`
+ * @param {CustomPluginPlayOptions} [options] Optional options
+ * @returns {Promise<void>}
+ * @abstract
+ * @method play
+ * @memberof 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,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"}
+{"version":3,"file":"CustomPlugin.d.ts","sourceRoot":"","sources":["../../src/struct/CustomPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,uBAAuB,EAAgC,MAAM,IAAI,CAAC;AAE3F;;;;GAIG;AACH,8BAAsB,YAAa,SAAQ,MAAM;IAC/C,IAAI,aAAqB;IACzB;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,uBAAuB,GAAG,SAAS,CAAC,IAAI,CAAC;IAC/G;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC;CAG3C;AAED;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;GASG"}

package/dist/struct/CustomPlugin.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomPlugin = void 0;
+/* eslint-disable @typescript-eslint/no-unused-vars */
 const _1 = require(".");
 const __1 = require("..");
-// TODO: Clean parameters on the next major version.
 /**
  * Custom Plugin
  * @extends Plugin
@@ -12,23 +12,39 @@ const __1 = require("..");
 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;
     }
+    /**
+     * Check if the {@link DisTube#play} `song` parameter is working with this plugin
+     * @param {string} song String need to validate
+     * @returns {boolean|Promise<boolean>}
+     */
+    validate(song) {
+        return false;
+    }
 }
 exports.CustomPlugin = CustomPlugin;
+/**
+ * @typedef {Object} CustomPluginPlayOptions
+ * @param {Discord.GuildMember} [member] Requested user
+ * @param {Discord.BaseGuildTextChannel} [textChannel] Default {@link Queue#textChannel}
+ * @param {boolean} [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} [position=0] Position of the song/playlist to add to the queue,
+ * <= 0 to add to the end of the queue.
+ * @param {boolean} [unshift=false] (DEPRECATED) Add the song/playlist to the beginning of the queue
+ * (after the playing song if exists)
+ * @param {*} [metadata] Optional metadata that can be attached to the song/playlist will be played.
+ */
+/**
+ * This method will be executed if the url is validated.
+ * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
+ * @param {string} song Validated `song`
+ * @param {CustomPluginPlayOptions} [options] Optional options
+ * @returns {Promise<void>}
+ * @abstract
+ * @method play
+ * @memberof 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,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"]}
+{"version":3,"file":"CustomPlugin.js","sourceRoot":"","sources":["../../src/struct/CustomPlugin.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,wBAA2B;AAC3B,0BAAgC;AAIhC;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,SAAM;IAAjD;;QACE,SAAI,GAAG,cAAU,CAAC,MAAM,CAAC;IAkB3B,CAAC;IARC;;;;OAIG;IACH,QAAQ,CAAC,IAAY;QACnB,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAnBD,oCAmBC;AAED;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;GASG","sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars */\nimport { Plugin } from \".\";\nimport { PluginType } from \"..\";\nimport type { VoiceBasedChannel } from \"discord.js\";\nimport type { Awaitable, CustomPluginPlayOptions, Playlist, SearchResult, Song } from \"..\";\n\n/**\n * Custom Plugin\n * @extends Plugin\n * @abstract\n */\nexport abstract class CustomPlugin extends Plugin {\n  type = PluginType.CUSTOM;\n  /**\n   * This method will be executed if the `song` string is validated.\n   * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined\n   * @param {string} song Validated `song`\n   * @param {CustomPluginPlayOptions} [options] Optional options\n   * @returns {Promise<void>}\n   * @abstract\n   */\n  abstract play(voiceChannel: VoiceBasedChannel, song: string, options: CustomPluginPlayOptions): Awaitable<void>;\n  /**\n   * Check if the {@link DisTube#play} `song` parameter is working with this plugin\n   * @param {string} song String need to validate\n   * @returns {boolean|Promise<boolean>}\n   */\n  validate(song: string): Awaitable<boolean> {\n    return false;\n  }\n}\n\n/**\n * @typedef {Object} CustomPluginPlayOptions\n * @param {Discord.GuildMember} [member] Requested user\n * @param {Discord.BaseGuildTextChannel} [textChannel] Default {@link Queue#textChannel}\n * @param {boolean} [skip=false]\n * Skip the playing song (if exists) and play the added song/playlist if `position` is 1.\n * If `position` is defined and not equal to 1, it will skip to the next song instead of the added song\n * @param {number} [position=0] Position of the song/playlist to add to the queue,\n * <= 0 to add to the end of the queue.\n * @param {boolean} [unshift=false] (DEPRECATED) Add the song/playlist to the beginning of the queue\n * (after the playing song if exists)\n * @param {*} [metadata] Optional metadata that can be attached to the song/playlist will be played.\n */\n\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 `song`\n * @param {CustomPluginPlayOptions} [options] Optional options\n * @returns {Promise<void>}\n * @abstract\n * @method play\n * @memberof CustomPlugin#\n */\n"]}

package/dist/struct/DisTubeError.d.ts

@@ -19,7 +19,6 @@ declare const ERROR_MESSAGES: {
     VOICE_DEPRECATED_CONNECTION: string;
     NO_QUEUE: string;
     QUEUE_EXIST: string;
-    ADD_BEFORE_PLAYING: string;
     PAUSED: string;
     RESUMED: string;
     NO_PREVIOUS: string;
@@ -33,7 +32,7 @@ declare const ERROR_MESSAGES: {
     UNPLAYABLE_FORMATS: string;
     NON_NSFW: string;
     NOT_SUPPORTED_URL: string;
-    CANNOT_RESOLVE_SONG: (t: string) => string;
+    CANNOT_RESOLVE_SONG: (t: any) => string;
     NO_VALID_SONG: string;
     EMPTY_FILTERED_PLAYLIST: string;
     EMPTY_PLAYLIST: string;

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

@@ -1 +1 @@
-{"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"}
+{"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;;;;;;;;;;;;;;;;;;;;6BAwBP,GAAG;;;;CAM7B,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

@@ -24,7 +24,6 @@ const ERROR_MESSAGES = {
         "Read more: https://distube.js.org/guide/additional-info/update.html#voice",
     NO_QUEUE: "There is no playing queue in this guild",
     QUEUE_EXIST: "This guild has a Queue already",
-    ADD_BEFORE_PLAYING: "Cannot add Song before the playing Song",
     PAUSED: "The queue has been paused already",
     RESUMED: "The queue has been playing already",
     NO_PREVIOUS: "There is no previous song in this queue",
@@ -38,7 +37,7 @@ const ERROR_MESSAGES = {
     UNPLAYABLE_FORMATS: "No playable format found",
     NON_NSFW: "Cannot play age-restricted content in non-NSFW channel",
     NOT_SUPPORTED_URL: "This url is not supported",
-    CANNOT_RESOLVE_SONG: (t) => `Cannot resolve ${t} to a Song`,
+    CANNOT_RESOLVE_SONG: (t) => `Cannot resolve ${(0, node_util_1.inspect)(t)} to a Song`,
     NO_VALID_SONG: "'songs' array does not have any valid Song, SearchResult or url",
     EMPTY_FILTERED_PLAYLIST: "There is no valid video in the playlist\n" +
         "Maybe age-restricted contents is filtered because you are in non-NSFW channel",

package/dist/struct/DisTubeError.js.map

@@ -1 +1 @@
-{"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"]}
+{"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,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,CAAM,EAAE,EAAE,CAAC,kBAAkB,IAAA,mBAAO,EAAC,CAAC,CAAC,YAAY;IACzE,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  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: any) => `Cannot resolve ${inspect(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,25 +1,13 @@
 import { Plugin } from ".";
 import { PluginType } from "..";
-import type { Playlist, Song } from ".";
 import type { GuildMember } from "discord.js";
+import type { Awaitable, Playlist, Song } from "..";
 /**
  * Extractor Plugin
  * @extends Plugin
  * @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}.
@@ -28,12 +16,30 @@ export declare abstract class ExtractorPlugin extends Plugin {
      * @param {Object} [options] Optional options
      * @param {Discord.GuildMember} [options.member] Requested user
      * @param {*} [options.metadata] Metadata
-     * @returns {Promise<Song|Playlist>}
+     * @returns {Song|Playlist|Promise<Song|Playlist>}
      * @abstract
      */
     abstract resolve<T = unknown>(url: string, options: {
         member?: GuildMember;
         metadata?: T;
-    }): Promise<Song<T> | Playlist<T>>;
+    }): Awaitable<Song<T> | Playlist<T>>;
+    /**
+     * Check if the url is working with this plugin
+     * @param {string} url Input url
+     * @returns {boolean|Promise<boolean>}
+     */
+    validate(url: string): Awaitable<boolean>;
 }
+/**
+ * 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 {Song|Playlist|Promise<Song|Playlist>}
+ * @method resolve
+ * @memberof ExtractorPlugin#
+ * @abstract
+ */
 //# 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,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"}
+{"version":3,"file":"ExtractorPlugin.d.ts","sourceRoot":"","sources":["../../src/struct/ExtractorPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAEpD;;;;GAIG;AACH,8BAAsB,eAAgB,SAAQ,MAAM;IAClD,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,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IACnC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC;CAG1C;AAED;;;;;;;;;;;GAWG"}

package/dist/struct/ExtractorPlugin.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtractorPlugin = void 0;
+/* eslint-disable @typescript-eslint/no-unused-vars */
 const _1 = require(".");
 const __1 = require("..");
 /**
@@ -11,20 +12,28 @@ const __1 = require("..");
 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;
     }
+    /**
+     * Check if the url is working with this plugin
+     * @param {string} url Input url
+     * @returns {boolean|Promise<boolean>}
+     */
+    validate(url) {
+        return false;
+    }
 }
 exports.ExtractorPlugin = ExtractorPlugin;
+/**
+ * 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 {Song|Playlist|Promise<Song|Playlist>}
+ * @method resolve
+ * @memberof ExtractorPlugin#
+ * @abstract
+ */
 //# 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,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"]}
+{"version":3,"file":"ExtractorPlugin.js","sourceRoot":"","sources":["../../src/struct/ExtractorPlugin.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,wBAA2B;AAC3B,0BAAgC;AAIhC;;;;GAIG;AACH,MAAsB,eAAgB,SAAQ,SAAM;IAApD;;QACE,SAAI,GAAG,cAAU,CAAC,SAAS,CAAC;IAuB9B,CAAC;IARC;;;;OAIG;IACH,QAAQ,CAAC,GAAW;QAClB,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAxBD,0CAwBC;AAED;;;;;;;;;;;GAWG","sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars */\nimport { Plugin } from \".\";\nimport { PluginType } from \"..\";\nimport type { GuildMember } from \"discord.js\";\nimport type { Awaitable, Playlist, Song } from \"..\";\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   *\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 {Song|Playlist|Promise<Song|Playlist>}\n   * @abstract\n   */\n  abstract resolve<T = unknown>(\n    url: string,\n    options: { member?: GuildMember; metadata?: T },\n  ): Awaitable<Song<T> | Playlist<T>>;\n  /**\n   * Check if the url is working with this plugin\n   * @param {string} url Input url\n   * @returns {boolean|Promise<boolean>}\n   */\n  validate(url: string): Awaitable<boolean> {\n    return false;\n  }\n}\n\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 {Song|Playlist|Promise<Song|Playlist>}\n * @method resolve\n * @memberof ExtractorPlugin#\n * @abstract\n */\n"]}

package/dist/struct/Playlist.d.ts

@@ -1,18 +1,16 @@
 import type ytpl from "@distube/ytpl";
 import type { PlaylistInfo, Song } from "..";
-import type { GuildMember, User } from "discord.js";
+import type { GuildMember } 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<T = unknown> implements PlaylistInfo {
+    #private;
     source: string;
     songs: Song[];
     name: string;
-    metadata: T;
-    member?: GuildMember;
-    user?: User;
     url?: string;
     thumbnail?: string;
     [x: string]: any;
@@ -43,16 +41,21 @@ export declare class Playlist<T = unknown> implements PlaylistInfo {
      */
     get formattedDuration(): string;
     /**
-     * @param {?Discord.GuildMember} [member] Requested user
-     * @private
-     * @returns {Playlist}
+     * User requested.
+     * @type {Discord.GuildMember?}
      */
-    _patchMember(member?: GuildMember): this;
+    get member(): GuildMember | undefined;
+    set member(member: GuildMember | undefined);
     /**
-     * @param {*} metadata Metadata
-     * @private
-     * @returns {Playlist}
+     * User requested.
+     * @type {Discord.User?}
      */
-    _patchMetadata<S = unknown>(metadata: S): Playlist<S>;
+    get user(): import("discord.js").User | undefined;
+    /**
+     * Optional metadata that can be used to identify the playlist.
+     * @type {T}
+     */
+    get metadata(): T;
+    set metadata(metadata: T);
 }
 //# 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;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"}
+{"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,MAAM,YAAY,CAAC;AAI9C;;;;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;IAGd,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;IAwEH;;;OAGG;IACH,IAAI,QAAQ,WAEX;IAED;;;OAGG;IACH,IAAI,iBAAiB,WAEpB;IAED;;;OAGG;IACH,IAAI,MAAM,IAIS,WAAW,GAAG,SAAS,CAFzC;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,EAIzC;IAED;;;OAGG;IACH,IAAI,IAAI,0CAEP;IAED;;;OAGG;IACH,IAAI,QAAQ,IAIW,CAAC,CAFvB;IAED,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAGvB;CACF"}

package/dist/struct/Playlist.js

@@ -1,4 +1,16 @@
 "use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _Playlist_metadata, _Playlist_member;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Playlist = void 0;
 const __1 = require("..");
@@ -9,16 +21,18 @@ const __1 = require("..");
  * @template T - The type for the metadata (if any) of the playlist
  */
 class Playlist {
-    constructor(playlist, options = {}, props = {}, meta) {
+    constructor(playlist, options = {}, props, meta) {
+        _Playlist_metadata.set(this, void 0);
+        _Playlist_member.set(this, void 0);
         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);
+        const { member, properties, metadata } = options;
         if (typeof playlist !== "object") {
             throw new __1.DisTubeError("INVALID_TYPE", ["Array<Song>", "object"], playlist, "playlist");
         }
-        if (typeof properties !== "object") {
+        if ("properties" in options && typeof properties !== "object") {
             throw new __1.DisTubeError("INVALID_TYPE", "object", properties, "properties");
         }
         // FIXME
@@ -27,7 +41,7 @@ class Playlist {
          * The source of the playlist
          * @type {string}
          */
-        this.source = (info.source || properties.source || "youtube").toLowerCase();
+        this.source = (info.source || properties?.source || "youtube").toLowerCase();
         /**
          * Playlist songs.
          * @type {Array<Song>}
@@ -36,7 +50,8 @@ class Playlist {
         if (!Array.isArray(this.songs) || !this.songs.length) {
             throw new __1.DisTubeError("EMPTY_PLAYLIST");
         }
-        this._patchMember(member || info.member);
+        this.songs.map(s => s.constructor.name === "Song" && (s.playlist = this));
+        this.member = member || info.member || undefined;
         /**
          * Playlist name.
          * @type {string}
@@ -54,18 +69,13 @@ class Playlist {
         this.url = info.url || info.webpage_url;
         /**
          * Playlist thumbnail.
-         * @type {?string}
+         * @type {string?}
          */
         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}
-         */
+        if (properties)
+            for (const [key, value] of Object.entries(properties))
+                this[key] = value;
         this.metadata = metadata;
-        this._patchMetadata(metadata);
     }
     /**
      * Playlist duration in second.
@@ -82,36 +92,37 @@ class Playlist {
         return (0, __1.formatDuration)(this.duration);
     }
     /**
-     * @param {?Discord.GuildMember} [member] Requested user
-     * @private
-     * @returns {Playlist}
+     * User requested.
+     * @type {Discord.GuildMember?}
      */
-    _patchMember(member) {
-        if (member) {
-            /**
-             * User requested.
-             * @type {?Discord.GuildMember}
-             */
-            this.member = member;
-            /**
-             * User requested.
-             * @type {?Discord.User}
-             */
-            this.user = this.member?.user;
-        }
-        this.songs.map(s => s.constructor.name === "Song" && s._patchPlaylist(this, this.member));
-        return this;
+    get member() {
+        return __classPrivateFieldGet(this, _Playlist_member, "f");
+    }
+    set member(member) {
+        if (!member)
+            return;
+        __classPrivateFieldSet(this, _Playlist_member, member, "f");
+        this.songs.map(s => s.constructor.name === "Song" && (s.member = this.member));
     }
     /**
-     * @param {*} metadata Metadata
-     * @private
-     * @returns {Playlist}
+     * User requested.
+     * @type {Discord.User?}
      */
-    _patchMetadata(metadata) {
-        this.metadata = metadata;
-        this.songs.map(s => s.constructor.name === "Song" && s._patchMetadata(metadata));
-        return this;
+    get user() {
+        return this.member?.user;
+    }
+    /**
+     * Optional metadata that can be used to identify the playlist.
+     * @type {T}
+     */
+    get metadata() {
+        return __classPrivateFieldGet(this, _Playlist_metadata, "f");
+    }
+    set metadata(metadata) {
+        __classPrivateFieldSet(this, _Playlist_metadata, metadata, "f");
+        this.songs.map(s => s.constructor.name === "Song" && (s.metadata = metadata));
     }
 }
 exports.Playlist = Playlist;
+_Playlist_metadata = new WeakMap(), _Playlist_member = new WeakMap();
 //# sourceMappingURL=Playlist.js.map