simply-xp 1.3.7 → 2.0.0-beta.0-fix.0

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,58 +1,88 @@
-<p align="center"><img align="center" style="margin-bottom:-6px" src="https://i.imgur.com/BiaHJA7.png?maxwidth=128&fidelity=grand"></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 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>
+<h2>We have levelling! - You handle the rest.</h2>
+<h3>Made by Abadima</h3>
+</div>
 
 <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>
+<div class="badges" style="text-align: center;">
 
-<br>
+[![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)
 
-## 🖥️ <b>How to install ?
+[![Documentation](https://img.shields.io/badge/SimplyXP-Documentation-6b46d4?style=for-the-badge)](https://simplyxp.js.org/docs/next/intro/)
+[![Support](https://img.shields.io/badge/Discord-Support-5865F2?style=for-the-badge&logo=discord)](https://discord.gg/hjhnjYJNHX)
+</div>
 
-```
-npm install simply-xp
-```
-
-(or)
-
-```
-yarn add simply-xp
-```
+---
+> CREDITS TO [RAHULETTO](https://github.com/rahuletto) FOR SIMPLY-XP **VERSION 1**
+---
 
 <br>
 
-# 🎉 Recent Updates 🎉
-
-- Fixed Various Bugs
-- Updated `Chart.js`
-- D.JS v14 Support
-- Patched v1.3.5 Bugs
+## 🖥️ <b>[DEV] Installation</b>
 
+```shell
+npm install simply-xp@beta
+```
 
-# But Why ?
+```shell
+pnpm install simply-xp@beta
+```
 
-- 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
+```shell
+yarn add simply-xp@beta
+```
 
 <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>
+## ✅ V2 Additions
+
+- Add `auto_create`, `auto_clean`, `debug`, and `xp_rate` options to `connect()`.
+- Add `compareCard()`
+- Add `convertFrom()`
+- Add `db` class for extended database functionality
+- Add `https()`
+- Add `leaderboardCard()`
+- Add `migrate` class
+- Add `SQLite` Support
+- Add `roleSetup.getRoles()`
+- Add `registerPlugins()`
+- Add `removeLevel()` and `removeXP()`.
+- Add `roleSetup.getRoles()`
+- Add `updateOptions()`
+- Add `xp_rate` Support For Unique Level Rates!
+
+## 🎉 V2 Changes
+
+- All functions returning either `UserResult` or `LevelRoleResult` now includes `lastUpdated` property.
+- Better Performance & Reduced RAM overhead.
+- Better Code Quality (EsLint)
+- Complete & Revamped Documentation
+- Complete TypeScript Rewrite
+- New Fonts
+- Reduced Package Size!
+- Renewed Logging System (`XpLog`)
+- Deleted `chart.js` dependency
+- `addLevel(), addXP(), setLevel(), setXP()` now has a `username` parameter, to automatically create the user if it doesn't exist.
+- `fetch()` now also returns `position`, and accepts `username` parameter
+- `leaderboard()` now supports Global Leaderboards, by simply not passing a `guildID` argument.
+- `roleSetup` functions now accept RoleID arrays! `["role1", "role2", "role3"]`.
+- `reset()` function now accepts `erase` and `username` as optional arguments
+
+## ⚠️ V2 Breaking Changes
+
+- All functions lose `client` and `message` arguments where applicable.
+- `create()` Now requires `username` argument.
+- `charts()` Requires new arguments, and is revamped.
+- `rank()` is **removed**, use `rankCard()` instead. (REQUIRES NEW ARGUMENTS)
+- `leaderboard()` replaces `userID` with `user` in `UserResult`.
+- `client.on()` => `XpEvents.on()` (READ DOCS)
+- `roleSetup` functions loses `client` argument.
+- `roleSetup.fetch()` => `roleSetup.list()`
+
+## ❌ V2 Removals
+
+- `lvlRole()` is removed, use `roleSetup.getRoles()` instead. (READ DOCS)

package/lib/src/add.d.ts

@@ -0,0 +1,35 @@
+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/next/functions/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>;
+/**
+ * XP Results
+ * @property {boolean} levelDifference - Whether the user has levelled up or not.
+ */
+export interface XPResult extends UserResult {
+    levelDifference: number;
+}
+/**
+ * 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/next/functions/addxp
+ * @returns {Promise<XPResult>} - 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<XPResult>;

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/next/functions/addlevel
+ * @returns {Promise<UserResult>} - Object of user data on success
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */async function addLevel(e,a,t,l){if(!e)throw new xplogs_1.XpFatal({function:"addLevel()",message:"User ID was not provided"});if(!a)throw new xplogs_1.XpFatal({function:"addLevel()",message:"Guild ID was not provided"});if(isNaN(t))throw new xplogs_1.XpFatal({function:"addLevel()",message:"Level was not provided"});var o=await database_1.db.findOne({collection:"simply-xps",data:{user:e,guild:a}});if(o)return database_1.db.updateOne({collection:"simply-xps",data:{user:e,guild:a}},{collection:"simply-xps",data:{name:l||o?.name||e,user:e,guild:a,level:o.level+t,xp:(0,xp_1.convertFrom)(t+o.level),xp_rate:xp_1.xp.xp_rate}});if(xp_1.xp.auto_create&&l)return database_1.db.createOne({collection:"simply-xps",data:{guild:a,user:e,name:l,level:t,xp:(0,xp_1.convertFrom)(t),xp_rate:xp_1.xp.xp_rate}});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/next/functions/addxp
+ * @returns {Promise<XPResult>} - Object of user data on success.
+ * @throws {XpFatal} - If parameters are not provided correctly.
+ */async function addXP(e,a,t,l){var o;if(!("number"==typeof t||"object"==typeof xp_1.xp&&t.min&&t.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 t&&(t=Math.floor(Math.random()*(t.max-t.min)+t.min)),!e)throw new xplogs_1.XpFatal({function:"addXP()",message:"User ID was not provided"});if(!a)throw new xplogs_1.XpFatal({function:"addXP()",message:"Guild ID was not provided"});let s;if(o=await database_1.db.findOne({collection:"simply-xps",data:{user:e,guild:a}}))s=await database_1.db.updateOne({collection:"simply-xps",data:{user:e,guild:a}},{collection:"simply-xps",data:{user:e,guild:a,name:l||o?.name||e,level:(0,xp_1.convertFrom)(o.xp+t,"xp"),xp:o.xp+t,xp_rate:xp_1.xp.xp_rate}}).catch(e=>{throw new xplogs_1.XpFatal({function:"addXP()",message:e.stack})});else{if(!xp_1.xp.auto_create||!l)throw new xplogs_1.XpFatal({function:"addXP()",message:"User does not exist"});s=await database_1.db.createOne({collection:"simply-xps",data:{guild:a,user:e,name:l,level:(0,xp_1.convertFrom)(t,"xp"),xp:t,xp_rate:xp_1.xp.xp_rate}}).catch(e=>{throw new xplogs_1.XpFatal({function:"addXP()",message:e.stack})})}return l=xplogs_1.XpEvents.eventCallback,(t=o?.level&&s?.level?s.level!==o.level?s.level-o.level:0:0<s?.level?s.level:0)<0&&l?.levelDown&&"function"==typeof l.levelDown&&l.levelDown(s,await xp_1.roleSetup.getRoles(e,a,{includeNextRoles:!0})),0<t&&l?.levelUp&&"function"==typeof l.levelUp&&l.levelUp(s,await xp_1.roleSetup.getRoles(e,a)),{...s,levelDifference:t}}Object.defineProperty(exports,"__esModule",{value:!0}),exports.addXP=exports.addLevel=void 0;const 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,160 @@
+/// <reference types="node" />
+import { SKRSContext2D } from "@napi-rs/canvas";
+import { User } from "../xp";
+export type CompareCardLocales = {
+    level?: string;
+    versus?: string;
+};
+type HexColor = `#${string}` | `0x${string}`;
+/**
+ * @property {URL} background - Background image URL
+ * @property {HexColor} color - Avatar border color
+ * @property {HexColor} centerBar - Center bar color
+ * @property {HexColor} centerBarBg - Center bar background color
+ * @property {string} font - ABSOLUTE FILE PATH
+ * @property {boolean} light - Use light theme
+ */
+export interface CompareCardOptions {
+    background?: URL;
+    color?: HexColor;
+    centerBar?: HexColor;
+    centerBarBg?: HexColor;
+    fallbackFont?: string;
+    font?: string;
+    light?: boolean;
+}
+export type LeaderboardCardLocales = {
+    level?: string;
+    members?: string;
+};
+/**
+ * @property {[HexColor, HexColor]} artworkColors - Gradient colors
+ * @property {URL} artworkImage
+ * @property {[HexColor, HexColor]} borderColors - Gradient colors
+ * @property {HexColor} backgroundColor
+ * @property {URL} backgroundImage
+ * @property {string} primaryFont - ABSOLUTE FILE PATH
+ * @property {boolean} light - Use light theme
+ * @property {[HexColor, HexColor]} rowColors - Even & Odd row colors
+ * @property {number} rowOpacity
+ * @property {string} secondaryFont - ABSOLUTE FILE PATH
+ */
+export interface LeaderboardCardOptions {
+    artworkColors?: [HexColor, HexColor];
+    artworkImage?: URL;
+    borderColors?: [HexColor, HexColor];
+    backgroundColor?: HexColor;
+    backgroundImage?: URL;
+    fallbackFont?: string;
+    light?: boolean;
+    primaryFont?: string;
+    rowColors?: [HexColor, HexColor];
+    rowOpacity?: number;
+    secondaryFont?: string;
+}
+export type RankCardLocales = {
+    level?: string;
+    next_level?: string;
+    xp?: string;
+};
+/**
+ * @property {URL} background - Background image URL
+ * @property {HexColor} color - Avatar border 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;
+    light?: boolean;
+    lvlbar?: HexColor;
+    lvlbarBg?: HexColor;
+    fallbackFont?: string;
+    font?: string;
+}
+export type CardUserOptions = {
+    id: string;
+    username: string;
+    avatarURL: string;
+};
+/**
+ * Generate a simple comparison card
+ * @async
+ * @param {{id: string, name: string}} guild - (id, name)
+ * @param {CardUserOptions} user1 - User 1
+ * @param {CardUserOptions} user2 - User 2
+ * @param {CompareCardOptions?} options - (background, color, legacy, lvlbar, lvlbarBg, font)
+ * @param {CompareCardLocales?} locales - [BETA] Translate the rank card
+ * @link `Documentation` https://simplyxp.js.org/docs/next/functions/compareCard
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>}
+ * @throws {XpFatal} - If parameters are not provided correctly or if the user is not found in the database
+ */
+export declare function compareCard(guild: {
+    id: string;
+    name: string;
+}, user1: CardUserOptions, user2: CardUserOptions, options?: CompareCardOptions, locales?: CompareCardLocales): Promise<{
+    attachment: Buffer;
+    description: string;
+    name: string;
+}>;
+/**
+ * Generate a simple leaderboard card
+ * @async
+ * @param {Array<User>} data - Array of user data
+ * @param {LeaderboardCardOptions?} options - (artworkColor, artworkImage, light)
+ * @param {{name: string, imageURL: string, memberCount: number}?} guildInfo - Guild info
+ * @param {LeaderboardCardLocales?} locales - Locales
+ * @link `Documentation` https://simplyxp.js.org/docs/next/functions/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?: LeaderboardCardOptions, guildInfo?: {
+    name: string;
+    imageURL: string;
+    memberCount?: number;
+}, locales?: LeaderboardCardLocales): Promise<{
+    attachment: Buffer;
+    description: string;
+    name: string;
+}>;
+/**
+ * Generate a simple user rank card
+ * @async
+ * @param {{id: string, name: string}} guild - (id, name)
+ * @param {CardUserOptions} user - (id, username, avatarURL)
+ * @param {RankCardOptions?} options - (background, color, legacy, lvlbar, lvlbarBg, font)
+ * @param {RankCardLocales?} locales - [BETA] Translate the rank card
+ * @link `Documentation` https://simplyxp.js.org/docs/next/functions/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: CardUserOptions, options?: RankCardOptions, locales?: RankCardLocales): Promise<{
+    attachment: Buffer;
+    description: string;
+    name: string;
+}>;
+/**
+ * @private
+ */
+export declare function RoundedBox(ctx: SKRSContext2D, x: number, y: number, width: number, height: number, radius: number, options?: {
+    clip?: boolean;
+    fill?: {
+        color: string;
+        alpha?: number;
+    };
+    roundCorners?: {
+        top?: boolean;
+        bottom?: boolean;
+    };
+    stroke?: {
+        color: string;
+        width: number;
+    };
+}): void;
+export {};

package/lib/src/cards.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * Generate a simple comparison card
+ * @async
+ * @param {{id: string, name: string}} guild - (id, name)
+ * @param {CardUserOptions} user1 - User 1
+ * @param {CardUserOptions} user2 - User 2
+ * @param {CompareCardOptions?} options - (background, color, legacy, lvlbar, lvlbarBg, font)
+ * @param {CompareCardLocales?} locales - [BETA] Translate the rank card
+ * @link `Documentation` https://simplyxp.js.org/docs/next/functions/compareCard
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>}
+ * @throws {XpFatal} - If parameters are not provided correctly or if the user is not found in the database
+ */async function compareCard(e,a,l,o={},t={}){var r,n,i,s,f,d,c;if(!e?.id||!e?.name)throw new xplogs_1.XpFatal({function:"compareCard()",message:"Please provide a guild"});if(!(a?.id&&a?.username&&l?.id&&l?.username))throw new xplogs_1.XpFatal({function:"compareCard()",message:"Please provide two valid users!"});if(!a?.avatarURL.endsWith(".png")&&!a.avatarURL.endsWith(".jpg")&&!a.avatarURL.endsWith(".webp"))throw new xplogs_1.XpFatal({function:"compareCard()",message:"[USER 1] Avatar image must be a png, jpg, or webp"});await(0,xp_1.registerFont)(o?.font||(0,path_1.join)(__dirname,"fonts","Baloo2-ExtraBold.woff2"),"Baloo"),o?.fallbackFont&&await(0,xp_1.registerFont)(o.fallbackFont,"FallbackFont"),t?.level||(t.level="Level"),t?.versus||(t.versus="vs"),s=await(0,canvas_1.loadImage)(o?.background||"https://i.ibb.co/WnfXZjc/clouds.jpg").catch(()=>{throw new xplogs_1.XpFatal({function:"compareCard()",message:"Unable to load background image, is it valid and reachable?"})}),r=await(0,canvas_1.loadImage)(a.avatarURL).catch(()=>{throw new xplogs_1.XpFatal({function:"compareCard()",message:"[USER 1] Unable to load user's AvatarURL, is it valid and reachable?"})}),n=await(0,canvas_1.loadImage)(l.avatarURL).catch(()=>{throw new xplogs_1.XpFatal({function:"compareCard()",message:"[USER 2] Unable to load user's AvatarURL, is it valid and reachable?"})});let p=await xp_1.db.findOne({collection:"simply-xps",data:{guild:e.id,user:a.id}});if(!p){if(!xp_1.xp.auto_create||!l?.username)throw new xplogs_1.XpFatal({function:"compareCard()",message:"[USER 1] User not found in database"});p=await(0,xp_1.create)(a.id,e.id,a.username)}let g=await xp_1.db.findOne({collection:"simply-xps",data:{guild:e.id,user:l.id}});if(!g){if(!xp_1.xp.auto_create||!l?.username)throw new xplogs_1.XpFatal({function:"compareCard()",message:"[USER 2] User not found in database"});g=await(0,xp_1.create)(l.id,e.id,l.username)}return RoundedBox(i=(e=(0,canvas_1.createCanvas)(1080,400)).getContext("2d"),0,0,e.width,e.height,25),i.clip(),i.fillStyle=o?.light?"#ffffff":"#000000",i.fill(),i.globalAlpha=.6,i.drawImage(s,-5,0,1090,400),i.restore(),i.globalAlpha=1,s=o?.color||o?.light?"rgba(0,0,0,0.5)":"rgba(255,255,255,0.5)",f=o?.centerBarBg||o?.light?"rgba(0,0,0,0.4)":"rgba(255,255,255,0.4)",d=t.level+(" "+shortener(p.level,!0)),c=t.level+(" "+shortener(g.level,!0)),i.save(),i.textAlign="center",i.fillStyle="#ffffff",i.shadowColor="#000000",i.shadowBlur=6,i.shadowOffsetX=1,i.shadowOffsetY=1,i.font="40px Baloo, FallbackFont",i.fillText(`${a.username} ${t.versus} `+l.username,540,60),i.restore(),i.save(),i.beginPath(),i.arc(160,200,105,0,2*Math.PI,!0),i.closePath(),i.strokeStyle=s,i.lineWidth=5,i.stroke(),i.beginPath(),i.arc(160,200,100,0,2*Math.PI,!0),i.closePath(),i.clip(),i.fillStyle=s,i.fill(),i.drawImage(r,50,90,220,220),i.restore(),i.save(),i.beginPath(),i.arc(920,200,105,0,2*Math.PI,!0),i.closePath(),i.strokeStyle=s,i.lineWidth=5,i.stroke(),i.beginPath(),i.arc(920,200,100,0,2*Math.PI,!0),i.closePath(),i.clip(),i.fillStyle=s,i.fill(),i.drawImage(n,810,90,220,220),i.restore(),i.save(),i.globalAlpha=1,i.fillStyle="#ffffff",i.textAlign="center",i.font="25px Baloo, FallbackFont",o?.light&&(i.shadowColor="#000000",i.shadowBlur=5,i.shadowOffsetX=1,i.shadowOffsetY=1),i.fillText(d,160,350),i.fillText(c,920,350),i.restore(),i.save(),i.globalAlpha=1,RoundedBox(i,265,330,540,25,10),i.clip(),i.fillStyle=f,i.fill(),i.fillStyle="#ffffff",i.textAlign="center",i.font="22px Baloo, FallbackFont",i.fillText((p.xp>g.xp?"+":"-")+Math.abs(p.level-g.level),540,350),xp_1.xp.auto_clean&&(0,xp_1.clean)(),{attachment:e.toBuffer("image/png"),description:"Simply-XP Comparison Card",name:"compareCard.png"}}
+/**
+ * Generate a simple leaderboard card
+ * @async
+ * @param {Array<User>} data - Array of user data
+ * @param {LeaderboardCardOptions?} options - (artworkColor, artworkImage, light)
+ * @param {{name: string, imageURL: string, memberCount: number}?} guildInfo - Guild info
+ * @param {LeaderboardCardLocales?} locales - Locales
+ * @link `Documentation` https://simplyxp.js.org/docs/next/functions/leaderboard
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>}
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */async function leaderboardCard(a,e={},l,o={}){var t,r,n,i,s,f;if(!a||a.length<1)throw new xplogs_1.XpFatal({function:"leaderboardCard()",message:"There must be at least 1 user in the data array"});let d=void 0,c=void 0,p,g=(e?.artworkImage&&(d=await(0,canvas_1.loadImage)(e.artworkImage).catch(()=>{throw new xplogs_1.XpFatal({function:"leaderboardCard()",message:"Unable to load artwork image, is it valid?"})})),e?.backgroundImage&&(c=await(0,canvas_1.loadImage)(e.backgroundImage).catch(()=>{throw new xplogs_1.XpFatal({function:"leaderboardCard()",message:"Unable to load background image, is it valid?"})})),await(0,xp_1.registerFont)(e?.primaryFont||(0,path_1.join)(__dirname,"fonts","Baloo2-ExtraBold.woff2"),"Baloo"),e?.secondaryFont&&await(0,xp_1.registerFont)(e.secondaryFont,"SecondaryFont"),e?.fallbackFont&&await(0,xp_1.registerFont)(e.fallbackFont,"FallbackFont"),o.level||(o.level="LEVEL"),o.members||(o.members="Members"),a=a.slice(0,8),t=e?.secondaryFont?"SecondaryFont, FallbackFont":"Baloo, FallbackFont",p=e?.light?{artworkColors:e?.artworkColors||["#997fe1","#616bff"],backgroundColor:"#FFFFFF",borderColors:e?.borderColors||["#e0d440","#fffa6b"],evenColor:"#f0f0f0",oddColor:"#dcdcdc",primaryTextColor:"#000000",secondaryTextColor:"rgba(0,0,0,0.5)"}:{artworkColors:e?.artworkColors||["#6B46D4","#2e3cff"],backgroundColor:"#141414",borderColors:e?.borderColors||["#e0d440","#fffa6b"],evenColor:"#1e1e1e",oddColor:"#282828",primaryTextColor:"#ffffff",secondaryTextColor:"rgba(255,255,255,0.5)"},RoundedBox(n=(r=(0,canvas_1.createCanvas)(1350,1080)).getContext("2d"),0,0,r.width,r.height,20,{clip:!0}),(i=n.createLinearGradient(0,0,r.width,0)).addColorStop(.4,p.artworkColors[0]),i.addColorStop(1,p.artworkColors[1]),n.fillStyle=i,n.fillRect(0,0,r.width,220),d&&(n.fillStyle="#000000",n.fillRect(0,0,r.width,220),n.globalAlpha=.5,n.drawImage(d,0,0,r.width,220),n.globalAlpha=1),n.fillStyle=e.backgroundColor||p.backgroundColor,n.fillRect(0,220,r.width,1080),c&&(n.globalAlpha=.9,n.drawImage(c,0,220,r.width,1080),n.globalAlpha=1),l&&l?.imageURL&&l?.name&&(i=await(0,canvas_1.loadImage)(l.imageURL),n.save(),n.beginPath(),n.arc(150,110,90,0,2*Math.PI,!0),n.closePath(),n.clip(),n.drawImage(i,60,20,180,180),n.restore(),(i=n.createLinearGradient(0,0,0,220)).addColorStop(0,p.borderColors[0]),i.addColorStop(1,p.borderColors[1]),n.strokeStyle=i,n.lineWidth=8,n.beginPath(),n.arc(150,110,90,0,2*Math.PI,!0),n.stroke(),n.fillStyle=p.primaryTextColor,n.font="60px Baloo, FallbackFont",l?.memberCount?(n.fillText(l.name,270,110),n.fillStyle=p.secondaryTextColor,n.font="40px Baloo, FallbackFont",n.fillText(l.memberCount+" "+o.members,270,160)):n.fillText(l.name,270,130)),p.evenColor);s=e?.rowOpacity&&!isNaN(e?.rowOpacity)?e.rowOpacity:c?.5:1;for(let e=0;e<a.length;e++)f=300+90*e,n.globalAlpha=s,n.save(),1===a.length?RoundedBox(n,30,f,1290,90,20,{clip:!0,fill:{color:g}}):0===e?RoundedBox(n,30,f,1290,90,20,{clip:!0,fill:{color:g},roundCorners:{top:!0,bottom:!1}}):e===a.length-1?RoundedBox(n,30,f,1290,90,20,{clip:!0,fill:{color:g},roundCorners:{top:!1,bottom:!0}}):RoundedBox(n,30,f,1290,90,0,{fill:{color:g}}),n.restore(),n.globalAlpha=1,n.textAlign="left",n.font="30px "+t,n.fillStyle=p.secondaryTextColor,n.fillText(e+1+".",60,55+f),n.textAlign="left",n.font="40px "+t,n.fillStyle=p.primaryTextColor,n.fillText(a[e]?.name||a[e]?.user||"???",120,60+f),n.textAlign="right",n.font="30px "+t,n.fillStyle=p.primaryTextColor,n.fillText(shortener(a[e]?.level)||"???",1270,55+f),n.fillStyle=p.secondaryTextColor,n.fillText(o.level,1270-n.measureText(shortener(a[e]?.level)||"???").width-15,55+f),g=g===p.evenColor?p.oddColor:p.evenColor;return xp_1.xp.auto_clean&&(0,xp_1.clean)(),{attachment:r.toBuffer("image/png"),description:"Simply-XP Leaderboard Card",name:"leaderboard.png"}}
+/**
+ * Generate a simple user rank card
+ * @async
+ * @param {{id: string, name: string}} guild - (id, name)
+ * @param {CardUserOptions} user - (id, username, avatarURL)
+ * @param {RankCardOptions?} options - (background, color, legacy, lvlbar, lvlbarBg, font)
+ * @param {RankCardLocales?} locales - [BETA] Translate the rank card
+ * @link `Documentation` https://simplyxp.js.org/docs/next/functions/rankCard
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>}
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */async function rankCard(e,a,l={},o={}){var t,r,n,i,s,f,d,c,p,g,h,x;if(!e)throw new xplogs_1.XpFatal({function:"rankCard()",message:"No Guild Provided"});if(!a)throw new xplogs_1.XpFatal({function:"rankCard()",message:"No User Provided"});if(o?.level||(o.level="Level"),o?.next_level||(o.next_level="Next Level"),o?.xp||(o.xp="XP"),xplogs_1.XpLog.debug("rankCard()",`${l?.legacy?"LEGACY":"MODERN"} ENABLED`),!a||!a.id||!a.username)throw new xplogs_1.XpFatal({function:"rankCard()",message:"Invalid User Provided, user must contain id, username, and avatarURL."});await(0,xp_1.registerFont)(l?.font||(0,path_1.join)(__dirname,"fonts","Baloo2-ExtraBold.woff2"),"Baloo"),l?.fallbackFont&&await(0,xp_1.registerFont)(l.fallbackFont,"FallbackFont"),i=await(0,canvas_1.loadImage)(l?.background||(l?.legacy?"https://i.ibb.co/dck2Tnt/rank-card.webp":"https://i.ibb.co/WnfXZjc/clouds.jpg")).catch(()=>{throw new xplogs_1.XpFatal({function:"rankCard()",message:"Unable to load background image, is it valid and reachable?"})}),t=await(0,canvas_1.loadImage)(a.avatarURL).catch(()=>{throw new xplogs_1.XpFatal({function:"rankCard()",message:"Unable to load user's AvatarURL, is it valid and reachable??"})});let b=await xp_1.db.findOne({collection:"simply-xps",data:{guild:e.id,user:a.id}});if(!b){if(!xp_1.xp.auto_create)throw new xplogs_1.XpFatal({function:"rankCard()",message:"User not found in database"});b=await(0,xp_1.create)(a.id,e.id,a.username)}return r=await xp_1.db.find({collection:"simply-xps",data:{guild:e.id}}),b.position=1+r.sort((e,a)=>a.xp-e.xp).findIndex(e=>e.user===a.id)||1,(n=(r=(0,canvas_1.createCanvas)(1080,400)).getContext("2d")).save(),RoundedBox(n,0,0,r.width,r.height,25),n.clip(),n.fillStyle=l?.light?"#ffffff":"#000000",n.fill(),n.globalAlpha=l?.legacy?.8:.6,n.drawImage(i,-5,0,1090,400),n.restore(),i=l?.color||(l?.legacy?"#9900ff":l?.light?"rgba(0,0,0,0.5)":"rgba(255,255,255,0.5)"),s=l?.lvlbar||"#ffffff",f=l?.lvlbarBg||l?.legacy?"#FFFFFF":l?.light?"rgba(0,0,0,0.2)":"rgba(255,255,255,0.2)",d=shortener(b.xp)+(" "+o.xp),c=o.level+(" "+shortener(b.level)),p="{current} / {needed}",g=(0,xp_1.convertFrom)(b.level+1),h=(0,xp_1.convertFrom)(b.level),h=100*(b.xp-h)/(g-h)*(l?.legacy?660:530)/100,x="326815959358898189"===b.user?"#ade6d8":1===b.position?"#ADD8E6":2===b.position?"#C0C0C0":3===b.position?"#CD7F32":"#ffffff",l?.legacy?(n.save(),n.globalAlpha=.4,n.fillStyle=l?.light?"#ffffff":"#000000",n.fillRect(40,0,240,r.height),n.restore(),n.save(),RoundedBox(n,70,30,180,180,50,{clip:!0,fill:{color:i}}),RoundedBox(n,75,35,170,170,50,{clip:!0}),n.drawImage(t,70,30,180,180),n.restore(),n.save(),RoundedBox(n,70,320,180,50,20,{clip:!0}),n.fillStyle=i,n.fillRect(70,320,180,50),n.fillStyle="#ffffff",dynamicFont(n,d,160,358,160,32),n.restore(),n.save(),RoundedBox(n,70,240,180,50,20,{clip:!0}),n.fillStyle=i,n.fillRect(70,240,180,50),n.fillStyle="#ffffff",n.textAlign="center",dynamicFont(n,c,160,278,160,32),n.restore(),n.save(),n.textAlign="left",n.fillStyle="#ffffff",n.shadowColor="#000000",n.shadowBlur=15,n.shadowOffsetX=1,n.shadowOffsetY=1,n.font="39px Baloo, FallbackFont",n.fillText(a.username,395,80),n.restore(),n.save(),n.textAlign="right",n.fillStyle="#ffffff",n.shadowColor="#000000",n.shadowBlur=15,n.shadowOffsetX=1,n.shadowOffsetY=1,n.font="55px Baloo, FallbackFont",n.fillText("#"+b.position,r.width-55,80),n.restore(),n.save(),RoundedBox(n,390,305,660,70,20,{clip:!0}),n.fillStyle="#ffffff",dynamicFont(n,e.name,720,355,700,45),n.globalAlpha=.2,n.fillRect(390,305,660,70),n.restore(),n.save(),RoundedBox(n,390,145,660,50,20,{clip:!0}),n.fillStyle=f,n.globalAlpha=.2,n.fillRect(390,145,660,50),n.restore(),n.save(),RoundedBox(n,390,145,h,50,20,{clip:!0}),n.fillStyle=s,n.globalAlpha=.5,n.fillRect(390,145,h,50),n.restore(),n.save(),n.textAlign="left",n.fillStyle="#ffffff",n.globalAlpha=.8,n.font="30px Baloo, FallbackFont",n.fillText(o.next_level+": "+shortener(g)+" "+o.xp,390,230),n.restore(),d=p.replace(/{needed}/g,shortener(g)).replace(/{current}/g,shortener(b.xp)),n.textAlign="center",n.fillStyle="#474747",n.globalAlpha=1,n.font="30px Baloo, FallbackFont",n.fillText(d,730,180)):(n.save(),n.textAlign="center",n.fillStyle="#ffffff",n.shadowColor="#000000",n.shadowBlur=5,n.shadowOffsetX=1,n.shadowOffsetY=1,n.font="40px Baloo, FallbackFont",n.fillText(a.username,540,80),n.restore(),n.save(),n.beginPath(),n.arc(160,200,105,0,2*Math.PI,!0),n.closePath(),n.lineWidth=5,n.strokeStyle=i,n.stroke(),n.beginPath(),n.arc(160,200,100,0,2*Math.PI,!0),n.closePath(),n.clip(),n.fillStyle=i,n.fill(),n.drawImage(t,50,90,220,220),n.restore(),n.save(),n.beginPath(),n.arc(230,130,30,0,2*Math.PI,!0),n.closePath(),n.strokeStyle=i,n.lineWidth=5,n.stroke(),n.beginPath(),n.arc(230,130,30,0,2*Math.PI,!0),n.closePath(),n.fillStyle=x,n.fill(),n.clip(),n.fillStyle="#000000",dynamicFont(n,shortener(b.position,!0),230,138,45,30),n.restore(),n.save(),n.fillStyle="#ffffff",l?.light&&(n.shadowColor="#000000",n.shadowBlur=5,n.shadowOffsetX=1,n.shadowOffsetY=1),n.textAlign="center",n.font="25px Baloo, FallbackFont",n.fillText(c,160,350),n.restore(),n.save(),RoundedBox(n,265,330,540,25,10,{clip:!0,fill:{color:f}}),RoundedBox(n,270,335,h,15,5,{clip:!0,fill:{color:s}}),n.restore(),n.save(),n.textAlign="center",n.fillStyle=l?.light?"rgba(0,0,0,0.6)":"rgba(255,255,255,0.6)",n.font="22px Baloo, FallbackFont",n.fillText(p.replace(/{needed}/g,shortener(g)).replace(/{current}/g,shortener(b.xp)),540,320),n.save(),n.fillStyle="#ffffff",n.textAlign="center",l?.light&&(n.shadowColor="#000000",n.shadowBlur=5,n.shadowOffsetX=1,n.shadowOffsetY=1),n.font="25px Baloo, FallbackFont",n.fillText(o.level+" "+shortener(b.level+1),920,350),n.restore()),xp_1.xp.auto_clean&&(0,xp_1.clean)(),{attachment:r.toBuffer("image/png"),description:"Simply-XP Rank Card",name:"rank.png"}}function RoundedBox(e,a,l,o,t,r,n){var i=n?.roundCorners||{top:!0,bottom:!0};e.beginPath(),e.moveTo(a+(i.top?r:0),l),e.lineTo(a+o-(i.top?r:0),l),i.top&&e.quadraticCurveTo(a+o,l,a+o,l+r),e.lineTo(a+o,l+t-(i.bottom?r:0)),i.bottom&&e.quadraticCurveTo(a+o,l+t,a+o-r,l+t),e.lineTo(a+(i.bottom?r:0),l+t),i.bottom&&e.quadraticCurveTo(a,l+t,a,l+t-r),e.lineTo(a,l+(i.top?r:0)),i.top&&e.quadraticCurveTo(a,l,a+r,l),e.closePath(),n?.fill&&(n?.clip&&e.clip(),n.fill?.color&&(e.fillStyle=n.fill.color),n.fill?.alpha&&(e.globalAlpha=n.fill.alpha),e.fillRect(a,l,o,t)),n?.stroke&&(n.stroke?.color&&(e.strokeStyle=n.stroke.color),n.stroke?.width&&(e.lineWidth=n.stroke.width),e.stroke()),n?.clip&&e.clip()}function shortener(e,a){let l="",o=0;if(!e||0===e)return"0";if(e>Number.MAX_SAFE_INTEGER)return"∞";for(;1e3<=e&&o<8;)e/=1e3,o++;switch(o){case 0:l="";break;case 1:l="K";break;case 2:l="M";break;case 3:l="B";break;case 4:l="T";break;case 5:l="Qa";break;case 6:l="Qi";break;default:l="S+"}return""+e.toFixed(0===o||a?0:2)+l}function dynamicFont(e,a,l,o,t,r){let n=r;for(;0<n&&(e.font=n+"px Baloo, FallbackFont",!(e.measureText(a).width<t));)n--;e.textAlign="center",e.fillText(a,l,o)}Object.defineProperty(exports,"__esModule",{value:!0}),exports.RoundedBox=exports.rankCard=exports.leaderboardCard=exports.compareCard=void 0;const canvas_1=require("@napi-rs/canvas"),xp_1=require("../xp"),xplogs_1=require("./functions/xplogs"),path_1=require("path");exports.compareCard=compareCard,exports.leaderboardCard=leaderboardCard,exports.rankCard=rankCard,exports.RoundedBox=RoundedBox;

package/lib/src/charts.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="node" />
+/**
+ * Chart options
+ * @property {string} font - Font of the chart
+ * @property {"blue" | "dark" | "discord" | "green" | "orange" | "red" | "space" | "yellow"} theme - Theme of the chart
+ * @property {number} limit - Limit of users to return (2-10)
+ */
+export interface ChartOptions {
+    fallbackFont?: string;
+    font?: string;
+    limit?: 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
+    theme?: "blue" | "dark" | "discord" | "green" | "orange" | "red" | "space" | "yellow";
+    type?: "bar" | "doughnut" | "pie";
+}
+/**
+ * Creates a chart
+ * @async
+ * @param {string} guildId
+ * @param {ChartOptions?} options
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/functions/charts
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>} Chart attachment
+ * @throws {XpFatal} If invalid parameters are provided, or if there are not enough users to create a chart
+ */
+export declare function charts(guildId: string, options?: ChartOptions): Promise<{
+    attachment: Buffer;
+    description: string;
+    name: string;
+}>;

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/next/functions/charts
+ * @returns {Promise<{attachment: Buffer, description: string, name: string}>} Chart attachment
+ * @throws {XpFatal} If invalid parameters are provided, or if there are not enough users to create a chart
+ */async function charts(e,r={}){var t,a,o,F,l,i,n,s,h;if(!e)throw new xplogs_1.XpFatal({function:"charts()",message:"No Guild ID Provided"});if(!r)throw new xplogs_1.XpFatal({function:"charts()",message:"No Options Provided"});r.theme&&["blue","dark","discord","green","orange","red","space","yellow"].includes(r.theme)||(xplogs_1.XpLog.warn("charts()","Invalid theme provided, defaulting to discord"),r.theme="discord"),r.type&&["bar","doughnut","pie"].includes(r.type)||(xplogs_1.XpLog.warn("charts()","Invalid type provided, defaulting to bar chart"),r.type="bar");let c;if((t=await(0,xp_1.leaderboard)(e,Math.min(Math.max(r?.limit||10,2),10)).catch(e=>{throw new xplogs_1.XpFatal({function:"charts()",message:e.message})})).length<2)throw new xplogs_1.XpFatal({function:"charts()",message:"Not enough users to create a chart"});switch(t.sort((e,t)=>t.position-e.position),await(0,xp_1.registerFont)(r?.font||(0,path_1.join)(__dirname,"fonts","Baloo2-ExtraBold.woff2"),"Baloo"),r.fallbackFont&&await(0,xp_1.registerFont)(r.fallbackFont,"FallbackFont"),r.theme){case"blue":c={background:"#1e1e3c",barColor:"#747fff",pieColors:["#747fff","#2832C2","#59788E","#00d2e7","#281E5D","#a9f5ff","#000e3f","#30edc2","#186c84","#0098ff"],textColor:"#FFFFFF"};break;case"dark":c={background:"#1e1e1e",barColor:"#747474",pieColors:["#1B1D1F","#454C53","#72787F","#999999","#9EA4AA","#CCCCCC","#C9CDD2","#DEDEDE","#E8EBED","#FFFFFF"],textColor:"#FFFFFF"};break;case"discord":c={background:"#36393f",barColor:"#5865F2",pieColors:["#5865F2","#57F287","#FEE75C","#EB459E","#ED4245","#FFFFFF","#000000","#FAA61A","#C04DF9","#00AAFF"],textColor:"#FFFFFF"};break;case"green":c={background:"#1e321e",barColor:"#74ff7f",pieColors:["#00FF00","#008000","#7FFF00","#32CD32","#228B22","#006400","#9ACD32","#00FA9A","#ADFF2F","#7CFC00"],textColor:"#FFFFFF"};break;case"orange":c={background:"#321e1e",barColor:"#ff9f74",pieColors:["#FF8C00","#FF5E0E","#FF4500","#FF6347","#E26310","#F5761A","#FD673A","#FFA500","#FF7F50","#FFD700"],textColor:"#FFFFFF"};break;case"red":c={background:"#321e1e",barColor:"#ff7474",pieColors:["#FF0000","#FF2400","#FF4500","#FF6347","#FF7F50","#FF8C00","#FFA07A","#FFA500","#FFC0CB","#FFD700"],textColor:"#FFFFFF"};break;case"space":c={background:"#001F3F",barColor:"#192E5B",pieColors:["#192E5B","#1F3F7F","#264FA3","#2C5FC7","#337FEA","#3D8FFF","#4D9FFF","#5DAFFF","#6DBFFF","#7DCFFF"],textColor:"#FFFFFF"};break;case"yellow":c={background:"#32321e",barColor:"#ffff74",pieColors:["#FFFD37","#FFEF00","#FDFF00","#DAA520","#F4C430","#E4D00A","#D2B55B","#FFFFE0","#FFFACD","#F5DEB3"],textColor:"#FFFFFF"}}const d=(0,canvas_1.createCanvas)(920,600),p=d.getContext("2d"),f=Math.max(...t.map(e=>e.level));if((0,cards_1.RoundedBox)(p,0,0,d.width,d.height,25,{clip:!0}),p.fillStyle=c.background,p.fillRect(0,0,d.width,d.height),"space"===r.theme){(e=p.createRadialGradient(d.width/2,d.height/2,1,d.width/2,d.height/2,Math.max(d.width,d.height))).addColorStop(0,"#000000"),e.addColorStop(1,"#001F3F"),p.fillStyle=e,p.fillRect(0,0,d.width,d.height),(e=p.createRadialGradient(150,150,10,150,150,100)).addColorStop(0,"#F2F2F2"),e.addColorStop(.8,"#D3D3D3"),e.addColorStop(1,"#001F3F"),p.fillStyle=e,p.beginPath(),p.arc(150,150,100,0,2*Math.PI),p.fill(),a=["#6B6B6B","#AA8F00","#473E83","#456579"];for(let e=0;e<a.length;e++)o=Math.random()*d.width,F=Math.random()*d.height,l=50*Math.random()+30,p.beginPath(),p.arc(o,F,l,0,2*Math.PI),p.fillStyle=a[e]||"#FFFFFF",p.fill();p.filter="blur(5px)",p.drawImage(d,0,0),p.filter="none";for(let e=0;e<100;e++)i=Math.random()*d.width,n=Math.random()*d.height,s=2*Math.random(),p.beginPath(),p.arc(i,n,s,0,2*Math.PI),p.fillStyle="#FFFFFF",p.fill()}let g=d.width-40,C=d.height-40;switch(r.type){case"bar":{h=p.measureText(f.toString()).width,g=d.width-h-100,C=d.height-140;const u=g/t.length-20,b=h+60,m=d.height-70;await Promise.all(t.map(async(e,t)=>{var a,o=(e.level===1/0?1:e.level/f)*C,t=b+t*(20+u),F=m-o,o=(p.save(),(0,cards_1.RoundedBox)(p,t,F,u,o,10,{clip:!0,fill:{color:c.barColor}}),p.restore(),t+u/2),t=(p.fillStyle=c.textColor,p.font="22px Baloo, FallbackFont",e.level.toString()),l=p.measureText(t).width,F=F-10,t=(p.fillText(t,o-l/2,F),e?.name||e.user),l=p.measureText(t).width,F=(p.font=Math.min(Math.floor(u/l*16),18)+"px Baloo, FallbackFont",l=p.measureText(t).width,30+m);"space"===r.theme&&(a=o-(e=l+20)/2,p.fillStyle="rgba(0, 0, 0, 0.5)",p.fillRect(a,F-18,e,25)),p.fillStyle=c.textColor,p.fillText(t,o-l/2,F)}))}break;case"doughnut":{const x=t.reduce((e,t)=>e+t.level,0),w=Math.min(g,C)/3,D=.6*w;let a=-Math.PI/2;const v=d.width/2,y=d.height/2;await Promise.all(t.map(async(e,t)=>{e=a+2*Math.PI*(e.level/x),p.fillStyle=c.pieColors[t%c.pieColors.length]||"#FFFFFF",p.beginPath(),p.moveTo(v+w*Math.cos(a),y+w*Math.sin(a)),p.arc(v,y,w,a,e),p.lineTo(v+D*Math.cos(e),y+D*Math.sin(e)),p.arc(v,y,D,e,a,!0),p.closePath(),p.fill(),a=e}))}break;case"pie":{const k=t.reduce((e,t)=>e+t.level,0),A=Math.min(g,C)/3;let a=-Math.PI/2;const E=d.width/2,M=d.height/2;await Promise.all(t.map(async(e,t)=>{e=a+2*Math.PI*(e.level/k),p.fillStyle=c.pieColors[t%c.pieColors.length]||"#FFFFFF",p.beginPath(),p.moveTo(E,M),p.arc(E,M,A,a,e),p.closePath(),p.fill(),a=e}))}break;default:throw new xplogs_1.XpFatal({function:"charts()",message:"Invalid chart type provided"})}if(["doughnut","pie"].includes(r.type)){const _=d.height-20-20*t.length;p.fillStyle="rgba(0,0,0,0.25)",p.fillRect(15,_-5,200,20*t.length+5),p.font="12px Baloo, FallbackFont",await Promise.all(t.map(async(e,t)=>{var a=c.pieColors[t%c.pieColors.length],t=_+20*t;p.fillStyle=a||"#FFFFFF",p.fillRect(20,t,15,15),p.fillStyle=c.textColor,p.fillText(e?.name||e.user,40,11.5+t)}))}return xp_1.xp.auto_clean&&(0,xp_1.clean)(),{attachment:d.toBuffer("image/png"),description:"Chart",name:"chart.png"}}Object.defineProperty(exports,"__esModule",{value:!0}),exports.charts=void 0;const xp_1=require("../xp"),canvas_1=require("@napi-rs/canvas"),path_1=require("path"),cards_1=require("./cards"),xplogs_1=require("./functions/xplogs");exports.charts=charts;

package/lib/src/connect.d.ts

@@ -0,0 +1,29 @@
+export type ConnectionOptions = {
+    auto_clean?: boolean;
+    auto_create?: boolean;
+    debug?: boolean;
+    notify?: boolean;
+    type: "mongodb" | "sqlite" | undefined;
+    xp_rate?: "slow" | "normal" | "fast" | number;
+};
+/**
+ * Connect to a database (MongoDB, SQLite)
+ *
+ * @async
+ * @param {string} uri
+ * @param {ConnectionOptions} options
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/functions/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>;
+/**
+ * Check database package versions
+ * @private
+ * @param {string} type - NPM Package Name (lowercase)
+ * @param {number} min - Minimum Major Version Number
+ * @param {number} max - Maximum Major Version Number (Optional)
+ * @returns {Promise<boolean>}
+ * @throws {XpFatal} If the package version is not supported
+ */
+export declare function checkPackageVersion(type: string, min: number, max?: number): Promise<boolean>;

package/lib/src/connect.js

@@ -0,0 +1,43 @@
+"use strict";
+/**
+ * Connect to a database (MongoDB, SQLite)
+ *
+ * @async
+ * @param {string} uri
+ * @param {ConnectionOptions} options
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/functions/connect
+ * @returns {Promise<boolean>}
+ * @throws {XpFatal} If an invalid type is provided or if the value is not provided.
+ */
+async function connect(e,t={type:void 0}){var a,{type:o,auto_create:n,auto_clean:r,notify:s,debug:c,xp_rate:i}=t;if(!i||"slow"!==i&&"normal"!==i&&"fast"!==i&&isNaN(i)||(xp_1.xp.xp_rate="slow"===i?.05:"normal"===i?.1:"fast"===i?.5:i),!e)throw new xplogs_1.XpFatal({function:"connect()",message:"No URI Provided"});switch(!1===s&&(xp_1.xp.notify=!1),n&&(xp_1.xp.auto_create=!0),r&&(xp_1.xp.auto_clean=!0),c&&(xp_1.xp.debug=!0),o||(t.type="mongodb",xplogs_1.XpLog.warn("connect()","Database type not provided, defaulting to MongoDB")),o){case"mongodb":if(a=(await Promise.resolve().then(()=>__importStar(require("mongodb")))).MongoClient,!await checkPackageVersion("mongodb",3,6))return xplogs_1.XpLog.err("connect()","MongoDB Version 3 to 6 is required");a=await a.connect(e).catch(e=>{throw new xplogs_1.XpFatal({function:"connect()",message:e.message})}),xp_1.xp.dbType="mongodb",xp_1.xp.database=a||void 0;break;case"sqlite":try{var[p,l]=await Promise.all([Promise.resolve().then(()=>__importStar(require("better-sqlite3"))),checkPackageVersion("better-sqlite3",7,9)]);if(!l)return xplogs_1.XpLog.err("connect()","better-sqlite3 Version 7 to 9 is required");xp_1.xp.database=new p.default(e),xp_1.xp.dbType="sqlite",xp_1.xp.database.exec(`CREATE TABLE IF NOT EXISTS "simply-xps"
+                              (
+                                  user        TEXT    NOT NULL,
+                                  guild       TEXT    NOT NULL,
+                                  name        TEXT    NOT NULL DEFAULT user,
+                                  level       INTEGER NOT NULL DEFAULT 0,
+                                  xp          INTEGER NOT NULL DEFAULT 0,
+                                  voice_xp    INTEGER          DEFAULT 0,
+                                  voice_time  INTEGER          DEFAULT 0,
+                                  lastUpdated DATE    NOT NULL,
+                                  xp_rate     INTEGER          DEFAULT 0.1
+                              )`),xp_1.xp.database.exec(`CREATE TABLE IF NOT EXISTS "simply-xp-levelroles"
+                              (
+                                  gid         TEXT NOT NULL,
+                                  lvlrole     TEXT NOT NULL,
+                                  lastUpdated TEXT NOT NULL
+                              )`)}catch(e){if("object"==typeof e&&null!==e&&void 0!==(a=e).code&&"MODULE_NOT_FOUND"!==a.code)throw new xplogs_1.XpFatal({function:"connect()",message:a.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!"),r&&(0,xp_1.clean)({db:!0}),await xp_1.db.findAll("simply-xps").then(e=>{e.filter(e=>e?.xp_rate!==xp_1.xp.xp_rate).map(e=>{xp_1.db.updateOne({collection:"simply-xps",data:{user:e.user,guild:e.guild}},{collection:"simply-xps",data:{user:e.user,guild:e.guild,level:(0,xp_1.convertFrom)(e.xp,"xp"),xp:e.xp,xp_rate:xp_1.xp.xp_rate}})})}),xplogs_1.XpLog.debug("connect()","UPDATED ALL USERS WITH NEW XP RATE"),!0)}
+/**
+ * Returns the package manager used
+ * @private
+ * @returns {Promise<"yarn" | "npm" | "pnpm">}
+ */
+async function getPackageManager(){const t=(await Promise.resolve().then(()=>__importStar(require("fs")))).existsSync;var e=["yarn.lock","pnpm-lock.yaml","pnpm-lock.json","package-lock.json"].filter(e=>t(e));if(1===e.length){if("yarn.lock"===e[0])return xplogs_1.XpLog.debug("getPackageManager()","Using YARN"),"yarn";if("pnpm-lock.yaml"===e[0]||"pnpm-lock.json"===e[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 {string} type - NPM Package Name (lowercase)
+ * @param {number} min - Minimum Major Version Number
+ * @param {number} max - Maximum Major Version Number (Optional)
+ * @returns {Promise<boolean>}
+ * @throws {XpFatal} If the package version is not supported
+ */async function checkPackageVersion(t,a,o){try{var e=await Promise.resolve(t+"/package.json").then(e=>__importStar(require(e)));return parseInt(e.version.substring(0,1))>=a&&(!o||parseInt(e.version.substring(0,1))<=o)}catch(e){return xplogs_1.XpLog.info("checkPackageVersion()",`Installing ${t} [V${o||a}] | Please wait...`),(0,child_process_1.execSync)(await getPackageManager()+` add ${t}@${o||a}.x.x`),xplogs_1.XpLog.warn("checkPackageVersion()",`Installed ${t}. Please restart!`),process.exit(1)}}var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,a,o){void 0===o&&(o=a);var n=Object.getOwnPropertyDescriptor(t,a);n&&("get"in n?t.__esModule:!n.writable&&!n.configurable)||(n={enumerable:!0,get:function(){return t[a]}}),Object.defineProperty(e,o,n)}:function(e,t,a,o){e[o=void 0===o?a:o]=t[a]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){var t,a;if(e&&e.__esModule)return e;if(t={},null!=e)for(a in e)"default"!==a&&Object.prototype.hasOwnProperty.call(e,a)&&__createBinding(t,e,a);return __setModuleDefault(t,e),t};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/next/functions/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,12 @@
+"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/next/functions/create
+ * @returns {Promise<UserResult>}
+ * @throws {XpFatal} If invalid parameters are provided
+ */
+async function create(e,t,r){if(!e)throw new xplogs_1.XpFatal({function:"create()",message:"User ID was not provided"});if(!t)throw new xplogs_1.XpFatal({function:"create()",message:"Guild ID was not provided"});var a;if(r)return await(a=(await Promise.resolve().then(()=>__importStar(require("./functions/database")))).db).findOne({collection:"simply-xps",data:{user:e,guild:t}})||a.createOne({collection:"simply-xps",data:{name:r,user:e,guild:t,level:0,xp:0,xp_rate:xp_1.xp.xp_rate}});throw new xplogs_1.XpFatal({function:"create()",message:"Username was not provided"})}var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,a){void 0===a&&(a=r);var i=Object.getOwnPropertyDescriptor(t,r);i&&("get"in i?t.__esModule:!i.writable&&!i.configurable)||(i={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,a,i)}:function(e,t,r,a){e[a=void 0===a?r:a]=t[r]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){var t,r;if(e&&e.__esModule)return e;if(t={},null!=e)for(r in e)"default"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&__createBinding(t,e,r);return __setModuleDefault(t,e),t};Object.defineProperty(exports,"__esModule",{value:!0}),exports.create=void 0;const xplogs_1=require("./functions/xplogs"),xp_1=require("../xp");exports.create=create;

package/lib/src/fetch.d.ts

@@ -0,0 +1,12 @@
+import { User } from "../xp";
+/**
+ * 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/next/functions/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/next/functions/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(t,e,r){var i;if(!t)throw new xplogs_1.XpFatal({function:"create()",message:"User ID was not provided"});if(!e)throw new xplogs_1.XpFatal({function:"create()",message:"Guild ID was not provided"});(0,xp_1.clean)({db:!0});let n=(i=await(await Promise.resolve().then(()=>__importStar(require("./functions/database")))).db.find({collection:"simply-xps",data:{guild:e}})).find(e=>e.user===t);if(!n){if(!xp_1.xp.auto_create||!r)throw new xplogs_1.XpFatal({function:"fetch()",message:"User data not found"});n=await(await Promise.resolve().then(()=>__importStar(require("./create")))).create(e,t,r)}return e=i.sort((e,t)=>t.xp-e.xp).findIndex(e=>e.user===t)+1,{name:n?.name,user:n.user,guild:n.guild,level:n.level,position:e,xp:n.xp}}var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var n=Object.getOwnPropertyDescriptor(t,r);n&&("get"in n?t.__esModule:!n.writable&&!n.configurable)||(n={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,n)}:function(e,t,r,i){e[i=void 0===i?r:i]=t[r]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){var t,r;if(e&&e.__esModule)return e;if(t={},null!=e)for(r in e)"default"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&__createBinding(t,e,r);return __setModuleDefault(t,e),t};Object.defineProperty(exports,"__esModule",{value:!0}),exports.fetch=void 0;const xplogs_1=require("./functions/xplogs"),xp_1=require("../xp");exports.fetch=fetch;