hypixel-api-reborn 11.1.0 → 11.2.1

package/src/API/skyblock/getGovernment.js

@@ -0,0 +1,7 @@
+module.exports = async function () {
+  const GovernmentData = require('../../structures/SkyBlock/Static/Government.js');
+  // eslint-disable-next-line no-underscore-dangle
+  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,12 @@
 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);
+  // eslint-disable-next-line no-underscore-dangle
   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 +18,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,15 @@
+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);
+  // eslint-disable-next-line no-underscore-dangle
+  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/{getSkyblockNews.js → getNews.js}

@@ -1,5 +1,6 @@
 const SkyblockNews = require('../../structures/SkyBlock/News/SkyblockNews');
 module.exports = async function () {
+  // eslint-disable-next-line no-underscore-dangle
   const res = await this._makeRequest('/skyblock/news');
   if (res.raw) return res;
   return res.items.map((i) => new SkyblockNews(i));

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

@@ -1,10 +1,12 @@
 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);
+  // eslint-disable-next-line no-underscore-dangle
   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 +30,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

@@ -1,19 +1,43 @@
-/* eslint-disable require-jsdoc */
-/* eslint-disable max-len */
-const validate = new (require('./Private/validate'))();
 const rateLimit = new (require('./Private/rateLimit'))();
-const Requests = require('./Private/requests');
+const validate = new (require('./Private/validate'))();
 const updater = new (require('./Private/updater'))();
+const Requests = require('./Private/requests');
+const EventEmitter = require('events');
 const Errors = require('./Errors');
 const API = require('./API/index');
-const EventEmitter = require('events');
 const clients = [];
+
+/* eslint-disable */
+const Player = require('./structures/Player');
+const Guild = require('./structures/Guild/Guild');
+const WatchdogStats = require('./structures/Watchdog/Stats');
+const Booster = require('./structures/Boosters/Booster');
+const SkyblockProfile = require('./structures/SkyBlock/SkyblockProfile');
+const SkyblockMember = require('./structures/SkyBlock/SkyblockMember');
+const SkyblockMuseum = require('./structures/SkyBlock/SkyblockMuseum');
+const APIStatus = require('./structures/APIStatus');
+const Leaderboard = require('./structures/Leaderboard');
+const ServerInfo = require('./structures/ServerInfo');
+const RecentGame = require('./structures/RecentGame');
+const Status = require('./structures/Status');
+const Auction = require('./structures/SkyBlock/Auctions/Auction');
+const AuctionInfo = require('./structures/SkyBlock/Auctions/AuctionInfo');
+const PartialAuction = require('./structures/SkyBlock/Auctions/PartialAuction');
+const Product = require('./structures/SkyBlock/Bazzar/Product');
+const BingoData = require('./structures/SkyBlock/Static/BingoData');
+const PlayerBingo = require('./structures/SkyBlock/PlayerBingo');
+const GovernmentData = require('./structures/SkyBlock/Static/Government');
+const FireSale = require('./structures/SkyBlock/Static/FireSale');
+const SkyblockNews = require('./structures/SkyBlock/News/SkyblockNews');
+const GameCounts = require('./structures/GameCounts');
+/* eslint-enable */
+
 /**
  * Client class
  */
 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 = {}) {
@@ -30,13 +54,14 @@ class Client extends EventEmitter {
     this.key = validate.validateKey(key);
     this.options = validate.parseOptions(options);
     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 : {}) }),
+            // eslint-disable-next-line no-underscore-dangle
+            _makeRequest: this._makeRequest.bind(this, validate.cacheSuboptions(lastArg) ? lastArg : {}),
             ...this
           },
           args
