hypixel-api-reborn 11.2.0 → 11.2.1

package/src/structures/MiniGames/SkyWars.js

@@ -1,7 +1,9 @@
+const { removeSnakeCaseString } = require('../../utils/removeSnakeCase');
 const { SkyWarsPrestigeIcons } = require('../../utils/Constants');
 const divide = require('../../utils/divide');
-const { removeSnakeCaseString } = require('../../utils/removeSnakeCase');
-const generateStatsForMode = (data, mode) => {
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+function generateStatsForMode(data, mode) {
   return {
     kills: data[`kills_${mode}`] || 0,
     deaths: data[`deaths_${mode}`] || 0,
@@ -10,14 +12,204 @@ const generateStatsForMode = (data, mode) => {
     KDRatio: divide(data[`kills_${mode}`], data[`deaths_${mode}`]),
     WLRatio: divide(data[`wins_${mode}`], data[`losses_${mode}`])
   };
-};
+}
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+function getSkyWarsPrestige(level) {
+  if (60 <= level) return 'Mythic';
+  return (
+    ['Iron', 'Iron', 'Gold', 'Diamond', 'Emerald', 'Sapphire', 'Ruby', 'Crystal', 'Opal', 'Amethyst', 'Rainbow'][
+      Math.floor(level / 5)
+    ] || 'Iron'
+  );
+}
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+function getSkyWarsLevel(xp) {
+  const totalXp = [0, 2, 7, 15, 25, 50, 100, 200, 350, 600, 1000, 1500];
+  if (15000 <= xp) return Math.floor((xp - 15000) / 10000 + 12);
+  const level = totalXp.findIndex((x) => 0 < x * 10 - xp);
+  return level;
+}
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+function getSkyWarsLevelProgress(xp) {
+  const totalXp = [0, 2, 7, 15, 25, 50, 100, 200, 350, 600, 1000, 1500];
+  const xpToNextLvl = [0, 2, 5, 8, 10, 25, 50, 100, 150, 250, 400, 500];
+  let percent;
+  let xpToNextLevel;
+  let currentLevelXp = xp;
+  if (15000 <= xp) {
+    currentLevelXp -= 15000;
+    if (0 === currentLevelXp) return { currentLevelXp: 0, xpToNextLevel: 10000, percent: 0, xpNextLevel: 10000 };
+    if (10000 < currentLevelXp) {
+      do {
+        currentLevelXp -= 10000;
+      } while (10000 <= currentLevelXp);
+    }
+    xpToNextLevel = 10000 - currentLevelXp;
+    percent = Math.round(currentLevelXp) / 100;
+    const percentRemaining = Math.round((100 - percent) * 100) / 100;
+    return {
+      currentLevelXp,
+      xpToNextLevel,
+      percent,
+      xpNextLevel: 10000,
+      percentRemaining
+    };
+  }
+  const totalXptoNextLevel = xpToNextLvl[totalXp.findIndex((x) => 0 < x * 10 - xp)] * 10;
+  for (let i = 0; i < xpToNextLvl.length; i++) {
+    if (0 > currentLevelXp - xpToNextLvl[i] * 10) break;
+    currentLevelXp -= xpToNextLvl[i] * 10;
+  }
+  xpToNextLevel = totalXptoNextLevel - currentLevelXp;
+  percent = Math.round((currentLevelXp / totalXptoNextLevel) * 10000) / 100;
+  return {
+    currentLevelXp,
+    xpToNextLevel,
+    percent,
+    xpNextLevel: totalXptoNextLevel
+  };
+}
+
+/**
+ * Parses SkyWars Kit
+ */
+class SkywarsKit {
+  /**
+   * Constructor
+   * @param {string} kit Kit
+w   */
+  constructor(kit) {
+    /**
+     * Kit data
+     * @private
+     * @type {string[] | null}
+     */
+    this.kitData = kit.match(/^kit_([a-z]+)_([a-z]+)_([a-z]+)$/);
+    /**
+     * Is this a kit
+     * @type {boolean}
+     */
+    this.isKit = Boolean(this.kitData);
+    if (!this.kitData) return;
+    /**
+     * Game mode the kit is for
+     * @type {KitGameModes}
+     */
+    this.gameMode = this.kitData[2];
+    /**
+     * Kit type
+     * @type {KitType}
+     */
+    this.kitType = this.kitData[1];
+    /**
+     * Kit name in camelCase
+     * @type {string}
+     */
+    this.kitName = removeSnakeCaseString(this.kitData[3]);
+  }
+}
+
+/**
+ * Parses SkyWars Kits
+ */
+class SkywarsKits {
+  /**
+   * Constructor
+   * @param {SkywarsKit[]} kits Potential Kits
+w   */
+  constructor(kits) {
+    this.kits = kits.map((kit) => new SkywarsKit(kit)).filter((kit) => kit.isKit);
+  }
+  /**
+   * Get kit by type/gameMode
+   * @param {KitGameModes} [gameMode] Kits in said game mode
+   * @param {KitType} [type] Kits corresponding to this type
+   * @returns {SkywarsKit[]}
+w   */
+  get(gameMode = '', type = '') {
+    return this.kits.filter((kit) => kit.gameMode.startsWith(gameMode) && kit.kitType.startsWith(type));
+  }
+}
+/**
+ * Skywars Packages - parses every package player has
+ */
+class SkywarsPackages {
+  /**
+   * Constructor
+   * @param {string[]} data data from API
+w   */
+  constructor(data) {
+    // TODO : a lot more
+    /**
+     * Raw Packages, as received from the API
+     * @type {string[]}
+     */
+    this.rawPackages = Array.from(data);
+    /**
+     * Cages
+     * @type {string[]}
+     */
+    this.cages = this.parseCages();
+    /**
+     * Kits
+     * @type {SkywarsKits}
+     */
+    this.kits = new SkywarsKits(data);
+    /**
+     * Achievements included in packages, under the form of name0
+     * @type {string[]}
+     */
+    this.achievements = this.rawPackages
+      .map((pkg) => pkg.match(/^([A-Za-z]+)_?achievement([0-9]?)$/))
+      .filter((x) => x)
+      .map((x) => x.slice(1).join(''));
+  }
+  /**
+   * Parses cages
+   * @returns {string[]}
+w   */
+  parseCages() {
+    return this.rawPackages
+      .map((pkg) => pkg.match(/^cage_([A-Za-z]+)-cage$/))
+      .filter((x) => x)
+      .map((x) => x[1].replace(/-[a-z]/g, (x) => x[1].toUpperCase()));
+  }
+}
+
+/**
+ * @typedef {string} KitType
+ * * basic
+ * * supporting
+ * * mining
+ * * defending
+ * * attacking
+ * * advanced
+ * * enderchest
+ */
+/**
+ * @typedef {string} KitGameModes
+ * * solo
+ * * team
+ */
+
+/**
+ * @typedef {Object} SkyWarsShardsInMode
+ * @property {number} solo Solo shards
+ * @property {number} team Team shards
+ * @property {number} mega Mega shards
+ * @property {number} lab Lab shards
+ */
+
 /**
  * SkyWars class
  */
 class SkyWars {
   /**
    * @param {object} data SkyWars data
-   */
+w   */
   constructor(data) {
     /**
      * Coins
@@ -316,8 +508,7 @@ class SkyWars {
  */
 /**
  * @typedef {string} PseudoDate String date, in the format of MM-YY ( YY is 20YY )
- * @example `10-19` would be October 2019.
- */
+w */
 /**
  * @typedef {Object} SkyWarsModeExtendedStats
  * @property {SkyWarsTotalModeStats} overall Overall Stats
@@ -331,183 +522,3 @@ class SkyWars {
  * @property {SkyWarsModeStats} doubles Mega Doubles Stats
  */
 module.exports = SkyWars;
-// eslint-disable-next-line require-jsdoc
-function getSkyWarsPrestige(level) {
-  if (level >= 60) return 'Mythic';
-  return (
-    ['Iron', 'Iron', 'Gold', 'Diamond', 'Emerald', 'Sapphire', 'Ruby', 'Crystal', 'Opal', 'Amethyst', 'Rainbow'][
-      Math.floor(level / 5)
-    ] || 'Iron'
-  );
-}
-// eslint-disable-next-line require-jsdoc
-function getSkyWarsLevel(xp) {
-  const totalXp = [0, 2, 7, 15, 25, 50, 100, 200, 350, 600, 1000, 1500];
-  if (xp >= 15000) return Math.floor((xp - 15000) / 10000 + 12);
-  const level = totalXp.findIndex((x) => x * 10 - xp > 0);
-  return level; /* + (xp - (totalXp[level - 1] * 10 || 0)) / (totalXp[level] - totalXp[level - 1]) / 10*/
-}
-// eslint-disable-next-line require-jsdoc
-function getSkyWarsLevelProgress(xp) {
-  const totalXp = [0, 2, 7, 15, 25, 50, 100, 200, 350, 600, 1000, 1500];
-  const xpToNextLvl = [0, 2, 5, 8, 10, 25, 50, 100, 150, 250, 400, 500]; // * 10
-  let percent;
-  let xpToNextLevel;
-  let currentLevelXp = xp;
-  if (xp >= 15000) {
-    currentLevelXp -= 15000;
-    if (currentLevelXp === 0) return { currentLevelXp: 0, xpToNextLevel: 10000, percent: 0, xpNextLevel: 10000 };
-    if (currentLevelXp > 10000) {
-      do {
-        currentLevelXp -= 10000;
-      } while (currentLevelXp >= 10000);
-    }
-    xpToNextLevel = 10000 - currentLevelXp;
-    percent = Math.round(currentLevelXp) / 100;
-    const percentRemaining = Math.round((100 - percent) * 100) / 100;
-    return {
-      currentLevelXp,
-      xpToNextLevel,
-      percent,
-      xpNextLevel: 10000,
-      percentRemaining
-    };
-  }
-  const totalXptoNextLevel = xpToNextLvl[totalXp.findIndex((x) => x * 10 - xp > 0)] * 10;
-  for (let i = 0; i < xpToNextLvl.length; i++) {
-    if (currentLevelXp - xpToNextLvl[i] * 10 < 0) break;
-    currentLevelXp -= xpToNextLvl[i] * 10;
-  }
-  xpToNextLevel = totalXptoNextLevel - currentLevelXp;
-  percent = Math.round((currentLevelXp / totalXptoNextLevel) * 10000) / 100;
-  return {
-    currentLevelXp,
-    xpToNextLevel,
-    percent,
-    xpNextLevel: totalXptoNextLevel
-  };
-}
-const ratingRegex = /^SkyWars_skywars_rating_(\d{1,2})_(\d{1,2})_(position|rating)$/;
-
-/**
- * Skywars Packages - parses every package player has
- */
-class SkywarsPackages {
-  /**
-   * Constructor
-   * @param {string[]} data data from API
-   */
-  constructor(data) {
-    // TODO : a lot more
-    /**
-     * Raw Packages, as received from the API
-     * @type {string[]}
-     */
-    this.rawPackages = Array.from(data);
-    /**
-     * Cages
-     * @type {string[]}
-     */
-    this.cages = this._parseCages();
-    /**
-     * Kits
-     * @type {SkywarsKits}
-     */
-    this.kits = new SkywarsKits(data);
-    /**
-     * Achievements included in packages, under the form of name0
-     * @type {string[]}
-     */
-    this.achievements = this.rawPackages
-      .map((pkg) => pkg.match(/^([A-z]+)_?achievement([0-9]?)$/))
-      .filter((x) => x)
-      .map((x) => x.slice(1).join(''));
-  }
-  /**
-   * Parses cages
-   * @returns {string[]}
-   */
-  _parseCages() {
-    return this.rawPackages
-      .map((pkg) => pkg.match(/^cage_([A-z]+)-cage$/))
-      .filter((x) => x)
-      .map((x) => x[1].replace(/-[a-z]/g, (x) => x[1].toUpperCase()));
-  }
-}
-
-/**
- * Parses SkyWars Kits
- */
-class SkywarsKit {
-  /**
-   * Constructor
-   * @param {string} kit Kit
-   */
-  constructor(kit) {
-    /**
-     * Kit data
-     * @private
-     * @type {string[] | null}
-     */
-    this._kitData = kit.match(/^kit_([a-z]+)_([a-z]+)_([a-z]+)$/);
-    /**
-     * Is this a kit
-     * @type {boolean}
-     */
-    this.isKit = !!this._kitData;
-    if (!this._kitData) return;
-    /**
-     * Game mode the kit is for
-     * @type {KitGameModes}
-     */
-    this.gameMode = this._kitData[2];
-    /**
-     * Kit type
-     * @type {KitType}
-     */
-    this.kitType = this._kitData[1];
-    /**
-     * Kit name in camelCase
-     * @type {string}
-     */
-    this.kitName = removeSnakeCaseString(this._kitData[3]);
-  }
-}
-
-/**
- * Parses SkyWars Kits
- */
-class SkywarsKits {
-  /**
-   * Constructor
-   * @param {SkywarsKit[]} kits Potential Kits
-   */
-  constructor(kits) {
-    this.kits = kits.map((kit) => new SkywarsKit(kit)).filter((kit) => kit.isKit);
-  }
-  /**
-   * Get kit by type/gameMode
-   * @param {KitGameModes} [gameMode] Kits in said game mode
-   * @param {KitType} [type] Kits corresponding to this type
-   * @returns {SkywarsKit[]}
-   */
-  get(gameMode = '', type = '') {
-    return this.kits.filter((kit) => kit.gameMode.startsWith(gameMode) && kit.kitType.startsWith(type));
-  }
-}
-
-/**
- * @typedef {string} KitType
- * * basic
- * * supporting
- * * mining
- * * defending
- * * attacking
- * * advanced
- * * enderchest
- */
-/**
- * @typedef {string} KitGameModes
- * * solo
- * * team
- */

package/src/structures/MiniGames/SmashHeroes.js

@@ -1,4 +1,40 @@
 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}`])
+  };
+}
+
+// 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)
+      });
+    }
+  }
+  return stats;
+}
+
 /**
  * SmashHeroes class
  */
@@ -78,40 +114,6 @@ class SmashHeroes {
     this.heroStats = data.class_stats ? generateHeroStats(data) : null;
   }
 }
-// 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}`])
-  };
-}
-// eslint-disable-next-line require-jsdoc
-function generateHeroStats(data) {
-  // eslint-disable-next-line no-useless-return
-  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)
-      });
-    }
-  }
-  return stats;
-}
 /**
  * @typedef {object} SmashHeroesModes
  * @property {SmashHeroesModeStats} '1v1v1v1' 1v1v1v1

package/src/structures/MiniGames/SpeedUHC.js

@@ -92,8 +92,8 @@ class SpeedUHC {
       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,
+      winStreak: data.win_streak_solo || 0,
+      killStreak: data.killstreak_solo || 0,
       assists: data.assists_solo || 0
     };
     /**
@@ -106,10 +106,23 @@ class SpeedUHC {
       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,
+      winStreak: data.win_streak_team || 0,
+      killStreak: data.killstreak_team || 0,
       assists: data.assists_team || 0
     };
   }
 }
+
+/**
+ * @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;

package/src/structures/MiniGames/UHC.js

@@ -1,5 +1,30 @@
-/* eslint-disable max-len */
 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);
