poru 1.2.3 → 2.0.2

package/.gitpod.yml

@@ -0,0 +1,8 @@
+# This configuration file was automatically generated by Gitpod.
+# Please adjust to your needs (see https://www.gitpod.io/docs/config-gitpod-file)
+# and commit this file to your remote git repository to share the goodness with others.
+
+tasks:
+  - init: npm install
+
+

package/README.md

@@ -3,16 +3,15 @@
 </p>
 <p align="center">
 
- [![Discord](https://img.shields.io/discord/567705326774779944?style=flat-square)](https://discord.gg/Zmmc47Nrh8)
+[![Discord](https://img.shields.io/discord/567705326774779944?style=flat-square)](https://discord.gg/Zmmc47Nrh8)
 [![npm](https://img.shields.io/npm/v/poru?style=flat-square)](https://www.npmjs.com/package/poru)
 ![Github Stars](https://img.shields.io/github/stars/parasop/poru?style=flat-square)
 ![GitHub issues](https://img.shields.io/github/issues-raw/parasop/poru?style=flat-square)
-![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/poru?style=flat-square) 
+![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/poru?style=flat-square)
 ![NPM](https://img.shields.io/npm/l/poru?style=flat-square)
 
 </p>
 
-
 <p align="center">
   <a href="https://nodei.co/npm/poru/"><img src="https://nodei.co/npm/poru.png?downloads=true&downloadRank=true&stars=true"></a>
 </p>
@@ -25,6 +24,7 @@
 - [Example](https://github.com/parasop/poru-example)
 
 # Installation
+
 ```
 // Using npm
 npm install poru
@@ -34,6 +34,7 @@ yarn add poru
 ```
 
 # About
+
 To use you need a configured [Lavalink](https://github.com/Frederikam/Lavalink) instance.
 
 - Stable client
@@ -43,15 +44,16 @@ To use you need a configured [Lavalink](https://github.com/Frederikam/Lavalink)
 - Easy to setup
 
 ## Implementation
-[Poru Music](https://github.com/parasop/poru-example) **Example bot as guide for beginning.** 
 
+[Poru Music](https://github.com/parasop/poru-example) **Example bot as guide for beginning.**
 
 ## Example usage basic bot
+
 ```javascript
 // main file
 // Require both libraries
-const { Client } = require("discord.js");
-const { Poru } = require("poru");
+const { Client } = require('discord.js');
+const { Poru } = require('poru');
 
 // Initiate both main classes
 const client = new Client();
@@ -59,39 +61,49 @@ const client = new Client();
 // Define some options for the node
 const nodes = [
   {
-    host: "localhost",
-    password: "youshallnotpass",
+    host: 'localhost',
+    password: 'youshallnotpass',
     port: 2333,
-    secure:false
-  }
+    secure: false,
+  },
 ];
 
+// Define if you want to integrate spotify
+const spotifyOptions = {
+  clientID: 'Your Client ID', // You'll find this on https://developers.spotify.com/dashboard/
+  clientSecret: 'Your Client Secret', // You'll find this on https://developers.spotify.com/dashboard/
+  playlistLimit: 10, // The amount of pages to load when a playlist is searched with each page having 50 tracks.
+  albumLimit: 5, // The amount of pages to load when a album is searched with each page having 50 tracks.
+  artistLimit: 5, // The amount of pages to load when a artist is searched with each page having 50 tracks.
+  searchMarket: 'IN', // The market from where the query should be searched from. Mainly this should contain your country.
+};
+
 // Assign Manager to the client variable
-client.poru = new Poru(client,nodes);
+client.poru = new Poru(client, nodes);
 
 // Emitted whenever a node connects
-client.poru.on("nodeConnect", node => {
-    console.log(`Node "${node.name}" connected.`)
-})
+client.poru.on('nodeConnect', node => {
+  console.log(`Node "${node.name}" connected.`);
+});
 
 // Emitted whenever a node encountered an error
-client.poru.on("nodeError", (node, error) => {
-    console.log(`Node "${node.name}" encountered an error`)
-})
+client.poru.on('nodeError', (node, error) => {
+  console.log(`Node "${node.name}" encountered an error`);
+});
 
 // Listen for when the client becomes ready
-client.once("ready", () => {
-  client.poru.init(client;
+client.once('ready', () => {
+  client.poru.init(client);
   console.log(`Logged in as ${client.user.tag}`);
 });
 
-// Finally login at the END of your code
-client.login("your bot token here");
-
+// this event used to make connections upto date with lavalink
+client.on('raw', async d => await client.poru.packetUpdate(d));
 
+// Finally login at the END of your code
+client.login('your bot token here');
 ```
 
-
 ```javascript
 // creating player
 const player = await client.poru.createConnection({
@@ -99,12 +111,13 @@ const player = await client.poru.createConnection({
   voiceChannel: message.member.voice.channel.id,
   textChannel: message.channel,
   selfDeaf: true,
-  selfMute: false, 
-  })
-  // Getting tracks
-const resolve = await client.poru.resolve('Ignite',"yt");
+  selfMute: false,
+});
+// Getting tracks
+const resolve = await client.poru.resolve('Ignite', 'yt');
 ```
 
 ## Need Help?
-Feel free to join our [discord server](https://discord.gg/Zmmc47Nrh8), Give us suggestions and advice about errors and new features. 
+
+Feel free to join our [discord server](https://discord.gg/Zmmc47Nrh8), Give us suggestions and advice about errors and new features.
 with ❤️ by [Paras](https://github.com/parasop) .

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poru",
-  "version": "1.2.3",
+  "version": "2.0.2",
   "description": "A stable and powefull lavalink client with so many features",
   "main": "index.js",
   "scripts": {
@@ -19,5 +19,16 @@
   "dependencies": {
     "node-fetch": "^3.2.6",
     "ws": "^8.8.0"
-  }
+  },
+  "keywords": [
+    "music",
+    "lavalink",
+    "poru",
+    "bot",
+    "spotify",
+    "apple-music",
+    "soundcloud",
+    "discordjs",
+    "eris"
+  ]
 }

package/src/Node.js

@@ -1,16 +1,15 @@
 const WebSocket = require("ws");
-const config = require("./config.json")
+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.url = `${options.secure ? 'wss' : 'ws'}://${options.host}:${options.port}`;
         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;
@@ -37,132 +36,153 @@ class Node {
         };
 
 
- }
-
- 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.client
-   };
-   if (this.resumeKey) headers["Resume-Key"] = this.resumeKey;
-   this.ws = new WebSocket(`ws${this.secure ? "s" : ""}:${this.host}:${this.port}/`, { 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));
-  }
-
-
-#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`)
-}
+    }
+    
+
+    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));
+    }
 
-this.manager.emit("nodeConnect", this);
-this.isConnected = true;
-this.manager.emit('debug', this.name, `[Web Socket] Connection ready ${this.url}`);
-      
-}
+    disconnect(){
+        if(!this.isConnected) return;
+
+        this.ws?.removeAllListeners();
+        this.ws?.close();
+        this.ws = null;
+        this.isConnected = false;
 
-#message(payload) {
-    if (Array.isArray(payload)) payload = Buffer.concat(payload);
-    else if (payload instanceof ArrayBuffer) payload = Buffer.from(payload);
 
-    const packet = JSON.parse(payload);
-    if (packet.op && packet.op === "stats") {
-        this.stats = { ...packet };
-        delete this.stats.op;
     }
-    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.manager.emit("nodeDisconnect", event, this);
-    this.manager.emit("debug",this.name,`[Web Socket] Connection with Lavalink closed with Error code : ${event||"Unkwon code"}`)
-    if (event !== 1000){
+    #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();
+                }
+              }
+
+
+
+
+
+
+        }
         
-     return this.reconnect();
     }
-}
 
+    #message(payload) {
 
-    #error(event) {
-    if (!event) return "Unknown event";
+        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);
+    }
 
-    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();
-}
+    #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);
+    #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;
 
-reconnect() {
-    this.reconnectAttempt = setTimeout(() => {
-        this.isConnected = false;
+        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.manager.emit("nodeReconnect", this);
-        this.connect();
-    }, this.reconnectTime);
-}
-
-send(payload) {
-    this.ws.send(JSON.stringify(payload), (error) => {
-        if (error) return error;
-        return null;
-    });
-}
+        this.reconnect = 1;
+        this.destroyed = true;
+        this.manager.nodes.delete(this.host)
+        this.manager.emit("nodeDestroy", this);
 
 
-
-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;
-}
 
