hypixel-api-reborn 8.3.0 → 10.0.0

package/src/Private/updater.js

@@ -0,0 +1,45 @@
+/* eslint-disable no-console */
+/* eslint-disable require-jsdoc */
+const fetch = require('node-fetch');
+const Errors = require('../Errors');
+class Updater {
+  async checkForUpdates () {
+    const currentVersion = 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) {
+      this.notify(latestVersion);
+    }
+  }
+  notify (newVersion) {
+    console.log(`
+
+    New version of hypixel-api-reborn is available!
+    
+    v${newVersion}
+    Changelog: https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/releases/tag/${newVersion}
+
+    \x1b[33mnpm i hypixel-api-reborn@${newVersion}\x1b[0m
+    or
+    \x1b[33myarn add hypixel-api-reborn@${newVersion}\x1b[0m
+    
+    `);
+  }
+  compare (a, b) {
+    const pa = a.split('.');
+    const pb = b.split('.');
+    for (let i = 0; i < 3; i++) {
+      const na = Number(pa[i]);
+      const nb = Number(pb[i]);
+      if (na > nb) return 1;
+      if (nb > na) return -1;
+      if (!isNaN(na) && isNaN(nb)) return 1;
+      if (isNaN(na) && !isNaN(nb)) return -1;
+    }
+    return 0;
+  }
+}
+module.exports = Updater;

package/src/Private/validate.js

@@ -36,7 +36,9 @@ class Validation {
       rateLimit: options.rateLimit || 'AUTO',
       keyLimit: options.keyLimit || 120,
       syncWithHeaders: !!options.syncWithHeaders,
-      headers: options.headers || {}
+      headers: options.headers || {},
+      silent: !!options.silent,
+      checkForUpdates: options.checkForUpdates || false
     };
   }
 
