hypixel-api-reborn 11.2.1 → 11.3.0

package/src/structures/MiniGames/ArenaBrawl.js

@@ -1,15 +1,64 @@
 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 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
  */
@@ -23,30 +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 {ArenaBrawlMode}
+     */
+    this['1v1'] = new ArenaBrawlMode(data, '1v1');
     /**
      * ArenaBrawl mode stats
-     * @type {ArenaBrawlStats}
+     * @type {ArenaBrawlMode}
      */
-    this.mode = {
-      '1v1': generateModeStats(data, '1v1'),
-      '2v2': generateModeStats(data, '2v2'),
-      '4v4': generateModeStats(data, '4v4')
-    };
+    this['2v2'] = new ArenaBrawlMode(data, '2v2');
+    /**
+     * ArenaBrawl mode stats
+     * @type {ArenaBrawlMode}
+     */
+    this['4v4'] = new ArenaBrawlMode(data, '4v4');
   }
 }
-/**
- * @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/BlitzSurvivalGames.js

@@ -1,71 +1,109 @@
 const divide = require('../../utils/divide');
-const kits = [
-  'arachnologist',
-  'archer',
-  'armorer',
-  'astronaut',
-  'baker',
-  'blaze',
-  'creepertamer',
-  'fisherman',
-  'horsetamer',
-  'hunter',
-  'knight',
-  'meatmaster',
-  'necromancer',
-  'pigman',
-  'reddragon',
-  'rogue',
-  'scout',
-  'slimeyslime',
-  'speleologist',
-  'tim',
-  'toxicologist',
-  'troll',
-  'wolftamer',
-  'paladin',
-  'shadow knight',
-  'hype train',
-  'jockey',
-  'reaper',
-  'golem',
-  'farmer',
-  'florist',
-  'snowman',
-  'guardian',
-  'warlock',
-  'viking',
-  'diver',
-  'ranger',
-  'donkeytamer',
-  'phoenix',
-  'warrior',
-  'rambo'
-];
 
-// eslint-disable-next-line jsdoc/require-jsdoc
-function generateKitStats(data) {
-  const stats = [];
-  for (let i = 0; i < kits.length; i++) {
-    if (data[kits[i]]) {
-      stats.push({
-        name: kits[i],
-        games: data[`games_played_${kits[i]}`] || 0,
-        level: data[kits[i]] + 1 || 1,
-        experience: data[`exp_${kits[i]}`] || 0,
-        prestige: data[`p${kits[i]}`] || 0,
-        kills: data[`kills_${kits[i]}`] || 0,
-        deaths: data[`deaths_${kits[i]}`] || 0,
-        KDRatio: divide(data[`kills_${kits[i]}`], data[`deaths_${kits[i]}`]),
-        wins: data[`wins_${kits[i]}`] || 0,
-        losses: data[`losses_${kits[i]}`] || 0,
-        WLRatio: divide(data[`wins_${kits[i]}`], data[`losses_${kits[i]}`]),
-        timePlayed: data[`time_played_${kits[i]}`] || null
-      });
-    }
+class BlitzSGKit {
+  /**
+   * @param {object} data Blitz SG data
+   * @param {string} kitName Kit name
+   */
+  constructor(data, kitName) {
+    /**
+     * Kit Level
+     * @type {number}
+     */
+    this.level = data[kitName] || 0;
+    /**
+     * Kit Level
+     * @type {number}
+     */
+    this.exp = data[`exp_${kitName}`] || 0;
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills = data[`kills_${kitName}`] || 0;
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = data[`deaths_${kitName}`] || 0;
+    /**
+     * Kill Death ratio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data[`wins_${kitName}`] || 0;
+    /**
+     * Games Played
+     * @type {number}
+     */
+    this.gamesPlayed = data[`games_played_${kitName}`] || 0;
+    /**
+     * Losses
+     * @type {number}
+     */
+    this.losses = this.gamesPlayed - this.wins;
+    /**
+     * Win Loss ratio
+     * @type {number}
+     */
+    this.WLRatio = divide(this.wins, this.losses);
+    /**
+     * Arrows Shot
+     * @type {number}
+     */
+    this.arrowsShot = data[`arrows_fired_${kitName}`] || 0;
+    /**
+     * Arrows Hit
+     * @type {number}
+     */
+    this.arrowsHit = data[`arrows_hit_${kitName}`] || 0;
+    /**
+     * Bow Accuracy
+     * @type {number}
+     */
+    this.bowAccuracy = divide(this.arrowsHit, this.arrowsShot);
+    /**
+     * Damage Delt
+     * @type {number}
+     */
+    this.damage = data[`damage_${kitName}`] || 0;
+    /**
+     * Damage Taken
+     * @type {number}
+     */
+    this.damageTaken = data[`damage_taken_${kitName}`] || 0;
+    /**
+     * Potions Drunk
+     * @type {number}
+     */
+    this.potionsDrunk = data[`potions_drunk_${kitName}`] || 0;
+    /**
+     * Potions Thrown
+     * @type {number}
+     */
+    this.potionsThrown = data[`potions_thrown_${kitName}`] || 0;
+    /**
+     * Time Played (In seconds)
+     * @type {number}
+     */
+    this.playTime = data[`time_played_${kitName}`] || 0;
+    /**
+     * Mobs Spawned
+     * @type {number}
+     */
+    this.mobsSpawned = data[`mobs_spawned_${kitName}`] || 0;
+    /**
+     * Chests Opened
+     * @type {number}
+     */
+    this.chestsOpened = data[`chests_opened_${kitName}`] || 0;
   }
