simply-xp 1.3.6 → 2.0.0-beta.0

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

@@ -0,0 +1,164 @@
+import { Collection } from "mongodb";
+/**
+ * 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.
+ * @property {number} [data.xp_rate] - The XP rate.
+ */
+export interface UserOptions {
+    collection: "simply-xps";
+    data: {
+        guild: string;
+        user?: string;
+        name?: string;
+        level?: number;
+        xp?: number;
+        xp_rate?: number;
+    };
+}
+/**
+ * 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 {string} lastUpdated - ISO String of the last time the user was updated.
+ * @property {number} level - The level.
+ * @property {number} xp - The XP.
+ * @property {number} [xp_rate] - The XP rate.
+ */
+export interface UserResult {
+    _id?: string;
+    user: string;
+    name?: string;
+    guild: string;
+    lastUpdated: string;
+    level: number;
+    xp: number;
+    xp_rate?: number;
+}
+/**
+ * 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 {object} data.lvlrole - The level role data.
+ * @property {number} data.lvlrole.lvl - The level.
+ * @property {string | Array<string>} [data.lvlrole.role] - The role ID(s).
+ */
+export interface LevelRoleOptions {
+    collection: "simply-xp-levelroles";
+    data: {
+        guild: string;
+        lvlrole: {
+            lvl: number | null;
+            role?: string | Array<string> | null;
+        };
+    };
+}
+/**
+ * The result of a level role document.
+ * @property {string} [_id] - The ID of the document.
+ * @property {string} guild - The guild ID.
+ * @property {object} lvlrole - The level role data.
+ * @property {number} lvlrole.lvl - The level.
+ * @property {string | Array<string>} [lvlrole.role] - The role ID(s).
+ * @property {string} lastUpdated - ISO String of the last time the level role was updated.
+ */
+export type LevelRoleResult = {
+    _id?: string;
+    guild: string;
+    lvlrole: {
+        lvl: number;
+        role?: string | Array<string>;
+    };
+    lastUpdated: string;
+};
+/**
+ * Database class providing methods to interact with the database.
+ * @class db
+ */
+export declare class db {
+    /**
+     * Gets a collection from the database.
+     * @param {collection} collection - The collection to get.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#getCollection Documentation
+     * @returns {Collection} The collection.
+     * @throws {XpFatal} Throws an error if there is no database connection, or database type is invalid.
+     */
+    static getCollection(collection: string): Collection;
+    /**
+     * Creates one document in the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The document to create.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#createOne Documentation
+     * @returns {Promise<UserResult | LevelRoleResult>} The created document.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */
+    static createOne(query: UserOptions | LevelRoleOptions): Promise<UserResult | LevelRoleResult>;
+    /**
+     * Deletes multiple documents from the database.
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The documents to delete.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#deleteMany Documentation
+     * @returns {Promise<boolean>} `true` if the documents were successfully deleted, otherwise `false`.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */
+    static deleteMany(query: UserOptions | LevelRoleOptions): Promise<boolean>;
+    /**
+     * Deletes one document from the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The document to delete.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#deleteOne Documentation
+     * @returns {Promise<boolean>} `true` if the document was successfully deleted, otherwise `false`.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */
+    static deleteOne(query: UserOptions | LevelRoleOptions): Promise<boolean>;
+    /**
+     * Finds one document in the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The query to search for the document.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#findOne Documentation
+     * @returns {Promise<UserResult | LevelRoleResult>} The found document.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */
+    static findOne(query: UserOptions | LevelRoleOptions): Promise<UserResult | LevelRoleResult>;
+    /**
+     * Finds multiple documents in the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The query to search for multiple documents.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#find Documentation
+     * @returns {Promise<UserResult[] | LevelRoleResult[]>} An array of found documents.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */
+    static find(query: UserOptions | LevelRoleOptions): Promise<UserResult[] | LevelRoleResult[]>;
+    /**
+     * Finds all documents in a collection.
+     * @param {"simply-xps" | "simply-xp-levelroles"} collection - The collection to search for all documents.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#findAll Documentation
+     * @returns {Promise<UserResult[] | LevelRoleResult[]>} An array of found documents.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */
+    static findAll(collection: "simply-xps" | "simply-xp-levelroles"): Promise<UserResult[] | LevelRoleResult[]>;
+    /**
+     * Updates one document in the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} filter - The document to update.
+     * @param {UserOptions | LevelRoleOptions} update - The document update data.
+     * @param {object} [options] - MongoDB options for updating the document.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#updateOne Documentation
+     * @returns {Promise<UserResult | LevelRoleResult>} The updated document.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */
+    static updateOne(filter: UserOptions | LevelRoleOptions, update: UserOptions | LevelRoleOptions, options?: object): Promise<UserResult | LevelRoleResult>;
+}