+  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];
+  starLevel += sums.map((x) => x * 10 - sum).findIndex((x) => 0 < x) - 1;
+  return starLevel;
+}
+
 /**
  * UHC class
  */
@@ -148,30 +173,6 @@ class UHC {
     };
   }
 }
-// eslint-disable-next-line 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);
-  const sum = kills * 1 + wins * 10;
-  let starLevel = 1;
-  const sums = [0, 1, 6, 21, 46, 96, 171, 271, 521, 1021, 1321, 1621, 1921, 2221, 2521, Infinity];
-  starLevel += sums.map((x) => x * 10 - sum).findIndex((x) => x > 0) - 1;
-  return starLevel;
-}
 /**
  * @typedef {object} UHCModeStats
  * @property {number} kills Kills

package/src/structures/MiniGames/WoolWars.js

@@ -48,7 +48,6 @@ class WoolWars {
       engineer: WoolWars.generateStatsFor(data.wool_wars?.stats, 'engineer'),
       archer: WoolWars.generateStatsFor(data.wool_wars?.stats, 'archer')
     };
-    // Misc fields ig
     /**
      * Owned Cosmetics
      * @type {string[]}
@@ -66,24 +65,26 @@ class WoolWars {
    * @return {number}
    */
   static convertXPToLevel(exp) {
-    const minimalExp = [0, 1e3, 3e3, 6e3, 1e4, 15e3]; // NB: progression is 1k, 2k, 3k, 4k, 5k
+    const minimalExp = [0, 1e3, 3e3, 6e3, 1e4, 15e3];
     const baseLevel = minimalExp.length;
     const baseExp = minimalExp[minimalExp.length - 1];
     const expToLevel100 = 49e4;
     if (exp < baseExp) return minimalExp.findIndex((x) => exp < x);
     const theoreticalLevel = (exp - baseExp) / 5e3 + baseLevel;
-    if (theoreticalLevel > 100) return 100 + this.convertXPToLevel(exp - expToLevel100);
+    if (100 < theoreticalLevel) return 100 + this.convertXPToLevel(exp - expToLevel100);
     return theoreticalLevel;
   }
   /**
    * Generates stats per class/overall
-   * @param {Record<string, unknwon>} data data
+   * @param {Record<string, any>} data data
    * @param {string} [_class=''] Class
    * @return {WoolWarsStats}
    */
   static generateStatsFor(data, _class) {
     // N.B i called it _class instead of class because reserved keyword
-    const workingData = (_class ? data?.['classes']?.[_class] : data) || {};
+
+    // eslint-disable-next-line no-underscore-dangle
+    const workingData = (_class ? data?.classes?.[_class] : data) || {};
     return {
       roundWins: workingData.wins || 0,
       gamesPlayed: workingData.games_played || 0,

package/src/structures/Pet.js

@@ -29,7 +29,7 @@ class Pet {
      * Stats of the pet, if any
      * @type {object}
      */
-    if (!stats) return; // don't parse stats because there is none.
+    if (!stats) return;
     /**
      * Hunger value ( 100 is highest )
      * @type {?number}