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

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

@@ -0,0 +1,111 @@
+/**
+ * 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;
+        user?: string;
+        name?: string;
+        level?: number;
+        xp?: number;
+    };
+}
+export type UserResult = {
+    _id?: string;
+    user: string;
+    name?: string;
+    guild: string;
+    level: number;
+    xp: 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 {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.
+ * @class db
+ */
+export declare class db {
+    /**
+     * Creates one document in the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The document to create.
+     * @link https://simplyxp.js.org/docs/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 one document from the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The document to delete.
+     * @link https://simplyxp.js.org/docs/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/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/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[]>;
+    /**
+     * 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/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,56 @@
+"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{
+/**
+     * Creates one document in the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The document to create.
+     * @link https://simplyxp.js.org/docs/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"});let e;switch(xp_1.xp.dbType){case"mongodb":e=xp_1.xp.database.db().collection(query.collection).insertOne(query.data).catch(error=>handleError(error,"createOne()"));break;case"sqlite":e="simply-xps"===query.collection?xp_1.xp.database.prepare('INSERT INTO "simply-xps" (user, guild, xp, level) VALUES (?, ?, ?, ?)').run(query.data.user,query.data.guild,query.data.xp,query.data.level):xp_1.xp.database.prepare('INSERT INTO "simply-xp-levelroles" (guild, level, role) VALUES (?, ?, ?)').run(query.data.guild,query.data.level,query.data.roles)}return e}
+/**
+     * Deletes one document from the database.
+     *
+     * @async
+     * @param {UserOptions | LevelRoleOptions} query - The document to delete.
+     * @link https://simplyxp.js.org/docs/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):xp_1.xp.database.prepare('DELETE FROM "simply-xp-levelroles" WHERE guild = ? AND level = ?').run(query.data.guild,query.data.level)}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/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=xp_1.xp.database.db().collection(query.collection).findOne(query.data).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):xp_1.xp.database.prepare('SELECT * FROM "simply-xp-levelroles" WHERE guild = ? AND level = ?').get(query.data.guild,query.data.level)}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/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":e=("simply-xps"===query.collection?xp_1.xp.database.prepare('SELECT * FROM "simply-xps" WHERE guild = ?'):xp_1.xp.database.prepare('SELECT * FROM "simply-xp-levelroles" WHERE guild = ?')).all(query.data.guild)}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/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},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 = ?, level = ? WHERE guild = ? AND user = ?').run(update.data.xp,update.data.level,filter.data.guild,filter.data.user),"simply-xps"!==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 role = ? WHERE guild = ? AND level = ?').run(update.data.roles,filter.data.guild,filter.data.level)}return db.findOne(update)}}exports.db=db;

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 {"xp" | "level"} type - Type to coreFunctions from. Use either "xp" or "level".
+ * @param {number} value - Value to coreFunctions.
+ * @link `Documentation:` https://simplyxp.js.org/docs/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 convert(type: "xp" | "level", value: number): number;
+/**
+ * Updates the options of the XP client.
+ * @param {NewClientOptions} clientOptions - The new options to update.
+ * @link `Documentation:` https://simplyxp.js.org/docs/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 {"xp" | "level"} type - Type to coreFunctions from. Use either "xp" or "level".
+ * @param {number} value - Value to coreFunctions.
+ * @link `Documentation:` https://simplyxp.js.org/docs/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 convert(type,value){if("xp"!==type&&"level"!==type)throw new xplogs_1.XpFatal({function:"convert()",message:"Invalid type provided"});if(!value)throw new xplogs_1.XpFatal({function:"coreFunctions()",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:"coreFunctions()",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/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.convert=void 0;const xplogs_1=require("./xplogs"),xp_1=require("../../xp"),connect_1=require("../connect");exports.convert=convert,exports.updateOptions=updateOptions;

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

@@ -0,0 +1,59 @@
+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
+ */
+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} command - The command or context of the log message
+     * @param {string} message - The log message
+     * @private
+     */
+    static log(level: ("debug" | "error" | "info" | "warn"), command: string, message: string): void;
+    /**
+     * Emits a debug log
+     * @param {string} command - The command or context of the log message
+     * @param {string} message - The log message
+     * @private
+     */
+    static debug(command: string, message: string): void;
+    /**
+     * Emits an info log
+     * @param {string} command - The command or context of the log message
+     * @param {string} message - The log message
+     * @private
+     */
+    static info(command: string, message: string): void;
+    /**
+     * Emits an error log
+     * @param {string} command - The command or context of the log message
+     * @param {string} message - The log message
+     * @private
+     */
+    static err(command: string, message: string): void;
+    /**
+     * Emits a warning log
+     * @param {string} command - The command or context of the log message
+     * @param {string} message - The log message
+     * @private
+     */
+    static warn(command: string, message: string): void;
+}
+export {};