package/lib/src/functions/database.js

@@ -0,0 +1,78 @@
+"use strict";
+/**
+ * Handle database errors
+ * @param {Error} error
+ * @param {string} functionName
+ * @returns {void}
+ * @private
+ */function handleError(error,functionName){throw new xplogs_1.XpFatal({function:"db."+functionName,message:error})}Object.defineProperty(exports,"__esModule",{value:!0}),exports.db=void 0;const xplogs_1=require("./xplogs"),xp_1=require("../../xp");class db{
+/**
+     * Gets a collection from the database.
+     * @param {collection} collection - The collection to get.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#getCollection Documentation
+     * @returns {Collection} The collection.
+     * @throws {XpFatal} Throws an error if there is no database connection, or database type is invalid.
+     */
+static getCollection(collection){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"getCollection()",message:"No database connection"});if("mongodb"!==xp_1.xp.dbType)throw new xplogs_1.XpFatal({function:"getCollection()",message:"MongoDB has to be your database type to use this function."});return xp_1.xp.database.db().collection(collection)}
+/**
+     * Creates one document in the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The document to create.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#createOne Documentation
+     * @returns {Promise<UserResult | LevelRoleResult>} The created document.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */static async createOne(query){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"createOne()",message:"No database connection"});switch(xp_1.xp.dbType){case"mongodb":xp_1.xp.database.db().collection(query.collection).insertOne({...query.data,lastUpdated:(new Date).toISOString()}).catch(error=>handleError(error,"createOne()"));break;case"sqlite":"simply-xps"===query.collection?xp_1.xp.database.prepare('INSERT INTO "simply-xps" (user, guild, level, name, lastUpdated, xp, xp_rate) VALUES (?, ?, ?, ?, ?, ?, ?)').run(query.data.user,query.data.guild,query.data.level,query.data?.name,(new Date).toISOString(),query.data.xp,query.data.xp_rate):xp_1.xp.database.prepare('INSERT INTO "simply-xp-levelroles" (gid, lvlrole, lastUpdated) VALUES (?, ?, ?)').run(query.data.guild,JSON.stringify(query.data.lvlrole),(new Date).toISOString())}return db.findOne(query)}
+/**
+     * Deletes multiple documents from the database.
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The documents to delete.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#deleteMany Documentation
+     * @returns {Promise<boolean>} `true` if the documents were successfully deleted, otherwise `false`.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */static async deleteMany(query){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"deleteMany()",message:"No database connection"});let e;switch(xp_1.xp.dbType){case"mongodb":e=xp_1.xp.database.db().collection(query.collection).deleteMany(query.data).catch(error=>handleError(error,"deleteMany()"));break;case"sqlite":e=("simply-xps"===query.collection?xp_1.xp.database.prepare('DELETE FROM "simply-xps" WHERE guild = ?'):xp_1.xp.database.prepare('DELETE FROM "simply-xp-levelroles" WHERE gid = ?')).run(query.data.guild)}return!!e}
+/**
+     * Deletes one document from the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The document to delete.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#deleteOne Documentation
+     * @returns {Promise<boolean>} `true` if the document was successfully deleted, otherwise `false`.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */static async deleteOne(query){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"deleteOne()",message:"No database connection"});let e;switch(xp_1.xp.dbType){case"mongodb":e=xp_1.xp.database.db().collection(query.collection).deleteOne(query.data).catch(error=>handleError(error,"deleteOne()"));break;case"sqlite":e="simply-xps"===query.collection?xp_1.xp.database.prepare('DELETE FROM "simply-xps" WHERE guild = ? AND user = ?').run(query.data.guild,query.data.user):(e=(e=await this.find(query)).filter(row=>row.lvlrole.lvl===query.data.lvlrole.lvl)[0],xp_1.xp.database.prepare('DELETE FROM "simply-xp-levelroles" WHERE gid = ? AND lvlrole = ?').run(query.data.guild,JSON.stringify(e.lvlrole)))}return!!e}
+/**
+     * Finds one document in the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The query to search for the document.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#findOne Documentation
+     * @returns {Promise<UserResult | LevelRoleResult>} The found document.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */static async findOne(query){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"findOne()",message:"No database connection"});let e;switch(xp_1.xp.dbType){case"mongodb":e="simply-xps"===query.collection?await xp_1.xp.database.db().collection(query.collection).findOne(query.data).catch(error=>handleError(error,"findOne()")):await xp_1.xp.database.db().collection(query.collection).findOne({guild:query.data.guild,"lvlrole.lvl":query.data.lvlrole.lvl}).catch(error=>handleError(error,"findOne()"));break;case"sqlite":e="simply-xps"===query.collection?xp_1.xp.database.prepare('SELECT * FROM "simply-xps" WHERE guild = ? AND user = ?').get(query.data.guild,query.data.user):(e=await this.find(query)).filter(row=>row.lvlrole.lvl===query.data.lvlrole.lvl)[0]}return e}
+/**
+     * Finds multiple documents in the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The query to search for multiple documents.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#find Documentation
+     * @returns {Promise<UserResult[] | LevelRoleResult[]>} An array of found documents.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */static async find(query){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"find()",message:"No database connection"});let e;switch(xp_1.xp.dbType){case"mongodb":e=xp_1.xp.database.db().collection(query.collection).find(query.data).toArray().catch(error=>handleError(error,"find()"));break;case"sqlite":"simply-xps"===query.collection?e=xp_1.xp.database.prepare('SELECT * FROM "simply-xps" WHERE guild = ?').all(query.data.guild):(e=xp_1.xp.database.prepare('SELECT * FROM "simply-xp-levelroles" WHERE gid = ?').all(query.data.guild)).length&&(e=await Promise.all(e.map(async row=>(row.lvlrole=JSON.parse(row.lvlrole),row))))}return e}
+/**
+     * Finds all documents in a collection.
+     * @param {"simply-xps" | "simply-xp-levelroles"} collection - The collection to search for all documents.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#findAll Documentation
+     * @returns {Promise<UserResult[] | LevelRoleResult[]>} An array of found documents.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */static async findAll(collection){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"findAll()",message:"No database connection"});let e;switch(xp_1.xp.dbType){case"mongodb":e=xp_1.xp.database.db().collection(collection).find().toArray().catch(error=>handleError(error,"findAll()"));break;case"sqlite":"simply-xps"===collection?e=xp_1.xp.database.prepare('SELECT * FROM "simply-xps"').all():(e=xp_1.xp.database.prepare('SELECT * FROM "simply-xp-levelroles"').all()).length&&(e=await Promise.all(e.map(async row=>(row.lvlrole=JSON.parse(row.lvlrole),row))))}return e}
+/**
+     * Updates one document in the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} filter - The document to update.
+     * @param {UserOptions | LevelRoleOptions} update - The document update data.
+     * @param {object} [options] - MongoDB options for updating the document.
+     * @link https://simplyxp.js.org/docs/next/handlers/database#updateOne Documentation
+     * @returns {Promise<UserResult | LevelRoleResult>} The updated document.
+     * @throws {XpFatal} Throws an error if there is no database connection.
+     */static async updateOne(filter,update,options){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"updateOne()",message:"No database connection"});switch(xp_1.xp.dbType){case"mongodb":await xp_1.xp.database.db().collection(update.collection).updateOne(filter.data,{$set:{...update.data,lastUpdated:(new Date).toISOString()}},options).catch(error=>handleError(error,"updateOne()"));break;case"sqlite":if("simply-xps"===filter.collection&&"simply-xps"===update.collection)xp_1.xp.database.prepare(`UPDATE "simply-xps" SET xp_rate = ?, xp = ?, lastUpdated = ?, level = ? ${update.data?.name?", name = ?":""} WHERE guild = ? AND user = ?`).run(update.data?.name?[update.data.xp_rate,update.data.xp,(new Date).toISOString(),update.data.level,update.data.name,filter.data.guild,filter.data.user]:[update.data.xp_rate,update.data.xp,(new Date).toISOString(),update.data.level,filter.data.guild,filter.data.user]);else{if("simply-xp-levelroles"!==filter.collection||"simply-xp-levelroles"!==update.collection)throw new xplogs_1.XpFatal({function:"updateOne()",message:"Collection mismatch, expected same collection on both filter and update."});xp_1.xp.database.prepare('UPDATE "simply-xp-levelroles" SET lvlrole = ? WHERE gid = ?').run(JSON.stringify(update.data.lvlrole),filter.data.guild)}}return db.findOne(update)}}exports.db=db;

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

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+interface HttpsOptions {
+    body?: object;
+    endpoint?: string;
+    headers?: Record<string, string>;
+    method?: "GET" | "POST";
+    responseType?: "json" | "stream" | "text";
+    statusCode?: number;
+    timeout?: number;
+}
+/**
+ * Send HTTPS Request.
+ * @param {string} url
+ * @param {HttpsOptions} options
+ * @param {Object} [options.body]
+ * @param {string} [options.endpoint]
+ * @param {Record<string, string>} [options.headers]
+ * @param {("GET"|"POST")} [options.method="GET"]
+ * @param {("json"|"stream"|"text")} [options.responseType="json"] - Expected response type.
+ * @param {number} [options.statusCode] - Expected status code.
+ * @param {number} [options.timeout] - Request Timeout in Milliseconds
+ * @returns {Promise<Object|Buffer|string>} - Returns the response from the request.
+ * @throws {PromiseRejectedResult} - If the request fails.
+ */
+export declare function https(url: string, options?: HttpsOptions): Promise<object | Buffer | string>;
+export {};