-  return stats;
 }
+
 /**
  * Blitz SG class
  */
@@ -84,6 +122,21 @@ class BlitzSurvivalGames {
      * @type {number}
      */
     this.kills = data.kills || 0;
+    /**
+     * Kit
+     * @type {string}
+     */
+    this.kit = data.defaultkit || '';
+    /**
+     * Solo Kills
+     * @type {number}
+     */
+    this.killsSolo = data.kills_solo_normal || 0;
+    /**
+     * Teams Kills
+     * @type {number}
+     */
+    this.killsTeams = data.kills_teams_normal || 0;
     /**
      * Deaths
      * @type {number}
@@ -94,80 +147,278 @@ class BlitzSurvivalGames {
      * @type {number}
      */
     this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data.wins || 0;
     /**
      * Solo wins
      * @type {number}
      */
-    this.winsSolo = data.wins || 0;
+    this.winsSolo = data.wins_solo_normal || 0;
     /**
      * Team wins
      * @type {number}
      */
     this.winsTeam = data.wins_teams || 0;
     /**
-     * Stats for each kit
-     * @type {BlitzSGKitStats[]}
+     * Games Played
+     * @type {number}
+     */
+    this.gamesPlayed = data.games_played || 0;
+    /**
+     * Losses
+     * @type {number}
+     */
+    this.losses = this.gamesPlayed - this.wins;
+    /**
+     * Win Loss ratio
+     * @type {number}
+     */
+    this.WLRatio = divide(this.wins, this.losses);
+    /**
+     * Arrows Shot
+     * @type {number}
+     */
+    this.arrowsShot = data.arrows_fired || 0;
+    /**
+     * Arrows Hit
+     * @type {number}
+     */
+    this.arrowsHit = data.arrows_hit || 0;
+    /**
+     * Bow Accuracy
+     * @type {number}
+     */
+    this.bowAccuracy = divide(this.arrowsHit, this.arrowsShot);
+    /**
+     * Damage Delt
+     * @type {number}
+     */
+    this.damage = data.damage || 0;
+    /**
+     * Damage Taken
+     * @type {number}
+     */
+    this.damageTaken = data.damage_taken || 0;
+    /**
+     * Potions Drunk
+     * @type {number}
+     */
+    this.potionsDrunk = data.potions_drunk || 0;
+    /**
+     * Potions Thrown
+     * @type {number}
+     */
+    this.potionsThrown = data.potions_thrown || 0;
+    /**
+     * Mobs Spawned
+     * @type {number}
+     */
+    this.mobsSpawned = data.mobs_spawned || 0;
+    /**
+     * Time Played (In seconds)
+     * @type {number}
+     */
+    this.playTime = data.time_played || 0;
+    /**
+     * Blitz Uses
+     * @type {number}
+     */
+    this.blitzUses = data.blitz_uses || 0;
+    /**
+     * Chests Opened
+     * @type {number}
+     */
+    this.chestsOpened = data.chests_opened || 0;
+
+    /**
+     * Archer Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.archer = new BlitzSGKit(data, 'archer');
+    /**
+     * Meatmaster Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.meatmaster = new BlitzSGKit(data, 'meatmaster');
+    /**
+     * Speleologist Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.speleologist = new BlitzSGKit(data, 'speleologist');
+    /**
+     * Baker Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.baker = new BlitzSGKit(data, 'baker');
+    /**
+     * Knight Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.knight = new BlitzSGKit(data, 'knight');
+    /**
+     * Guardian Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.guardian = new BlitzSGKit(data, 'guardian');
+    /**
+     * Scout Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.scout = new BlitzSGKit(data, 'scout');
+    /**
+     * Hunter Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.hunter = new BlitzSGKit(data, 'hunter');
+    /**
+     * Hype Train Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.hypeTrain = new BlitzSGKit(data, 'hype train');
+    /**
+     * Fisherman Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.fisherman = new BlitzSGKit(data, 'fisherman');
+    /**
+     * Armorer Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.armorer = new BlitzSGKit(data, 'armorer');
+    /**
+     * Horsetamer Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.horsetamer = new BlitzSGKit(data, 'horsetamer');
+    /**
+     * Astronaut Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.astronaut = new BlitzSGKit(data, 'astronaut');
+    /**
+     * Troll Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.troll = new BlitzSGKit(data, 'troll');
+    /**
+     * Reaper Kit Stats
+     * @type {BlitzSGKit}
      */
-    this.kitStats = generateKitStats(data);
+    this.reaper = new BlitzSGKit(data, 'reaper');
+    /**
+     * Shark Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.shark = new BlitzSGKit(data, 'shark');
+    /**
+     * Reddragon Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.reddragon = new BlitzSGKit(data, 'reddragon');
+    /**
+     * Toxicologist Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.toxicologist = new BlitzSGKit(data, 'toxicologist');
+    /**
+     * Rogue Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.rogue = new BlitzSGKit(data, 'rogue');
+    /**
+     * Warlock Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.warlock = new BlitzSGKit(data, 'warlock');
+    /**
+     * Slimeyslime Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.slimeyslime = new BlitzSGKit(data, 'slimeyslime');
+    /**
+     * Jockey Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.jockey = new BlitzSGKit(data, 'jockey');
+    /**
+     * Golem Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.golem = new BlitzSGKit(data, 'golem');
+    /**
+     * Viking Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.viking = new BlitzSGKit(data, 'viking');
+    /**
+     * Shadow Knight Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.shadowKnight = new BlitzSGKit(data, 'shadow knight');
+    /**
+     * Pigman Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.pigman = new BlitzSGKit(data, 'pigman');
+    /**
+     * Paladin Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.paladin = new BlitzSGKit(data, 'paladin');
+    /**
+     * Necromancer Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.necromancer = new BlitzSGKit(data, 'necromancer');
+    /**
+     * Florist Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.florist = new BlitzSGKit(data, 'florist');
+    /**
+     * Diver Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.diver = new BlitzSGKit(data, 'diver');
+    /**
+     * Arachnologist Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.arachnologist = new BlitzSGKit(data, 'arachnologist');
+    /**
+     * Blaze Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.blaze = new BlitzSGKit(data, 'blaze');
+    /**
+     * Wolftamer Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.wolftamer = new BlitzSGKit(data, 'wolftamer');
+    /**
+     * Tim Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.tim = new BlitzSGKit(data, 'tim');
+    /**
+     * Farmer Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.farmer = new BlitzSGKit(data, 'farmer');
+    /**
+     * Creepertamer Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.creepertamer = new BlitzSGKit(data, 'creepertamer');
+    /**
+     * Snowman Kit Stats
+     * @type {BlitzSGKit}
+     */
+    this.snowman = new BlitzSGKit(data, 'snowman');
   }
 }
