simply-xp 1.3.5-beta-7 → 1.3.5

package/README.md

@@ -1,57 +1,57 @@
-<p align="center"><img align="center" style="margin-bottom:-6px" src="https://i.imgur.com/BiaHJA7.png?maxwidth=128&fidelity=grand"></p>
-
-<h2 style="font-size:2.5rem;" align="center">Simply-XP</h2>
-
-<h2 align="center">A Simple, Easy and Beginner friendly XP System. <br>Supports Discord.JS<br><br>Developed by Rahuletto#0243 & Maintained by Abadima#6356</h2>
-
-<br>
-<p align="center">
-   <a href="https://www.npmjs.com/package/simply-xp"><img src="https://img.shields.io/npm/v/simply-xp.svg?style=flat-square" /></a>
- <a href="https://www.npmjs.com/package/simply-xp"><img src="https://img.shields.io/npm/dt/simply-xp?style=flat-square" /></a><br>
-   <a href="https://www.npmjs.com/package/simply-xp"><img src="https://nodei.co/npm/simply-xp.png?downloadRank=true&downloads=true&downloadRank=true&stars=true" /></a><br>
-   <a href="https://discord.gg/3JzDV9T5Fn"><img src="https://invidget.switchblade.xyz/3JzDV9T5Fn" /></a>
-</p>
-
-<br>
-
-## 🖥️ <b>How to install ?
-
-```
-npm install simply-xp
-```
-
-(or)
-
-```
-yarn add simply-xp
-```
-
-<br>
-
-# 🎉 Recent Updates 🎉
-
-- Fixed Various Bugs
-- Updated `Chart.js`
-- D.JS v14 Support
-
-
-# But Why ?
-
-- Easiest XP System in Discord.js
-- Fastest Support ever
-- Rank Card Maker
-- Beginner Friendly
-- Easier than other XP Systems
-- Inbuilt Auto Roles system
-- Flexible and simple at the same time
-
-<br>
-
-## **Need Help ? Join the [Discord Server](https://discord.gg/3JzDV9T5Fn)**
-
-<br>
-   
- <h1>👥 Contact us | Support</h1>
- <p>
-<a href="https://discord.gg/3JzDV9T5Fn"><img src="https://invidget.switchblade.xyz/3JzDV9T5Fn" /></a>
+<p align="center"><img align="center" style="margin-bottom:-6px" src="https://i.imgur.com/BiaHJA7.png?maxwidth=128&fidelity=grand"></p>
+
+<h2 style="font-size:2.5rem;" align="center">Simply-XP</h2>
+
+<h2 align="center">A Simple, Easy and Beginner friendly XP System. <br>Supports Discord.JS<br><br>Developed by Rahuletto#0243 & Maintained by Abadima#6356</h2>
+
+<br>
+<p align="center">
+   <a href="https://www.npmjs.com/package/simply-xp"><img src="https://img.shields.io/npm/v/simply-xp.svg?style=flat-square" /></a>
+ <a href="https://www.npmjs.com/package/simply-xp"><img src="https://img.shields.io/npm/dt/simply-xp?style=flat-square" /></a><br>
+   <a href="https://www.npmjs.com/package/simply-xp"><img src="https://nodei.co/npm/simply-xp.png?downloadRank=true&downloads=true&downloadRank=true&stars=true" /></a><br>
+   <a href="https://discord.gg/3JzDV9T5Fn"><img src="https://invidget.switchblade.xyz/3JzDV9T5Fn" /></a>
+</p>
+
+<br>
+
+## 🖥️ <b>How to install ?
+
+```
+npm install simply-xp
+```
+
+(or)
+
+```
+yarn add simply-xp
+```
+
+<br>
+
+# 🎉 Recent Updates 🎉
+
+- Fixed Various Bugs
+- Updated `Chart.js`
+- D.JS v14 Support
+
+
+# But Why ?
+
+- Easiest XP System in Discord.js
+- Fastest Support ever
+- Rank Card Maker
+- Beginner Friendly
+- Easier than other XP Systems
+- Inbuilt Auto Roles system
+- Flexible and simple at the same time
+
+<br>
+
+## **Need Help ? Join the [Discord Server](https://discord.gg/3JzDV9T5Fn)**
+
+<br>
+   
+ <h1>👥 Contact us | Support</h1>
+ <p>
+<a href="https://discord.gg/3JzDV9T5Fn"><img src="https://invidget.switchblade.xyz/3JzDV9T5Fn" /></a>
 </p>

package/index.d.ts