package/lib/src/functions/https.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * Send HTTPS Request.
+ * @param {string} url
+ * @param {HttpsOptions} options
+ * @param {Object} [options.body]
+ * @param {string} [options.endpoint]
+ * @param {Record<string, string>} [options.headers]
+ * @param {("GET"|"POST")} [options.method="GET"]
+ * @param {("json"|"stream"|"text")} [options.responseType="json"] - Expected response type.
+ * @param {number} [options.statusCode] - Expected status code.
+ * @param {number} [options.timeout] - Request Timeout in Milliseconds
+ * @returns {Promise<Object|Buffer|string>} - Returns the response from the request.
+ * @throws {PromiseRejectedResult} - If the request fails.
+ */function https(url,options={}){return new Promise((resolve,reject)=>{const e=(0,https_1.request)({agent:new https_1.Agent({keepAlive:!0}),headers:options?.headers||{"Content-Type":"application/json"},hostname:new url_1.URL(url).hostname,method:options?.method||"GET",path:options?.endpoint||new url_1.URL(url).pathname},response=>{const e=[];response.on("error",reject),response.on("data",chunk=>e.push(Buffer.from(chunk))),response.on("end",()=>{options?.statusCode&&response.statusCode!==options?.statusCode&&reject({error:"Unexpected Status Code",status:response.statusCode});try{switch(options?.responseType||"json"){case"json":resolve(JSON.parse(Buffer.concat(e).toString()));break;case"stream":resolve(Buffer.concat(e));break;default:resolve(Buffer.concat(e).toString())}}catch(e){reject(e)}})}).on("error",reject);e.setTimeout(options?.timeout||5e3,()=>{e.destroy(),reject({error:"Request Timed Out",status:408})}),options?.body&&e.write(JSON.stringify(options.body)),e.end()})}Object.defineProperty(exports,"__esModule",{value:!0}),exports.https=void 0;const https_1=require("https"),url_1=require("url");exports.https=https;

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

