hypixel-api-reborn 11.2.0 → 11.3.0

package/src/structures/MiniGames/ArenaBrawl.js

@@ -1,4 +1,64 @@
 const divide = require('../../utils/divide');
+
+class ArenaBrawlMode {
+  /**
+   * @param {object} data ArenaBrawl data
+   * @param {string} mode mode
+   */
+  constructor(data, mode) {
+    /**
+     * Damage
+     * @type {number}
+     */
+    this.damage = data[`damage_${mode}`];
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills = data[`kills_${mode}`];
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = data[`deaths_${mode}`];
+    /**
+     * KDRatio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Healed
+     * @type {number}
+     */
+    this.healed = data[`healed_${mode}`];
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data[`wins_${mode}`];
+    /**
+     * Losses
+     * @type {number}
+     */
+    this.losses = data[`losses_${mode}`];
+    /**
+     * WLRatio
+     * @type {number}
+     */
+    this.WLRatio = divide(this.wins, this.losses);
+    /**
+     * Games Played
+     * @type {number}
+     */
+    this.games = data[`games_${mode}`];
+    /**
+     * Winstreak
+     * @type {number}
+     */
+    this.winstreak = data[`win_streaks_${mode}`];
+  }
+}
+
 /**
  * ArenaBrawl class
  */
@@ -12,41 +72,47 @@ class ArenaBrawl {
      * @type {number}
      */
     this.coins = data.coins || 0;
+    /**
+     * Coins Spent
+     * @type {number}
+     */
+    this.coinsSpent = data.coins_spent || 0;
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data.wins || 0;
+    /**
+     * Keys
+     * @type {number}
+     */
+    this.keys = data.keys || 0;
+    /**
+     * Chests
+     * @type {number}
+     */
+    this.chests = data.magical_chest || 0;
+    /**
+     * Rune
+     * @type {string}
+     */
+    this.rune = data.active_rune || '';
     /**
      * ArenaBrawl mode stats
-     * @type {ArenaBrawlStats}
+     * @type {ArenaBrawlMode}
      */
-    this.mode = {
-      '1v1': generateModeStats(data, '1v1'),
-      '2v2': generateModeStats(data, '2v2'),
-      '4v4': generateModeStats(data, '4v4')
-    };
+    this['1v1'] = new ArenaBrawlMode(data, '1v1');
+    /**
+     * ArenaBrawl mode stats
+     * @type {ArenaBrawlMode}
+     */
+    this['2v2'] = new ArenaBrawlMode(data, '2v2');
+    /**
+     * ArenaBrawl mode stats
+     * @type {ArenaBrawlMode}
+     */
+    this['4v4'] = new ArenaBrawlMode(data, '4v4');
   }
 }
-// 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
- * @property {ArenaBrawlModeStats} '2v2' ArenaBrawl 2v2 stats
- * @property {ArenaBrawlModeStats} '4v4' ArenaBrawl 4v4 stats
- */
-/**
- * @typedef {Object} ArenaBrawlModeStats
- * @property {number} kills ArenaBrawl kills
- * @property {number} deaths ArenaBrawl deaths
- * @property {number} KDRatio ArenaBrawl Kill Death ratio
- * @property {number} wins ArenaBrawl wins
- * @property {number} losses ArenaBrawl losses
- * @property {number} WLRatio ArenaBrawl Win Loss ratio
- */
+
 module.exports = ArenaBrawl;

package/src/structures/MiniGames/BedWars.js

@@ -32,182 +32,9 @@ const generateStatsForMode = (data, mode) => {
   };
 };
 
