hypixel-api-reborn 10.0.0 → 11.0.0

package/src/Private/uuidCache.js

@@ -1,33 +1,37 @@
-/* eslint-disable require-jsdoc */
-const fetch = require('node-fetch');
-const cachedUuids = new Map();
-
-// 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);
-  const res = await fetch(url);
-  setTimeout(putCache, 0, res);
-  return await res.clone();
-};
+/* eslint-disable require-jsdoc */
+const requireFetch = !globalThis.fetch;
+const externalFetch = require('node-fetch');
+const fetch = requireFetch ? externalFetch : globalThis.fetch;
+const cachedUuids = new Map();
+
+// 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);
+  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;
+};

package/src/Private/validate.js

@@ -1,97 +1,97 @@
-/* eslint-disable require-jsdoc */
-const Errors = require('../Errors');
-const { isStrArray, strToArray } = require('../utils/arrayTools');
-/**
- * Validation Class, used internally to validate provided arguments
- */
-class Validation {
-  /**
-   * Check if cache options are valid
-   * @param {Object} options Global Cache Options to be validated
-   * @returns {void} Void
-   * @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);
-  }
-
-  /**
-   * Parses cache options
-   * @param {Object} options Options to be parsed
-   * @returns {Object} Parsed cache options
-   * @private
-   */
-  parseOptions (options) {
-    if (typeof options !== 'object' || options === null) 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 || false
-    };
-  }
-
-  /**
-   * Checks if Key is provided in a correct format
-   * @param {string} key API Key
-   * @returns {string} Key
-   * @private
-   */
-  validateKey (key) {
-    if (!key) throw new Error(Errors.NO_API_KEY);
-    if (typeof key !== 'string') throw new Error(Errors.KEY_MUST_BE_A_STRING);
-    return key;
-  }
-
-  /**
-   * Check if suboptions are valid
-   * @param {Object} input Cache options
-   * @returns {boolean} Whether options are valid
-   * @private
-   */
-  cacheSuboptions (input) {
-    if (typeof input !== 'object' || input === null) return false;
-    if (!input.noCacheCheck && !input.noCaching && !input.raw) return false;
-    return true;
-  }
-
-  /**
-   * Handles & parses the filter
-   * @param {*} filter FilterResolvable to be parsed
-   * @returns {Function} Filter function
-   * @private
-   */
-  _handleFilter (filter) {
-    if (!filter) return () => true;
-    if (typeof filter === 'object' && !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);
-    }
-    if (!isStrArray(filter)) throw new Error(Errors.CACHE_FILTER_INVALID);
-    // blacklist by default
-    return (x) => !strToArray(filter).includes(x);
-  }
-  /**
-   * Checks user's node version
-   * -12 will return an error; -14 will result in a warning
-   * @returns {void}
-   * @private
-   */
-  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);
-  }
-}
-module.exports = Validation;
+/* eslint-disable require-jsdoc */
+const Errors = require('../Errors');
+const { isStrArray, strToArray } = require('../utils/arrayTools');
+/**
+ * Validation Class, used internally to validate provided arguments
+ */
+class Validation {
+  /**
+   * Check if cache options are valid
+   * @param {Object} options Global Cache Options to be validated
+   * @returns {void} Void
+   * @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);
+  }
+
+  /**
+   * Parses cache options
+   * @param {Object} options Options to be parsed
+   * @returns {Object} Parsed cache options
+   * @private
+   */
+  parseOptions(options) {
+    if (typeof options !== 'object' || options === null) 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 || false
+    };
+  }
+
+  /**
+   * Checks if Key is provided in a correct format
+   * @param {string} key API Key
+   * @returns {string} Key
+   * @private
+   */
+  validateKey(key) {
+    if (!key) throw new Error(Errors.NO_API_KEY);
+    if (typeof key !== 'string') throw new Error(Errors.KEY_MUST_BE_A_STRING);
+    return key;
+  }
+
+  /**
+   * Check if suboptions are valid
+   * @param {Object} input Cache options
+   * @returns {boolean} Whether options are valid
+   * @private
+   */
+  cacheSuboptions(input) {
+    if (typeof input !== 'object' || input === null) return false;
+    if (!input.noCacheCheck && !input.noCaching && !input.raw) return false;
+    return true;
+  }
+
+  /**
+   * Handles & parses the filter
+   * @param {*} filter FilterResolvable to be parsed
+   * @returns {Function} Filter function
+   * @private
+   */
+  _handleFilter(filter) {
+    if (!filter) return () => true;
+    if (typeof filter === 'object' && !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);
+    }
+    if (!isStrArray(filter)) throw new Error(Errors.CACHE_FILTER_INVALID);
+    // blacklist by default
+    return (x) => !strToArray(filter).includes(x);
+  }
+  /**
+   * Checks user's node version
+   * -12 will return an error; -14 will result in a warning
+   * @returns {void}
+   * @private
+   */
+  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);
+  }
+}
+module.exports = Validation;