@@ -0,0 +1,79 @@
+import { Database } from "better-sqlite3";
+import { Plugin } from "../../xp";
+import { MongoClient } from "mongodb";
+/**
+ * Options for clean function.
+ * @property {boolean} [db=false] - Whether to clean the database or not.
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/clean
+ */
+type CleanOptions = {
+    db?: boolean;
+};
+/**
+ * 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_clean - Whether to automatically clean database and cache.
+ * @property {object} dbOptions - The database options.
+ * @property {"mongodb" | "sqlite"} dbOptions.type - The database type.
+ * @property {MongoClient | Database} dbOptions.database - The database connection.
+ * @property {boolean} debug - Whether to enable debug logs.
+ * @property {boolean} notify - Enable/Disable console notifications.
+ * @property {"slow" | "normal" | "fast" | number} xp_rate - The XP rate.
+ */
+interface NewClientOptions {
+    auto_create: boolean;
+    auto_clean: boolean;
+    dbOptions: {
+        type: "mongodb" | "sqlite";
+        database: MongoClient | Database;
+    };
+    debug: boolean;
+    notify: boolean;
+    xp_rate?: "slow" | "normal" | "fast" | number;
+}
+/**
+ * Helps to clean the database and cache, more in the future, maybe.
+ * @param {CleanOptions} [options={}] - The options.
+ * @param {boolean?} options.db - Whether to clean the database or not.
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/clean
+ * @returns {void} - Nothing.
+ * @throws {XpFatal} If an error occurs.
+ */
+export declare function clean(options?: CleanOptions): void;
+/**
+ * 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/next/Functions/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;
+/**
+ * Registers fonts from URLs or paths (For convenience).
+ * @param {string} pathOrURL - The path or URL to the font.
+ * @param {string} name - The name of the font.
+ * @param {number} [timeout=1500] - The timeout for the request.
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/Functions/registerFont
+ * @returns {Promise<void>} - Nothing.
+ * @throws {XpFatal} If an invalid path or URL is provided.
+ */
+export declare function registerFont(pathOrURL: string, name: string, timeout?: number): Promise<void>;
+/**
+ * Register Simply-XP Plugins.
+ * @param {Plugin[]} plugins - The plugins to register.
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/Functions/registerPlugins
+ * @returns {void} - Nothing.
+ * @throws {XpFatal} If an invalid plugin is provided.
+ */
+export declare function registerPlugins(plugins: Plugin[]): void;
+/**
+ * Updates the options of the XP client.
+ * @param {NewClientOptions} clientOptions - The new options to update.
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/Functions/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,43 @@
+"use strict";
+/**
+ * Helps to clean the database and cache, more in the future, maybe.
+ * @param {CleanOptions} [options={}] - The options.
+ * @param {boolean?} options.db - Whether to clean the database or not.
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/clean
+ * @returns {void} - Nothing.
+ * @throws {XpFatal} If an error occurs.
+ */function clean(options={}){options?.db&&xp_1.xp?.database&&xp_1.db.findAll("simply-xps").then(users=>{users.forEach(async user=>{0===user.level&&0===user.xp&&await xp_1.db.deleteOne({collection:"simply-xps",data:{user:user.user,guild:user.guild}})}),xplogs_1.XpLog.debug("clean()","REMOVED ALL USERS WITHOUT XP")}),(0,canvas_1.clearAllCache)(),xplogs_1.XpLog.debug("clean()","CLEARED CANVAS CACHE")}
+/**
+ * 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/next/Functions/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(isNaN(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(Math.max(0,value)/xp_1.xp.xp_rate,2);if("xp"===type)return Math.floor(xp_1.xp.xp_rate*Math.sqrt(Math.max(0,value)));throw new xplogs_1.XpFatal({function:"convertFrom()",message:"Invalid type provided"})}
+/**
+ * Registers fonts from URLs or paths (For convenience).
+ * @param {string} pathOrURL - The path or URL to the font.
+ * @param {string} name - The name of the font.
+ * @param {number} [timeout=1500] - The timeout for the request.
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/Functions/registerFont
+ * @returns {Promise<void>} - Nothing.
+ * @throws {XpFatal} If an invalid path or URL is provided.
+ */async function registerFont(pathOrURL,name,timeout=1500){xp_1.xp.registeredFonts.includes(name)||(pathOrURL.startsWith("https://")?await(0,xp_1.https)(pathOrURL,{responseType:"stream",timeout:timeout}).then(font=>{canvas_1.GlobalFonts.register(font,name),xp_1.xp.registeredFonts.push(name)}).catch(error=>{throw new xplogs_1.XpFatal({function:"registerFont()",message:`Failed to register font from URL
+`+JSON.stringify(error)})}):(canvas_1.GlobalFonts.registerFromPath(pathOrURL,name),xp_1.xp.registeredFonts.push(name)))}
+/**
+ * Register Simply-XP Plugins.
+ * @param {Plugin[]} plugins - The plugins to register.
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/Functions/registerPlugins
+ * @returns {void} - Nothing.
+ * @throws {XpFatal} If an invalid plugin is provided.
+ */function registerPlugins(plugins){if(!Array.isArray(plugins))throw new xplogs_1.XpFatal({function:"registerPlugins()",message:"Plugins must be an array"});plugins.forEach(async plugin=>{let e=!1,t=!0;if(plugin?.initialize&&plugin?.name||(t=!1,xplogs_1.XpLog.warn("registerPlugins()",plugin?.name?plugin.name.toUpperCase()+" PLUGIN NOT INITIALIZED: No initialize function provided.":"INVALID PLUGIN PROVIDED")),Array.isArray(plugin?.requiredVersions)&&!plugin.requiredVersions.includes(xp_1.xp.version)&&(plugin.requiredVersions.forEach(version=>{parseInt(version)?t=!(!parseInt(version)||1!==version.length||xp_1.xp.version.split(".")[0]!==version):version.match(/\d\.\d\.\d/)||t||(e=!0,t=!0)}),e&&xplogs_1.XpLog.warn("registerPlugins()",plugin.name.toUpperCase()+" PLUGIN FAILED VERSION CHECKS, ANYWAYS..."),t||e||xplogs_1.XpLog.warn("registerPlugins()",plugin.name.toUpperCase()+" PLUGIN NOT INITIALIZED: Requires: v"+plugin.requiredVersions.join(", v"))),t)try{await plugin.initialize(xp_1.xp).then(()=>{xplogs_1.XpLog.info("registerPlugins()",plugin.name.toUpperCase()+" PLUGIN INITIALIZED")})}catch(e){throw new xplogs_1.XpFatal({function:"registerPlugins()",message:`Failed to initialize plugin: ${plugin.name}
+`+e})}})}
+/**
+ * Updates the options of the XP client.
+ * @param {NewClientOptions} clientOptions - The new options to update.
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/Functions/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(clientOptions?.auto_clean&&(xp_1.xp.auto_clean=!0),clientOptions?.auto_create&&(xp_1.xp.auto_create=!0),clientOptions?.debug&&(xp_1.xp.debug=!0),clientOptions?.notify&&(xp_1.xp.notify=clientOptions.notify),clientOptions?.xp_rate&&("number"==typeof clientOptions.xp_rate||["fast","normal","slow"].includes(clientOptions.xp_rate))&&(xp_1.xp.xp_rate="slow"===clientOptions.xp_rate?.05:"normal"===clientOptions.xp_rate?.1:"fast"===clientOptions.xp_rate?.5:clientOptions.xp_rate),clientOptions.dbOptions&&"object"==typeof clientOptions.dbOptions&&clientOptions.dbOptions.type&&clientOptions.dbOptions.database){var{type:e,database:t}=clientOptions.dbOptions;if(!(e&&"mongodb"===e||"sqlite"===e))throw new xplogs_1.XpFatal({function:"updateOptions()",message:"Invalid database type provided"});if(xp_1.xp.dbType=e,t){xp_1.xp.database=t;const n="mongodb"===xp_1.xp.dbType?{name:"MongoDB",type:"mongodb",min:3,max:6}:{name:"Better-SQLite3",type:"better-sqlite3",min:7,max:9};(0,connect_1.checkPackageVersion)(n.type,n.min,n.max).then(result=>{if(!result)throw new xplogs_1.XpFatal({function:"updateOptions()",message:`${n.name} V${n.min} up to V${n.max} is required.`});switch(xp_1.xp.dbType){case"mongodb":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"})});break;case"sqlite":try{xp_1.xp.database.prepare("SELECT 1").get()}catch(e){throw new xplogs_1.XpFatal({function:"updateOptions()",message:"Invalid SQLite connection"})}}})}}clientOptions?.auto_clean&&clean({db:!0}),xp_1.db.findAll("simply-xps").then(users=>{users.filter(user=>user?.xp_rate!==xp_1.xp.xp_rate).map(async user=>{await xp_1.db.updateOne({collection:"simply-xps",data:{user:user.user,guild:user.guild}},{collection:"simply-xps",data:{user:user.user,guild:user.guild,level:convertFrom(user.xp,"xp"),xp:user.xp,xp_rate:xp_1.xp.xp_rate}})}),xplogs_1.XpLog.debug("updateOptions()","UPDATED ALL USERS WITH NEW XP RATE")})}Object.defineProperty(exports,"__esModule",{value:!0}),exports.updateOptions=exports.registerPlugins=exports.registerFont=exports.convertFrom=exports.clean=void 0;const connect_1=require("../connect"),canvas_1=require("@napi-rs/canvas"),xp_1=require("../../xp"),xplogs_1=require("./xplogs");exports.clean=clean,exports.convertFrom=convertFrom,exports.registerFont=registerFont,exports.registerPlugins=registerPlugins,exports.updateOptions=updateOptions;

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

@@ -0,0 +1,81 @@
+import { UserResult } from "./database";
+type errOptions = {
+    function: string;
+    message: string | Error;
+};
+/**
+ * Emits a fatal error message
+ * @class XpFatal
+ */
+export declare class XpFatal extends Error {
+    /**
+     * Emits a simple error message
+     * @param {errOptions} options
+     * @private
+     */
+    constructor(options: errOptions);
+}
+/**
+ * Emits a log message
+ * @class XpLog
+ * @private
+ */
+export declare class XpLog {
+    /**
+     * Emits a log message with the specified level
+     * @param {("debug" | "error" | "info" | "warn")} level - The log level (e.g., 'info', 'error', 'warn')
+     * @param {string} xpFunction - The command or context of the log message
+     * @param {string} message - The log message
+     * @private
+     */
+    static log(level: ("debug" | "error" | "info" | "warn"), xpFunction: string, message: string): void;
+    /**
+     * Emits a debug log
+     * @param {string} xpFunction - The command or context of the log message
+     * @param {string} message - The log message
+     * @private
+     */
+    static debug(xpFunction: string, message: string): void;
+    /**
+     * Emits an info log
+     * @param {string} xpFunction - The command or context of the log message
+     * @param {string} message - The log message
+     * @returns {boolean} Returns true
+     * @private
+     */
+    static info(xpFunction: string, message: string): boolean;
+    /**
+     * Emits an error log
+     * @param {string} xpFunction - The command or context of the log message
+     * @param {string} message - The log message
+     * @returns {boolean} Returns false
+     * @private
+     */
+    static err(xpFunction: string, message: string): boolean;
+    /**
+     * Emits a warning log
+     * @param {string} xpFunction - The command or context of the log message
+     * @param {string} message - The log message
+     * @private
+     */
+    static warn(xpFunction: string, message: string): void;
+}
+export type XpEventCallback = {
+    custom: (message: string) => void;
+    debug: (xpFunction: string, message: string) => void;
+    error: (xpFunction: string, message: string) => void;
+    info: (xpFunction: string, message: string) => void;
+    levelDown: (data: UserResult, lostRoles: string[]) => void;
+    levelUp: (data: UserResult, newRoles: string[]) => void;
+    warn: (xpFunction: string, message: string) => void;
+};
+/**
+ * Event handler for XP events
+ * @class XpEvents
+ * @public
+ */
+export declare class XpEvents {
+    static eventCallback: XpEventCallback;
+    static on(callbacks: XpEventCallback): void;
+}
+export {};

