gj-boomlings-api 2.0.1 → 2.0.3

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2023 shikoshib
+Copyright 2025 shikoshib
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
 

package/README.md

@@ -1,14 +1,9 @@
 <div align="center">
-  <h1>
-    <a href="https://www.npmjs.com/package/gj-boomlings-api"><img src="https://shikoshib.github.io/font1.png" width="500"></a>
-  </h1>
+  <h1>gj-boomlings-api</h1>
   A light-weight Geometry Dash API wrapper<br><br><a href="https://github.com/shikoshib/gj-boomlings-api/wiki"><b>Documentation</b></a><br><br>
   <a href="https://www.npmjs.com/package/gj-boomlings-api"><img src="https://img.shields.io/npm/v/gj-boomlings-api.svg?maxAge=3600" alt="npm version" /></a>
-  <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/min/gj-boomlings-api">
-  <a href="https://github.com/shikoshib/gj-boomlings-api/actions/workflows/node.js.yml"><img src="https://github.com/shikoshib/gj-boomlings-api/actions/workflows/node.js.yml/badge.svg" /></a>
   <a href="https://www.npmjs.com/package/gj-boomlings-api"><img src="https://img.shields.io/npm/dt/gj-boomlings-api" /></a>
   <a href="https://snyk.io/test/github/shikoshib/gj-boomlings-api"><img src="https://snyk.io/test/github/shikoshib/gj-boomlings-api/badge.svg" alt="Known Vulnerabilities" /></a>
-  <a href="https://packagequality.com/#?package=gj-boomlings-api"><img src="https://packagequality.com/shield/gj-boomlings-api.svg"/></a>
 </div>
 
 # About
@@ -19,8 +14,6 @@
 npm i gj-boomlings-api
 yarn add gj-boomlings-api
 ```
-## In browser
-Not yet, coming soon
 # Examples
 ## Download a level
 ```js
