hypixel-api-reborn 11.3.3 → 11.3.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypixel-api-reborn",
-  "version": "11.3.3",
+  "version": "11.3.5",
   "description": "Feature-rich Hypixel API wrapper for Node.js",
   "main": "./src/index.js",
   "types": "./typings/index.d.ts",
@@ -32,7 +32,7 @@
     "node-fetch": "^3.3.2",
     "prismarine-nbt": "^2.5.0",
     "rss-parser": "^3.13.0",
-    "skyhelper-networth": "^1.22.0"
+    "skyhelper-networth": "^1.24.0"
   },
   "license": "MIT",
   "readme": "https://hypixel.stavzdev.me/",
@@ -42,10 +42,10 @@
   "publisher": "StavZ",
   "devDependencies": {
     "@discordjs/docgen": "github:discordjs/docgen",
-    "@types/node": "^22.1.0",
+    "@types/node": "^22.5.0",
     "chai": "^4.3.4",
-    "eslint": "^9.8.0",
-    "eslint-plugin-jsdoc": "^49.0.0",
+    "eslint": "^9.9.1",
+    "eslint-plugin-jsdoc": "^50.2.2",
     "globals": "^15.9.0",
     "mocha": "^10.4.0",
     "node-env-run": "^4.0.2",

package/src/API/skyblock/getGarden.js

@@ -1,7 +1,11 @@
 module.exports = async function (profileId) {
   const SkyblockGarden = require('../../structures/SkyBlock/SkyblockGarden');
-  // eslint-disable-next-line no-underscore-dangle
-  const res = await this._makeRequest(`/skyblock/garden?profile=${profileId}`);
-  if (res.raw) return res;
+  let res;
+  try {
+    // eslint-disable-next-line no-underscore-dangle
+    res = await this._makeRequest(`/skyblock/garden?profile=${profileId}`).catch();
+    // eslint-disable-next-line no-unused-vars, no-empty
+  } catch (e) {}
+  if (res?.raw) return res;
   return new SkyblockGarden(res);
 };

package/src/index.js

@@ -80,7 +80,7 @@ module.exports = {
   VampireZ: require('./structures/MiniGames/VampireZ.js'),
   Walls: require('./structures/MiniGames/Walls.js'),
   Warlords: require('./structures/MiniGames/Warlords.js'),
-  WoolWars: require('./structures/MiniGames/WoolWars.js'),
+  WoolGames: require('./structures/MiniGames/WoolGames.js'),
 
   /* Leaderboards */
   Leaderboard: require('./structures/Leaderboard.js'),

package/src/structures/MiniGames/Arcade.js

@@ -240,73 +240,6 @@ class BountyHunters {
     this.swordKills = data.sword_kills_oneinthequiver || 0;
   }
 }
-/**
- * Capture the Wool class
- */
-class CaptureTheWool {
-  constructor(data) {
-    /**
-     * Wins
-     * @type {number}
-     */
-    this.wins = data.woolhunt_participated_wins || 0;
-    /**
-     * Losses
-     * @type {number}
-     */
-    this.losses = data.woolhunt_participated_losses || 0;
-    /**
-     * Win Loss ratio
-     * @type {number}
-     */
-    this.WLRatio = divide(this.wins, this.losses);
-    /**
-     * Draws
-     * @type {number}
-     */
-    this.draws = data.woolhunt_participated_draws || 0;
-    /**
-     * Kills
-     * @type {number}
-     */
-    this.kills = data.woolhunt_kills || 0;
-    /**
-     * Deaths
-     * @type {number}
-     */
-    this.deaths = data.woolhunt_deaths || 0;
-    /**
-     * Kill Death ratio
-     * @type {number}
-     */
-    this.KDRatio = divide(this.kills, this.deaths);
-    /**
-     * assists
-     * @type {number}
-     */
-    this.assists = data.woolhunt_assists || 0;
-    /**
-     * woolPickedUp
-     * @type {number}
-     */
-    this.woolPickedUp = data.woolhunt_wools_stolen || 0;
-    /**
-     * woolCaptured
-     * @type {number}
-     */
-    this.woolCaptured = data.woolhunt_wools_captured || 0;
-    /**
-     * fastestWin (In seconds)
-     * @type {number}
-     */
-    this.fastestWin = data.woolhunt_fastest_win || 0;
-    /**
-     * longestGame (In seconds)
-     * @type {number}
-     */
-    this.longestGame = data.woolhunt_longest_game || 0;
-  }
-}
 /**
  * Dragon Wars class
  */
@@ -561,9 +494,9 @@ class GalaxyWars {
   }
 }
 /**
- * Party Popper Stats (Sub gamemode of Hide and Seek)
+ * Party Pooper Stats (Sub gamemode of Hide and Seek)
  */
