distube 5.0.4 → 5.0.6

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

@@ -1,5 +1,5 @@
 import * as discord_js from 'discord.js';
-import { Snowflake, Message, GuildTextBasedChannel, VoiceBasedChannel, VoiceState, Guild, GuildMember, Interaction, Client, Collection, ClientOptions } from 'discord.js';
+import { GuildMember, Snowflake, Message, GuildTextBasedChannel, VoiceBasedChannel, VoiceState, Guild, Interaction, Client, Collection, ClientOptions } from 'discord.js';
 import { TypedEmitter } from 'tiny-typed-emitter';
 import { AudioPlayer, VoiceConnection, AudioResource } from '@discordjs/voice';
 import { Transform, TransformCallback } from 'stream';
@@ -637,6 +637,7 @@ declare class DisTubeVoice extends TypedEmitter<DisTubeVoiceEvents> {
     emittedError: boolean;
     isDisconnected: boolean;
     stream?: DisTubeStream;
+    pausingStream?: DisTubeStream;
     constructor(voiceManager: DisTubeVoiceManager, channel: VoiceBasedChannel);
     /**
      * The voice channel id the bot is in
@@ -1026,12 +1027,12 @@ declare class Queue extends DisTubeBase {
      * Pause the guild stream
      * @returns The guild queue
      */
-    pause(): Queue;
+    pause(): Promise<Queue>;
     /**
      * Resume the guild stream
      * @returns The guild queue
      */
-    resume(): Queue;
+    resume(): Promise<Queue>;
     /**
      * Set the guild stream's volume
      * @param percent - The percentage of volume you want to set
@@ -1390,13 +1391,13 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
      * @param guild - The type can be resolved to give a {@link Queue}
      * @returns The guild queue
      */
-    pause(guild: GuildIdResolvable): Queue;
+    pause(guild: GuildIdResolvable): Promise<Queue>;
     /**
      * Resume the guild stream
      * @param guild - The type can be resolved to give a {@link Queue}
      * @returns The guild queue
      */
-    resume(guild: GuildIdResolvable): Queue;
+    resume(guild: GuildIdResolvable): Promise<Queue>;
     /**
      * Stop the guild stream
      * @param guild - The type can be resolved to give a {@link Queue}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as discord_js from 'discord.js';
-import { Snowflake, Message, GuildTextBasedChannel, VoiceBasedChannel, VoiceState, Guild, GuildMember, Interaction, Client, Collection, ClientOptions } from 'discord.js';
+import { GuildMember, Snowflake, Message, GuildTextBasedChannel, VoiceBasedChannel, VoiceState, Guild, Interaction, Client, Collection, ClientOptions } from 'discord.js';
 import { TypedEmitter } from 'tiny-typed-emitter';
 import { AudioPlayer, VoiceConnection, AudioResource } from '@discordjs/voice';
 import { Transform, TransformCallback } from 'stream';
@@ -637,6 +637,7 @@ declare class DisTubeVoice extends TypedEmitter<DisTubeVoiceEvents> {
     emittedError: boolean;
     isDisconnected: boolean;
     stream?: DisTubeStream;
+    pausingStream?: DisTubeStream;
     constructor(voiceManager: DisTubeVoiceManager, channel: VoiceBasedChannel);
     /**
      * The voice channel id the bot is in
@@ -1026,12 +1027,12 @@ declare class Queue extends DisTubeBase {
      * Pause the guild stream
      * @returns The guild queue
      */
-    pause(): Queue;
+    pause(): Promise<Queue>;
     /**
      * Resume the guild stream
      * @returns The guild queue
      */
-    resume(): Queue;
+    resume(): Promise<Queue>;
     /**
      * Set the guild stream's volume
      * @param percent - The percentage of volume you want to set
@@ -1390,13 +1391,13 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
      * @param guild - The type can be resolved to give a {@link Queue}
      * @returns The guild queue
      */
-    pause(guild: GuildIdResolvable): Queue;
+    pause(guild: GuildIdResolvable): Promise<Queue>;
     /**
      * Resume the guild stream
      * @param guild - The type can be resolved to give a {@link Queue}
      * @returns The guild queue
      */
-    resume(guild: GuildIdResolvable): Queue;
+    resume(guild: GuildIdResolvable): Promise<Queue>;
     /**
      * Stop the guild stream
      * @param guild - The type can be resolved to give a {@link Queue}

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,11 +18,19 @@ 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
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   BaseManager: () => BaseManager,
   DisTube: () => DisTube,
   DisTubeBase: () => DisTubeBase,
@@ -68,7 +78,7 @@ __export(src_exports, {
   resolveGuildId: () => resolveGuildId,
   version: () => version
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/type.ts
 var Events = /* @__PURE__ */ ((Events2) => {
@@ -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",
@@ -563,6 +573,7 @@ var DisTubeVoice = class extends import_tiny_typed_emitter.TypedEmitter {
   emittedError;
   isDisconnected = false;
   stream;
+  pausingStream;
   #channel;
   #volume = 100;
   constructor(voiceManager, channel) {
@@ -696,11 +707,15 @@ var DisTubeVoice = class extends import_tiny_typed_emitter.TypedEmitter {
       this.emittedError = true;
       this.emit("error", error);
     });
-    if (this.audioPlayer.state.status !== import_voice.AudioPlayerStatus.Paused) this.audioPlayer.play(dtStream.audioResource);
-    this.stream?.kill();
+    if (this.audioPlayer.state.status !== import_voice.AudioPlayerStatus.Paused) {
+      this.audioPlayer.play(dtStream.audioResource);
+      this.stream?.kill();
+      dtStream.spawn();
+    } else if (!this.pausingStream) {
+      this.pausingStream = this.stream;
+    }
     this.stream = dtStream;
     this.volume = this.#volume;
-    dtStream.spawn();
   }
   set volume(volume) {
     if (typeof volume !== "number" || isNaN(volume)) {
@@ -732,6 +747,9 @@ var DisTubeVoice = class extends import_tiny_typed_emitter.TypedEmitter {
     if (state.status !== import_voice.AudioPlayerStatus.Paused) return;
     if (this.stream?.audioResource && state.resource !== this.stream.audioResource) {
       this.audioPlayer.play(this.stream.audioResource);
+      this.stream.spawn();
+      this.pausingStream?.kill();
+      delete this.pausingStream;
     } else {
       this.audioPlayer.unpause();
     }
@@ -1691,21 +1709,31 @@ var Queue = class extends DisTubeBase {
    * Pause the guild stream
    * @returns The guild queue
    */
-  pause() {
-    if (this.paused) throw new DisTubeError("PAUSED");
-    this.paused = true;
-    this.voice.pause();
-    return this;
+  async pause() {
+    await this._taskQueue.queuing();
+    try {
+      if (this.paused) throw new DisTubeError("PAUSED");
+      this.paused = true;
+      this.voice.pause();
+      return this;
+    } finally {
+      this._taskQueue.resolve();
+    }
   }
   /**
    * Resume the guild stream
    * @returns The guild queue
    */
-  resume() {
-    if (!this.paused) throw new DisTubeError("RESUMED");
-    this.paused = false;
-    this.voice.unpause();
-    return this;
+  async resume() {
+    await this._taskQueue.queuing();
+    try {
+      if (!this.paused) throw new DisTubeError("RESUMED");
+      this.paused = false;
+      this.voice.unpause();
+      return this;
+    } finally {
+      this._taskQueue.resolve();
+    }
   }
   /**
    * Set the guild stream's volume
@@ -2068,7 +2096,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;
@@ -2467,7 +2503,7 @@ ${e.message}`;
 };
 
 // src/index.ts
-var version = "5.0.4";
+var version = "5.0.6";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BaseManager,