gj-boomlings-api 2.0.0 → 2.0.2

package/functions/getSongsLibrary.js

@@ -1 +1,107 @@
-module.exports={getSongsLibrary:async function(){const zlib=require("zlib");const fetch=require("node-fetch");let req=await fetch("https://geometrydashfiles.b-cdn.net/music/musiclibrary.dat");let res=await req.text();let libArray;const buffer=await new Promise((resolve,reject)=>{zlib.unzip(Buffer.from(res,"base64"),(err,buffer)=>{if(err){reject(err)}else{resolve(buffer)}})});const rawData=buffer.toString();libArray=rawData.split("|");let library={};library.version=Number(libArray[0]);let genres=[];let rawGenres=libArray[3].split(";");rawGenres.pop();rawGenres.forEach(genre=>{genres.push({id:genre.split(",")[0],name:genre.split(",")[1]})});let artists=[];let rawArtists=libArray[1].split(";");rawArtists.pop();rawArtists.forEach(artist=>{let obj={};obj.id=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];artists.push(obj)});let songs=[];let rawSongs=libArray[2].split(";");rawSongs.pop();rawSongs.forEach(song=>{let obj={};obj.id=Number(song.split(",")[0]);obj.name=song.split(",")[1];let songArtist=artists.filter(a=>a.id==song.split(",")[2])[0];obj.artist=songArtist;let size=song.split(",")[3];size=size/1048576;size=size.toFixed(1);obj.size=`${size} MB`;obj.duration=`${song.split(",")[4]}s`;let songGenres=[];let rawSongGenres=song.split(",")[5].split(".");rawSongGenres.shift();rawSongGenres.pop();rawSongGenres.forEach(genre=>{let songGenre=genres.filter(g=>g.id==genre)[0];songGenres.push(songGenre.name)});obj.genres=songGenres;songs.push(obj)});library.songs=songs;return library}};
+/**
+ * @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");
+
+        let req = await fetch("https://geometrydashfiles.b-cdn.net/music/musiclibrary.dat");
+        let res = await req.text();
+
+        let libArray;
+        const buffer = await new Promise((resolve, reject) => {
+            zlib.unzip(Buffer.from(res, "base64"), (err, buffer) => {
+                if (err) {
+                    reject(err);
+                } else {
+                    resolve(buffer);
+                }
+            });
+        })
+        const rawData = buffer.toString();
+        libArray = rawData.split("|");
+
+        let library = {};
+        library.version = Number(libArray[0]);
+
+        let genres = [];
+        let rawGenres = libArray[3].split(";");
+        rawGenres.pop();
+        rawGenres.forEach(genre => {
+            genres.push({ id: genre.split(",")[0], name: genre.split(",")[1] })
+        });
+
+        let artists = [];
+        let rawArtists = libArray[1].split(";");
+        rawArtists.pop();
+        rawArtists.forEach(artist => {
+            let obj = {};
+            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];
+            artists.push(obj);
+        })
+
+        let songs = [];
+        let rawSongs = libArray[2].split(";");
+        rawSongs.pop();
+        rawSongs.forEach(song => {
+            let obj = {};
+
+            obj.id = Number(song.split(",")[0]);
+            obj.name = song.split(",")[1];
+
+            let songArtist = artists.filter(a => a.id == song.split(",")[2])[0];
+            obj.artist = songArtist;
+
+            let size = song.split(",")[3];
+            size = size / 1048576;
+            obj.size = size.toFixed(1);
+
+            obj.duration = Number(song.split(",")[4]);
+
+            let songGenres = [];
+            let rawSongGenres = song.split(",")[5].split(".");
+            rawSongGenres.shift();
+            rawSongGenres.pop();
+            rawSongGenres.forEach(genre => {
+                let songGenre = genres.filter(g => g.id == genre)[0];
+                songGenres.push(songGenre.name);
+            })
+            obj.genres = songGenres;
+
+            songs.push(obj);
+        })
+
+        library.songs = songs;
+
+        return library;
+    }
+}

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,7 +21,7 @@ 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);
@@ -22,7 +31,7 @@ module.exports = {
         const XOR = require("../xor.js");
         const xor = new XOR;
 
-        let chkStr = username.toLowerCase() + Buffer.from(comment).toString("base64") + id + percent + "0xPT6iUrtws0J";
+        let chkStr = username.toLowerCase() + Buffer.from(comment).toString("base64") + level + percent + "0xPT6iUrtws0J";
         let chk = xor.encrypt(sha1(chkStr), 29481);
 
         let res = await gjReq("uploadGJComment21", {
@@ -30,7 +39,7 @@ module.exports = {
             gjp: xor.encrypt(password, 37526),
             userName: username.toLowerCase(),
             comment: Buffer.from(comment).toString("base64"),
-            levelID: id,
+            levelID: level,
             percent: percent,
             chk: chk,
             secret: "Wmfd2893gb7"

package/functions/uploadMessage.js

@@ -1,24 +1,33 @@
 module.exports = {
-    uploadMessage: async function (receiver, subj, content, user, pass) {
-        if (!receiver) throw new Error("Please specify a message receiver!");
-        if (!subj) throw new Error("Please specify a message subject!");
+    /**
+     * Sends a message.
+     * @param {string} recipient - The message recipient.
+     * @param {string} subject - The message subject.
+     * @param {string} content - The message content.
+     * @param {string} username - The sender's username or player ID.
+     * @param {string} password - The sender's password.
+     * @returns {number} Returns 1 if everything's OK, and -1 if something went wrong.
+     */
+    uploadMessage: async function (recipient, subject, content, username, password) {
+        if (!recipient) throw new Error("Please specify a message recipient!");
+        if (!subject) throw new Error("Please specify a message subject!");
         if (!content) throw new Error("Please specify a message content!");
-        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");
         const XOR = require("../xor");
         const xor = new XOR;
 
         let userSearch = await gjReq("getGJUsers20", {
-            str: user,
+            str: username,
             secret: "Wmfd2893gb7"
         });
         if (userSearch.data == -1) throw new Error(-1);
         let userAccID = userSearch.data.split(":")[21];
 
         let recSearch = await gjReq("getGJUsers20", {
-            str: receiver,
+            str: recipient,
             secret: "Wmfd2893gb7"
         });
         if (recSearch.data == -1) throw new Error(-1);
@@ -27,8 +36,8 @@ module.exports = {
         let res = await gjReq("uploadGJMessage20", {
             accountID: userAccID,
             toAccountID: recAccID,
-            gjp: xor.encrypt(pass, 37526),
-            subject: Buffer.from(subj).toString("base64"),
+            gjp: xor.encrypt(password, 37526),
+            subject: Buffer.from(subject).toString("base64"),
             body: xor.encrypt(content, 14251),
             secret: "Wmfd2893gb7"
         });

package/gjReq.js

@@ -1 +1,18 @@
-const fetch=require("node-fetch");module.exports={gjReq:async function(endpoint,data){let r=await fetch(`https://www.boomlings.com/database/${endpoint.endsWith(".php")?endpoint.split(".php")[0]:endpoint}.php`,{method:"POST",headers:{"Content-Type":"application/x-www-form-urlencoded","User-Agent":" "},body:new URLSearchParams(data)});let res=await r.text();return{data:res,status:r.status}}};
+const fetch = require("node-fetch");
+module.exports = {
+    gjReq: async function (endpoint, data) {
+        let r = await fetch(`https://www.boomlings.com/database/${endpoint.endsWith(".php") ? endpoint.split(".php")[0] : endpoint}.php`, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/x-www-form-urlencoded",
+                "User-Agent": " "
+            },
+            body: new URLSearchParams(data)
+        });
+        let res = await r.text();
+        return {
+            data: res,
+            status: r.status
+        }
+    }
+};

