hypixel-api-reborn 11.1.0 → 11.2.1

package/src/Private/updater.js

@@ -1,23 +1,26 @@
-/* eslint-disable require-jsdoc */
 /* eslint-disable no-console */
-const fetch = require('node-fetch');
+const requireFetch = !globalThis.fetch;
+const externalFetch = (...args) => import('node-fetch').then(({ default: fetch }) => fetch(...args));
+const fetch = requireFetch ? externalFetch : globalThis.fetch;
 const Errors = require('../Errors');
 class Updater {
   async checkForUpdates() {
-    const currentVersion = require('../../package.json').version;
+    const version = require('../../package.json').version;
     const request = await fetch('https://registry.npmjs.org/hypixel-api-reborn');
     if (!request.ok) return console.log(Errors.UPDATER_REQUEST_NOT_OK);
     const metadata = await request.json();
-    const latestVersion = metadata['dist-tags'].latest;
-    const compare = this.compare(currentVersion, latestVersion);
-    if (compare === -1) {
-      console.log(`New version of hypixel-api-reborn is available! Current version: ${currentVersion}, Latest version: ${latestVersion}`);
+    const latest = metadata['dist-tags'].latest;
+    const compare = this.compare(version, latest);
+    if (-1 === compare) {
+      console.log(
+        `New version of hypixel-api-reborn is available! Current version: ${version}, Latest version: ${latest}`
+      );
     }
   }
   compare(a, b) {
     const pa = a.split('.');
     const pb = b.split('.');
-    for (let i = 0; i < 3; i++) {
+    for (let i = 0; 3 > i; i++) {
       const na = Number(pa[i]);
       const nb = Number(pb[i]);
       if (na > nb) return 1;

package/src/Private/uuidCache.js

@@ -1,37 +1,30 @@
-/* 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 cachedUuids = new Map();
+const NodeCache = require('node-cache');
+const cache = new NodeCache();
 
 // TODO - use this for all cache models
 
-async function putCache(response) {
-  try {
-    response = await response.json();
-    cachedUuids.set(response.id, response.name);
-    setTimeout(deleteCache, 1000 * 60 * 10, response.id);
-  } catch (e) {
-    // F
-  }
-}
-function deleteCache(id) {
-  return cachedUuids.delete(id);
-}
-function response(obj) {
-  return new fetch.Response(JSON.stringify(obj));
-}
-function checkHit(query) {
-  if (cachedUuids.has(query)) return response({ id: query, name: cachedUuids.get(query) });
-  const reverseSearch = Array.from(cachedUuids.entries()).find((pair) => pair[1].toLowerCase() === query.toLowerCase());
-  if (reverseSearch) return response({ id: reverseSearch[0], name: query });
-  return null;
-}
-module.exports = async (url, query) => {
-  if (checkHit(query || url)) return checkHit(query || url);
+module.exports = async (url, query, cacheTime) => {
+  if (cache.has(query.toLowerCase())) return cache.get(query.toLowerCase());
   const res = await fetch(url);
-  const response = await res.clone().json();
-  // Don't cache 5xx
-  if (response.error !== 'Internal Server Error' && response.status < 500) setTimeout(putCache, 0, res.clone());
-  return res;
+  const data = await res.json();
+  // Don't cache 4xx
+  if (400 <= res.status) {
+    return {
+      status: res.status,
+      id: null,
+      name: null
+    };
+  }
+
+  cache.set(query.toLowerCase(), { status: res.status, id: data.id, name: data.name }, cacheTime);
+  cache.set(data.id.toLowerCase(), { status: res.status, id: data.id, name: data.name }, cacheTime);
+
+  return {
+    status: res.status,
+    id: data.id,
+    name: data.name
+  };
 };

package/src/Private/validate.js

@@ -1,4 +1,3 @@
-/* eslint-disable require-jsdoc */
 const Errors = require('../Errors');
 const { isStrArray, strToArray } = require('../utils/arrayTools');
 /**
@@ -12,12 +11,20 @@ class Validation {
    * @private
    */
   validateOptions(options) {
-    if (typeof options.cacheTime !== 'number') throw new Error(Errors.CACHE_TIME_MUST_BE_A_NUMBER);
-    if (typeof options.cacheSize !== 'number') throw new Error(Errors.CACHE_LIMIT_MUST_BE_A_NUMBER);
-    if (typeof options.rateLimit !== 'string' || !['AUTO', 'HARD', 'NONE'].includes(options.rateLimit)) throw new Error(Errors.INVALID_RATE_LIMIT_OPTION);
-    if (typeof options.keyLimit !== 'number') throw new Error(Errors.INVALID_KEY_LIMIT_OPTION);
-    if (typeof options.syncWithHeaders !== 'boolean') throw new Error(Errors.INVALID_HEADER_SYNC_OPTION);
-    if (typeof options.headers !== 'object') throw new Error(Errors.INVALID_HEADERS);
+    if ('number' !== typeof options.hypixelCacheTime) throw new Error(Errors.CACHE_TIME_MUST_BE_A_NUMBER);
+    if ('number' !== typeof options.mojangCacheTime) throw new Error(Errors.CACHE_TIME_MUST_BE_A_NUMBER);
+    if ('number' !== typeof options.cacheSize) throw new Error(Errors.CACHE_LIMIT_MUST_BE_A_NUMBER);
+    if ('string' !== typeof options.rateLimit || !['AUTO', 'HARD', 'NONE'].includes(options.rateLimit)) {
+      throw new Error(Errors.INVALID_RATE_LIMIT_OPTION);
+    }
+    if ('number' !== typeof options.keyLimit) throw new Error(Errors.INVALID_KEY_LIMIT_OPTION);
+    if ('boolean' !== typeof options.syncWithHeaders) throw new Error(Errors.INVALID_HEADER_SYNC_OPTION);
+    if ('object' !== typeof options.headers) throw new Error(Errors.INVALID_HEADERS);
+    if ('boolean' !== typeof options.silent) throw new Error(Errors.INVALID_SILENT_OPTION);
+    if ('boolean' !== typeof options.checkForUpdates) throw new Error(Errors.INVALID_UPDATE_OPTION);
+    if (!['boolean', 'string'].includes(typeof options.useThirdPartyAPI)) {
+      throw new Error(Errors.INVALID_THIRD_PARTY_API_OPTION);
+    }
   }
 
   /**
@@ -27,18 +34,22 @@ class Validation {
    * @private
    */
   parseOptions(options) {
-    if (typeof options !== 'object' || options === null) throw new Error(Errors.OPTIONS_MUST_BE_AN_OBJECT);
+    if ('object' !== typeof options || null === options) throw new Error(Errors.OPTIONS_MUST_BE_AN_OBJECT);
     return {
-      cache: options.cache || false,
-      cacheTime: options.cacheTime || 60,
-      cacheSize: (options.cacheSize === -1 ? Infinity : options.cacheSize) || Infinity,
-      cacheFilter: typeof options.cacheFilter === 'function' ? options.cacheFilter : this._handleFilter(options.cacheFilter),
-      rateLimit: options.rateLimit || 'AUTO',
-      keyLimit: options.keyLimit || 120,
-      syncWithHeaders: !!options.syncWithHeaders,
-      headers: options.headers || {},
-      silent: !!options.silent,
-      checkForUpdates: options.checkForUpdates || true
+      cache: options.cache ?? true,
+      hypixelCacheTime: options.hypixelCacheTime ?? 60,
+      mojangCacheTime: options.mojangCacheTime ?? 600,
+      cacheSize: (-1 === options.cacheSize ? Infinity : options.cacheSize) || Infinity,
+      cacheFilter:
+        // eslint-disable-next-line no-underscore-dangle
+        'function' === typeof options.cacheFilter ? options.cacheFilter : this._handleFilter(options.cacheFilter),
+      rateLimit: options.rateLimit ?? 'AUTO',
+      keyLimit: options.keyLimit ?? 60,
+      syncWithHeaders: Boolean(options.syncWithHeaders),
+      headers: options.headers ?? {},
+      silent: Boolean(options.silent),
+      checkForUpdates: options.checkForUpdates ?? true,
+      useThirdPartyAPI: options.useThirdPartyAPI ?? false
     };
   }
 
@@ -50,7 +61,7 @@ class Validation {
    */
   validateKey(key) {
     if (!key) throw new Error(Errors.NO_API_KEY);
-    if (typeof key !== 'string') throw new Error(Errors.KEY_MUST_BE_A_STRING);
+    if ('string' !== typeof key) throw new Error(Errors.KEY_MUST_BE_A_STRING);
     return key;
   }
 
@@ -61,7 +72,7 @@ class Validation {
    * @private
    */
   cacheSuboptions(input) {
-    if (typeof input !== 'object' || input === null) return false;
+    if ('object' !== typeof input || null === input) return false;
     if (!input.noCacheCheck && !input.noCaching && !input.raw) return false;
     return true;
   }
@@ -74,7 +85,7 @@ class Validation {
    */
   _handleFilter(filter) {
     if (!filter) return () => true;
-    if (typeof filter === 'object' && !Array.isArray(filter)) {
+    if ('object' === typeof filter && !Array.isArray(filter)) {
       if (filter.whitelist && isStrArray(filter.whitelist)) return (x) => strToArray(filter.whitelist).includes(x);
       if (filter.blacklist && isStrArray(filter.blacklist)) return (x) => !strToArray(filter.blacklist).includes(x);
       throw new Error(Errors.CACHE_FILTER_INVALID);
@@ -91,7 +102,7 @@ class Validation {
    */
   validateNodeVersion() {
     const nodeVersion = parseInt(process.version.match(/v(\d{2})\.\d{1,}\.\d+/)[1], 10);
-    if (nodeVersion < 12) throw new Error(Errors.NODE_VERSION_ERR);
+    if (12 > nodeVersion) throw new Error(Errors.NODE_VERSION_ERR);
   }
 }
 module.exports = Validation;

package/src/index.js

@@ -14,6 +14,10 @@ module.exports = {
   Pets: require('./structures/Pets'),
   PlayerCosmetics: require('./structures/PlayerCosmetics'),
 
+  /* Challenges */
+  Challenges: require('./structures/Static/Challenges.js'),
+  GameChallenges: require('./structures/Static/GameChallenges.js'),
+
   /* Watchdog */
   WatchdogStats: require('./structures/Watchdog/Stats.js'),
 
@@ -27,6 +31,10 @@ module.exports = {
   SkyblockMember: require('./structures/SkyBlock/SkyblockMember.js'),
   SkyblockInventoryItem: require('./structures/SkyBlock/SkyblockInventoryItem.js'),
   SkyblockPet: require('./structures/SkyBlock/SkyblockPet'),
+  GovernmentData: require('./structures/SkyBlock/Static/Government.js'),
+  Candidate: require('./structures/SkyBlock/Static/Candidate.js'),
+  BingoData: require('./structures/SkyBlock/Static/BingoData.js'),
+  Bingo: require('./structures/SkyBlock/Static/Bingo.js'),
 
   /* Skyblock Auctions */
   BaseAuction: require('./structures/SkyBlock/Auctions/BaseAuction.js'),
@@ -34,6 +42,7 @@ module.exports = {
   Auction: require('./structures/SkyBlock/Auctions/Auction.js'),
   AuctionInfo: require('./structures/SkyBlock/Auctions/AuctionInfo.js'),
   Bid: require('./structures/SkyBlock/Auctions/Bid.js'),
+  FireSale: require('./structures/SkyBlock/Static/FireSale.js'),
 
   /* Skyblock Bazaar */
   Product: require('./structures/SkyBlock/Bazzar/Product.js'),

package/src/structures/APIIncident.js

@@ -16,7 +16,7 @@ class APIIncident {
      * Timestamp when investigation was started as Date object
      * @type {object|null}
      */
-    this.start = new Date(data.pubDate) || null;
+    this.start = data.pubDate ? new Date(data.pubDate) : null;
     /**
      * Formatted timestamp when investigation was started
      * @type {string|null}
@@ -42,12 +42,6 @@ class APIIncident {
      * @type {string|null}
      */
     this.snippet = data.contentSnippet || null;
-    /**
-     * Content as plain text
-     * The parsing might be faulty!
-     * @type {string|null}
-     */
-    this.TextContent = (data.content || '').replace(/<[^>]+>/g, '') || null;
     /**
      * GUID
      * @type {string|null}
@@ -62,16 +56,15 @@ class APIIncident {
      * Whether the incident is resolved/completed or not
      * @author linearaccelerator
      * @type {boolean}
-     * @version >6.0.1
      */
-    this.isResolved = this.TextContent.includes('Resolved -') || this.TextContent.includes('Completed -');
+    this.isResolved = this.HTMLContent.includes('Resolved -') || this.HTMLContent.includes('Completed -');
   }
   /**
-   * Text Content
+   * HTML Content
    * @return {string}
    */
   toString() {
-    return this.TextContent;
+    return this.HTMLContent;
   }
 }
 

package/src/structures/APIStatus.js

@@ -31,7 +31,6 @@ class APIStatus {
      * All incidents that aren't completed/resolved
      * @author linearaccelerator
      * @type {APIIncident[]}
-     * @version >6.0.1
      */
     this.currentIncidents = this.incidents.filter((i) => !i.isResolved);
   }

package/src/structures/Boosters/Booster.js

@@ -1,4 +1,12 @@
 const Game = require('../Game');
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+function parseType(data) {
+  if (true === data.stacked) return 'STACKED';
+  if (!data.stacked) return 'QUEUED';
+  return 'ACTIVE';
+}
+
 /**
  * Booster class
  */
@@ -9,27 +17,27 @@ class Booster {
   constructor(data) {
     /**
      * Booster's purchaser's UUID
-     * @type {String}
+     * @type {string}
      */
     this.purchaser = data.purchaserUuid;
     /**
      * Booster's multiplier
-     * @type {Number}
+     * @type {number}
      */
     this.amount = data.amount;
     /**
      * Booster's length in seconds
-     * @type {Number}
+     * @type {number}
      */
     this.originalLength = data.originalLength;
     /**
      * Length remaining in seconds
-     * @type {Number}
+     * @type {number}
      */
     this.remaining = data.length;
     /**
      * Date activated timestamp
-     * @type {Number}
+     * @type {number}
      */
     this.activatedTimestamp = data.dateActivated;
     /**
@@ -63,7 +71,7 @@ class Booster {
      * Works by checking if date.length is negative
      * @type {boolean}
      */
-    this.expired = data.length < 0;
+    this.expired = 0 > data.length;
   }
   /**
    * Beautiful format
@@ -73,11 +81,4 @@ class Booster {
     return `${this.purchaser}'s booster in ${this.game}`;
   }
 }
-
-// eslint-disable-next-line require-jsdoc
-function parseType(data) {
-  if (data.stacked === true) return 'STACKED';
-  if (!data.stacked) return 'QUEUED';
-  return 'ACTIVE';
-}
 module.exports = Booster;

package/src/structures/Color.js

@@ -68,62 +68,107 @@ class Color {
   toCode() {
     return this.color;
   }
+
+  /**
+   * Returns color code
+   * @return {InGameCode}
+   */
+  toInGameCode() {
+    const InGameCodes = {
+      BLACK: '§0',
+      DARK_BLUE: '§1',
+      DARK_GREEN: '§2',
+      DARK_AQUA: '§3',
+      DARK_RED: '§4',
+      DARK_PURPLE: '§5',
+      GOLD: '§6',
+      GRAY: '§7',
+      DARK_GRAY: '§8',
+      BLUE: '§9',
+      GREEN: '§a',
+      AQUA: '§b',
+      RED: '§c',
+      LIGHT_PURPLE: '§d',
+      YELLOW: '§e',
+      WHITE: '§f'
+    };
+    return InGameCodes[this.color];
+  }
 }
 /**
  * @typedef {string} ColorCode
- * * `BLACK`
- * * `DARK_BLUE`
- * * `DARK_GREEN`
- * * `DARK_AQUA`
- * * `DARK_RED`
- * * `DARK_PURPLE`
- * * `GOLD`
- * * `GRAY`
- * * `DARK_GRAY`
- * * `BLUE`
- * * `GREEN`
- * * `AQUA`
- * * `RED`
- * * `LIGHT_PURPLE`
- * * `YELLOW`
- * * `WHITE`
+ * * 'BLACK'
+ * * 'DARK_BLUE'
+ * * 'DARK_GREEN'
+ * * 'DARK_AQUA'
+ * * 'DARK_RED'
+ * * 'DARK_PURPLE'
+ * * 'GOLD'
+ * * 'GRAY'
+ * * 'DARK_GRAY'
+ * * 'BLUE'
+ * * 'GREEN'
+ * * 'AQUA'
+ * * 'RED'
+ * * 'LIGHT_PURPLE'
+ * * 'YELLOW'
+ * * 'WHITE'
  */
 /**
  * @typedef {string} ColorString
- * * BLACK: `Black`
- * * DARK_BLUE: `Dark Blue`
- * * DARK_GREEN: `Dark Green`
- * * DARK_AQUA: `Dark Aqua`
- * * DARK_RED: `Dark Red`
- * * DARK_PURPLE: `Dark Purple`
- * * GOLD: `Gold`
- * * GRAY: `Gray`
- * * DARK_GRAY: `Dark Gray`
- * * BLUE: `Blue`,
- * * GREEN: `Green`
- * * AQUA: `Aqua`
- * * RED: `Red`
- * * LIGHT_PURPLE: `Light Purple`
- * * YELLOW: `Yellow`
- * * WHITE: `White`
+ * * BLACK: 'Black'
+ * * DARK_BLUE: 'Dark Blue'
+ * * DARK_GREEN: 'Dark Green'
+ * * DARK_AQUA: 'Dark Aqua'
+ * * DARK_RED: 'Dark Red'
+ * * DARK_PURPLE: 'Dark Purple'
+ * * GOLD: 'Gold'
+ * * GRAY: 'Gray'
+ * * DARK_GRAY: 'Dark Gray'
+ * * BLUE: 'Blue`'
+ * * GREEN: 'Green'
+ * * AQUA: 'Aqua'
+ * * RED: 'Red'
+ * * LIGHT_PURPLE: 'Light Purple'
+ * * YELLOW: 'Yellow'
+ * * WHITE: 'White'
  */
 /**
  * @typedef {string} ColorHex
- * * BLACK: `#000000`
- * * DARK_BLUE: `#0000AA`
- * * DARK_GREEN: `#008000`
- * * DARK_AQUA: `#00AAAA`
- * * DARK_RED: `#AA0000`
- * * DARK_PURPLE: `#AA00AA`
- * * GOLD: `#FFAA00`
- * * GRAY: `#AAAAAA`
- * * DARK_GRAY: `#555555`
- * * BLUE: `#5555FF`
- * * GREEN: `#3CE63C`
- * * AQUA: `#3CE6E6`
- * * RED: `#FF5555`
- * * LIGHT_PURPLE: `#FF55FF`
- * * YELLOW: `#FFFF55`
- * * WHITE: `#FFFFFF`
+ * * BLACK: '#000000'
+ * * DARK_BLUE: '#0000AA'
+ * * DARK_GREEN: '#008000'
+ * * DARK_AQUA: '#00AAAA'
+ * * DARK_RED: '#AA0000'
+ * * DARK_PURPLE: '#AA00AA'
+ * * GOLD: '#FFAA00'
+ * * GRAY: '#AAAAAA'
+ * * DARK_GRAY: '#555555'
+ * * BLUE: '#5555FF'
+ * * GREEN: '#3CE63C'
+ * * AQUA: '#3CE6E6'
+ * * RED: '#FF5555'
+ * * LIGHT_PURPLE: '#FF55FF'
+ * * YELLOW: '#FFFF55'
+ * * WHITE: '#FFFFFF'
+ */
+/**
+ * @typedef {string} InGameCode
+ * * BLACK: '§0'
+ * * DARK_BLUE: '§1'
+ * * DARK_GREEN: '§2'
+ * * DARK_AQUA: '§3'
+ * * DARK_RED: '§4'
+ * * DARK_PURPLE: '§5'
+ * * GOLD: '§6'
+ * * GRAY: '§7'
+ * * DARK_GRAY: '§8'
+ * * BLUE: '§9'
+ * * GREEN: '§a'
+ * * AQUA: '§b'
+ * * RED: '§c'
+ * * LIGHT_PURPLE: '§d'
+ * * YELLOW: '§e'
+ * * WHITE: '§f'
  */
 module.exports = Color;

package/src/structures/Game.js

@@ -12,7 +12,9 @@ class Game {
      * @type {GameId|GameCode}
      */
     this.game = game.toString().toLowerCase();
-    const result = games.find((g) => g.code.toLowerCase() === this.game || g.id.toString() === this.game || g.name.toLowerCase() === this.game);
+    const result = games.find(
+      (g) => g.code.toLowerCase() === this.game || g.id.toString() === this.game || g.name.toLowerCase() === this.game
+    );
     /**
      * ID of game
      * @type {GameId}
@@ -32,7 +34,7 @@ class Game {
      * Whether the game is found
      * @type {boolean}
      */
-    this.found = !!result;
+    this.found = Boolean(result);
   }
 
   /**