poru 3.0.2 → 3.1.0

package/.gitpod.yml

@@ -4,5 +4,3 @@
 
 tasks:
   - init: npm install
-
-

package/README.md

@@ -50,73 +50,77 @@ To use you need a configured [Lavalink](https://github.com/Frederikam/Lavalink)
 ## Example usage basic bot
 
 ```javascript
-const { Client, GatewayIntentBits } = require('discord.js');
-const { Poru } = require('poru');
+const { Client, GatewayIntentBits } = require("discord.js");
+const { Poru } = require("poru");
 const nodes = [
   {
     id: "main_node",
     hostname: "localhost",
     port: 8080,
-    password: "iloveyou3000"
-  }
-]
+    password: "iloveyou3000",
+  },
+];
 const PoruOptions = {
   reconnectTime: 0,
-  resumeKey: 'MyPlayers',
+  resumeKey: "MyPlayers",
   resumeTimeout: 60,
-  defaultPlatform: "ytsearch"
-}
+  defaultPlatform: "ytsearch",
+};
 const client = new Client({
   intents: [
-   GatewayIntentBits.Guilds,
-   GatewayIntentBits.GuildMessages,
-   GatewayIntentBits.GuildVoiceStates,
-   GatewayIntentBits.MessageContent
-  ]
+    GatewayIntentBits.Guilds,
+    GatewayIntentBits.GuildMessages,
+    GatewayIntentBits.GuildVoiceStates,
+    GatewayIntentBits.MessageContent,
+  ],
 });
-client.poru = new Poru(client, nodes, PoruOptions)
+client.poru = new Poru(client, nodes, PoruOptions);
 
-client.poru.on('trackStart', (player, track) => {
+client.poru.on("trackStart", (player, track) => {
   const channel = client.channels.cache.get(player.textChannel);
   return channel.send(`Now playing \`${track.title}\``);
 });
 
