gj-boomlings-api 1.2.3 → 1.3.0

package/docs/objects/comment.md

@@ -1,34 +0,0 @@
-# Comment object
-
-Used by `getComments()` and `getCommentHistory()`.
-
-## Example
-```
-{
-    username: 'RobTop',
-    content: ':)',
-    levelID: 10565740,
-    playerID: 16,
-    likes: 57919,
-    percent: 0,
-    id: 53363972,
-    age: '5 years'
-}
-```
-
-## Properties
-```username``` - the comment author's username.
-
-```content``` - the actual content of a comment.
-
-```levelID``` - the ID of a level, on which the comment was sent.
-
-```playerID``` - the comment author's player ID.
-
-```likes``` - the amount of likes on a comment.
-
-```percent``` - the percentage that has been put on this comment. Returns `0` if the percentage checkbox hadn't been checked.
-
-```id``` - the ID of a comment.
-
-```age``` - the age of a comment.

package/docs/objects/level.md

@@ -1,95 +0,0 @@
-# Level object
-
-Used by `dlLevel()`, `getLevelByID()` and `getUserLevels()`.
-
-## Example
-```
-{
-  id: 58825144,
-  name: 'xo',
-  description: 'stream vertigo',
-  creator: 'KrmaL',
-  level_version: 2,
-  difficulty: 'Extreme Demon',
-  stars: 10,
-  downloads: 2640560,
-  likes: 107918,
-  disliked: false,
-  length: 'XL',
-  password: '000007',
-  demon: true,
-  featured: false,
-  epic: false,
-  objects: 37838,
-  uploaded: '3 years',
-  updated: '3 years',
-  stars_requested: 10,
-  game_version: '2.1',
-  ldm: false,
-  copied: 0,
-  two_p: false,
-  coins: 0,
-  verified_coins: false,
-  song: {
-    name: 'XO (Eden Cover & Remake)',
-    id: 766165,
-    artist: 'aaronmusslewhite',
-    artistId: 2130,
-    fileSize: '6.1 MB',
-    link: 'http://audio.ngfiles.com/766000/766165_XO-Eden-Cover-amp-Remake.mp3'
-  }
-}
-```
-
-## Properties
-```id``` - the level ID.
-
-```name``` - the level name.
-
-```description``` - the level description.
-
-```creator``` - the level creator.
-
-```level_version``` - the version of a level.
-
-```difficulty``` - the level difficulty.
-
-```stars``` - the amount of stars you get from beating the level.
-
-```downloads``` - the amount of level downloads.
-
-```likes``` - the amount of level likes.
-
-```disliked``` - a boolean that shows if the level is disliked. Returns `true` if the like amount is negative, otherwise it's `false`.
-
-```length``` - the level length.
-
-```password``` - the level password. It may return `''` (an empty string) if the level is not copyable, or `'1'` if the level is free to copy.
-
-```demon``` - a boolean that shows if the level is demon.
-
-```featured``` - a boolean that shows if the level has been featured.
-
-```epic``` - a boolean that shows if the level is epic-rated.
-
-```objects``` - the amount of level objects. However, this property has a cap of 65535 objects (it's RobTop's problem).
-
-```uploaded``` - when the level has been uploaded.
-
-```updated``` - when the level has been last updated.
-
-```stars_requested``` - basically how many stars the creator has requested. Returns`0` if no stars have been requested.
-
-```game_version``` - the version required to play the level. Returns `Pre-1.7` if the level has been uploaded or last updated earlier, than 1.7 came out.
-
-```ldm``` - a boolean that shows if the level has a "Low Detail Mode" checkbox.
-
-```copied``` - the original level ID, that got copied. Returns `0` if the level is already original.
-
-```two_p``` - a boolean that shows if the level is in the 2-player mode.
-
-```coins``` - the amount of coins in the level.
-
-```verified_coins``` - a boolean that shows if the coins are verified (silver coins).
-
-```song``` - a [song object](./song.md).

package/docs/objects/song.md