package/lib/src/functions/xplogs.js

@@ -0,0 +1,15 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.XpEvents=exports.XpLog=exports.XpFatal=void 0;const xp_1=require("../../xp");class XpFatal extends Error{constructor(options){super(options.function+": "+options.message)}}exports.XpFatal=XpFatal,Object.defineProperty(XpFatal.prototype,"name",{value:"SimplyXpFatal"});class XpLog{static log(level,xpFunction,message){var e=XpEvents.eventCallback?.[level],t=level.toUpperCase(),s=xpFunction.toUpperCase();e&&"function"==typeof e?e(xpFunction,message):console.log(`[SIMPLY XP] ${{debug:"",info:"",error:"",warn:""}[level]}(${t}) ${s}: `+message)}static debug(xpFunction,message){xp_1.xp.debug&&XpLog.log("debug",xpFunction,message)}
+/**
+     * Emits an info log
+     * @param {string} xpFunction - The command or context of the log message
+     * @param {string} message - The log message
+     * @returns {boolean} Returns true
+     * @private
+     */static info(xpFunction,message){return xp_1.xp.notify&&XpLog.log("info",xpFunction,message),!0}
+/**
+     * Emits an error log
+     * @param {string} xpFunction - The command or context of the log message
+     * @param {string} message - The log message
+     * @returns {boolean} Returns false
+     * @private
+     */static err(xpFunction,message){return XpLog.log("error",xpFunction,message),!1}static warn(xpFunction,message){XpLog.log("warn",xpFunction,message)}}exports.XpLog=XpLog;class XpEvents{static eventCallback;static on(callbacks){XpEvents.eventCallback=callbacks}}exports.XpEvents=XpEvents;