-client.on('ready', () => {
-  console.log('Ready!');
+client.on("ready", () => {
+  console.log("Ready!");
   client.poru.init(client);
 });
 
-
-client.on('interactionCreate', async (interaction) => {
+client.on("interactionCreate", async (interaction) => {
   if (!interaction.isChatInputCommand()) return;
-  if (!interaction.member.voice.channel) return interaction.reply({ content: `Please connect with voice channel `, ephemeral: true });
+  if (!interaction.member.voice.channel)
+    return interaction.reply({
+      content: `Please connect with voice channel `,
+      ephemeral: true,
+    });
 
-  const track = interaction.options.getString('track');
+  const track = interaction.options.getString("track");
 
   const res = await client.poru.resolve(track);
 
   if (res.loadType === "LOAD_FAILED") {
-    return interaction.reply('Failed to load track.');
+    return interaction.reply("Failed to load track.");
   } else if (res.loadType === "NO_MATCHES") {
-    return interaction.reply('No source found!');
+    return interaction.reply("No source found!");
   }
 
-//create connection with discord voice channnel
+  //create connection with discord voice channnel
   const player = client.poru.createConnection({
     guildId: interaction.guild.id,
     voiceChannel: interaction.member.voice.channelId,
     textChannel: interaction.channel.id,
-    selfDeaf: true
+    selfDeaf: true,
   });
-  
- 
-  if (res.loadType === 'PLAYLIST_LOADED') {
+
+  if (res.loadType === "PLAYLIST_LOADED") {
     for (const track of res.tracks) {
       track.info.requester = interaction.user;
       player.queue.add(track);
     }
 
-    interaction.reply(`${res.playlistInfo.name} has been loaded with ${res.tracks.length}`);
+    interaction.reply(
+      `${res.playlistInfo.name} has been loaded with ${res.tracks.length}`
+    );
   } else {
     const track = res.tracks[0];
     track.info.requester = interaction.user;
@@ -127,7 +131,7 @@ client.on('interactionCreate', async (interaction) => {
   if (!player.isPlaying && player.isConnected) player.play();
 });
 
-client.login('TOKEN');
+client.login("TOKEN");
 ```
 
 ## Need Help?

package/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

package/index.js

@@ -1,16 +1,12 @@
-
 module.exports = {
-    Node: require("./src/Node"),
-    Player: require("./src/Player"),
-    Poru: require("./src/Poru"),
-    Spotify : require("./src/platform/Spotify"),
-    Deezer : require("./src/platform/Deezer"),
-    AppleMusic : require("./src/platform/AppleMusic"),
-    Queue : require("./src/guild/Queue"),
-    Filter : require("./src/guild/Filter"),
-    Track: require("./src/guild/Track"),
-    PoruTrack : require("./src/guild/PoruTrack")
-    
-    
-
-}
+  Node: require("./src/Node"),
+  Player: require("./src/Player"),
+  Poru: require("./src/Poru"),
+  Spotify: require("./src/platform/Spotify"),
+  Deezer: require("./src/platform/Deezer"),
+  AppleMusic: require("./src/platform/AppleMusic"),
+  Queue: require("./src/guild/Queue"),
+  Filter: require("./src/guild/Filter"),
+  Track: require("./src/guild/Track"),
+  PoruTrack: require("./src/guild/PoruTrack"),
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "poru",
-  "version": "3.0.2",
-  "description": "A stable and powefull lavalink client with so many features",
+  "version": "3.1.0",
+  "description": "A stable and powerfull lavalink client around node.js",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -21,8 +21,8 @@
     "ws": "^8.8.0"
   },
   "engines": {
-		"node": ">=16.9.0"
-	},
+    "node": ">=16.9.0"
+  },
   "keywords": [
     "music",
     "lavalink",
@@ -31,6 +31,7 @@
     "spotify",
     "apple-music",
     "soundcloud",
+    "deezer",
     "discordjs",
     "eris"
   ]

package/src/Node.js

@@ -1,188 +1,192 @@
 const WebSocket = require("ws");
-const config = require("./config")
+const config = require("./config");
 
 class Node {
-    constructor(manager,options,node) {
-        this.manager = manager
-        this.name= options.name || null;
-        this.host = options.host || "localhost"
-        this.port = options.port || 2333
-        this.password = options.password ||"youshallnotpass"
-        this.secure = options.secure || false;
-        this.url = `${this.secure ? 'wss' : 'ws'}://${this.host}:${this.port}/`;
-        this.ws = null;
-        this.reconnectTime = node.reconnectTime || 5000;
-        this.resumeKey = node.resumeKey || null;
-        this.resumeTimeout = node.resumeTimeout || 60;
-        this.reconnectAttempt;
-        this.reconnects = 0;
-        this.isConnected = false;
-        this.destroyed = null;
-        this.stats = {
-            players: 0,
-            playingPlayers: 0,
-            uptime: 0,
-            memory: {
-                free: 0,
-                used: 0,
-                allocated: 0,
-                reservable: 0,
-            },
-            cpu: {
-                cores: 0,
-                systemLoad: 0,
-                lavalinkLoad: 0,
-            },
-        };
-
-
-    }
-    
-
-    connect() {
-        if (this.ws) this.ws.close();
-        const headers = {
-            Authorization: this.password,
-            "Num-Shards": this.manager.shards || 1,
-            "User-Id": this.manager.user,
-            "Client-Name": config.clientName
-        };
-        if (this.resumeKey) headers["Resume-Key"] = this.resumeKey;
-        this.ws = new WebSocket(this.url, { headers });
-        this.ws.on("open",this.#open.bind(this));
-        this.ws.on("error", this.#error.bind(this));
-        this.ws.on("message", this.#message.bind(this));
-        this.ws.on("close", this.#close.bind(this));
+  constructor(manager, options, node) {
+    this.manager = manager;
+    this.name = options.name || null;
+    this.host = options.host || "localhost";
+    this.port = options.port || 2333;
+    this.password = options.password || "youshallnotpass";
+    this.secure = options.secure || false;
+    this.url = `${this.secure ? "wss" : "ws"}://${this.host}:${this.port}/`;
+    this.ws = null;
+    this.reconnectTime = node.reconnectTime || 5000;
+    this.resumeKey = node.resumeKey || null;
+    this.resumeTimeout = node.resumeTimeout || 60;
+    this.reconnectAttempt;
+    this.reconnects = 0;
+    this.isConnected = false;
+    this.destroyed = null;
+    this.stats = {
+      players: 0,
+      playingPlayers: 0,
+      uptime: 0,
+      memory: {
+        free: 0,
+        used: 0,
+        allocated: 0,
+        reservable: 0,
+      },
+      cpu: {
+        cores: 0,
+        systemLoad: 0,
+        lavalinkLoad: 0,
+      },
+    };
+  }
+
+  connect() {
+    if (this.ws) this.ws.close();
+    const headers = {
+      Authorization: this.password,
+      "Num-Shards": this.manager.shards || 1,
+      "User-Id": this.manager.user,
+      "Client-Name": config.clientName,
+    };
+    if (this.resumeKey) headers["Resume-Key"] = this.resumeKey;
+    this.ws = new WebSocket(this.url, { headers });
+    this.ws.on("open", this.#open.bind(this));
+    this.ws.on("error", this.#error.bind(this));
+    this.ws.on("message", this.#message.bind(this));
+    this.ws.on("close", this.#close.bind(this));
+  }
+
+  disconnect() {
+    if (!this.isConnected) return;
+
+    this.ws?.removeAllListeners();
+    this.ws?.close();
+    this.ws = null;
+    this.isConnected = false;
+  }
+
+  #open() {
+    if (this.reconnectAttempt) {
+      clearTimeout(this.reconnectAttempt);
+      delete this.reconnectAttempt;
     }
 
-    disconnect(){
-        if(!this.isConnected) return;
-
-        this.ws?.removeAllListeners();
-        this.ws?.close();
-        this.ws = null;
-        this.isConnected = false;
-
-
+    if (this.resumeKey) {
+      this.send({
+        op: "configureResuming",
+        key: this.resumeKey.toString(),
+        timeout: this.resumeTimeout,
+      });
+      this.manager.emit(
+        "debug",
+        this.name,
+        `[Web Socket]  Resuming configured on Lavalink`
+      );
     }
 
-
-    #open(){
-        if (this.reconnectAttempt) {
-            clearTimeout(this.reconnectAttempt);
-            delete this.reconnectAttempt;
-        } 
-
-        if (this.resumeKey){
-            this.send({
-                op: "configureResuming", 
-                key: (this.resumeKey).toString(), 
-                timeout: this.resumeTimeout 
-            });
-            this.manager.emit("debug",this.name,`[Web Socket]  Resuming configured on Lavalink`)
-        }
-
-        this.manager.emit("nodeConnect", this);
-        this.isConnected = true;
-        this.manager.emit('debug', this.name, `[Web Socket] Connection ready ${this.url}`);
-
-        if(config.autoResume){
-          
-            for (const player of this.manager.players.values()) {
-                if (player.node === this) {
-                  player.restart();
-                }
-              }
-
-
-
-
-
-
+    this.manager.emit("nodeConnect", this);
+    this.isConnected = true;
+    this.manager.emit(
+      "debug",
+      this.name,
+      `[Web Socket] Connection ready ${this.url}`
+    );
+
+    if (config.autoResume) {
+      for (const player of this.manager.players.values()) {
+        if (player.node === this) {
+          player.restart();
         }
-        
+      }
     }
+  }
 
-    #message(payload) {
+  #message(payload) {
+    const packet = JSON.parse(payload);
+    if (!packet.op) return;
 
-        const packet = JSON.parse(payload);
-        if(!packet.op) return;
-        
-        if (packet.op && packet.op === "stats") {
-            this.stats = { ...packet };
-        }
-        const player = this.manager.players.get(packet.guildId);
-        if (packet.guildId && player) player.emit(packet.op, packet);
-         packet.node = this;
-        this.manager.emit("debug",this.name,`[Web Socket] Lavalink Node Update : ${packet.op}  `)
-        this.manager.emit("raw", packet);
+    if (packet.op && packet.op === "stats") {
+      this.stats = { ...packet };
     }
-
-    #close(event) {
-        this.disconnect();
-        this.manager.emit("nodeDisconnect",this,event);
-        this.manager.emit("debug",this.name,`[Web Socket] Connection with Lavalink closed with Error code : ${event||"Unknown code"}`)
-        if (event !== 1000){
-            
-       }
-    }
-
-
-    #error(event) {
-        if (!event) return "Unknown event";
-
-        this.manager.emit("debug",this.name,`[Web Socket] Connection for Lavalink node has error code: ${event.code}`)
-        this.manager.emit("nodeError", this, event);
-        return this.reconnect();
+    const player = this.manager.players.get(packet.guildId);
+    if (packet.guildId && player) player.emit(packet.op, packet);
+    packet.node = this;
+    this.manager.emit(
+      "debug",
+      this.name,
+      `[Web Socket] Lavalink Node Update : ${packet.op}  `
+    );
+    this.manager.emit("raw", packet);
+  }
+
+  #close(event) {
+    this.disconnect();
+    this.manager.emit("nodeDisconnect", this, event);
+    this.manager.emit(
+      "debug",
+      this.name,
+      `[Web Socket] Connection with Lavalink closed with Error code : ${
+        event || "Unknown code"
+      }`
+    );
+    if (event !== 1000) {
     }
-
-    destroy(){
-        if(!this.isConnected) return;
-
-        const players = this.manager.players.filter(p => p.node == this);
-        if (players.size) players.forEach(p => p.destroy());
-        this.ws.close(1000, "destroy");
-        this.ws.removeAllListeners();
-        this.ws = null;
-        this.reconnect = 1;
-        this.destroyed = true;
-        this.manager.nodes.delete(this.host)
-        this.manager.emit("nodeDestroy", this);
-
-
-    }
-
-    reconnect() {
-        this.reconnectAttempt = setTimeout(() => {
-            this.isConnected = false;
-            this.ws.removeAllListeners();
-            this.ws = null;
-            this.manager.emit("nodeReconnect", this);
-            this.connect();
-        }, this.reconnectTime);
-    }
-
-    send(payload) {
-        const data = JSON.stringify(payload);
-        this.ws.send(data, (error) => {
-            if (error) return error;
-            return null;
-        });
-        this.manager.emit("raw", data, this.name)
-    }
-
-    get penalties(){
-        let penalties = 0;
-        if (!this.isConnected) return penalties;
-        penalties += this.stats.players;
-        penalties += Math.round(Math.pow(1.05, 100 * this.stats.cpu.systemLoad) * 10 - 10);
-        if (this.stats.frameStats) {
-            penalties += this.stats.frameStats.deficit;
-            penalties += this.stats.frameStats.nulled * 2;
-        }
-        return penalties;
+  }
+
+  #error(event) {
+    if (!event) return "Unknown event";
+
+    this.manager.emit(
+      "debug",
+      this.name,
+      `[Web Socket] Connection for Lavalink node has error code: ${event.code}`
+    );
+    this.manager.emit("nodeError", this, event);
+    return this.reconnect();
+  }
+
+  destroy() {
+    if (!this.isConnected) return;
+
+    const players = this.manager.players.filter((p) => p.node == this);
+    if (players.size) players.forEach((p) => p.destroy());
+    this.ws.close(1000, "destroy");
+    this.ws.removeAllListeners();
+    this.ws = null;
+    this.reconnect = 1;
+    this.destroyed = true;
+    this.manager.nodes.delete(this.host);
+    this.manager.emit("nodeDestroy", this);
+  }
+
+  reconnect() {
+    this.reconnectAttempt = setTimeout(() => {
+      this.isConnected = false;
+      this.ws.removeAllListeners();
+      this.ws = null;
+      this.manager.emit("nodeReconnect", this);
+      this.connect();
+    }, this.reconnectTime);
+  }
+
+  send(payload) {
+    const data = JSON.stringify(payload);
+    this.ws.send(data, (error) => {
+      if (error) return error;
+      return null;
+    });
+    this.manager.emit("raw", data, this.name);
+  }
+
+  get penalties() {
+    let penalties = 0;
+    if (!this.isConnected) return penalties;
+    penalties += this.stats.players;
+    penalties += Math.round(
+      Math.pow(1.05, 100 * this.stats.cpu.systemLoad) * 10 - 10
+    );
+    if (this.stats.frameStats) {
+      penalties += this.stats.frameStats.deficit;
+      penalties += this.stats.frameStats.nulled * 2;
     }
+    return penalties;
+  }
 }
 
 module.exports = Node;
-