-/**
- * @typedef {string} BlitzSGKit
- * * `arachnologist`
- * * `archer`
- * * `armorer`
- * * `astronaut`
- * * `baker`
- * * `blaze`
- * * `creepertamer`
- * * `fisherman`
- * * `horsetamer`
- * * `hunter`
- * * `knight`
- * * `meatmaster`
- * * `necromancer`
- * * `pigman`
- * * `reddragon`
- * * `rogue`
- * * `scout`
- * * `slimeyslime`
- * * `speleologist`
- * * `tim`
- * * `toxicologist`
- * * `troll`
- * * `wolftamer`
- * * `paladin`
- * * `shadow knight`
- * * `hype train`
- * * `jockey`
- * * `reaper`
- * * `golem`
- * * `farmer`
- * * `florist`
- * * `snowman`
- * * `guardian`
- * * `warlock`
- * * `viking`
- * * `diver`
- * * `ranger`
- * * `donkeytamer`
- * * `phoenix`
- * * `warrior`
- * * `rambo`
- */
-/**
- * @typedef {object} BlitzSGKitStats
- * @property {BlitzSGKit} name Kit name
- * @property {number} games Played games
- * @property {number} level level
- * @property {number} experience Total experience
- * @property {number} prestige Prestige
- * @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
- * @property {number|null} timePlayed Time played
- */
+
 module.exports = BlitzSurvivalGames;