hypixel-api-reborn 11.2.1 → 11.3.0

package/src/structures/MiniGames/SmashHeroes.js

@@ -1,38 +1,106 @@
 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}`])
-  };
+class SmashHeroesMode {
+  /**
+   * @param {object} data SmashHeroes data
+   * @param {string} mode SmashHeores mode
+   */
+  constructor(data, mode) {
+    /**
+     * kills
+     * @type {number}
+     */
+    this.kills = data[`kills_${mode}`] || 0;
+    /**
+     * deaths
+     * @type {number}
+     */
+    this.deaths = data[`deaths_${mode}`] || 0;
+    /**
+     * KDRatio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * wins
+     * @type {number}
+     */
+    this.wins = data[`wins_${mode}`] || 0;
+    /**
+     * losses
+     * @type {number}
+     */
+    this.losses = data[`losses_${mode}`] || 0;
+    /**
+     * WLRatio
+     * @type {number}
+     */
+    this.WLRatio = divide(this.wins, this.losses);
+  }
 }
 
-// eslint-disable-next-line jsdoc/require-jsdoc
-function generateHeroStats(data) {
-  const stats = [];
-  for (const hero in data.class_stats) {
-    if (Object.prototype.hasOwnProperty.call(data.class_stats, hero)) {
-      stats.push({
-        name: hero,
-        level: data[`lastLevel_${hero}`] || 0,
-        xp: data[`xp_${hero}`] || 0,
-        prestige: data[`pg_${hero}`] || 0,
-        playedGames: data.class_stats[hero].games || 0,
-        kills: data.class_stats[hero].kills || 0,
-        deaths: data.class_stats[hero].deaths || 0,
-        KDRatio: divide(data.class_stats[hero].kills, data.class_stats[hero].deaths),
-        wins: data.class_stats[hero].wins || 0,
-        losses: data.class_stats[hero].losses || 0,
-        WLRatio: divide(data.class_stats[hero].wins, data.class_stats[hero].losses)
-      });
-    }
+class SmashHeoresHero {
+  /**
+   * @param {object} data SmashHeroes data
+   * @param {string} hero Hero name
+   */
+  constructor(data, hero) {
+    /**
+     * Hero Name
+     * @type {string}
+     */
+    this.name = hero;
+    /**
+     * Level
+     * @type {number}
+     */
+    this.level = data[`lastLevel_${hero}`] || 0;
+    /**
+     * Xp
+     * @type {number}
+     */
+    this.xp = data[`xp_${hero}`] || 0;
+    /**
+     * Prestige
+     * @type {number}
+     */
+    this.prestige = data[`pg_${hero}`] || 0;
+    /**
+     * Played Games
+     * @type {number}
+     */
+    this.playedGames = data.class_stats?.[hero]?.games || 0;
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills = data.class_stats?.[hero]?.kills || 0;
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = data.class_stats?.[hero]?.deaths || 0;
+    /**
+     * KDRatio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data.class_stats?.[hero]?.wins || 0;
+    /**
+     * Losses
+     * @type {number}
+     */
+    this.losses = data.class_stats?.[hero]?.losses || 0;
+    /**
+     * WLRatio
+     * @type {number}
+     */
+    this.WLRatio = divide(this.wins, this.losses);
   }
-  return stats;
 }
 
 /**
@@ -93,54 +161,112 @@ class SmashHeroes {
      * @type {number}
      */
     this.WLRatio = divide(this.wins, this.losses);
+    /**
+     * Smashed
+     * @type {number}
+     */
+    this.smashed = data.smashed || 0;
+    /**
+     * Stats for each mode
+     * @type {SmashHeroesMode}
+     */
+    this['1v1v1v1'] = new SmashHeroesMode(data, 'normal');
     /**
      * Stats for each mode
-     * @type {SmashHeroesModes}
+     * @type {SmashHeroesMode}
      */
-    this.mode = {
-      '1v1v1v1': generateModeStats(data, 'normal'),
-      '2v2': generateModeStats(data, '2v2'),
-      '2v2v2': generateModeStats(data, 'teams')
-    };
+    this['2v2'] = new SmashHeroesMode(data, '2v2');
+    /**
+     * Stats for each mode
+     * @type {SmashHeroesMode}
+     */
+    this['2v2v2'] = new SmashHeroesMode(data, 'teams');
     /**
      * Active class
      * @type {string}
      */
-    this.activeClass = data.active_class ?? null;
+    this.activeClass = data.active_class || null;
+    /**
+     * The Bulk
+     * @type {SmashHeoresHero}
+     */
+    this.theBulk = new SmashHeoresHero(data, 'THE_BULK');
+    /**
+     * Cake Monster
+     * @type {SmashHeoresHero}
+     */
+    this.cakeMonster = new SmashHeoresHero(data, 'CAKE_MONSTER');
+    /**
+     * General Cluck
+     * @type {SmashHeoresHero}
+     */
+    this.generalCluck = new SmashHeoresHero(data, 'GENERAL_CLUCK');
+    /**
+     * Botmun
+     * @type {SmashHeoresHero}
+     */
+    this.botmun = new SmashHeoresHero(data, 'BOTMUN');
+    /**
+     * Marauder
+     * @type {SmashHeoresHero}
+     */
+    this.marauder = new SmashHeoresHero(data, 'MARAUDER');
+    /**
+     * Pug
+     * @type {SmashHeoresHero}
+     */
+    this.pug = new SmashHeoresHero(data, 'PUG');
+    /**
+     * Tinman
+     * @type {SmashHeoresHero}
+     */
+    this.tinman = new SmashHeoresHero(data, 'TINMAN');
+    /**
+     * Spoderman
+     * @type {SmashHeoresHero}
+     */
+    this.spoderman = new SmashHeoresHero(data, 'SPODERMAN');
+    /**
+     * Frosty
+     * @type {SmashHeoresHero}
+     */
+    this.frosty = new SmashHeoresHero(data, 'FROSTY');
+    /**
+     * Sergeant Shield
+     * @type {SmashHeoresHero}
+     */
+    this.sergeantShield = new SmashHeoresHero(data, 'SERGEANT_SHIELD');
+    /**
+     * Skullfire
+     * @type {SmashHeoresHero}
+     */
+    this.skullfire = new SmashHeoresHero(data, 'SKULLFIRE');
+    /**
+     * Goku
+     * @type {SmashHeoresHero}
+     */
+    this.goku = new SmashHeoresHero(data, 'GOKU');
+    /**
+     * Sanic
+     * @type {SmashHeoresHero}
+     */
+    this.sanic = new SmashHeoresHero(data, 'SANIC');
+    /**
+     * Dusk Crawler
+     * @type {SmashHeoresHero}
+     */
+    this.duskCrawler = new SmashHeoresHero(data, 'DUSK_CRAWLER');
+    /**
+     * Shoop Da Whoop
+     * @type {SmashHeoresHero}
+     */
+    this.shoopDaWhoop = new SmashHeoresHero(data, 'SHOOP_DA_WHOOP');
     /**
-     * Stats for each class
-     * @type {SmashHeroesClassStats[]|null}
+     * Green Hood
+     * @type {SmashHeoresHero}
      */
-    this.heroStats = data.class_stats ? generateHeroStats(data) : null;
+    this.greenHood = new SmashHeoresHero(data, 'GREEN_HOOD');
   }
 }
-/**
- * @typedef {object} SmashHeroesModes
- * @property {SmashHeroesModeStats} '1v1v1v1' 1v1v1v1
- * @property {SmashHeroesModeStats} '2v2' 2v2
- * @property {SmashHeroesModeStats} '2v2v2' 2v2v2
- */
-/**
- * @typedef {object} SmashHeroesModeStats
- * @property {number} kills Kills
- * @property {number} deaths Deaths
- * @property {number} KDRatio Kill/Death ratio
- * @property {number} wins Wins
- * @property {number} losses Losses
- * @property {number} WLRatio Win/Loss ratio
- */
-/**
- * @typedef {object} SmashHeroesClassStats
- * @property {string} name Name
- * @property {number} level Level
- * @property {number} xp XP
- * @property {number} prestige Prestige
- * @property {number} playedGames Played games
- * @property {number} kills Kills
- * @property {number} deaths Deaths
- * @property {number} KDRatio Kill/Death ratio
- * @property {number} wins Wins
- * @property {number} losses Losses
- * @property {number} WLRatio Win/Loss ratio
- */
+
 module.exports = SmashHeroes;

package/src/structures/MiniGames/SpeedUHC.js

@@ -1,4 +1,54 @@
 const divide = require('../../utils/divide');
+
+class SpeedUHCMode {
+  /**
+   * @param {object} data Speed UHC data
+   * @param {string} data Speed UHC data
+   */
+  constructor(data, mode) {
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills = data[`kills_${mode}`] || 0;
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = data[`deaths_${mode}`] || 0;
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data[`wins_${mode}`] || 0;
+    /**
+     * Losses
+     * @type {number}
+     */
+    this.losses = data[`losses_${mode}`] || 0;
+    /**
+     * Played Games
+     * @type {number}
+     */
+    this.playedGames = data[`games_${mode}`] || 0;
+    /**
+     * Winstreak
+     * @type {number}
+     */
+    this.winstreak = data[`win_streak_${mode}`] || 0;
+    /**
+     * Kill Streak
+     * @type {number}
+     */
+    this.killStreak = data[`killstreak_${mode}`] || 0;
+    /**
+     * Assists
+     * @type {number}
+     */
+    this.assists = data[`assists_${mode}`] || 0;
+  }
+}
+
 /**
  * Speed UHC class
  */
@@ -84,45 +134,35 @@ class SpeedUHC {
     this.assists = data.assists || 0;
     /**
      * Solo
-     * @type {SpeedUHCModeStats}
-     */
-    this.solo = {
-      kills: data.kills_solo || 0,
-      deaths: data.deaths_solo || 0,
-      wins: data.wins_solo || 0,
-      losses: data.losses_solo || 0,
-      playedGames: data.games_solo || 0,
-      winStreak: data.win_streak_solo || 0,
-      killStreak: data.killstreak_solo || 0,
-      assists: data.assists_solo || 0
-    };
+     * @type {SpeedUHCMode}
+     */
+    this.solo = new SpeedUHCMode(data, 'solo');
+    /**
+     * Solo Normal
+     * @type {SpeedUHCMode}
+     */
+    this.soloNormal = new SpeedUHCMode(data, 'solo_normal');
+    /**
+     * Solo Insane
+     * @type {SpeedUHCMode}
+     */
+    this.soloInsane = new SpeedUHCMode(data, 'solo_insane');
     /**
      * Team
-     * @type {SpeedUHCModeStats}
-     */
-    this.teams = {
-      kills: data.kills_team || 0,
-      deaths: data.deaths_team || 0,
-      wins: data.wins_team || 0,
-      losses: data.losses_team || 0,
-      playedGames: data.games_team || 0,
-      winStreak: data.win_streak_team || 0,
-      killStreak: data.killstreak_team || 0,
-      assists: data.assists_team || 0
-    };
+     * @type {SpeedUHCMode}
+     */
+    this.team = new SpeedUHCMode(data, 'team');
+    /**
+     * Team Normal
+     * @type {SpeedUHCMode}
+     */
+    this.teamNormal = new SpeedUHCMode(data, 'team_normal');
+    /**
+     * Team Insane
+     * @type {SpeedUHCMode}
+     */
+    this.teamInsane = new SpeedUHCMode(data, 'team_insane');
   }
 }
 
-/**
- * @typedef {object} SpeedUHCModeStats
- * @property {number} kills Kills
- * @property {number} deaths Deaths
- * @property {number} wins Wins
- * @property {number} losses Losses
- * @property {number} playedGames Played games
- * @property {number} winStreak Win streak
- * @property {number} killStreak Kill streak
- * @property {number} assists Assists
- */
-
 module.exports = SpeedUHC;