@@ -1,28 +0,0 @@
-# Song object
-
-Used by `getOfficialSongInfo()` and `getSongInfo()`.
-
-## Example
-```
-{
-  name: 'Dynamics',
-  id: 1099128,
-  artist: 'shikoshib',
-  artistId: 10001037,
-  fileSize: '5.74 MB',
-  link: 'https://audio.ngfiles.com/1099000/1099128_Dynamics.mp3?f1640426773'
-}
-```
-
-## Properties
-```name``` - the song name.
-
-```id``` - the song ID.
-
-```artist``` - the song artist.
-
-```artistId``` - the artist's Newgrounds ID.
-
-```fileSize``` - the size of the song in megabytes, rounded to two decimals.
-
-```link``` - the link to a file of the song.

package/docs/objects/user.md

@@ -1,61 +0,0 @@
-# Level object
-
-Used by ```getProfile()```.
-
-## Example
-```
-{
-  username: 'RobTop',
-  playerID: 16,
-  accountID: 71,
-  rank: 219796,
-  stars: 2375,
-  diamonds: 2170,
-  secretCoins: 3,
-  userCoins: 140,
-  demons: 5,
-  creatorPoints: 0,
-  messages: 'none',
-  friendRequests: 'none',
-  commentHistory: 'all',
-  mod: 'elder',
-  youtube: 'https://youtube.com/channel/UCz_yk8mDSAnxJq0ar66L4sw',
-  twitter: 'https://twitter.com/RobTopGames',
-  twitch: 'https://twitch.tv/robtopgames'
-}
-```
-
-## Properties
-```username``` - the player's username.
-
-```playerID``` - the player ID.
-
-```accountID``` - the account ID.
-
-```rank``` - the user's position in the global leaderboard. Returns `0` if the player hasn't received it yet or if the player is banned on the leaderboard.
-
-```stars``` - the amount of stars the player has.
-
-```diamonds``` - the amount of diamonds the player has.
-
-```secretCoins``` - the amount of secret (gold) coins the player has collected.
-
-```userCoins``` - the amount of user (white) coins the player has collected.
-
-```demons``` - the amount of demons the player has beaten.
-
-```creatorPoints``` - the amount of creator points the player has.
-
-```messages``` - a property that shows if you can send messages to the player. Returns `"none"` if the DMs are closed, `"friends"` if sending DMs is available to only friends, and `"all"` if everyone can send messages to the specified player.
-
-```friendRequests``` - a property that shows if you can send friend requests to the player. Returns `"none"` if you can't or `"all"` if everyone can send friend requests to the specified player.
-
-```commentHistory``` - a property that shows if you can view the player's comment history. Returns `"none"` if you can't, `"friends"` if viewing the comment history is available to only friends, and `"all"` if everyone can view the comment history.
-
-```mod``` - a property that shows if the player is an in-game moderator. Returns `"none"` if not, `"mod"` if the player is a regular Mod (yellow badge), and `"elder"` if the player is an Elder Mod (orange badge).
-
-```youtube``` - the link to the player's YouTube channel.
-
-```twitter``` - the link to the player's Twitter account.
-
-```twitch``` - the link to the player's Twitch channel.

package/docs/reportLevel.md