@@ -40,7 +33,7 @@ gd.getGauntlets().then(console.log);
 ## Post a message on a profile
 ```js
 const gd = require("gj-boomlings-api");
-gd.uploadAccountPost("I love gj-boomlings-api!","shikoshib","your password here");
+gd.uploadAccountPost("I love gj-boomlings-api!", "shikoshib", "your password here");
 ```
 ## Send a message
 ```js

package/functions/blockUser.js

@@ -1,4 +1,11 @@
 module.exports = {
+    /**
+     * Blocks a specified user.
+     * @param {string} target - The player that needs to be blocked.
+     * @param {string} username - The blocking person's username or player ID.
+     * @param {string} password - The blocking person's password.
+     * @returns {number} Returns 1 if everything's OK, and -1 if something went wrong.
+     */
     blockUser: async function (target, username, password) {
         if (!target) throw new Error("Please provide a target's player ID or username!");
         if (!username) throw new Error("Please provide a player ID or username!");
@@ -30,8 +37,7 @@ module.exports = {
         }
 
         let res = await gjReq("blockGJUser20", data);
-        if (res.data == -1) throw new Error(-1);
 
-        return res.data;
+        return Number(res.data);
     }
 }

package/functions/deleteAccountPost.js

@@ -1,7 +1,14 @@
 module.exports = {
-    deleteAccountPost: async function (id, str, password) {
+    /**
+     * Deletes a post from the user's account.
+     * @param {number} id - The post's ID.
+     * @param {string} username - The poster's username or player ID.
+     * @param {string} password - The poster's password.
+     * @returns {number} Returns 1 if everything's OK, and -1 if something went wrong.
+     */
+    deleteAccountPost: async function (id, username, password) {
         if (!id) throw new Error("Please provide an account post ID!");
-        if (!str) throw new Error("Please provide a user ID or name!");
+        if (!username) throw new Error("Please provide a player ID or username!");
         if (!password) throw new Error("Please provide a password!");
 
         const { gjReq } = require("../gjReq");
@@ -9,7 +16,7 @@ module.exports = {
         const xor = new XOR;
 
         let search = await gjReq("getGJUsers20", {
-            str: str,
+            str: username,
             secret: "Wmfd2893gb7"
         });
         if (search.data == -1) throw new Error(-1);
@@ -21,8 +28,7 @@ module.exports = {
             gjp: xor.encrypt(password, 37526),
             commentID: id
         });
-        if (res.data == -1) throw new Error(-1);
 
-        return res.data;
+        return Number(res.data);
     }
 }

package/functions/deleteComment.js

@@ -1,14 +1,22 @@
 module.exports = {
+    /**
+     * Deletes a comment from a level.
+     * @param {number} id - The comment's ID.
+     * @param {number} level - The ID of the level which has the comment.
+     * @param {string} username - The commenter's username.
+     * @param {string} password - The commenter's password.
+     * @returns {number} Returns 1 if everything's OK, and -1 if something went wrong.
+     */
     deleteComment:
-        async function (id, lvl, str, password) {
+        async function (id, level, username, password) {
             if (!id) throw new Error("Please provide a comment ID!");
-            if (!lvl) throw new Error("Please provide a level ID!");
-            if (!str) throw new Error("Please provide a user ID or name!");
+            if (!level) throw new Error("Please provide a level ID!");
+            if (!username) throw new Error("Please provide a user ID or name!");
             if (!password) throw new Error("Please provide a password!");
 
             const { gjReq } = require("../gjReq.js");
             let search = await gjReq("getGJUsers20", {
-                str: str,
+                str: username,
                 secret: "Wmfd2893gb7"
             });
             if (search.data == -1) throw new Error(-1);
@@ -20,12 +28,11 @@ module.exports = {
             const res = await gjReq("deleteGJComment20", {
                 accountID: accID,
                 secret: "Wmfd2893gb7",
-                levelID: lvl,
+                levelID: level,
                 gjp: xor.encrypt(password, 37526),
                 commentID: id
             });
-            if (res.data == -1) throw new Error(-1);
 
-            return res.data;
+            return Number(res.data);
         }
 }

package/functions/deleteLevel.js

@@ -1,7 +1,14 @@
 module.exports = {
-    deleteLevel: async function (lvl, str, password) {
-        if (isNaN(lvl)) throw new Error("Please provide a valid level ID!");
-        if (!str) throw new Error("Please provide a user ID or name!");
+    /**
+     * Deletes a level.
+     * @param {number} level - The ID of the level that needs to be deleted.
+     * @param {string} username - The uploader's username or player ID.
+     * @param {string} password - The uploader's password.
+     * @returns {number} Returns 1 if everything's OK, and -1 if something went wrong.
+     */
+    deleteLevel: async function (level, username, password) {
+        if (isNaN(level)) throw new Error("Please provide a valid level ID!");
+        if (!username) throw new Error("Please provide a user ID or name!");
         if (!password) throw new Error("Please provide a password!");
 
         const { gjReq } = require("../gjReq");
@@ -9,7 +16,7 @@ module.exports = {
         const xor = new XOR;
 
         let search = await gjReq("getGJUsers20", {
-            str: str,
+            str: username,
             secret: "Wmfd2893gb7"
         });
         if (search.data == -1) throw new Error(-1);
@@ -18,13 +25,12 @@ module.exports = {
         let data = {
             accountID: accID,
             secret: "Wmfv2898gc9",
-            levelID: lvl,
+            levelID: level,
             gjp: xor.encrypt(password, 37526),
         };
 
         let res = await gjReq("deleteGJLevelUser20", data);
-        if (res.data == -1) throw new Error(-1);
 
-        return res.data;
+        return Number(res.data);
     }
 }

package/functions/dlLevel.js

@@ -1,4 +1,54 @@
+/**
+ * @typedef {Object} Song
+ * @property {string} name - The song's name.
+ * @property {number} id - The song's ID.
+ * @property {string} artist - The song artist.
+ * @property {number} artistId - The song artist's ID on Newgrounds.
+ * @property {number} fileSize - The song's file size in megabytes.
+ * @property {string} link - The direct link to download the song file.
+ */
+
+/**
+ * A playable Geometry Dash online level.
+ * @typedef {Object} Level
+ * @property {number} id - The level's ID.
+ * @property {string} name - The level's name.
+ * @property {string} description - The level's description.
+ * @property {string} levelVersion - The level's current version number.
+ * @property {number} playerID - The level uploader's player ID.
+ * @property {string} difficulty - The level's difficulty.
+ * @property {number} stars - The amount of stars given when completing the level.
+ * @property {number} downloads - The amount of times the level has been downloaded.
+ * @property {number} likes - The amount of likes the level has.
+ * @property {boolean} disliked - Whether the level is disliked (i.e. if the likes count is less than 0).
+ * @property {string} length - The level's length.
+ * @property {string} password - The level's password. Otherwise, returns "" (an empty string) if the level isn't copyable, and "1" if the level is copyable without a password.
+ * @property {boolean} demon - Whether the level is a demon.
+ * @property {boolean} featured - Whether the level is featured.
+ * @property {boolean} epic - Whether the level is epic-rated.
+ * @property {string|boolean} rating - Primarily used for new 2.2 ratings. Returns either "epic", "legendary", "mythic", or `false` if the level's rating is lower than epic.
+ * @property {number} objects - The amount of objects the level has, based on the level data.
+ * @property {string} uploaded - How long ago the level was uploaded.
+ * @property {string} updated - How long ago the level was last updated.
+ * @property {number} starsRequested - The amount of stars the uploader requested for this level.
+ * @property {string} gameVersion - The version of the game used to upload the current version of the level. Returns "Pre-1.7" if the level was last updated in 1.6 or earlier.
+ * @property {boolean} ldm - Whether the level has a "Low Detail Mode" option.
+ * @property {number} copiedID - The original level's ID if this level was copied. Returns 0 if the level is original on itself.
+ * @property {boolean} large - Whether the level is considered "large" (i.e. has more than 40k objects).
+ * @property {boolean} twoPlayer - Whether the level can be played by two people.
+ * @property {number} coins - The amount of coins the level has.
+ * @property {boolean} verifiedCoins - Whether the coins are verified.
+ * @property {Song} song - The main song used in the level.
+ * @property {Array} additionalSongs - The array containing additional songs' IDs.
+ * @property {Array} sfx - The array containing sound effects' IDs.
+ */
+
 module.exports = {
+    /**
+     * Downloads a level.
+     * @param {number} level - The level ID.
+     * @returns {Level}
+     */
     dlLevel: async function (level) {
         const zlib = require("zlib");
         if (!level) throw new Error("Please provide a level ID.");
@@ -98,6 +148,13 @@ module.exports = {
         const objs = rawData.split(";");
         objs.shift();
 
+        const epicObj = {
+            0: null,
+            1: "epic",
+            2: "legendary",
+            3: "mythic"
+        }
+
         let song;
         const { getOfficialSongInfo } = require("./getOfficialSongInfo");
         const { getSongInfo } = require("./getSongInfo");
@@ -106,7 +163,7 @@ module.exports = {
         } else if (NGSongID && !officialSongID) {
             let findSong = await getSongInfo(NGSongID);
             song = findSong;
-        }else if(!officialSongID&&!NGSongID){
+        } else if (!officialSongID && !NGSongID) {
             song = getOfficialSongInfo(1);
         }
 
@@ -125,7 +182,8 @@ module.exports = {
             password: password,
             demon: Boolean(Number(isDemon)),
             featured: Boolean(Number(isFeatured)),
-            epic: Boolean(Number(isEpic)),
+            epic: Number(isEpic) >= 1,
+            rating: epicObj[Number(isEpic)],
             objects: objs.length - 1,
             uploaded: uploaded,
             updated: updated,
@@ -137,7 +195,9 @@ module.exports = {
             twoPlayer: Boolean(Number(is2P)),
             coins: coins,
             verifiedCoins: Boolean(Number(coinsVerified)),
-            song: song
+            song: song,
+            additionalSongs: [],
+            sfx: []
         }
 
         if (s[69] && s[68] != "41") {
@@ -156,4 +216,4 @@ module.exports = {
 
         return result;
     }
-}
+}

package/functions/dlMessage.js

@@ -1,15 +1,33 @@
+/**
+ * @typedef {Object} Message
+ * @property {string} username - The message sender's username.
+ * @property {string} title - The message's title.
+ * @property {string} content - The message's content.
+ * @property {number} playerID - The message sender's player ID.
+ * @property {number} accountID - The message sender's account ID.
+ * @property {number} messageID - The message ID.
+ * @property {string} age - How long ago the message was sent.
+ */
+
 module.exports = {
-    dlMessage: async function (id, user, pass) {
+    /**
+     * Downloads a message.
+     * @param {number} id - The message ID.
+     * @param {string} username - The message recipient's username or player ID.
+     * @param {string} password - The message recipient's password.
+     * @returns {Message}
+     */
+    dlMessage: async function (id, username, password) {
         if (!id) throw new Error("Please provide a valid message ID!");
-        if (!user) throw new Error("Please provide a player ID or username!");
-        if (!pass) throw new Error("Please provide a password!");
+        if (!username) throw new Error("Please provide a player ID or username!");
+        if (!password) throw new Error("Please provide a password!");
 
         const { gjReq } = require("../gjReq");
         const XOR = require("../xor");
         const xor = new XOR;
 
         let search = await gjReq("getGJUsers20", {
-            str: user,
+            str: username,
             secret: "Wmfd2893gb7"
         });
         if (search.data == -1) return {};
@@ -17,7 +35,7 @@ module.exports = {
 
         let res = await gjReq("downloadGJMessage20", {
             accountID: accID,
-            gjp: xor.encrypt(pass, 37526),
+            gjp: xor.encrypt(password, 37526),
             secret: "Wmfd2893gb7",
             messageID: id
         });

package/functions/getAccountPosts.js

@@ -1,10 +1,24 @@
+/**
+ * @typedef {Object} AccountPost
+ * @property {string} content - The account post's content.
+ * @property {number} likes - The amount of likes the account post has.
+ * @property {string} age - How long ago the account post was published.
+ * @property {number} id - The account post's ID.
+ */
+
 module.exports = {
-    getAccountPosts: async function (str, page = 1) {
-        if (!str) throw new Error("Please provide a player ID or name!");
+    /**
+     * Get the list of a user's account posts.
+     * @param {string} target - The targeted user's username or player ID.
+     * @param {number} page - The page to look through. Defaults to 1.
+     * @returns {AccountPost[]}
+     */
+    getAccountPosts: async function (target, page = 1) {
+        if (!target) throw new Error("Please provide a player ID or username!");
         const { gjReq } = require("../gjReq");
 
         let search = await gjReq("getGJUsers20", {
-            str: str,
+            str: target,
             secret: "Wmfd2893gb7"
         });
         if (search.data == -1) return [];
@@ -21,7 +35,12 @@ module.exports = {
         let accPosts = res.data.split("#")[0].split("|");
         let result = [];
         accPosts.forEach(p => {
-            result.push({ content: Buffer.from(p.split("~")[1], "base64").toString(), likes: Number(p.split("~")[3]), age: p.split("~")[5], id: Number(p.split("~")[7]) });
+            result.push({
+                content: Buffer.from(p.split("~")[1], "base64").toString(),
+                likes: Number(p.split("~")[3]),
+                age: p.split("~")[5],
+                id: Number(p.split("~")[7])
+            });
         })
 
         return result;

package/functions/getBlockedList.js

@@ -1,14 +1,29 @@
+/**
+ * @typedef {Object} BlockedUser
+ * @property {string} username - The blocked person's username.
+ * @property {number} playerID - The blocked person's player ID.
+ * @property {number} accountID - The blocked person's account ID.
+ * @property {string} color1 - The HEX code of the blocked person's primary color.
+ * @property {string} color2 - The HEX code of the blocked person's secondary color.
+ */
+
 module.exports = {
-    getBlockedList: async function (user, pass) {
-        if (!user) throw new Error("Please provide a player ID or username!");
-        if (!pass) throw new Error("Please provide a password!");
+    /**
+     * Gets the list of people in a user's blacklist.
+     * @param {string} username - The user's username or player ID.
+     * @param {string} password - The user's password.
+     * @returns {BlockedUser[]}
+     */
+    getBlockedList: async function (username, password) {
+        if (!username) throw new Error("Please provide a player ID or username!");
+        if (!password) throw new Error("Please provide a password!");
 
         const { gjReq } = require("../gjReq");
         const XOR = require("../xor");
         const xor = new XOR;
 
         let search = await gjReq("getGJUsers20", {
-            str: user,
+            str: username,
             secret: "Wmfd2893gb7"
         });
         if (search.data == -1) return [];
@@ -16,7 +31,7 @@ module.exports = {
 
         const data = {
             accountID: accID,
-            gjp: xor.encrypt(pass, 37526),
+            gjp: xor.encrypt(password, 37526),
             secret: "Wmfd2893gb7",
             type: 1
         }
@@ -24,7 +39,6 @@ module.exports = {
         let res = await gjReq("getGJUserList20", data);
         if (res.data == -1 || res.data == -2) return [];
 
-        let players = res.data.split("|");
         let result = [];
 
         let colors = require("../misc/colors.json");

package/functions/getCommentHistory.js

@@ -1,6 +1,33 @@
+/**
+ * @typedef {Object} Comment
+ * @property {number} levelID - The ID of a level the comment was left on.
+ * @property {string} content - The comment's content.
+ * @property {number} likes - The amount of likes the comment has.
+ * @property {boolean} disliked - Whether the comment is disliked (i.e. if the likes count is less than 0).
+ * @property {number} percent - The achieved level percentage at the time of publishing the comment.
+ * @property {number} id - The comment's ID.
+ * @property {string} age - How long ago the comment was published.
+ * @property {string} username - The commenter's username.
+ * @property {string} iconID - The commenter's icon ID.
+ * @property {string} color1 - The commenter's primary color.
+ * @property {string} color2 - The commenter's secondary color.
+ * @property {string} iconType - The commenter's selected game mode to be displayed as an icon.
+ * @property {number} glow - Whether the commenter's icon has the "glow" feature enabled.
+ * @property {number} playerID - The commenter's player ID.
+ * @property {number} accountID - The commenter's account ID.
+ * @property {string|null} mod - Whether the commenter is a moderator. Returns `null` if not, "mod" if the user is a regular moderator and "elder" if the user is an elder moderator.
+ * @property {string|null} color - The comment's text color (usually tied to moderators). Returns `null` if the color is white, otherwise returns the HEX code of the color.
+ */
 module.exports = {
-    getCommentHistory: async function (str, page = 1, mode = 1) {
-        if (!str) throw new Error("Please provide a player ID or name!");
+    /**
+     * Gets the comment history of a user.
+     * @param {string} username - The target's username or player ID.
+     * @param {number} page - The page to search through. Defaults to 1.
+     * @param {number} mode - The viewing mode. Can be either 0 (most recent) or 1 (most liked). Defaults to 1.
+     * @returns {Comment[]}
+     */
+    getCommentHistory: async function (username, page = 1, mode = 1) {
+        if (!username) throw new Error("Please provide a player ID or name!");
         if (page && isNaN(page)) throw new Error("Please provide a page!");
         if (mode && isNaN(mode)) throw new Error("Please provide a valid mode ID! 0 for recent, 1 for most liked.");
 
@@ -9,7 +36,7 @@ module.exports = {
         const { rgbToHEX } = require("../misc/rgbToHEX");
         const colors = require("../misc/colors.json");
 
-        const user = await getProfile(str);
+        const user = await getProfile(username);
         if (user.commentHistory != "all") throw new Error("Whoops! This user has disabled viewing his comment history!");
 
         let res = await gjReq("getGJCommentHistory", {
@@ -48,12 +75,14 @@ module.exports = {
                 age: comment[11],
                 username: user[1],
                 iconID: Number(user[3]),
-                c1: rgbToHEX(colors[user[5]]),
-                c2: rgbToHEX(colors[user[7]]),
+                color1: rgbToHEX(colors[user[5]]),
+                color2: rgbToHEX(colors[user[7]]),
                 iconType: iconObj[user[9]],
                 glow: Boolean(Number(user[11])),
                 playerID: Number(comment[5]),
-                accountID: Number(user[13])
+                accountID: Number(user[13]),
+                mod: null,
+                color: null
             };
             if (comment.length > 14) {
                 obj.mod = comment[15] == "1" ? "mod" : "elder";

package/functions/getComments.js

@@ -1,4 +1,30 @@
+/**
+ * @typedef {Object} Comment
+ * @property {string} content - The comment's content.
+ * @property {number} likes - The amount of likes the comment has.
+ * @property {boolean} disliked - Whether the comment is disliked (i.e. if the likes count is less than 0).
+ * @property {number} percent - The achieved level percentage at the time of publishing the comment.
+ * @property {number} id - The comment's ID.
+ * @property {string} age - How long ago the comment was published.
+ * @property {string} username - The commenter's username.
+ * @property {string} iconID - The commenter's icon ID.
+ * @property {string} color1 - The commenter's primary color.
+ * @property {string} color2 - The commenter's secondary color.
+ * @property {string} iconType - The commenter's selected game mode to be displayed as an icon.
+ * @property {number} glow - Whether the commenter's icon has the "glow" feature enabled.
+ * @property {number} playerID - The commenter's player ID.
+ * @property {number} accountID - The commenter's account ID.
+ * @property {string|null} mod - Whether the user is a moderator. Returns `null` if not, "mod" if the user is a regular moderator and "elder" if the user is an elder moderator.
+ * @property {string|null} color - The comment's text color (usually tied to moderators). Returns `null` if the color is white, otherwise returns the HEX code of the color.
+ */
 module.exports = {
+    /**
+     * Gets a list of comments on a level.
+     * @param {number} level - The level ID.
+     * @param {number} page - The page to search through. Defaults to 1.
+     * @param {number} mode - The viewing mode. Can be either 0 (most recent) or 1 (most liked). Defaults to 1.
+     * @returns {Comment[]}
+     */
     getComments:
         async function (level, page = 1, mode = 1) {
             if (isNaN(level)) throw new Error("Please provide a valid level ID!");
@@ -44,11 +70,13 @@ module.exports = {
                     age: comment[11],
                     username: user[1],
                     iconID: Number(user[3]),
-                    c1: rgbToHEX(colors[user[5]]),
-                    c2: rgbToHEX(colors[user[7]]),
+                    color1: rgbToHEX(colors[user[5]]),
+                    color2: rgbToHEX(colors[user[7]]),
                     iconType: iconObj[user[9]],
                     glow: Boolean(Number(user[11])),
-                    accountID: Number(user[13])
+                    accountID: Number(user[13]),
+                    mod: null,
+                    color: null
                 };
                 if (comment.length > 14) {
                     obj.mod = comment[15] == "1" ? "mod" : "elder";

package/functions/getCreatorScores.js

@@ -1,4 +1,22 @@
+/**
+ * @typedef {Object} ScoresUser
+ * @property {string} name - The player's username.
+ * @property {number} playerID - The player's player ID.
+ * @property {number} accountID - The player's account ID.
+ * @property {number} rank - The player's ranking on the leaderboard.
+ * @property {number} stars - The amount of stars the player has.
+ * @property {number} diamonds - The amount of diamonds the player has.
+ * @property {number} secretCoins - The amount of secret coins the player has.
+ * @property {number} userCoins - The amount of user coins the player has.
+ * @property {number} demons - The amount of demons the player has completed.
+ * @property {number} moons - The amount of moons the player has.
+ * @property {number} creatorPoints - The amount of creator points the player has.
+ */
 module.exports = {
+    /**
+     * Fetches the player leaderboard based on the amount of creator points.
+     * @returns {ScoresUser[]}
+     */
     getCreatorScores: async function () {
         let GJDecode = require("../misc/GJDecode");
         const { decodeScoresUser } = new GJDecode;

package/functions/getDailyLevel.js

@@ -1,6 +1,10 @@
 module.exports = {
+    /**
+     * Gets the current daily level.
+     * @returns {import("./dlLevel").Level}
+     */
     getDailyLevel: async function () {
-        const { dlLevel } = require("./dlLevel")
+        const { dlLevel } = require("./dlLevel");
         let res = await dlLevel(-1);
         return res;
     }

package/functions/getFriendsList.js

@@ -1,14 +1,29 @@
+/**
+ * @typedef {Object} Friend
+ * @property {string} username - The friend's username.
+ * @property {number} playerID - The friend's player ID.
+ * @property {number} accountID - The friend's account ID.
+ * @property {string} color1 - The HEX code of the friend's primary color.
+ * @property {string} color2 - The HEX code of the friend's secondary color.
+ * @property {string} messages - The current state of messaging the friend. Returns "all" if anyone can message the person, "friends" if it's limited to friends, and "none" if no one can.
+ */
 module.exports = {
-    getFriendsList: async function (user, pass) {
-        if (!user) throw new Error("Please provide a player ID or username!");
-        if (!pass) throw new Error("Please provide a password!");
+    /**
+     * Gets the list of a user's friends.
+     * @param {string} username - The user's username or player ID.
+     * @param {string} password - The user's password.
+     * @returns {Friend[]}
+     */
+    getFriendsList: async function (username, password) {
+        if (!username) throw new Error("Please provide a player ID or username!");
+        if (!password) throw new Error("Please provide a password!");
 
         const { gjReq } = require("../gjReq");
         const XOR = require("../xor");
         const xor = new XOR;
 
         let search = await gjReq("getGJUsers20", {
-            str: user,
+            str: username,
             secret: "Wmfd2893gb7"
         });
         if (search.data == -1) return [];
@@ -16,7 +31,7 @@ module.exports = {
 
         const data = {
             accountID: accID,
-            gjp: xor.encrypt(pass, 37526),
+            gjp: xor.encrypt(password, 37526),
             secret: "Wmfd2893gb7"
         }
 
@@ -30,7 +45,7 @@ module.exports = {
         const { rgbToHEX } = require("../misc/rgbToHEX");
 
         players.forEach(p => {
-            let s=p.split(":");
+            let s = p.split(":");
             let username = s[1];
             let playerID = s[3];
             let p1 = s[7];

package/functions/getGauntlets.js

@@ -1,4 +1,14 @@
+/**
+ * @typedef {Object} Gauntlet
+ * @property {string} name - The gauntlet's name.
+ * @property {number} id - The gauntlet's ID.
+ * @property {Array<Number>} levels - The list of level IDs in the gauntlet.
+ */
 module.exports = {
+    /**
+     * Gets the list of gauntlets.
+     * @returns {Gauntlet[]}
+     */
     getGauntlets: async function () {
         const glIDs = require("../misc/gauntlets.json");
         const { gjReq } = require("../gjReq");
@@ -15,6 +25,7 @@ module.exports = {
             }
             result.push({
                 name: `${glIDs[g.split(":")[1]]} Gauntlet`,
+                id: Number(g.split(":")[1]),
                 levels: list
             });
         })