simply-xp 2.0.0-dev.0-fix.2 → 2.0.0-dev.2

package/README.md

@@ -41,10 +41,10 @@ yarn add simply-xp@dev
 # ✅ V2 Additions
 
 - Added support for `SQLite` database
-- Added `auto_purge` + `debug` option for `connect()` function
+- Added `debug`, `auto_create`, `auto_purge` options for `connect()` function
 - Added `db` class for extended database functionality
 - Added `leaderboardCard()` function
-- Added `convert()` function
+- Added `convertFrom()` function
 - Added `migrate` class
 
 # 🎉 V2 Changes 🎉
@@ -55,14 +55,16 @@ yarn add simply-xp@dev
 - Better Code Quality (EsLint)
 - Complete TypeScript Rewrite
 - Deleted `chart.js` dependency
-- `fetch()` now also returns `position`
-- `roleSetup` functions now accept roleID arrays! `["role1", "role2", "role3"]`
-- `reset()` function now accepts "erase" as an optional argument
+- `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()` Requires new arguments.
+- `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.
+- `roleSetup()` functions loses `client` argument.
+- `leaderboard()` loses `client` argument, and returns `user` instead of `userID`

package/lib/src/add.d.ts

@@ -1,35 +1,36 @@
+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<{user: string, guild: string, level: number, xp: number}>} - Object of user data on success
+ * @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): Promise<{
-    user: string;
-    guild: string;
-    level: number;
-    xp: number;
-}>;
+export declare function addLevel(userId: string, guildId: string, level: number, username?: string): Promise<UserResult>;
+/**
+ * XP Results
+ * @property {boolean} hasLevelledUp - Whether the user has levelled up or not.
+ */
+interface XPResult extends UserResult {
+    hasLevelledUp: boolean;
+}
 /**
  * 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}} xp - The XP to add, can be a number or an object with min and max properties.
+ * @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<{user: string, guild: string, level: number, xp: number}>} - Object of user data on success.
+ * @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, xp: number | {
+export declare function addXP(userId: string, guildId: string, xpData: number | {
     min: number;
     max: number;
-}): Promise<{
-    user: string;
-    guild: string;
-    level: number;
-    xp: number;
-}>;
+}, username?: string): Promise<XPResult>;
+export {};

package/lib/src/add.js

@@ -5,17 +5,19 @@
  * @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<{user: string, guild: string, level: number, xp: number}>} - Object of user data on success
+ * @returns {Promise<UserResult>} - Object of user data on success
  * @throws {XpFatal} - If parameters are not provided correctly
- */async function addLevel(userId,guildId,level){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"});var e;if(level)return(e=await database_1.db.findOne({collection:"simply-xps",data:{user:userId,guild:guildId}}))?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,convert_1.convert)("level",level+e.level)}}):database_1.db.createOne({collection:"simply-xps",data:{user:userId,guild:guildId,level:level,xp:(0,convert_1.convert)("level",level)}});throw new xplogs_1.XpFatal({function:"addLevel()",message:"Level was not provided"})}
+ */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.convertFrom)(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.convertFrom)(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}} xp - The XP to add, can be a number or an object with min and max properties.
+ * @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<{user: string, guild: string, level: number, xp: number}>} - Object of user data on success.
+ * @returns {Promise<XPResult>} - Object of user data on success.
  * @throws {XpFatal} - If parameters are not provided correctly.
- */async function addXP(userId,guildId,xp){if(!("number"==typeof xp||"object"==typeof xp&&xp.min&&xp.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 xp&&(xp=Math.floor(Math.random()*(xp.max-xp.min)+xp.min)),!userId)throw new xplogs_1.XpFatal({function:"addXP()",message:"User ID was not provided"});var e;if(guildId)return(e=await database_1.db.findOne({collection:"simply-xps",data:{user:userId,guild:guildId}}))?database_1.db.updateOne({collection:"simply-xps",data:{user:userId,guild:guildId}},{collection:"simply-xps",data:{user:userId,guild:guildId,level:(0,convert_1.convert)("xp",e.xp+xp),xp:e.xp+xp}}):database_1.db.createOne({collection:"simply-xps",data:{user:userId,guild:guildId,level:(0,convert_1.convert)("xp",xp),xp:xp}});throw new xplogs_1.XpFatal({function:"addXP()",message:"Guild ID was not provided"})}Object.defineProperty(exports,"__esModule",{value:!0}),exports.addXP=exports.addLevel=void 0;const convert_1=require("./functions/convert"),xplogs_1=require("./functions/xplogs"),database_1=require("./functions/database");exports.addLevel=addLevel,exports.addXP=addXP;
+ */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}});let a;if(e)a=await database_1.db.updateOne({collection:"simply-xps",data:{user:userId,guild:guildId}},{collection:"simply-xps",data:{user:userId,guild:guildId,level:(0,utilities_1.convertFrom)(e.xp+xpData,"xp"),xp:e.xp+xpData}}).catch(err=>{throw new xplogs_1.XpFatal({function:"addXP()",message:err.stack})});else{if(!xp_1.xp.auto_create||!username)throw new xplogs_1.XpFatal({function:"addXP()",message:"User does not exist"});a=await database_1.db.createOne({collection:"simply-xps",data:{guild:guildId,user:userId,name:username,level:(0,utilities_1.convertFrom)(xpData,"xp"),xp:xpData}}).catch(err=>{throw new xplogs_1.XpFatal({function:"addXP()",message:err.stack})})}return{...a,hasLevelledUp:a.level>e.level}}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

@@ -2,14 +2,15 @@
 import { User } from "./leaderboard";
 type HexColor = `#${string}` | `0x${string}`;
 /**
- * @property artworkColors - [HEX, RGB, RGBA]
- * @property borderColor - [HEX, RGB, RGBA]
- * @property backgroundColor - [HEX, RGB, RGBA]
- * @property artworkImage - [PNG, JPG, WEBP]
- * @property font - ABSOLUTE FILE PATH
- * @property light - Use light theme
+ * @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 type LeaderboardOptions = {
+export interface LeaderboardOptions {
     artworkColors?: [HexColor, HexColor];
     artworkImage?: URL;
     borderColors?: [HexColor, HexColor];
@@ -17,19 +18,23 @@ export type LeaderboardOptions = {
     backgroundImage?: URL;
     font?: string;
     light?: boolean;
-};
+}
 /**
- * @property background - [PNG, JPG, WEBP]
- * @property font - ABSOLUTE FILE PATH
+ * @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 type RankCardOptions = {
+export interface RankCardOptions {
     background?: URL;
     color?: HexColor;
     legacy?: boolean;
     lvlbar?: HexColor;
     lvlbarBg?: HexColor;
     font?: string;
-};
+}
 export type UserOptions = {
     id: string;
     username: string;

package/lib/src/cards.js

@@ -9,7 +9,7 @@
  * @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");var o,t,r,l,n,d,i,s,c=await database_1.db.findOne({collection:"simply-xps",data:{guild:guild.id,user:user.id}});if(c)return o=(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,options?.legacy?(t=user.username.replace(/[\u007f-\uffff]/g,""),r=options?.color||"#9900ff",l=options?.lvlbar||"#ffffff",options=options?.lvlbarBg||"#ffffff",s=shortener(c.xp)+(" "+locales.xp),n=locales.level+(" "+shortener(c.level)),d=(0,convert_1.convert)("level",c.level+1),i=(0,convert_1.convert)("level",c.level),i=100*(c.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("#"+o,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(c.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"};throw new xplogs_1.XpFatal({function:"rankCard",message:"User not found in database"})}
+ */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.eot"),"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.convertFrom)(o.level+1),i=(0,utilities_1.convertFrom)(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
@@ -20,4 +20,4 @@
  * @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"),convert_1=require("./functions/convert"),path_1=require("path");let cachedRankImage,cachedRankCanvas,cachedRankContext,cachedLeaderboardArtwork,cachedLeaderboardCanvas,cachedLeaderboardContext,cachedLeaderboardImage;exports.rankCard=rankCard,exports.leaderboardCard=leaderboardCard;
+ */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)),canvas_1.GlobalFonts.registerFromPath(options?.font||(0,path_1.join)(__dirname,"Fonts","Baloo-Regular.eot"),"Sans Serif"),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/connect.d.ts

