simply-xp 1.3.5-beta-6 → 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,50 +1,54 @@
-{
-  "name": "simply-xp",
-  "version": "1.3.5-beta-6",
-  "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": "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.33",
-    "chart.js": "^3.9.1",
-    "mongoose": "^6.8.3"
-  },
-  "peerDependencies": {
-    "discord.js": ">=13.12.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')
-} catch (e) {
-  console.warn('[XP] Discord.js is recommended for this package.')
-}
-
-module.exports.roleSetup = require('./src/roleSetup')
-
-module.exports.addLevel = require('./src/addLevel')
-
-module.exports.addXP = require('./src/addXP')
-
-module.exports.charts = require('./src/charts')
-
-module.exports.connect = require('./src/connect')
-
-module.exports.create = require('./src/create')
-
-module.exports.fetch = require('./src/fetch')
-
-module.exports.leaderboard = require('./src/leaderboard')
-
-module.exports.lvlRole = require('./src/lvlRole')
-
-module.exports.rank = require('./src/rank')
-
-module.exports.setLevel = require('./src/setLevel')
-
-module.exports.setXP = require('./src/setXP')
-
-module.exports.reset = require('./src/reset')
+try {
+	require("discord.js");
+} catch (e) {
+	console.warn("[XP] Discord.js is recommended for this package.");
+}
+
+module.exports.roleSetup = require("./src/roleSetup");
+
+module.exports.addLevel = require("./src/addLevel");
+
+module.exports.addXP = require("./src/addXP");
+
+module.exports.charts = require("./src/charts");
+
+module.exports.connect = require("./src/connect");
+
+module.exports.create = require("./src/create");
+
+module.exports.fetch = require("./src/fetch");
+
+module.exports.leaderboard = require("./src/leaderboard");
+
+module.exports.lvlRole = require("./src/lvlRole");
+
+module.exports.rank = require("./src/rank");
+
+module.exports.setLevel = require("./src/setLevel");
+
+module.exports.setXP = require("./src/setXP");
+
+module.exports.reset = require("./src/reset");
+
+module.exports.options = {auto_purge: false};

package/src/addLevel.js

@@ -1,66 +1,66 @@
-const levels = require('../src/models/level.js')
-let {roleSetup} = require('../simplyxp')
-
-/**
- * @param {Discord.Message} message
- * @param {string} userID
- * @param {string} guildID
- * @param {number} level
- */
-async function addLevel(message, userID, guildID, level) {
-    if (!userID) throw new Error('[XP] User 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.')
-
-    let {client} = message
-
-    const user = await levels.findOne({user: userID, guild: guildID})
-
-    if (!user) {
-        const newUser = new levels({
-            user: userID,
-            guild: guildID,
-            xp: 0,
-            level: 0
-        })
-
-        await newUser.save().catch(() => console.log(`[XP] Failed to save new user to database`))
-
-        let xp = (level * 10) ** 2
-
-        return {
-            level: level,
-            exp: xp
-        }
-    }
-    let level1 = user.level
-
-    user.level += parseFloat(level)
-    user.xp = (user.level * 10) ** 2
-
-    await user.save().catch((e) =>
-        console.log(`[XP] Failed to add Level | User: ${userID} | Err: ${e}`)
-    )
-
-    if (level1 !== level) {
-        let data = {
-            xp: user.xp,
-            level: user.level,
-            userID,
-            guildID
-        }
-
-        let role = await roleSetup.find(client, guildID, level)
-
-        client.emit('levelUp', message, data, role)
-    }
-
-    return {
-        level: user.level,
-        xp: user.xp
-    }
-}
-
-module.exports = addLevel
+const levels = require("../src/models/level.js");
+let {roleSetup} = require("../simplyxp");
+
+/**
+ * @param {Discord.Message} message
+ * @param {string} userID
+ * @param {string} guildID
+ * @param {number} level
+ */
+async function addLevel(message, userID, guildID, level) {
+	if (!userID) throw new Error("[XP] User 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.");
+
+	let {client} = message;
+
+	const user = await levels.findOne({user: userID, guild: guildID});
+
+	if (!user) {
+		const newUser = new levels({
+			user: userID,
+			guild: guildID,
+			xp: 0,
+			level: 0
+		});
+
+		await newUser.save().catch(() => console.log("[XP] Failed to save new user to database"));
+
+		let xp = (level * 10) ** 2;
+
+		return {
+			level: level,
+			exp: xp
+		};
+	}
+	let level1 = user.level;
+
+	user.level += parseFloat(level);
+	user.xp = (user.level * 10) ** 2;
+
+	await user.save().catch((e) =>
+		console.log(`[XP] Failed to add Level | User: ${userID} | Err: ${e}`)
+	);
+
+	if (level1 !== level) {
+		let data = {
+			xp: user.xp,
+			level: user.level,
+			userID,
+			guildID
+		};
+
+		let role = await roleSetup.find(client, guildID, level);
+
+		client.emit("levelUp", message, data, role);
+	}
+
+	return {
+		level: user.level,
+		xp: user.xp
+	};
+}
+
+module.exports = addLevel;