package/index.js

@@ -1,2 +1,36 @@
-const{dlLevel}=require("./functions/dlLevel");const{getProfile}=require("./functions/getProfile");const{getSongsLibrary}=require("./functions/getSongsLibrary");const{getSongInfo}=require("./functions/getSongInfo");const{getAccountPosts}=require("./functions/getAccountPosts");const{getGauntlets}=require("./functions/getGauntlets");const{getMapPacks}=require("./functions/getMapPacks");const{getOfficialSongInfo}=require("./functions/getOfficialSongInfo");const{getDailyLevel}=require("./functions/getDailyLevel");const{getWeeklyDemon}=require("./functions/getWeeklyDemon");const{getCreatorScores}=require("./functions/getCreatorScores");const{getTop100}=require("./functions/getTop100");const{reportLevel}=require("./functions/reportLevel");const{uploadMessage}=require("./functions/uploadMessage");const{getMessages}=require("./functions/getMessages");const{dlMessage}=require("./functions/dlMessage");const{getBlockedList}=require("./functions/getBlockedList");const{getFriendsList}=require("./functions/getFriendsList");const{deleteLevel}=require("./functions/deleteLevel");const{blockUser}=require("./functions/blockUser");const{unblockUser}=require("./functions/unblockUser");const{uploadAccountPost}=require("./functions/uploadAccountPost");const{deleteAccountPost}=require("./functions/deleteAccountPost");const{updateLevelDesc}=require("./functions/updateLevelDesc");const{getLevelByID}=require("./functions/getLevelByID");const{searchLevels}=require("./functions/searchLevels");const{getComments}=require("./functions/getComments");const{getTopLists}=require("./functions/getTopLists");const{searchLists}=require("./functions/searchLists");const{getTab}=require("./functions/getTab");const{getUserLevels}=require("./functions/getUserLevels");const{deleteComment}=require("./functions/deleteComment");const{getCommentHistory}=require("./functions/getCommentHistory");const{getLevelScores}=require("./functions/getLevelScores");const{uploadComment}=require("./functions/uploadComment");
-module.exports={dlLevel,getProfile,getSongsLibrary,getSongInfo,getAccountPosts,getGauntlets,getMapPacks,getOfficialSongInfo,getDailyLevel,getWeeklyDemon,getCreatorScores,getTop100,reportLevel,uploadMessage,getMessages,dlMessage,getBlockedList,getFriendsList,deleteLevel,blockUser,unblockUser,uploadAccountPost,deleteAccountPost,updateLevelDesc,getLevelByID,searchLevels,getComments,getTopLists,searchLists,getTab,getUserLevels,deleteComment,getCommentHistory,getLevelScores,uploadComment};
+const { dlLevel } = require("./functions/dlLevel");
+const { getProfile } = require("./functions/getProfile");
+const { getSongsLibrary } = require("./functions/getSongsLibrary");
+const { getSongInfo } = require("./functions/getSongInfo");
+const { getAccountPosts } = require("./functions/getAccountPosts");
+const { getGauntlets } = require("./functions/getGauntlets");
+const { getMapPacks } = require("./functions/getMapPacks");
+const { getOfficialSongInfo } = require("./functions/getOfficialSongInfo");
+const { getDailyLevel } = require("./functions/getDailyLevel");
+const { getWeeklyDemon } = require("./functions/getWeeklyDemon");
+const { getCreatorScores } = require("./functions/getCreatorScores");
+const { getTop100 } = require("./functions/getTop100");
+const { reportLevel } = require("./functions/reportLevel");
+const { uploadMessage } = require("./functions/uploadMessage");
+const { getMessages } = require("./functions/getMessages");
+const { dlMessage } = require("./functions/dlMessage");
+const { getBlockedList } = require("./functions/getBlockedList");
+const { getFriendsList } = require("./functions/getFriendsList");
+const { deleteLevel } = require("./functions/deleteLevel");
+const { blockUser } = require("./functions/blockUser");
+const { unblockUser } = require("./functions/unblockUser");
+const { uploadAccountPost } = require("./functions/uploadAccountPost");
+const { deleteAccountPost } = require("./functions/deleteAccountPost");
+const { updateLevelDesc } = require("./functions/updateLevelDesc");
+const { getLevelByID } = require("./functions/getLevelByID");
+const { searchLevels } = require("./functions/searchLevels");
+const { getComments } = require("./functions/getComments");
+const { getTopLists } = require("./functions/getTopLists");
+const { searchLists } = require("./functions/searchLists");
+const { getTab } = require("./functions/getTab");
+const { getUserLevels } = require("./functions/getUserLevels");
+const { deleteComment } = require("./functions/deleteComment");
+const { getCommentHistory } = require("./functions/getCommentHistory");
+const { getLevelScores } = require("./functions/getLevelScores");
+const { uploadComment } = require("./functions/uploadComment");
+module.exports = { dlLevel, getProfile, getSongsLibrary, getSongInfo, getAccountPosts, getGauntlets, getMapPacks, getOfficialSongInfo, getDailyLevel, getWeeklyDemon, getCreatorScores, getTop100, reportLevel, uploadMessage, getMessages, dlMessage, getBlockedList, getFriendsList, deleteLevel, blockUser, unblockUser, uploadAccountPost, deleteAccountPost, updateLevelDesc, getLevelByID, searchLevels, getComments, getTopLists, searchLists, getTab, getUserLevels, deleteComment, getCommentHistory, getLevelScores, uploadComment };