poru 4.2.2 → 5.0.0

package/.gitpod.yml

@@ -1,8 +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
-
-
+# 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/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 parasop
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 parasop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,157 +1,164 @@
-<p align="center">
-  <img src="https://cdn.discordapp.com/attachments/732987654165233744/987656504373026816/20220618_000923_0000.png" />
-</p>
-<p align="center">
-
-[![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)
-![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>
-
-## Table of contents
-
-- [Documentation](https://poru.js.org)
-- [Installation](#installation)
-- [About](#about)
-- [Example](https://github.com/parasop/poru-example)
-
-# Installation
-
-```
-// Using npm
-npm install poru
-
-// Using yarn
-yarn add poru
-```
-
-# About
-
-To use you need a configured [Lavalink](https://github.com/freyacodes/Lavalink) instance.
-
-- Stable client
-- support typescript
-- 100% Compatible with Lavalink
-- Object-oriented
-- 100% Customizable
-- Easy to setup
-- Inbuilt Queue System
-- Inbuilt support for spotify,apple music and deezer
-## Implementation
-
-[Poru Music](https://github.com/parasop/poru-example) **Example bot as guide for beginning.**
-
-
-## Implementation Repo:
-Note : Send pr to add your repo here
-
-URL | Features  | Additional Information
--------|----------|-----------------
-[Poru Music](https://github.com/parasop/poru-example) | Basic example | works with latest djs version
-
-
-
-
-
-
-
-
-
-
-## Example usage basic bot
-
-```javascript
-const { Client, GatewayIntentBits } = require("discord.js");
-const { Poru } = require("poru");
-const nodes = [
-  {
-    name: "local-node",
-    host: "localhost",
-    port: 2333,
-    password: "youshallnotpass",
-  },
-];
-const PoruOptions = {
-  library:"discord.js",
-  defaultPlatform: "scsearch",
-};
-const client = new Client({
-  intents: [
-    GatewayIntentBits.Guilds,
-    GatewayIntentBits.GuildMessages,
-    GatewayIntentBits.GuildVoiceStates,
-    GatewayIntentBits.MessageContent,
-  ],
-});
-client.poru = new Poru(client, nodes, PoruOptions);
-
-client.poru.on("trackStart", (player, track) => {
-  const channel = client.channels.cache.get(player.textChannel);
-  return channel.send(`Now playing \`${track.info.title}\``);
-});
-
-client.on("ready", () => {
-  console.log("Ready!");
-  client.poru.init(client);
-});
-
-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,
-    });
-
-  const track = interaction.options.getString("track");
-
-  const res = await client.poru.resolve({query:track,source:"scsearch",requester:interaction.member});
-
-  if (res.loadType === "LOAD_FAILED") {
-    return interaction.reply("Failed to load track.");
-  } else if (res.loadType === "NO_MATCHES") {
-    return interaction.reply("No source found!");
-  }
-
-  //create connection with discord voice channnel
-  const player = client.poru.createConnection({
-    guildId: interaction.guild.id,
-    voiceChannel: interaction.member.voice.channelId,
-    textChannel: interaction.channel.id,
-    deaf: true,
-  });
-
-  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}`
-    );
-  } else {
-    const track = res.tracks[0];
-    track.info.requester = interaction.user;
-    player.queue.add(track);
-    interaction.reply(`Queued Track \n \`${track.info.title}\``)
-  }
-
-  if (!player.isPlaying && player.isConnected) player.play();
-});
-
-client.login("TOKEN");
-```
-
-## Need Help?
-
-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) .
+<p align="center">
+  <img src="https://cdn.discordapp.com/attachments/732987654165233744/987656504373026816/20220618_000923_0000.png" />
+</p>
+<p align="center">
+
+[![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)
+![NPM](https://img.shields.io/npm/l/poru?style=flat-square)
+
+</p>
+
+<p align="center">
+note: this version support only lavalink v4 or above
+</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>
+
+## Table of contents
+
+- [Documentation](https://poru.js.org)
+- [Installation](#installation)
+- [About](#about)
+- [Example](https://github.com/parasop/poru-example)
+
+# Installation
+
+```
+// Using npm
+npm install poru
+
+// Using yarn
+yarn add poru
+```
+
+# About
+
+To use you need a configured [Lavalink](https://github.com/freyacodes/Lavalink) instance.
+
+- Stable client
+- support typescript
+- 100% Compatible with Lavalink
+- Object-oriented
+- 100% Customizable
+- Easy to setup
+- Inbuilt Queue System
+- Inbuilt support for spotify,apple music and deezer
+## Implementation
+
+[Poru Music](https://github.com/parasop/poru-example) **Example bot as guide for beginning.**
+
+
+## Implementation Repo:
+Note : Send pr to add your repo here
+
+URL | Features  | Additional Information
+-------|----------|-----------------
+[Poru Music](https://github.com/parasop/poru-example) | Basic example | works with latest djs version |
+[The world machine](https://github.com/Reishimanfr/TWM-bot) | See github repo for full list | - |
+[Lunox](https://github.com/adh319/Lunox) | Look over the repo for the full list of features. | Simply powerfull Discord Music Bot |
+
+
+
+
+
+
+
+
+
+## Example usage basic bot
+
+```javascript
+const { Client, GatewayIntentBits } = require("discord.js");
+const { Poru } = require("poru");
+const nodes = [
+  {
+    name: "local-node",
+    host: "localhost",
+    port: 2333,
+    password: "youshallnotpass",
+  },
+];
+const PoruOptions = {
+  library:"discord.js",
+  defaultPlatform: "scsearch",
+};
+const client = new Client({
+  intents: [
+    GatewayIntentBits.Guilds,
+    GatewayIntentBits.GuildMessages,
+    GatewayIntentBits.GuildVoiceStates,
+    GatewayIntentBits.MessageContent,
+  ],
+});
+client.poru = new Poru(client, nodes, PoruOptions);
+
+client.poru.on("trackStart", (player, track) => {
+  const channel = client.channels.cache.get(player.textChannel);
+  return channel.send(`Now playing \`${track.info.title}\``);
+});
+
+client.on("ready", () => {
+  console.log("Ready!");
+  client.poru.init(client);
+});
+
+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,
+    });
+
+  const track = interaction.options.getString("track");
+
+  const res = await client.poru.resolve({query:track,source:"scsearch",requester:interaction.member});
+
+  if (res.loadType === "error") {
+    return interaction.reply("Failed to load track.");
+  } else if (res.loadType === "empty") {
+    return interaction.reply("No source found!");
+  }
+
+  //create connection with discord voice channnel
+  const player = client.poru.createConnection({
+    guildId: interaction.guild.id,
+    voiceChannel: interaction.member.voice.channelId,
+    textChannel: interaction.channel.id,
+    deaf: true,
+  });
+
+  if (res.loadType === "playlist") {
+    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}`
+    );
+  } else {
+    const track = res.tracks[0];
+    track.info.requester = interaction.user;
+    player.queue.add(track);
+    interaction.reply(`Queued Track \n \`${track.info.title}\``)
+  }
+
+  if (!player.isPlaying && player.isConnected) player.play();
+});
+
+client.login("TOKEN");
+```
+
+## Need Help?
+
+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/dist/src/Connection.d.ts

@@ -1,17 +1,17 @@
-import { Player } from "./Player";
-export interface IVoiceServer {
-    token: string;
-    sessionId: string;
-    endpoint: string;
-}
-export declare class Connection {
-    player: Player;
-    sessionId: string | null;
-    region: string | null;
-    voice: IVoiceServer | null;
-    self_mute: boolean;
-    self_deaf: boolean;
-    constructor(player: Player);
-    setServersUpdate(data: any): void;
-    setStateUpdate(data: any): void;
-}
+import { Player } from "./Player";
+export interface IVoiceServer {
+    token: string;
+    sessionId: string;
+    endpoint: string;
+}
+export declare class Connection {
+    player: Player;
+    sessionId: string | null;
+    region: string | null;
+    voice: IVoiceServer | null;
+    self_mute: boolean;
+    self_deaf: boolean;
+    constructor(player: Player);
+    setServersUpdate(data: any): void;
+    setStateUpdate(data: any): void;
+}

package/dist/src/Connection.js

@@ -1,51 +1,51 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Connection = void 0;
-const Error_1 = require("./Error");
-class Connection {
-    player;
-    sessionId;
-    region;
-    voice;
-    self_mute;
-    self_deaf;
-    constructor(player) {
-        this.player = player;
-        this.sessionId = null;
-        this.region = null;
-        this.voice = {
-            sessionId: null,
-            token: null,
-            endpoint: null,
-        };
-        this.self_mute = false;
-        this.self_deaf = false;
-    }
-    setServersUpdate(data) {
-        if (!data.endpoint)
-            throw new Error(Error_1.Errors.sessionNotFound);
-        this.voice.endpoint = data.endpoint;
-        this.voice.token = data.token;
-        this.region =
-            data.endpoint.split(".").shift()?.replace(/[0-9]/g, "") || null;
-        this.player.node.rest.updatePlayer({
-            guildId: this.player.guildId,
-            data: { voice: this.voice },
-        });
-        this.player.poru.emit("debug", this.player.node.name, `[Voice] <- [Discord] : Voice Server Update | Server: ${this.region} Guild: ${this.player.guildId}`);
-    }
-    setStateUpdate(data) {
-        const { session_id, channel_id, self_deaf, self_mute } = data;
-        if (this.player.voiceChannel &&
-            channel_id &&
-            this.player.voiceChannel !== channel_id) {
-            this.player.voiceChannel = channel_id;
-        }
-        this.self_deaf = self_deaf;
-        this.self_mute = self_mute;
-        this.voice.sessionId = session_id || null;
-        //  this.player.poru.emit('debug', this.player.node.name, `[Voice] <- [Discord] : State Update Received | Channel: ${this.player.voiceChannel} Session ID: ${session_id} Guild: ${this.player.guildId}`);
-    }
-}
-exports.Connection = Connection;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connection = void 0;
+const Error_1 = require("./Error");
+class Connection {
+    player;
+    sessionId;
+    region;
+    voice;
+    self_mute;
+    self_deaf;
+    constructor(player) {
+        this.player = player;
+        this.sessionId = null;
+        this.region = null;
+        this.voice = {
+            sessionId: null,
+            token: null,
+            endpoint: null,
+        };
+        this.self_mute = false;
+        this.self_deaf = false;
+    }
+    setServersUpdate(data) {
+        if (!data.endpoint)
+            throw new Error(Error_1.Errors.sessionNotFound);
+        this.voice.endpoint = data.endpoint;
+        this.voice.token = data.token;
+        this.region =
+            data.endpoint.split(".").shift()?.replace(/[0-9]/g, "") || null;
+        this.player.node.rest.updatePlayer({
+            guildId: this.player.guildId,
+            data: { voice: this.voice },
+        });
+        this.player.poru.emit("debug", this.player.node.name, `[Voice] <- [Discord] : Voice Server Update | Server: ${this.region} Guild: ${this.player.guildId}`);
+    }
+    setStateUpdate(data) {
+        const { session_id, channel_id, self_deaf, self_mute } = data;
+        if (this.player.voiceChannel &&
+            channel_id &&
+            this.player.voiceChannel !== channel_id) {
+            this.player.voiceChannel = channel_id;
+        }
+        this.self_deaf = self_deaf;
+        this.self_mute = self_mute;
+        this.voice.sessionId = session_id || null;
+        //  this.player.poru.emit('debug', this.player.node.name, `[Voice] <- [Discord] : State Update Received | Channel: ${this.player.voiceChannel} Session ID: ${session_id} Guild: ${this.player.guildId}`);
+    }
+}
+exports.Connection = Connection;
 //# sourceMappingURL=Connection.js.map

package/dist/src/Error.d.ts

@@ -1,3 +1,3 @@
-export declare enum Errors {
-    sessionNotFound = ""
-}
+export declare enum Errors {
+    sessionNotFound = ""
+}

package/dist/src/Error.js

@@ -1,8 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Errors = void 0;
-var Errors;
-(function (Errors) {
-    Errors["sessionNotFound"] = "";
-})(Errors = exports.Errors || (exports.Errors = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Errors = void 0;
+var Errors;
+(function (Errors) {
+    Errors["sessionNotFound"] = "";
+})(Errors = exports.Errors || (exports.Errors = {}));
 //# sourceMappingURL=Error.js.map