package/lib/src/functions/xplogs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),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,command,message){var e=level.toUpperCase(),command=command.toUpperCase();console.log(`[SIMPLY XP] ${{debug:"",info:"",error:"",warn:""}[level]}(${e}) ${command}: `+message)}static debug(command,message){xp_1.xp.debug&&XpLog.log("debug",command,message)}static info(command,message){xp_1.xp.notify&&XpLog.log("info",command,message)}static err(command,message){XpLog.log("error",command,message)}static warn(command,message){XpLog.log("warn",command,message)}}exports.XpLog=XpLog;

package/lib/src/leaderboard.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 | null;
+    position?: number;
+    level: number;
+    xp: number;
+}
+/**
+ * Get array of all users in the leaderboard
+ * @async
+ * @param {string} guildId - Guild ID
+ * @param {number} limit - Limit of users to return
+ * @link `Documentation:` https://simplyxp.js.org/docs/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
+ * @param {number} limit - Limit of users to return
+ * @link `Documentation:` https://simplyxp.js.org/docs/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(!guildId)throw new xplogs_1.XpFatal({function:"leaderboard()",message:"Guild ID was not provided"});if(limit&&limit<1)throw new xplogs_1.XpFatal({function:"leaderboard()",message:"Limit must be greater than 0"});return(guildId=(await database_1.db.find({collection:"simply-xps",data:{guild:guildId}})).sort((a,b)=>b.xp-a.xp)).forEach((user,index)=>user.position=index+1),limit?guildId.slice(0,limit):guildId}Object.defineProperty(exports,"__esModule",{value:!0}),exports.leaderboard=void 0;const xplogs_1=require("./functions/xplogs"),database_1=require("./functions/database");exports.leaderboard=leaderboard;

package/lib/src/migrate.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Migration functions
+ * @class migrate
+ */
+export declare class migrate {
+    /**
+     * Effortlessly migrate from discord-xp to simply-xp.
+     * @async
+     * @param {URL} dbUrl - MongoDB URL
+     * @param {boolean} deleteOld - Delete old data after migration
+     * @link `Documentation:` https://simplyxp.js.org/docs/migrate/discord_xp
+     * @returns {Promise<boolean>} - Returns true if migration is successful
+     * @throws {XpFatal} - If parameters are not provided correctly
+     */
+    static discord_xp(dbUrl: URL, deleteOld: boolean): Promise<boolean>;
+    /**
+     * Effortlessly migrate from MongoDB to SQLite. (or vice versa)
+     * @async
+     * @param {"mongodb"|"sqlite"} from
+     * @link `Documentation:` https://simplyxp.js.org/docs/migrate/database
+     * @returns {Promise<boolean>} - Returns true if migration is successful
+     * @throws {XpFatal} - If parameters are not provided correctly
+     */
+    static database(from: "mongodb" | "sqlite"): Promise<void>;
+}

package/lib/src/migrate.js

