simply-xp 1.3.7 → 2.0.0-beta.0-fix.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(e,a){throw new xplogs_1.XpFatal({function:"db."+a,message:e})}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(e){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(e)}
+/**
+     * 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(e){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(e.collection).insertOne({...e.data,lastUpdated:(new Date).toISOString()}).catch(e=>handleError(e,"createOne()"));break;case"sqlite":"simply-xps"===e.collection?xp_1.xp.database.prepare('INSERT INTO "simply-xps" (user, guild, level, name, lastUpdated, xp, xp_rate) VALUES (?, ?, ?, ?, ?, ?, ?)').run(e.data.user,e.data.guild,e.data.level,e.data?.name,(new Date).toISOString(),e.data.xp,e.data.xp_rate):xp_1.xp.database.prepare('INSERT INTO "simply-xp-levelroles" (gid, lvlrole, lastUpdated) VALUES (?, ?, ?)').run(e.data.guild,JSON.stringify(e.data.lvlrole),(new Date).toISOString())}return db.findOne(e)}
+/**
+     * 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(e){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"deleteMany()",message:"No database connection"});let a;switch(xp_1.xp.dbType){case"mongodb":a=xp_1.xp.database.db().collection(e.collection).deleteMany(e.data).catch(e=>handleError(e,"deleteMany()"));break;case"sqlite":a=("simply-xps"===e.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(e.data.guild)}return!!a}
+/**
+     * 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(a){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(a.collection).deleteOne(a.data).catch(e=>handleError(e,"deleteOne()"));break;case"sqlite":e="simply-xps"===a.collection?xp_1.xp.database.prepare('DELETE FROM "simply-xps" WHERE guild = ? AND user = ?').run(a.data.guild,a.data.user):(e=(e=await this.find(a)).filter(e=>e.lvlrole.lvl===a.data.lvlrole.lvl)[0],xp_1.xp.database.prepare('DELETE FROM "simply-xp-levelroles" WHERE gid = ? AND lvlrole = ?').run(a.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(a){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"===a.collection?await xp_1.xp.database.db().collection(a.collection).findOne(a.data).catch(e=>handleError(e,"findOne()")):await xp_1.xp.database.db().collection(a.collection).findOne({guild:a.data.guild,"lvlrole.lvl":a.data.lvlrole.lvl}).catch(e=>handleError(e,"findOne()"));break;case"sqlite":e="simply-xps"===a.collection?xp_1.xp.database.prepare('SELECT * FROM "simply-xps" WHERE guild = ? AND user = ?').get(a.data.guild,a.data.user):(e=await this.find(a)).filter(e=>e.lvlrole.lvl===a.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(e){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"find()",message:"No database connection"});let a;switch(xp_1.xp.dbType){case"mongodb":a=xp_1.xp.database.db().collection(e.collection).find(e.data).toArray().catch(e=>handleError(e,"find()"));break;case"sqlite":"simply-xps"===e.collection?a=xp_1.xp.database.prepare('SELECT * FROM "simply-xps" WHERE guild = ?').all(e.data.guild):(a=xp_1.xp.database.prepare('SELECT * FROM "simply-xp-levelroles" WHERE gid = ?').all(e.data.guild)).length&&(a=await Promise.all(a.map(async e=>(e.lvlrole=JSON.parse(e.lvlrole),e))))}return a}
+/**
+     * 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(e){if(!xp_1.xp.database)throw new xplogs_1.XpFatal({function:"findAll()",message:"No database connection"});let a;switch(xp_1.xp.dbType){case"mongodb":a=xp_1.xp.database.db().collection(e).find().toArray().catch(e=>handleError(e,"findAll()"));break;case"sqlite":"simply-xps"===e?a=xp_1.xp.database.prepare('SELECT * FROM "simply-xps"').all():(a=xp_1.xp.database.prepare('SELECT * FROM "simply-xp-levelroles"').all()).length&&(a=await Promise.all(a.map(async e=>(e.lvlrole=JSON.parse(e.lvlrole),e))))}return a}
+/**
+     * 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(e,a,t){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(a.collection).updateOne(e.data,{$set:{...a.data,lastUpdated:(new Date).toISOString()}},t).catch(e=>handleError(e,"updateOne()"));break;case"sqlite":if("simply-xps"===e.collection&&"simply-xps"===a.collection)xp_1.xp.database.prepare(`UPDATE "simply-xps" SET xp_rate = ?, xp = ?, lastUpdated = ?, level = ? ${a.data?.name?", name = ?":""} WHERE guild = ? AND user = ?`).run(a.data?.name?[a.data.xp_rate,a.data.xp,(new Date).toISOString(),a.data.level,a.data.name,e.data.guild,e.data.user]:[a.data.xp_rate,a.data.xp,(new Date).toISOString(),a.data.level,e.data.guild,e.data.user]);else{if("simply-xp-levelroles"!==e.collection||"simply-xp-levelroles"!==a.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(a.data.lvlrole),e.data.guild)}}return db.findOne(a)}}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(e,o={}){return new Promise((s,r)=>{const t=(0,https_1.request)({agent:new https_1.Agent({keepAlive:!0}),headers:o?.headers||{"Content-Type":"application/json"},hostname:new url_1.URL(e).hostname,method:o?.method||"GET",path:o?.endpoint||new url_1.URL(e).pathname},t=>{const e=[];t.on("error",r),t.on("data",t=>e.push(Buffer.from(t))),t.on("end",()=>{o?.statusCode&&t.statusCode!==o?.statusCode&&r({error:"Unexpected Status Code",status:t.statusCode});try{switch(o?.responseType||"json"){case"json":s(JSON.parse(Buffer.concat(e).toString()));break;case"stream":s(Buffer.concat(e));break;default:s(Buffer.concat(e).toString())}}catch(t){r(t)}})}).on("error",r);t.setTimeout(o?.timeout||5e3,()=>{t.destroy(),r({error:"Request Timed Out",status:408})}),o?.body&&t.write(JSON.stringify(o.body)),t.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,82 @@
+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";
+        database: MongoClient;
+    } | {
+        type: "sqlite";
+        database: 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(e={}){e?.db&&xp_1.xp?.database&&xp_1.db.findAll("simply-xps").then(e=>{e.forEach(async e=>{0===e.level&&0===e.xp&&await xp_1.db.deleteOne({collection:"simply-xps",data:{user:e.user,guild:e.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(e,t="level"){if(isNaN(e))throw new xplogs_1.XpFatal({function:"convertFrom()",message:"Value was not provided"});if("xp"!==t&&"level"!==t)throw new xplogs_1.XpFatal({function:"convert()",message:"Invalid type provided"});if("level"===t)return Math.pow(Math.max(0,e)/xp_1.xp.xp_rate,2);if("xp"===t)return Math.floor(xp_1.xp.xp_rate*Math.sqrt(Math.max(0,e)));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(e,t,a=1500){xp_1.xp.registeredFonts.includes(t)||(e.startsWith("https://")?await(0,xp_1.https)(e,{responseType:"stream",timeout:a}).then(e=>{canvas_1.GlobalFonts.register(e,t),xp_1.xp.registeredFonts.push(t)}).catch(e=>{throw new xplogs_1.XpFatal({function:"registerFont()",message:`Failed to register font from URL
+`+JSON.stringify(e)})}):(canvas_1.GlobalFonts.registerFromPath(e,t),xp_1.xp.registeredFonts.push(t)))}
+/**
+ * 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(e){if(!Array.isArray(e))throw new xplogs_1.XpFatal({function:"registerPlugins()",message:"Plugins must be an array"});e.forEach(async t=>{let a=!1,p=!0;if(t?.initialize&&t?.name||(p=!1,xplogs_1.XpLog.warn("registerPlugins()",t?.name?t.name.toUpperCase()+" PLUGIN NOT INITIALIZED: No initialize function provided.":"INVALID PLUGIN PROVIDED")),Array.isArray(t?.requiredVersions)&&!t.requiredVersions.includes(xp_1.xp.version)&&(t.requiredVersions.forEach(e=>{parseInt(e)?p=!(!parseInt(e)||1!==e.length||xp_1.xp.version.split(".")[0]!==e):e.match(/\d\.\d\.\d/)||p||(a=!0,p=!0)}),a&&xplogs_1.XpLog.warn("registerPlugins()",t.name.toUpperCase()+" PLUGIN FAILED VERSION CHECKS, ANYWAYS..."),p||a||xplogs_1.XpLog.warn("registerPlugins()",t.name.toUpperCase()+" PLUGIN NOT INITIALIZED: Requires: v"+t.requiredVersions.join(", v"))),p)try{await t.initialize(xp_1.xp).then(()=>{xplogs_1.XpLog.info("registerPlugins()",t.name.toUpperCase()+" PLUGIN INITIALIZED")})}catch(e){throw new xplogs_1.XpFatal({function:"registerPlugins()",message:`Failed to initialize plugin: ${t.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(e){if(!e)throw new xplogs_1.XpFatal({function:"updateOptions()",message:"Options were not provided"});if("object"!=typeof e)throw new xplogs_1.XpFatal({function:"updateOptions()",message:"Options must be an object"});if(e?.auto_clean&&(xp_1.xp.auto_clean=!0),e?.auto_create&&(xp_1.xp.auto_create=!0),e?.debug&&(xp_1.xp.debug=!0),e?.notify&&(xp_1.xp.notify=e.notify),e?.xp_rate&&("number"==typeof e.xp_rate||["fast","normal","slow"].includes(e.xp_rate))&&(xp_1.xp.xp_rate="slow"===e.xp_rate?.05:"normal"===e.xp_rate?.1:"fast"===e.xp_rate?.5:e.xp_rate),e.dbOptions&&"object"==typeof e.dbOptions&&e.dbOptions.type&&e.dbOptions.database){var{type:t,database:a}=e.dbOptions;if(!(t&&"mongodb"===t||"sqlite"===t))throw new xplogs_1.XpFatal({function:"updateOptions()",message:"Invalid database type provided"});if(xp_1.xp.dbType=t,a){xp_1.xp.database=a;const p="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)(p.type,p.min,p.max).then(e=>{if(!e)throw new xplogs_1.XpFatal({function:"updateOptions()",message:`${p.name} V${p.min} up to V${p.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"})}}})}}e?.auto_clean&&clean({db:!0}),xp_1.db.findAll("simply-xps").then(e=>{e.filter(e=>e?.xp_rate!==xp_1.xp.xp_rate).map(async e=>{await xp_1.db.updateOne({collection:"simply-xps",data:{user:e.user,guild:e.guild}},{collection:"simply-xps",data:{user:e.user,guild:e.guild,level:convertFrom(e.xp,"xp"),xp:e.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(e){super(e.function+": "+e.message)}}exports.XpFatal=XpFatal,Object.defineProperty(XpFatal.prototype,"name",{value:"SimplyXpFatal"});class XpLog{static log(e,t,o){var p=XpEvents.eventCallback?.[e],r=e.toUpperCase(),a=t.toUpperCase();p&&"function"==typeof p?p(t,o):console.log(`[SIMPLY XP] ${{debug:"",info:"",error:"",warn:""}[e]}(${r}) ${a}: `+o)}static debug(e,t){xp_1.xp.debug&&XpLog.log("debug",e,t)}
+/**
+     * 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(e,t){return xp_1.xp.notify&&XpLog.log("info",e,t),!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(e,t){return XpLog.log("error",e,t),!1}static warn(e,t){XpLog.log("warn",e,t)}}exports.XpLog=XpLog;class XpEvents{static eventCallback;static on(e){XpEvents.eventCallback=e}}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(e,r){if(r&&!(1<=r))throw new xplogs_1.XpFatal({function:"leaderboard()",message:"Limit must be a number greater than 0"});const a=new Set;return e=e?(await xp_1.db.find({collection:"simply-xps",data:{guild:e}})).sort((e,r)=>r.xp-e.xp):(await xp_1.db.findAll("simply-xps")).sort((e,r)=>r.xp-e.xp).filter(e=>!a.has(e.user)&&(a.add(e.user),!0)),await Promise.all(e.map(async(e,r)=>(e.position=r+1,e))),e.slice(0,r)}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(e=!1){var r=await xp_1.db.getCollection("levels").find().toArray();xplogs_1.XpLog.debug("migrate.discord_xp()",`FOUND ${r.length} DOCUMENTS`);try{for(const t of r)await xp_1.db.findOne({collection:"simply-xps",data:{guild:t.guildID,user:t.userID}})||(await xp_1.db.createOne({collection:"simply-xps",data:{guild:t.guildID,user:t.userID,xp:t.xp,level:(0,xp_1.convertFrom)(t.xp,"xp")}}),e&&await xp_1.db.getCollection("levels").deleteOne({userID:t.userID,guildID:t.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(e,r){if(!e)throw new xplogs_1.XpFatal({function:"migrate.database()",message:"No database type provided"});if(!r)throw new xplogs_1.XpFatal({function:"migrate.database()",message:"No database connection provided"});if(xp_1.xp.dbType===e)return xplogs_1.XpLog.info("migrate.fromDB()","Same database received, that was unnecessary!");let t;switch(e){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");t=await r.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");t=r.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 ${t.length} RESULTS`),await Promise.all(t.map(async e=>await xp_1.db.findOne({collection:"simply-xps",data:{guild:e.guild,user:e.user}})?xp_1.db.updateOne({collection:"simply-xps",data:{guild:e.guild,user:e.user}},{collection:"simply-xps",data:{guild:e.guild,user:e.user,name:e.name,xp:e.xp,level:e.level}}):xp_1.db.createOne({collection:"simply-xps",data:{guild:e.guild,user:e.user,xp:e.xp,level:e.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>;