simply-xp 1.3.7 → 1.3.8

package/README.md

@@ -2,19 +2,21 @@
 
 <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>
+<p align="center">
+  A simple, beginner-friendly XP system for Discord.js.<br>
+  Developed by <strong>Rahuletto</strong> & Maintained by <strong>Abadima</strong>
+</p>
 
 <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>
+  <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://discord.gg/3JzDV9T5Fn"><img src="https://invidget.switchblade.xyz/3JzDV9T5Fn" /></a>
 </p>
 
 <br>
 
-## 🖥️ <b>How to install ?
+## 🖥️ <b>How to install?
 
 ```
 npm install simply-xp
@@ -28,23 +30,21 @@ yarn add simply-xp
 
 <br>
 
-# 🎉 Recent Updates 🎉
+# 🎉 Recent Updates
 
 - Fixed Various Bugs
 - Updated `Chart.js`
 - D.JS v14 Support
 - Patched v1.3.5 Bugs
 
+# ⭐ Features
 
-# But Why ?
-
-- Easiest XP System in Discord.js
-- Fastest Support ever
-- Rank Card Maker
+- Easy XP System
+- Automatic Role Assignment
+- Beautiful Rank Cards
+- Optimized for Performance
+- Lightweight & Flexible
 - Beginner Friendly
-- Easier than other XP Systems
-- Inbuilt Auto Roles system
-- Flexible and simple at the same time
 
 <br>
 
@@ -52,7 +52,7 @@ yarn add simply-xp
 
 <br>
    
- <h1>👥 Contact us | Support</h1>
+ <h1>👥 Contact & Support</h1>
  <p>
 <a href="https://discord.gg/3JzDV9T5Fn"><img src="https://invidget.switchblade.xyz/3JzDV9T5Fn" /></a>
-</p>
+</p>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simply-xp",
-  "version": "1.3.7",
+  "version": "1.3.8",
   "description": "A Simple, Easy and Beginner Friendly XP System",
   "main": "simplyxp.js",
   "typings": "index.d.ts",
@@ -9,47 +9,72 @@
     "beta": "eslint . --fix && pnpm update && npm publish --tag beta",
     "legacy": "eslint . --fix && pnpm update && npm publish --tag legacy"
   },
-  "author": "Rahuletto",
+  "author": {
+    "name": "Abadima",
+    "url": "https://abadima.dev"
+  },
+  "maintainers": [
+    {
+      "name": "Abadima",
+      "url": "https://abadima.dev"
+    }
+  ],
+  "contributors": [
+    {
+      "name": "Rahuletto",
+      "role": "Original Author",
+      "url": "https://marban.is-a.dev/"
+    }
+  ],
+  "license": "Apache-2.0",
   "keywords": [
     "xp",
-    "simply",
-    "easy",
-    "xp-system",
-    "system",
-    "mongoose",
+    "experience",
+    "level",
+    "leveling",
+    "leveling system",
     "discord",
-    "discord xp",
-    "discord-xp",
-    "simply-djs",
+    "discord bot",
     "discord.js",
-    "simplydjs",
-    "weky",
-    "nuggies",
-    "experience",
-    "level role",
-    "amari",
-    "package",
+    "discord-xp",
     "leaderboard",
-    "mee6",
+    "rank",
+    "rank card",
+    "leaderboard card",
+    "gamification",
+    "xp system",
+    "simply",
+    "simplydjs",
     "charts",
-    "ChartJS",
-    "level up"
+    "@napi-rs/canvas",
+    "chart.js",
+    "mongoose",
+    "mongodb",
+    "sqlite",
+    "nodejs",
+    "bot",
+    "mee6",
+    "amari",
+    "weky"
   ],
-  "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Abadima/simply-xp.git"
   },
   "homepage": "https://simplyxp.js.org",
+  "bugs": {
+    "url": "https://github.com/Abadima/simply-xp/issues"
+  },
+  "readme": "README.md",
   "dependencies": {
-    "@napi-rs/canvas": "^0.1.43",
+    "@napi-rs/canvas": "0.1.88",
     "chart.js": "^3.9.1",
-    "mongoose": "^7.4.2"
+    "mongoose": "^7.8.8"
   },
   "peerDependencies": {
     "discord.js": ">=13.12.0"
   },
   "devDependencies": {
-    "eslint": "^8.47.0"
+    "eslint": "^9.39.2"
   }
-}
+}

package/simplyxp.js

@@ -4,7 +4,7 @@ try {
 	console.warn("[XP] Discord.js is recommended for this package.");
 }
 
-module.exports.options = {auto_purge: false};
+module.exports.options = { auto_purge: false };
 
 module.exports.roleSetup = require("./src/roleSetup");
 

package/src/addLevel.js

@@ -1,5 +1,5 @@
 const levels = require("../src/models/level.js");
-let {roleSetup} = require("../simplyxp");
+let { roleSetup } = require("../simplyxp");
 
 /**
  * @param {Discord.Message} message
@@ -14,9 +14,9 @@ async function addLevel(message, userID, guildID, level) {
 
 	if (!level) throw new Error("[XP] Level amount is not provided.");
 
-	let {client} = message;
+	let { client } = message;
 
-	const user = await levels.findOne({user: userID, guild: guildID});
+	const user = await levels.findOne({ user: userID, guild: guildID });
 
 	if (!user) {
 		const newUser = new levels({

package/src/addXP.js

@@ -1,5 +1,5 @@
 const levels = require("../src/models/level.js");
-let {roleSetup} = require("../simplyxp");
+let { roleSetup } = require("../simplyxp");
 
 /**
  * @param {Discord.Message} message
@@ -15,7 +15,7 @@ async function addXP(message, userID, guildID, xp) {
 
 	if (!xp) throw new Error("[XP] XP amount is not provided.");
 
-	let {client} = message;
+	let { client } = message;
 
 	let min;
 	let max;
@@ -47,7 +47,7 @@ async function addXP(message, userID, guildID, xp) {
 		xp = Math.floor(Math.random() * (max - min) + min);
 	}
 
-	const user = await levels.findOne({user: userID, guild: guildID});
+	const user = await levels.findOne({ user: userID, guild: guildID });
 
 	let lvl = Math.floor(0.1 * Math.sqrt(xp));
 

package/src/charts.js

@@ -6,14 +6,9 @@ let leaderboard = require("./leaderboard");
  */
 
 async function charts(message, options) {
-	try {
-		require("canvas");
-	} catch {
-		throw "[XP] This requires canvas to be installed. \n\"npm install canvas\"";
-	}
 	const ChartJS = require("chart.js");
-	const Canvas = require("canvas");
-	let {client} = message;
+	const Canvas = require("@napi-rs/canvas");
+	let { client } = message;
 
 	let data = [];
 	let pos = options?.position || 5;

package/src/create.js

@@ -10,7 +10,7 @@ async function create(userID, guildID) {
 
 	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;
 

package/src/fetch.js

@@ -1,4 +1,5 @@
 const levels = require("../src/models/level.js");
+const getUserPosition = require("./utils/getUserPosition");
 
 /**
  * @param {string} userID
@@ -25,24 +26,7 @@ async function fetch(userID, guildID) {
 		await user.save();
 	}
 
-	const leaderboard = await levels
-		.find({
-			guild: guildID
-		})
-		.sort([["xp", "descending"]])
-		.exec();
-
-	if (user === null)
-		return {
-			level: 0,
-			xp: 0,
-			reqxp: 100,
-			rank: leaderboard.findIndex((i) => i.user === userID) + 1,
-			shortxp: 0,
-			shortreq: 100
-		};
-
-	user.position = leaderboard.findIndex((i) => i.user === userID) + 1;
+	user.position = (await getUserPosition(userID, guildID)) || 1;
 
 	let targetxp = user.level + 1;
 

package/src/leaderboard.js

@@ -1,5 +1,5 @@
 const levels = require("../src/models/level.js");
-const {options} = require("../simplyxp");
+const { options } = require("../simplyxp");
 
 /**
  * @param {Discord.Client} client
@@ -13,9 +13,14 @@ async function leaderboard(client, guildID, limit) {
 	let g = client.guilds.cache.get(guildID);
 	if (!g) throw new Error("[XP] Guild was not found.");
 
-	let leaderboard = await levels.find({guild: guildID}).sort([["xp", "descending"]]);
+	const leaderboard = await levels
+		.find({ guild: guildID })
+		.sort([["xp", "descending"]]);
 
-	let led = [], subtractPos = 0;
+	const led = [];
+	let subtractPos = 0;
+	const shouldPurge = Boolean(options?.auto_purge);
+	const limitNumber = limit ? Number(limit) : null;
 
 	function shortener(count) {
 		const COUNT_ABBRS = ["", "k", "M", "T"];
@@ -26,13 +31,22 @@ async function leaderboard(client, guildID, limit) {
 		return result;
 	}
 
-	const led2 = leaderboard.map(async (key) => {
+	for (let i = 0; i < leaderboard.length; i += 1) {
+		const key = leaderboard[i];
 		const user = await g.members.fetch(key.user).catch(() => null);
-		if (!user && options?.auto_purge) return levels.deleteOne({user: key.user, guild: guildID});
-		if (key.xp === 0 || !user) return subtractPos++;
+		if (!user && shouldPurge) {
+			await levels.deleteOne({ user: key.user, guild: guildID });
+		}
+		if (key.xp === 0 || !user) {
+			subtractPos += 1;
+			continue;
+		}
 
-		let pos = leaderboard.indexOf(key) + 1 - subtractPos;
-		if (limit && pos > Number(limit)) return;
+		const pos = i + 1 - subtractPos;
+		if (limitNumber && pos > limitNumber) {
+			if (!shouldPurge) break;
+			continue;
+		}
 
 		led.push({
 			guildID: key.guild,
@@ -44,8 +58,9 @@ async function leaderboard(client, guildID, limit) {
 			username: user.user.username,
 			tag: user.user.tag
 		});
-	});
-	return Promise.all(led2).then(() => led);
+	}
+
+	return led;
 }
 
 module.exports = leaderboard;

package/src/models/level.js

@@ -1,10 +1,12 @@
 const mongoose = require("mongoose");
 
 const Levelz = new mongoose.Schema({
-	user: {type: String, unique: true},
-	guild: {type: String},
-	xp: {type: Number, default: 0},
-	level: {type: Number, default: 0}
+	user: { type: String, unique: true },
+	guild: { type: String },
+	xp: { type: Number, default: 0 },
+	level: { type: Number, default: 0 }
 });
 
+Levelz.index({ guild: 1, xp: -1 });
+
 module.exports = mongoose.model("Simply-XP", Levelz);

package/src/models/lvlrole.js

@@ -1,8 +1,8 @@
 const mongoose = require("mongoose");
 
 const rol = new mongoose.Schema({
-	gid: {type: String},
-	lvlrole: {type: Array}
+	gid: { type: String },
+	lvlrole: { type: Array }
 });
 
 module.exports = mongoose.model("Simply-XP-LevelRole", rol);

package/src/rank.js

@@ -1,5 +1,6 @@
 const levels = require("../src/models/level.js");
-const {join} = require("path");
+const { join } = require("path");
+const getUserPosition = require("./utils/getUserPosition");
 
 /**
  * @param {Discord.Message} message
@@ -19,14 +20,7 @@ async function rank(message, userID, guildID, options = []) {
 	});
 	if (!user) throw new Error("[XP] NO_DATA | User has no XP data.");
 
-	const leaderboard = await levels
-		.find({
-			guild: guildID
-		})
-		.sort([["xp", "descending"]])
-		.exec();
-
-	user.position = leaderboard.findIndex((i) => i.user === userID) + 1;
+	user.position = (await getUserPosition(userID, guildID)) || 1;
 
 	let targetxp = user.level + 1;
 
@@ -48,7 +42,7 @@ async function rank(message, userID, guildID, options = []) {
 		try {
 			const Canvas = require("@napi-rs/canvas");
 			Canvas.GlobalFonts.registerFromPath(
-				join(__dirname, "Fonts", "Baloo-Regular.ttf"),
+				join(__dirname, "Fonts", "Baloo2-Regular.woff2"),
 				"Sans Serif"
 			);
 
@@ -114,7 +108,12 @@ async function rank(message, userID, guildID, options = []) {
 			ctx.fillRect(0, 0, 1080, 400);
 			let background = await Canvas.loadImage(BackGroundImg);
 			ctx.globalAlpha = 0.7;
-			ctx.drawImage(background, 0, 0, 1080, 400);
+			const canvasWidth = canvas.width;
+			const canvasHeight = canvas.height;
+			const scale = canvasWidth / background.width;
+			const scaledHeight = background.height * scale;
+			const yOffset = (canvasHeight - scaledHeight) / 2;
+			ctx.drawImage(background, 0, yOffset, canvasWidth, scaledHeight);
 			ctx.restore();
 
 			ctx.fillStyle = DrawLayerColor;

package/src/reset.js

@@ -11,12 +11,12 @@ async function reset(userID, guildID) {
 	if (!guildID) throw new Error("[XP] User ID was not provided.");
 
 	await levels
-		.findOneAndUpdate({user: userID, guild: guildID}, {xp: 0, level: 0})
+		.findOneAndUpdate({ user: userID, guild: guildID }, { xp: 0, level: 0 })
 		.catch((err) => {
 			throw new Error(err);
 		});
 
-	return {user: userID, guild: guildID, xp: 0, level: 0};
+	return { user: userID, guild: guildID, xp: 0, level: 0 };
 }
 
 module.exports = reset;

package/src/roleSetup.js

@@ -36,7 +36,7 @@ class roleSetup {
 					await newrol.save();
 				}
 
-				newrol.lvlrole.push({lvl: options.level, role: options.role});
+				newrol.lvlrole.push({ lvl: options.level, role: options.role });
 
 				await newrol
 					.save()
@@ -75,7 +75,7 @@ class roleSetup {
 					gid: guildID
 				},
 				{
-					$pull: {lvlrole: {lvl: options.level}}
+					$pull: { lvlrole: { lvl: options.level } }
 				}
 			);
 

package/src/setLevel.js

@@ -1,5 +1,5 @@
 const levels = require("../src/models/level.js");
-const {roleSetup} = require("../simplyxp");
+const { roleSetup } = require("../simplyxp");
 
 /**
  * @param {Discord.Message} message
@@ -12,12 +12,12 @@ async function setLevel(message, userID, guildID, level) {
 	if (!guildID) throw new Error("[XP] Guild ID was not provided.");
 	if (!level || isNaN(Number(level))) throw new Error("[XP] Invalid level amount.");
 
-	const {client} = message;
+	const { client } = message;
 
 	const user = await levels.findOneAndUpdate(
-		{user: userID, guild: guildID},
-		{xp: (level * 10) ** 2, level: Math.floor(0.1 * Math.sqrt((level * 10) ** 2))},
-		{upsert: true, new: true}
+		{ user: userID, guild: guildID },
+		{ xp: (level * 10) ** 2, level: Math.floor(0.1 * Math.sqrt((level * 10) ** 2)) },
+		{ upsert: true, new: true }
 	);
 
 	if (user.level !== level) {

package/src/setXP.js

@@ -6,9 +6,9 @@ async function setXP(userID, guildID, xp) {
 	if (!xp || isNaN(Number(xp))) throw new Error("[XP] Invalid XP amount.");
 
 	const user = await levels.findOneAndUpdate(
-		{user: userID, guild: guildID},
-		{xp: xp},
-		{upsert: true}
+		{ user: userID, guild: guildID },
+		{ xp: xp },
+		{ upsert: true }
 	);
 
 	const lvl = Math.floor(0.1 * Math.sqrt(xp));
@@ -17,7 +17,7 @@ async function setXP(userID, guildID, xp) {
 		await user.save().catch((e) => console.log(`[XP] Failed to set XP | User: ${userID} | Err: ${e}`));
 	}
 
-	return {xp};
+	return { xp };
 }
 
 module.exports = setXP;

package/src/utils/getUserPosition.js

@@ -0,0 +1,22 @@
+const levels = require("../models/level.js");
+
+async function getUserPosition(userID, guildID) {
+	const cursor = levels.find({ guild: guildID }).sort({ xp: -1 }).cursor();
+	let position = 0;
+
+	try {
+		for await (const entry of cursor) {
+			position += 1;
+			if (entry.user === userID) {
+				return position;
+			}
+		}
+		return null;
+	} finally {
+		if (typeof cursor.close === "function") {
+			await cursor.close();
+		}
+	}
+}
+
+module.exports = getUserPosition;