hypixel-api-reborn 8.3.0 → 10.0.0

package/README.md

@@ -10,7 +10,7 @@
 <img src="https://flat.badgen.net/npm/license/hypixel-api-reborn">
 <a href="https://github.com/Hypixel-API-Reborn/hypixel-api-reborn"><img src="https://flat.badgen.net/github/stars/hypixel-api-reborn/hypixel-api-reborn"></a>
 <a href="https://www.npmjs.com/package/hypixel-api-reborn"><img src="https://nodei.co/npm/hypixel-api-reborn.png?compact=true"></a>
-<h2>This is the only Hypixel API wrapper for Node.js with intellisense support</h2>
+<h2>A feature-rich Hypixel API wrapper for Node.js</h2>
 <br>
 </div>
 
@@ -47,7 +47,7 @@ hypixel.getGuild('name', 'The Foundation').then(guild => {
 ```
 For more examples go to our [documentation](https://hypixel.stavzdev.me/).
 ## Changelog
-[v8.2.0](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/releases/tag/8.2.0)
+[v10.0.0](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/releases/tag/10.0.0)
 
 ### Try it now
 **[Code Sandbox](https://codesandbox.io/s/clever-babbage-xqmfw?file=/src/index.js)**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypixel-api-reborn",
-  "version": "8.3.0",
+  "version": "10.0.0",
   "description": "Feature-rich Hypixel API wrapper for Node.js",
   "main": "./src/index.js",
   "types": "./typings/index.d.ts",
@@ -32,7 +32,7 @@
   "author": "StavZ",
   "dependencies": {
     "node-fetch": "^2.6.1",
-    "object-path": "^0.11.5",
+    "object-path": "^0.11.8",
     "prismarine-nbt": "^1.6.0",
     "rss-parser": "^3.12.0"
   },
@@ -43,16 +43,16 @@
   },
   "publisher": "StavZ",
   "devDependencies": {
-    "@types/node": "^16.3.1",
-    "@typescript-eslint/eslint-plugin": "^4.28.2",
-    "@typescript-eslint/parser": "^4.28.2",
+    "@types/node": "^16.10.2",
+    "@typescript-eslint/eslint-plugin": "^4.32.0",
+    "@typescript-eslint/parser": "^4.32.0",
     "chai": "^4.3.4",
-    "dtslint": "^4.1.2",
-    "eslint": "^7.30.0",
+    "dtslint": "^4.1.6",
+    "eslint": "^7.32.0",
     "eslint-config-google": "^0.14.0",
-    "mocha": "^9.0.2",
+    "mocha": "^9.1.2",
     "node-env-run": "^4.0.2",
     "path": "^0.12.7",
-    "typescript": "^4.3.5"
+    "typescript": "^4.4.3"
   }
 }

package/src/API/getAPIStatus.js

@@ -1,7 +1,8 @@
 const Rss = require('rss-parser');
 const Parser = new Rss();
-module.exports = async function () {
+module.exports = async function (options) {
   const Status = require('../structures/APIStatus.js');
   const parsed = await Parser.parseURL('https://status.hypixel.net/history.rss');
+  if (options.raw) return parsed;
   return new Status(parsed);
 };

package/src/API/getBoosters.js

@@ -1,5 +1,6 @@
 module.exports = async function () {
   const Booster = require('../structures/Boosters/Booster');
   const res = await this._makeRequest('/boosters');
+  if (res.raw) return res;
   return res.boosters.length ? res.boosters.map((b) => new Booster(b)).reverse() : [];
 };

package/src/API/getFriends.js

@@ -5,6 +5,7 @@ module.exports = async function (query) {
   const Friend = require('../structures/Friend');
   query = await toUuid(query);
   const res = await this._makeRequest(`/friends?uuid=${query}`);
+  if (res.raw) return res;
   if (res.records.length && res.records.length > 0) {
     return res.records.map((f) => new Friend(f, query));
   } else {

package/src/API/getGameCounts.js

@@ -1,5 +1,6 @@
 const GameCounts = require('../structures/GameCounts');
 module.exports = async function () {
   const res = await this._makeRequest('/counts');
+  if (res.raw) return res;
   return new GameCounts(res);
 };

package/src/API/getGuild.js

@@ -5,12 +5,14 @@ module.exports = async function (searchParameter, query) {
   if (!query) throw new Error(Errors.NO_GUILD_QUERY);
   const Guild = require('../structures/Guild/Guild');
   if (searchParameter === 'id' && !isGuildID(query)) throw new Error(Errors.INVALID_GUILD_ID);
-  if (searchParameter === 'player') query = await toUuid(query);
+  const isPlayerQuery = searchParameter === 'player';
+  if (isPlayerQuery) query = await toUuid(query);
   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;
   if (!res.guild && searchParameter !== 'player') {
     throw new Error(Errors.GUILD_DOES_NOT_EXIST);
   }
 
-  return res.guild ? new Guild(res.guild) : null;
+  return res.guild ? new Guild(res.guild, isPlayerQuery ? query : null) : null;
 };

package/src/API/getKeyInfo.js

@@ -2,6 +2,7 @@ const Errors = require('../Errors');
 module.exports = async function () {
   const KeyInfo = require('../structures/KeyInfo');
   const res = await this._makeRequest('/key');
+  if (res.raw) return res;
   if (!res.success) {
     throw new Error(Errors.SOMETHING_WENT_WRONG.replace(/{cause}/, res.cause));
   }

package/src/API/getLeaderboards.js

@@ -2,6 +2,7 @@ const Errors = require('../Errors');
 module.exports = async function () {
   const Leaderboard = require('../structures/Leaderboard');
   const res = await this._makeRequest('/leaderboards');
+  if (res.raw) return res;
   if (!res.leaderboards) throw new Error(Errors.SOMETHING_WENT_WRONG.replace(/{cause}/, 'Try again.'));
   const lbnames = Object.create(require('../utils/Constants').leaderboardNames);
   // eslint-disable-next-line guard-for-in

package/src/API/getPlayer.js

@@ -1,12 +1,27 @@
 const Errors = require('../Errors');
 const toUuid = require('../utils/toUuid');
 const getGuild = require('./getGuild');
-module.exports = async function (query, options = { guild: false }) {
+const getRecentGames = require('./getRecentGames');
+const getRankedSkyWars = require('./getRankedSkyWars');
+module.exports = async function (query, options = { guild: false, recentGames: false, currentRankedSW: false }) {
   if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
   const Player = require('../structures/Player');
   query = await toUuid(query);
   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);
-  res.player.guild = options.guild ? await getGuild.call(this, 'player', query) : null;
-  return new Player(res.player, this);
+  let guild = null;
+  let recentGames = null;
+  let rankedSW = null;
+  if (options.guild) {
+    guild = getGuild.call(this, 'player', query);
+  }
+  if (options.recentGames) {
+    recentGames = getRecentGames.call(this, query);
+  }
+  if (options.currentRankedSW) {
+    rankedSW = getRankedSkyWars.call(this, query);
+  }
+  [guild, recentGames, rankedSW] = await Promise.all([guild, recentGames, rankedSW]);
+  return new Player(res.player, { guild, recentGames, rankedSW });
 };

package/src/API/getRankedSkyWars.js

@@ -0,0 +1,11 @@
+const Errors = require('../Errors');
+const toUuid = require('../utils/toUuid');
+module.exports = async function (query) {
+  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
+  const SkyWarsRanked = require('../structures/MiniGames/SkyWarsRanked');
+  query = await toUuid(query);
+  const res = await this._makeRequest(`/player/ranked/skywars?uuid=${query}`);
+  if (res.raw) return res;
+  if (!res.result) return null;
+  return new SkyWarsRanked(res.result);
+};

package/src/API/getRecentGames.js

@@ -8,6 +8,7 @@ module.exports = async function (query, playerData) {
   query = await toUuid(query);
 
   const res = await this._makeRequest(`/recentgames?uuid=${query}`);
+  if (res.raw) return res;
   if (res.games === []) {
     if (!playerData) throw new Error(Errors.PLAYER_IS_INACTIVE);
     if (Date.now() - playerData.lastLogoutTimestamp < day3) throw new Error(Errors.PLAYER_DISABLED_ENDPOINT);

package/src/API/getStatus.js

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

package/src/API/getWatchdogStats.js

@@ -1,5 +1,6 @@
 module.exports = async function () {
   const WatchdogStats = require('../structures/Watchdog/Stats');
   const res = await this._makeRequest('/punishmentstats');
+  if (res.raw) return res;
   return new WatchdogStats(res);
 };

package/src/API/index.js

@@ -1,9 +1,23 @@
-/* eslint-disable no-extend-native */
-const fs = require('fs');
-// eslint-disable-next-line no-path-concat
-const curDir = __dirname + '/';
-module.exports = Array.from(fs.readdirSync(curDir, { withFileTypes: true }))
-  .filter((x) => x.name !== 'index.js')
-  .map((x) => x.isDirectory() ? Array.from(fs.readdirSync(curDir + x.name)).map((y) => ([y.split('.')[0], x.name + '/' + y])) : [[x.name.split('.')[0], x.name]])
-  .flat(1)
-  .reduce((pV, cV) => Object.assign(pV, { [cV[0]]: require(curDir + cV[1]) }), {});
+module.exports = {
+  getAPIStatus: require('./getAPIStatus'),
+  getBoosters: require('./getBoosters'),
+  getFriends: require('./getFriends'),
+  getGameCounts: require('./getGameCounts'),
+  getGuild: require('./getGuild'),
+  getKeyInfo: require('./getKeyInfo'),
+  getLeaderboards: require('./getLeaderboards'),
+  getPlayer: require('./getPlayer'),
+  getRankedSkyWars: require('./getRankedSkyWars'),
+  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')
+};

package/src/API/skyblock/getEndedSkyblockAuctions.js

@@ -2,6 +2,7 @@ const PartialAuction = require('../../structures/SkyBlock/Auctions/PartialAuctio
 const AuctionInfo = require('../../structures/SkyBlock/Auctions/AuctionInfo');
 module.exports = async function (includeItemBytes = false) {
   const res = await this._makeRequest('/skyblock/auctions_ended', false);
+  if (res.raw) return res;
   return {
     info: new AuctionInfo({ ...res, totalAuctions: res.auctions.length, totalPages: 1 }),
     auctions: res.auctions.length ? res.auctions.map((a) => new PartialAuction(a, includeItemBytes)) : []

package/src/API/skyblock/getSkyblockAuctionsByPlayer.js

@@ -5,6 +5,7 @@ module.exports = async function (query, includeItemBytes = false) {
   const Auction = require('../../structures/SkyBlock/Auctions/Auction');
   query = await toUuid(query);
   const res = await this._makeRequest(`/skyblock/auction?player=${query}`);
+  if (res.raw) return res;
 
   return res.auctions.length ? res.auctions.map((a) => new Auction(a, includeItemBytes)) : [];
 };

package/src/API/skyblock/getSkyblockBazaar.js

@@ -2,6 +2,7 @@ module.exports = async function () {
   const Product = require('../../structures/SkyBlock/Bazzar/Product');
 
   const res = await this._makeRequest('/skyblock/bazaar');
+  if (res.raw) return res;
 
   const productsKeys = Object.keys(res.products);
 

package/src/API/skyblock/getSkyblockMember.js

@@ -6,6 +6,7 @@ module.exports = async function (query, options = { fetchPlayer: false }) {
   if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
   query = await toUuid(query);
   const res = await this._makeRequest(`/skyblock/profiles?uuid=${query}`);
+  if (res.raw) return res;
   if (!res.profiles || !res.profiles.length) {
     return new Map();
   }

package/src/API/skyblock/getSkyblockNews.js

@@ -1,5 +1,6 @@
 const SkyblockNews = require('../../structures/SkyBlock/News/SkyblockNews');
 module.exports = async function () {
   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

@@ -6,6 +6,7 @@ module.exports = async function (query, options = { fetchPlayer: false }) {
   if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
   query = await toUuid(query);
   const res = await this._makeRequest(`/skyblock/profiles?uuid=${query}`);
+  if (res.raw) return res;
 
   if (!res.profiles || !res.profiles.length) {
     return [];

package/src/Client.js

@@ -2,7 +2,8 @@
 /* eslint-disable max-len */
 const validate = new (require('./Private/validate'))();
 const rateLimit = new (require('./Private/rateLimit'))();
-const requests = new (require('./Private/requests'))();
+const Requests = require('./Private/requests');
+const updater = new (require('./Private/updater'))();
 const Errors = require('./Errors');
 const API = require('./API/index');
 const EventEmitter = require('events');
@@ -17,6 +18,7 @@ class Client extends EventEmitter {
    */
   constructor (key, options = {}) {
     super();
+    this.requests = new Requests(this, options.cacheHandler);
     // eslint-disable-next-line no-console
     if (options && !options.silent) this.on('warn', console.warn);
     // Test to check for multiple instances of client
@@ -28,17 +30,29 @@ class Client extends EventEmitter {
     this.key = validate.validateKey(key);
     this.options = validate.parseOptions(options);
     validate.validateOptions(this.options);
-    // eslint-disable-next-line no-return-assign
-    Object.keys(API).forEach((func) => Client.prototype[func] = function (...args) {
-      return API[func].apply({ _makeRequest: this._makeRequest.bind(this, { ...(validate.cacheSuboptions(args[args.length - 1]) ? args[args.length - 1] : {}) }), ...this }, args);
-    });
+    // eslint-disable-next-line guard-for-in
+    for (const func in API) {
+      Client.prototype[func] = function (...args) {
+        const lastArg = args[args.length - 1];
+        return API[func].apply(
+          {
+            _makeRequest: this._makeRequest.bind(this, { ...(validate.cacheSuboptions(lastArg) ? lastArg : {}) }),
+            ...this
+          },
+          args);
+      };
+
+      if (this.options.checkForUpdates) {
+        updater.checkForUpdates();
+      }
+    }
     /**
      * All cache entries
      * @type {Map<string,object>}
      */
-    this.cache = requests.cache;
+    this.cache = this.requests.cache;
     clients.push(this);
-    rateLimit.init(this.getKeyInfo(), this.options, this).then(()=>this.emit('ready'));
+    rateLimit.init(this.getKeyInfo(), this.options, this).then(() => this.emit('ready'));
   }
   /**
    * Private function - make request
@@ -50,10 +64,10 @@ class Client extends EventEmitter {
    */
   async _makeRequest (options, url, useRateLimitManager = true) {
     if (!url) return;
-    if (url !== '/key' && !options.noCacheCheck && requests.cache.has(url)) return requests.cache.get(url);
+    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 requests.request.call(this, url, {...options, headers: {...options.headers, ...this.options.headers}});
+    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 } });
     if (this.options.syncWithHeaders) rateLimit.sync(result._headers);
     return result;
   }
@@ -72,8 +86,7 @@ class Client extends EventEmitter {
    * // This example gets the first 100 friends of a player and gets their stats.
    * hypixel.once('ready',()=>{
    *  hypixel.getFriends('StavZDev')
-   *  .then(friends => friends.map(x=>x.uuid).slice(0, 100))
-   *  .then(hypixel.getPlayer)
+   *  .then(friends => friends.map(x=>x.uuid).slice(0, 100).map(hypixel.getPlayer))
    *  .catch(console.log);
    * })
    */
@@ -350,41 +363,72 @@ class Client extends EventEmitter {
    * })
    * .catch(console.log)
    */
+  /**
+   * Allows you to get Ranked SkyWars data for current season of a player
+   * @method
+   * @name Client#getRankedSkyWars
+   * @param {string} query Player nickname or uuid
+   * @param {MethodOptions} [options={}] Options
+   * @return {Promise<SkyWarsRanked>}
+   * @example
+   * hypixel.getRankedSkyWars('gypu').then((ranked) => {
+   *   console.log(ranked.position); // 4
+   * }).catch(console.log);
+   * @example
+   * // if player has no stats for current ranked season
+   * hypixel.getRankedSkyWars('StavZDev').then((ranked) => {
+   *   console.log(ranked); // null
+   * }).catch(console.log) // throws 404 error;
+   */
   /**
    * Delete x (by default all) cache entries
    * @param {?number} amount Amount of cache to delete
    * @return {Promise<void|boolean[]>}
    */
   sweepCache (amount) {
-    return requests.sweepCache(amount);
+    return this.requests.sweepCache(amount);
   }
 }
 /**
  * @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 {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} [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=false] Enable/Disable check for new version of hypixel-api-reborn.
+ */
+const defaultCache = require('./Private/defaultCache.js');
+/**
+ * @typedef {defaultCache} Cache
+ */
+/**
+ * @typedef {Cache} CacheHandler
  */
 /**
  * @typedef {object} MethodOptions
+ * @property {boolean} [raw=false] Raw data
  * @property {boolean} [noCacheCheck=false] Disable/Enable cache checking
  * @property {boolean} [noCaching=false] Disable/Enable writing to cache
  * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
  */
 /**
  * @typedef {object} PlayerMethodOptions
+ * @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} [guild=false] Disable/Enable request for player's guild
+ * @property {boolean} [recentGames=false] Disable/Enable request for player's recent game
+ * @property {boolean} [currentRankedSW=false] Disable/Enable request for player's current ranked SkyWars rating. Previous ratings will always show mindless of this option.
  * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
  */
 /**
  * @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] Disable/Enable player profile request for each member

package/src/Errors.js

@@ -30,8 +30,10 @@ module.exports = {
   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.',
+  UPDATER_REQUEST_NOT_OK: '[hypixel-api-reborn] An error occured 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.',
   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_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'
 };

package/src/Private/defaultCache.js

@@ -0,0 +1,78 @@
+/**
+ * This is the default cache implementation, using a Map.
+ * All cache implementations must have these methods below, they can be async :
+ * set(key, value) : Sets key to value
+ * has(key) : Whether there is an entry to this key. (can be an alias to get)
+ * get(key) : Gets by key (nullish value if not found)
+ * delete(key) : Deletes by key
+ * keys() : Array of keys, ordered by time of creation. To help you, the key will be deleted and set in case of an update
+ * size(): Size of cache (number of keys)
+ * clear(): Deletes all cache entries
+ * See JSDoc for more info
+ */
+class Cache {
+  /**
+   * Constructor
+   */
+  constructor() {
+    this.storage = new Map();
+  }
+  /**
+   * Sets an entry
+   * @param {string} key String key
+   * @param {*} value Any value
+   * @return {boolean}
+   */
+  set(key, value) {
+    return this.storage.set(key, value);
+  }
+  /**
+   * Check if there's an entry in the cache that has this key
+   * This doesn't have to return boolean, just a truthy/falsy value
+   * @param {string} key String key
+   * @return {boolean} Whether this key exists
+   */
+  has(key) {
+    return this.storage.has(key);
+  }
+  /**
+   * Gets an entry, return a nullish value if not found
+   * @param {string} key String key
+   * @return {*}
+   */
+  get(key) {
+    return this.storage.get(key);
+  }
+  /**
+   * Deletes an entry
+   * @param {string} key String key
+   * @return {boolean} Preferably, returns a boolean to check if the deletion is actually successful
+   */
+  delete(key) {
+    return this.storage.delete(key);
+  }
+  /**
+   * Returns Array of string (not an iterator preferably, it can break)
+   * @return {string[]}
+   */
+  keys() {
+    return Array.from(this.storage.keys());
+  }
+  /**
+   * Returns size of cache
+   * @return {number}
+   */
+  size() {
+    return this.storage.size;
+  }
+  /**
+   * Clears cache
+   * @return {void}
+   */
+  clear() {
+    this.storage.clear();
+  }
+}
+
+module.exports = Cache;
+

package/src/Private/rateLimit.js

@@ -21,11 +21,11 @@ module.exports = class RateLimit {
   }
 
   sync (data) {
-    this.options.keyLimit = parseInt(data.get('ratelimit-limit')) || this.options.keyLimit;
-    this.requests = parseInt(data.get('ratelimit-remaining')) || this.requests;
-    if (data.get('ratelimit-reset') && Math.round(Date.now() / 1000) - (60 - parseInt(data.get('ratelimit-reset'))) != Math.round(this.lastResetHappenedAt / 1000)) {
+    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) - (60 - 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')) * 1000);
+      this.resetTimer = setTimeout(this.reset.bind(this), parseInt(data.get('ratelimit-reset'), 10) * 1000);
     }
   }
 

package/src/Private/requests.js

@@ -2,10 +2,19 @@
 const fetch = require('node-fetch');
 const BASE_URL = 'https://api.hypixel.net';
 const Errors = require('../Errors');
-const cached = new Map();
+const Cache = require('./defaultCache');
+
 module.exports = class Requests {
+  constructor(client, cache) {
+    if (cache && !this.validateCustomCache()) throw new Error(Errors.INVALID_CACHE_HANDLER);
+    /**
+     * @type {Cache}
+     */
+    this.cached = cache || new Cache();
+    this.client = client;
+  }
   async request (endpoint, options = {}) {
-    options.headers = {'API-Key': this.key, ...options.headers};
+    options.headers = {'API-Key': this.client.key, ...options.headers};
     const res = await fetch(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 parsedRes = await res.json().catch(() => {
@@ -18,22 +27,28 @@ module.exports = class Requests {
       throw new Error(Errors.SOMETHING_WENT_WRONG.replace(/{cause}/, res.cause));
     }
     parsedRes._headers = res.headers;
+    parsedRes.raw = !!options.raw;
     if (options.noCaching) return parsedRes;
     // split by question mark : first part is /path, remove /
-    if (this.options.cache && this.options.cacheFilter(endpoint.split('?')[0].slice(1))) {
-      if (this.options.cacheSize < cached.size) cached.delete(cached.keys().next().value); // Map and its special "iterators"
-      cached.set(endpoint, parsedRes);
-      if (this.options.cacheTime >= 0) setTimeout(() => cached.delete(endpoint), 1000 * this.options.cacheTime);
+    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]);
+      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);
     }
     return parsedRes;
   }
 
   get cache () {
-    return cached;
+    return this.cached;
   }
 
   async sweepCache (amount) {
-    if (!amount || amount >= cached.size) return cached.clear();
-    return Array.from(cached.keys()).slice(cached.size - amount).map((x) => cached.delete(x));
+    if (!amount || amount >= await this.cached.size()) return await this.cached.clear();
+    return await Promise.all(Array.from(await this.cached.keys()).slice(await this.cached.size() - amount).map((x) => this.cached.delete(x)));
+  }
+
+  validateCustomCache(cache) {
+    return !!(cache.set && cache.get && cache.delete && cache.keys);
   }
 };