gj-boomlings-api 2.0.2 → 2.1.0

package/functions/getCommentHistory.js

@@ -11,8 +11,9 @@
  * @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 {("cube"|"ship"|"ball"|"ufo"|"wave"|"robot"|"spider"|"swing"|"jetpack")} iconType - The commenter's selected game mode to be displayed as an icon.
+ * @property {Boolean} glow - Whether the commenter's icon has the "glow" feature enabled.
+ * @property {string} glowColor - The commenter's glow color.
  * @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.
@@ -31,7 +32,7 @@ module.exports = {
         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.");
 
-        const { gjReq } = require("../gjReq.js");
+        const { gjReq } = require("../misc/gjReq");
         const { getProfile } = require("./getProfile.js");
         const { rgbToHEX } = require("../misc/rgbToHEX");
         const colors = require("../misc/colors.json");
@@ -77,10 +78,11 @@ module.exports = {
                 iconID: Number(user[3]),
                 color1: rgbToHEX(colors[user[5]]),
                 color2: rgbToHEX(colors[user[7]]),
-                iconType: iconObj[user[9]],
-                glow: Boolean(Number(user[11])),
+                iconType: iconObj[user[11]],
+                glow: Boolean(Number(user[13])),
+                glowColor: rgbToHEX(colors[user[9]]),
                 playerID: Number(comment[5]),
-                accountID: Number(user[13]),
+                accountID: Number(user[15]),
                 mod: null,
                 color: null
             };

package/functions/getComments.js

@@ -3,6 +3,7 @@
  * @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 {boolean} spam - Whether the comment is marked as spam.
  * @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.
@@ -10,8 +11,9 @@
  * @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 {("cube"|"ship"|"ball"|"ufo"|"wave"|"robot"|"spider"|"swing"|"jetpack")} iconType - The commenter's selected game mode to be displayed as an icon.
+ * @property {Boolean} glow - Whether the commenter's icon has the "glow" feature enabled.
+ * @property {string} glowColor - The commenter's glow color.
  * @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.
@@ -22,7 +24,7 @@ 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.
+     * @param {(0|1)} mode - The viewing mode. Can be either 0 (most recent) or 1 (most liked). Defaults to 1.
      * @returns {Comment[]}
      */
     getComments:
@@ -30,7 +32,7 @@ module.exports = {
             if (isNaN(level)) throw new Error("Please provide a valid level ID!");
             if (mode && isNaN(mode)) throw new Error("Please provide a mode ID! 0 for recent, 1 for most liked.");
 
-            const { gjReq } = require("../gjReq");
+            const { gjReq } = require("../misc/gjReq");
             const { rgbToHEX } = require("../misc/rgbToHEX");
             const colors = require("../misc/colors.json");
 
@@ -65,6 +67,7 @@ module.exports = {
                     playerID: Number(comment[3]),
                     likes: Number(comment[5]),
                     disliked: comment[5] < 0 ? true : false,
+                    spam: Boolean(Number(comment[7])),
                     percent: Number(comment[9]),
                     id: Number(comment[13]),
                     age: comment[11],
@@ -72,9 +75,10 @@ module.exports = {
                     iconID: Number(user[3]),
                     color1: rgbToHEX(colors[user[5]]),
                     color2: rgbToHEX(colors[user[7]]),
-                    iconType: iconObj[user[9]],
-                    glow: Boolean(Number(user[11])),
-                    accountID: Number(user[13]),
+                    iconType: iconObj[user[11]],
+                    glow: Boolean(Number(user[13])),
+                    glowColor: rgbToHEX(colors[user[9]]),
+                    accountID: Number(user[15]),
                     mod: null,
                     color: null
                 };

package/functions/getCreatorScores.js

@@ -11,26 +11,35 @@
  * @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.
+ * @property {number} iconID - The icon ID.
+ * @property {string} color1 - The HEX code of the player's primary color.
+ * @property {string} color2 - The HEX code of the player's secondary color.
+ * @property {Boolean} glow - Whether the commenter's icon has the "glow" feature enabled.
+ * @property {string} glowColor - The commenter's glow color.
+ * @property {("cube"|"ship"|"ball"|"ufo"|"wave"|"robot"|"spider"|"swing"|"jetpack")} iconType - The commenter's selected game mode to be displayed as an icon.
  */
 module.exports = {
     /**
      * Fetches the player leaderboard based on the amount of creator points.
+     * @param {number} count - The amount the leaderboard will be capped at. Defaults to 100.
      * @returns {ScoresUser[]}
      */
-    getCreatorScores: async function () {
+    getCreatorScores: async function (count = 100) {
+        if (isNaN(count)) throw new Error("The count should be a valid number!");
+
         let GJDecode = require("../misc/GJDecode");
         const { decodeScoresUser } = new GJDecode;
-        const { gjReq } = require("../gjReq");
+        const { gjReq } = require("../misc/gjReq");
 
         const data = {
             secret: "Wmfd2893gb7",
             type: "creators",
-            count: 100
+            count: count
         }
 
         let res = await gjReq("getGJScores20", data);
 
-        let players = res.data.split("|");
+        let players = res.data.replaceAll("||", "|").split("|");
         players.pop();
 
         let result = [];

package/functions/getDailyLevel.js

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

package/functions/getFriendRequests.js

@@ -0,0 +1,87 @@
+/**
+ * @typedef {Object} FriendRequest
+ * @property {string} username - The username of the person who sent the friend request.
+ * @property {number} id - The friend request's ID.
+ * @property {string} comment - The message attached to the friend request.
+ * @property {number} playerID - The player ID of the person who sent the friend request.
+ * @property {number} accountID - The account ID of the person who sent the friend request.
+ * @property {number} iconID - The icon ID.
+ * @property {string} color1 - The HEX code of the primary color of the person who sent the friend request.
+ * @property {string} color2 - The HEX code of the secondary color of the person who sent the friend request.
+ * @property {("cube"|"ship"|"ball"|"ufo"|"wave"|"robot"|"spider"|"swing"|"jetpack")} iconType - The selected game mode to be displayed as an icon.
+ * @property {boolean} glow - Whether the person who sent the friend request has the "glow" feature enabled on their icon.
+ * @property {boolean} new - Whether the friend request is unread (displayed as "!" in-game).
+ * @property {string} age - How long ago the friend request was sent.
+ */
+
+module.exports = {
+    /**
+     * Gets a list of pending friend requests.
+     * @param {string} username - The username or player ID.
+     * @param {string} password - The password.
+     * @param {number} page - The page to search through. Defaults to 1.
+     * @param {boolean} isSender - Whether the person specified in `username` was the one sending the friend request. Defaults to false (the person is the one receiving friend requests).
+     * @returns {FriendRequest[]}
+     */
+    getFriendRequests: async function (username, password, page = 1, isSender = false) {
+        if (!username) throw new Error("Please provide the username or the player ID!");
+        if (!password) throw new Error("Please provide the password!");
+        if (isSender && isNaN(isSender)) throw new Error("Please provide either false or true for isSender!");
+
+        const { gjReq } = require("../misc/gjReq");
+        const { gjp2 } = require("../misc/gjp2");
+        const { rgbToHEX } = require("../misc/rgbToHEX");
+        const colors = require("../misc/colors.json");
+
+        let userSearch = await gjReq("getGJUsers20", {
+            str: username,
+            secret: "Wmfd2893gb7"
+        });
+        if (userSearch.data == -1) throw new Error(`-1: Player with the ID or player username "${username}" not found`);
+        let userAccID = userSearch.data.split(":")[23];
+
+        let res = await gjReq("getGJFriendRequests20", {
+            accountID: userAccID,
+            gjp2: gjp2(password),
+            secret: "Wmfd2893gb7",
+            getSent: Number(isSender),
+            page: Number(page) - 1
+        });
+        if (res.data == -1) throw new Error(-1);
+        if (res.data == -2) return [];
+
+        const friendRequests = res.data.split("#")[0].split("|");
+        const requestList = [];
+
+        let iconObj = {
+            0: "cube",
+            1: "ship",
+            2: "ball",
+            3: "ufo",
+            4: "wave",
+            5: "robot",
+            6: "spider",
+            7: "swing",
+            8: "jetpack"
+        };
+
+        for (let request of friendRequests) {
+            requestList.push({
+                username: request.split(":")[1],
+                id: Number(request.split(":")[19]),
+                comment: Buffer.from(request.split(":")[21], "base64").toString(),
+                playerID: Number(request.split(":")[3]),
+                accountID: Number(request.split(":")[17]),
+                iconID: Number(request.split(":")[5]),
+                color1: rgbToHEX(colors[request.split(":")[7]]),
+                color2: rgbToHEX(colors[request.split(":")[9]]),
+                iconType: iconObj[Number(request.split(":")[13])],
+                glow: request.split(":")[15] == "2",
+                new: request.split(":")[23] == "1",
+                age: request.split(":")[25]
+            })
+        }
+
+        return requestList;
+    }
+}

package/functions/getFriendsList.js

@@ -9,29 +9,28 @@
  */
 module.exports = {
     /**
-     * Gets the list of a user's friends.
+     * Gets the list of a player'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!");
+        if (!username) throw new Error("Please provide the player ID or username!");
+        if (!password) throw new Error("Please provide the password!");
 
-        const { gjReq } = require("../gjReq");
-        const XOR = require("../xor");
-        const xor = new XOR;
+        const { gjReq } = require("../misc/gjReq");
+        const { gjp2 } = require("../misc/gjp2");
 
         let search = await gjReq("getGJUsers20", {
             str: username,
             secret: "Wmfd2893gb7"
         });
-        if (search.data == -1) return [];
-        let accID = search.data.split(":")[21];
+        if (search.data == -1) throw new Error(`-1: Player with the ID or player username "${username}" not found`);
+        let accID = search.data.split(":")[23];
 
         const data = {
             accountID: accID,
-            gjp: xor.encrypt(password, 37526),
+            gjp2: gjp2(password),
             secret: "Wmfd2893gb7"
         }
 
@@ -43,15 +42,28 @@ module.exports = {
 
         let colors = require("../misc/colors.json");
         const { rgbToHEX } = require("../misc/rgbToHEX");
+        let iconObj = {
+            0: "cube",
+            1: "ship",
+            2: "ball",
+            3: "ufo",
+            4: "wave",
+            5: "robot",
+            6: "spider",
+            7: "swing",
+            8: "jetpack"
+        };
 
         players.forEach(p => {
             let s = p.split(":");
             let username = s[1];
             let playerID = s[3];
+            let iconID = s[5];
             let p1 = s[7];
             let p2 = s[9];
-            let accID = s[15];
-            let msg = s[17];
+            let iconType = s[13];
+            let accID = s[17];
+            let msg = s[19];
 
             let msgObj = {
                 "0": "all",
@@ -63,8 +75,10 @@ module.exports = {
                 username: username,
                 playerID: Number(playerID),
                 accountID: Number(accID),
+                iconID: Number(iconID),
                 color1: rgbToHEX(colors[p1]),
                 color2: rgbToHEX(colors[p2]),
+                iconType: iconObj[Number(iconType)],
                 messages: msgObj[msg]
             })
         })

package/functions/getGauntlets.js

@@ -6,14 +6,16 @@
  */
 module.exports = {
     /**
-     * Gets the list of gauntlets.
+     * Gets the list of all gauntlets.
      * @returns {Gauntlet[]}
      */
     getGauntlets: async function () {
         const glIDs = require("../misc/gauntlets.json");
-        const { gjReq } = require("../gjReq");
+        const { gjReq } = require("../misc/gjReq");
 
-        let res = await gjReq("getGJGauntlets21", { secret: "Wmfd2893gb7", special: 1 })
+        // the only time i've ever used binaryVersion lmao
+        // for some reason it does make a difference though
+        let res = await gjReq("getGJGauntlets21", { secret: "Wmfd2893gb7", special: 1, binaryVersion: 48 });
 
         let gauntlets = res.data.split("#")[0].split("|");
         let result = [];

package/functions/getLevelByID.js

@@ -38,13 +38,13 @@
  */
 module.exports = {
     /**
-     * Gets a level by its ID. Works considerably faster than dlLevel(), yet lacks the last update/upload date, password, LDM, accurate object count, SFX and additional songs (if any).
+     * Gets a level by its ID. Works considerably faster than downloadLevel(), yet lacks the last update/upload date, password, LDM, accurate object count, SFX and additional songs (if any).
      * @param {number} id - The level's ID.
      * @returns {Level}
      */
     getLevelByID: async function (id) {
         if (isNaN(id)) throw new Error("Please provide a valid level ID!");
-        const { gjReq } = require("../gjReq");
+        const { gjReq } = require("../misc/gjReq");
         const GJDecode = require("../misc/GJDecode");
         const { decodeSearchResults } = new GJDecode;
         const res = await gjReq("getGJLevels21", {

package/functions/getLevelScores.js

@@ -4,11 +4,12 @@
  * @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 {string} color1 - The player's primary color.
- * @property {string} color2 - The player's secondary color.
+ * @property {string} color1 - The HEX code of the player's primary color.
+ * @property {string} color2 - The HEX code of the player's secondary color.
  * @property {string} iconID - The player's icon ID.
- * @property {string} iconType - The player's selected game mode to be displayed as an icon.
+ * @property {("cube"|"ship"|"ball"|"ufo"|"wave"|"robot"|"spider"|"swing"|"jetpack")} iconType - The player's selected game mode to be displayed as an icon.
  * @property {string} glow - Whether the player's icon has the "glow" feature enabled.
+ * @property {string} glowColor - The HEX code of the player's glow color.
  * @property {string} percent - The record's percentage.
  * @property {string} coins - The amount of coins collected.
  * @property {string} age - How long ago the record was published.
@@ -24,27 +25,26 @@ module.exports = {
      */
     getLevelScores: async function (level, type, username, password) {
         let types = { week: "2", top: "1", friends: "0" }
-        if (!level) throw new Error("Please provide a level ID!");
+        if (!level) throw new Error("Please provide the level ID!");
         if (!types[type.toLowerCase()]) throw new Error("Please provide a valid leaderboard type! Possible types: \"week\", \"top\", \"friends\".")
-        if (!username) throw new Error("Please provide a username or a Player ID!");
-        if (!password) throw new Error("Please provide a password!");
+        if (!username) throw new Error("Please provide the username or player ID!");
+        if (!password) throw new Error("Please provide the password!");
 
-        const { gjReq } = require("../gjReq.js");
+        const { gjReq } = require("../misc/gjReq");
         const { rgbToHEX } = require("../misc/rgbToHEX");
         const colors = require("../misc/colors.json");
         let search = await gjReq("getGJUsers20", {
             str: username,
             secret: "Wmfd2893gb7"
         });
-        if (search.data == -1) return [];
-        let accID = search.data.split(":")[21];
+        if (search.data == -1) throw new Error(`-1: Player with the ID or player username "${username}" not found`);
+        let accID = search.data.split(":")[23];
 
-        const XOR = require("../xor.js");
-        const xor = new XOR;
+        const { gjp2 } = require("../misc/gjp2");
 
         const data = {
             accountID: accID,
-            gjp: xor.encrypt(password, 37526),
+            gjp2: gjp2(password),
             levelID: level,
             secret: "Wmfd2893gb7",
             type: types[type.toLowerCase()]
@@ -72,16 +72,17 @@ module.exports = {
             result.push({
                 username: s[1],
                 playerID: Number(s[3]),
-                accountID: Number(s[15]),
-                rank: Number(s[19]),
-                color1: rgbToHEX(colors[username[7]]),
-                color2: rgbToHEX(colors[username[9]]),
+                accountID: Number(s[17]),
+                rank: Number(s[21]),
+                color1: rgbToHEX(colors[s[7]]),
+                color2: rgbToHEX(colors[s[9]]),
                 iconID: Number(s[5]),
-                iconType: iconObj[s[11]],
-                glow: s[13] == "2" ? true : false,
-                percent: Number(s[17]),
-                coins: Number(s[21]),
-                age: s[23]
+                iconType: iconObj[s[13]],
+                glow: s[15] == "2" ? true : false,
+                glowColor: rgbToHEX(colors[s[11]]),
+                percent: Number(s[19]),
+                coins: Number(s[23]),
+                age: s[25]
             })
         })
 

package/functions/getMapPacks.js

@@ -16,7 +16,7 @@ module.exports = {
      * @returns {MapPack[]}
      */
     getMapPacks: async function (page = 1) {
-        const { gjReq } = require("../gjReq");
+        const { gjReq } = require("../misc/gjReq");
         const data = {
             secret: "Wmfd2893gb7",
             page: Number(page) - 1

package/functions/getMessages.js

@@ -16,29 +16,29 @@ module.exports = {
      * @param {number} page - The page to search through. Defaults to 1.
      * @returns {Message[]}
      */
-    getMessages: async function (username, password, page = 1) {
-        if (!username) throw new Error("Please provide a player ID or username!");
-        if (!password) throw new Error("Please provide a password!");
+    getMessages: async function (username, password, page = 1,) {
+        if (!username) throw new Error("Please provide the player ID or username!");
+        if (!password) throw new Error("Please provide the password!");
         if (isNaN(page)) throw new Error("The page should be a number!");
 
-        const { gjReq } = require("../gjReq");
-        const XOR = require("../xor");
-        const xor = new XOR;
+        const { gjReq } = require("../misc/gjReq");
+        const { gjp2 } = require("../misc/gjp2");
 
         let search = await gjReq("getGJUsers20", {
             str: username,
             secret: "Wmfd2893gb7"
         });
-        if (search.data == -1) return [];
-        let accID = search.data.split(":")[21];
+        if (search.data == -1) throw new Error(`-1: Player with the ID or player username "${username}" not found`);
+        let accID = search.data.split(":")[23];
 
         let res = await gjReq("getGJMessages20", {
             accountID: accID,
-            gjp: xor.encrypt(password, 37526),
+            gjp2: gjp2(password),
             secret: "Wmfd2893gb7",
             page: page - 1
         });
-        if (res.data == -1 || res.data.startsWith("#")) return [];
+        if (res.data == -1) throw new Error(-1);
+        if (res.data.startsWith("#") || res.data == -2) return [];
 
         let msgs = res.data.split("#")[0].split("|");
         let result = [];