@@ -60,7 +62,7 @@ class Validation {
    */
   cacheSuboptions (input) {
     if (typeof input !== 'object' || input === null) return false;
-    if (!input.noCacheCheck && !input.noCaching) return false;
+    if (!input.noCacheCheck && !input.noCaching && !input.raw) return false;
     return true;
   }
 
@@ -87,9 +89,9 @@ class Validation {
    * @returns {void}
    * @private
    */
-  validateNodeVersion() {
+  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 (nodeVersion < 12) throw new Error(Errors.NODE_VERSION_ERR);
   }
 }
 module.exports = Validation;

package/src/structures/Game.js

@@ -48,7 +48,7 @@ class Game {
    * @type {GameId[]}
    */
   static get IDS() {
-    return games.map((x)=>x.id);
+    return games.map((x) => x.id);
   }
 
   /**
@@ -56,7 +56,7 @@ class Game {
    * @type {GameCode[]}
    */
   static get CODES() {
-    return games.map((x)=>x.code);
+    return games.map((x) => x.code);
   }
 
   /**
@@ -64,7 +64,7 @@ class Game {
    * @type {GameString[]}
    */
   static get NAMES() {
-    return games.map((x)=>x.name);
+    return games.map((x) => x.name);
   }
 }
 /**

package/src/structures/Guild/Guild.js

@@ -9,8 +9,9 @@ const {getGuildLevel, parseHistory} = require('../../utils/guildExp');
 class Guild {
   /**
    * @param {data} data Guild data
+   * @param {string} [me] Player uuid used to search for this guild
    */
-  constructor (data) {
+  constructor (data, me = '') {
     /**
      * Guild ID
      * @type {string}
@@ -41,6 +42,11 @@ class Guild {
      * @type {Array<GuildMember>}
      */
     this.members = members(data);
+    /**
+     * Me, if a player UUID is used to get the guild
+     * @type {GuildMember|null}
+     */
+    this.me = this.members.find((member) => member.uuid === me);
     /**
      * Guild ranks
      * @type {Array<GuildRank>}

package/src/structures/MiniGames/Arcade.js

@@ -32,12 +32,12 @@ class Arcade {
      * Weekly coins
      * @type {number}
      */
-    this.weeklyCoins = parseInt(data[`weekly_coins_${weekAB()}`] || 0);
+    this.weeklyCoins = parseInt(data[`weekly_coins_${weekAB()}`] || 0, 10);
     /**
      * Monthly coins
      * @type {number}
      */
-    this.monthlyCoins = parseInt(data[`monthly_coins_${monthAB()}`] || 0);
+    this.monthlyCoins = parseInt(data[`monthly_coins_${monthAB()}`] || 0, 10);
     /**
      * Hints Disabled
      * @type {Boolean}
@@ -182,22 +182,22 @@ class BaseGame {
      * Wins
      * @type {?number}
      */
-    this.wins = parseInt(data['wins_' + gameName]) || 0;
+    this.wins = parseInt(data['wins_' + gameName], 10) || 0;
     /**
      * Kills, only available in combat games
      * @type {?number}
      */
-    this.kills = parseInt(data['kills_' + gameName]) || 0;
+    this.kills = parseInt(data['kills_' + gameName], 10) || 0;
     /**
      * Deaths, only available in combat games
      * @type {?number}
      */
-    this.deaths = parseInt(data['deaths_' + gameName]) || 0;
+    this.deaths = parseInt(data['deaths_' + gameName], 10) || 0;
     /**
      * Rounds Played, only available in Santa says, Simon Says, and HITW
      * @type {?number}
      */
-    this.roundsPlayed = parseInt(data['rounds_' + gameName]) || 0;
+    this.roundsPlayed = parseInt(data['rounds_' + gameName], 10) || 0;
   }
   /**
    * Extend BaseGame without creating a new class
@@ -244,12 +244,12 @@ class GalaxyWars {
      * Total weekly kills
      * @type {number}
      */
-    this.weeklyKills = parseInt(data[`weekly_kills_${weekAB()}`] || 0);
+    this.weeklyKills = parseInt(data[`weekly_kills_${weekAB()}`] || 0, 10);
     /**
      * Total Monthly kills
      * @type {number}
      */
-    this.monthlyKills = parseInt(data[`monthly_kills_${monthAB()}`] || 0);
+    this.monthlyKills = parseInt(data[`monthly_kills_${monthAB()}`] || 0, 10);
     /**
      * Attacker Kills
      * @type {number}

package/src/structures/MiniGames/BedWars.js

@@ -105,6 +105,19 @@ class BedWars {
       diamond: data.diamond_resources_collected_bedwars || 0,
       emerald: data.emerald_resources_collected_bedwars || 0
     };
+    /**
+     * Loot chests
+     * @type {BedWarsLootChests}
+     */
+    this.lootChests = {
+      christmas: data.bedwars_christmas_boxes || 0,
+      lunar: data.bedwars_lunar_boxes || 0,
+      normal: data.bedwars_boxes || 0,
+      easter: data.bedwars_easter_boxes || 0,
+      halloween: data.bedwars_halloween_boxes || 0,
+      golden: data.bedwars_golden_boxes || 0,
+      total: (data.bedwars_christmas_boxes + data.bedwars_lunar_boxes + data.bedwars_boxes + data.bedwars_easter_boxes + data.bedwars_halloween_boxes + data.bedwars_golden_boxes) || 0
+    };
     /**
      * Beds lost/broken/BL Ratio
      * @type {BedWarsBeds}
@@ -291,6 +304,15 @@ function getLevelForExp (exp) {
  * @property {number} diamond Diamond
  * @property {number} emerald Emerald
  */
+/**
+ * @typedef {object} BedWarsLootChests
+ * @property {number} christmas Christmas chests
+ * @property {number} halloween Halloween chests
+ * @property {number} easter Easter chests
+ * @property {number} christmas Christmas chests
+ * @property {number} golden Golden chests
+ * @property {number} normal Normal chests
+ */
 /**
  * @typedef {object} BedWarsBeds
  * @property {number} lost Beds lost