simply-xp 1.1.6 → 1.2.0-test-1

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,31 +1,31 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: 'bug'
-assignees: ''
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-
-1. Run the bot
-2. Try the function
-3. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Versions (please complete the following information):**
-
-- Discord.js Version [e.g. v13]
-- simply-xp Version [e.g. v2.0.0]
-
-**Additional context**
-Add any other context about the problem here.
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Run the bot
+2. Try the function
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Versions (please complete the following information):**
+
+- Discord.js Version [e.g. v13]
+- simply-xp Version [e.g. v2.0.0]
+
+**Additional context**
+Add any other context about the problem here.

package/.prettierrc.json

@@ -1,8 +1,8 @@
-{
-  "trailingComma": "none",
-  "tabWidth": 2,
-  "semi": false,
-  "singleQuote": true,
-  "useTabs": false,
-  "bracketSpacing": true
-}
+{
+  "trailingComma": "none",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true,
+  "useTabs": false,
+  "bracketSpacing": true
+}

package/README.md

@@ -1,9 +1,8 @@
-<p align="center"><img align="center" style="width: 128px" src="https://user-images.githubusercontent.com/71836991/173240203-ca92976f-2e5e-4a85-ba5e-155796eac889.png"></p>
+<p align="center"><img align="center" style="margin-bottom:-6px" src="https://i.imgur.com/BiaHJA7.png?maxwidth=128&fidelity=grand"></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>
-
+<h2 align="center">A Simple, Easy and Beginner friendly XP System. <br>Uses Discord.js v13<br><br>Developed by Rahuletto#0243 & Maintained by Abadima#6356</h2>
 
 <br>
 <p align="center">
@@ -29,33 +28,20 @@ yarn add simply-xp
 
 <br>
 
-# 👋 Goodbye 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 !
-
-# 👋 Last Update log
-
-- 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
+# 🎉 What's New 🎉
 
-# ~~But Why ?~~
-## We do not recommend using this package as you can encounter bugs.
+- We have patched known issues, and we continue to monitor changes!
+- Our rank card has a new font applied
 
-- ~~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~~
+# But Why ?
 
-`Reconstructed discord-xp to give you things simpler ;)`
+- 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
 
 <br>
 

package/index.d.ts

@@ -1,107 +1,107 @@
-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
-  type?: 'bar' | 'line' | 'radar' | 'doughnut' | 'polarArea'
-}
-
-export declare function charts(
-  message: Message,
-  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
-  color?: HexColorString
-}
-export declare function rank(
-  message: Message,
-  userID: string,
-  guildID: string,
-  options?: rankOptions
-): Promise<any>
-
-export declare function reset(userID: string, guildID: string): Promise<any>
-
-export type lvladdOptions = {
-  level: string
-  role: string
-}
-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
-  level: number
-  userID: string
-  guildID: string
-}
-
-export type Role = {
-  lvl: string
-  role: string
-}
-
-declare module 'discord.js' {
-  export interface ClientEvents {
-    levelUp: [Message, Data, Role]
-  }
-}
+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
+  type?: 'bar' | 'line' | 'radar' | 'doughnut' | 'polarArea'
+}
+
+export declare function charts(
+  message: Message,
+  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
+  color?: HexColorString
+}
+export declare function rank(
+  message: Message,
+  userID: string,
+  guildID: string,
+  options?: rankOptions
+): Promise<any>
+
+export declare function reset(userID: string, guildID: string): Promise<any>
+
+export type lvladdOptions = {
+  level: string
+  role: string
+}
+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
+  level: number
+  userID: string
+  guildID: string
+}
+
+export type Role = {
+  lvl: string
+  role: string
+}
+
+declare module 'discord.js' {
+  export interface ClientEvents {
+    levelUp: [Message, Data, Role]
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simply-xp",
-  "version": "1.1.6",
+  "version": "1.2.0-test-1",
   "description": "A Simple, Easy and Beginner Friendly XP System",
   "main": "simplyxp.js",
   "typings": "index.d.ts",
@@ -40,13 +40,15 @@
     "url": "https://github.com/Rahuletto/simply-xp"
   },
   "dependencies": {
-    "canvas": "^2.8.0",
-    "chart.js-image": "^5.6.3",
-    "mongoose": "^6.0.12"
+    "canvas": "^2.9.3",
+    "chart.js-image": "^6.0.3",
+    "mongoose": "^6.0.15"
   },
   "devDependencies": {
-    "discord.js": "^13.2.0",
     "husky": "^7.0.0",
     "pretty-quick": "^3.1.1"
+  },
+  "peerDependencies": {
+    "discord.js": "^13.x.x"
   }
 }