package/lib/src/leaderboard.d.ts

@@ -0,0 +1,11 @@
+import { User } from "../xp";
+/**
+ * Get array of all users in the leaderboard
+ * @async
+ * @param {string?} guildId - Guild ID (optional)
+ * @param {number} limit - Limit of users to return
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/functions/leaderboard
+ * @returns {Promise<User[]>} Array of all users in the leaderboard
+ * @throws {XpFatal} If guild ID is not provided or limit is less than 1
+ */
+export declare function leaderboard(guildId?: string, limit?: number): Promise<User[]>;

package/lib/src/leaderboard.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * Get array of all users in the leaderboard
+ * @async
+ * @param {string?} guildId - Guild ID (optional)
+ * @param {number} limit - Limit of users to return
+ * @link `Documentation:` https://simplyxp.js.org/docs/next/functions/leaderboard
+ * @returns {Promise<User[]>} Array of all users in the leaderboard
+ * @throws {XpFatal} If guild ID is not provided or limit is less than 1
+ */async function leaderboard(guildId,limit){if(limit&&!(1<=limit))throw new xplogs_1.XpFatal({function:"leaderboard()",message:"Limit must be a number greater than 0"});const e=new Set;return guildId=guildId?(await xp_1.db.find({collection:"simply-xps",data:{guild:guildId}})).sort((a,b)=>b.xp-a.xp):(await xp_1.db.findAll("simply-xps")).sort((a,b)=>b.xp-a.xp).filter(user=>!e.has(user.user)&&(e.add(user.user),!0)),await Promise.all(guildId.map(async(user,index)=>(user.position=index+1,user))),guildId.slice(0,limit)}Object.defineProperty(exports,"__esModule",{value:!0}),exports.leaderboard=void 0;const xplogs_1=require("./functions/xplogs"),xp_1=require("../xp");exports.leaderboard=leaderboard;