package/src/index.js

@@ -1,83 +1,82 @@
-module.exports = {
-  Client: require('./Client.js'),
-  version: require('../package.json').version,
-
-  /* API Status */
-  APIStatus: require('./structures/APIStatus.js'),
-  APIIncident: require('./structures/APIIncident.js'),
-
-  Player: require('./structures/Player.js'),
-  Game: require('./structures/Game.js'),
-  Friend: require('./structures/Friend.js'),
-  Status: require('./structures/Status.js'),
-  Color: require('./structures/Color.js'),
-  KeyInfo: require('./structures/KeyInfo.js'),
-  Pet: require('./structures/Pet'),
-  Pets: require('./structures/Pets'),
-  PlayerCosmetics: require('./structures/PlayerCosmetics'),
-
-  /* Watchdog */
-  WatchdogStats: require('./structures/Watchdog/Stats.js'),
-
-  /* Guild */
-  Guild: require('./structures/Guild/Guild.js'),
-  GuildMember: require('./structures/Guild/GuildMember.js'),
-  GuildRank: require('./structures/Guild/GuildRank.js'),
-
-  /* SkyBlock */
-  SkyblockProfile: require('./structures/SkyBlock/SkyblockProfile.js'),
-  SkyblockMember: require('./structures/SkyBlock/SkyblockMember.js'),
-  SkyblockInventoryItem: require('./structures/SkyBlock/SkyblockInventoryItem.js'),
-  SkyblockPet: require('./structures/SkyBlock/SkyblockPet'),
-
-  /* Skyblock Auctions */
-  BaseAuction: require('./structures/SkyBlock/Auctions/BaseAuction.js'),
-  PartialAuction: require('./structures/SkyBlock/Auctions/PartialAuction.js'),
-  Auction: require('./structures/SkyBlock/Auctions/Auction.js'),
-  AuctionInfo: require('./structures/SkyBlock/Auctions/AuctionInfo.js'),
-  Bid: require('./structures/SkyBlock/Auctions/Bid.js'),
-
-  /* Skyblock Bazaar */
-  Product: require('./structures/SkyBlock/Bazzar/Product.js'),
-  Order: require('./structures/SkyBlock/Bazzar/Order.js'),
-
-  /** Skyblock News */
-  SkyblockNews: require('./structures/SkyBlock/News/SkyblockNews'),
-
-  /* Booster */
-  Booster: require('./structures/Boosters/Booster.js'),
-
-  /* MiniGames */
-  Arcade: require('./structures/MiniGames/Arcade.js'),
-  ArenaBrawl: require('./structures/MiniGames/ArenaBrawl.js'),
-  BedWars: require('./structures/MiniGames/BedWars.js'),
-  BlitzSurvivalGames: require('./structures/MiniGames/BlitzSurvivalGames.js'),
-  BuildBattle: require('./structures/MiniGames/BuildBattle.js'),
-  CopsAndCrims: require('./structures/MiniGames/CopsAndCrims.js'),
-  Duels: require('./structures/MiniGames/Duels.js'),
-  MegaWalls: require('./structures/MiniGames/MegaWalls.js'),
-  MurderMystery: require('./structures/MiniGames/MurderMystery.js'),
-  Paintball: require('./structures/MiniGames/Paintball.js'),
-  Quakecraft: require('./structures/MiniGames/Quakecraft.js'),
-  SkyWars: require('./structures/MiniGames/SkyWars.js'),
-  SmashHeroes: require('./structures/MiniGames/SmashHeroes.js'),
-  SpeedUHC: require('./structures/MiniGames/SpeedUHC.js'),
-  TNTGames: require('./structures/MiniGames/TNTGames.js'),
-  TurboKartRacers: require('./structures/MiniGames/TurboKartRacers.js'),
-  UHC: require('./structures/MiniGames/UHC.js'),
-  VampireZ: require('./structures/MiniGames/VampireZ.js'),
-  Walls: require('./structures/MiniGames/Walls.js'),
-  Warlords: require('./structures/MiniGames/Warlords.js'),
-
-  /* Leaderboards */
-  Leaderboard: require('./structures/Leaderboard.js'),
-
-  /** Server Info */
-  ServerInfo: require('./structures/ServerInfo'),
-
-  /* Errors */
-  Errors: require('./Errors.js'),
-
-  /* Utils */
-  Utils: require('./utils')
-};
+module.exports = {
+  Client: require('./Client.js'),
+  version: require('../package.json').version,
+
+  /* API Status */
+  APIStatus: require('./structures/APIStatus.js'),
+  APIIncident: require('./structures/APIIncident.js'),
+
+  Player: require('./structures/Player.js'),
+  Game: require('./structures/Game.js'),
+  Status: require('./structures/Status.js'),
+  Color: require('./structures/Color.js'),
+  Pet: require('./structures/Pet'),
+  Pets: require('./structures/Pets'),
+  PlayerCosmetics: require('./structures/PlayerCosmetics'),
+
+  /* Watchdog */
+  WatchdogStats: require('./structures/Watchdog/Stats.js'),
+
+  /* Guild */
+  Guild: require('./structures/Guild/Guild.js'),
+  GuildMember: require('./structures/Guild/GuildMember.js'),
+  GuildRank: require('./structures/Guild/GuildRank.js'),
+
+  /* SkyBlock */
+  SkyblockProfile: require('./structures/SkyBlock/SkyblockProfile.js'),
+  SkyblockMember: require('./structures/SkyBlock/SkyblockMember.js'),
+  SkyblockInventoryItem: require('./structures/SkyBlock/SkyblockInventoryItem.js'),
+  SkyblockPet: require('./structures/SkyBlock/SkyblockPet'),
+
+  /* Skyblock Auctions */
+  BaseAuction: require('./structures/SkyBlock/Auctions/BaseAuction.js'),
+  PartialAuction: require('./structures/SkyBlock/Auctions/PartialAuction.js'),
+  Auction: require('./structures/SkyBlock/Auctions/Auction.js'),
+  AuctionInfo: require('./structures/SkyBlock/Auctions/AuctionInfo.js'),
+  Bid: require('./structures/SkyBlock/Auctions/Bid.js'),
+
+  /* Skyblock Bazaar */
+  Product: require('./structures/SkyBlock/Bazzar/Product.js'),
+  Order: require('./structures/SkyBlock/Bazzar/Order.js'),
+
+  /* Skyblock News */
+  SkyblockNews: require('./structures/SkyBlock/News/SkyblockNews'),
+
+  /* Booster */
+  Booster: require('./structures/Boosters/Booster.js'),
+
+  /* MiniGames */
+  Arcade: require('./structures/MiniGames/Arcade.js'),
+  ArenaBrawl: require('./structures/MiniGames/ArenaBrawl.js'),
+  BedWars: require('./structures/MiniGames/BedWars.js'),
+  BlitzSurvivalGames: require('./structures/MiniGames/BlitzSurvivalGames.js'),
+  BuildBattle: require('./structures/MiniGames/BuildBattle.js'),
+  CopsAndCrims: require('./structures/MiniGames/CopsAndCrims.js'),
+  Duels: require('./structures/MiniGames/Duels.js'),
+  MegaWalls: require('./structures/MiniGames/MegaWalls.js'),
+  MurderMystery: require('./structures/MiniGames/MurderMystery.js'),
+  Paintball: require('./structures/MiniGames/Paintball.js'),
+  Quakecraft: require('./structures/MiniGames/Quakecraft.js'),
+  SkyWars: require('./structures/MiniGames/SkyWars.js'),
+  SmashHeroes: require('./structures/MiniGames/SmashHeroes.js'),
+  SpeedUHC: require('./structures/MiniGames/SpeedUHC.js'),
+  TNTGames: require('./structures/MiniGames/TNTGames.js'),
+  TurboKartRacers: require('./structures/MiniGames/TurboKartRacers.js'),
+  UHC: require('./structures/MiniGames/UHC.js'),
+  VampireZ: require('./structures/MiniGames/VampireZ.js'),
+  Walls: require('./structures/MiniGames/Walls.js'),
+  Warlords: require('./structures/MiniGames/Warlords.js'),
+  WoolWars: require('./structures/MiniGames/WoolWars.js'),
+
+  /* Leaderboards */
+  Leaderboard: require('./structures/Leaderboard.js'),
+
+  /* Server Info */
+  ServerInfo: require('./structures/ServerInfo.js'),
+
+  /* Errors */
+  Errors: require('./Errors.js'),
+
+  /* Utils */
+  Utils: require('./utils')
+};