package/simplyxp.js

@@ -1,7 +1,7 @@
 try {
   require('discord.js')
 } catch (e) {
-  throw new Error('Discord.JS is required for this package to run')
+  throw new Error('Discord.js v13 is required for this package to run')
 }
 
 module.exports.roleSetup = require('./src/roleSetup')

package/src/addLevel.js

@@ -1,71 +1,71 @@
-let Discord = require('discord.js')
-const levels = require('../src/models/level.js')
-let { roleSetup } = require('../simplyxp')
-
-/**
- * @param {Discord.Message} message
- * @param {string} userID
- * @param {string} guildID
- * @param {number} level
- */
-async function addLevel(message, userID, guildID, level) {
-  if (!userID) throw new Error('[XP] User ID was not provided.')
-
-  if (!guildID) throw new Error('[XP] Guild ID was not provided.')
-
-  if (!level) throw new Error('[XP] Level amount is not provided.')
-
-  let { client } = message
-
-  const user = await levels.findOne({ user: userID, guild: guildID })
-
-  if (!user) {
-    const newUser = new levels({
-      user: userID,
-      guild: guildID,
-      xp: 0,
-      level: 0
-    })
-
-    await newUser
-      .save()
-      .catch((e) => console.log(`[XP] Failed to save new user to database`))
-
-    let xp = (level * 10) ** 2
-
-    return {
-      level: level,
-      exp: xp
-    }
-  }
-  let level1 = user.level
-
-  user.xp += (level * 10) ** 2
-  user.level += Math.floor(0.1 * Math.sqrt(user.xp))
-
-  await user
-    .save()
-    .catch((e) =>
-      console.log(`[XP] Failed to add Level | User: ${userID} | Err: ${e}`)
-    )
-
-  if (level1 !== level) {
-    let data = {
-      xp: user.xp,
-      level: user.level,
-      userID,
-      guildID
-    }
-
-    let role = await roleSetup.find(client, guildID, level)
-
-    client.emit('levelUp', message, data, role)
-  }
-
-  return {
-    level: user.level,
-    xp: user.xp
-  }
-}
-
-module.exports = addLevel
+let Discord = require('discord.js')
+const levels = require('../src/models/level.js')
+let { roleSetup } = require('../simplyxp')
+
+/**
+ * @param {Discord.Message} message
+ * @param {string} userID
+ * @param {string} guildID
+ * @param {number} level
+ */
+async function addLevel(message, userID, guildID, level) {
+  if (!userID) throw new Error('[XP] User ID was not provided.')
+
+  if (!guildID) throw new Error('[XP] Guild ID was not provided.')
+
+  if (!level) throw new Error('[XP] Level amount is not provided.')
+
+  let { client } = message
+
+  const user = await levels.findOne({ user: userID, guild: guildID })
+
+  if (!user) {
+    const newUser = new levels({
+      user: userID,
+      guild: guildID,
+      xp: 0,
+      level: 0
+    })
+
+    await newUser
+      .save()
+      .catch((e) => console.log(`[XP] Failed to save new user to database`))
+
+    let xp = (level * 10) ** 2
+
+    return {
+      level: level,
+      exp: xp
+    }
+  }
+  let level1 = user.level
+
+  user.xp += (level * 10) ** 2
+  user.level += Math.floor(0.1 * Math.sqrt(user.xp))
+
+  await user
+    .save()
+    .catch((e) =>
+      console.log(`[XP] Failed to add Level | User: ${userID} | Err: ${e}`)
+    )
+
+  if (level1 !== level) {
+    let data = {
+      xp: user.xp,
+      level: user.level,
+      userID,
+      guildID
+    }
+
+    let role = await roleSetup.find(client, guildID, level)
+
+    client.emit('levelUp', message, data, role)
+  }
+
+  return {
+    level: user.level,
+    xp: user.xp
+  }
+}
+
+module.exports = addLevel