simply-xp 1.1.3 → 1.1.6

package/README.md

@@ -1,9 +1,10 @@
-<p align="center"><img align="center" style="margin-bottom:-6px" src="https://i.imgur.com/BiaHJA7.png?maxwidth=128&fidelity=grand"></p>
+<p align="center"><img align="center" style="width: 128px" src="https://user-images.githubusercontent.com/71836991/173240203-ca92976f-2e5e-4a85-ba5e-155796eac889.png"></p>
 
 <h2 style="font-size:2.5rem;" align="center">Simply-XP</h2>
 
 <h2 align="center">A Simple, Easy and Beginner friendly XP System. <br>Uses Discord.js v13<br><br>Developed by Rahuletto#0243</h2>
 
+
 <br>
 <p align="center">
    <a href="https://www.npmjs.com/package/simply-xp"><img src="https://img.shields.io/npm/v/simply-xp.svg?style=flat-square" /></a>
@@ -28,48 +29,33 @@ yarn add simply-xp
 
 <br>
 
-# 🎉 What's New 🎉
-
-- Fixed create()
-- New `charts`
-- addXP redefined ! and now fires levelUp event [Most awaited]
-- New Examples
-- New Typings for levelUp
-- rankCard fix and more customizations !
-- leaderboard is much cooler.
-- Bug Fixes
-
-# But Why ?
+# 👋 Goodbye XP 👋
 
-- Easiest XP System in Discord.js
-- Fastest Support ever
-- Rank Card Maker
-- Beginner Friendly
-- Easier than other XP Systems
-- Inbuilt Auto Roles system
 
-`Inspired by discord-xp`
+> We are deprecating, Because making an XP system is already easy. And working on a package which not much people uses is an time waste. We are not deleting the package whatsoever !
 
-# 🖥 Functions 🖥
+# 👋 Last Update log
 
-```js
-let xp = require('simply-xp')
-```
+- Fixed bugs
+- New `addLevel(), setLevel(), reset()`
+- roleSetup redefined.. Redid whole system.
+- New everything.. Everything is now tidy and compact.
+- levelUp event returns role id too !
+- Re-coded to squeeze bugs
+- Bug Fixes
 
-- [connect()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/connect.md)
-- [create()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/create.md)
-- [addXP()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/addXP.md)
-- [setXP()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/setXP.md)
-- [rank()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/rank.md)
-- [fetch()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/fetch.md)
-- [leaderboard()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/charts.md)
-- [charts()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/leaderboard.md)
-- [lvlRole()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/lvlRole.md) | Requires: [roleSetup()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/roleSetup.md)
-- [roleSetup()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/roleSetup.md) | Requires: [lvlRole()](https://github.com/Rahuletto/simply-xp/blob/main/Examples/lvlRole.md)
+# ~~But Why ?~~
+## We do not recommend using this package as you can encounter bugs.
 
-Overwhelmed by these functions ?? Got ya covered !
+- ~~Easiest XP System in Discord.js~~
+- ~~Fastest Support ever~~
+- ~~Rank Card Maker~~
+- ~~Beginner Friendly~~
+- ~~Easier than other XP Systems~~
+- ~~Inbuilt Auto Roles system~~
+- ~~Flexible and simple at the same time~~
 
-- [Introduction](https://github.com/Rahuletto/simply-xp/blob/main/Examples/intro.md)
+`Reconstructed discord-xp to give you things simpler ;)`
 
 <br>
 

package/index.d.ts

@@ -1,15 +1,30 @@
-import { Message } from 'discord.js'
+import { Message, Client } from 'discord.js'
 
 type HexColorString = `#${string}` | string
 
 export type connectOptions = {
   notify?: boolean
 }
+
 export declare function connect(
   db: string,
   options?: connectOptions
 ): Promise<any>
 
+export declare function addLevel(
+  message: Message,
+  userID: string,
+  guildID: string,
+  level: number
+): Promise<any>
+
+export declare function addXP(
+  message: Message,
+  userID: string,
+  guildID: string,
+  xp: number
+): Promise<any>
+
 export type chartsOptions = {
   position?: string
   background?: HexColorString
@@ -21,6 +36,22 @@ export declare function charts(
   options?: chartsOptions
 ): Promise<any>
 
+export declare function create(userID: string, guildID: string): Promise<any>
+
+export declare function fetch(userID: string, guildID: string): Promise<any>
+
+export declare function leaderboard(
+  userID: string,
+  guildID: string,
+  limit: number
+): Promise<any>
+
+export declare function lvlRole(
+  message: Message,
+  userID: string,
+  guildID: string
+): Promise<any>
+
 export type rankOptions = {
   slash?: boolean
   background?: string
@@ -33,6 +64,8 @@ export declare function rank(
   options?: rankOptions
 ): Promise<any>
 
+export declare function reset(userID: string, guildID: string): Promise<any>
+
 export type lvladdOptions = {
   level: string
   role: string
@@ -41,6 +74,19 @@ export type lvlremoveOptions = {
   level: string
 }
 
+export declare function setLevel(
+  message: Message,
+  userID: string,
+  guildID: string,
+  level: number
+): Promise<any>
+
+export declare function setXP(
+  userID: string,
+  guildID: string,
+  xp: number
+): Promise<any>
+
 /** For levelUp event */
 export type Data = {
   xp: string
@@ -49,8 +95,13 @@ export type Data = {
   guildID: string
 }
 
+export type Role = {
+  lvl: string
+  role: string
+}
+
 declare module 'discord.js' {
   export interface ClientEvents {
-    levelUp: [Message, Data]
+    levelUp: [Message, Data, Role]
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simply-xp",
-  "version": "1.1.3",
+  "version": "1.1.6",
   "description": "A Simple, Easy and Beginner Friendly XP System",
   "main": "simplyxp.js",
   "typings": "index.d.ts",