@@ -45,7 +70,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 +81,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,16 +93,22 @@ 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 ('/key' !== url && !options.noCacheCheck && (await this.requests.cache.has(url))) {
+      return Object.assign(await this.requests.cache.get(url), { raw: Boolean(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 }
+    });
+    // eslint-disable-next-line no-underscore-dangle
     if (this.options.syncWithHeaders) rateLimit.sync(result._headers);
     return result;
   }
   /**
    * Emitted when rate limiter is ready. ( You don't have to wait for this event to emit UNLESS you are planning to do data scraping which means spamming requests )
-   * @event
+   * @event ready
    * @name Client#ready
    * @example
    * // This example gets player's uuid.
@@ -86,14 +120,14 @@ class Client extends EventEmitter {
    */
   /**
    * Emitted when a request is going to be sent
-   * @event
+   * @event outgoingRequest
    * @name Client#outgoingRequest
    * @param {string} url URL
    * @param {object} [options] Options, if any
    */
   /**
    * Emitted when there is a warning.
-   * @event
+   * @event warn
    * @name Client#warn
    * @param {string} error Warning Message
    */
@@ -132,7 +166,7 @@ class Client extends EventEmitter {
    * Allows you to get statistics of hypixel guild
    * @method
    * @name Client#getGuild
-   * @param {id|name|player} searchParameter Search for guild by id, name or player (if player is in guild)
+   * @param {'id'|'name'|'player'} searchParameter Search for guild by id, name or player (if player is in guild)
    * @param {string} query Guild ID, Guild name or player uuid/nickname
    * @param {MethodOptions} [options={}] Method options
    * @return {Promise<Guild>}
@@ -143,6 +177,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 +195,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 +212,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 +230,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 +248,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.
@@ -313,6 +374,35 @@ class Client extends EventEmitter {
    * })
    * .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
    * @method