-class PartyPopper {
+class PartyPooper {
   /**
    * @param {Object} data Data from API
    */
@@ -619,10 +552,10 @@ class HideAndSeek {
    */
   constructor(data) {
     /**
-     * Party Popper Stats
-     * @type {PartyPopper}
+     * Party Pooper Stats
+     * @type {PartyPooper}
      */
-    this.partyPopper = new PartyPopper(data);
+    this.partyPooper = new PartyPooper(data);
     /**
      * Prop Hunt Stats
      * @type {PropHunt}
@@ -977,11 +910,6 @@ class Arcade {
      * @type {BountyHunters}
      */
     this.bountyHunters = new BountyHunters(data);
-    /**
-     * Capture The Wool
-     * @type {CaptureTheWool}
-     */
-    this.captureTheWool = new CaptureTheWool(data);
     /**
      * Dragon wars stats
      * @type {DragonWars}

package/src/structures/MiniGames/WoolGames.js

@@ -0,0 +1,405 @@
+const { divide } = require('../../utils');
+
+class WoolWarsClass {
+  /**
+   * Constructor
+   * @param {Record<string, unknown>} data Data from API
+   */
+  constructor(data, className) {
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data?.[className]?.wins || 0;
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills = data?.[className]?.kills || 0;
+    /**
+     * Assists
+     * @type {number}
+     */
+    this.assists = data?.[className]?.assists || 0;
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = data?.[className]?.deaths || 0;
+    /**
+     * KDRatio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Games Played
+     * @type {number}
+     */
+    this.gamesPlayed = data?.[className]?.games_played || 0;
+    /**
+     * Wools Placed
+     * @type {number}
+     */
+    this.woolsPlaced = data?.[className]?.wool_placed || 0;
+    /**
+     * Blocks Broken
+     * @type {number}
+     */
+    this.blocksBroken = data?.[className]?.blocks_broken || 0;
+    /**
+     * Place Break Ratio
+     * @type {number}
+     */
+    this.placeBreakRatio = divide(this.woolsPlaced, this.blocksBroken);
+    /**
+     * Powerups Collected
+     * @type {number}
+     */
+    this.powerups = data?.[className]?.powerups_gotten || 0;
+  }
+}
+
+/**
+ * Wool Wars Class
+ */
+class WoolWars {
+  /**
+   * Constructor
+   * @param {Record<string, unknown>} data Data from API
+   */
+  constructor(data) {
+    /**
+     * Selected Class
+     * @type {'ASSAULT' | 'TANK' | 'GOLEM' | 'SWORDSMAN' | 'ENGINEER' | 'ARCHER' | 'NONE'}
+     */
+    this.selectedClass = data?.selected_class || 'NONE';
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data?.stats?.wins || 0;
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills = data?.stats?.kills || 0;
+    /**
+     * Assists
+     * @type {number}
+     */
+    this.assists = data?.stats?.assists || 0;
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = data?.stats?.deaths || 0;
+    /**
+     * KDRatio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Games Played
+     * @type {number}
+     */
+    this.gamesPlayed = data?.stats?.games_played || 0;
+    /**
+     * Wools Placed
+     * @type {number}
+     */
+    this.woolsPlaced = data?.stats?.wool_placed || 0;
+    /**
+     * Blocks Broken
+     * @type {number}
+     */
+    this.blocksBroken = data?.stats?.blocks_broken || 0;
+    /**
+     * Place Break Ratio
+     * @type {number}
+     */
+    this.placeBreakRatio = divide(this.woolsPlaced, this.blocksBroken);
+    /**
+     * powerups
+     * @type {number}
+     */
+    this.powerups = data?.powerups_gotten || 0;
+    /**
+     * Assault Class Stats
+     * @type {WoolWarsClass}
+     */
+    this.assault = new WoolWarsClass(data?.stats?.classes, 'assault');
+    /**
+     * Tank Class Stats
+     * @type {WoolWarsClass}
+     */
+    this.tank = new WoolWarsClass(data?.stats?.classes, 'tank');
+    /**
+     * Golem Class Stats
+     * @type {WoolWarsClass}
+     */
+    this.golem = new WoolWarsClass(data?.stats?.classes, 'golem');
+    /**
+     * Swordsman Class Stats
+     * @type {WoolWarsClass}
+     */
+    this.swordsman = new WoolWarsClass(data?.stats?.classes, 'swordsman');
+    /**
+     * Engineer Class Stats
+     * @type {WoolWarsClass}
+     */
+    this.engineer = new WoolWarsClass(data?.stats?.classes, 'engineer');
+    /**
+     * Archer Class Stats
+     * @type {WoolWarsClass}
+     */
+    this.archer = new WoolWarsClass(data?.stats?.classes, 'archer');
+  }
+}
+/**
+ * Capture The Wool Stats Class
+ */
+class CaptureTheWool {
+  /**
+   * Constructor
+   * @param {Record<string, unknown>} data Data from API
+   */
+  constructor(data) {
+    /**
+     * kills
+     * @type {number}
+     */
+    this.kills = data?.stats?.kills || 0;
+    /**
+     * Assists
+     * @type {number}
+     */
+    this.assists = data?.stats?.assists || 0;
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = data?.stats?.deaths || 0;
+    /**
+     * KDRatio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.kills, this.deaths);
+    /**
+     * Kills With Wool
+     * @type {number}
+     */
+    this.killsWithWool = data?.stats?.kills_with_wool || 0;
+    /**
+     * Deaths With Wool
+     * @type {number}
+     */
+    this.deathsWithWool = data?.stats?.deaths_with_wool || 0;
+    /**
+     * KDRatio With Wool
+     * @type {number}
+     */
+    this.KDRatioWithWool = divide(this.killsWithWool, this.deathsWithWool);
+    /**
+     * Wool Captured
+     * @type {number}
+     */
+    this.woolCaptured = data?.stats?.wools_captured || 0;
+    /**
+     * Wool Stolen
+     * @type {number}
+     */
+    this.woolStolen = data?.stats?.wools_stolen || 0;
+    /**
+     * Wool Capture Stolen Ratio
+     * @type {number}
+     */
+    this.woolCaptureStolenRatio = divide(this.woolCaptured, this.woolStolen);
+  }
+}
+/**
+ * Sheep Wars Stats Class
+ */
+class SheepWars {
+  /**
+   * Constructor
+   * @param {Record<string, unknown>} data Data from API
+   */
+  constructor(data) {
+    /**
+     * Wins
+     * @type {number}
+     */
+    this.wins = data?.stats?.wins || 0;
+    /**
+     * Kills
+     * @type {number}
+     */
+    this.kills = data?.stats?.kills || 0;
+    /**
+     * Kills Void
+     * @type {number}
+     */
+    this.killsVoid = data?.stats?.kills_void || 0;
+    /**
+     K kills Bow
+     * @type {number}
+     */
+    this.killsBow = data?.stats?.kills_bow || 0;
+    /**
+     * Kills Explosive
+     * @type {number}
+     */
+    this.killsExplosive = data?.stats?.kills_explosive || 0;
+    /**
+     * Deaths
+     * @type {number}
+     */
+    this.deaths = data?.stats?.deaths || 0;
+    /**
+     * Deaths Void
+     * @type {number}
+     */
+    this.deathsVoid = data?.stats?.deaths_void || 0;
+    /**
+     * Deaths Melee
+     * @type {number}
+     */
+    this.deathsMelee = data?.stats?.deaths_melee || 0;
+    /**
+     * Deaths Explosive
+     * @type {number}
+     */
+    this.deathsExplosive = data?.stats?.deaths_explosive || 0;
+    /**
+     * KDRatio
+     * @type {number}
+     */
+    this.KDRatio = divide(this.wins, this.deaths);
+    /**
+     * Losses
+     * @type {number}
+     */
+    this.losses = data?.stats?.losses || 0;
+    /**
+     * WLRatio
+     * @type {number}
+     */
+    this.WLRatio = divide(this.wins, this.losses);
+    /**
+     * Games Played
+     * @type {number}
+     */
+    this.gamesPlayed = data?.stats?.games_played || 0;
+    /**
+     * Damage Dealt
+     * @type {number}
+     */
+    this.damageDealt = data?.stats?.damage_dealt || 0;
+    /**
+     * Sheep Thrown
+     * @type {number}
+     */
+    this.sheepThrown = data?.stats?.sheep_thrown || 0;
+    /**
+     * Magic Wool Hit
+     * @type {number}
+     */
+    this.magicWoolHit = data?.stats?.magic_wool_hit || 0;
+  }
+}
+
+/**
+ * WoolGames Stats
+ */
+class WoolGames {
+  /**
+   * Constructor
+   * @param {Record<string, unknown>} data Data from API
+   */
+  constructor(data) {
+    /**
+     * Layers
+     * @type {number}
+     */
+    this.layers = data?.progression?.available_layers || 0;
+    /**
+     * XP
+     * @type {number}
+     */
+    this.xp = data?.progression?.experience || 0;
+    /**
+     * Exact Level
+     * @type {number}
+     */
+    this.exactLevel = this.convertXPToLevel(this.xp);
+    /**
+     * Level
+     * @type {number}
+     */
+    this.level = Math?.floor(this.exactLevel);
+    /**
+     * Coins
+     * @type {number}
+     */
+    this.coins = data?.coins || 0;
+    /**
+     * Owned Cosmetics
+     * @type {string[]}
+     */
+    this.ownedCosmetics = data?.packages || [];
+    /**
+     * Private Games Config
+     * @type {WoolGamesPrivateGamesConfig}
+     */
+    this.privateGamesConfig = data?.privategames || {};
+    /**
+     * Playtime
+     * @type {number}
+     */
+    this.playtime = data?.playtime || 0;
+    /**
+     * Wool Wars
+     * @type {WoolWars}
+     */
+    this.woolWars = new WoolWars(data?.wool_wars);
+    /**
+     * Capture The Wool
+     * @type {CaptureTheWool}
+     */
+    this.captureTheWool = new CaptureTheWool(data?.capture_the_wool);
+    /**
+     * Sheep Wars
+     * @type {SheepWars}
+     */
+    this.sheepWars = new SheepWars(data?.sheep_wars);
+  }
+
+  /**
+   * Converts XP to Level
+   * @param {number} exp xp
+   * @return {number}
+   */
+  convertXPToLevel(exp) {
+    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 (100 < theoreticalLevel) return 100 + this.convertXPToLevel(exp - expToLevel100);
+    return theoreticalLevel;
+  }
+}
+
+/**
+ * @typedef {object} WoolGamesPrivateGamesConfig
+ * @property {boolean} one_hit_one_kill one hit one kill
+ * @property {'Enabled' | 'Disabled'} rainbow_wool rainbow wool
+ * @property {string} health_buff health buff
+ * @property {string} game_speed game speed
+ * @property {string} speed speed
+ * @property {'Enabled' | 'Disabled'} no_class no class
+ * @property {boolean} respawn_enable respawn enable
+ */
+
+module.exports = WoolGames;

package/src/structures/Player.js

@@ -29,7 +29,7 @@ const Paintball = require('./MiniGames/Paintball');
 const Quakecraft = require('./MiniGames/Quakecraft');
 const Walls = require('./MiniGames/Walls');
 const Warlords = require('./MiniGames/Warlords');
-const WoolWars = require('./MiniGames/WoolWars');
+const WoolGames = require('./MiniGames/WoolGames');
 const Pit = require('./MiniGames/Pit');
 const Guild = require('./Guild/Guild');
 const RecentGame = require('./RecentGame');
@@ -240,7 +240,7 @@ class Player {
           vampirez: data.stats.VampireZ ? new VampireZ(data.stats.VampireZ) : null,
           walls: data.stats.Walls ? new Walls(data.stats.Walls) : null,
           warlords: data.stats.Battleground ? new Warlords(data.stats.Battleground) : null,
-          woolwars: data.stats.WoolGames ? new WoolWars(data.stats.WoolGames) : null
+          woolgames: data.stats.WoolGames ? new WoolGames(data.stats.WoolGames) : null
         }
       : null;
     /**
@@ -325,7 +325,7 @@ class Player {
  * @property {VampireZ|null} vampirez VampireZ
  * @property {Walls|null} walls Walls
  * @property {Warlords|null} warlords Warlords
- * @property {WoolWars|null} woolwars Wool Wars
+ * @property {WoolGames|null} woolgames Wool Games
  */
 /**
  * @typedef {Object} RanksPurchaseTime