distube 4.0.2 → 4.0.3

package/README.md

@@ -1,17 +1,17 @@
 <div align="center">
   <p>
-    <a href="https://nodei.co/npm/distube/"><img src="https://nodei.co/npm/distube.png?downloads=true&downloadRank=true&stars=true"></a>
+    <a href="https://www.npmjs.com/package/distube" target="_blank"><img src="https://nodei.co/npm/distube.png?downloads=true&downloadRank=true&stars=true"></a>
   </p>
   <p>
-    <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/skick1234/DisTube/Testing?label=Tests&logo=github&style=flat-square">
-    <img alt="node-current" src="https://img.shields.io/node/v/distube?logo=node.js&logoColor=white&style=flat-square">
-    <img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/distube/peer/discord.js?label=discord.js&logo=discord&logoColor=white&style=flat-square">
-    <img alt="Depfu" src="https://img.shields.io/depfu/skick1234/DisTube?style=flat-square">
-    <img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/skick1234/DisTube/main?logo=codecov&logoColor=white&style=flat-square&token=WWDYRRSEQW">
+    <a href="https://github.com/skick1234/DisTube/actions" target="_blank"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/skick1234/DisTube/Testing?label=Tests&logo=github&style=flat-square"></a>
+    <a href="https://nodejs.org/" target="_blank"><img alt="node-current" src="https://img.shields.io/node/v/distube?logo=node.js&logoColor=white&style=flat-square"></a>
+    <a href="https://discord.js.org/" target="_blank"><img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/distube/peer/discord.js?label=discord.js&logo=discord&logoColor=white&style=flat-square"></a>
+    <a href="https://depfu.com/github/skick1234/DisTube?project_id=36112" target="_blank"><img alt="Depfu" src="https://img.shields.io/depfu/dependencies/github/skick1234/DisTube?style=flat-square"></a>
+    <a href="https://app.codecov.io/gh/skick1234/DisTube" target="_blank"><img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/skick1234/DisTube/main?logo=codecov&logoColor=white&style=flat-square&token=WWDYRRSEQW"></a>
     <br>
-    <img alt="npm" src="https://img.shields.io/npm/dt/distube?logo=npm&style=flat-square">
-    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/skick1234/DisTube?logo=github&logoColor=white&style=flat-square">
-    <img alt="Discord" src="https://img.shields.io/discord/732254550689316914?logo=discord&logoColor=white&style=flat-square">
+    <a href="https://www.npmjs.com/package/distube" target="_blank"><img alt="npm" src="https://img.shields.io/npm/dt/distube?logo=npm&style=flat-square"></a>
+    <a href="https://github.com/skick1234/DisTube/stargazers" target="_blank"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/skick1234/DisTube?logo=github&logoColor=white&style=flat-square"></a>
+    <a href="https://discord.gg/feaDd9h" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/732254550689316914?logo=discord&logoColor=white&style=flat-square"></a>
   </p>
 </div>
 

package/dist/index.d.ts

@@ -13,23 +13,44 @@ declare type DisTubeVoiceEvents = {
     error: (error: Error) => Awaitable;
     finish: () => Awaitable;
 };
