hypixel-api-reborn 11.1.0 → 11.2.0

package/.prettierrc

@@ -5,9 +5,9 @@
   "bracketSpacing": true,
   "proseWrap": "always",
   "singleQuote": true,
-  "printWidth": 210,
+  "printWidth": 120,
+  "endOfLine": "lf",
   "useTabs": false,
   "tabWidth": 2,
-  "semi": true,
-  "endOfLine": "lf"
+  "semi": true
 }

package/README.md

@@ -15,8 +15,11 @@
 
 ### Links
 
-[Discord Support](https://discord.gg/NSEBNMM) | [Documentation](https://hypixel-api-reborn.github.io/) | [NPM](https://www.npmjs.com/package/hypixel-api-reborn) |
-[GitHub](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn) | [ToDo](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/projects/1) | [CLI](https://github.com/Hypixel-API-Reborn/cli)
+[Discord Support](https://discord.gg/NSEBNMM) | [Documentation](https://hypixel-api-reborn.github.io/) |
+[NPM](https://www.npmjs.com/package/hypixel-api-reborn) |
+[GitHub](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn) |
+[ToDo](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/projects/1) |
+[CLI](https://github.com/Hypixel-API-Reborn/cli)
 
 #### Requirements
 
@@ -31,7 +34,6 @@ npm i hypixel-api-reborn
 ```js
 const Hypixel = require('hypixel-api-reborn');
 const hypixel = new Hypixel.Client('API-KEY');
-// https://stavzdev.is-inside.me/cCMiZdoy.gif
 
 // getPlayer
 hypixel

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypixel-api-reborn",
-  "version": "11.1.0",
+  "version": "11.2.0",
   "description": "Feature-rich Hypixel API wrapper for Node.js",
   "main": "./src/index.js",
   "types": "./typings/index.d.ts",
@@ -16,12 +16,11 @@
     "url": "https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/issues"
   },
   "scripts": {
-    "eslint": "npx eslint src/ typings/",
-    "eslint:fix": "npx eslint src/ typings/ --fix",
+    "lint": "npx eslint src/ typings/",
+    "lint:fix": "npx eslint src/ typings/ --fix",
     "lint:dev": "npm run eslint && npm run dtslint",
-    "test": "npx mocha tests --exit",
-    "docgen": "npx docgen -s src -o ../docs/master.json",
-    "docgen:custom": "npx docgen -s src --custom docs/index.yml -o ../docs/master.json",
+    "tests": "npx mocha tests --exit --recursive",
+    "docgen": "npx docgen -s src -o ./master.json",
     "dtslint": "npx dtslint typings",
     "prettier": "npx prettier --write src/ typings/",
     "prettier:check": "npx prettier --check src/ typings/"
@@ -31,10 +30,12 @@
   },
   "author": "StavZ",
   "dependencies": {
-    "node-fetch": "^2.6.1",
+    "node-cache": "^5.1.2",
+    "node-fetch": "^3.3.2",
     "object-path": "^0.11.8",
-    "prismarine-nbt": "^2.1.0",
-    "rss-parser": "^3.13.0"
+    "prismarine-nbt": "^2.5.0",
+    "rss-parser": "^3.13.0",
+    "skyhelper-networth": "^1.19.0"
   },
   "license": "MIT",
   "readme": "https://hypixel.stavzdev.me/",
@@ -43,18 +44,19 @@
   },
   "publisher": "StavZ",
   "devDependencies": {
-    "@types/node": "^20.6.5",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
+    "@discordjs/docgen": "github:discordjs/docgen",
+    "@types/node": "^20.11.19",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7.0.2",
     "chai": "^4.3.4",
-    "dtslint": "^4.1.6",
-    "eslint": "^7.32.0",
+    "dtslint": "^4.2.1",
+    "eslint": "^8.56.0",
     "eslint-config-google": "^0.14.0",
-    "eslint-config-prettier": "^9.0.0",
-    "mocha": "^9.1.2",
+    "eslint-config-prettier": "^9.1.0",
+    "mocha": "^10.4.0",
     "node-env-run": "^4.0.2",
     "path": "^0.12.7",
-    "prettier": "^3.0.3",
-    "typescript": "^4.3.3"
+    "prettier": "^3.2.5",
+    "typescript": "^5.3.3"
   }
 }

package/src/API/getAchievements.js

@@ -0,0 +1,6 @@
+module.exports = async function () {
+  const Achievements = require('../structures/Static/Achievements');
+  const res = await this._makeRequest('/resources/achievements');
+  if (res.raw) return res;
+  return new Achievements(res);
+};

package/src/API/getChallenges.js

@@ -0,0 +1,6 @@
+module.exports = async function () {
+  const Challenges = require('../structures/Static/Challenges');
+  const res = await this._makeRequest('/resources/challenges');
+  if (res.raw) return res;
+  return new Challenges(res);
+};

package/src/API/getGuild.js

@@ -6,7 +6,7 @@ module.exports = async function (searchParameter, query) {
   const Guild = require('../structures/Guild/Guild');
   if (searchParameter === 'id' && !isGuildID(query)) throw new Error(Errors.INVALID_GUILD_ID);
   const isPlayerQuery = searchParameter === 'player';
-  if (isPlayerQuery) query = await toUuid(query);
+  if (isPlayerQuery) query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
   if (!['id', 'name', 'player'].includes(searchParameter)) throw new Error(Errors.INVALID_GUILD_SEARCH_PARAMETER);
   const res = await this._makeRequest(`/guild?${searchParameter}=${encodeURI(query)}`);
   if (res.raw) return res;

package/src/API/getGuildAchievements.js

@@ -0,0 +1,6 @@
+module.exports = async function () {
+  const GuildAchievements = require('../structures/Static/GuildAchievements');
+  const res = await this._makeRequest('/resources/guilds/achievements');
+  if (res.raw) return res;
+  return new GuildAchievements(res);
+};

package/src/API/getLeaderboards.js

@@ -7,7 +7,9 @@ module.exports = async function () {
   const lbnames = Object.create(require('../utils/Constants').leaderboardNames);
   // eslint-disable-next-line guard-for-in
   for (const name in lbnames) {
-    lbnames[name] = res.leaderboards[lbnames[name]].length ? res.leaderboards[lbnames[name]].map((lb) => new Leaderboard(lb)) : [];
+    lbnames[name] = res.leaderboards[lbnames[name]].length
+      ? res.leaderboards[lbnames[name]].map((lb) => new Leaderboard(lb))
+      : [];
   }
   return lbnames;
 };

package/src/API/getPlayer.js

@@ -5,7 +5,7 @@ const getRecentGames = require('./getRecentGames');
 module.exports = async function (query, options = { guild: false, recentGames: false }) {
   if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
   const Player = require('../structures/Player');
-  query = await toUuid(query);
+  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
   const res = await this._makeRequest(`/player?uuid=${query}`);
   if (res.raw) return res;
   if (query && !res.player) throw new Error(Errors.PLAYER_HAS_NEVER_LOGGED);

package/src/API/getQuests.js

@@ -0,0 +1,6 @@
+module.exports = async function () {
+  const Quests = require('../structures/Static/Quests');
+  const res = await this._makeRequest('/resources/quests');
+  if (res.raw) return res;
+  return new Quests(res);
+};

package/src/API/getRecentGames.js

@@ -5,7 +5,7 @@ module.exports = async function (query, playerData) {
   if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
   const RecentGame = require('../structures/RecentGame');
 
-  query = await toUuid(query);
+  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
 
   const res = await this._makeRequest(`/recentgames?uuid=${query}`);
   if (res.raw) return res;

package/src/API/getServerInfo.js

@@ -2,7 +2,9 @@ const net = require('net');
 const Errors = require('../Errors');
 const ServerInfo = require('../structures/ServerInfo');
 const varInt = require('../utils/varInt');
-const packetsToSend = ['1500E0050E6D632E6879706978656C2E6E657463DD01', '0100', '09010000000000000000'].map((x) => Buffer.from(x, 'hex')); // To avoid dependency hell, these are precompiled as hex.
+const packetsToSend = ['1500E0050E6D632E6879706978656C2E6E657463DD01', '0100', '09010000000000000000'].map((x) =>
+  Buffer.from(x, 'hex')
+); // To avoid dependency hell, these are precompiled as hex.
 module.exports = async function (repeats) {
   if (repeats < 0 || typeof repeats !== 'number') repeats = 3;
   if (repeats > 10) repeats = 10;

package/src/API/getStatus.js

@@ -1,7 +1,7 @@
 const toUuid = require('../utils/toUuid');
 module.exports = async function (query) {
   const Status = require('../structures/Status');
-  query = await toUuid(query);
+  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
   const res = await this._makeRequest(`/status?uuid=${query}`);
   if (res.raw) return res;
   return new Status(res.session);

package/src/API/index.js

@@ -1,19 +1,30 @@
 module.exports = {
-  getAPIStatus: require('./getAPIStatus'),
-  getBoosters: require('./getBoosters'),
-  getGameCounts: require('./getGameCounts'),
-  getGuild: require('./getGuild'),
-  getLeaderboards: require('./getLeaderboards'),
-  getPlayer: require('./getPlayer'),
-  getRecentGames: require('./getRecentGames'),
-  getServerInfo: require('./getServerInfo'),
-  getStatus: require('./getStatus'),
-  getWatchdogStats: require('./getWatchdogStats'),
-  getEndedSkyblockAuctions: require('./skyblock/getEndedSkyblockAuctions'),
-  getSkyblockAuctions: require('./skyblock/getSkyblockAuctions'),
-  getSkyblockAuctionsByPlayer: require('./skyblock/getSkyblockAuctionsByPlayer'),
-  getSkyblockBazaar: require('./skyblock/getSkyblockBazaar'),
-  getSkyblockMember: require('./skyblock/getSkyblockMember'),
-  getSkyblockNews: require('./skyblock/getSkyblockNews'),
-  getSkyblockProfiles: require('./skyblock/getSkyblockProfiles')
+  getAchievements: require('./getAchievements.js'),
+  getAPIStatus: require('./getAPIStatus.js'),
+  getBoosters: require('./getBoosters.js'),
+  getChallenges: require('./getChallenges.js'),
+  getGameCounts: require('./getGameCounts.js'),
+  getGuild: require('./getGuild.js'),
+  getGuildAchievements: require('./getGuildAchievements.js'),
+  getLeaderboards: require('./getLeaderboards.js'),
+  getPlayer: require('./getPlayer.js'),
+  getQuests: require('./getQuests.js'),
+  getRecentGames: require('./getRecentGames.js'),
+  getServerInfo: require('./getServerInfo.js'),
+  getStatus: require('./getStatus.js'),
+  getWatchdogStats: require('./getWatchdogStats.js'),
+
+  getSkyblockAuction: require('./skyblock/getAuction.js'),
+  getSkyblockAuctions: require('./skyblock/getAuctions.js'),
+  getSkyblockAuctionsByPlayer: require('./skyblock/getAuctionsByPlayer.js'),
+  getSkyblockBazaar: require('./skyblock/getBazaar.js'),
+  getSkyblockBingo: require('./skyblock/getBingo.js'),
+  getSkyblockBingoByPlayer: require('./skyblock/getBingoByPlayer.js'),
+  getSkyblockEndedAuctions: require('./skyblock/getEndedAuctions.js'),
+  getSkyblockFireSales: require('./skyblock/getFireSales.js'),
+  getSkyblockGovernment: require('./skyblock/getGovernment.js'),
+  getSkyblockMember: require('./skyblock/getMember.js'),
+  getSkyblockMuseum: require('./skyblock/getMuseum.js'),
+  getSkyblockNews: require('./skyblock/getNews.js'),
+  getSkyblockProfiles: require('./skyblock/getProfiles.js')
 };

package/src/API/skyblock/getAuction.js

@@ -0,0 +1,19 @@
+const Errors = require('../../Errors');
+const toUuid = require('../../utils/toUuid');
+module.exports = async function (type, query, includeItemBytes = false) {
+  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
+  const Auction = require('../../structures/SkyBlock/Auctions/Auction');
+  let filter = '';
+  if (type === 'PROFILE') {
+    filter = 'profile';
+  } else if (type === 'PLAYER') {
+    query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
+    filter = 'player';
+  } else if (type === 'AUCTION') {
+    filter = 'uuid';
+  } else throw new Error(Errors.BAD_AUCTION_FILTER);
+  const res = await this._makeRequest(`/skyblock/auction?${filter}=${query}`);
+  if (res.raw) return res;
+
+  return res.auctions.length ? res.auctions.map((a) => new Auction(a, includeItemBytes)) : [];
+};

package/src/API/skyblock/{getSkyblockAuctions.js → getAuctions.js}

@@ -30,8 +30,12 @@ module.exports = async function (range, options = {}) {
   if (range == null || range === '*') range = [0, (await getPage(0, { noAuctions: true })).info.totalPages];
   if (!Array.isArray(range)) range = [parseInt(range), parseInt(range)];
   if (isNaN(range[0])) throw new Error(Errors.PAGE_INDEX_ERROR);
-  if (parseInt(options.retries) !== options.retries || options.retries > 10 || options.retries < 0) throw new Error(Errors.INVALID_OPTION_VALUE);
-  if (parseInt(options.cooldown) !== options.cooldown || options.cooldown > 3000 || options.cooldown < 0) throw new Error(Errors.INVALID_OPTION_VALUE);
+  if (parseInt(options.retries) !== options.retries || options.retries > 10 || options.retries < 0) {
+    throw new Error(Errors.INVALID_OPTION_VALUE);
+  }
+  if (parseInt(options.cooldown) !== options.cooldown || options.cooldown > 3000 || options.cooldown < 0) {
+    throw new Error(Errors.INVALID_OPTION_VALUE);
+  }
   range = range.sort();
   const result = { auctions: [] };
   const fetches = [];

package/src/API/skyblock/{getSkyblockAuctionsByPlayer.js → getAuctionsByPlayer.js}

@@ -3,7 +3,7 @@ const toUuid = require('../../utils/toUuid');
 module.exports = async function (query, includeItemBytes = false) {
   if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
   const Auction = require('../../structures/SkyBlock/Auctions/Auction');
-  query = await toUuid(query);
+  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
   const res = await this._makeRequest(`/skyblock/auction?player=${query}`);
   if (res.raw) return res;
 

package/src/API/skyblock/getBingo.js

@@ -0,0 +1,8 @@
+module.exports = async function () {
+  const BingoData = require('../../structures/SkyBlock/Static/BingoData');
+
+  const res = await this._makeRequest('/resources/skyblock/bingo');
+  if (res.raw) return res;
+
+  return new BingoData(res);
+};

package/src/API/skyblock/getBingoByPlayer.js

@@ -0,0 +1,14 @@
+const getBingo = require('./getBingo');
+const toUuid = require('../../utils/toUuid');
+const Errors = require('../../Errors');
+module.exports = async function (query, { fetchBingoData = false }) {
+  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
+  const PlayerBingo = require('../../structures/SkyBlock/PlayerBingo');
+  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
+  const res = await this._makeRequest(`/skyblock/uuid?player=${query}`);
+  if (res.raw) return res;
+  let bingoData = null;
+  if (fetchBingoData) bingoData = await getBingo.call(this);
+
+  return new PlayerBingo(data, bingoData);
+};

package/src/API/skyblock/getFireSales.js

@@ -0,0 +1,7 @@
+module.exports = async function () {
+  const FireSale = require('../../structures/SkyBlock/Static/FireSale');
+  const res = await this._makeRequest('/skyblock/firesales');
+  if (res.raw) return res;
+
+  return res.sales.length ? res.sales.map((a) => new FireSale(a)) : [];
+};

package/src/API/skyblock/getGovernment.js

@@ -0,0 +1,8 @@
+module.exports = async function () {
+  const GovernmentData = require('../../structures/SkyBlock/Static/Government.js');
+
+  const res = await this._makeRequest('/resources/skyblock/election');
+  if (res.raw) return res;
+
+  return new GovernmentData(res);
+};

package/src/API/skyblock/{getSkyblockMember.js → getMember.js}

@@ -1,10 +1,11 @@
 const Errors = require('../../Errors');
 const toUuid = require('../../utils/toUuid');
 const getPlayer = require('../getPlayer');
-module.exports = async function (query, options = { fetchPlayer: false }) {
+module.exports = async function (query, options = { fetchPlayer: false, getMuseum: false }) {
   const SkyblockMember = require('../../structures/SkyBlock/SkyblockMember');
+  const getSkyblockMuseum = require('../skyblock/getMuseum');
   if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
-  query = await toUuid(query);
+  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
   const res = await this._makeRequest(`/skyblock/profiles?uuid=${query}`);
   if (res.raw) return res;
   if (!res.profiles || !res.profiles.length) throw new Error(Errors.NO_SKYBLOCK_PROFILES);
@@ -16,9 +17,14 @@ module.exports = async function (query, options = { fetchPlayer: false }) {
       profile.cute_name,
       new SkyblockMember({
         uuid: query,
+        profileId: profile.profile_id,
         profileName: profile.cute_name,
         gameMode: profile.game_mode || null,
-        m: profile.members[query]
+        m: profile.members[query],
+        banking: profile.banking,
+        communityUpgrades: profile.community_upgrades,
+        museum: options.getMuseum ? await getSkyblockMuseum.call(this, query, profile.profile_id) : null,
+        selected: profile.selected
       })
     );
   }

package/src/API/skyblock/getMuseum.js

@@ -0,0 +1,14 @@
+const Errors = require('../../Errors');
+const toUuid = require('../../utils/toUuid');
+module.exports = async function (query, profileId) {
+  const SkyblockMuseum = require('../../structures/SkyBlock/SkyblockMuseum');
+  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
+  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
+  const res = await this._makeRequest(`/skyblock/museum?uuid=${query}&profile=${profileId}`);
+  if (res.raw) return res;
+  return new SkyblockMuseum({
+    uuid: query,
+    m: res,
+    profileId: profileId
+  });
+};

package/src/API/skyblock/{getSkyblockProfiles.js → getProfiles.js}

@@ -1,10 +1,11 @@
 const Errors = require('../../Errors');
 const toUuid = require('../../utils/toUuid');
 const getPlayer = require('../getPlayer');
-module.exports = async function (query, options = { fetchPlayer: false }) {
+module.exports = async function (query, options = { fetchPlayer: false, getMuseum: false }) {
   const SkyblockProfile = require('../../structures/SkyBlock/SkyblockProfile');
+  const getSkyblockMuseum = require('../skyblock/getMuseum');
   if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
-  query = await toUuid(query);
+  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
   const res = await this._makeRequest(`/skyblock/profiles?uuid=${query}`);
   if (res.raw) return res;
   if (!res.profiles || !res.profiles.length) throw new Error(Errors.NO_SKYBLOCK_PROFILES);
@@ -28,11 +29,16 @@ module.exports = async function (query, options = { fetchPlayer: false }) {
     }
 
     profiles.push({
-      profile_id: res.profiles[i].profile_id,
-      profile_name: res.profiles[i].cute_name,
-      members: res.profiles[i].members,
-      me: query,
-      selected: res.profiles[i].selected
+      uuid: query,
+      profileId: res.profiles[i].profile_id,
+      profileName: res.profiles[i].cute_name,
+      gameMode: res.profiles[i].game_mode || null,
+      m: res.profiles[i].members[query],
+      banking: res.profiles[i].banking,
+      communityUpgrades: res.profiles[i].community_upgrades,
+      museum: options.getMuseum ? await getSkyblockMuseum.call(this, query, res.profiles[i].profile_id) : null,
+      selected: res.profiles[i].selected,
+      members: res.profiles[i].members
     });
   }
 

package/src/Client.js

@@ -13,7 +13,7 @@ const clients = [];
  */
 class Client extends EventEmitter {
   /**
-   * @param {string} key API key [(?)](https://stavzdev.is-inside.me/cCMiZdoy.gif)
+   * @param {string} key API key
    * @param {ClientOptions} [options={}] Client options
    */
   constructor(key, options = {}) {
@@ -32,11 +32,11 @@ class Client extends EventEmitter {
     validate.validateOptions(this.options);
     // eslint-disable-next-line guard-for-in
     for (const func in API) {
-      Client.prototype[func] = function (...args) {
+      Client.prototype[func] = (...args) => {
         const lastArg = args[args.length - 1];
         return API[func].apply(
           {
-            _makeRequest: this._makeRequest.bind(this, { ...(validate.cacheSuboptions(lastArg) ? lastArg : {}) }),
+            _makeRequest: this._makeRequest.bind(this, validate.cacheSuboptions(lastArg) ? lastArg : {}),
             ...this
           },
           args
@@ -45,7 +45,10 @@ class Client extends EventEmitter {
     }
 
     if (this.options.checkForUpdates) {
-      updater.checkForUpdates();
+      updater.checkForUpdates().catch(() => {
+        // eslint-disable-next-line no-console
+        if (!this.options.silent) console.warn('[hypixel-api-reborn] Error whilst checking for updates!');
+      });
     }
     /**
      * All cache entries
@@ -53,7 +56,7 @@ class Client extends EventEmitter {
      */
     this.cache = this.requests.cache;
     clients.push(this);
-    rateLimit.init(this.getPlayer('52d9a36f66ce4cdf9a56ad9724ae9fb4'), this.options, this).then(() => this.emit('ready'));
+    rateLimit.init(this.getGameCounts(), this.options, this).then(() => this.emit('ready'));
   }
   /**
    * Private function - make request
@@ -65,10 +68,15 @@ class Client extends EventEmitter {
    */
   async _makeRequest(options, url, useRateLimitManager = true) {
     if (!url) return;
-    if (url !== '/key' && !options.noCacheCheck && (await this.requests.cache.has(url))) return Object.assign(await this.requests.cache.get(url), { raw: !!options.raw });
+    if (url !== '/key' && !options.noCacheCheck && (await this.requests.cache.has(url))) {
+      return Object.assign(await this.requests.cache.get(url), { raw: !!options.raw });
+    }
     if (useRateLimitManager) await rateLimit.rateLimitManager();
     this.emit('outgoingRequest', url, { ...options, headers: { ...options.headers, ...this.options.headers } });
-    const result = await this.requests.request.call(this.requests, url, { ...options, headers: { ...options.headers, ...this.options.headers } });
+    const result = await this.requests.request.call(this.requests, url, {
+      ...options,
+      headers: { ...options.headers, ...this.options.headers }
+    });
     if (this.options.syncWithHeaders) rateLimit.sync(result._headers);
     return result;
   }
@@ -143,6 +151,11 @@ class Client extends EventEmitter {
    * }).catch(e => {
    *   console.log(e);
    * })
+   * @example
+   * // async/await
+   * const guild = await hypixel.getGuild('name', 'The Foundation').catch(console.log);
+   * console.log(guild.level); // 111
+   * console.log(guild.id); // '52e5719284ae51ed0c716c69'
    */
   /**
    * Allows you to get statistics of watchdog, the server anticheat
@@ -156,6 +169,10 @@ class Client extends EventEmitter {
    * }).catch(e => {
    *   console.log(e);
    * })
+   * @example
+   * // async/await
+   * const watchdog = await hypixel.getWatchdogStats().catch(console.log);
+   * console.log(watchdog.byWatchdogTotal); // 5931897
    */
   /**
    * Allows you to get all active boosters
@@ -169,6 +186,10 @@ class Client extends EventEmitter {
    * }).catch(e => {
    *   console.log(e);
    * })
+   * @example
+   * // async/await
+   * const boosters = await hypixel.getBoosters().catch(console.log);
+   * console.log(boosters[0].purchaser); // '978ddb705a8e43618e41749178c020b0'
    */
   /**
    * Allows you to get all skyblock profiles of player
@@ -183,13 +204,16 @@ class Client extends EventEmitter {
    * }).catch(e => {
    *   console.log(e);
    * })
+   * @example
+   * const profiles = await hypixel.getSkyblockProfiles('StavZDev').catch(console.log);
+   * console.log(profiles[0].members[0].uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
    */
   /**
    * Allows you to get a player's skyblock member data from all their profiles
    * @method
    * @name Client#getSkyblockMember
    * @param {string} query Player nickname or UUID
-   * @param {MethodOptions} [options={}] Method options
+   * @param {SkyblockMethodOptions} [options={}] Method options
    * @return {Promise<Map<string,SkyblockMember>>}
    * @example
    * hypixel.getSkyblockMember('StavZDev').then(member => {
@@ -198,6 +222,17 @@ class Client extends EventEmitter {
    * }).catch(e => {
    *   console.log(e);
    * })
+   * @example
+   * const member = await hypixel.getSkyblockMember('StavZDev').catch(console.log);
+   * console.log(member.get('Cucumber').uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
+   */
+  /**
+   * Allows you to get a player's skyblock profile museum
+   * @method
+   * @name Client#getSkyblockMuseum
+   * @param {string} query Player nickname or UUID
+   * @param {string} profileId Profile ID
+   * @return {Promise<SkyblockMuseum>}
    */
   /**
    * Allows you to get the Hypixel API's Status and past Incidents, no key needed.
@@ -312,6 +347,34 @@ class Client extends EventEmitter {
    *   console.log(products[0].productId); // INK_SACK:3
    * })
    * .catch(console.log);
+   */ /**
+   * Allows you to get bingo data
+   * @method
+   * @name Client#getSkyblockBingo
+   * @param {MethodOptions} [options={}] Options
+   * @return {Promise<BingoData>}
+   */
+  /**
+   * Allows you to get bingo data of a player
+   * @method
+   * @name Client#getSkyblockBingoByPlayer
+   * @param {string} query UUID / IGN of player
+   * @param {PlayerBingoOptions} [options={}] Options
+   * @return {Promise<PlayerBingo>}
+   */
+  /**
+   * Allows you to get SB government
+   * @method
+   * @name Client#getSkyblockGovernment
+   * @param {MethodOptions} [options={}] Options
+   * @return {Promise<GovernmentData>}
+   */
+  /**
+   * Allows you to get SB government
+   * @method
+   * @name Client#getSkyblockFireSale
+   * @param {MethodOptions} [options={}] Options
+   * @return {Promise<FireSale[]>}
    */
   /**
    * Allows you to get skyblock news
@@ -348,16 +411,18 @@ class Client extends EventEmitter {
 }
 /**
  * @typedef {object} ClientOptions
- * @prop {boolean} [cache=false] Enable/Disable request caching.
- * @prop {number} [cacheTime=60] Amount of time in seconds to cache the requests.
+ * @prop {boolean} [cache=true] Enable/Disable request caching.
+ * @prop {number} [hypixelCacheTime=60] Amount of time in seconds to cache the hypixel api requests.
+ * @prop {number} [mojangCacheTime=600] Amount of time in seconds to cache the mojang api requests.
  * @prop {CacheHandler} [cacheHandler] Custom Cache Handler
  * @prop {AUTO|HARD|NONE} [rateLimit='AUTO'] Rate limit mode.
  * @prop {boolean} [syncWithHeaders=false] Sync with headers rate limit information. Usually not necessary nor recommended ( because of latency )
- * @prop {number} [keyLimit=120] Key limit of your key.
+ * @prop {number} [keyLimit=60] Key limit of your key.
  * @prop {number} [cacheSize=-1] The amount how many results will be cached. (`-1` for infinity)
  * @prop {boolean} [silent=false] Don't automatically put warnings into console.
  * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request.
  * @prop {boolean} [checkForUpdates=true] Enable/Disable check for new version of hypixel-api-reborn.
+ * @prop {boolean|string} [useThirdPartyAPI=false] Enable/Disable Mojang Third Party API
  */
 const defaultCache = require('./Private/defaultCache.js');
 /**
@@ -384,9 +449,10 @@ const defaultCache = require('./Private/defaultCache.js');
  */
 /**
  * @typedef {object} SkyblockMethodOptions
- * @property {boolean} [raw=false] Raw data
- * @property {?boolean} [noCacheCheck=false] Disable/Enable cache checking
- * @property {?boolean} [noCaching=false] Disable/Enable writing to cache
+ * @property {boolean} [fetchPlayer=false] Raw data
+ * @property {boolean} [getMuseum=false] Raw data
+ * @property {boolean} [noCacheCheck=false] Disable/Enable cache checking
+ * @property {boolean} [noCaching=false] Disable/Enable writing to cache
  * @property {?boolean} [fetchPlayer=false] Disable/Enable player profile request for each member
  * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
  */
@@ -403,4 +469,12 @@ const defaultCache = require('./Private/defaultCache.js');
  * @property {boolean} [includeItemBytes=false] Whether to include item bytes in the result
  * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
  */
+/**
+ * @typedef {object} PlayerBingoOptions
+ * @property {boolean} [raw=false] Raw data
+ * @property {boolean} [noCacheCheck=false] Disable/Enable cache checking
+ * @property {boolean} [noCaching=false] Disable/Enable writing to cache
+ * @property {boolean} [fetchBingoData=false] Fetches bingo data to give more information
+ * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
+ */
 module.exports = Client;