+    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;
+module.exports = Node;
 

package/src/Player.js

@@ -23,7 +23,7 @@ class Player extends EventEmitter {
 
         this.isPlaying = false;
 
-        this.isPause = false;
+        this.isPaused = false;
 
         this.trackRepeat = false;
 
@@ -50,26 +50,32 @@ class Player extends EventEmitter {
             this.manager.emit("playerUpdate", this, packet);
         });
     }
-    async play() {
+
+    async play(options={}) {
 
         if (!this.queue.length) {
-            return nulll;
+            return null;
+        }
+        
+         this.currentTrack = this.queue.shift()
+
+        if(!this.currentTrack.track){
+          this.currentTrack = await this.currentTrack.resolve(this.manager);
         }
-        this.currentTrack = this.queue.shift();
-        this.playing = true;
-        this.timestamp = Date.now();
+
+        this.isPlaying = true;
         this.node.send({
             op: "play",
             guildId: this.guild,
             track: this.currentTrack.track,
-            volume: this.volume || 100,
-        });
+            noReplace:options.noReplace || true,
+           });
         this.position = 0;
         return this;
     }
 
 
-     stop() {
+    stop() {
 
         this.position = 0;
         this.isConnectd = false
@@ -90,7 +96,7 @@ class Player extends EventEmitter {
             pause,
         });
         this.isPlaying = !pause;
-        this.isPause = pause;
+        this.isPaused = pause;
 
         return this;
     }