+declare enum Events {
+    ERROR = "error",
+    ADD_LIST = "addList",
+    ADD_SONG = "addSong",
+    PLAY_SONG = "playSong",
+    FINISH_SONG = "finishSong",
+    EMPTY = "empty",
+    FINISH = "finish",
+    INIT_QUEUE = "initQueue",
+    NO_RELATED = "noRelated",
+    DISCONNECT = "disconnect",
+    DELETE_QUEUE = "deleteQueue",
+    SEARCH_CANCEL = "searchCancel",
+    SEARCH_NO_RESULT = "searchNoResult",
+    SEARCH_DONE = "searchDone",
+    SEARCH_INVALID_ANSWER = "searchInvalidAnswer",
+    SEARCH_RESULT = "searchResult"
+}
 declare type DisTubeEvents = {
-    error: (channel: GuildTextBasedChannel | undefined, error: Error) => Awaitable;
-    addList: (queue: Queue, playlist: Playlist) => Awaitable;
-    addSong: (queue: Queue, song: Song) => Awaitable;
-    playSong: (queue: Queue, song: Song) => Awaitable;
-    finishSong: (queue: Queue, song: Song) => Awaitable;
-    empty: (queue: Queue) => Awaitable;
-    finish: (queue: Queue) => Awaitable;
-    initQueue: (queue: Queue) => Awaitable;
-    noRelated: (queue: Queue) => Awaitable;
-    disconnect: (queue: Queue) => Awaitable;
-    deleteQueue: (queue: Queue) => Awaitable;
-    searchCancel: (message: Message<true>, query: string) => Awaitable;
-    searchNoResult: (message: Message<true>, query: string) => Awaitable;
-    searchDone: (message: Message<true>, answer: Message<true>, query: string) => Awaitable;
-    searchInvalidAnswer: (message: Message<true>, answer: Message<true>, query: string) => Awaitable;
-    searchResult: (message: Message<true>, results: SearchResult[], query: string) => Awaitable;
+    error: [channel: GuildTextBasedChannel | undefined, error: Error];
+    addList: [queue: Queue, playlist: Playlist];
+    addSong: [queue: Queue, song: Song];
+    playSong: [queue: Queue, song: Song];
+    finishSong: [queue: Queue, song: Song];
+    empty: [queue: Queue];
+    finish: [queue: Queue];
+    initQueue: [queue: Queue];
+    noRelated: [queue: Queue];
+    disconnect: [queue: Queue];
+    deleteQueue: [queue: Queue];
+    searchCancel: [message: Message<true>, query: string];
+    searchNoResult: [message: Message<true>, query: string];
+    searchDone: [message: Message<true>, answer: Message<true>, query: string];
+    searchInvalidAnswer: [message: Message<true>, answer: Message<true>, query: string];
+    searchResult: [message: Message<true>, results: SearchResult[], query: string];
+};
+declare type TypedDisTubeEvents = {
+    [K in keyof DisTubeEvents]: (...args: DisTubeEvents[K]) => Awaitable;
 };
 interface Filter {
     name: string;
@@ -337,6 +358,7 @@ declare class DisTubeVoice extends TypedEmitter<DisTubeVoiceEvents> {
     emittedError: boolean;
     isDisconnected: boolean;
     constructor(voiceManager: DisTubeVoiceManager, channel: VoiceBasedChannel);
+    get channelId(): string | undefined;
     get channel(): VoiceBasedChannel;
     set channel(channel: VoiceBasedChannel);
     join(channel?: VoiceBasedChannel): Promise<DisTubeVoice>;
@@ -543,6 +565,8 @@ declare function isClientInstance(client: any): client is Client;
 declare function checkInvalidKey(target: Record<string, any>, source: Record<string, any> | string[], sourceName: string): void;
 declare function isObject(obj: any): obj is object;
 declare function isRecord<T = unknown>(obj: any): obj is Record<string, T>;
+declare type KeyOf<T> = T extends object ? (keyof T)[] : [];
+declare function objectKeys<T>(obj: T): KeyOf<T>;
 
 declare class DirectLinkPlugin extends ExtractorPlugin {
     validate(url: string): Promise<boolean>;
@@ -553,7 +577,7 @@ declare class DirectLinkPlugin extends ExtractorPlugin {
 }
 
 declare const version: string;
-declare class DisTube extends TypedEmitter<DisTubeEvents> {
+declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
     readonly handler: DisTubeHandler;
     readonly options: Options;
     readonly client: Client;
@@ -601,4 +625,4 @@ declare class DisTube extends TypedEmitter<DisTubeEvents> {
     emitError(error: Error, channel?: GuildTextBasedChannel): void;
 }
 
-export { Awaitable, BaseManager, Chapter, CustomPlaylistOptions, CustomPlugin, DirectLinkPlugin, DisTube, DisTubeBase, DisTubeError, DisTubeEvents, DisTubeHandler, DisTubeOptions, DisTubeStream, DisTubeVoice, DisTubeVoiceEvents, DisTubeVoiceManager, ExtractorPlugin, Filter, FilterManager, FilterResolvable, Filters, GuildIdManager, GuildIdResolvable, Options, OtherSongInfo, PlayHandlerOptions, PlayOptions, Playlist, PlaylistInfo, Plugin, PluginType, Queue, QueueManager, RelatedSong, RepeatMode, ResolveOptions, ResolvePlaylistOptions, SearchResult, SearchResultPlaylist, SearchResultType, SearchResultVideo, Song, StreamType, TaskQueue, checkIntents, checkInvalidKey, chooseBestVideoFormat, DisTube as default, defaultFilters, defaultOptions, formatDuration, isClientInstance, isGuildInstance, isMemberInstance, isMessageInstance, isObject, isRecord, isSnowflake, isSupportedVoiceChannel, isTextChannelInstance, isURL, isVoiceChannelEmpty, parseNumber, resolveGuildId, toSecond, version };
+export { Awaitable, BaseManager, Chapter, CustomPlaylistOptions, CustomPlugin, DirectLinkPlugin, DisTube, DisTubeBase, DisTubeError, DisTubeEvents, DisTubeHandler, DisTubeOptions, DisTubeStream, DisTubeVoice, DisTubeVoiceEvents, DisTubeVoiceManager, Events, ExtractorPlugin, Filter, FilterManager, FilterResolvable, Filters, GuildIdManager, GuildIdResolvable, Options, OtherSongInfo, PlayHandlerOptions, PlayOptions, Playlist, PlaylistInfo, Plugin, PluginType, Queue, QueueManager, RelatedSong, RepeatMode, ResolveOptions, ResolvePlaylistOptions, SearchResult, SearchResultPlaylist, SearchResultType, SearchResultVideo, Song, StreamType, TaskQueue, TypedDisTubeEvents, checkIntents, checkInvalidKey, chooseBestVideoFormat, DisTube as default, defaultFilters, defaultOptions, formatDuration, isClientInstance, isGuildInstance, isMemberInstance, isMessageInstance, isObject, isRecord, isSnowflake, isSupportedVoiceChannel, isTextChannelInstance, isURL, isVoiceChannelEmpty, objectKeys, parseNumber, resolveGuildId, toSecond, version };

package/dist/index.js

@@ -56,15 +56,11 @@ var require_package = __commonJS({
   "package.json"(exports, module2) {
     module2.exports = {
       name: "distube",
-      version: "4.0.2",
+      version: "4.0.3",
       description: "A Discord.js module to simplify your music commands and play songs with audio filters on Discord without any API key.",
       main: "./dist/index.js",
-      module: "./dist/index.mjs",
       types: "./dist/index.d.ts",
-      exports: {
-        import: "./dist/index.mjs",
-        require: "./dist/index.js"
-      },
+      exports: "./dist/index.js",
       directories: {
         lib: "src",
         test: "tests"
@@ -139,11 +135,11 @@ var require_package = __commonJS({
         "@discordjs/voice": "^0.11.0",
         "@distube/docgen": "distubejs/docgen",
         "@types/jest": "^28.1.6",
-        "@types/node": "^18.0.6",
+        "@types/node": "^18.6.0",
         "@typescript-eslint/eslint-plugin": "^5.30.7",
         "@typescript-eslint/parser": "^5.30.7",
         "babel-jest": "^28.1.3",
-        "discord.js": "^14.0.2",
+        "discord.js": "^14.0.3",
         eslint: "^8.20.0",
         "eslint-config-distube": "^1.6.4",
         "eslint-config-prettier": "^8.5.0",
@@ -153,7 +149,7 @@ var require_package = __commonJS({
         jest: "^28.1.3",
         "jsdoc-babel": "^0.5.0",
         "nano-staged": "^0.8.0",
-        "npm-check-updates": "^15.3.4",
+        "npm-check-updates": "^16.0.0",
         pinst: "^3.0.0",
         prettier: "^2.7.1",
         tsup: "^6.1.3",
@@ -199,6 +195,7 @@ __export(src_exports, {
   DisTubeStream: () => DisTubeStream,
   DisTubeVoice: () => DisTubeVoice,
   DisTubeVoiceManager: () => DisTubeVoiceManager,
+  Events: () => Events,
   ExtractorPlugin: () => ExtractorPlugin,
   FilterManager: () => FilterManager,
   GuildIdManager: () => GuildIdManager,
@@ -233,6 +230,7 @@ __export(src_exports, {
   isTextChannelInstance: () => isTextChannelInstance,
   isURL: () => isURL,
   isVoiceChannelEmpty: () => isVoiceChannelEmpty,
+  objectKeys: () => objectKeys,
   parseNumber: () => parseNumber,
   resolveGuildId: () => resolveGuildId,
   toSecond: () => toSecond,
@@ -241,6 +239,25 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/type.ts
+var Events = /* @__PURE__ */ ((Events2) => {
+  Events2["ERROR"] = "error";
+  Events2["ADD_LIST"] = "addList";
+  Events2["ADD_SONG"] = "addSong";
+  Events2["PLAY_SONG"] = "playSong";
+  Events2["FINISH_SONG"] = "finishSong";
+  Events2["EMPTY"] = "empty";
+  Events2["FINISH"] = "finish";
+  Events2["INIT_QUEUE"] = "initQueue";
+  Events2["NO_RELATED"] = "noRelated";
+  Events2["DISCONNECT"] = "disconnect";
+  Events2["DELETE_QUEUE"] = "deleteQueue";
+  Events2["SEARCH_CANCEL"] = "searchCancel";
+  Events2["SEARCH_NO_RESULT"] = "searchNoResult";
+  Events2["SEARCH_DONE"] = "searchDone";
+  Events2["SEARCH_INVALID_ANSWER"] = "searchInvalidAnswer";
+  Events2["SEARCH_RESULT"] = "searchResult";
+  return Events2;
+})(Events || {});
 var RepeatMode = /* @__PURE__ */ ((RepeatMode2) => {
   RepeatMode2[RepeatMode2["DISABLED"] = 0] = "DISABLED";
   RepeatMode2[RepeatMode2["SONG"] = 1] = "SONG";
@@ -698,6 +715,7 @@ var DisTubeBase = class {
 __name(DisTubeBase, "DisTubeBase");
 
 // src/core/DisTubeVoice.ts
+var import_discord = require("discord.js");
 var import_tiny_typed_emitter = require("tiny-typed-emitter");
 var import_voice = require("@discordjs/voice");
 var _channel, _volume, _br, br_fn, _join, join_fn;
@@ -751,7 +769,23 @@ var DisTubeVoice = class extends import_tiny_typed_emitter.TypedEmitter {
     }).on("error", () => void 0);
     this.connection.subscribe(this.audioPlayer);
   }
+  get channelId() {
+    return this.connection?.joinConfig?.channelId ?? void 0;
+  }
   get channel() {
+    if (!this.channelId)
+      return __privateGet(this, _channel);
+    if (__privateGet(this, _channel)?.id === this.channelId)
+      return __privateGet(this, _channel);
+    const channel = this.voices.client.channels.cache.get(this.channelId);
+    if (!channel)
+      return __privateGet(this, _channel);
+    for (const type of import_discord.Constants.VoiceBasedChannelTypes) {
+      if (channel.type === type) {
+        __privateSet(this, _channel, channel);
+        return channel;
+      }
+    }
     return __privateGet(this, _channel);
   }
   set channel(channel) {
@@ -762,7 +796,7 @@ var DisTubeVoice = class extends import_tiny_typed_emitter.TypedEmitter {
       throw new DisTubeError("VOICE_DIFFERENT_GUILD");
     if (channel.client.user?.id !== this.voices.client.user?.id)
       throw new DisTubeError("VOICE_DIFFERENT_CLIENT");
-    if (channel.id === __privateGet(this, _channel)?.id)
+    if (channel.id === this.channelId)
       return;
     if (!channel.joinable) {
       if (channel.full)
@@ -887,11 +921,11 @@ join_fn = /* @__PURE__ */ __name(function(channel) {
 }, "#join");
 
 // src/core/manager/BaseManager.ts
-var import_discord = require("discord.js");
+var import_discord2 = require("discord.js");
 var BaseManager = class extends DisTubeBase {
   constructor() {
     super(...arguments);
-    __publicField(this, "collection", new import_discord.Collection());
+    __publicField(this, "collection", new import_discord2.Collection());
   }
   get size() {
     return this.collection.size;
@@ -1125,7 +1159,7 @@ voiceEventHandler_fn = /* @__PURE__ */ __name(function(queue) {
     error: (error) => __privateMethod(this, _handlePlayingError, handlePlayingError_fn).call(this, queue, error),
     finish: () => __privateMethod(this, _handleSongFinish, handleSongFinish_fn).call(this, queue)
   };
-  for (const event of Object.keys(queue._listeners)) {
+  for (const event of objectKeys(queue._listeners)) {
     queue.voice.on(event, queue._listeners[event]);
   }
 }, "#voiceEventHandler");
@@ -1881,7 +1915,7 @@ var Queue = class extends DisTubeBase {
     this.songs = [];
     this.previousSongs = [];
     if (this._listeners) {
-      for (const event of Object.keys(this._listeners)) {
+      for (const event of objectKeys(this._listeners)) {
         this.voice.removeListener(event, this._listeners[event]);
       }
     }
@@ -1957,7 +1991,7 @@ __name(ExtractorPlugin, "ExtractorPlugin");
 
 // src/util.ts
 var import_url = require("url");
-var import_discord2 = require("discord.js");
+var import_discord3 = require("discord.js");
 var formatInt = /* @__PURE__ */ __name((int) => int < 10 ? `0${int}` : int, "formatInt");
 function formatDuration(sec) {
   if (!sec || !Number(sec))
@@ -2011,8 +2045,8 @@ function isURL(input) {
 }
 __name(isURL, "isURL");
 function checkIntents(options) {
-  const intents = new import_discord2.IntentsBitField(options.intents);
-  if (!intents.has(import_discord2.GatewayIntentBits.GuildVoiceStates))
+  const intents = new import_discord3.IntentsBitField(options.intents);
+  if (!intents.has(import_discord3.GatewayIntentBits.GuildVoiceStates))
     throw new DisTubeError("MISSING_INTENTS", "GuildVoiceStates");
 }
 __name(checkIntents, "checkIntents");
@@ -2030,7 +2064,7 @@ function isVoiceChannelEmpty(voiceState) {
 __name(isVoiceChannelEmpty, "isVoiceChannelEmpty");
 function isSnowflake(id) {
   try {
-    return import_discord2.SnowflakeUtil.deconstruct(id).timestamp > import_discord2.SnowflakeUtil.epoch;
+    return import_discord3.SnowflakeUtil.deconstruct(id).timestamp > import_discord3.SnowflakeUtil.epoch;
   } catch {
     return false;
   }
@@ -2041,15 +2075,15 @@ function isMemberInstance(member) {
 }
 __name(isMemberInstance, "isMemberInstance");
 function isTextChannelInstance(channel) {
-  return !!channel && isSnowflake(channel.id) && isSnowflake(channel.guildId) && typeof channel.name === "string" && import_discord2.Constants.TextBasedChannelTypes.includes(channel.type) && typeof channel.nsfw === "boolean" && "messages" in channel && typeof channel.send === "function";
+  return !!channel && isSnowflake(channel.id) && isSnowflake(channel.guildId) && typeof channel.name === "string" && import_discord3.Constants.TextBasedChannelTypes.includes(channel.type) && typeof channel.nsfw === "boolean" && "messages" in channel && typeof channel.send === "function";
 }
 __name(isTextChannelInstance, "isTextChannelInstance");
 function isMessageInstance(message) {
-  return !!message && isSnowflake(message.id) && isSnowflake(message.guildId) && isMemberInstance(message.member) && isTextChannelInstance(message.channel) && import_discord2.Constants.NonSystemMessageTypes.includes(message.type) && message.member.id === message.author?.id;
+  return !!message && isSnowflake(message.id) && isSnowflake(message.guildId) && isMemberInstance(message.member) && isTextChannelInstance(message.channel) && import_discord3.Constants.NonSystemMessageTypes.includes(message.type) && message.member.id === message.author?.id;
 }
 __name(isMessageInstance, "isMessageInstance");
 function isSupportedVoiceChannel(channel) {
-  return !!channel && isSnowflake(channel.id) && isSnowflake(channel.guildId) && import_discord2.Constants.VoiceBasedChannelTypes.includes(channel.type);
+  return !!channel && isSnowflake(channel.id) && isSnowflake(channel.guildId) && import_discord3.Constants.VoiceBasedChannelTypes.includes(channel.type);
 }
 __name(isSupportedVoiceChannel, "isSupportedVoiceChannel");
 function isGuildInstance(guild) {
@@ -2081,8 +2115,8 @@ __name(isClientInstance, "isClientInstance");
 function checkInvalidKey(target, source, sourceName) {
   if (!isObject(target))
     throw new DisTubeError("INVALID_TYPE", "object", target, sourceName);
-  const sourceKeys = Array.isArray(source) ? source : Object.keys(source);
-  const invalidKey = Object.keys(target).find((key) => !sourceKeys.includes(key));
+  const sourceKeys = Array.isArray(source) ? source : objectKeys(source);
+  const invalidKey = objectKeys(target).find((key) => !sourceKeys.includes(key));
   if (invalidKey)
     throw new DisTubeError("INVALID_KEY", sourceName, invalidKey);
 }
@@ -2095,6 +2129,12 @@ function isRecord(obj) {
   return isObject(obj);
 }
 __name(isRecord, "isRecord");
+function objectKeys(obj) {
+  if (!isObject(obj))
+    return [];
+  return Object.keys(obj);
+}
+__name(objectKeys, "objectKeys");
 
 // src/plugin/DirectLink.ts
 var import_undici = require("undici");
@@ -2377,6 +2417,7 @@ __name(DisTube, "DisTube");
   DisTubeStream,
   DisTubeVoice,
   DisTubeVoiceManager,
+  Events,
   ExtractorPlugin,
   FilterManager,
   GuildIdManager,
@@ -2410,6 +2451,7 @@ __name(DisTube, "DisTube");
   isTextChannelInstance,
   isURL,
   isVoiceChannelEmpty,
+  objectKeys,
   parseNumber,
   resolveGuildId,
   toSecond,