@@ -3,6 +3,7 @@ import { Message, Client } from 'discord.js'
 type HexColorString = `#${string}` | string
 
 export type connectOptions = {
+  auto_purge?: boolean,
   notify?: boolean
 }
 

package/package.json

@@ -1,53 +1,54 @@
-{
-  "name": "simply-xp",
-  "version": "1.3.5-beta-7",
-  "description": "A Simple, Easy and Beginner Friendly XP System",
-  "main": "simplyxp.js",
-  "typings": "index.d.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "beta": "eslint . --fix && npm update && npm publish --tag beta"
-  },
-  "author": "Rahuletto",
-  "keywords": [
-    "xp",
-    "simply",
-    "easy",
-    "xp-system",
-    "system",
-    "mongoose",
-    "discord",
-    "discord xp",
-    "discord-xp",
-    "simply-djs",
-    "discord.js",
-    "simplydjs",
-    "weky",
-    "nuggies",
-    "experience",
-    "level role",
-    "amari",
-    "package",
-    "leaderboard",
-    "mee6",
-    "charts",
-    "ChartJS",
-    "level up"
-  ],
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Rahuletto/simply-xp"
-  },
-  "dependencies": {
-    "@napi-rs/canvas": "^0.1.41",
-    "chart.js": "^3.9.1",
-    "mongoose": "^6.11.2"
-  },
-  "peerDependencies": {
-    "discord.js": ">=13.12.0"
-  },
-  "devDependencies": {
-    "eslint": "^8.43.0"
-  }
-}
+{
+  "name": "simply-xp",
+  "version": "1.3.5",
+  "description": "A Simple, Easy and Beginner Friendly XP System",
+  "main": "simplyxp.js",
+  "typings": "index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "beta": "eslint . --fix && npm update && npm publish --tag beta",
+    "legacy": "eslint . --fix && npm update && npm publish --tag legacy"
+  },
+  "author": "Rahuletto",
+  "keywords": [
+    "xp",
+    "simply",
+    "easy",
+    "xp-system",
+    "system",
+    "mongoose",
+    "discord",
+    "discord xp",
+    "discord-xp",
+    "simply-djs",
+    "discord.js",
+    "simplydjs",
+    "weky",
+    "nuggies",
+    "experience",
+    "level role",
+    "amari",
+    "package",
+    "leaderboard",
+    "mee6",
+    "charts",
+    "ChartJS",
+    "level up"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rahuletto/simply-xp"
+  },
+  "dependencies": {
+    "@napi-rs/canvas": "^0.1.41",
+    "chart.js": "^3.9.1",
+    "mongoose": "^7.4.2"
+  },
+  "peerDependencies": {
+    "discord.js": ">=13.12.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.46.0"
+  }
+}

package/simplyxp.js

@@ -1,31 +1,33 @@
 try {
-	require('discord.js');
+	require("discord.js");
 } catch (e) {
-	console.warn('[XP] Discord.js is recommended for this package.');
+	console.warn("[XP] Discord.js is recommended for this package.");
 }
 
-module.exports.roleSetup = require('./src/roleSetup');
+module.exports.roleSetup = require("./src/roleSetup");
 
-module.exports.addLevel = require('./src/addLevel');
+module.exports.addLevel = require("./src/addLevel");
 
-module.exports.addXP = require('./src/addXP');
+module.exports.addXP = require("./src/addXP");
 
-module.exports.charts = require('./src/charts');
+module.exports.charts = require("./src/charts");
 
-module.exports.connect = require('./src/connect');
+module.exports.connect = require("./src/connect");
 
-module.exports.create = require('./src/create');
+module.exports.create = require("./src/create");
 
-module.exports.fetch = require('./src/fetch');
+module.exports.fetch = require("./src/fetch");
 
-module.exports.leaderboard = require('./src/leaderboard');
+module.exports.leaderboard = require("./src/leaderboard");
 
-module.exports.lvlRole = require('./src/lvlRole');
+module.exports.lvlRole = require("./src/lvlRole");
 
-module.exports.rank = require('./src/rank');
+module.exports.rank = require("./src/rank");
 
-module.exports.setLevel = require('./src/setLevel');
+module.exports.setLevel = require("./src/setLevel");
 
-module.exports.setXP = require('./src/setXP');
+module.exports.setXP = require("./src/setXP");
 
-module.exports.reset = require('./src/reset');
+module.exports.reset = require("./src/reset");
+
+module.exports.options = {auto_purge: false};

package/src/addLevel.js