package/lib/src/migrate.d.ts

@@ -0,0 +1,27 @@
+import { MongoClient } from "mongodb";
+import { Database } from "better-sqlite3";
+/**
+ * Migration functions
+ * @class migrate
+ */
+export declare class migrate {
+    /**
+     * Effortlessly migrate from discord-xp to simply-xp.
+     * @async
+     * @param {boolean} deleteOld - Delete old data after migration
+     * @link `Documentation:` https://simplyxp.js.org/docs/next/classes/migrate#migratediscord_xp
+     * @returns {Promise<boolean>} - Returns true if migration is successful
+     * @throws {XpLog.err} - If migration fails.
+     */
+    static discord_xp(deleteOld?: boolean): Promise<boolean>;
+    /**
+     * Effortlessly migrate from MongoDB to SQLite. (or vice versa)
+     * @async
+     * @param {"mongodb"|"sqlite"} dbType
+     * @param {Database | MongoClient} connection
+     * @link `Documentation:` https://simplyxp.js.org/docs/next/classes/migrate#migratefromdb
+     * @returns {Promise<boolean>} - Returns true if migration is successful
+     * @throws {XpFatal} - If parameters are not provided correctly
+     */
+    static fromDB(dbType: "mongodb" | "sqlite", connection: Database | MongoClient): Promise<boolean>;
+}