@@ -0,0 +1,19 @@
+"use strict";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.migrate=void 0;const xplogs_1=require("./functions/xplogs"),database_1=require("./functions/database");class migrate{
+/**
+     * Effortlessly migrate from discord-xp to simply-xp.
+     * @async
+     * @param {URL} dbUrl - MongoDB URL
+     * @param {boolean} deleteOld - Delete old data after migration
+     * @link `Documentation:` https://simplyxp.js.org/docs/migrate/discord_xp
+     * @returns {Promise<boolean>} - Returns true if migration is successful
+     * @throws {XpFatal} - If parameters are not provided correctly
+     */
+static async discord_xp(dbUrl,deleteOld){try{await Promise.resolve().then(()=>__importStar(require("discord-xp"))).setURL(dbUrl);var e=await Promise.resolve().then(()=>__importStar(require("discord.js/package.json")));xplogs_1.XpLog.debug("migrate.discord_xp()",`Discord.JS v${e.version} detected.`);const t=await Promise.resolve().then(()=>__importStar(require("discord-xp/models/levels")));return await t.find({}).then(async data=>{for(const e of data)await database_1.db.findOne({collection:"simply-xps",data:{guild:e.guildID,user:e.userID}})||(await database_1.db.createOne({collection:"simply-xps",data:{guild:e.guildID,user:e.userID,xp:e.xp,level:e.level}}),deleteOld&&await t.deleteOne({userID:e.userID,guildID:e.guildID}))}),!0}catch(e){throw new xplogs_1.XpFatal({function:"migrate.discord_xp()",message:"Unfortunately this function requires discord-xp to be installed, you can uninstall it after using this function!"})}}
+/**
+     * Effortlessly migrate from MongoDB to SQLite. (or vice versa)
+     * @async
+     * @param {"mongodb"|"sqlite"} from
+     * @link `Documentation:` https://simplyxp.js.org/docs/migrate/database
+     * @returns {Promise<boolean>} - Returns true if migration is successful
+     * @throws {XpFatal} - If parameters are not provided correctly
+     */static async database(from){if(from)throw new xplogs_1.XpFatal({function:"migrate.database()",message:"This function is not yet implemented, please wait for the next dev release!"});throw new xplogs_1.XpFatal({function:"migrate.database()",message:"No database type provided"})}}exports.migrate=migrate;

package/lib/src/reset.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Reset user levels to 0 in a guild
+ * @async
+ * @param {string} userId
+ * @param {string} guildId
+ * @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, username: string, erase?: boolean): Promise<boolean>;

package/lib/src/reset.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Reset user levels to 0 in a guild
+ * @async
+ * @param {string} userId
+ * @param {string} guildId
+ * @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,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

@@ -0,0 +1,47 @@
+/**
+ * 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
+ */
+export declare class roleSetup {
+    /**
+     * Add a role to the role setup
+     * @async
+     * @param {string} guildId - The guild ID
+     * @param {RoleSetupObject} options - Level/role options
+     * @link `Documentation:` https://simplyxp.js.org/docs/roleSetup/add
+     * @returns {Promise<boolean>} - True if successful
+     * @throws {XpFatal} If an invalid type is provided or value is not provided.
+     */
+    static add(guildId: string, options: RoleSetupObject): Promise<boolean>;
+    /**
+     * Find a role in roleSetup
+     * @async
+     * @param {string} guildId - The guild ID
+     * @param {number} levelNumber - The level number
+     * @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 find(guildId: string, levelNumber: number): Promise<RoleSetupObject>;
+    /**
+     * Remove a level from the role setup
+     * @async
+     * @param {string} guildId - The guild ID
+     * @param {number} levelNumber - The level number
+     * @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 remove(guildId: string, levelNumber: number): Promise<boolean>;
+}

package/lib/src/roleSetup.js

@@ -0,0 +1,29 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.roleSetup=void 0;const xp_1=require("../xp"),xplogs_1=require("./functions/xplogs");class roleSetup{
+/**
+     * Add a role to the role setup
+     * @async
+     * @param {string} guildId - The guild ID
+     * @param {RoleSetupObject} options - Level/role options
+     * @link `Documentation:` https://simplyxp.js.org/docs/roleSetup/add
+     * @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,timestamp:(new Date).toISOString()}});throw new xplogs_1.XpFatal({function:"roleSetup.add()",message:"Role was not provided"})}
+/**
+     * Find a role in roleSetup
+     * @async
+     * @param {string} guildId - The guild ID
+     * @param {number} levelNumber - The level number
+     * @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,timestamp:(new Date).toISOString()}})}
+/**
+     * Remove a level from the role setup
+     * @async
+     * @param {string} guildId - The guild ID
+     * @param {number} levelNumber - The level number
+     * @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,timestamp:(new Date).toISOString()}})}}exports.roleSetup=roleSetup;

package/lib/src/set.d.ts

@@ -0,0 +1,25 @@
+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<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, username?: string): Promise<UserResult>;
+/**
+ * Set user XP
+ * @async
+ * @param {string} userId
+ * @param {string} guildId
+ * @param {number} xpData
+ * @param {string} username - Username to use if auto_create is enabled
+ * @link `Documentation:` https://simplyxp.js.org/docs/setxp
+ * @returns {Promise<UserResult>} - Object of user data on success
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */
+export declare function setXP(userId: string, guildId: string, xpData: number, username?: string): Promise<UserResult>;

package/lib/src/set.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * 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<UserResult>} - Object of user data on success
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */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.convert)("level",level)}});if(xp_1.xp.auto_create&&username)return database_1.db.createOne({collection:"simply-xps",data:{guild:guildId,user:userId,name:username,level:level,xp:(0,utilities_1.convert)("level",level)}});throw new xplogs_1.XpFatal({function:"setLevel()",message:"User does not exist"})}
+/**
+ * Set user XP
+ * @async
+ * @param {string} userId
+ * @param {string} guildId
+ * @param {number} xpData
+ * @param {string} username - Username to use if auto_create is enabled
+ * @link `Documentation:` https://simplyxp.js.org/docs/setxp
+ * @returns {Promise<UserResult>} - Object of user data on success
+ * @throws {XpFatal} - If parameters are not provided correctly
+ */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"});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:(0,utilities_1.convert)("xp",xpData),xp:xpData}});if(xp_1.xp.auto_create&&username)return database_1.db.createOne({collection:"simply-xps",data:{guild:guildId,user:userId,name:username,level:(0,utilities_1.convert)("xp",xpData),xp:xpData}});throw new xplogs_1.XpFatal({function:"setXP()",message:"User does not exist"})}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

