hypixel-api-reborn 11.2.1 → 11.3.0

package/src/structures/MiniGames/UHC.js

@@ -1,23 +1,7 @@
 const divide = require('../../utils/divide');
 
 // eslint-disable-next-line jsdoc/require-jsdoc
-function getStarLevel(data) {
-  const kills =
-    (data.kills || 0) +
-    (data.kills_solo || 0) +
-    (data['kills_red vs blue'] || 0) +
-    (data['kills_no diamonds'] || 0) +
-    (data.kills_brawl || 0) +
-    (data['kills_solo brawl'] || 0) +
-    (data['kills_duo brawl'] || 0);
-  const wins =
-    (data.wins || 0) +
-    (data.wins_solo || 0) +
-    (data['wins_red vs blue'] || 0) +
-    (data['wins_no diamonds'] || 0) +
-    (data.wins_brawl || 0) +
-    (data['wins_solo brawl'] || 0) +
-    (data['wins_duo brawl'] || 0);
+function getStarLevel(kills, wins) {
   const sum = Number(kills) + wins * 10;
   let starLevel = 1;
   const sums = [0, 1, 6, 21, 46, 96, 171, 271, 521, 1021, 1321, 1621, 1921, 2221, 2521, Infinity];
@@ -25,159 +9,186 @@ function getStarLevel(data) {
   return starLevel;
 }
 
-/**
- * UHC class
- */
-class UHC {
+class UHCGamemode {
   /**
    * @param {object} data UHC data
+   * @param {string} mode UHC Mode Name
    */
-  constructor(data) {
+  constructor(data, mode) {
+    if (mode) mode = `_${mode}`;
     /**
-     * Coins
+     * Kills
      * @type {number}
      */
-    this.coins = data.coins || 0;
+    this.kills = data[`kills${mode}`] || 0;
     /**
-     * Score
+     * Deaths
      * @type {number}
      */
-    this.score = data.score || 0;
+    this.deaths = data[`deaths${mode}`] || 0;
     /**
-     * Kills
+     * Wins
      * @type {number}
      */
-    this.kills =
-      (data.kills || 0) +
-      (data.kills_solo || 0) +
-      (data['kills_red vs blue'] || 0) +
-      (data['kills_no diamonds'] || 0) +
-      (data.kills_brawl || 0) +
-      (data['kills_solo brawl'] || 0) +
-      (data['kills_duo brawl'] || 0);
+    this.wins = data[`wins${mode}`] || 0;
     /**
-     * Deaths
+     * Golden Heads Eaten
      * @type {number}
      */
-    this.deaths =
-      (data.deaths || 0) +
-      (data.deaths_solo || 0) +
-      (data['deaths_red vs blue'] || 0) +
-      (data['deaths_no diamonds'] || 0) +
-      (data.deaths_brawl || 0) +
-      (data['deaths_solo brawl'] || 0) +
-      (data['deaths_duo brawl'] || 0);
+    this.headsEaten = data[`heads_eaten${mode}`] || 0;
     /**
-     * Kill/Death ratio
+     * Ultimates Crafted
      * @type {number}
      */
-    this.KDRatio = divide(this.kills, this.deaths);
+    this.ultimatesCrafted = data[`ultimates_crafted${mode}`] || 0;
     /**
-     * Wins
+     * Extra Ultimates Crafted
      * @type {number}
      */
-    this.wins =
-      (data.wins || 0) +
-      (data.wins_solo || 0) +
-      (data['wins_red vs blue'] || 0) +
-      (data['wins_no diamonds'] || 0) +
-      (data.wins_brawl || 0) +
-      (data['wins_solo brawl'] || 0) +
-      (data['wins_duo brawl'] || 0);
+    this.extraUltimatesCrafted = data[`extra_ultimates_crafted${mode}`] || 0;
+  }
+}
+
+/**
+ * UHC class
+ */
+class UHC {
+  /**
+   * @param {object} data UHC data
+   */
+  constructor(data) {
     /**
-     * Heads eaten
+     * Coins
      * @type {number}
      */
-    this.headsEaten =
-      (data.heads_eaten || 0) +
-      (data.heads_eaten_solo || 0) +
-      (data['heads_eaten_red vs blue'] || 0) +
-      (data['heads_eaten_no diamonds'] || 0) +
-      (data.heads_eaten_brawl || 0) +
-      (data['heads_eaten_solo brawl'] || 0) +
-      (data['heads_eaten_duo brawl'] || 0);
+    this.coins = data.coins || 0;
     /**
-     * Star level
+     * Score
      * @type {number}
      */
-    this.starLevel = getStarLevel(data);
+    this.score = data.score || 0;
+    /**
+     * Selected Kit
+     * @type {string}
+     */
+    this.kit = data.equippedKit || '';
     /**
      * Solo
-     * @type {UHCModeStats}
+     * @type {UHCGamemode}
      */
-    this.solo = {
-      kills: data.kills_solo || 0,
-      deaths: data.deaths_solo || 0,
-      wins: data.wins_solo || 0,
-      headsEaten: data.heads_eaten_solo || 0
-    };
+    this.solo = new UHCGamemode(data, 'solo');
     /**
-     * Team
-     * @type {UHCModeStats}
+     * Teams
+     * @type {UHCGamemode}
      */
-    this.team = {
-      kills: data.kills || 0,
-      deaths: data.deaths || 0,
-      wins: data.wins || 0,
-      headsEaten: data.heads_eaten || 0
-    };
+    this.team = new UHCGamemode(data);
     /**
      * Red vs Blue
-     * @type {UHCModeStats}
+     * @type {UHCGamemode}
      */
-    this.redVsBlue = {
-      kills: data['kills_red vs blue'] || 0,
-      deaths: data['deaths_red vs blue'] || 0,
-      wins: data['wins_red vs blue'] || 0,
-      headsEaten: data['heads_eaten_red vs blue'] || 0
-    };
+    this.redVsBlue = new UHCGamemode(data, 'red_vs_blue');
     /**
      * No Diamond
-     * @type {UHCModeStats}
+     * @type {UHCGamemode}
      */
-    this.noDiamond = {
-      kills: data['kills_no diamonds'] || 0,
-      deaths: data['deaths_no diamonds'] || 0,
-      wins: data['wins_no diamonds'] || 0,
-      headsEaten: data['heads_eaten_no diamonds'] || 0
-    };
+    this.noDiamond = new UHCGamemode(data, 'no_diamonds');
     /**
      * Brawl
-     * @type {UHCModeStats}
+     * @type {UHCGamemode}
      */
-    this.brawl = {
-      kills: data.kills_brawl || 0,
-      deaths: data.deaths_brawl || 0,
-      wins: data.wins_brawl || 0,
-      headsEaten: data.heads_eaten_brawl || 0
-    };
+    this.brawl = new UHCGamemode(data, 'brawl');
     /**
      * Solo brawl
-     * @type {UHCModeStats}
+     * @type {UHCGamemode}
      */
-    this.soloBrawl = {
-      kills: data['kills_solo brawl'] || 0,
-      deaths: data['deaths_solo brawl'] || 0,
-      wins: data['wins_solo brawl'] || 0,
-      headsEaten: data['heads_eaten_solo brawl'] || 0
-    };
+    this.soloBrawl = new UHCGamemode(data, 'solo_brawl');
     /**
      * Duo Brawl
-     * @type {UHCModeStats}
-     */
-    this.duoBrawl = {
-      kills: data['kills_duo brawl'] || 0,
-      deaths: data['deaths_duo brawl'] || 0,
-      wins: data['wins_duo brawl'] || 0,
-      headsEaten: data['heads_eaten_duo brawl'] || 0
-    };
+     * @type {UHCGamemode}
+     */
+    this.duoBrawl = new UHCGamemode(data, 'duo_brawl');
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins =
+      this.solo.wins +
+      this.team.wins +
+      this.redVsBlue.wins +
+      this.noDiamond.wins +
+      this.brawl.wins +
+      this.soloBrawl.wins +
+      this.duoBrawl.wins;
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills =
+      this.solo.kills +
+      this.team.kills +
+      this.redVsBlue.kills +
+      this.noDiamond.kills +
+      this.brawl.kills +
+      this.soloBrawl.kills +
+      this.duoBrawl.kills;
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths =
+      this.solo.deaths +
+      this.team.deaths +
+      this.redVsBlue.deaths +
+      this.noDiamond.deaths +
+      this.brawl.deaths +
+      this.soloBrawl.deaths +
+      this.duoBrawl.deaths;
+    /**
+     * Kill/Death ratio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Heads eaten
+     * @type {number}
+     */
+    this.headsEaten =
+      this.solo.headsEaten +
+      this.team.headsEaten +
+      this.redVsBlue.headsEaten +
+      this.noDiamond.headsEaten +
+      this.brawl.headsEaten +
+      this.soloBrawl.headsEaten +
+      this.duoBrawl.headsEaten;
+    /**
+     * Ultimates Crafted
+     * @type {number}
+     */
+    this.ultimatesCrafted =
+      this.solo.ultimatesCrafted +
+      this.team.ultimatesCrafted +
+      this.redVsBlue.ultimatesCrafted +
+      this.noDiamond.ultimatesCrafted +
+      this.brawl.ultimatesCrafted +
+      this.soloBrawl.ultimatesCrafted +
+      this.duoBrawl.ultimatesCrafted;
+    /**
+     * Extra Ultimates Crafted
+     * @type {number}
+     */
+    this.extraUltimatesCrafted =
+      this.solo.extraUltimatesCrafted +
+      this.team.extraUltimatesCrafted +
+      this.redVsBlue.extraUltimatesCrafted +
+      this.noDiamond.extraUltimatesCrafted +
+      this.brawl.extraUltimatesCrafted +
+      this.soloBrawl.extraUltimatesCrafted +
+      this.duoBrawl.extraUltimatesCrafted;
+    /**
+     * Star level
+     * @type {number}
+     */
+    this.starLevel = getStarLevel(this.kills, this.wins);
   }
 }
-/**
- * @typedef {object} UHCModeStats
- * @property {number} kills Kills
- * @property {number} deaths Deaths
- * @property {number} wins Wins
- * @property {number} headsEaten Heads eaten
- */
 module.exports = UHC;

package/src/structures/MiniGames/VampireZ.js

@@ -1,4 +1,34 @@
 const divide = require('../../utils/divide');
+
+class VampireZRole {
+  /**
+   * @param {object} data VampireZ data
+   * @param {string} role VampireZ Role
+   */
+  constructor(data, role) {
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills = data[`${role}_kills`];
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = data[`${role}_deaths`];
+    /**
+     * KDRatio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data[`${role}_wins`];
+  }
+}
+
 /**
  * VampireZ class
  */
@@ -13,48 +43,51 @@ class VampireZ {
      */
     this.coins = data.coins || 0;
     /**
-     * Role Human
-     * @type {VampireZHumanStats}
+     * Gold Bought
+     * @type {number}
      */
-    this.human = {
-      kills: data.human_kills || 0,
-      deaths: data.human_deaths || 0,
-      KDRatio: divide(data.human_kills, data.human_wins),
-      wins: data.human_wins || 0
-    };
+    this.goldBought = data.gold_bought || 0;
     /**
-     * Role Zombie
-     * @type {VampireZZombieStats}
+     * Blood
+     * @type {boolean}
+     */
+    this.blood = data.blood || false;
+    /**
+     * Zombie Kills
+     * @type {number}
      */
-    this.zombie = {
-      kills: data.zombie_kills || 0
-    };
+    this.zombieKills = data.zombie_kills || 0;
     /**
-     * Role Vampire
-     * @type {VampireZVampireStats}
+     * Human Stats
+     * @type {VampireZRole}
      */
-    this.vampire = {
-      kills: data.vampire_kills || 0,
-      deaths: data.vampire_deaths || 0,
-      KDRatio: divide(data.vampire_kills, data.vampire_wins)
-    };
+    this.human = new VampireZRole(data, 'human');
+    /**
+     * Vampire Stats
+     * @type {VampireZRole}
+     */
+    this.vampire = new VampireZRole(data, 'vampire');
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills = this.human.kills + this.vampire.kills;
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = this.human.deaths + this.vampire.deaths;
+    /**
+     * KDRatio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = this.human.wins + this.vampire.wins;
   }
 }
-/**
- * @typedef {object} VampireZHumanStats
- * @property {number} kills Kills
- * @property {number} deaths Deaths
- * @property {number} KDRatio Kill Death ratio
- * @property {number} wins Wins
- */
-/**
- * @typedef {object} VampireZZombieStats
- * @property {number} kills Kills
- */
-/**
- * @typedef {object} VampireZVampireStats
- * @property {number} kills Kills
- * @property {number} deaths Deaths
- * @property {number} KDRatio Kill Death ratio
- */
+
 module.exports = VampireZ;

package/src/structures/MiniGames/Warlords.js

@@ -1,4 +1,49 @@
 const divide = require('../../utils/divide');
+
+class WarlordsClass {
+  /**
+   * @param {object} data Warlords data
+   * @param {string} className
+   */
+  constructor(data, className) {
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data[`wins_${className}`] || 0;
+    /**
+     * Losses
+     * @type {number}
+     */
+    this.losses = data[`losses_${className}`] || 0;
+    /**
+     * WLRatio
+     * @type {number}
+     */
+    this.WLRatio = divide(this.wins, this.losses);
+    /**
+     * Games Played
+     * @type {number}
+     */
+    this.gamesPlayed = data[`${className}_plays`];
+    /**
+     * Damage
+     * @type {number}
+     */
+    this.damage = data[`damage_${className}`] || 0;
+    /**
+     * Heal
+     * @type {number}
+     */
+    this.heal = data[`heal_${className}`] || 0;
+    /**
+     * Damage Prevented
+     * @type {number}
+     */
+    this.damagePrevented = data[`damage_prevented_${className}`] || 0;
+  }
+}
+
 /**
  * Warlords class
  */
@@ -56,7 +101,87 @@ class Warlords {
      * Chosen class
      * @type {string}
      */
-    this.class = data.chosen_class || 0;
+    this.class = data.chosen_class || '';
+    /**
+     * pyromancer
+     * @type {WarlordsClass}
+     */
+    this.pyromancer = new WarlordsClass(data, 'pyromancer');
+    /**
+     * mage
+     * @type {WarlordsClass}
+     */
+    this.mage = new WarlordsClass(data, 'mage');
+    /**
+     * thunderlord
+     * @type {WarlordsClass}
+     */
+    this.thunderlord = new WarlordsClass(data, 'thunderlord');
+    /**
+     * shaman
+     * @type {WarlordsClass}
+     */
+    this.shaman = new WarlordsClass(data, 'shaman');
+    /**
+     * earthwarden
+     * @type {WarlordsClass}
+     */
+    this.earthwarden = new WarlordsClass(data, 'earthwarden');
+    /**
+     * aquamancer
+     * @type {WarlordsClass}
+     */
+    this.aquamancer = new WarlordsClass(data, 'aquamancer');
+    /**
+     * paladin
+     * @type {WarlordsClass}
+     */
+    this.paladin = new WarlordsClass(data, 'paladin');
+    /**
+     * avenger
+     * @type {WarlordsClass}
+     */
+    this.avenger = new WarlordsClass(data, 'avenger');
+    /**
+     * warrior
+     * @type {WarlordsClass}
+     */
+    this.warrior = new WarlordsClass(data, 'warrior');
+    /**
+     * defender
+     * @type {WarlordsClass}
+     */
+    this.defender = new WarlordsClass(data, 'defender');
+    /**
+     * cryomancer
+     * @type {WarlordsClass}
+     */
+    this.cryomancer = new WarlordsClass(data, 'cryomancer');
+    /**
+     * crusader
+     * @type {WarlordsClass}
+     */
+    this.crusader = new WarlordsClass(data, 'crusader');
+    /**
+     * berserker
+     * @type {WarlordsClass}
+     */
+    this.berserker = new WarlordsClass(data, 'berserker');
+    /**
+     * protector
+     * @type {WarlordsClass}
+     */
+    this.protector = new WarlordsClass(data, 'protector');
+    /**
+     * revenant
+     * @type {WarlordsClass}
+     */
+    this.revenant = new WarlordsClass(data, 'revenant');
+    /**
+     * spiritguard
+     * @type {WarlordsClass}
+     */
+    this.spiritguard = new WarlordsClass(data, 'spiritguard');
   }
 }
 module.exports = Warlords;

package/src/structures/MiniGames/WoolWars.js

@@ -34,13 +34,62 @@ class WoolWars {
      * @type {number}
      */
     this.coins = data.coins || 0;
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data.wins || 0;
+    /**
+     * gamesPlayed
+     * @type {number}
+     */
+    this.gamesPlayed = data.games_played || 0;
+    /**
+     * woolsPlaced
+     * @type {number}
+     */
+    this.woolsPlaced = data.wool_placed || 0;
+    /**
+     * blocksBroken
+     * @type {number}
+     */
+    this.blocksBroken = data.blocks_broken || 0;
+    /**
+     * placeBreakRatio
+     * @type {number}
+     */
+    this.placeBreakRatio = divide(this.woolsPlaced, this.blocksBroken);
+    /**
+     * kills
+     * @type {number}
+     */
+    this.kills = data.kills || 0;
+    /**
+     * deaths
+     * @type {number}
+     */
+    this.deaths = data.deaths || 0;
+    /**
+     * KDRatio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * assists
+     * @type {number}
+     */
+    this.assists = data.assists || 0;
+    /**
+     * powerups
+     * @type {number}
+     */
+    this.powerups = data.powerups_gotten || 0;
     /**
      * Selected class, or NONE if field isn't present in API for some reason
      * @type {'ASSAULT'|'TANK'|'GOLEM'|'SWORDSMAN'|'ENGINEER'|'ARCHER'|'NONE'}
      */
     this.selectedClass = data.wool_wars?.selected_class || 'NONE';
     this.stats = {
-      overall: WoolWars.generateStatsFor(data.wool_wars?.stats, ''),
       assault: WoolWars.generateStatsFor(data.wool_wars?.stats, 'assault'),
       tank: WoolWars.generateStatsFor(data.wool_wars?.stats, 'tank'),
       golem: WoolWars.generateStatsFor(data.wool_wars?.stats, 'golem'),
@@ -86,11 +135,11 @@ class WoolWars {
     // eslint-disable-next-line no-underscore-dangle
     const workingData = (_class ? data?.classes?.[_class] : data) || {};
     return {
-      roundWins: workingData.wins || 0,
+      wins: workingData.wins || 0,
       gamesPlayed: workingData.games_played || 0,
       woolsPlaced: workingData.wool_placed || 0,
       blocksBroken: workingData.blocks_broken || 0,
-      placeBreakRatio: divide(workingData.wool_placed, workingData.blocks_broken),
+      placeBreakRatio: divide(workingData.wool_placed || 0, workingData.blocks_broken || 0),
       kills: workingData.kills || 0,
       deaths: workingData.deaths || 0,
       KDRatio: divide(workingData.kills, workingData.deaths),
@@ -107,10 +156,11 @@ class WoolWars {
  * @property {string} game_speed Game speed
  * @property {string} speed Player speed
  * @property {'Enabled'|'Disabled'} no_class No class
+ * @property {boolean} respawn_enable Respawning enabled
  */
 /**
  * @typedef {Object} WoolWarsStats
- * @property {number} roundWins round wins
+ * @property {number} wins wins
  * @property {number} gamesPlayed games played
  * @property {number} woolsPlaced wools placed
  * @property {number} blocksBroken blocks broken