package/src/structures/APIIncident.js

@@ -1,78 +1,78 @@
-const regex = /https:\/\/status.hypixel.net\/incidents\/([a-z0-9]+)/;
-/**
- * API incident class
- */
-class APIIncident {
-  /**
-   * @param {object} data API incident data
-   */
-  constructor (data) {
-    /**
-     * Link to incident
-     * @type {string|null}
-     */
-    this.link = data.link || null;
-    /**
-     * Timestamp when investigation was started as Date object
-     * @type {object|null}
-     */
-    this.start = new Date(data.pubDate) || null;
-    /**
-     * Formatted timestamp when investigation was started
-     * @type {string|null}
-     */
-    this.startFormatted = data.pubDate || null;
-    /**
-     * Timestamp when investigation was started as Date
-     * @type {Date|null}
-     */
-    this.startTimestamp = new Date(data.pubDate).getTime() || null;
-    /**
-     * Incident author
-     * @type {string|null}
-     */
-    this.author = data.creator || null;
-    /**
-     * Content as HTML
-     * @type {string|null}
-     */
-    this.HTMLContent = data.content || null;
-    /**
-     * Content snippet
-     * @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}
-     */
-    this.guid = data.guid ? regex.exec(data.guid)[1] : null;
-    /**
-     * Incident categories
-     * @type {string[]}
-     */
-    this.categories = data.categories || [];
-    /**
-     * 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 -');
-  }
-  /**
-   * Text Content
-   * @return {string}
-   */
-  toString() {
-    return this.TextContent;
-  }
-}
-
-module.exports = APIIncident;
+const regex = /https:\/\/status.hypixel.net\/incidents\/([a-z0-9]+)/;
+/**
+ * API incident class
+ */
+class APIIncident {
+  /**
+   * @param {object} data API incident data
+   */
+  constructor(data) {
+    /**
+     * Link to incident
+     * @type {string|null}
+     */
+    this.link = data.link || null;
+    /**
+     * Timestamp when investigation was started as Date object
+     * @type {object|null}
+     */
+    this.start = new Date(data.pubDate) || null;
+    /**
+     * Formatted timestamp when investigation was started
+     * @type {string|null}
+     */
+    this.startFormatted = data.pubDate || null;
+    /**
+     * Timestamp when investigation was started as Date
+     * @type {Date|null}
+     */
+    this.startTimestamp = new Date(data.pubDate).getTime() || null;
+    /**
+     * Incident author
+     * @type {string|null}
+     */
+    this.author = data.creator || null;
+    /**
+     * Content as HTML
+     * @type {string|null}
+     */
+    this.HTMLContent = data.content || null;
+    /**
+     * Content snippet
+     * @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}
+     */
+    this.guid = data.guid ? regex.exec(data.guid)[1] : null;
+    /**
+     * Incident categories
+     * @type {string[]}
+     */
+    this.categories = data.categories || [];
+    /**
+     * 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 -');
+  }
+  /**
+   * Text Content
+   * @return {string}
+   */
+  toString() {
+    return this.TextContent;
+  }
+}
+
+module.exports = APIIncident;