simply-xp 1.3.5-beta-7 → 2.0.0-dev.1

package/FUNDING.yml

@@ -1,3 +1,3 @@
 github: Rahuletto
-patreon: rahuletto
-tidelift: npm/simply-xp
+patreon: abadima
+tidelift: npm/simply-xp

package/README.md

@@ -1,57 +1,69 @@
-<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>
+<div class="Heading" style="text-align: center;">
+  <img src="https://i.ibb.co/cCKJ9FS/simplyxp.png" width="320" height="125" alt="XP Logo">
+
+<h2>We have levelling! - You handle the rest.</h2>
+<h3>Made by Abadima</h3>
+</div>
+
+<br>
+<div class="badges" style="text-align: center;">
+
+[![Downloads](https://img.shields.io/npm/dt/simply-xp?style=for-the-badge)](https://www.npmjs.com/package/simply-xp)
+[![Version](https://img.shields.io/npm/v/simply-xp.svg?style=for-the-badge)](https://www.npmjs.com/package/simply-xp)
+[![CodeFactor](https://www.codefactor.io/repository/github/abadima/simply-xp/badge?style=for-the-badge)](https://www.codefactor.io/repository/github/abadima/simply-xp)
+
+[![Documentation](https://img.shields.io/badge/SimplyXP-Documentation-6b46d4?style=for-the-badge)](https://simplyxp.js.org)
+[![Support](https://img.shields.io/badge/Discord-Support-5865F2?style=for-the-badge&logo=discord)](https://discord.gg/hjhnjYJNHX)
+</div>
+
+---
+> CREDITS TO [RAHULETTO](https://github.com/rahuletto) FOR SIMPLY-XP **VERSION 1**
+---
+
+<br>
+
+## 🖥️ <b>[DEV] Installation</b>
+
+```shell
+npm install simply-xp@dev
+```
+
+```shell
+pnpm install simply-xp@dev
+```
+
+```shell
+yarn add simply-xp@dev
+```
+
+<br>
+
+# ✅ V2 Additions
+
+- Added support for `SQLite` database
+- Added `debug`, `auto_create`, `auto_purge` options for `connect()` function
+- Added `db` class for extended database functionality
+- Added `leaderboardCard()` function
+- Added `coreFunctions()` function
+- Added `migrate` class
+
+# 🎉 V2 Changes 🎉
+
+- Better Documentation
+- Better Log Handling (`XpDebug`, `XpError`, `XpInfo`, `XpWarn`)
+- Better Performance
+- Better Code Quality (EsLint)
+- Complete TypeScript Rewrite
+- Deleted `chart.js` dependency
+- `fetch()` now also returns `position`, and accepts `username` parameter
+- `roleSetup` functions now accept roleID arrays! `["role1", "role2", "role3"]`, and will return `timestamp` as a bonus!
+- `reset()` function now accepts `username` and `erase` as optional arguments
+- `addLevel(), addXP(), setLevel(), setXP()` now has a `username` parameter, to automatically create the user if it doesn't exist. 
+
+# ⚠️ V2 Breaking Changes ⚠️
+
+- `create()` Now requires `username` argument.
+- `charts()` Requires new arguments.
+- `rank()` is **deprecated**, use `rankCard()` instead.
+- `rankCard()` Requires completely new arguments.
+- `roleSetup()` functions loses `client` argument.

package/lib/src/add.d.ts

@@ -0,0 +1,28 @@
+import { UserResult } from "./functions/database";
+/**
+ * Add XP to a user
+ * @async
+ * @param {string} userId
+ * @param {string} guildId
+ * @param {number} level
+ * @param {string} username - Username to use if auto_create is enabled
+ * @link `Documentation:` https://simplyxp.js.org/docs/addlevel
+ * @returns {Promise<UserResult>} - Object of user data on success
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */
+export declare function addLevel(userId: string, guildId: string, level: number, username?: string): Promise<UserResult>;
+/**
+ * Add XP to a user.
+ * @async
+ * @param {string} userId - The ID of the user.
+ * @param {string} guildId - The ID of the guild.
+ * @param {number | {min: number, max: number}} xpData - The XP to add, can be a number or an object with min and max properties.
+ * @param {string} username - Username to use if auto_create is enabled.
+ * @link `Documentation:` https://simplyxp.js.org/docs/addxp
+ * @returns {Promise<UserResult>} - Object of user data on success.
+ * @throws {XpFatal} - If parameters are not provided correctly.
+ */
+export declare function addXP(userId: string, guildId: string, xpData: number | {
+    min: number;
+    max: number;
+}, username?: string): Promise<UserResult>;

package/lib/src/add.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * Add XP to a user
+ * @async
+ * @param {string} userId
+ * @param {string} guildId
+ * @param {number} level
+ * @param {string} username - Username to use if auto_create is enabled
+ * @link `Documentation:` https://simplyxp.js.org/docs/addlevel
+ * @returns {Promise<UserResult>} - Object of user data on success
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */async function addLevel(userId,guildId,level,username){if(!userId)throw new xplogs_1.XpFatal({function:"addLevel()",message:"User ID was not provided"});if(!guildId)throw new xplogs_1.XpFatal({function:"addLevel()",message:"Guild ID was not provided"});if(!level)throw new xplogs_1.XpFatal({function:"addLevel()",message:"Level was not provided"});var e=await database_1.db.findOne({collection:"simply-xps",data:{user:userId,guild:guildId}});if(e)return database_1.db.updateOne({collection:"simply-xps",data:{user:userId,guild:guildId}},{collection:"simply-xps",data:{user:userId,guild:guildId,level:e.level+level,xp:(0,utilities_1.convert)("level",level+e.level)}});if(xp_1.xp.auto_create&&username)return database_1.db.createOne({collection:"simply-xps",data:{guild:guildId,user:userId,name:username,level:level,xp:(0,utilities_1.convert)("level",level)}});throw new xplogs_1.XpFatal({function:"addLevel()",message:"User does not exist"})}
+/**
+ * Add XP to a user.
+ * @async
+ * @param {string} userId - The ID of the user.
+ * @param {string} guildId - The ID of the guild.
+ * @param {number | {min: number, max: number}} xpData - The XP to add, can be a number or an object with min and max properties.
+ * @param {string} username - Username to use if auto_create is enabled.
+ * @link `Documentation:` https://simplyxp.js.org/docs/addxp
+ * @returns {Promise<UserResult>} - Object of user data on success.
+ * @throws {XpFatal} - If parameters are not provided correctly.
+ */async function addXP(userId,guildId,xpData,username){if(!("number"==typeof xpData||"object"==typeof xp_1.xp&&xpData.min&&xpData.max))throw new xplogs_1.XpFatal({function:"addXP()",message:"XP is not a number or object, make sure you are using the correct syntax"});if("object"==typeof xpData&&(xpData=Math.floor(Math.random()*(xpData.max-xpData.min)+xpData.min)),!userId)throw new xplogs_1.XpFatal({function:"addXP()",message:"User ID was not provided"});if(!guildId)throw new xplogs_1.XpFatal({function:"addXP()",message:"Guild ID was not provided"});var e=await database_1.db.findOne({collection:"simply-xps",data:{user:userId,guild:guildId}});if(e)return database_1.db.updateOne({collection:"simply-xps",data:{user:userId,guild:guildId}},{collection:"simply-xps",data:{user:userId,guild:guildId,level:(0,utilities_1.convert)("xp",e.xp+xpData),xp:e.xp+xpData}});if(xp_1.xp.auto_create&&username)return database_1.db.createOne({collection:"simply-xps",data:{guild:guildId,user:userId,name:username,level:(0,utilities_1.convert)("xp",xpData),xp:xpData}});throw new xplogs_1.XpFatal({function:"addXP()",message:"User does not exist"})}Object.defineProperty(exports,"__esModule",{value:!0}),exports.addXP=exports.addLevel=void 0;const utilities_1=require("./functions/utilities"),xplogs_1=require("./functions/xplogs"),database_1=require("./functions/database"),xp_1=require("../xp");exports.addLevel=addLevel,exports.addXP=addXP;

package/lib/src/cards.d.ts

@@ -0,0 +1,91 @@
+/// <reference types="node" />
+import { User } from "./leaderboard";
+type HexColor = `#${string}` | `0x${string}`;
+/**
+ * @property {[HexColor, HexColor]} artworkColors - Gradient colors
+ * @property {URL} artworkImage
+ * @property {[HexColor, HexColor]} borderColors - Gradient colors
+ * @property {HexColor} backgroundColor
+ * @property {URL} backgroundImage
+ * @property {string} font - ABSOLUTE FILE PATH
+ * @property {boolean} light - Use light theme
+ */
+export interface LeaderboardOptions {
+    artworkColors?: [HexColor, HexColor];
+    artworkImage?: URL;
+    borderColors?: [HexColor, HexColor];
+    backgroundColor?: HexColor;
+    backgroundImage?: URL;
+    font?: string;
+    light?: boolean;
+}
+/**
+ * @property {URL} background - Background image URL
+ * @property {HexColor} color
+ * @property {boolean} legacy - Use legacy card design
+ * @property {HexColor} lvlbar
+ * @property {HexColor} lvlbarBg
+ * @property {string} font - ABSOLUTE FILE PATH
+ */
+export interface RankCardOptions {
+    background?: URL;
+    color?: HexColor;
+    legacy?: boolean;
+    lvlbar?: HexColor;
+    lvlbarBg?: HexColor;
+    font?: string;
+}
+export type UserOptions = {
+    id: string;
+    username: string;
+    avatarURL: string;
+};
+export type LeaderboardLocales = {
+    level?: string;
+    members?: string;
+};
+export type rankLocales = {
+    level?: string;
+    next_level?: string;
+    xp?: string;
+};
+/**
+ * Generate a simple user rank card
+ * @async
+ * @param {{id: string, name: string}} guild - (id, name)
+ * @param {UserOptions} user - (id, username, avatarURL)
+ * @param {RankCardOptions?} options - (background, color, legacy, lvlbar, lvlbarBg, font)
+ * @param {rankLocales?} locales - [BETA] Translate the rank card
+ * @link [Documentation](https://simplyxp.js.org/docs/rankCard)
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>}
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */
+export declare function rankCard(guild: {
+    id: string;
+    name: string;
+}, user: UserOptions, options?: RankCardOptions, locales?: rankLocales): Promise<{
+    attachment: Buffer;
+    description: string;
+    name: string;
+}>;
+/**
+ * Generate a simple leaderboard card
+ * @async
+ * @param {Array<User>} data - Array of user data
+ * @param {LeaderboardOptions?} options - (artworkColor, artworkImage, light)
+ * @param {{name: string, imageURL: string, memberCount: number}?} guildInfo - Guild info
+ * @param {LeaderboardLocales} locales - Locales
+ * @link [Documentation](https://simplyxp.js.org/docs/leaderboard)
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>}
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */
+export declare function leaderboardCard(data: Array<User>, options?: LeaderboardOptions, guildInfo?: {
+    name: string;
+    imageURL: string;
+    memberCount: number;
+}, locales?: LeaderboardLocales): Promise<{
+    attachment: Buffer;
+    description: string;
+    name: string;
+}>;
+export {};

package/lib/src/cards.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * Generate a simple user rank card
+ * @async
+ * @param {{id: string, name: string}} guild - (id, name)
+ * @param {UserOptions} user - (id, username, avatarURL)
+ * @param {RankCardOptions?} options - (background, color, legacy, lvlbar, lvlbarBg, font)
+ * @param {rankLocales?} locales - [BETA] Translate the rank card
+ * @link [Documentation](https://simplyxp.js.org/docs/rankCard)
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>}
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */async function rankCard(guild,user,options={},locales={}){if(!guild)throw new xplogs_1.XpFatal({function:"rankCard()",message:"No Guild Provided"});if(!user)throw new xplogs_1.XpFatal({function:"rankCard()",message:"No User Provided"});options.legacy=!0;let e,a;if(locales?.level||(locales.level="Level"),locales?.next_level||(locales.next_level="Next Level"),locales?.xp||(locales.xp="XP"),xplogs_1.XpLog.debug("rankCard()","LEGACY MODE ENABLED"),xplogs_1.XpLog.info("rankCard()","Modern RankCard is not supported yet, coming soon!"),!user?.avatarURL.endsWith(".png")&&!user.avatarURL.endsWith(".jpg")&&!user.avatarURL.endsWith(".webp"))throw new xplogs_1.XpFatal({function:"rankCard()",message:"Invalid avatar image, avatar image must be a png, jpg, or webp"});if(!user||!user.id||!user.username)throw new xplogs_1.XpFatal({function:"rankCard()",message:"Invalid User Provided, user must contain id, username, and avatarURL."});canvas_1.GlobalFonts.registerFromPath(options?.font||(0,path_1.join)(__dirname,"Fonts","Baloo-Regular.ttf"),"Sans Serif"),cachedRankImage=cachedRankImage||await(0,canvas_1.loadImage)(options?.background||"https://i.ibb.co/dck2Tnt/rank-card.webp");let o=await database_1.db.findOne({collection:"simply-xps",data:{guild:guild.id,user:user.id}});if(!o){if(!xp_1.xp.auto_create)throw new xplogs_1.XpFatal({function:"rankCard()",message:"User not found in database"});o=await(0,xp_1.create)(guild.id,user.id,user.username)}var t,r,l,n,d,i,s,c=(await database_1.db.find({collection:"simply-xps",data:{guild:guild.id}})).sort((a,b)=>b.xp-a.xp).findIndex(u=>u.user===user.id)+1;return options?.legacy?(t=user.username.replace(/[\u007f-\uffff]/g,""),r=options?.color||"#9900ff",l=options?.lvlbar||"#ffffff",options=options?.lvlbarBg||"#ffffff",s=shortener(o.xp)+(" "+locales.xp),n=locales.level+(" "+shortener(o.level)),d=(0,utilities_1.convert)("level",o.level+1),i=(0,utilities_1.convert)("level",o.level),i=100*(o.xp-i)/(d-i)*660/100,cachedRankContext&&cachedRankCanvas?(e=cachedRankCanvas,a=cachedRankContext):(e=(0,canvas_1.createCanvas)(1080,400),RoundedBox(a=e.getContext("2d"),0,0,e.width,e.height,50),a.clip(),a.fillStyle="#000000",a.fillRect(0,0,1080,400),a.globalAlpha=.7,a.drawImage(cachedRankImage,-5,0,1090,400),a.restore(),a.fillStyle="#000000",a.globalAlpha=.4,a.fillRect(40,0,240,e.height),a.globalAlpha=1),a.save(),RoundedBox(a,70,30,180,180,50),a.strokeStyle=r,a.lineWidth=15,a.stroke(),a.clip(),a.drawImage(await(0,canvas_1.loadImage)(user.avatarURL),70,30,180,180),a.restore(),a.save(),RoundedBox(a,70,320,180,50,20),a.strokeStyle="#BFC85A22",a.stroke(),a.clip(),a.fillStyle=r,a.globalAlpha=1,a.fillRect(70,320,180,50),a.globalAlpha=1,a.fillStyle="#ffffff",a.textAlign="center",dynamicFont(a,s,160,358,160,32),a.restore(),a.save(),RoundedBox(a,70,240,180,50,20),a.strokeStyle="#BFC85A22",a.stroke(),a.clip(),a.fillStyle=r,a.globalAlpha=1,a.fillRect(70,240,180,50),a.globalAlpha=1,a.fillStyle="#ffffff",a.textAlign="center",dynamicFont(a,n,160,278,160,32),a.restore(),a.save(),a.textAlign="left",a.fillStyle="#ffffff",a.shadowColor="#000000",a.shadowBlur=15,a.shadowOffsetX=1,a.shadowOffsetY=1,a.font='39px "Sans Serif"',a.fillText(t,390,80),a.restore(),a.save(),a.textAlign="right",a.fillStyle="#ffffff",a.shadowColor="#000000",a.shadowBlur=15,a.shadowOffsetX=1,a.shadowOffsetY=1,a.font='55px "Sans Serif"',a.fillText("#"+c,e.width-55,80),a.restore(),a.save(),RoundedBox(a,390,305,660,70,Number(20)),a.strokeStyle="#BFC85A22",a.stroke(),a.clip(),a.fillStyle="#ffffff",a.textAlign="center",dynamicFont(a,guild.name,720,355,700,45),a.globalAlpha=.2,a.fillRect(390,305,660,70),a.restore(),a.save(),RoundedBox(a,390,145,660,50,20),a.strokeStyle="#BFC85A22",a.stroke(),a.clip(),a.fillStyle=options,a.globalAlpha=.2,a.fillRect(390,145,660,50),a.restore(),a.save(),RoundedBox(a,390,145,i,50,20),a.strokeStyle="#BFC85A22",a.stroke(),a.clip(),a.fillStyle=l,a.globalAlpha=.5,a.fillRect(390,145,i,50),a.restore(),a.save(),a.textAlign="left",a.fillStyle="#ffffff",a.globalAlpha=.8,a.font='30px "Sans Serif"',a.fillText(locales.next_level+": "+shortener(d)+" "+locales.xp,390,230),a.restore(),s="{current} / {needed}".replace(/{needed}/g,shortener(d)).replace(/{current}/g,shortener(o.xp)),a.textAlign="center",a.fillStyle="#474747",a.globalAlpha=1,a.font='30px "Sans Serif"',a.fillText(s,730,180)):e=(0,canvas_1.createCanvas)(1080,360),{attachment:e.toBuffer("image/png"),description:"Simply-XP Rank Card",name:"rank.png"}}
+/**
+ * Generate a simple leaderboard card
+ * @async
+ * @param {Array<User>} data - Array of user data
+ * @param {LeaderboardOptions?} options - (artworkColor, artworkImage, light)
+ * @param {{name: string, imageURL: string, memberCount: number}?} guildInfo - Guild info
+ * @param {LeaderboardLocales} locales - Locales
+ * @link [Documentation](https://simplyxp.js.org/docs/leaderboard)
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>}
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */async function leaderboardCard(data,options={},guildInfo,locales={}){var e,a;if(!data||data.length<1)throw new xplogs_1.XpFatal({function:"leaderboardCard()",message:"There must be at least 1 user in the data array"});!cachedLeaderboardArtwork&&options?.artworkImage&&(cachedLeaderboardArtwork=await(0,canvas_1.loadImage)(options.artworkImage)),!cachedLeaderboardImage&&options?.backgroundImage&&(cachedLeaderboardImage=await(0,canvas_1.loadImage)(options.backgroundImage)),locales.level||(locales.level="LEVEL"),locales.members||(locales.members="Members"),data=data.slice(0,8);let o,t,r,l=(r=options?.light?{artworkColors:options?.artworkColors||["#374bff","#5f69ff"],backgroundColor:"#f0f0eb",borderColors:options?.borderColors||["#ffa237","#ffcc6b"],evenColor:"#dcdcdc",oddColor:"#c8c8c8",primaryTextColor:"#000000",secondaryTextColor:"rgba(0,0,0,0.5)"}:{artworkColors:options?.artworkColors||["#374bff","#333793"],backgroundColor:"#141414",borderColors:options?.borderColors||["#ffa237","#b67125"],evenColor:"#1e1e1e",oddColor:"#282828",primaryTextColor:"#ffffff",secondaryTextColor:"rgba(255,255,255,0.5)"},cachedLeaderboardCanvas&&cachedLeaderboardContext?(o=cachedLeaderboardCanvas,t=cachedLeaderboardContext):(o=(0,canvas_1.createCanvas)(1350,1080),RoundedBox(t=o.getContext("2d"),0,0,o.width,o.height,20),t.clip(),(e=t.createLinearGradient(0,0,o.width,0)).addColorStop(0,r.artworkColors[0]),e.addColorStop(1,r.artworkColors[1]),t.fillStyle=e,t.fillRect(0,0,o.width,220),cachedLeaderboardArtwork&&(t.fillStyle="#000000",t.fillRect(0,0,o.width,220),t.globalAlpha=.5,t.drawImage(cachedLeaderboardArtwork,0,0,o.width,220),t.globalAlpha=1),t.fillStyle=options.backgroundColor||r.backgroundColor,t.fillRect(0,220,o.width,1080),cachedLeaderboardImage&&(t.globalAlpha=.9,t.drawImage(cachedLeaderboardImage,0,220,o.width,1080),t.globalAlpha=1)),guildInfo&&guildInfo?.imageURL&&guildInfo?.name&&guildInfo?.memberCount&&(e=await(0,canvas_1.loadImage)(guildInfo.imageURL),t.save(),t.beginPath(),t.arc(150,110,90,0,2*Math.PI,!0),t.closePath(),t.clip(),t.drawImage(e,60,20,180,180),t.restore(),(options=t.createLinearGradient(0,0,0,220)).addColorStop(0,r.borderColors[0]),options.addColorStop(1,r.borderColors[1]),t.strokeStyle=options,t.lineWidth=10,t.beginPath(),t.arc(150,110,90,0,2*Math.PI,!0),t.stroke(),t.fillStyle=r.primaryTextColor,t.font='60px "Sans Serif"',t.fillText(guildInfo.name,270,110),t.fillStyle=r.secondaryTextColor,t.font='40px "Sans Serif"',t.fillText(guildInfo.memberCount+" "+locales.members,270,160)),r.evenColor);for(let e=0;e<data.length;e++)a=300+90*e,1===data.length?RoundedBox(t,30,a,1290,90,20):0===e?RoundedBox(t,30,a,1290,90,20,{top:!0,bottom:!1}):e===data.length-1?RoundedBox(t,30,a,1290,90,20,{top:!1,bottom:!0}):RoundedBox(t,30,a,1290,90,0),t.fillStyle=l,t.globalAlpha=cachedLeaderboardImage?.5:1,t.fill(),t.globalAlpha=1,t.textAlign="left",t.font='30px "Sans Serif"',t.fillStyle=r.secondaryTextColor,t.fillText(e+1+".",60,55+a),t.textAlign="left",t.font='40px "Sans Serif"',t.fillStyle=r.primaryTextColor,t.fillText(data[e]?.name||data[e]?.user||"???",120,60+a),t.textAlign="right",t.font='30px "Sans Serif"',t.fillStyle=r.primaryTextColor,t.fillText(shortener(data[e]?.level)||"???",1270,55+a),t.fillStyle=r.secondaryTextColor,t.fillText(locales.level,1270-t.measureText(shortener(data[e]?.level)||"???").width-15,55+a),l=l===r.evenColor?r.oddColor:r.evenColor;return{attachment:o.toBuffer("image/png"),description:"Simply-XP Leaderboard Card",name:"leaderboard.png"}}function RoundedBox(ctx,x,y,width,height,radius,roundCorners={top:!0,bottom:!0}){ctx.beginPath(),ctx.moveTo(x+(roundCorners.top?radius:0),y),ctx.lineTo(x+width-(roundCorners.top?radius:0),y),roundCorners.top&&ctx.quadraticCurveTo(x+width,y,x+width,y+radius),ctx.lineTo(x+width,y+height-(roundCorners.bottom?radius:0)),roundCorners.bottom&&ctx.quadraticCurveTo(x+width,y+height,x+width-radius,y+height),ctx.lineTo(x+(roundCorners.bottom?radius:0),y+height),roundCorners.bottom&&ctx.quadraticCurveTo(x,y+height,x,y+height-radius),ctx.lineTo(x,y+(roundCorners.top?radius:0)),roundCorners.top&&ctx.quadraticCurveTo(x,y,x+radius,y),ctx.closePath()}function shortener(count){var e,a=["","k","M","B","T","Qa","Qi","Sx","Sp"];return count&&0!==count?count===1/0?"∞":(e=Math.floor(Math.log(count)/Math.log(1e3)),a.length<=e?count.toFixed(0)+a[a.length-1]:(count/Math.pow(1e3,e)).toFixed(0===e?0:2)+a[e]):"0"}function dynamicFont(context,text,x,y,maxWidth,maxSize){let e=maxSize;for(;0<e&&(context.font=e+'px "Sans Serif"',!(context.measureText(text).width<maxWidth));)e--;context.textAlign="center",context.fillText(text,x,y)}Object.defineProperty(exports,"__esModule",{value:!0}),exports.leaderboardCard=exports.rankCard=void 0;const canvas_1=require("@napi-rs/canvas"),xplogs_1=require("./functions/xplogs"),database_1=require("./functions/database"),utilities_1=require("./functions/utilities"),path_1=require("path"),xp_1=require("../xp");let cachedRankImage,cachedRankCanvas,cachedRankContext,cachedLeaderboardArtwork,cachedLeaderboardCanvas,cachedLeaderboardContext,cachedLeaderboardImage;exports.rankCard=rankCard,exports.leaderboardCard=leaderboardCard;

package/lib/src/charts.d.ts

@@ -0,0 +1,17 @@
+type HexColor = `#${string}` | `0x${string}`;
+export interface ChartOptions {
+    backgroundColor?: HexColor;
+    limit?: number;
+    type?: "bar" | "line" | "pie" | "doughnut" | "radar" | "polarArea";
+}
+/**
+ * Creates a chart
+ * @async
+ * @param {string} guildId
+ * @param {ChartOptions?} options
+ * @link `Documentation:` https://simplyxp.js.org/docs/charts
+ * @returns {Promise<void>}
+ * @throws {XpFatal} If invalid parameters are provided
+ */
+export declare function charts(guildId: string, options?: ChartOptions): Promise<void>;
+export {};

package/lib/src/charts.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * Creates a chart
+ * @async
+ * @param {string} guildId
+ * @param {ChartOptions?} options
+ * @link `Documentation:` https://simplyxp.js.org/docs/charts
+ * @returns {Promise<void>}
+ * @throws {XpFatal} If invalid parameters are provided
+ */async function charts(guildId,options={}){if(!guildId)throw new xplogs_1.XpFatal({function:"charts()",message:"No Guild ID Provided"});if(options)throw options.limit&&10<options.limit&&(options.limit=10),options.type||(options.type="bar"),new xplogs_1.XpFatal({function:"charts()",message:"[V2] Under Development | Should be here within 2-3 dev releases."});throw new xplogs_1.XpFatal({function:"charts()",message:"No Options Provided"})}Object.defineProperty(exports,"__esModule",{value:!0}),exports.charts=void 0;const xplogs_1=require("./functions/xplogs");exports.charts=charts;

package/lib/src/connect.d.ts

@@ -0,0 +1,26 @@
+export type ConnectionOptions = {
+    type: "mongodb" | "sqlite" | undefined;
+    auto_create?: boolean;
+    auto_purge?: boolean;
+    notify?: boolean;
+    debug?: boolean;
+};
+/**
+ * Connect to a database (MongoDB, SQLite)
+ *
+ * @async
+ * @param {string} uri
+ * @param {ConnectionOptions} options
+ * @link `Documentation:` https://simplyxp.js.org/docs/connect
+ * @returns {Promise<boolean>}
+ * @throws {XpFatal} If an invalid type is provided or if the value is not provided.
+ */
+export declare function connect(uri: string, options?: ConnectionOptions): Promise<boolean | void>;
+/**
+ * Check database package versions
+ * @private
+ * @param {"mongodb" | "sqlite"} type
+ * @returns {Promise<boolean>}
+ * @throws {XpFatal} If the package version is not supported
+ */
+export declare function checkPackageVersion(type: "mongodb" | "sqlite"): Promise<boolean>;

package/lib/src/connect.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * Connect to a database (MongoDB, SQLite)
+ *
+ * @async
+ * @param {string} uri
+ * @param {ConnectionOptions} options
+ * @link `Documentation:` https://simplyxp.js.org/docs/connect
+ * @returns {Promise<boolean>}
+ * @throws {XpFatal} If an invalid type is provided or if the value is not provided.
+ */async function connect(uri,options={type:void 0}){var e,{type:t,auto_create:o,auto_purge:r,notify:a,debug:n}=options;if(!uri)throw new xplogs_1.XpFatal({function:"connect()",message:"No URI Provided"});switch(!1===a&&(xp_1.xp.notify=!1),o&&(xp_1.xp.auto_create=!0),r&&(xp_1.xp.auto_purge=!0),n&&(xp_1.xp.debug=!0),t||(options.type="mongodb",xplogs_1.XpLog.warn("connect()","Database type not provided, defaulting to MongoDB")),t){case"mongodb":if(e=(await Promise.resolve().then(()=>__importStar(require("mongodb")))).MongoClient,!await checkPackageVersion("mongodb"))return xplogs_1.XpLog.err("connect()","MongoDB V4 or higher is required");e=await e.connect(uri).catch(error=>{throw new xplogs_1.XpFatal({function:"connect()",message:error.message})}),xp_1.xp.dbType="mongodb",xp_1.xp.database=e||void 0;break;case"sqlite":try{var[s,i]=await Promise.all([Promise.resolve().then(()=>__importStar(require("better-sqlite3"))),checkPackageVersion("sqlite")]);if(!i)return xplogs_1.XpLog.err("connect()","better-sqlite3 V7 or higher is required");xp_1.xp.database=new s.default(uri),xp_1.xp.dbType="sqlite",xp_1.xp.database.exec(`CREATE TABLE IF NOT EXISTS "simply-xps"
+                              (
+                                  user
+                                  TEXT
+                                  UNIQUE,
+                                  guild
+                                  TEXT,
+                                  xp
+                                  INTEGER
+                                  DEFAULT
+                                  0,
+                                  level
+                                  INTEGER
+                                  DEFAULT
+                                  0
+                              )`),xp_1.xp.database.exec(`CREATE TABLE IF NOT EXISTS "simply-xp-levelroles"
+                              (
+                                  gid
+                                  TEXT
+                                  UNIQUE,
+                                  lvlrole
+                                  TEXT
+                                  NOT
+                                  NULL
+                              )`)}catch(t){if("object"==typeof t&&null!==t&&void 0!==(e=t).code&&"MODULE_NOT_FOUND"!==e.code)throw new xplogs_1.XpFatal({function:"connect()",message:e.message})}break;default:throw new xplogs_1.XpFatal({function:"connect()",message:"DATABASE TYPE NOT PROVIDED OR INVALID"})}return!!xp_1.xp.database&&(xplogs_1.XpLog.info("connect()","Connected to database!"),!0)}
+/**
+ * Returns the package manager used
+ * @private
+ * @returns {Promise<"yarn" | "npm" | "pnpm">}
+ */async function getPackageManager(){const e=(await Promise.resolve().then(()=>__importStar(require("fs")))).existsSync;var t=["yarn.lock","pnpm-lock.yaml","pnpm-lock.json","package-lock.json"].filter(lockfile=>e(lockfile));if(1===t.length){if("yarn.lock"===t[0])return xplogs_1.XpLog.debug("getPackageManager()","Using Yarn"),"yarn";if("pnpm-lock.yaml"===t[0]||"pnpm-lock.json"===t[0])return xplogs_1.XpLog.debug("getPackageManager()","Using PNPM"),"pnpm"}return xplogs_1.XpLog.debug("getPackageManager()","Using NPM"),"npm"}
+/**
+ * Check database package versions
+ * @private
+ * @param {"mongodb" | "sqlite"} type
+ * @returns {Promise<boolean>}
+ * @throws {XpFatal} If the package version is not supported
+ */async function checkPackageVersion(type){var e,t;switch(type){case"mongodb":try{return e=await Promise.resolve().then(()=>__importStar(require("mongodb/package.json"))),4<=parseInt(e.version.substring(0,1))}catch(e){return xplogs_1.XpLog.info("checkPackageVersion()","Installing MongoDB [5.x] | Please wait..."),(0,child_process_1.execSync)(await getPackageManager()+" add mongodb@5.x.x"),xplogs_1.XpLog.warn("checkPackageVersion()","Installed MongoDB. Please restart!"),process.exit(1)}case"sqlite":try{return t=await Promise.resolve().then(()=>__importStar(require("better-sqlite3/package.json"))),7<=parseInt(t.version.substring(0,1))}catch(e){return xplogs_1.XpLog.info("checkPackageVersion()","Installing better-sqlite3 [V8] | Please wait..."),(0,child_process_1.execSync)(await getPackageManager()+" add better-sqlite3@8.x.x"),xplogs_1.XpLog.warn("checkPackageVersion()","Installed better-sqlite3. Please restart!"),process.exit(1)}}}var __createBinding=this&&this.__createBinding||(Object.create?function(o,m,k,k2){void 0===k2&&(k2=k);var e=Object.getOwnPropertyDescriptor(m,k);e&&("get"in e?m.__esModule:!e.writable&&!e.configurable)||(e={enumerable:!0,get:function(){return m[k]}}),Object.defineProperty(o,k2,e)}:function(o,m,k,k2){o[k2=void 0===k2?k:k2]=m[k]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(o,v){Object.defineProperty(o,"default",{enumerable:!0,value:v})}:function(o,v){o.default=v}),__importStar=this&&this.__importStar||function(mod){var e,t;if(mod&&mod.__esModule)return mod;if(e={},null!=mod)for(t in mod)"default"!==t&&Object.prototype.hasOwnProperty.call(mod,t)&&__createBinding(e,mod,t);return __setModuleDefault(e,mod),e};Object.defineProperty(exports,"__esModule",{value:!0}),exports.checkPackageVersion=exports.connect=void 0;const xplogs_1=require("./functions/xplogs"),child_process_1=require("child_process"),xp_1=require("../xp");exports.connect=connect,exports.checkPackageVersion=checkPackageVersion;

package/lib/src/create.d.ts

@@ -0,0 +1,12 @@
+import { UserResult } from "./functions/database";
+/**
+ * Create a new user in the database
+ * @async
+ * @param {string} userId
+ * @param {string} guildId
+ * @param {string} username
+ * @link `Documentation:` https://simplyxp.js.org/docs/create
+ * @returns {Promise<UserResult>}
+ * @throws {XpFatal} If invalid parameters are provided
+ */
+export declare function create(userId: string, guildId: string, username: string): Promise<UserResult>;

package/lib/src/create.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * Create a new user in the database
+ * @async
+ * @param {string} userId
+ * @param {string} guildId
+ * @param {string} username
+ * @link `Documentation:` https://simplyxp.js.org/docs/create
+ * @returns {Promise<UserResult>}
+ * @throws {XpFatal} If invalid parameters are provided
+ */async function create(userId,guildId,username){if(!userId)throw new xplogs_1.XpFatal({function:"create()",message:"User ID was not provided"});if(!guildId)throw new xplogs_1.XpFatal({function:"create()",message:"Guild ID was not provided"});if(!username)throw new xplogs_1.XpFatal({function:"create()",message:"Username was not provided"});xplogs_1.XpLog.warn("create()","We just swapped userId with guildId again, this warning will be removed in the next DEV release.");var e=(await Promise.resolve().then(()=>__importStar(require("./functions/database")))).db;return await e.findOne({collection:"simply-xps",data:{user:userId,guild:guildId}})||e.createOne({collection:"simply-xps",data:{name:username,user:userId,guild:guildId,level:0,xp:0}})}var __createBinding=this&&this.__createBinding||(Object.create?function(o,m,k,k2){void 0===k2&&(k2=k);var e=Object.getOwnPropertyDescriptor(m,k);e&&("get"in e?m.__esModule:!e.writable&&!e.configurable)||(e={enumerable:!0,get:function(){return m[k]}}),Object.defineProperty(o,k2,e)}:function(o,m,k,k2){o[k2=void 0===k2?k:k2]=m[k]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(o,v){Object.defineProperty(o,"default",{enumerable:!0,value:v})}:function(o,v){o.default=v}),__importStar=this&&this.__importStar||function(mod){var e,t;if(mod&&mod.__esModule)return mod;if(e={},null!=mod)for(t in mod)"default"!==t&&Object.prototype.hasOwnProperty.call(mod,t)&&__createBinding(e,mod,t);return __setModuleDefault(e,mod),e};Object.defineProperty(exports,"__esModule",{value:!0}),exports.create=void 0;const xplogs_1=require("./functions/xplogs");exports.create=create;

package/lib/src/deprecated/rank.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+import { RankCardOptions } from "../cards";
+/**
+ * @deprecated Use rankCard() instead.
+ * Get user rank card
+ * @param {Message} message (DISCORD)
+ * @param {string} userId
+ * @param {string} _guildId
+ * @param {RankCardOptions?} options
+ * @link `Documentation:` https://simplyxp.js.org/docs/deprecated/rank
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>}
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */
+export declare function rank(message: import("discord.js").Message, userId: string, _guildId: string, options?: RankCardOptions): Promise<{
+    attachment: Buffer;
+    description: string;
+    name: string;
+}>;

package/lib/src/deprecated/rank.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * @deprecated Use rankCard() instead.
+ * Get user rank card
+ * @param {Message} message (DISCORD)
+ * @param {string} userId
+ * @param {string} _guildId
+ * @param {RankCardOptions?} options
+ * @link `Documentation:` https://simplyxp.js.org/docs/deprecated/rank
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>}
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */async function rank(message,userId,_guildId,options){var e;try{e=await Promise.resolve().then(()=>__importStar(require("discord.js/package.json"))),parseInt(e.version.split(".")[0])<13?xplogs_1.XpLog.warn("rank()","This may not work with Discord.JS v12 or below."):xplogs_1.XpLog.debug("rank()",`Discord.JS v${e.version} detected.`)}catch(e){throw new xplogs_1.XpFatal({function:"rank()",message:"This function requires Discord.JS, as it is only for Discord bots. | Use rankCard() instead."})}if(!message||!message?.guild)throw new xplogs_1.XpFatal({function:"rank()",message:"Invalid Message Provided"});if(!userId)throw new xplogs_1.XpFatal({function:"rank()",message:"No User ID Provided"});if(xplogs_1.XpLog.warn("rank()","DEPRECATED FUNCTION!! Please use rankCard() instead."),e=await message.guild.members.fetch(userId).catch(()=>null))return(0,cards_1.rankCard)({id:message.guild.id,name:message.guild.name},{id:e.id,username:e.user.username,avatarURL:e.user.displayAvatarURL()},options);throw new xplogs_1.XpFatal({function:"rank()",message:"Member not found"})}var __createBinding=this&&this.__createBinding||(Object.create?function(o,m,k,k2){void 0===k2&&(k2=k);var e=Object.getOwnPropertyDescriptor(m,k);e&&("get"in e?m.__esModule:!e.writable&&!e.configurable)||(e={enumerable:!0,get:function(){return m[k]}}),Object.defineProperty(o,k2,e)}:function(o,m,k,k2){o[k2=void 0===k2?k:k2]=m[k]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(o,v){Object.defineProperty(o,"default",{enumerable:!0,value:v})}:function(o,v){o.default=v}),__importStar=this&&this.__importStar||function(mod){var e,r;if(mod&&mod.__esModule)return mod;if(e={},null!=mod)for(r in mod)"default"!==r&&Object.prototype.hasOwnProperty.call(mod,r)&&__createBinding(e,mod,r);return __setModuleDefault(e,mod),e};Object.defineProperty(exports,"__esModule",{value:!0}),exports.rank=void 0;const xplogs_1=require("../functions/xplogs"),cards_1=require("../cards");exports.rank=rank;

package/lib/src/fetch.d.ts

@@ -0,0 +1,12 @@
+import { User } from "./leaderboard";
+/**
+ * Fetch user data
+ * @async
+ * @param {string} userId
+ * @param {string} guildId
+ * @param {string} username - Username to use if auto_create is enabled
+ * @link `Documentation:` https://simplyxp.js.org/docs/fetch
+ * @returns {Promise<{name: string | null, user: string, guild: string, level: number, position: number, xp: number}>}
+ * @throws {XpFatal} If invalid parameters are provided, or if the user data is not found.
+ */
+export declare function fetch(userId: string, guildId: string, username: string): Promise<User>;

package/lib/src/fetch.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * Fetch user data
+ * @async
+ * @param {string} userId
+ * @param {string} guildId
+ * @param {string} username - Username to use if auto_create is enabled
+ * @link `Documentation:` https://simplyxp.js.org/docs/fetch
+ * @returns {Promise<{name: string | null, user: string, guild: string, level: number, position: number, xp: number}>}
+ * @throws {XpFatal} If invalid parameters are provided, or if the user data is not found.
+ */async function fetch(userId,guildId,username){if(!userId)throw new xplogs_1.XpFatal({function:"create()",message:"User ID was not provided"});if(!guildId)throw new xplogs_1.XpFatal({function:"create()",message:"Guild ID was not provided"});var e=await(await Promise.resolve().then(()=>__importStar(require("./functions/database")))).db.find({collection:"simply-xps",data:{guild:guildId}}),t=e.find(u=>u.user===userId);if(t)return e=e.sort((a,b)=>b.xp-a.xp).findIndex(u=>u.user===userId)+1,{name:t?.name,user:t.user,guild:t.guild,level:t.level,position:e,xp:t.xp};if(xp_1.xp.auto_create&&username)return(await Promise.resolve().then(()=>__importStar(require("./create")))).create(guildId,userId,username);throw new xplogs_1.XpFatal({function:"fetch()",message:"User data not found"})}var __createBinding=this&&this.__createBinding||(Object.create?function(o,m,k,k2){void 0===k2&&(k2=k);var e=Object.getOwnPropertyDescriptor(m,k);e&&("get"in e?m.__esModule:!e.writable&&!e.configurable)||(e={enumerable:!0,get:function(){return m[k]}}),Object.defineProperty(o,k2,e)}:function(o,m,k,k2){o[k2=void 0===k2?k:k2]=m[k]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(o,v){Object.defineProperty(o,"default",{enumerable:!0,value:v})}:function(o,v){o.default=v}),__importStar=this&&this.__importStar||function(mod){var e,t;if(mod&&mod.__esModule)return mod;if(e={},null!=mod)for(t in mod)"default"!==t&&Object.prototype.hasOwnProperty.call(mod,t)&&__createBinding(e,mod,t);return __setModuleDefault(e,mod),e};Object.defineProperty(exports,"__esModule",{value:!0}),exports.fetch=void 0;const xplogs_1=require("./functions/xplogs"),xp_1=require("../xp");exports.fetch=fetch;