hypixel-api-reborn 11.1.0 → 11.2.1

package/src/structures/MiniGames/Arcade.js

@@ -1,173 +1,16 @@
 // IMPORTANT : a lot of the properties from the API seem to be nonsense
 
-const divide = require('../../utils/divide');
-const { weekAB, monthAB } = require('../../utils/oscillation');
 const { removeSnakeCaseString } = require('../../utils/removeSnakeCase');
+const { weekAB, monthAB } = require('../../utils/oscillation');
+const divide = require('../../utils/divide');
 
-/**
- * Arcade class
- */
-class Arcade {
-  /**
-   * Constructor
-   * @param {Object} data Data from the API
-   */
-  constructor(data = {}) {
-    /**
-     * Last Tournament Advertisement as timestamp, only appears when a tournament is announced
-     * @type {number}
-     */
-    this.lastTourneyAdTimestamp = data.lastTourneyAd || undefined;
-    /**
-     * Last Tournament Advertisement as Date, only appears when a tournament is announced
-     * @type {Date}
-     */
-    this.lastTourneyAdAt = this.lastTourneyAdTimestamp ? new Date(data.lastTourneyAd) : undefined;
-    /**
-     * Amount of coins
-     * @type {number}
-     */
-    this.coins = data.coins || 0;
-    /**
-     * Weekly coins
-     * @type {number}
-     */
-    this.weeklyCoins = parseInt(data[`weekly_coins_${weekAB()}`] || 0, 10);
-    /**
-     * Monthly coins
-     * @type {number}
-     */
-    this.monthlyCoins = parseInt(data[`monthly_coins_${monthAB()}`] || 0, 10);
-    /**
-     * Hints Disabled
-     * @type {Boolean}
-     */
-    this.hintsDisabled = !data.hints;
-    /**
-     * Flash Disabled
-     * @type {Boolean}
-     */
-    this.flashDisabled = !data.flash;
-    /**
-     * Draw their thing stats
-     * @type {BaseGame}
-     */
-    this.drawTheirThing = new BaseGame(data, 'draw_their_thing');
-    /**
-     * Dragon wars "2" stats
-     * @type {BaseGame}
-     */
-    this.dragonWars = new BaseGame(data, 'dragonwars2');
-    /**
-     * Easter Simulator stats
-     * @type {EasterSimulator}
-     */
-    this.easterSimulator = new BaseGame(data, 'easter_simulator').extend('eggsFound', data.eggs_found_easter_simulator || 0);
-    /**
-     * Grinch Simulator stats
-     * @type {GrinchSimulator}
-     */
-    this.grinchSimulator = new BaseGame(data, 'grinch_simulator_v2').extend('giftsFound', data.gifts_grinch_simulator_v2 || 0);
-    /**
-     * Scuba Simulator stats
-     * @type {ScubaSimulator}
-     */
-    this.scubaSimulator = new BaseGame(data, 'scuba_simulator').extend('itemsFound', data.items_found_scuba_simulator || 0);
-    /**
-     * Santa Simulator stats
-     * @type {SantaSimulator}
-     */
-    this.santaSimulator = new BaseGame(data, 'santa_simulator').extend('giftsDelivered', data.delivered_santa_simulator || 0);
-    /**
-     * Santa Says stats
-     * @type {BaseGame}
-     */
-    this.santaSays = new BaseGame(data, 'santa_says');
-    /**
-     * Simon Says stats
-     * @type {BaseGame}
-     */
-    this.simonSays = new BaseGame(data, 'simon_says');
-    /**
-     * Farm Hunt stats
-     * @type {BaseGame}
-     */
-    this.farmHunt = new BaseGame(data, 'farm_hunt');
-    /**
-     * Hole in the Wall stats
-     * @type {HITW}
-     */
-    this.holeInTheWall = new HITW(data, 'hole_in_the_wall');
-    /**
-     * Mini Walls stats
-     * @type {MiniWalls}
-     */
-    this.miniWalls = new MiniWalls(data); // needs extension
-    /**
-     * Party games (1) stats
-     * @type {BaseGame}
-     */
-    this.partyGames = new BaseGame(data, 'party');
-    /**
-     * Party Games 2 stats ( legacy )
-     * @type {BaseGame}
-     * @deprecated
-     */
-    this.partyGames2 = new BaseGame(data, 'party_2');
-    /**
-     * Party Games 3 stats ( legacy )
-     * @type {BaseGame}
-     * @deprecated
-     */
-    this.partyGames3 = new BaseGame(data, 'party_3');
-    /**
-     * Throw out stats
-     * @type {BaseGame}
-     */
-    this.throwOut = new BaseGame(data, 'throw_out');
-    /**
-     * Soccer stats
-     * @type {Soccer}
-     */
-    this.soccer = new Soccer(data);
-    /**
-     * Hypixel Sports stats
-     * @type {BaseGame}
-     * @deprecated
-     */
-    this.hypixelSports = new BaseGame(data, 'hypixel_sports');
-    /**
-     * Ender Spleef stats
-     * @type {BaseGame}
-     */
-    this.enderSpleef = new BaseGame(data, 'ender');
-    /**
-     * Blocking dead ( previously known as DayOne ) stats
-     * @type {BlockingDead}
-     */
-    this.blockingDead = new BaseGame(data, 'dayone').extend('headshots', data.headshots_dayone || 0);
-    /**
-     * Galaxy Wars stats
-     * @type {GalaxyWars}
-     */
-    this.galaxyWars = new GalaxyWars(data);
-    // Lenient parsing
-    /**
-     * OITQ / One In The Quiver stats
-     * @type {OITQ}
-     */
-    this.oitq = this.oneInTheQuiver = new BaseGame(data, 'oneinthequiver').extend('bountyKills', data.bounty_kills_oneinthequiver || 0);
-    /**
-     * Zombies
-     * @type {Zombies}
-     */
-    this.zombies = new Zombies(data);
-    /**
-     * Capture The Wool
-     * @type {{kills: number, captures: number}}
-     */
-    this.captureTheWool = { kills: data.arcade_ctw_slayer || 0, captures: data.arcade_ctw_oh_sheep || 0 };
-  }
+// eslint-disable-next-line jsdoc/require-jsdoc
+function parseZombiesKills(data) {
+  const matches = Array.from(Object.keys(data))
+    .map((x) => x.match(/^([A-Za-z]+)_zombie_kills_zombies$/))
+    .filter((x) => x);
+  // From entries might be broken
+  return Object.fromEntries(matches.map((x) => [removeSnakeCaseString(x[1]), data[x[0]] || 0]));
 }
 /**
  * Most basic game class, used by all arcade games
@@ -361,64 +204,76 @@ class MiniWalls extends BaseGame {
   }
 }
 /**
- * Zombies - Overall stats
+ * Zombies - Stats by Map + Difficulty
  */
-class Zombies {
+class ZombiesStats {
   /**
    * Constructor
    * @param {Object} data Data from API
+   * @param {string} type Map name + difficulty ( default overall )
    */
-  constructor(data) {
+  constructor(data, type = '') {
+    if (type) type = `_${type}`;
     /**
-     * Overall Stats
-     * @type {ZombiesStats}
+     * Best Round
+     * @type {number}
      */
-    this.overall = new ZombiesStats(data);
+    this.bestRound = data[`best_round_zombies${type}`] || 0;
     /**
-     * Stats for Dead End
-     * @type {ZombieMap}
+     * Deaths ( NOT losses )
+     * @type {number}
      */
-    this.deadEnd = new ZombieMap(data, 'deadend');
+    this.deaths = data[`deaths_zombies${type}`] || 0;
     /**
-     * Stats for Bad Blood
-     * @type {ZombieMap}
+     * Doors opened
+     * @type {number}
      */
-    this.badBlood = new ZombieMap(data, 'badblood');
+    this.doorsOpened = data[`doors_opened_zombies${type}`] || 0;
     /**
-     * Stats for Alien Arcadium
-     * @type {ZombieMap}
+     * Fastest time to reach round 10 in seconds
+     * @type {number}
      */
-    this.alienArcadium = new ZombieMap(data, 'alienarcadium');
+    this.fastestRound10 = data[`fastest_time_10_zombies${type}`] || 0;
     /**
-     * Kills By Zombie
-     * @type {Record<string,number>}
+     * Fastest time to reach round 20 in seconds
+     * @type {number}
      */
-    this.killsByZombie = parseZombiesKills(data);
+    this.fastestRound20 = data[`fastest_time_20_zombies${type}`] || 0;
     /**
-     * Bullets Hit
+     * Fastest time to reach round 30 in seconds
      * @type {number}
      */
-    this.bulletsHit = data.bullets_hit_zombies || 0;
+    this.fastestRound30 = data[`fastest_time_30_zombies${type}`] || 0;
     /**
-     * Bullets Shot
+     * Players revived
      * @type {number}
      */
-    this.bulletsShot = data.bullets_shot_zombies || 0;
+    this.playersRevived = data[`players_revived_zombies${type}`] || 0;
     /**
-     * Gun Accuracy
+     * Number of times player is knocked down
      * @type {number}
      */
-    this.gunAccuracy = divide(this.bulletsHit, this.bulletsShot);
+    this.timesKnockedDown = data[`times_knocked_down_zombies${type}`] || 0;
     /**
-     * Headshots
+     * Total amount of rounds the player survived
      * @type {number}
      */
-    this.headshots = data.headshots_zombies || 0;
+    this.roundsSurvived = data[`total_rounds_survived_zombies${type}`] || 0;
     /**
-     * Headshot Accuracy
+     * Total amount of windows fully repaired by player
      * @type {number}
      */
-    this.headshotAccuracy = divide(this.headshots, this.bulletsShot);
+    this.windowsRepaired = data[`windows_repaired_zombies${type}`] || 0;
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data[`wins_zombies${type}`] || 0;
+    /**
+     * Total Zombie Kills
+     * @type {number}
+     */
+    this.zombieKills = data[`zombie_kills_zombies${type}`] || 0;
   }
 }
 /**
@@ -454,86 +309,238 @@ class ZombieMap {
   }
 }
 /**
- * Zombies - Stats by Map + Difficulty
+ * Zombies - Overall stats
  */
-class ZombiesStats {
+class Zombies {
   /**
    * Constructor
    * @param {Object} data Data from API
-   * @param {string} type Map name + difficulty ( default overall )
    */
-  constructor(data, type = '') {
-    if (type) type = `_${type}`;
+  constructor(data) {
     /**
-     * Best Round
-     * @type {number}
+     * Overall Stats
+     * @type {ZombiesStats}
      */
-    this.bestRound = data[`best_round_zombies${type}`] || 0;
+    this.overall = new ZombiesStats(data);
     /**
-     * Deaths ( NOT losses )
-     * @type {number}
+     * Stats for Dead End
+     * @type {ZombieMap}
      */
-    this.deaths = data[`deaths_zombies${type}`] || 0;
+    this.deadEnd = new ZombieMap(data, 'deadend');
     /**
-     * Doors opened
-     * @type {number}
+     * Stats for Bad Blood
+     * @type {ZombieMap}
      */
-    this.doorsOpened = data[`doors_opened_zombies${type}`] || 0;
+    this.badBlood = new ZombieMap(data, 'badblood');
     /**
-     * Fastest time to reach round 10 in seconds
-     * @type {number}
+     * Stats for Alien Arcadium
+     * @type {ZombieMap}
      */
-    this.fastestRound10 = data[`fastest_time_10_zombies${type}`] || 0;
+    this.alienArcadium = new ZombieMap(data, 'alienarcadium');
     /**
-     * Fastest time to reach round 20 in seconds
+     * Kills By Zombie
+     * @type {Record<string,number>}
+     */
+    this.killsByZombie = parseZombiesKills(data);
+    /**
+     * Bullets Hit
      * @type {number}
      */
-    this.fastestRound20 = data[`fastest_time_20_zombies${type}`] || 0;
+    this.bulletsHit = data.bullets_hit_zombies || 0;
     /**
-     * Fastest time to reach round 30 in seconds
+     * Bullets Shot
      * @type {number}
      */
-    this.fastestRound30 = data[`fastest_time_30_zombies${type}`] || 0;
+    this.bulletsShot = data.bullets_shot_zombies || 0;
     /**
-     * Players revived
+     * Gun Accuracy
      * @type {number}
      */
-    this.playersRevived = data[`players_revived_zombies${type}`] || 0;
+    this.gunAccuracy = divide(this.bulletsHit, this.bulletsShot);
     /**
-     * Number of times player is knocked down
+     * Headshots
      * @type {number}
      */
-    this.timesKnockedDown = data[`times_knocked_down_zombies${type}`] || 0;
+    this.headshots = data.headshots_zombies || 0;
     /**
-     * Total amount of rounds the player survived
+     * Headshot Accuracy
      * @type {number}
      */
-    this.roundsSurvived = data[`total_rounds_survived_zombies${type}`] || 0;
+    this.headshotAccuracy = divide(this.headshots, this.bulletsShot);
+  }
+}
+
+/**
+ * Arcade class
+ */
+class Arcade {
+  /**
+   * Constructor
+   * @param {Object} data Data from the API
+   */
+  constructor(data = {}) {
     /**
-     * Total amount of windows fully repaired by player
+     * Amount of coins
      * @type {number}
      */
-    this.windowsRepaired = data[`windows_repaired_zombies${type}`] || 0;
+    this.coins = data.coins || 0;
     /**
-     * Wins
+     * Weekly coins
      * @type {number}
      */
-    this.wins = data[`wins_zombies${type}`] || 0;
+    this.weeklyCoins = parseInt(data[`weekly_coins_${weekAB()}`] || 0, 10);
     /**
-     * Total Zombie Kills
+     * Monthly coins
      * @type {number}
      */
-    this.zombieKills = data[`zombie_kills_zombies${type}`] || 0;
+    this.monthlyCoins = parseInt(data[`monthly_coins_${monthAB()}`] || 0, 10);
+    /**
+     * Hints Disabled
+     * @type {boolean}
+     */
+    this.hintsDisabled = !data.hints;
+    /**
+     * Flash Disabled
+     * @type {boolean}
+     */
+    this.flashDisabled = !data.flash;
+    /**
+     * Draw their thing stats
+     * @type {BaseGame}
+     */
+    this.drawTheirThing = new BaseGame(data, 'draw_their_thing');
+    /**
+     * Dragon wars "2" stats
+     * @type {BaseGame}
+     */
+    this.dragonWars = new BaseGame(data, 'dragonwars2');
+    /**
+     * Easter Simulator stats
+     * @type {EasterSimulator}
+     */
+    this.easterSimulator = new BaseGame(data, 'easter_simulator').extend(
+      'eggsFound',
+      data.eggs_found_easter_simulator || 0
+    );
+    /**
+     * Grinch Simulator stats
+     * @type {GrinchSimulator}
+     */
+    this.grinchSimulator = new BaseGame(data, 'grinch_simulator_v2').extend(
+      'giftsFound',
+      data.gifts_grinch_simulator_v2 || 0
+    );
+    /**
+     * Scuba Simulator stats
+     * @type {ScubaSimulator}
+     */
+    this.scubaSimulator = new BaseGame(data, 'scuba_simulator').extend(
+      'itemsFound',
+      data.items_found_scuba_simulator || 0
+    );
+    /**
+     * Santa Simulator stats
+     * @type {SantaSimulator}
+     */
+    this.santaSimulator = new BaseGame(data, 'santa_simulator').extend(
+      'giftsDelivered',
+      data.delivered_santa_simulator || 0
+    );
+    /**
+     * Santa Says stats
+     * @type {BaseGame}
+     */
+    this.santaSays = new BaseGame(data, 'santa_says');
+    /**
+     * Simon Says stats
+     * @type {BaseGame}
+     */
+    this.simonSays = new BaseGame(data, 'simon_says');
+    /**
+     * Farm Hunt stats
+     * @type {BaseGame}
+     */
+    this.farmHunt = new BaseGame(data, 'farm_hunt');
+    /**
+     * Hole in the Wall stats
+     * @type {HITW}
+     */
+    this.holeInTheWall = new HITW(data, 'hole_in_the_wall');
+    /**
+     * Mini Walls stats
+     * @type {MiniWalls}
+     */
+    // TODO needs extension
+    this.miniWalls = new MiniWalls(data);
+    /**
+     * Party games (1) stats
+     * @type {BaseGame}
+     */
+    this.partyGames = new BaseGame(data, 'party');
+    /**
+     * Party Games 2 stats ( legacy )
+     * @type {BaseGame}
+     * @deprecated
+     */
+    this.partyGames2 = new BaseGame(data, 'party_2');
+    /**
+     * Party Games 3 stats ( legacy )
+     * @type {BaseGame}
+     * @deprecated
+     */
+    this.partyGames3 = new BaseGame(data, 'party_3');
+    /**
+     * Throw out stats
+     * @type {BaseGame}
+     */
+    this.throwOut = new BaseGame(data, 'throw_out');
+    /**
+     * Soccer stats
+     * @type {Soccer}
+     */
+    this.soccer = new Soccer(data);
+    /**
+     * Hypixel Sports stats
+     * @type {BaseGame}
+     * @deprecated
+     */
+    this.hypixelSports = new BaseGame(data, 'hypixel_sports');
+    /**
+     * Ender Spleef stats
+     * @type {BaseGame}
+     */
+    this.enderSpleef = new BaseGame(data, 'ender');
+    /**
+     * Blocking dead ( previously known as DayOne ) stats
+     * @type {BlockingDead}
+     */
+    this.blockingDead = new BaseGame(data, 'dayone').extend('headshots', data.headshots_dayone || 0);
+    /**
+     * Galaxy Wars stats
+     * @type {GalaxyWars}
+     */
+    this.galaxyWars = new GalaxyWars(data);
+    // Lenient parsing
+    /**
+     * OITQ / One In The Quiver stats
+     * @type {OITQ}
+     */
+    this.oitq = this.oneInTheQuiver = new BaseGame(data, 'oneinthequiver').extend(
+      'bountyKills',
+      data.bounty_kills_oneinthequiver || 0
+    );
+    /**
+     * Zombies
+     * @type {Zombies}
+     */
+    this.zombies = new Zombies(data);
+    /**
+     * Capture The Wool
+     * @type {{kills: number, captures: number}}
+     */
+    this.captureTheWool = { kills: data.arcade_ctw_slayer || 0, captures: data.arcade_ctw_oh_sheep || 0 };
   }
 }
-// eslint-disable-next-line require-jsdoc
-function parseZombiesKills(data) {
-  const matches = Array.from(Object.keys(data))
-    .map((x) => x.match(/^([A-z]+)_zombie_kills_zombies$/))
-    .filter((x) => x);
-  // From entries might be broken
-  return Object.fromEntries(matches.map((x) => [removeSnakeCaseString(x[1]), data[x[0]] || 0]));
-}
 /**
  * @typedef {Object} EasterSimulator
  * @extends BaseGame

package/src/structures/MiniGames/ArenaBrawl.js

@@ -1,4 +1,15 @@
 const divide = require('../../utils/divide');
+// eslint-disable-next-line jsdoc/require-jsdoc
+function generateModeStats(data, mode) {
+  return {
+    kills: data[`kills_${mode}`] || 0,
+    deaths: data[`deaths_${mode}`] || 0,
+    KDRatio: divide(data[`kills_${mode}`], data[`deaths_${mode}`]),
+    wins: data[`wins_${mode}`] || 0,
+    losses: data[`losses_${mode}`] || 0,
+    WLRatio: divide(data[`wins_${mode}`], data[`losses_${mode}`])
+  };
+}
 /**
  * ArenaBrawl class
  */
@@ -23,17 +34,6 @@ class ArenaBrawl {
     };
   }
 }
-// eslint-disable-next-line require-jsdoc
-function generateModeStats(data, mode) {
-  return {
-    kills: data[`kills_${mode}`] || 0,
-    deaths: data[`deaths_${mode}`] || 0,
-    KDRatio: divide(data[`kills_${mode}`], data[`deaths_${mode}`]),
-    wins: data[`wins_${mode}`] || 0,
-    losses: data[`losses_${mode}`] || 0,
-    WLRatio: divide(data[`wins_${mode}`], data[`losses_${mode}`])
-  };
-}
 /**
  * @typedef {Object} ArenaBrawlStats
  * @property {ArenaBrawlModeStats} '1v1' ArenaBrawl 1v1 stats