@@ -125,6 +131,7 @@ class Player extends EventEmitter {
         return this;
     }
 
+
     async QueueRepeat() {
         this.loop = 2;
         this.queueRepeat = true;
@@ -136,9 +143,7 @@ class Player extends EventEmitter {
         this.loop = 0;
         this.trackRepeat = false;
         this.queueRepeat = false;
-
-
-        return this;
+           return this;
     }
 
     async setTextChannel(channel) {
@@ -179,9 +184,6 @@ class Player extends EventEmitter {
         return this;
     }
 
-
-
-
     async disconnect() {
         if (this.voiceChannel === null) return null;
         this.pause(true);
@@ -209,16 +211,34 @@ class Player extends EventEmitter {
         this.manager.players.delete(this.guild);
     }
 
+    restart(){
+        this.filters.updateFilters();
+        if(this.currentTrack){
+
+            this.isPlaying = true;
+            this.node.send({
+                op: "play",
+                startTime: this.position,
+                noReplace:true,
+                guildId: this.guild,
+                track: this.currentTrack.track,
+                puase: this.isPaused
+              });
+           
+
+        }
+    }
+
     async autoplay(toggle = false) {
 
         if (!toggle) return null;
         try {
             if (!this.previousTrack) return this.stop();
-            let data = `https://www.youtube.com/watch?v=${this.previousTrack.identifier}&list=RD${this.previousTrack.identifier}`;
+            let data = `https://www.youtube.com/watch?v=${this.previousTrack.info.identifier}&list=RD${this.previousTrack.info.identifier}`;
 
-            let response = await this.manager.search(data);
+            let response = await this.manager.resolve(data);
 
-            if (!response || !response.tracks || ["LOAD_FAILED", "NO_MATCHES"].includes(response.type)) return this.stop();
+            if (!response || !response.tracks || ["LOAD_FAILED", "NO_MATCHES"].includes(response.loadType)) return this.stop();
 
             let track = response.tracks[Math.floor(Math.random() * Math.floor(response.tracks.length))];
 
@@ -303,7 +323,6 @@ class Player extends EventEmitter {
         return events[data.type] || events.default;
     }
 
-
 }
 
 module.exports = Player;

package/src/Poru.js

@@ -2,11 +2,13 @@ const { EventEmitter } = require("events");
 const fetch = (...args) => import('node-fetch').then(({
     default: fetch
 }) => fetch(...args));
+const config = require("./config")
 const Player = require("./Player");
 const Node = require("./Node");
 const Response = require("./guild/Response");
-const config = require("./config.json")
 const Spotify = require("./platform/Spotify")
+const AppleMusic = require("./platform/AppleMusic")
+const Deezer = require("./platform/Deezer")
 class Poru extends EventEmitter {
     constructor(client, nodes, options = {}) {
         super();
@@ -23,6 +25,7 @@ class Poru extends EventEmitter {
         this.options = options
         this.shards = options.shards || 1;
         this.sendData = null;
+        this.version = config.version
     }
 
 
@@ -75,21 +78,34 @@ class Poru extends EventEmitter {
             if (guild) guild.shard.send(data);
         }
         client.on("raw", async packet => {
-            await this.#packetUpdate(packet);
+            await this.packetUpdate(packet);
         })
-        
+
         this._nodes.forEach((node) => this.addNode(node));
 
 
- if (this.options.spotify.clientID && this.options.spotify.clientSecret) {
-            this.spotify = new Spotify(this, {
-                clientID: this.options.clientID,
-                clientSecret: this.options.clientSecret 
-                })
+        if (this.options.spotify && this.options.spotify.clientID && this.options.spotify.clientSecret) {
+            this.spotify = new Spotify(this, this.options)
+        }
+        if (this.options.apple) {
+            if (!this.options.apple.playlistLimit) {
+                throw new Error("[Poru Apple Music] playlistLimit must be provided")
+            }
+            this.apple = new AppleMusic(this, this.options)
+            this.apple.requestToken();
+        }
+        if (this.options.deezer) {
+            if (!this.options.deezer.playlistLimit) {
+                throw new Error("[Poru Deezer Music] playlistLimit must be provided")
+
+            }
+            this.deezer = new Deezer(this, this.options)
+
         }
         console.log(`Thanks for using Poru`)
     }
 
+
     setServersUpdate(data) {
         let guild = data.guild_id
         this.voiceServers.set(guild, data);
@@ -130,7 +146,7 @@ class Poru extends EventEmitter {
         this.voiceStates.delete(data.guild_id);
     }
 
-    #packetUpdate(packet) {
+    packetUpdate(packet) {
         if (!['VOICE_STATE_UPDATE', 'VOICE_SERVER_UPDATE'].includes(packet.t)) return;
         const player = this.players.get(packet.d.guild_id);
         if (!player) return;
@@ -175,15 +191,24 @@ class Poru extends EventEmitter {
 
 
     async resolve(track, source) {
+
         const node = this.leastUsedNodes[0];
         if (!node) throw new Error("No nodes are available.");
-        if(this.spotify &&  this.spotify.check(track)){
-             return await this.spotify.resolve(track);
+
+        if (this.spotify && this.spotify.check(track)) {
+            return await this.spotify.resolve(track);
+        } else if (this.apple && this.apple.check(track)) {
+            return await this.apple.resolve(track);
+        } else if (this.deezer && this.deezer.check(track)) {
+            return await this.deezer.resolve(track);
         }
+
+
+
         const regex = /^https?:\/\//;
         if (!regex.test(track)) {
             // eslint-disable-next-line no-param-reassign
-            track = `${source || "yt"}search:${track}`;
+            track = `${source || "ytsearch"}:${track}`;
         }
         const result = await this.#fetch(node, "loadtracks", `identifier=${encodeURIComponent(track)}`);