@@ -0,0 +1,25 @@
+import { Database } from "better-sqlite3";
+import { MongoClient } from "mongodb";
+export interface XPClient {
+    dbType: "mongodb" | "sqlite";
+    database: MongoClient | Database | undefined;
+    auto_create: boolean;
+    auto_purge: boolean;
+    notify: boolean;
+    debug: boolean;
+}
+export { addLevel, addXP } from "./src/add";
+export { db } from "./src/functions/database";
+export { charts } from "./src/charts";
+export { connect } from "./src/connect";
+export { convert, updateOptions } from "./src/functions/utilities";
+export { create } from "./src/create";
+export { fetch } from "./src/fetch";
+export { leaderboard } from "./src/leaderboard";
+export { migrate } from "./src/migrate";
+export { rankCard, leaderboardCard } from "./src/cards";
+export { reset } from "./src/reset";
+export { roleSetup } from "./src/roleSetup";
+export { setLevel, setXP } from "./src/set";
+export declare const xp: XPClient;
+export { rank } from "./src/deprecated/rank";

package/lib/xp.js

@@ -0,0 +1,45 @@
+"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.updateOptions = exports.convert = 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; } });
+Object.defineProperty(exports, "addXP", { enumerable: true, get: function () { return add_1.addXP; } });
+var database_1 = require("./src/functions/database");
+Object.defineProperty(exports, "db", { enumerable: true, get: function () { return database_1.db; } });
+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 utilities_1 = require("./src/functions/utilities");
+Object.defineProperty(exports, "convert", { enumerable: true, get: function () { return utilities_1.convert; } });
+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");
+Object.defineProperty(exports, "fetch", { enumerable: true, get: function () { return fetch_1.fetch; } });
+var leaderboard_1 = require("./src/leaderboard");
+Object.defineProperty(exports, "leaderboard", { enumerable: true, get: function () { return leaderboard_1.leaderboard; } });
+var migrate_1 = require("./src/migrate");
+Object.defineProperty(exports, "migrate", { enumerable: true, get: function () { return migrate_1.migrate; } });
+var cards_1 = require("./src/cards");
+Object.defineProperty(exports, "rankCard", { enumerable: true, get: function () { return cards_1.rankCard; } });
+Object.defineProperty(exports, "leaderboardCard", { enumerable: true, get: function () { return cards_1.leaderboardCard; } });
+var reset_1 = require("./src/reset");
+Object.defineProperty(exports, "reset", { enumerable: true, get: function () { return reset_1.reset; } });
+var roleSetup_1 = require("./src/roleSetup");
+Object.defineProperty(exports, "roleSetup", { enumerable: true, get: function () { return roleSetup_1.roleSetup; } });
+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,
+    dbType: "mongodb",
+    notify: true
+};
+// DEPRECATED
+var rank_1 = require("./src/deprecated/rank");
+Object.defineProperty(exports, "rank", { enumerable: true, get: function () { return rank_1.rank; } });