@@ -1,19 +0,0 @@
-# reportLevel()
-
-Reports the level.
-
-## Parameters
-`level` - the level id.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.reportLevel(54953085).then(console.log);
-```
-
-## Response
-```js
-1
-```
-
-For some reason, the API always returns 1, even if you'll provide an invalid ID.

package/docs/searchLevels.md

@@ -1,113 +0,0 @@
-# searchLevels()
-
-Searches the levels by a specified query.
-
-## Parameters
-`query` - the search string, for example, the level name. If you'll leave it empty, you'll just get the list of most liked levels.
-
-`page` (optional) - the page. Defaults to 1.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.searchLevels("", 2).then(console.log);
-```
-
-## Response
-```
-[
-  {
-    id: 27319926,
-    name: 'through time',
-    description: 'Run... run through time. For you all! Follow me on twitter: @ItsBerkoo',
-    creator: 'Berkoo',
-    level_version: 2,
-    difficulty: 'Normal',
-    stars: 3,
-    downloads: 28632458,
-    likes: 2503368,
-    disliked: false,
-    length: 'Long',
-    demon: false,
-    featured: true,
-    epic: false,
-    objects: 0,
-    stars_requested: 2,
-    game_version: '2.0',
-    copied: 0,
-    two_p: false,
-    coins: 1,
-    verified_coins: true,
-    song: {
-      name: 'Promises',
-      id: 678497,
-      artist: 'KabukiTunes',
-      artistId: 47258,
-      fileSize: '8.23 MB',
-      link: 'http://audio.ngfiles.com/678000/678497_Promises.mp3'
-    }
-  },
-  {
-    id: 28179535,
-    name: 'Acid Factory',
-    description: 'Geometry dash - Poison Gauntlet - Thanks for play! [Acid Factory] 11,000,000 Downloads! <3 ',
-    creator: 'TrinckyFinki',
-    level_version: 3,
-    difficulty: 'Hard',
-    stars: 4,
-    downloads: 51023385,
-    likes: 2446217,
-    disliked: false,
-    length: 'Long',
-    demon: false,
-    featured: true,
-    epic: false,
-    objects: 14193,
-    stars_requested: 3,
-    game_version: '2.1',
-    copied: 28178503,
-    two_p: false,
-    coins: 3,
-    verified_coins: true,
-    song: {
-      name: 'VGMusicRox - Frantic Factory (',
-      id: 550260,
-      artist: 'Viproxi',
-      artistId: 4107,
-      fileSize: '5.94 MB',
-      link: 'http://audio.ngfiles.com/550000/550260_VGMusicRox---Frantic-Facto.mp3'
-    }
-  },
-  {
-    id: 55520,
-    name: 'THE LIGHTNING ROAD',
-    description: 'Removed Coins, ~ Timeless Real / Reduloc',
-    creator: 'timeless real',
-    level_version: 3,
-    difficulty: 'Easy Demon',
-    stars: 10,
-    downloads: 44657564,
-    likes: 2440721,
-    disliked: false,
-    length: 'Long',
-    demon: true,
-    featured: true,
-    epic: false,
-    objects: 3527,
-    stars_requested: 10,
-    game_version: '2.1',
-    copied: 55520,
-    two_p: false,
-    coins: 0,
-    verified_coins: false,
-    song: {
-      name: 'Dry Out',
-      id: 'Level 4',
-      artist: 'DJVI',
-      link: 'https://www.youtube.com/watch?v=FnXabH2q2A0'
-    }
-  },
-...and so on
-```
-
-Returns an array of [level objects](./objects/level.md), sorted by the amount of likes.

package/docs/updateLevelDesc.md

@@ -1,23 +0,0 @@
-# updateLevelDesc()
-
-Updates the description of a level.
-
-## Parameters
-`level` - the level ID.
-
-`description` - the new description of a level.
-
-`user` - the username or player ID.
-
-`gjp` - the user's password.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.updateLevelDesc("83430836", "I love gj-boomlings-api!", "gmdshxdow", "*********").then(console.log);
-```
-
-## Response
-```js
-1
-```

package/docs/uploadAccountPost.md

@@ -1,27 +0,0 @@
-# uploadAccountPost()
-
-Posts a comment to a profile.
-
-## Parameters
-`content` - the actual comment content.
-
-`user` - the username or player ID.
-
-`gjp` - the user's password.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.uploadAccountPost("I love gj-boomlings-api!", "gmdshxdow", "*********").then(console.log);
-```
-
-## Response
-```js
-1
-```
-
-Returns `1` if the comment was successfully posted.
-
----
-
-Fun fact: you can actually post comments with non-Latin characters (Cyrillic letters, Arabic letters, etc.), but I don't recommend you to use them, cuz they are often really buggy.

package/docs/uploadComment.md

@@ -1,28 +0,0 @@
-# uploadComment()
-
-Posts a comment to a profile.
-
-## Parameters
- 
-`content` - the actual comment content.
-
-`id` - the level ID.
-
-`user` - the username or player ID.
-
-`gjp` - the user's password
-
-`percent` (optional) - the comment percentage. Defaults to 0.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.uploadComment("I love gj-boomlings-api!", 83925274, "gmdshxdow", "*********", 99).then(console.log);
-```
-
-## Response
-```js
-1
-```
-
-Returns `1` if the comment was successfully posted.

package/functions/decURLSafeBase64.js

@@ -1,10 +0,0 @@
-module.exports = {
-    decURLSafeBase64:
-        function(string) {
-            const bs = require("js-base64");
-            if(!string || string == "") throw new Error("No string provided!")
-            let str = bs.decode(string.replaceAll("_", '/').replaceAll("-", '+'));
-            if(!bs.isValid(str)) throw new Error("The provided string is not encoded in Base64!")
-            return str;
-        }
-}