-/**
- * BedWars class
- */
-class BedWars {
-  /**
-   * @param {object} data BedWars data
-   */
-  constructor(data) {
-    /**
-     * Tokens
-     * @type {number}
-     */
-    this.tokens = data.coins || 0;
-    /**
-     * Level
-     * @type {number}
-     */
-    this.level = data.Experience ? getLevelForExp(data.Experience) : 0;
-    /**
-     * Experience
-     * @type {number}
-     */
-    this.experience = data.Experience || 0;
-    /**
-     * Prestige
-     * @type {BedWarsPrestige}
-     */
-    this.prestige = data.Experience ? getBedWarsPrestige(getLevelForExp(data.Experience)) : 'Stone';
-    /**
-     * Played games
-     * @type {number}
-     */
-    this.playedGames = data.games_played_bedwars || 0;
-    /**
-     * Wins
-     * @type {number}
-     */
-    this.wins = data.wins_bedwars || 0;
-    /**
-     * Winstreak
-     * @type {number}
-     */
-    this.winstreak = data.winstreak || 0;
-    /**
-     * Kills
-     * @type {number}
-     */
-    this.kills = data.kills_bedwars || 0;
-    /**
-     * Final kills
-     * @type {number}
-     */
-    this.finalKills = data.final_kills_bedwars || 0;
-    /**
-     * Losses
-     * @type {number}
-     */
-    this.losses = data.losses_bedwars || 0;
-    /**
-     * Deaths
-     * @type {number}
-     */
-    this.deaths = data.deaths_bedwars || 0;
-    /**
-     * Final deaths
-     * @type {number}
-     */
-    this.finalDeaths = data.final_deaths_bedwars || 0;
-    /**
-     * Collected items
-     * @type {BedWarsCollectedItems}
-     */
-    this.collectedItemsTotal = {
-      iron: data.iron_resources_collected_bedwars || 0,
-      gold: data.gold_resources_collected_bedwars || 0,
-      diamond: data.diamond_resources_collected_bedwars || 0,
-      emerald: data.emerald_resources_collected_bedwars || 0
-    };
-    /**
-     * Beds lost/broken/BL Ratio
-     * @type {BedWarsBeds}
-     */
-    this.beds = {
-      lost: data.beds_lost_bedwars || 0,
-      broken: data.beds_broken_bedwars || 0,
-      BLRatio: divide(data.beds_broken_bedwars, data.beds_lost_bedwars)
-    };
-    /**
-     * Average Kills/Final kills/Beds broken
-     * @type {BedWarsAvg}
-     */
-    this.avg = {
-      kills: divide(this.kills, this.playedGames),
-      finalKills: divide(this.finalKills, this.playedGames),
-      bedsBroken: divide(this.beds.broken, this.playedGames)
-    };
-    /**
-     * Kill Death ratio
-     * @type {number}
-     */
-    this.KDRatio = divide(this.kills, this.deaths);
-    /**
-     * Final kill death ratio
-     * @type {number}
-     */
-    this.finalKDRatio = divide(this.finalKills, this.finalDeaths);
-    /**
-     * Win Loss ratio
-     * @type {number}
-     */
-    this.WLRatio = divide(this.wins, this.losses);
-    /**
-     * BedWars Solo stats
-     * @type {BedWarsModeStats}
-     */
-    this.solo = generateStatsForMode(data, 'eight_one');
-    /**
-     * BedWars Doubles stats
-     * @type {BedWarsModeStats}
-     */
-    this.doubles = generateStatsForMode(data, 'eight_two');
-    /**
-     * BedWars 3v3v3v3 stats
-     * @type {BedWarsModeStats}
-     */
-    this.threes = generateStatsForMode(data, 'four_three');
-    /**
-     * BedWars 4v4v4v4 stats
-     * @type {BedWarsModeStats}
-     */
-    this.fours = generateStatsForMode(data, 'four_four');
-    /**
-     * BedWars 4v4 stats
-     * @type {BedWarsModeStats}
-     */
-    this['4v4'] = generateStatsForMode(data, 'two_four');
-    /**
-     * BedWars Dream Mode Stats
-     * @type {BedwarsDreamStats}
-     */
-    this.dream = ['ultimate', 'rush', 'armed', 'lucky', 'voidless'].reduce(
-      (ac, mode) => ({
-        [mode]: {
-          doubles: generateStatsForMode(data, `eight_two_${mode}`),
-          fours: generateStatsForMode(data, `four_four_${mode}`)
-        },
-        ...ac
-      }),
-      {}
-    );
-    /**
-     * BedWars Castle Stats
-     * @type {BedWarsModeStats}
-     */
-    this.castle = generateStatsForMode(data, 'castle');
-    /**
-     * BedWars Practice Stats
-     * @type {BedWarsPracticeStats}
-     */
-    this.practice = generateStatsForPractice(data);
-    /**
-     * Bedwars Slumber Tickets
-     * @type {number}
-     */
-    this.slumberTickets = data.slumber?.tickets ?? 0;
-    /**
-     * Bedwars Slumber Total Tickets
-     * @type {number}
-     */
-    this.totalSlumberTicket = data.slumber?.total_tickets ?? 0;
-  }
-}
-// eslint-disable-next-line require-jsdoc
+// eslint-disable-next-line jsdoc/require-jsdoc
 function getBedWarsPrestige(level) {
-  // eslint-disable-next-line max-len
-  if (level >= 5000) return 'Eternal';
+  if (5000 <= level) return 'Eternal';
   return (
     [
       'Stone',
@@ -270,9 +97,17 @@ const XP_PER_PRESTIGE = 96 * 5000 + EASY_LEVELS_XP;
 const LEVELS_PER_PRESTIGE = 100;
 const HIGHEST_PRESTIGE = 10;
 
-// eslint-disable-next-line require-jsdoc
+// eslint-disable-next-line jsdoc/require-jsdoc
+function getLevelRespectingPrestige(level) {
+  if (level > HIGHEST_PRESTIGE * LEVELS_PER_PRESTIGE) {
+    return level - HIGHEST_PRESTIGE * LEVELS_PER_PRESTIGE;
+  }
+  return level % LEVELS_PER_PRESTIGE;
+}
+
+// eslint-disable-next-line jsdoc/require-jsdoc
 function getExpForLevel(level) {
-  if (level === 0) return 0;
+  if (0 === level) return 0;
   const respectedLevel = getLevelRespectingPrestige(level);
   if (respectedLevel > EASY_LEVELS) return 5000;
   switch (respectedLevel) {
@@ -284,18 +119,13 @@ function getExpForLevel(level) {
       return 2000;
     case 4:
       return 3500;
-  }
-  return 5000;
-}
-// eslint-disable-next-line require-jsdoc
-function getLevelRespectingPrestige(level) {
-  if (level > HIGHEST_PRESTIGE * LEVELS_PER_PRESTIGE) {
-    return level - HIGHEST_PRESTIGE * LEVELS_PER_PRESTIGE;
-  } else {
-    return level % LEVELS_PER_PRESTIGE;
+    default: {
+      return 5000;
+    }
   }
 }
-// eslint-disable-next-line require-jsdoc
+
+// eslint-disable-next-line jsdoc/require-jsdoc
 function getLevelForExp(exp) {
   const prestiges = Math.floor(exp / XP_PER_PRESTIGE);
   let level = prestiges * LEVELS_PER_PRESTIGE;
@@ -311,7 +141,8 @@ function getLevelForExp(exp) {
   }
   return level + Math.floor(expWithoutPrestiges / 5000);
 }
-// eslint-disable-next-line require-jsdoc
+
+// eslint-disable-next-line jsdoc/require-jsdoc
 function generateStatsForPractice(data) {
   return {
     selected: data?.practice?.selected || 'NONE',
@@ -323,7 +154,7 @@ function generateStatsForPractice(data) {
         total: data?.practice?.bridging?.failed_attempts + data?.practice?.bridging?.successful_attempts
       },
       records: {
-        '30Blocks': {
+        blocks30: {
           elevation: {
             none: {
               straight: data?.practice?.records?.['bridging_distance_30:elevation_NONE:angle_STRAIGHT:'] ?? 0,
@@ -339,7 +170,7 @@ function generateStatsForPractice(data) {
             }
           }
         },
-        '50Blocks': {
+        blocks50: {
           elevation: {
             none: {
               straight: data?.practice?.records?.['bridging_distance_50:elevation_NONE:angle_STRAIGHT:'] ?? 0,
@@ -355,7 +186,7 @@ function generateStatsForPractice(data) {
             }
           }
         },
-        '100Blocks': {
+        blocks100: {
           elevation: {
             none: {
               straight: data?.practice?.records?.['bridging_distance_100:elevation_NONE:angle_STRAIGHT:'] ?? 0,
@@ -398,6 +229,178 @@ function generateStatsForPractice(data) {
     }
   };
 }
+/**
+ * BedWars class
+ */
+class BedWars {
+  /**
+   * @param {object} data BedWars data
+   */
+  constructor(data) {
+    /**
+     * Tokens
+     * @type {number}
+     */
+    this.tokens = data.coins || 0;
+    /**
+     * Level
+     * @type {number}
+     */
+    this.level = data.Experience ? getLevelForExp(data.Experience) : 0;
+    /**
+     * Experience
+     * @type {number}
+     */
+    this.experience = data.Experience || 0;
+    /**
+     * Prestige
+     * @type {BedWarsPrestige}
+     */
+    this.prestige = data.Experience ? getBedWarsPrestige(getLevelForExp(data.Experience)) : 'Stone';
+    /**
+     * Played games
+     * @type {number}
+     */
+    this.playedGames = data.games_played_bedwars || 0;
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data.wins_bedwars || 0;
+    /**
+     * Winstreak
+     * @type {number}
+     */
+    this.winstreak = data.winstreak || 0;
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills = data.kills_bedwars || 0;
+    /**
+     * Final kills
+     * @type {number}
+     */
+    this.finalKills = data.final_kills_bedwars || 0;
+    /**
+     * Losses
+     * @type {number}
+     */
+    this.losses = data.losses_bedwars || 0;
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = data.deaths_bedwars || 0;
+    /**
+     * Final deaths
+     * @type {number}
+     */
+    this.finalDeaths = data.final_deaths_bedwars || 0;
+    /**
+     * Collected items
+     * @type {BedWarsCollectedItems}
+     */
+    this.collectedItemsTotal = {
+      iron: data.iron_resources_collected_bedwars || 0,
+      gold: data.gold_resources_collected_bedwars || 0,
+      diamond: data.diamond_resources_collected_bedwars || 0,
+      emerald: data.emerald_resources_collected_bedwars || 0
+    };
+    /**
+     * Beds lost/broken/BL Ratio
+     * @type {BedWarsBeds}
+     */
+    this.beds = {
+      lost: data.beds_lost_bedwars || 0,
+      broken: data.beds_broken_bedwars || 0,
+      BLRatio: divide(data.beds_broken_bedwars, data.beds_lost_bedwars)
+    };
+    /**
+     * Average Kills/Final kills/Beds broken
+     * @type {BedWarsAvg}
+     */
+    this.avg = {
+      kills: divide(this.kills, this.playedGames),
+      finalKills: divide(this.finalKills, this.playedGames),
+      bedsBroken: divide(this.beds.broken, this.playedGames)
+    };
+    /**
+     * Kill Death ratio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Final kill death ratio
+     * @type {number}
+     */
+    this.finalKDRatio = divide(this.finalKills, this.finalDeaths);
+    /**
+     * Win Loss ratio
+     * @type {number}
+     */
+    this.WLRatio = divide(this.wins, this.losses);
+    /**
+     * BedWars Solo stats
+     * @type {BedWarsModeStats}
+     */
+    this.solo = generateStatsForMode(data, 'eight_one');
+    /**
+     * BedWars Doubles stats
+     * @type {BedWarsModeStats}
+     */
+    this.doubles = generateStatsForMode(data, 'eight_two');
+    /**
+     * BedWars 3v3v3v3 stats
+     * @type {BedWarsModeStats}
+     */
+    this.threes = generateStatsForMode(data, 'four_three');
+    /**
+     * BedWars 4v4v4v4 stats
+     * @type {BedWarsModeStats}
+     */
+    this.fours = generateStatsForMode(data, 'four_four');
+    /**
+     * BedWars 4v4 stats
+     * @type {BedWarsModeStats}
+     */
+    this['4v4'] = generateStatsForMode(data, 'two_four');
+    /**
+     * BedWars Dream Mode Stats
+     * @type {BedwarsDreamStats}
+     */
+    this.dream = ['ultimate', 'rush', 'armed', 'lucky', 'voidless'].reduce(
+      (ac, mode) => ({
+        [mode]: {
+          doubles: generateStatsForMode(data, `eight_two_${mode}`),
+          fours: generateStatsForMode(data, `four_four_${mode}`)
+        },
+        ...ac
+      }),
+      {}
+    );
+    /**
+     * BedWars Castle Stats
+     * @type {BedWarsModeStats}
+     */
+    this.castle = generateStatsForMode(data, 'castle');
+    /**
+     * BedWars Practice Stats
+     * @type {BedWarsPracticeStats}
+     */
+    this.practice = generateStatsForPractice(data);
+    /**
+     * Bedwars Slumber Tickets
+     * @type {number}
+     */
+    this.slumberTickets = data.slumber?.tickets ?? 0;
+    /**
+     * Bedwars Slumber Total Tickets
+     * @type {number}
+     */
+    this.totalSlumberTicket = data.slumber?.total_tickets ?? 0;
+  }
+}
 /**
  * @typedef {string} BedWarsPrestige
  * * `Stone`
@@ -523,9 +526,9 @@ function generateStatsForPractice(data) {
  */
 /**
  * @typedef {Object} BedWarsPracticeRecords
- * @property {BedWarsPracticeRecord} 30Blocks 30 Blocks
- * @property {BedWarsPracticeRecord} 50Blocks 50 Blocks
- * @property {BedWarsPracticeRecord} 100Blocks 100 Blocks
+ * @property {BedWarsPracticeRecord} blocks30 30 Blocks
+ * @property {BedWarsPracticeRecord} blocks50 50 Blocks
+ * @property {BedWarsPracticeRecord} blocks100 100 Blocks
  */
 /**
  * @typedef {Object} BedWarsPracticeBridging