@@ -1,5 +1,5 @@
-const levels = require('../src/models/level.js');
-let {roleSetup} = require('../simplyxp');
+const levels = require("../src/models/level.js");
+let {roleSetup} = require("../simplyxp");
 
 /**
  * @param {Discord.Message} message
@@ -8,11 +8,11 @@ let {roleSetup} = require('../simplyxp');
  * @param {number} level
  */
 async function addLevel(message, userID, guildID, level) {
-	if (!userID) throw new Error('[XP] User ID was not provided.');
+	if (!userID) throw new Error("[XP] User ID was not provided.");
 
-	if (!guildID) throw new Error('[XP] Guild ID was not provided.');
+	if (!guildID) throw new Error("[XP] Guild ID was not provided.");
 
-	if (!level) throw new Error('[XP] Level amount is not provided.');
+	if (!level) throw new Error("[XP] Level amount is not provided.");
 
 	let {client} = message;
 
@@ -26,7 +26,7 @@ async function addLevel(message, userID, guildID, level) {
 			level: 0
 		});
 
-		await newUser.save().catch(() => console.log('[XP] Failed to save new user to database'));
+		await newUser.save().catch(() => console.log("[XP] Failed to save new user to database"));
 
 		let xp = (level * 10) ** 2;
 
@@ -54,7 +54,7 @@ async function addLevel(message, userID, guildID, level) {
 
 		let role = await roleSetup.find(client, guildID, level);
 
-		client.emit('levelUp', message, data, role);
+		client.emit("levelUp", message, data, role);
 	}
 
 	return {

package/src/addXP.js

@@ -1,5 +1,5 @@
-const levels = require('../src/models/level.js');
-let {roleSetup} = require('../simplyxp');
+const levels = require("../src/models/level.js");
+let {roleSetup} = require("../simplyxp");
 
 /**
  * @param {Discord.Message} message
@@ -9,11 +9,11 @@ let {roleSetup} = require('../simplyxp');
  */
 
 async function addXP(message, userID, guildID, xp) {
-	if (!userID) throw new Error('[XP] User ID was not provided.');
+	if (!userID) throw new Error("[XP] User ID was not provided.");
 
-	if (!guildID) throw new Error('[XP] Guild ID was not provided.');
+	if (!guildID) throw new Error("[XP] Guild ID was not provided.");
 
-	if (!xp) throw new Error('[XP] XP amount is not provided.');
+	if (!xp) throw new Error("[XP] XP amount is not provided.");
 
 	let {client} = message;
 
@@ -22,25 +22,25 @@ async function addXP(message, userID, guildID, xp) {
 	if (xp.min) {
 		if (!xp.max)
 			throw new Error(
-				'[XP] XP min amount is provided but max amount is not provided.'
+				"[XP] XP min amount is provided but max amount is not provided."
 			);
 
 		min = Number(xp.min);
 
-		if (Number(xp.min).toString() === 'NaN')
-			throw new Error('[XP] XP amount (min) is not a number.');
+		if (Number(xp.min).toString() === "NaN")
+			throw new Error("[XP] XP amount (min) is not a number.");
 	}
 
 	if (xp.max) {
 		if (!xp.min)
 			throw new Error(
-				'[XP] XP max amount is provided but min amount is not provided.'
+				"[XP] XP max amount is provided but min amount is not provided."
 			);
 
 		max = Number(xp.max);
 
-		if (Number(xp.max).toString() === 'NaN')
-			throw new Error('[XP] XP amount (max) is not a number.');
+		if (Number(xp.max).toString() === "NaN")
+			throw new Error("[XP] XP amount (max) is not a number.");
 	}
 
 	if (xp.min && xp.max) {
@@ -60,7 +60,7 @@ async function addXP(message, userID, guildID, xp) {
 			level: lvl
 		});
 
-		await newUser.save().catch(() => console.log('[XP] Failed to save new user to database'));
+		await newUser.save().catch(() => console.log("[XP] Failed to save new user to database"));
 
 		return {
 			level: 0,
@@ -92,7 +92,7 @@ async function addXP(message, userID, guildID, xp) {
 
 		let role = await roleSetup.find(client, guildID, level);
 
-		client.emit('levelUp', message, data, role);
+		client.emit("levelUp", message, data, role);
 	}
 
 	return {

package/src/charts.js

@@ -1,18 +1,18 @@
-let leaderboard = require('./leaderboard');
+let leaderboard = require("./leaderboard");
 
 /**
  * @param {Discord.Message} message
- * @param {import('../index').chartsOptions} options
+ * @param {import("../index").chartsOptions} options
  */
 
 async function charts(message, options) {
 	try {
-		require('canvas');
+		require("canvas");
 	} catch {
-		throw '[XP] This requires canvas to be installed. \n"npm install canvas"';
+		throw "[XP] This requires canvas to be installed. \n\"npm install canvas\"";
 	}
-	const ChartJS = require('chart.js');
-	const Canvas = require('canvas');
+	const ChartJS = require("chart.js");
+	const Canvas = require("canvas");
 	let {client} = message;
 
 	let data = [];
@@ -30,30 +30,30 @@ async function charts(message, options) {
 	});
 
 	new ChartJS(ctx, {
-		type: options.type || 'bar',
+		type: options.type || "bar",
 		data: {
 			labels: uzern,
 			datasets: [
 				{
-					label: 'Leaderboards',
+					label: "Leaderboards",
 					data: data,
 					backgroundColor: [
-						'rgba(255, 99, 132, 0.5)',
-						'rgba(255, 159, 64, 0.5)',
-						'rgba(255, 205, 86, 0.5)',
-						'rgba(75, 192, 192, 0.5)',
-						'rgba(54, 162, 235, 0.5)',
-						'rgba(153, 102, 255, 0.5)',
-						'rgb(201, 203, 207, 0.5)'
+						"rgba(255, 99, 132, 0.5)",
+						"rgba(255, 159, 64, 0.5)",
+						"rgba(255, 205, 86, 0.5)",
+						"rgba(75, 192, 192, 0.5)",
+						"rgba(54, 162, 235, 0.5)",
+						"rgba(153, 102, 255, 0.5)",
+						"rgb(201, 203, 207, 0.5)"
 					],
 					borderColor: [
-						'rgb(255, 99, 132)',
-						'rgb(255, 159, 64)',
-						'rgb(255, 205, 86)',
-						'rgb(75, 192, 192)',
-						'rgb(54, 162, 235)',
-						'rgb(153, 102, 255)',
-						'rgb(201, 203, 207)'
+						"rgb(255, 99, 132)",
+						"rgb(255, 159, 64)",
+						"rgb(255, 205, 86)",
+						"rgb(75, 192, 192)",
+						"rgb(54, 162, 235)",
+						"rgb(153, 102, 255)",
+						"rgb(201, 203, 207)"
 					],
 					borderWidth: 2
 				}
@@ -64,18 +64,18 @@ async function charts(message, options) {
 			plugins: {
 				title: {
 					display: true,
-					text: 'XP Datasheet'
+					text: "XP Datasheet"
 				}
 			}
 		},
 		plugins: [
 			{
-				id: 'simply-xp',
+				id: "simply-xp",
 				beforeDraw: (chart) => {
-					const ctx = chart.canvas.getContext('2d');
+					const ctx = chart.canvas.getContext("2d");
 					ctx.save();
-					ctx.globalCompositeOperation = 'destination-over';
-					ctx.fillStyle = options.background || '#2F3136';
+					ctx.globalCompositeOperation = "destination-over";
+					ctx.fillStyle = options.background || "#2F3136";
 					ctx.fillRect(0, 0, chart.width, chart.height);
 					ctx.restore();
 				}
@@ -84,8 +84,8 @@ async function charts(message, options) {
 	}).update();
 
 	return {
-		attachment: ctx.toBuffer('image/png'),
-		name: 'chart.png'
+		attachment: ctx.toBuffer("image/png"),
+		name: "chart.png"
 	};
 }
 

package/src/connect.js

@@ -1,22 +1,21 @@
-const mongoose = require('mongoose');
+const mongoose = require("mongoose");
 
 /**
  * @param {string} db
- * @param {import('../index').connectOptions} options
+ * @param {import("../index").connectOptions} options
  */
 
 async function connect(db, options = []) {
-	if (!db) throw new Error('[XP] Database URL was not provided');
-	mongoose.set('strictQuery', true);
-  
+	if (!db) throw new Error("[XP] Database URL was not provided");
+	mongoose.set("strictQuery", true);
+
 	mongoose.connect(db, {
 		useNewUrlParser: true,
 		useUnifiedTopology: true
 	});
 
 
-	if (options.notify === false) return;
-	else return console.log('{ XP } Database Connected');
+	if (options.notify) return console.log("{ XP } Database Connected");
 }
 
 module.exports = connect;

package/src/create.js

@@ -1,4 +1,4 @@
-const levels = require('../src/models/level.js');
+const levels = require("../src/models/level.js");
 
 /**
  * @param {string} userID
@@ -6,11 +6,11 @@ const levels = require('../src/models/level.js');
  */
 
 async function create(userID, guildID) {
-	if (!userID) throw new Error('[XP] User ID was not provided.');
+	if (!userID) throw new Error("[XP] User ID was not provided.");
 
-	if (!guildID) throw new Error('[XP] User ID was not provided.');
+	if (!guildID) throw new Error("[XP] User ID was not provided.");
 
-	let uzer = await levels.findOne({ user: userID, guild: guildID });
+	let uzer = await levels.findOne({user: userID, guild: guildID});
 
 	if (uzer) return;
 
@@ -20,7 +20,7 @@ async function create(userID, guildID) {
 	});
 	await newuser
 		.save()
-		.catch(() => console.log('[XP] Failed to save new use to database'));
+		.catch(() => console.log("[XP] Failed to save new use to database"));
 
 	return true;
 }

package/src/fetch.js

@@ -1,4 +1,4 @@
-const levels = require('../src/models/level.js');
+const levels = require("../src/models/level.js");
 
 /**
  * @param {string} userID
@@ -6,9 +6,9 @@ const levels = require('../src/models/level.js');
  */
 
 async function fetch(userID, guildID) {
-	if (!userID) throw new Error('[XP] User ID was not provided.');
+	if (!userID) throw new Error("[XP] User ID was not provided.");
 
-	if (!guildID) throw new Error('[XP] Guild ID was not provided.');
+	if (!guildID) throw new Error("[XP] Guild ID was not provided.");
 
 	let user = await levels.findOne({
 		user: userID,
@@ -29,7 +29,7 @@ async function fetch(userID, guildID) {
 		.find({
 			guild: guildID
 		})
-		.sort([['xp', 'descending']])
+		.sort([["xp", "descending"]])
 		.exec();
 
 	if (user === null)
@@ -49,7 +49,7 @@ async function fetch(userID, guildID) {
 	let target = targetxp * targetxp * 100;
 
 	function shortener(count) {
-		const COUNT_ABBRS = ['', 'k', 'M', 'T'];
+		const COUNT_ABBRS = ["", "k", "M", "T"];
 
 		const i = 0 === count ? count : Math.floor(Math.log(count) / Math.log(1000));
 		let result = parseFloat((count / Math.pow(1000, i)).toFixed(2));

package/src/leaderboard.js

@@ -1,4 +1,5 @@
-const levels = require('../src/models/level.js');
+const levels = require("../src/models/level.js");
+const {options} = require("../simplyxp");
 
 /**
  * @param {Discord.Client} client
@@ -7,17 +8,17 @@ const levels = require('../src/models/level.js');
  */
 
 async function leaderboard(client, guildID, limit) {
-	if (!guildID) throw new Error('[XP] Guild ID was not provided.');
+	if (!guildID) throw new Error("[XP] Guild ID was not provided.");
 
 	let g = client.guilds.cache.get(guildID);
-	if (!g) throw new Error('[XP] Guild was not found.');
+	if (!g) throw new Error("[XP] Guild was not found.");
 
-	let leaderboard = await levels.find({guild: guildID}).sort([['xp', 'descending']]);
+	let leaderboard = await levels.find({guild: guildID}).sort([["xp", "descending"]]);
 
 	let led = [];
 
 	function shortener(count) {
-		const COUNT_ABBRS = ['', 'k', 'M', 'T'];
+		const COUNT_ABBRS = ["", "k", "M", "T"];
 
 		const i = 0 === count ? count : Math.floor(Math.log(count) / Math.log(1000));
 		let result = parseFloat((count / Math.pow(1000, i)).toFixed(2));
@@ -27,13 +28,11 @@ async function leaderboard(client, guildID, limit) {
 
 	const led2 = leaderboard.map(async (key) => {
 		const user = await g.members.fetch(key.user).catch(() => null);
-		if (!user) return levels.deleteOne({user: key.user, guild: guildID});
+		if (!user && options.auto_purge) return levels.deleteOne({user: key.user, guild: guildID});
 		if (key.xp === 0) return;
-		let pos = leaderboard.indexOf(key) + 1;
 
-		if (limit) {
-			if (pos > Number(limit)) return;
-		}
+		let pos = leaderboard.indexOf(key) + 1;
+		if (limit && pos > Number(limit)) return;
 
 		led.push({
 			guildID: key.guild,