@@ -348,17 +438,20 @@ 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 {'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
  */
+// eslint-disable-next-line no-unused-vars
 const defaultCache = require('./Private/defaultCache.js');
 /**
  * @typedef {defaultCache} Cache
@@ -384,9 +477,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 +497,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;

package/src/Errors.js

@@ -2,44 +2,65 @@
 module.exports = {
   INVALID_API_KEY: '[hypixel-api-reborn] Invalid API Key! For help join our Discord Server https://discord.gg/NSEBNMM',
   NO_API_KEY: '[hypixel-api-reborn] No API Key specified! For help join our Discord Server https://discord.gg/NSEBNMM',
-  ERROR_CODE_CAUSE: '[hypixel-api-reborn] Code: {code} - {cause}! For help join our Discord Server https://discord.gg/NSEBNMM',
+  ERROR_CODE_CAUSE:
+    '[hypixel-api-reborn] Code: {code} - {cause}! For help join our Discord Server https://discord.gg/NSEBNMM',
   ERROR_STATUSTEXT: '[hypixel-api-reborn] {statustext}! For help join our Discord Server https://discord.gg/NSEBNMM',
-  KEY_MUST_BE_A_STRING: '[hypixel-api-reborn] Specified API Key must be a string! For help join our Discord Server https://discord.gg/NSEBNMM',
-  OPTIONS_MUST_BE_AN_OBJECT: '[hypixel-api-reborn] Options must be an object! For help join our Discord Server https://discord.gg/NSEBNMM',
-  CACHE_TIME_MUST_BE_A_NUMBER: '[hypixel-api-reborn] Cache Time must be a number! For help join our Discord Server https://discord.gg/NSEBNMM',
-  CACHE_LIMIT_MUST_BE_A_NUMBER: '[hypixel-api-reborn] Cache Limit must be a number! For help join our Discord Server https://discord.gg/NSEBNMM',
-  CACHE_FILTER_INVALID: '[hypixel-api-reborn] Cache Filter must be a function returning a boolean, an object, an array, or a string!',
+  KEY_MUST_BE_A_STRING:
+    '[hypixel-api-reborn] Specified API Key must be a string! For help join our Discord Server https://discord.gg/NSEBNMM',
+  OPTIONS_MUST_BE_AN_OBJECT:
+    '[hypixel-api-reborn] Options must be an object! For help join our Discord Server https://discord.gg/NSEBNMM',
+  CACHE_TIME_MUST_BE_A_NUMBER:
+    '[hypixel-api-reborn] Cache Time must be a number! For help join our Discord Server https://discord.gg/NSEBNMM',
+  CACHE_LIMIT_MUST_BE_A_NUMBER:
+    '[hypixel-api-reborn] Cache Limit must be a number! For help join our Discord Server https://discord.gg/NSEBNMM',
+  CACHE_FILTER_INVALID:
+    '[hypixel-api-reborn] Cache Filter must be a function returning a boolean, an object, an array, or a string!',
   NO_NICKNAME_UUID: '[hypixel-api-reborn] No nickname or uuid specified.',
   NO_UUID: '[hypixel-api-reborn] No uuid specified.',
   UUID_NICKNAME_MUST_BE_A_STRING: '[hypixel-api-reborn] Nickname or uuid must be a string.',
   MALFORMED_UUID: '[hypixel-api-reborn] Malformed UUID!',
   PLAYER_DOES_NOT_EXIST: '[hypixel-api-reborn] Player does not exist.',
   PLAYER_HAS_NEVER_LOGGED: '[hypixel-api-reborn] Player has never logged into Hypixel.',
-  PLAYER_IS_INACTIVE: "[hypixel-api-reborn] No records of recent games because player hasn't been online for more than 3 days or is lacking data to determine the cause of an empty response",
+  PLAYER_IS_INACTIVE:
+    "[hypixel-api-reborn] No records of recent games because player hasn't been online for more than 3 days or is lacking data to determine the cause of an empty response",
   PLAYER_DISABLED_ENDPOINT: '[hypixel-api-reborn] Player has disabled this endpoint.',
   NO_GUILD_QUERY: '[hypixel-api-reborn] No guild search query specified.',
   INVALID_GUILD_ID: '[hypixel-api-reborn] Specified Guild ID is invalid.',
   INVALID_GUILD_SEARCH_PARAMETER: "[hypixel-api-reborn] getGuild() searchParameter must be 'id', 'guild' or 'player'.",
   SOMETHING_WENT_WRONG: '[hypixel-api-reborn] Something went wrong. {cause}',
   GUILD_DOES_NOT_EXIST: '[hypixel-api-reborn] Guild does not exist.',
-  PAGE_INDEX_ERROR: '[hypixel-api-reborn] Invalid page index. Must be an integer, an array of 2 integers, or a keyword. For help join our Discord Server https://discord.gg/NSEBNMM',
-  INVALID_OPTION_VALUE: '[hypixel-api-reborn] Invalid option value! For help join our Discord Server https://discord.gg/NSEBNMM',
-  INVALID_RESPONSE_BODY: '[hypixel-api-reborn] An error occurred while converting to JSON. Perhaps this is due to an update or maintenance. For help join our Discord Server https://discord.gg/NSEBNMM',
-  INVALID_RATE_LIMIT_OPTION: "[hypixel-api-reborn] Rate Limit provided in Client options must be 'HARD', 'AUTO', or 'NONE'. For help join our Discord Server https://discord.gg/NSEBNMM",
-  INVALID_KEY_LIMIT_OPTION: '[hypixel-api-reborn] Key Limit provided in Client options must be an integer representing the amount of requests possible in one minute with your key.',
+  PAGE_INDEX_ERROR:
+    '[hypixel-api-reborn] Invalid page index. Must be an integer, an array of 2 integers, or a keyword. For help join our Discord Server https://discord.gg/NSEBNMM',
+  INVALID_OPTION_VALUE:
+    '[hypixel-api-reborn] Invalid option value! For help join our Discord Server https://discord.gg/NSEBNMM',
+  INVALID_RESPONSE_BODY:
+    '[hypixel-api-reborn] An error occurred while converting to JSON. Perhaps this is due to an update or maintenance. For help join our Discord Server https://discord.gg/NSEBNMM',
+  INVALID_RATE_LIMIT_OPTION:
+    "[hypixel-api-reborn] Rate Limit provided in Client options must be 'HARD', 'AUTO', or 'NONE'. For help join our Discord Server https://discord.gg/NSEBNMM",
+  INVALID_KEY_LIMIT_OPTION:
+    '[hypixel-api-reborn] Key Limit provided in Client options must be an integer representing the amount of requests possible in one minute with your key.',
   INVALID_HEADER_SYNC_OPTION: '[hypixel-api-reborn] Invalid Value for maxSyncHeaders : must be a boolean',
   INVALID_BURST_OPTION: '[hypixel-api-reborn] maxBurstRequests provided in Client options must be a number',
-  NODE_VERSION_ERR: "[hypixel-api-reborn] You are using a version of Nodejs that doesn't support certain features we use. Please upgrade to version 14 or above.",
+  NODE_VERSION_ERR:
+    "[hypixel-api-reborn] You are using a version of Nodejs that doesn't support certain features we use. Please upgrade to version 14 or above.",
   UPDATER_REQUEST_NOT_OK: '[hypixel-api-reborn] An error occurred checking for updates.',
   CONNECTION_ERROR: '[hypixel-api-reborn] Failed to connect.',
-  RATE_LIMIT_INIT_ERROR: '[hypixel-api-reborn] An error happened whilst initializing rate limit. We strongly recommend restarting the code as this can lead to desynchronization.',
+  RATE_LIMIT_INIT_ERROR:
+    '[hypixel-api-reborn] An error happened whilst initializing rate limit. We strongly recommend restarting the code as this can lead to desynchronization.',
   MULTIPLE_INSTANCES:
     '[hypixel-api-reborn] Multiple instances of hypixel-api-reborn are found so we merged them for you. Please refrain from spawning multiple instances in the future. For more information, join our Discord Server https://discord.gg/NSEBNMM.',
-  INVALID_HEADERS: '[hypixel-api-reborn] Invalid Headers are provided in ClientOptions. For help join our Discord Server https://discord.gg/NSEBNMM',
-  INVALID_CACHE_HANDLER: '[hypixel-api-reborn] An invalid cache handler is provideed. For help join our Discord Server https://discord.gg/NSEBNMM',
+  INVALID_HEADERS:
+    '[hypixel-api-reborn] Invalid Headers are provided in ClientOptions. For help join our Discord Server https://discord.gg/NSEBNMM',
+  INVALID_CACHE_HANDLER:
+    '[hypixel-api-reborn] An invalid cache handler is provideed. For help join our Discord Server https://discord.gg/NSEBNMM',
   UNEXPECTED_ERROR:
     "[hypixel-api-reborn] The data provided to hypixel API is malformed and thus not recognized by hypixel, but this shouldn't be your fault. Please report this error in our Discord Server https://discord.gg/NSEBNMM or GitHub. ",
   RATE_LIMIT_EXCEEDED:
     "[hypixel-api-reborn] The rate limitations on your API Key has been exceeded. There might be an outage (Check Hypixel's status page), or you simply did too many requests in a short time. Hint: Enable rate limit options! They can help you avoid this error! For help join our Discord Server https://discord.gg/NSEBNMM",
-  NO_SKYBLOCK_PROFILES: '[hypixel-api-reborn] The player has no skyblock profiles.'
+  NO_SKYBLOCK_PROFILES: '[hypixel-api-reborn] The player has no skyblock profiles.',
+  INVALID_SILENT_OPTION: '[hypixel-api-reborn] Invalid Value for silent : must be a boolean',
+  INVALID_UPDATE_OPTION: '[hypixel-api-reborn] Invalid Value for update : must be a boolean',
+  INVALID_THIRD_PARTY_API_OPTION: '[hypixel-api-reborn] Invalid Third Party API option : must be a boolean or string',
+  BAD_AUCTION_FILTER:
+    '[hypixel-api-reborn] Unexpected filter for Client#getSkyblockAuction. Expected one of "PLAYER", "AUCTION", "PROFILE", but got something else.'
 };

package/src/Private/rateLimit.js

@@ -1,8 +1,5 @@
-/* eslint-disable @typescript-eslint/no-empty-function */
-/* eslint-disable camelcase */
 const Errors = require('../Errors');
 
-/* eslint-disable require-jsdoc */
 class RateLimit {
   constructor() {
     this.initialized = 0;
@@ -12,18 +9,21 @@ class RateLimit {
     if (!this.initialized) return;
     this.requests++;
     this.requestQueue.unshift(Date.now());
-    if (this.options.rateLimit === 'NONE' || !this.requestQueue.length) return;
-    if (this.options.rateLimit === 'AUTO' && this.requests <= this.options.keyLimit / 2) return;
+    if ('NONE' === this.options.rateLimit || !this.requestQueue.length) return;
+    if ('AUTO' === this.options.rateLimit && this.requests <= this.options.keyLimit / 2) return;
     const cooldown = this.computeCooldownTime();
     this.requestQueue[0] = Date.now() + cooldown;
-    await new Promise((r) => setTimeout(r, cooldown), true);
-    return;
+    return await new Promise((r) => setTimeout(r, cooldown), true);
   }
 
   sync(data) {
     this.options.keyLimit = parseInt(data.get('ratelimit-limit'), 10) || this.options.keyLimit;
     this.requests = parseInt(data.get('ratelimit-remaining'), 10) || this.requests;
-    if (data.get('ratelimit-reset') && Math.round(Date.now() / 1000) - (300 - parseInt(data.get('ratelimit-reset'), 10)) !== Math.round(this.lastResetHappenedAt / 1000)) {
+    if (
+      data.get('ratelimit-reset') &&
+      Math.round(Date.now() / 1000) - (300 - parseInt(data.get('ratelimit-reset'), 10)) !==
+        Math.round(this.lastResetHappenedAt / 1000)
+    ) {
       clearTimeout(this.resetTimer);
       this.resetTimer = setTimeout(this.reset.bind(this), parseInt(data.get('ratelimit-reset'), 10) * 1000);
     }
@@ -32,12 +32,16 @@ class RateLimit {
   computeCooldownTime() {
     const overhead = this.requestQueue[1] <= Date.now() ? 0 : this.requestQueue[1] - Date.now();
     const multiplier = Math.floor(this.requests / this.options.keyLimit) + 1;
-    return overhead + (-overhead - Date.now() + 300000 * multiplier + this.lastResetHappenedAt) / (this.options.keyLimit * multiplier - this.requests);
+    return (
+      overhead +
+      (-overhead - Date.now() + 300000 * multiplier + this.lastResetHappenedAt) /
+        (this.options.keyLimit * multiplier - this.requests)
+    );
   }
 
   reset() {
     this.requests = this.requests - this.options.keyLimit;
-    if (this.requests < 0) this.requests = 0;
+    if (0 > this.requests) this.requests = 0;
     this.lastResetHappenedAt = Date.now();
     this.resetTimer = setTimeout(this.reset.bind(this), 300000);
     this.requestQueue = this.requestQueue.filter((x) => x >= Date.now());
@@ -50,13 +54,13 @@ class RateLimit {
   init(keyInfo, options, client) {
     this.options = options;
     this.requests = 0;
-    this.cooldownTime = 300000 / this.options.keyLimit; // Initial value
+    this.cooldownTime = 300000 / this.options.keyLimit;
     this.requestQueue = [];
     this.client = client;
     return keyInfo
       .then((info) => {
         this.requests = info.requestsInPastMin;
-        this.lastResetHappenedAt = Date.now() - (300 - info.resetsAfter) * 1000; // Computed reset time
+        this.lastResetHappenedAt = Date.now() - (300 - info.resetsAfter) * 1000;
         this.resetTimer = setTimeout(this.rateLimitMonitor.bind(this), 1000 * info.resetsAfter);
         this.initialized = 1;
       })
@@ -74,6 +78,6 @@ module.exports = RateLimit;
 /**
  * @typedef {Object} RLOptions
  * @property {number} keyLimit Max request of key per min
- * @property {NONE|AUTO|HARD} rateLimit rate limit mode
+ * @property {'NONE'|'AUTO'|'HARD'} rateLimit rate limit mode
  * @property {boolean} syncWithHeaders Sync rate limits with headers
  */

package/src/Private/requests.js

@@ -1,10 +1,9 @@
-/* eslint-disable require-jsdoc */
 const requireFetch = !globalThis.fetch;
-const externalFetch = require('node-fetch');
+const externalFetch = (...args) => import('node-fetch').then(({ default: fetch }) => fetch(...args));
+const fetch = requireFetch ? externalFetch : globalThis.fetch;
 const BASE_URL = 'https://api.hypixel.net/v2';
-const Errors = require('../Errors');
 const Cache = require('./defaultCache');
-const Client = require('../Client.js');
+const Errors = require('../Errors');
 
 class Requests {
   constructor(client, cache) {
@@ -14,32 +13,44 @@ class Requests {
   }
   async request(endpoint, options = {}) {
     options.headers = { 'API-Key': this.client.key, ...options.headers };
-    const fetchMethod = requireFetch ? externalFetch : fetch;
     /**
      * @type {externalFetch.Response|Response}
      */
-    const res = await fetchMethod(BASE_URL + endpoint, options);
-    if (res.status >= 500 && res.status < 528) throw new Error(Errors.ERROR_STATUSTEXT.replace(/{statustext}/, `Server Error : ${res.status} ${res.statusText}`));
+    const res = await fetch(BASE_URL + endpoint, options);
+    if (500 <= res.status && 528 > res.status) {
+      throw new Error(
+        Errors.ERROR_STATUSTEXT.replace(/{statustext}/, `Server Error : ${res.status} ${res.statusText}`)
+      );
+    }
     const parsedRes = await res.json().catch(() => {
       throw new Error(Errors.INVALID_RESPONSE_BODY);
     });
-    if (res.status === 400) throw new Error(Errors.ERROR_CODE_CAUSE.replace(/{code}/, '400 Bad Request').replace(/{cause}/, parsedRes.cause || ''));
-    if (res.status === 403) throw new Error(Errors.INVALID_API_KEY);
-    if (res.status === 422) throw new Error(Errors.UNEXPECTED_ERROR);
-    if (res.status === 429) throw new Error(Errors.RATE_LIMIT_EXCEEDED);
-    if (res.status !== 200) throw new Error(Errors.ERROR_STATUSTEXT.replace(/{statustext}/, res.statusText));
+    if (400 === res.status) {
+      throw new Error(
+        Errors.ERROR_CODE_CAUSE.replace(/{code}/, '400 Bad Request').replace(/{cause}/, parsedRes.cause || '')
+      );
+    }
+    if (403 === res.status) throw new Error(Errors.INVALID_API_KEY);
+    if (422 === res.status) throw new Error(Errors.UNEXPECTED_ERROR);
+    if (429 === res.status) throw new Error(Errors.RATE_LIMIT_EXCEEDED);
+    if (200 !== res.status) throw new Error(Errors.ERROR_STATUSTEXT.replace(/{statustext}/, res.statusText));
     if (!parsedRes.success) {
       throw new Error(Errors.SOMETHING_WENT_WRONG.replace(/{cause}/, res.cause));
     }
+    // eslint-disable-next-line no-underscore-dangle
     parsedRes._headers = res.headers;
-    parsedRes.raw = !!options.raw;
+    parsedRes.raw = Boolean(options.raw);
     if (options.noCaching) return parsedRes;
     // split by question mark : first part is /path, remove /
     if (this.client.options.cache && this.client.options.cacheFilter(endpoint.split('?')[0].slice(1))) {
-      if (this.client.options.cacheSize < (await this.cached.size())) await this.cached.delete(Array.from(await this.cached.keys())[0]);
+      if (this.client.options.cacheSize < (await this.cached.size())) {
+        await this.cached.delete(Array.from(await this.cached.keys())[0]);
+      }
       await this.cached.delete(endpoint);
       await this.cached.set(endpoint, parsedRes);
-      if (this.client.options.cacheTime >= 0) setTimeout(() => this.cached.delete(endpoint), 1000 * this.client.options.cacheTime);
+      if (0 <= this.client.options.hypixelCacheTime) {
+        setTimeout(() => this.cached.delete(endpoint), 1000 * this.client.options.hypixelCacheTime);
+      }
     }
     return parsedRes;
   }
@@ -58,7 +69,7 @@ class Requests {
   }
 
   validateCustomCache(cache) {
-    return !!(cache.set && cache.get && cache.delete && cache.keys);
+    return Boolean(cache.set && cache.get && cache.delete && cache.keys);
   }
 }