package/src/addXP.js

@@ -1,103 +1,104 @@
-const levels = require('../src/models/level.js')
-let {roleSetup} = require('../simplyxp')
-
-/**
- * @param {Discord.Message} message
- * @param {string} userID
- * @param {string} guildID
- * @param {number} xp
- */
-
-async function addXP(message, userID, guildID, xp) {
-    if (!userID) throw new Error('[XP] User 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.')
-
-    let {client} = message
-
-    let min
-    let max
-    if (xp.min) {
-        if (!xp.max)
-            throw new Error(
-                '[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 (xp.max) {
-        if (!xp.min)
-            throw new Error(
-                '[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 (xp.min && xp.max) {
-        xp = Math.floor(Math.random() * (max - min) + min)
-    }
-
-    const user = await levels.findOne({user: userID, guild: guildID})
-
-    let lvl = Math.floor(0.1 * Math.sqrt(xp))
-
-    if (!user) {
-        const newUser = new levels({
-            user: userID,
-            guild: guildID,
-            xp: xp,
-            level: lvl
-        })
-
-        await newUser.save().catch(() => console.log(`[XP] Failed to save new user to database`))
-
-        return {
-            level: 0,
-            exp: 0
-        }
-    }
-    let level1 = user.level
-
-    user.xp += parseInt(xp, 10)
-    user.level = Math.floor(0.1 * Math.sqrt(user.xp))
-
-    await user.save().catch((e) => console.log(`[XP] Failed to add XP | User: ${userID} | Err: ${e}`))
-
-    let level = user.level
-
-    xp = user.xp
-
-    if (user.xp === 0 || Math.sign(user.xp) === -1) {
-        xp = 0
-    }
-
-    if (level1 !== level) {
-        let data = {
-            xp,
-            level,
-            userID,
-            guildID
-        }
-
-        let role = await roleSetup.find(client, guildID, level)
-
-        client.emit('levelUp', message, data, role)
-    }
-
-    return {
-        level,
-        xp
-    }
-}
-
-module.exports = addXP
+const levels = require("../src/models/level.js");
+let {roleSetup} = require("../simplyxp");
+
+/**
+ * @param {Discord.Message} message
+ * @param {string} userID
+ * @param {string} guildID
+ * @param {number} xp
+ */
+
+async function addXP(message, userID, guildID, xp) {
+	if (!userID) throw new Error("[XP] User 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.");
+
+	let {client} = message;
+
+	let min;
+	let max;
+	if (xp.min) {
+		if (!xp.max)
+			throw new Error(
+				"[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 (xp.max) {
+		if (!xp.min)
+			throw new Error(
+				"[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 (xp.min && xp.max) {
+		xp = Math.floor(Math.random() * (max - min) + min);
+	}
+
+	const user = await levels.findOne({user: userID, guild: guildID});
+
+	let lvl = Math.floor(0.1 * Math.sqrt(xp));
+
+	// TODO: FIX THIS xp = xp & level = lvl
+	if (!user) {
+		const newUser = new levels({
+			user: userID,
+			guild: guildID,
+			xp: xp,
+			level: lvl
+		});
+
+		await newUser.save().catch(() => console.log("[XP] Failed to save new user to database"));
+
+		return {
+			level: 0,
+			exp: 0
+		};
+	}
+	let level1 = user.level;
+
+	user.xp += parseInt(xp, 10);
+	user.level = Math.floor(0.1 * Math.sqrt(user.xp));
+
+	await user.save().catch((e) => console.log(`[XP] Failed to add XP | User: ${userID} | Err: ${e}`));
+
+	let level = user.level;
+
+	xp = user.xp;
+
+	if (user.xp === 0 || Math.sign(user.xp) === -1) {
+		xp = 0;
+	}
+
+	if (level1 !== level) {
+		let data = {
+			xp,
+			level,
+			userID,
+			guildID
+		};
+
+		let role = await roleSetup.find(client, guildID, level);
+
+		client.emit("levelUp", message, data, role);
+	}
+
+	return {
+		level,
+		xp
+	};
+}
+
+module.exports = addXP;