@@ -1,6 +1,7 @@
 export type ConnectionOptions = {
     type: "mongodb" | "sqlite" | undefined;
-    auto_purge?: false | unknown;
+    auto_create?: boolean;
+    auto_purge?: boolean;
     notify?: boolean;
     debug?: boolean;
 };
@@ -15,3 +16,11 @@ export type ConnectionOptions = {
  * @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

@@ -8,7 +8,7 @@
  * @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,o,t,{type:n,auto_purge:r,notify:a,debug:i}=options;if(!uri)throw new xplogs_1.XpFatal({function:"connect()",message:"No URI Provided"});switch(!1===a&&(xp_1.xp.notify=!1),r&&(xp_1.xp.auto_purge=!0),i&&(xp_1.xp.debug=!0),n||(options.type="mongodb",xplogs_1.XpLog.warn("connect()","Database type not provided, defaulting to MongoDB")),n){case"mongodb":try{if(t=(await Promise.resolve().then(()=>__importStar(require("mongodb")))).MongoClient,!(await Promise.resolve().then(()=>__importStar(require("mongodb/package.json")))).version.startsWith("5"))return xplogs_1.XpLog.err("connect()","MongoDB V5 is required");e=await t.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}catch(e){xplogs_1.XpLog.info("connect()","Installing MongoDB [5.x] | Please wait..."),(0,child_process_1.execSync)(await getPackageManager()+" add mongodb@5.x.x"),xplogs_1.XpLog.warn("connect()","Installed MongoDB. Please restart!"),process.exit(1)}break;case"sqlite":try{if(o=await Promise.resolve().then(()=>__importStar(require("better-sqlite3"))),!(await Promise.resolve().then(()=>__importStar(require("better-sqlite3/package.json")))).version.startsWith("8"))return xplogs_1.XpLog.err("connect()","SQLite V8 is required");xp_1.xp.database=new o.default(uri),xp_1.xp.dbType="sqlite",xp_1.xp.database.exec(`CREATE TABLE IF NOT EXISTS "simply-xps"
+ */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
@@ -32,9 +32,16 @@
                                   TEXT
                                   NOT
                                   NULL
-                              )`)}catch(e){if("object"==typeof e&&null!==e&&void 0!==(t=e).code&&"MODULE_NOT_FOUND"!==t.code)throw new xplogs_1.XpFatal({function:"connect()",message:t.message});xplogs_1.XpLog.info("connect()","Installing better-sqlite3 [V8]..."),(0,child_process_1.execSync)(await getPackageManager()+" add better-sqlite3@8.x.x"),xplogs_1.XpLog.warn("connect()","Installed better-sqlite3. | Please reboot!"),process.exit(0)}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)}
+                              )`)}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 o=["yarn.lock","pnpm-lock.yaml","pnpm-lock.json","package-lock.json"].filter(lockfile=>e(lockfile));if(1===o.length){if("yarn.lock"===o[0])return xplogs_1.XpLog.debug("getPackageManager()","Using Yarn"),"yarn";if("pnpm-lock.yaml"===o[0]||"pnpm-lock.json"===o[0])return xplogs_1.XpLog.debug("getPackageManager()","Using PNPM"),"pnpm"}return xplogs_1.XpLog.debug("getPackageManager()","Using NPM"),"npm"}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,o;if(mod&&mod.__esModule)return mod;if(e={},null!=mod)for(o in mod)"default"!==o&&Object.prototype.hasOwnProperty.call(mod,o)&&__createBinding(e,mod,o);return __setModuleDefault(e,mod),e};Object.defineProperty(exports,"__esModule",{value:!0}),exports.connect=void 0;const xplogs_1=require("./functions/xplogs"),child_process_1=require("child_process"),xp_1=require("../xp");exports.connect=connect;
+ */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

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

package/lib/src/create.js

@@ -2,10 +2,10 @@
 /**
  * Create a new user in the database
  * @async
- * @param {string} guildId
  * @param {string} userId
+ * @param {string} guildId
  * @param {string} username
  * @link `Documentation:` https://simplyxp.js.org/docs/create
- * @returns {Promise<object>}
+ * @returns {Promise<UserResult>}
  * @throws {XpFatal} If invalid parameters are provided
- */async function create(guildId,userId,username){if(!guildId)throw new xplogs_1.XpFatal({function:"create()",message:"Guild ID was not provided"});if(!userId)throw new xplogs_1.XpFatal({function:"create()",message:"User ID was not provided"});var e;if(username)return await(e=(await Promise.resolve().then(()=>__importStar(require("./functions/database")))).db).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}});throw new xplogs_1.XpFatal({function:"create()",message:"Username was not provided"})}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;
+ */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/fetch.d.ts

@@ -1,17 +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): Promise<{
-    name: string | null;
-    user: string;
-    guild: string;
-    level: number;
-    position: number;
-    xp: number;
-}>;
+export declare function fetch(userId: string, guildId: string, username: string): Promise<User>;

package/lib/src/fetch.js

@@ -4,7 +4,8 @@
  * @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){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=(guildId=await(await Promise.resolve().then(()=>__importStar(require("./functions/database")))).db.find({collection:"simply-xps",data:{guild:guildId}})).find(u=>u.user===userId);if(e)return guildId=guildId.sort((a,b)=>b.xp-a.xp).findIndex(u=>u.user===userId)+1,{name:e?.name||null,user:e.user,guild:e.guild,level:e.level,position:guildId,xp:e.xp};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");exports.fetch=fetch;
+ */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;

package/lib/src/functions/database.d.ts

@@ -1,4 +1,14 @@
-export type UserOptions = {
+/**
+ * Options for creating a user document.
+ * @property {string} collection - The collection to create the document in.
+ * @property {object} data - The data to create the document with.
+ * @property {string} data.guild - The guild ID.
+ * @property {string} [data.user] - The user ID.
+ * @property {string} [data.name] - The username.
+ * @property {number} [data.level] - The level.
+ * @property {number} [data.xp] - The XP.
+ */
+export interface UserOptions {
     collection: "simply-xps";
     data: {
         guild: string;
@@ -7,28 +17,48 @@ export type UserOptions = {
         level?: number;
         xp?: number;
     };
-};
-export type UserResult = {
+}
+/**
+ * The result of a user document.
+ * @property {string} [_id] - The ID of the document.
+ * @property {string} user - The user ID.
+ * @property {string} [name] - The username.
+ * @property {string} guild - The guild ID.
+ * @property {number} level - The level.
+ * @property {number} xp - The XP.
+ */
+export interface UserResult {
     _id?: string;
     user: string;
     name?: string;
     guild: string;
     level: number;
     xp: number;
-};
-export type LevelRoleOptions = {
+}
+/**
+ * Options for creating a level role document.
+ * @property {string} collection - The collection to create the document in.
+ * @property {object} data - The data to create the document with.
+ * @property {string} data.guild - The guild ID.
+ * @property {number} [data.level] - The level to assign the role at.
+ * @property {string | Array<string>} [data.roles] - The role(s) to assign.
+ * @property {string} data.timestamp - The timestamp of when the document was created.
+ */
+export interface LevelRoleOptions {
     collection: "simply-xp-levelroles";
     data: {
         guild: string;
         level?: number;
         roles?: string | Array<string>;
+        timestamp: string;
     };
-};
+}
 export type LevelRoleResult = {
     _id?: string;
     guild: string;
     level: number;
     roles: Array<string>;
+    timestamp: string;
 };
 /**
  * Database class providing methods to interact with the database.

package/lib/src/functions/utilities.d.ts

@@ -0,0 +1,41 @@
+import { MongoClient } from "mongodb";
+import { Database } from "better-sqlite3";
+/**
+ * Options for the XP client.
+ * @property {boolean} auto_create - Whether to automatically create a user if they don't exist in the database.
+ * @property {boolean} auto_purge - Whether to automatically purge inactive users.
+ * @property {object} dbOptions - The database options.
+ * @property {"mongodb" | "sqlite"} dbOptions.type
+ * @property {MongoClient | Database} dbOptions.database
+ * @property {boolean} notify - Enable/Disable console notifications.
+ * @property {boolean} debug - Whether to enable debug logs.
+ */
+interface NewClientOptions {
+    auto_create: boolean;
+    auto_purge: boolean;
+    dbOptions: {
+        type: "mongodb" | "sqlite";
+        database: MongoClient | Database;
+    };
+    notify: boolean;
+    debug: boolean;
+}
+/**
+ * Convert XP to level and vice versa.
+ *
+ * @param {number} value.
+ * @param {"xp" | "level"} type - Type to convert from (Default: level).
+ * @link `Documentation:` https://simplyxp.js.org/docs/utilities/convert
+ * @returns {number} - The converted value. (XP to level or level to XP)
+ * @throws {XpFatal} If an invalid type is provided or if the value is not provided.
+ */
+export declare function convertFrom(value: number, type?: "xp" | "level"): number;
+/**
+ * Updates the options of the XP client.
+ * @param {NewClientOptions} clientOptions - The new options to update.
+ * @link `Documentation:` https://simplyxp.js.org/docs/utilities/updateOptions
+ * @returns {void} - Nothing.
+ * @throws {XpFatal} If an invalid option is provided.
+ */
+export declare function updateOptions(clientOptions: NewClientOptions): void;
+export {};

package/lib/src/functions/utilities.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * Convert XP to level and vice versa.
+ *
+ * @param {number} value.
+ * @param {"xp" | "level"} type - Type to convert from (Default: level).
+ * @link `Documentation:` https://simplyxp.js.org/docs/utilities/convert
+ * @returns {number} - The converted value. (XP to level or level to XP)
+ * @throws {XpFatal} If an invalid type is provided or if the value is not provided.
+ */function convertFrom(value,type="level"){if(!value)throw new xplogs_1.XpFatal({function:"convertFrom()",message:"Value was not provided"});if("xp"!==type&&"level"!==type)throw new xplogs_1.XpFatal({function:"convert()",message:"Invalid type provided"});if("level"===type)return Math.pow(value/.1,2);if("xp"===type)return Math.floor(.1*Math.sqrt(value));throw new xplogs_1.XpFatal({function:"convertFrom()",message:"Invalid type provided"})}
+/**
+ * Updates the options of the XP client.
+ * @param {NewClientOptions} clientOptions - The new options to update.
+ * @link `Documentation:` https://simplyxp.js.org/docs/utilities/updateOptions
+ * @returns {void} - Nothing.
+ * @throws {XpFatal} If an invalid option is provided.
+ */function updateOptions(clientOptions){if(!clientOptions)throw new xplogs_1.XpFatal({function:"updateOptions()",message:"Options were not provided"});if("object"!=typeof clientOptions)throw new xplogs_1.XpFatal({function:"updateOptions()",message:"Options must be an object"});if(xp_1.xp.auto_create=clientOptions.auto_create,xp_1.xp.auto_purge=clientOptions.auto_purge,xp_1.xp.notify=clientOptions.notify,xp_1.xp.debug=clientOptions.debug,clientOptions.dbOptions&&"object"==typeof clientOptions.dbOptions&&clientOptions.dbOptions.type&&clientOptions.dbOptions.database){var{type:clientOptions,database:t}=clientOptions.dbOptions;if(!(clientOptions&&"mongodb"===clientOptions||"sqlite"===clientOptions))throw new xplogs_1.XpFatal({function:"updateOptions()",message:"Invalid database type provided"});xp_1.xp.dbType=clientOptions,t&&(xp_1.xp.database=t,"mongodb"===xp_1.xp.dbType?(0,connect_1.checkPackageVersion)("mongodb").then(result=>{if(!result)throw new xplogs_1.XpFatal({function:"updateOptions()",message:"MongoDB V4 or higher is required"});xp_1.xp.database.db().command({ping:1}).catch(()=>{throw xp_1.xp.database=void 0,new xplogs_1.XpFatal({function:"updateOptions()",message:"Invalid MongoDB connection"})})}):"sqlite"===xp_1.xp.dbType&&(0,connect_1.checkPackageVersion)("sqlite").then(result=>{if(!result)throw new xplogs_1.XpFatal({function:"updateOptions()",message:"SQLite V7 or higher is required"});try{xp_1.xp.database.prepare("SELECT 1").get()}catch(t){throw new xplogs_1.XpFatal({function:"updateOptions()",message:"Invalid SQLite connection"})}}))}}Object.defineProperty(exports,"__esModule",{value:!0}),exports.updateOptions=exports.convertFrom=void 0;const xplogs_1=require("./xplogs"),xp_1=require("../../xp"),connect_1=require("../connect");exports.convertFrom=convertFrom,exports.updateOptions=updateOptions;

package/lib/src/leaderboard.d.ts

@@ -1,11 +1,20 @@
-export type User = {
+/**
+ * User object
+ * @property {string} guild - Guild ID
+ * @property {string} user - User ID
+ * @property {string} name - Username
+ * @property {number} position - Position in leaderboard
+ * @property {number} level - User level
+ * @property {number} xp - User XP
+ */
+export interface User {
     guild: string;
     user: string;
-    name?: string;
+    name?: string | null;
     position?: number;
     level: number;
     xp: number;
-};
+}
 /**
  * Get array of all users in the leaderboard
  * @async

package/lib/src/reset.d.ts

@@ -3,9 +3,10 @@
  * @async
  * @param {string} userId
  * @param {string} guildId
- * @param {boolean} erase - Erase user entry from database
+ * @param {string} username
+ * @param {boolean?} erase - Erase user entry from database
  * @link `Documentation:` https://simplyxp.js.org/docs/reset
  * @returns {Promise<boolean>}
  * @throws {XpFatal} If an invalid type is provided or if the value is not provided.
  */
-export declare function reset(userId: string, guildId: string, erase: boolean): Promise<boolean>;
+export declare function reset(userId: string, guildId: string, username: string, erase?: boolean): Promise<boolean>;

package/lib/src/reset.js

@@ -4,8 +4,9 @@
  * @async
  * @param {string} userId
  * @param {string} guildId
- * @param {boolean} erase - Erase user entry from database
+ * @param {string} username
+ * @param {boolean?} erase - Erase user entry from database
  * @link `Documentation:` https://simplyxp.js.org/docs/reset
  * @returns {Promise<boolean>}
  * @throws {XpFatal} If an invalid type is provided or if the value is not provided.
- */async function reset(userId,guildId,erase){if(!userId)throw new xplogs_1.XpFatal({function:"reset()",message:"No User ID Provided"});var e;if(guildId)return e=(await Promise.resolve().then(()=>__importStar(require("./functions/database")))).db,erase?e.deleteOne({collection:"simply-xps",data:{guild:guildId,user:userId}}).catch(error=>{throw new xplogs_1.XpFatal({function:"reset()",message:error})}):e.updateOne({collection:"simply-xps",data:{guild:guildId,user:userId}},{collection:"simply-xps",data:{guild:guildId,user:userId,level:0,xp:0}}).catch(error=>{throw new xplogs_1.XpFatal({function:"reset()",message:error})});throw new xplogs_1.XpFatal({function:"reset()",message:"No Guild ID Provided"})}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.reset=void 0;const xplogs_1=require("./functions/xplogs");exports.reset=reset;
+ */async function reset(userId,guildId,username,erase=!1){if(!userId)throw new xplogs_1.XpFatal({function:"reset()",message:"No User ID Provided"});if(!guildId)throw new xplogs_1.XpFatal({function:"reset()",message:"No Guild ID Provided"});if(username)return!(await(username=(await Promise.resolve().then(()=>__importStar(require("./functions/database")))).db).findOne({collection:"simply-xps",data:{guild:guildId,user:userId}})||(xp_1.xp.auto_create&&!erase&&await username.createOne({collection:"simply-xps",data:{guild:guildId,user:userId,level:0,xp:0}}).then(()=>!0).catch(error=>{throw new xplogs_1.XpFatal({function:"reset()",message:error.stack})}),!erase))||(erase?username.deleteOne({collection:"simply-xps",data:{guild:guildId,user:userId}}).catch(error=>{throw new xplogs_1.XpFatal({function:"reset()",message:error})}):username.updateOne({collection:"simply-xps",data:{guild:guildId,user:userId}},{collection:"simply-xps",data:{guild:guildId,user:userId,level:0,xp:0}}).catch(error=>{throw new xplogs_1.XpFatal({function:"reset()",message:error})}));throw new xplogs_1.XpFatal({function:"reset()",message:"No Username Provided"})}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.reset=void 0;const xplogs_1=require("./functions/xplogs"),xp_1=require("../xp");exports.reset=reset;

package/lib/src/roleSetup.d.ts

@@ -1,8 +1,14 @@
-export type RoleSetupObject = {
+/**
+ * Role setup object
+ * @property {string} guild - The guild ID
+ * @property {number} level - The level number
+ * @property {string[] | string} roles - The role(s) to add
+ */
+export interface RoleSetupObject {
     guild?: string;
     level: number;
     roles: string[] | string;
-};
+}
 /**
  * Setup roles for levels
  * @class roleSetup

package/lib/src/roleSetup.js

@@ -8,7 +8,7 @@
      * @returns {Promise<boolean>} - True if successful
      * @throws {XpFatal} If an invalid type is provided or value is not provided.
      */
-static async add(guildId,options){if(!guildId)throw new xplogs_1.XpFatal({function:"roleSetup.add()",message:"Guild ID was not provided"});if(!options)throw new xplogs_1.XpFatal({function:"roleSetup.add()",message:"Options were not provided"});if(isNaN(options?.level))throw new xplogs_1.XpFatal({function:"roleSetup.add()",message:"Level must be a number"});if(options?.roles)return"string"==typeof options?.roles&&(options.roles=[options.roles]),xp_1.db.createOne({collection:"simply-xp-levelroles",data:{guild:guildId,level:options.level,roles:options.roles}});throw new xplogs_1.XpFatal({function:"roleSetup.add()",message:"Role was not provided"})}
+static async add(guildId,options){if(!guildId)throw new xplogs_1.XpFatal({function:"roleSetup.add()",message:"Guild ID was not provided"});if(!options)throw new xplogs_1.XpFatal({function:"roleSetup.add()",message:"Options were not provided"});if(isNaN(options?.level))throw new xplogs_1.XpFatal({function:"roleSetup.add()",message:"Level must be a number"});if(options?.roles)return"string"==typeof options?.roles&&(options.roles=[options.roles]),xp_1.db.createOne({collection:"simply-xp-levelroles",data:{guild:guildId,level:options.level,roles:options.roles,timestamp:(new Date).toISOString()}});throw new xplogs_1.XpFatal({function:"roleSetup.add()",message:"Role was not provided"})}
 /**
      * Find a role in roleSetup
      * @async
@@ -17,7 +17,7 @@ static async add(guildId,options){if(!guildId)throw new xplogs_1.XpFatal({functi
      * @link `Documentation:` https://simplyxp.js.org/docs/roleSetup/find
      * @returns {Promise<RoleSetupObject>} - The level role object
      * @throws {XpFatal} If an invalid type is provided or value is not provided.
-     */static async find(guildId,levelNumber){if(!guildId)throw new xplogs_1.XpFatal({function:"roleSetup.find()",message:"Guild ID was not provided"});if(isNaN(levelNumber))throw new xplogs_1.XpFatal({function:"roleSetup.find()",message:"Level Number was not provided"});return xp_1.db.findOne({collection:"simply-xp-levelroles",data:{guild:guildId,level:levelNumber}})}
+     */static async find(guildId,levelNumber){if(!guildId)throw new xplogs_1.XpFatal({function:"roleSetup.find()",message:"Guild ID was not provided"});if(isNaN(levelNumber))throw new xplogs_1.XpFatal({function:"roleSetup.find()",message:"Level Number was not provided"});return xp_1.db.findOne({collection:"simply-xp-levelroles",data:{guild:guildId,level:levelNumber,timestamp:(new Date).toISOString()}})}
 /**
      * Remove a level from the role setup
      * @async
@@ -26,4 +26,4 @@ static async add(guildId,options){if(!guildId)throw new xplogs_1.XpFatal({functi
      * @link `Documentation:` https://simplyxp.js.org/docs/roleSetup/remove
      * @returns {Promise<boolean>} - True if successful
      * @throws {XpFatal} If an invalid type is provided or value is not provided.
-     */static async remove(guildId,levelNumber){if(!guildId)throw new xplogs_1.XpFatal({function:"roleSetup.remove()",message:"Guild ID was not provided"});if(isNaN(levelNumber))throw new xplogs_1.XpFatal({function:"roleSetup.remove()",message:"Level Number was not provided"});return xp_1.db.deleteOne({collection:"simply-xp-levelroles",data:{guild:guildId,level:levelNumber}})}}exports.roleSetup=roleSetup;
+     */static async remove(guildId,levelNumber){if(!guildId)throw new xplogs_1.XpFatal({function:"roleSetup.remove()",message:"Guild ID was not provided"});if(isNaN(levelNumber))throw new xplogs_1.XpFatal({function:"roleSetup.remove()",message:"Level Number was not provided"});return xp_1.db.deleteOne({collection:"simply-xp-levelroles",data:{guild:guildId,level:levelNumber,timestamp:(new Date).toISOString()}})}}exports.roleSetup=roleSetup;

package/lib/src/set.d.ts

@@ -1,32 +1,33 @@
+import { UserResult } from "./functions/database";
 /**
  * Set user level
  * @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/setlevel
- * @returns {Promise<{user: string, guild: string, level: number, xp: number}>} - Object of user data on success
+ * @returns {Promise<UserResult>} - Object of user data on success
  * @throws {XpFatal} - If parameters are not provided correctly
  */
-export declare function setLevel(userId: string, guildId: string, level: number): Promise<{
-    user: string;
-    guild: string;
-    level: number;
-    xp: number;
-}>;
+export declare function setLevel(userId: string, guildId: string, level: number, username?: string): Promise<UserResult>;
+/**
+ * XP Results
+ * @property {boolean} hasLevelledUp - Whether the user has levelled up or not.
+ */
+interface XPResult extends UserResult {
+    hasLevelledUp: boolean;
+}
 /**
  * Set user XP
  * @async
  * @param {string} userId
  * @param {string} guildId
- * @param {number} xp
+ * @param {number} xpData
+ * @param {string} username - Username to use if auto_create is enabled
  * @link `Documentation:` https://simplyxp.js.org/docs/setxp
- * @returns {Promise<object>} - Object of user data on success
+ * @returns {Promise<XPResult>} - Object of user data on success
  * @throws {XpFatal} - If parameters are not provided correctly
  */
-export declare function setXP(userId: string, guildId: string, xp: number): Promise<{
-    user: string;
-    guild: string;
-    level: number;
-    xp: number;
-}>;
+export declare function setXP(userId: string, guildId: string, xpData: number, username?: string): Promise<XPResult>;
+export {};

package/lib/src/set.js

@@ -5,17 +5,19 @@
  * @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/setlevel
- * @returns {Promise<{user: string, guild: string, level: number, xp: number}>} - Object of user data on success
+ * @returns {Promise<UserResult>} - Object of user data on success
  * @throws {XpFatal} - If parameters are not provided correctly
- */async function setLevel(userId,guildId,level){if(!userId)throw new xplogs_1.XpFatal({function:"setLevel()",message:"User ID was not provided"});if(!guildId)throw new xplogs_1.XpFatal({function:"setLevel()",message:"Guild ID was not provided"});if(level)return await database_1.db.findOne({collection:"simply-xps",data:{user:userId,guild:guildId}})?database_1.db.updateOne({collection:"simply-xps",data:{user:userId,guild:guildId}},{collection:"simply-xps",data:{user:userId,guild:guildId,level:level,xp:(0,convert_1.convert)("level",level)}}):database_1.db.createOne({collection:"simply-xps",data:{user:userId,guild:guildId,level:level,xp:(0,convert_1.convert)("level",level)}});throw new xplogs_1.XpFatal({function:"setLevel()",message:"Level was not provided"})}
+ */async function setLevel(userId,guildId,level,username){if(!userId)throw new xplogs_1.XpFatal({function:"setLevel()",message:"User ID was not provided"});if(!guildId)throw new xplogs_1.XpFatal({function:"setLevel()",message:"Guild ID was not provided"});if(!level)throw new xplogs_1.XpFatal({function:"setLevel()",message:"Level was not provided"});if(await database_1.db.findOne({collection:"simply-xps",data:{user:userId,guild:guildId}}))return database_1.db.updateOne({collection:"simply-xps",data:{user:userId,guild:guildId}},{collection:"simply-xps",data:{user:userId,guild:guildId,level:level,xp:(0,utilities_1.convertFrom)(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.convertFrom)(level)}});throw new xplogs_1.XpFatal({function:"setLevel()",message:"User does not exist"})}
 /**
  * Set user XP
  * @async
  * @param {string} userId
  * @param {string} guildId
- * @param {number} xp
+ * @param {number} xpData
+ * @param {string} username - Username to use if auto_create is enabled
  * @link `Documentation:` https://simplyxp.js.org/docs/setxp
- * @returns {Promise<object>} - Object of user data on success
+ * @returns {Promise<XPResult>} - Object of user data on success
  * @throws {XpFatal} - If parameters are not provided correctly
- */async function setXP(userId,guildId,xp){if(!userId)throw new xplogs_1.XpFatal({function:"setXP()",message:"User ID was not provided"});if(!guildId)throw new xplogs_1.XpFatal({function:"setXP()",message:"Guild ID was not provided"});if(xp)return await database_1.db.findOne({collection:"simply-xps",data:{user:userId,guild:guildId}})?database_1.db.updateOne({collection:"simply-xps",data:{user:userId,guild:guildId}},{collection:"simply-xps",data:{user:userId,guild:guildId,level:(0,convert_1.convert)("xp",xp),xp:xp}}):database_1.db.createOne({collection:"simply-xps",data:{user:userId,guild:guildId,level:(0,convert_1.convert)("xp",xp),xp:xp}});throw new xplogs_1.XpFatal({function:"setXP()",message:"XP was not provided"})}Object.defineProperty(exports,"__esModule",{value:!0}),exports.setXP=exports.setLevel=void 0;const xplogs_1=require("./functions/xplogs"),convert_1=require("./functions/convert"),database_1=require("./functions/database");exports.setLevel=setLevel,exports.setXP=setXP;
+ */async function setXP(userId,guildId,xpData,username){if(!userId)throw new xplogs_1.XpFatal({function:"setXP()",message:"User ID was not provided"});if(!guildId)throw new xplogs_1.XpFatal({function:"setXP()",message:"Guild ID was not provided"});if(!xpData)throw new xplogs_1.XpFatal({function:"setXP()",message:"XP was not provided"});var e=await database_1.db.findOne({collection:"simply-xps",data:{user:userId,guild:guildId}});let s;if(e)s=await database_1.db.updateOne({collection:"simply-xps",data:{user:userId,guild:guildId}},{collection:"simply-xps",data:{user:userId,guild:guildId,level:(0,utilities_1.convertFrom)(xpData),xp:xpData}});else{if(!xp_1.xp.auto_create||!username)throw new xplogs_1.XpFatal({function:"setXP()",message:"User does not exist"});s=await database_1.db.createOne({collection:"simply-xps",data:{guild:guildId,user:userId,name:username,level:(0,utilities_1.convertFrom)(xpData),xp:xpData}})}return{...s,hasLevelledUp:s.level>e.level}}Object.defineProperty(exports,"__esModule",{value:!0}),exports.setXP=exports.setLevel=void 0;const xplogs_1=require("./functions/xplogs"),utilities_1=require("./functions/utilities"),database_1=require("./functions/database"),xp_1=require("../xp");exports.setLevel=setLevel,exports.setXP=setXP;

package/lib/xp.d.ts

@@ -3,6 +3,7 @@ import { MongoClient } from "mongodb";
 export interface XPClient {
     dbType: "mongodb" | "sqlite";
     database: MongoClient | Database | undefined;
+    auto_create: boolean;
     auto_purge: boolean;
     notify: boolean;
     debug: boolean;
@@ -11,7 +12,7 @@ export { addLevel, addXP } from "./src/add";
 export { db } from "./src/functions/database";
 export { charts } from "./src/charts";
 export { connect } from "./src/connect";
-export { convert } from "./src/functions/convert";
+export { convertFrom, updateOptions } from "./src/functions/utilities";
 export { create } from "./src/create";
 export { fetch } from "./src/fetch";
 export { leaderboard } from "./src/leaderboard";

package/lib/xp.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rank = exports.xp = exports.setXP = exports.setLevel = exports.roleSetup = exports.reset = exports.leaderboardCard = exports.rankCard = exports.migrate = exports.leaderboard = exports.fetch = exports.create = exports.convert = exports.connect = exports.charts = exports.db = exports.addXP = exports.addLevel = void 0;
+exports.rank = exports.xp = exports.setXP = exports.setLevel = exports.roleSetup = exports.reset = exports.leaderboardCard = exports.rankCard = exports.migrate = exports.leaderboard = exports.fetch = exports.create = exports.updateOptions = exports.convertFrom = exports.connect = exports.charts = exports.db = exports.addXP = exports.addLevel = void 0;
 // EXPORTS
 var add_1 = require("./src/add");
 Object.defineProperty(exports, "addLevel", { enumerable: true, get: function () { return add_1.addLevel; } });
@@ -11,8 +11,9 @@ var charts_1 = require("./src/charts");
 Object.defineProperty(exports, "charts", { enumerable: true, get: function () { return charts_1.charts; } });
 var connect_1 = require("./src/connect");
 Object.defineProperty(exports, "connect", { enumerable: true, get: function () { return connect_1.connect; } });
-var convert_1 = require("./src/functions/convert");
-Object.defineProperty(exports, "convert", { enumerable: true, get: function () { return convert_1.convert; } });
+var utilities_1 = require("./src/functions/utilities");
+Object.defineProperty(exports, "convertFrom", { enumerable: true, get: function () { return utilities_1.convertFrom; } });
+Object.defineProperty(exports, "updateOptions", { enumerable: true, get: function () { return utilities_1.updateOptions; } });
 var create_1 = require("./src/create");
 Object.defineProperty(exports, "create", { enumerable: true, get: function () { return create_1.create; } });
 var fetch_1 = require("./src/fetch");
@@ -32,6 +33,7 @@ var set_1 = require("./src/set");
 Object.defineProperty(exports, "setLevel", { enumerable: true, get: function () { return set_1.setLevel; } });
 Object.defineProperty(exports, "setXP", { enumerable: true, get: function () { return set_1.setXP; } });
 exports.xp = {
+    auto_create: false,
     auto_purge: false,
     database: undefined,
     debug: false,
@@ -41,4 +43,3 @@ exports.xp = {
 // DEPRECATED
 var rank_1 = require("./src/deprecated/rank");
 Object.defineProperty(exports, "rank", { enumerable: true, get: function () { return rank_1.rank; } });
-//# sourceMappingURL=xp.js.map

package/package.json

@@ -1,70 +1,70 @@
-{
-  "name": "simply-xp",
-  "version": "2.0.0-dev.0-fix.2",
-  "description": "The easiest way to implement xp system",
-  "main": "lib/xp.js",
-  "scripts": {
-    "beta": "node Tests/clean.mjs && pnpm update && npm publish --tag beta",
-    "clean": "node Tests/clean.mjs",
-    "dev": "node Tests/clean.mjs && pnpm update && npm publish --tag dev",
-    "docs": "node Tests/jsdocs.cjs",
-    "latest": "node Tests/clean.mjs && pnpm update && npm publish",
-    "test": "node Tests/clean.mjs && node Tests/test.cjs"
-  },
-  "author": "Rahuletto",
-  "keywords": [
-    "amaribot",
-    "charts",
-    "discord",
-    "discord.js",
-    "discord-xp",
-    "easy",
-    "fun",
-    "guilded",
-    "leaderboard",
-    "level role",
-    "level up",
-    "mee6",
-    "mongodb",
-    "package",
-    "simply",
-    "simply-djs",
-    "simplydjs",
-    "sqlite",
-    "system",
-    "xp"
-  ],
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Rahuletto/simply-xp.git"
-  },
-  "dependencies": {
-    "@napi-rs/canvas": "^0.1.41"
-  },
-  "devDependencies": {
-    "@types/better-sqlite3": "^7.6.4",
-    "@types/node": "^20.4.5",
-    "@typescript-eslint/eslint-plugin": "^6.2.1",
-    "@typescript-eslint/parser": "^6.2.1",
-    "better-sqlite3": "8.5.0",
-    "discord.js": "^14.12.1",
-    "eslint": "^8.46.0",
-    "guilded.ts": "^0.20.2",
-    "jsdoc-to-markdown": "^8.0.0",
-    "mongodb": "5.7.0",
-    "typescript": "^5.1.6",
-    "uglify-js": "^3.17.4"
-  },
-  "engines": {
-    "node": ">=15.5.0"
-  },
-  "bugs": {
-    "url": "https://github.com/Rahuletto/simply-xp/issues"
-  },
-  "homepage": "https://simplyxp.js.org",
-  "directories": {
-    "doc": "Mini_Docs",
-    "lib": "lib"
-  }
-}
+{
+  "name": "simply-xp",
+  "version": "2.0.0-dev.2",
+  "description": "The easiest way to implement xp system",
+  "main": "lib/xp.js",
+  "scripts": {
+    "beta": "node Tests/clean.mjs && pnpm update && npm publish --tag beta",
+    "clean": "node Tests/clean.mjs",
+    "dev": "node Tests/clean.mjs && pnpm update && npm publish --tag dev",
+    "docs": "node Tests/jsdocs.cjs",
+    "latest": "node Tests/clean.mjs && pnpm update && npm publish",
+    "test": "node Tests/clean.mjs && node Tests/test.cjs"
+  },
+  "author": "Abadima",
+  "keywords": [
+    "amaribot",
+    "charts",
+    "discord",
+    "discord.js",
+    "discord-xp",
+    "easy",
+    "fun",
+    "guilded",
+    "leaderboard",
+    "level role",
+    "level up",
+    "mee6",
+    "mongodb",
+    "package",
+    "simply",
+    "simply-djs",
+    "simplydjs",
+    "sqlite",
+    "system",
+    "xp"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rahuletto/simply-xp.git"
+  },
+  "dependencies": {
+    "@napi-rs/canvas": "^0.1.41"
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.4",
+    "@types/node": "^20.4.8",
+    "@typescript-eslint/eslint-plugin": "^6.2.1",
+    "@typescript-eslint/parser": "^6.2.1",
+    "better-sqlite3": "8.5.0",
+    "discord.js": "^14.12.1",
+    "eslint": "^8.46.0",
+    "guilded.ts": "^0.20.2",
+    "jsdoc-to-markdown": "^8.0.0",
+    "mongodb": "5.7.0",
+    "typescript": "^5.1.6",
+    "uglify-js": "^3.17.4"
+  },
+  "engines": {
+    "node": ">=15.5.0"
+  },
+  "bugs": {
+    "url": "https://github.com/Rahuletto/simply-xp/issues"
+  },
+  "homepage": "https://simplyxp.js.org",
+  "directories": {
+    "doc": "Mini_Docs",
+    "lib": "lib"
+  }
+}

package/lib/src/functions/convert.d.ts

@@ -1,10 +0,0 @@
-/**
- * Convert XP to level and vice versa.
- *
- * @param {"xp" | "level"} type - Type to convert from. Use either "xp" or "level".
- * @param {number} value - Value to convert.
- * @link https://simplyxp.js.org/docs/convert Documentation
- * @returns {number} - The converted value. (XP to level or level to XP)
- * @throws {XpFatal} If an invalid type is provided or if the value is not provided.
- */
-export declare function convert(type: "xp" | "level", value: number): number;

package/lib/src/functions/convert.js

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * Convert XP to level and vice versa.
- *
- * @param {"xp" | "level"} type - Type to convert from. Use either "xp" or "level".
- * @param {number} value - Value to convert.
- * @link https://simplyxp.js.org/docs/convert Documentation
- * @returns {number} - The converted value. (XP to level or level to XP)
- * @throws {XpFatal} If an invalid type is provided or if the value is not provided.
- */function convert(type,value){if("xp"===type||"level"===type){if(!value)throw new xplogs_1.XpFatal({function:"convert()",message:"Value was not provided"});if("level"===type)return Math.pow(value/.1,2);if("xp"===type)return Math.floor(.1*Math.sqrt(value))}throw new xplogs_1.XpFatal({function:"convert()",message:"Invalid type provided"})}Object.defineProperty(exports,"__esModule",{value:!0}),exports.convert=void 0;const xplogs_1=require("./xplogs");exports.convert=convert;