distube 5.0.5 → 5.0.7

package/README.md

@@ -19,31 +19,61 @@
 
 # DisTube
 
-A powerful Discord.js module for simplifying music commands and effortless playback of various sources with integrated audio filters.
+DisTube is a comprehensive Discord music bot library built for Discord.js, offering simplified music commands, effortless playback from diverse sources, and integrated audio filters.
 
-[DisTube Support Server](https://discord.gg/feaDd9h) - [Frequently Asked Questions](https://discord.gg/feaDd9h)
+## 🌟 Features
 
-## Features
+- **Easy Integration**: Built on top of [discord.js](https://discord.js.org) v14 and [@discordjs/voice](https://discord.js.org)
+- **Voice Management**: Robust handling of voice connections and queue management
+- **Audio Filters**: Built-in filters (bassboost, echo, karaoke, etc.) and custom filter support
+- **Plugin System**: Extensible architecture supporting various music sources through plugins
+- **Type Safety**: Written in TypeScript for better development experience
+- **Active Community**: Join our [Discord Support Server](https://discord.gg/feaDd9h) for help
 
-- Easy Integration: Built on top of [discord.js](https://discord.js.org) v14 and [@discordjs/voice](https://discord.js.org).
-- Voice and Queue Management: Handles voice channel connections, disconnections, and manages music queues efficiently.
-- Audio Filters: Offers built-in audio filters (bassboost, echo, karaoke, etc.) and allows for custom filter implementations.
-- Plugin System: Supports extensibility through plugins
-  > DisTube does not have built-in support for music sources. You need to use plugins to add support for them.
-
-## Requirement
+## 📋 Requirements
 
 - Node.js 18.17.0 or higher
 - [discord.js](https://discord.js.org) v14
 - [@discordjs/voice](https://github.com/discordjs/voice)
 - [@discordjs/opus](https://github.com/discordjs/opus)
 - [FFmpeg](https://www.ffmpeg.org/download.html)
+
+### 🔒 Encryption Libraries
+
+> [!NOTE]
+> You only need to install one of these libraries if your system does not support `aes-256-gcm` (verify by running `require('node:crypto').getCiphers().includes('aes-256-gcm')`).
+
+- [@noble/ciphers](https://www.npmjs.com/package/@noble/ciphers)
 - [sodium-native](https://www.npmjs.com/package/sodium-native)
 
-## Documentation
+## 🚀 Installation
+
+```bash
+npm install distube @discordjs/voice @discordjs/opus
+```
+
+For FFmpeg installation:
+
+- [Windows Guide](http://blog.gregzaal.com/how-to-install-ffmpeg-on-windows/)
+- [Linux Guide](https://www.tecmint.com/install-ffmpeg-in-linux/)
+
+> [!NOTE]
+> Alternative FFmpeg builds available [here](https://github.com/BtbN/FFmpeg-Builds/releases)
+
+## 📚 Documentation
+
+- [API Documentation](https://distube.js.org/) - Detailed API reference
+- [DisTube Guide](https://github.com/skick1234/DisTube/wiki) - Step-by-step guide for beginners
+- [Plugin List](https://github.com/skick1234/DisTube/wiki/Projects-Hub#plugins) - Available plugins for music sources
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [Contributing Guidelines](https://github.com/skick1234/DisTube/blob/main/.github/CONTRIBUTING.md) before submitting a pull request.
+
+## 📄 License
 
-Read DisTube's definitions, properties and events details in the [API Documentation page](https://distube.js.org/).
+Licensed under [MIT License](https://github.com/skick1234/DisTube/blob/main/LICENSE)
 
-Learn how to build a music bot from scratch with [DisTube Guide](https://github.com/skick1234/DisTube/wiki)
+## 💖 Support
 
-[List of plugins](https://github.com/skick1234/DisTube/wiki/Projects-Hub#plugins) for supporting various sites
+<a href='https://ko-fi.com/skick' target='_blank'><img height='48' src='https://storage.ko-fi.com/cdn/kofi3.png' alt='Support me on Ko-fi' /></a>

package/dist/index.d.mts

@@ -387,7 +387,7 @@ declare class TaskQueue {
     /**
      * Waits for last task finished and queues a new task
      */
-    queuing(): Promise<void>;
+    queuing(isPlay?: boolean): Promise<void>;
     /**
      * Removes the finished task and processes the next task
      */
@@ -396,6 +396,10 @@ declare class TaskQueue {
      * The remaining number of tasks
      */
     get remaining(): number;
+    /**
+     * Whether or not having a play task
+     */
+    get hasPlayTask(): boolean;
 }
 
 /**

package/dist/index.d.ts

@@ -387,7 +387,7 @@ declare class TaskQueue {
     /**
      * Waits for last task finished and queues a new task
      */
-    queuing(): Promise<void>;
+    queuing(isPlay?: boolean): Promise<void>;
     /**
      * Removes the finished task and processes the next task
      */
@@ -396,6 +396,10 @@ declare class TaskQueue {
      * The remaining number of tasks
      */
     get remaining(): number;
+    /**
+     * Whether or not having a play task
+     */
+    get hasPlayTask(): boolean;
 }
 
 /**

package/dist/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __export = (target, all) => {
@@ -16,6 +18,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -152,7 +162,7 @@ var ERROR_MESSAGES = {
   VOICE_DIFFERENT_CLIENT: "Cannot join a voice channel created by a different client",
   FFMPEG_EXITED: /* @__PURE__ */ __name((code) => `ffmpeg exited with code ${code}`, "FFMPEG_EXITED"),
   FFMPEG_NOT_INSTALLED: /* @__PURE__ */ __name((path) => `ffmpeg is not installed at '${path}' path`, "FFMPEG_NOT_INSTALLED"),
-  ENCRYPTION_LIBRARIES_MISSING: "Cannot play audio as no valid encryption package is installed.\nPlease install sodium-native, sodium, libsodium-wrappers, or tweetnacl.",
+  ENCRYPTION_LIBRARIES_MISSING: "Cannot play audio as no valid encryption package is installed and your node doesn't support aes-256-gcm.\nPlease install  @noble/ciphers, @stablelib/xchacha20poly1305, sodium-native or libsodium-wrappers.",
   NO_QUEUE: "There is no playing queue in this guild",
   QUEUE_EXIST: "This guild has a Queue already",
   QUEUE_STOPPED: "The queue has been stopped already",
@@ -207,7 +217,9 @@ var Task = class {
   }
   resolve;
   promise;
-  constructor() {
+  isPlay;
+  constructor(isPlay) {
+    this.isPlay = isPlay;
     this.promise = new Promise((res) => {
       this.resolve = res;
     });
@@ -224,9 +236,9 @@ var TaskQueue = class {
   /**
    * Waits for last task finished and queues a new task
    */
-  queuing() {
+  queuing(isPlay = false) {
     const next = this.remaining ? this.#tasks[this.#tasks.length - 1].promise : Promise.resolve();
-    this.#tasks.push(new Task());
+    this.#tasks.push(new Task(isPlay));
     return next;
   }
   /**
@@ -241,6 +253,12 @@ var TaskQueue = class {
   get remaining() {
     return this.#tasks.length;
   }
+  /**
+   * Whether or not having a play task
+   */
+  get hasPlayTask() {
+    return this.#tasks.some((t) => t.isPlay);
+  }
 };
 
 // src/struct/Playlist.ts
@@ -1891,9 +1909,6 @@ var Queue = class extends DisTubeBase {
   async stop() {
     await this._taskQueue.queuing();
     try {
-      this.playing = false;
-      this.paused = false;
-      this.stopped = true;
       this.voice.stop();
       this.remove();
     } finally {
@@ -1904,14 +1919,12 @@ var Queue = class extends DisTubeBase {
    * Remove the queue from the manager
    */
   remove() {
+    this.playing = false;
+    this.paused = false;
     this.stopped = true;
     this.songs = [];
     this.previousSongs = [];
-    if (this._listeners) {
-      for (const event of objectKeys(this._listeners)) {
-        this.voice.off(event, this._listeners[event]);
-      }
-    }
+    if (this._listeners) for (const event of objectKeys(this._listeners)) this.voice.off(event, this._listeners[event]);
     this.queues.remove(this.id);
     this.emit("deleteQueue" /* DELETE_QUEUE */, this);
   }
@@ -2086,7 +2099,15 @@ function isNsfwChannel(channel) {
 __name(isNsfwChannel, "isNsfwChannel");
 var isTruthy = /* @__PURE__ */ __name((x) => Boolean(x), "isTruthy");
 var checkEncryptionLibraries = /* @__PURE__ */ __name(async () => {
-  for (const lib of ["sodium-native", "sodium", "libsodium-wrappers", "tweetnacl"]) {
+  if (await import("crypto").then((m) => m.getCiphers().includes("aes-256-gcm"))) return true;
+  for (const lib of [
+    "@noble/ciphers",
+    "@stablelib/xchacha20poly1305",
+    "sodium-native",
+    "sodium",
+    "libsodium-wrappers",
+    "tweetnacl"
+  ]) {
     try {
       await import(lib);
       return true;
@@ -2273,7 +2294,7 @@ var DisTube = class extends import_tiny_typed_emitter3.TypedEmitter {
       throw new DisTubeError("INVALID_TYPE", "Discord.GuildMember", member, "options.member");
     }
     const queue = this.getQueue(voiceChannel) || await this.queues.create(voiceChannel, textChannel);
-    await queue._taskQueue.queuing();
+    await queue._taskQueue.queuing(true);
     try {
       this.debug(`[${queue.id}] Playing input: ${song}`);
       const resolved = await this.handler.resolve(song, { member, metadata });
@@ -2309,6 +2330,7 @@ ${e.message}`;
       }
       throw e;
     } finally {
+      if (!queue.songs.length && !queue._taskQueue.hasPlayTask) queue.remove();
       queue._taskQueue.resolve();
     }
   }
@@ -2485,7 +2507,7 @@ ${e.message}`;
 };
 
 // src/index.ts
-var version = "5.0.5";
+var version = "5.0.7";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BaseManager,