package/lib/src/migrate.js

@@ -0,0 +1,19 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.migrate=void 0;const xplogs_1=require("./functions/xplogs"),xp_1=require("../xp"),connect_1=require("./connect");class migrate{
+/**
+     * Effortlessly migrate from discord-xp to simply-xp.
+     * @async
+     * @param {boolean} deleteOld - Delete old data after migration
+     * @link `Documentation:` https://simplyxp.js.org/docs/next/classes/migrate#migratediscord_xp
+     * @returns {Promise<boolean>} - Returns true if migration is successful
+     * @throws {XpLog.err} - If migration fails.
+     */
+static async discord_xp(deleteOld=!1){var e=await xp_1.db.getCollection("levels").find().toArray();xplogs_1.XpLog.debug("migrate.discord_xp()",`FOUND ${e.length} DOCUMENTS`);try{for(const r of e)await xp_1.db.findOne({collection:"simply-xps",data:{guild:r.guildID,user:r.userID}})||(await xp_1.db.createOne({collection:"simply-xps",data:{guild:r.guildID,user:r.userID,xp:r.xp,level:(0,xp_1.convertFrom)(r.xp,"xp")}}),deleteOld&&await xp_1.db.getCollection("levels").deleteOne({userID:r.userID,guildID:r.guildID}));return!0}catch(e){return xplogs_1.XpLog.err("migrate.discord_xp()",e),!1}}
+/**
+     * Effortlessly migrate from MongoDB to SQLite. (or vice versa)
+     * @async
+     * @param {"mongodb"|"sqlite"} dbType
+     * @param {Database | MongoClient} connection
+     * @link `Documentation:` https://simplyxp.js.org/docs/next/classes/migrate#migratefromdb
+     * @returns {Promise<boolean>} - Returns true if migration is successful
+     * @throws {XpFatal} - If parameters are not provided correctly
+     */static async fromDB(dbType,connection){if(!dbType)throw new xplogs_1.XpFatal({function:"migrate.database()",message:"No database type provided"});if(!connection)throw new xplogs_1.XpFatal({function:"migrate.database()",message:"No database connection provided"});if(xp_1.xp.dbType===dbType)return xplogs_1.XpLog.info("migrate.fromDB()","Same database received, that was unnecessary!");let e;switch(dbType){case"mongodb":try{if(!await(0,connect_1.checkPackageVersion)("mongodb",4,6))return xplogs_1.XpLog.err("migrate.fromDB()","MongoDB V4 up to V6 is required");e=await connection.db().collection("simply-xps").find().toArray()}catch(e){return xplogs_1.XpLog.err("migrate.fromDB()",e),!1}break;case"sqlite":try{if(!await(0,connect_1.checkPackageVersion)("better-sqlite3",7,8))return xplogs_1.XpLog.err("migrate.fromDB()","better-sqlite3 V7 up to V8 is required");e=connection.prepare("SELECT * FROM `simply-xps`").all()}catch(e){return xplogs_1.XpLog.err("migrate.fromDB()",e),!1}}return xplogs_1.XpLog.debug("migrate.fromDB()",`FOUND ${e.length} RESULTS`),await Promise.all(e.map(async user=>await xp_1.db.findOne({collection:"simply-xps",data:{guild:user.guild,user:user.user}})?xp_1.db.updateOne({collection:"simply-xps",data:{guild:user.guild,user:user.user}},{collection:"simply-xps",data:{guild:user.guild,user:user.user,name:user.name,xp:user.xp,level:user.level}}):xp_1.db.createOne({collection:"simply-xps",data:{guild:user.guild,user:user.user,xp:user.xp,level:user.level}}))),!0}}exports.migrate=migrate;

package/lib/src/remove.d.ts

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