gj-boomlings-api 2.0.1 → 2.0.3

package/functions/getLevelByID.js

@@ -1,4 +1,47 @@
+/**
+ * @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.
+ */
+
+/**
+ * @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 given stars 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 {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 (inaccurate because it could be circumvented, and caps at 65,535).
+ * @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 {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 {string} creator - The level uploader's username.
+ * @property {Song} song - The main song used in the level.
+ */
 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).
+     * @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");

package/functions/getLevelScores.js

@@ -1,16 +1,39 @@
+/**
+ * @typedef {Object} LevelScore
+ * @property {string} username - 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 {string} color1 - The player's primary color.
+ * @property {string} color2 - 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 {string} glow - Whether the player's icon has the "glow" feature enabled.
+ * @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.
+ */
 module.exports = {
-    getLevelScores: async function (lvl, type, user, pass) {
+    /**
+     * Fetches leaderboards from a specified level.
+     * @param {number} level - The level to fetch leaderboards from.
+     * @param {("week"|"top"|"player")} type - The leaderboard type. Possible types: \"week\", \"top\", \"friends\".
+     * @param {string} username - The user's username or player ID. For whatever reason, RobTop made this required, even for simple fetching.
+     * @param {string} password - The user's password. For whatever reason, RobTop made this required, even for simple fetching.
+     * @returns {LevelScore[]}
+     */
+    getLevelScores: async function (level, type, username, password) {
         let types = { week: "2", top: "1", friends: "0" }
-        if (!lvl) throw new Error("Please provide a level ID!");
+        if (!level) throw new Error("Please provide a level ID!");
         if (!types[type.toLowerCase()]) throw new Error("Please provide a valid leaderboard type! Possible types: \"week\", \"top\", \"friends\".")
-        if (!user) throw new Error("Please provide a username or a Player ID!");
-        if (!pass) throw new Error("Please provide a password!");
+        if (!username) throw new Error("Please provide a username or a Player ID!");
+        if (!password) throw new Error("Please provide a password!");
 
         const { gjReq } = require("../gjReq.js");
         const { rgbToHEX } = require("../misc/rgbToHEX");
         const colors = require("../misc/colors.json");
         let search = await gjReq("getGJUsers20", {
-            str: user,
+            str: username,
             secret: "Wmfd2893gb7"
         });
         if (search.data == -1) return [];
@@ -21,8 +44,8 @@ module.exports = {
 
         const data = {
             accountID: accID,
-            gjp: xor.encrypt(pass, 37526),
-            levelID: lvl,
+            gjp: xor.encrypt(password, 37526),
+            levelID: level,
             secret: "Wmfd2893gb7",
             type: types[type.toLowerCase()]
         }
@@ -51,8 +74,8 @@ module.exports = {
                 playerID: Number(s[3]),
                 accountID: Number(s[15]),
                 rank: Number(s[19]),
-                c1: rgbToHEX(colors[user[7]]),
-                c2: rgbToHEX(colors[user[9]]),
+                color1: rgbToHEX(colors[username[7]]),
+                color2: rgbToHEX(colors[username[9]]),
                 iconID: Number(s[5]),
                 iconType: iconObj[s[11]],
                 glow: s[13] == "2" ? true : false,

package/functions/getMapPacks.js

@@ -1,4 +1,20 @@
+/**
+ * @typedef {Object} MapPack
+ * @property {string} name - The map pack's name.
+ * @property {number} id - The map pack's ID.
+ * @property {Array<Number>} levels - The list of level IDs in the map pack.
+ * @property {Number} stars - The amount of stars received from completing the map pack.
+ * @property {number} coins - The amount of secret coins received from completing the map pack.
+ * @property {string} difficulty - The map pack's difficulty.
+ * @property {string} textColor - The map pack's title color.
+ * @property {string} barColor - The map pack's progress bar color.
+ */
 module.exports = {
+    /**
+     * Gets the map packs from a specified page.
+     * @param {number} page - The page to search through. Defaults to 1.
+     * @returns {MapPack[]}
+     */
     getMapPacks: async function (page = 1) {
         const { gjReq } = require("../gjReq");
         const data = {

package/functions/getMessages.js

@@ -1,7 +1,24 @@
+/**
+ * @typedef {Object} Message
+ * @property {string} username - The message sender's username.
+ * @property {string} title - The message's title.
+ * @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.
+ * @property {boolean} read - Whether the message was already read.
+ */
 module.exports = {
-    getMessages: async function (user, pass, page = 1) {
-        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 messages received by a user.
+     * @param {string} username - The user's username or player ID.
+     * @param {string} password - The user's password.
+     * @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!");
         if (isNaN(page)) throw new Error("The page should be a number!");
 
         const { gjReq } = require("../gjReq");
@@ -9,7 +26,7 @@ module.exports = {
         const xor = new XOR;
 
         let search = await gjReq("getGJUsers20", {
-            str: user,
+            str: username,
             secret: "Wmfd2893gb7"
         });
         if (search.data == -1) return [];
@@ -17,7 +34,7 @@ module.exports = {
 
         let res = await gjReq("getGJMessages20", {
             accountID: accID,
-            gjp: xor.encrypt(pass, 37526),
+            gjp: xor.encrypt(password, 37526),
             secret: "Wmfd2893gb7",
             page: page - 1
         });

package/functions/getOfficialSongInfo.js

@@ -1,11 +1,22 @@
+/**
+ * @typedef {Object} Song
+ * @property {string} name - The song's name.
+ * @property {string} id - The ID of the level the song is used in (e.g. "Level 1").
+ * @property {string} artist - The song artist.
+ * @property {string} link - The link to listen to the song.
+ */
 module.exports = {
+    /**
+     * Gets song info about an official song.
+     * @param {number} song - The song ID.
+     * @returns {Song}
+     */
     getOfficialSongInfo: function (song) {
         if (isNaN(song)) throw new Error("Please provide a valid official song ID.");
-        const { sm, bot, pg, dout, bab, clg, j, tm, c, xs, cf, toe, ea, cs, ed, hf, bp, toeii, gd, d, fd, dash, exp, tss, va, ar, tc, p, bm, m, y, f, sp, s, e, round, mdo, ps, ne, pt, unknown } = require("../misc/officialsongs.json");
-        const jsons = { 1: sm, 2: bot, 3: pg, 4: dout, 5: bab, 6: clg, 7: j, 8: tm, 9: c, 10: xs, 11: cf, 12: toe, 13: ea, 14: cs, 15: ed, 16: hf, 17: bp, 18: toeii, 19: gd, 20: d, 21: fd, 22: dash, 23: exp, 24: tss, 25: va, 26: ar, 27: tc, 28: p, 29: bm, 30: m, 31: y, 32: f, 33: sp, 34: s, 35: e, 36: round, 37: mdo, 38: ps, 39: ne, 40: pt };
+        const officialSongs = require("../misc/officialsongs.json");
 
-        let result = jsons[Number(song)];
-        if (!result) result = unknown;
+        let result = officialSongs[Number(song)];
+        if (!result) result = officialSongs["-1"];
         return result;
     }
 }

package/functions/getProfile.js

@@ -1,4 +1,45 @@
+/**
+ * @typedef {Object} Player
+ * @property {string} username - 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 position on the global 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.
+ * @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 {number} cubeID - The ID of the currently selected cube icon.
+ * @property {number} shipID - The ID of the currently selected ship icon.
+ * @property {number} ballID - The ID of the currently selected ball icon.
+ * @property {number} ufoID - The ID of the currently selected UFO icon.
+ * @property {number} waveID - The ID of the currently selected wave icon.
+ * @property {number} robotID - The ID of the currently selected robot icon.
+ * @property {number} spiderID - The ID of the currently selected spider icon.
+ * @property {number} swingID - The ID of the currently selected swing icon.
+ * @property {number} jetpackID - The ID of the currently selected jetpack icon.
+ * @property {number} explosionID - The ID of the currently selected explosion animation.
+ * @property {boolean} glow - Whether the player's icon has the "glow" feature enabled.
+ * @property {string} messages - The current state of messaging the player. Returns "all" if anyone can message the person, "friends" if it's limited to friends, and "none" if no one can.
+ * @property {boolean} friendRequests - Whether the player has allowed to receive friend requests.
+ * @property {string} commentHistory - The current state of viewing the player's comment history. Returns "all" if anyone can do it, "friends" if it's limited to friends, and "none" if only the player can.
+ * @property {string|null} mod - Whether the player 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} youtube - The player's YouTube channel ID, used in this template: `https://youtube.com/channel/((youtube))`.
+ * @property {string} twitter - The player's X (formerly Twitter) username, used in this template: `https://x.com/((twitter))`.
+ * @property {string} twitch - The player's Twitch username, used in this template: `https://twitch.tv/((twitch))`.
+ */
+
 module.exports = {
+    /**
+     * Fetches the profile of a specified user.
+     * @param {string} name - The search query (user, account ID or player ID).
+     * @param {("name"|"accountid"|"playerid")} mode - The search mode, defaults to "auto". If "auto" is selected, the search is first attempted by matching the matching the username, then account ID and then player ID.
+     * @returns {Player}
+     */
     getProfile: async function (name, mode = "auto") {
         const { gjReq } = require("../gjReq");
         const { rgbToHEX } = require("../misc/rgbToHEX");
@@ -46,12 +87,12 @@ module.exports = {
             }
 
             let friendReqsObj = {
-                0: "all",
-                1: "none"
+                0: true,
+                1: false
             }
 
             let modObj = {
-                0: "none",
+                0: null,
                 1: "mod",
                 2: "elder"
             }
@@ -68,8 +109,8 @@ module.exports = {
                 demons: demons,
                 moons: moons,
                 creatorPoints: cp,
-                c1: rgbToHEX(colors[c1]),
-                c2: rgbToHEX(colors[c2]),
+                color1: rgbToHEX(colors[c1]),
+                color2: rgbToHEX(colors[c2]),
                 cubeID: cube,
                 shipID: ship,
                 ballID: ball,
@@ -119,8 +160,6 @@ module.exports = {
             return decodeUser(accArray);
         }
 
-        let result;
-
         if (mode == "accountid") {
             const user = await new Promise((resolve) => {
                 accIDSearch().then(u => resolve(u));

package/functions/getSongInfo.js

@@ -1,4 +1,19 @@
+/**
+ * @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.
+ */
+
 module.exports = {
+    /**
+     * Searches for a song on Newgrounds or in the internal Geometry Dash song library.
+     * @param {number} song - The song ID.
+     * @returns {Song}
+     */
     getSongInfo: async function (song) {
         if (isNaN(song)) throw new Error("Please provide a valid song ID.");
         const { gjReq } = require("../gjReq");
@@ -16,12 +31,12 @@ module.exports = {
         if (link == "CUSTOMURL") link = `https://geometrydashfiles.b-cdn.net/music/${song.toString().trim()}.ogg`;
 
         const result = {
-            "name": rawSong[3],
-            "id": Number(rawSong[1]),
-            "artist": rawSong[7],
-            "artistId": Number(rawSong[5]),
-            "fileSize": `${rawSong[9]} MB`,
-            "link": link
+            name: rawSong[3],
+            id: Number(rawSong[1]),
+            artist: rawSong[7],
+            artistId: Number(rawSong[5]),
+            fileSize: Number(rawSong[9]),
+            link: link
         }
 
         return result;

package/functions/getSongsLibrary.js

@@ -1,4 +1,32 @@
+/**
+ * @typedef {Object} Artist
+ * @property {number} id - The artist's ID.
+ * @property {string} name - The artist's name.
+ * @property {string} website - The artist's website.
+ * @property {string} youtube - The artist's YouTube channel ID.
+ */
+
+/**
+ * @typedef {Object} Song
+ * @property {number} id - The song ID.
+ * @property {string} name - The song name.
+ * @property {Artist} artist - The song artist.
+ * @property {number} size - The song file size in megabytes.
+ * @property {number} duration - The song duration in seconds.
+ * @property {Array<String>} genres - The song genres.
+ */
+
+/**
+ * @typedef {Object} Library
+ * @property {number} version - The songs library's version.
+ * @property {Array<Song>} songs - The songs included in the internal Geometry Dash song library.
+ */
+
 module.exports = {
+    /**
+     * Gets the list of songs from the internal Geometry Dash song library.
+     * @returns {Library}
+     */
     getSongsLibrary: async function () {
         const zlib = require("zlib");
         const fetch = require("node-fetch");
@@ -34,7 +62,7 @@ module.exports = {
         rawArtists.pop();
         rawArtists.forEach(artist => {
             let obj = {};
-            obj.id = artist.split(",")[0];
+            obj.id = Number(artist.split(",")[0]);
             obj.name = artist.split(",")[1];
             if (artist.split(",")[2].trim() != "") obj.website = decodeURIComponent(artist.split(",")[2]);
             if (artist.split(",")[3].trim() != "") obj.youtube = artist.split(",")[3];
@@ -55,10 +83,9 @@ module.exports = {
 
             let size = song.split(",")[3];
             size = size / 1048576;
-            size = size.toFixed(1);
-            obj.size = `${size} MB`;
+            obj.size = size.toFixed(1);
 
-            obj.duration = `${song.split(",")[4]}s`;
+            obj.duration = Number(song.split(",")[4]);
 
             let songGenres = [];
             let rawSongGenres = song.split(",")[5].split(".");

package/functions/getTab.js

@@ -1,7 +1,14 @@
 module.exports = {
+    /**
+     * Fetches levels from a specified tab.
+     * @param {("trending"|"recent"|"featured"|"magic"|"awarded"|"sent")} tab - The tab to fetch.
+     * @param {number} page - The page to search through. Defaults to 1.
+     * @returns {import("./getLevelByID").Level[]}
+     */
     getTab: async function (tab, page = 1) {
         let tabs = { trending: 3, recent: 4, featured: 6, magic: 7, awarded: 11, sent: 27 }
         if (!tabs[tab.toLowerCase()]) throw new Error('Please provide a valid tab! Possible tabs: "trending", "recent", "featured", "magic", "awarded", "sent".');
+
         const { gjReq } = require("../gjReq");
         let GJDecode = require("../misc/GJDecode");
         const { decodeSearchResults } = new GJDecode;
@@ -11,6 +18,7 @@ module.exports = {
             secret: "Wmfd2893gb7"
         });
         if (res.data == -1) return [];
+        
         return decodeSearchResults(res.data);
     }
 }

package/functions/getTop100.js

@@ -1,4 +1,8 @@
 module.exports = {
+    /**
+     * Fetches the player leaderboard based on the amount of stars.
+     * @returns {import("./getCreatorScores").ScoresUser[]}
+     */
     getTop100: async function () {
         let GJDecode = require("../misc/GJDecode");
         const { decodeScoresUser } = new GJDecode;

package/functions/getTopLists.js

@@ -1,4 +1,9 @@
 module.exports = {
+    /**
+     * Fetches the list of top lists.
+     * @param {number} page - The page to search through. Defaults to 1.
+     * @returns {import("./searchLists").List[]}
+     */
     getTopLists: async function (page = 1) {
         const { gjReq } = require("../gjReq");
         const GJDecode = require("../misc/GJDecode");

package/functions/getUserLevels.js

@@ -1,14 +1,20 @@
 module.exports = {
-    getUserLevels: async function (str, page = 1) {
-        if (!str) throw new Error("Please provide a username or player ID!");
+    /**
+     * Fetches levels by a user.
+     * @param {string} username - The search query (username or player ID).
+     * @param {number} page - The page to search through. Defaults to 1.
+     * @returns {import("./getLevelByID").Level[]}
+     */
+    getUserLevels: async function (username, page = 1) {
+        if (!username) throw new Error("Please provide a username or player ID!");
 
         const { gjReq } = require("../gjReq.js");
         let GJDecode = require("../misc/GJDecode.js");
         const { decodeSearchResults } = new GJDecode;
-        let playerID=str;
-        if (isNaN(str)) {
+        let playerID=username;
+        if (isNaN(username)) {
             let search = await gjReq("getGJUsers20", {
-                str: str,
+                str: username,
                 secret: "Wmfd2893gb7"
             });
             if (search.data == -1) return [];

package/functions/getWeeklyDemon.js

@@ -1,4 +1,8 @@
 module.exports = {
+    /**
+     * Gets the current weekly demon.
+     * @returns {import("./dlLevel").Level}
+     */
     getWeeklyDemon: async function () {
         const { dlLevel } = require("./dlLevel");
         let res = await dlLevel(-2);

package/functions/reportLevel.js

@@ -1,4 +1,9 @@
 module.exports = {
+    /**
+     * Reports a level.
+     * @param {number} level - The level ID.
+     * @returns {1} - Always returns 1, regardless of whether the level was reported or not.
+     */
     reportLevel: async function (level) {
         if (isNaN(level)) throw new Error("Please provide a valid level ID.");
         const { gjReq } = require("../gjReq");

package/functions/searchLevels.js

@@ -1,4 +1,10 @@
 module.exports = {
+    /**
+     * Searches for levels.
+     * @param {string} query - The search query.
+     * @param {number} page - The page to search through. Defaults to 1.
+     * @returns {import("./getLevelByID").Level[]}
+     */
     searchLevels: async function (query, page = 1) {
         const { gjReq } = require("../gjReq");
         let GJDecode = require("../misc/GJDecode");

package/functions/searchLists.js

@@ -1,4 +1,28 @@
+/**
+ * @typedef {Object} List
+ * @property {number} id - The list ID.
+ * @property {string} name - The list name.
+ * @property {string} description - The list's description.
+ * @property {string} difficulty - The list's difficulty.
+ * @property {string} username - The list uploader's username.
+ * @property {number} playerID - The list uploader's player ID.
+ * @property {number} accountID - The list uploader's account ID.
+ * @property {string} downloads - The amount of times the list has been downloaded.
+ * @property {number} likes - The amount of likes the list has.
+ * @property {number} diamonds - The amount of diamonds given when completing the list.
+ * @property {boolean} disliked - Whether the list is disliked (i.e. if the likes count is less than 0).
+ * @property {Array<Number>} levels - The array of level IDs in the list.
+ * @property {number} required - The amount of completed levels required to get the reward.
+ * @property {number} uploadedUnix - The UNIX timestamp of the list's upload date.
+ */
+
 module.exports = {
+    /**
+     * Searches for lists.
+     * @param {string} query - The search query.
+     * @param {number} page - The page to search through. Defaults to 1.
+     * @returns {List[]}
+     */
     searchLists: async function (query, page = 1) {
         const { gjReq } = require("../gjReq");
         const GJDecode = require("../misc/GJDecode");

package/functions/unblockUser.js

@@ -1,4 +1,11 @@
 module.exports = {
+    /**
+     * Unblocks a specified user.
+     * @param {string} target - The player that needs to be unblocked.
+     * @param {string} username - The unblocking person's username or player ID.
+     * @param {string} password - The unblocking person's password.
+     * @returns {number} Returns 1 if everything's OK, and -1 if something went wrong.
+     */
     unblockUser: 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,7 +37,6 @@ module.exports = {
         }
 
         let res = await gjReq("unblockGJUser20", data);
-        if (res.data == -1) throw new Error(-1);
 
         return res.data;
     }

package/functions/updateLevelDesc.js

@@ -1,7 +1,15 @@
 module.exports = {
-    updateLevelDesc: async function (level, desc, user, password) {
+    /**
+     * Updates the description on a level.
+     * @param {number} level - The level ID.
+     * @param {string} desc - The new description.
+     * @param {string} username - The level uploader's username or player ID.
+     * @param {string} password - The level uploader's password.
+     * @returns {number} Returns 1 if everything's OK, and -1 if something went wrong.
+     */
+    updateLevelDesc: async function (level, desc, username, password) {
         if (isNaN(level)) throw new Error("Please provide a valid level ID!");
-        if (!user) throw new Error("Please provide a player 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 +17,7 @@ module.exports = {
         const xor = new XOR;
 
         let search = await gjReq("getGJUsers20", {
-            str: user,
+            str: username,
             secret: "Wmfd2893gb7"
         });
         if (search.data == -1) throw new Error(-1);
@@ -22,7 +30,6 @@ module.exports = {
             levelDesc: Buffer.from(desc).toString("base64"),
             secret: "Wmfd2893gb7"
         });
-        if (res.data == -1) throw new Error("-1: Failed to update the description.");
 
         return res.data;
     }

package/functions/uploadAccountPost.js

@@ -1,7 +1,14 @@
 module.exports = {
-    uploadAccountPost: async function (content, str, password) {
+    /**
+     * Uploads a post to an account.
+     * @param {string} content - The account post content.
+     * @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.
+     */
+    uploadAccountPost: async function (content, username, password) {
         if (!content) throw new Error("Please provide an account post content!");
-        if (!str) throw new Error("Please provide a user ID or name!");
+        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);

package/functions/uploadComment.js

@@ -1,8 +1,17 @@
 module.exports = {
-    uploadComment: async function (comment, id, user, password, percent = 0) {
+    /**
+     * Posts a comment on a level.
+     * @param {string} comment - The comment content.
+     * @param {number} level - The level ID.
+     * @param {string} username - The commenter's username or player ID.
+     * @param {string} password - The commenter's password.
+     * @param {number} percent - The achieved level percentage to be displayed on the comment.
+     * @returns {number} Returns 1 if everything's OK, and -1 if something went wrong.
+     */
+    uploadComment: async function (comment, level, username, password, percent = 0) {
         if (!comment) throw new Error("Please provide a comment!");
-        if (!id) throw new Error("Please provide a level ID!");
-        if (!user) throw new Error("Please provide a username or a player ID!");
+        if (!level) throw new Error("Please provide a level ID!");
+        if (!username) throw new Error("Please provide a username or a player ID!");
         if (!password) throw new Error("Please provide a password!");
         if (Number(percent) > 100) throw new Error("The percentage cannot be more than 100!");
 
@@ -12,25 +21,25 @@ module.exports = {
         function sha1(data) { return crypto.createHash("sha1").update(data, "binary").digest("hex"); }
 
         let search = await gjReq("getGJUsers20", {
-            str: user,
+            str: username,
             secret: "Wmfd2893gb7"
         });
         if (search.data == -1) throw new Error(-1);
-        let username = search.data.split(":")[1];
+        let name = search.data.split(":")[1];
         let accID = search.data.split(":")[21];
 
         const XOR = require("../xor.js");
         const xor = new XOR;
 
-        let chkStr = username.toLowerCase() + Buffer.from(comment).toString("base64") + id + percent + "0xPT6iUrtws0J";
+        let chkStr = name.toLowerCase() + Buffer.from(comment).toString("base64") + level + percent + "0xPT6iUrtws0J";
         let chk = xor.encrypt(sha1(chkStr), 29481);
 
         let res = await gjReq("uploadGJComment21", {
             accountID: accID,
             gjp: xor.encrypt(password, 37526),
-            userName: username.toLowerCase(),
+            userName: name.toLowerCase(),
             comment: Buffer.from(comment).toString("base64"),
-            levelID: id,
+            levelID: level,
             percent: percent,
             chk: chk,
             secret: "Wmfd2893gb7"