hypixel-api-reborn 11.3.4 → 11.3.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypixel-api-reborn",
-  "version": "11.3.4",
+  "version": "11.3.6",
   "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.23.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.5",
     "chai": "^4.3.4",
-    "eslint": "^9.8.0",
-    "eslint-plugin-jsdoc": "^49.0.0",
+    "eslint": "^9.10.0",
+    "eslint-plugin-jsdoc": "^50.2.3",
     "globals": "^15.9.0",
     "mocha": "^10.4.0",
     "node-env-run": "^4.0.2",

package/src/Errors.js

@@ -62,5 +62,7 @@ module.exports = {
   INVALID_UPDATE_OPTION: '[hypixel-api-reborn] Invalid Value for update : must be a boolean',
   INVALID_THIRD_PARTY_API_OPTION: '[hypixel-api-reborn] Invalid Third Party API option : must be a boolean or string',
   BAD_AUCTION_FILTER:
-    '[hypixel-api-reborn] Unexpected filter for Client#getSkyblockAuction. Expected one of "PLAYER", "AUCTION", "PROFILE", but got something else.'
+    '[hypixel-api-reborn] Unexpected filter for Client#getSkyblockAuction. Expected one of "PLAYER", "AUCTION", "PROFILE", but got something else.',
+  RECENT_REQUEST:
+    '[Hypixel-API-Reborn] You have requested that player recently. Try turning on cache. For help join our Discord Server https://discord.gg/NSEBNMM'
 };

package/src/Private/requests.js

@@ -32,6 +32,12 @@ class Requests {
     }
     if (403 === res.status) throw new Error(Errors.INVALID_API_KEY);
     if (422 === res.status) throw new Error(Errors.UNEXPECTED_ERROR);
+    if (
+      429 === res.status &&
+      'You have already looked up this player too recently, please try again shortly' === parsedRes.cause
+    ) {
+      throw new Error(Errors.RECENT_REQUEST);
+    }
     if (429 === res.status) throw new Error(Errors.RATE_LIMIT_EXCEEDED);
     if (200 !== res.status) throw new Error(Errors.ERROR_STATUSTEXT.replace(/{statustext}/, res.statusText));
     if (!parsedRes.success && !endpoint.startsWith('/housing')) {

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/UHC.js

@@ -14,8 +14,7 @@ class UHCGamemode {
    * @param {object} data UHC data
    * @param {string} mode UHC Mode Name
    */
-  constructor(data, mode) {
-    if (mode) mode = `_${mode}`;
+  constructor(data, mode = '') {
     /**
      * Kills
      * @type {number}
@@ -76,7 +75,7 @@ class UHC {
      * Solo
      * @type {UHCGamemode}
      */
-    this.solo = new UHCGamemode(data, 'solo');
+    this.solo = new UHCGamemode(data, '_solo');
     /**
      * Teams
      * @type {UHCGamemode}
@@ -86,27 +85,27 @@ class UHC {
      * Red vs Blue
      * @type {UHCGamemode}
      */
-    this.redVsBlue = new UHCGamemode(data, 'red_vs_blue');
+    this.redVsBlue = new UHCGamemode(data, '_red_vs_blue');
     /**
      * No Diamond
      * @type {UHCGamemode}
      */
-    this.noDiamond = new UHCGamemode(data, 'no_diamonds');
+    this.noDiamond = new UHCGamemode(data, '_no_diamonds');
     /**
      * Brawl
      * @type {UHCGamemode}
      */
-    this.brawl = new UHCGamemode(data, 'brawl');
+    this.brawl = new UHCGamemode(data, '_brawl');
     /**
      * Solo brawl
      * @type {UHCGamemode}
      */
-    this.soloBrawl = new UHCGamemode(data, 'solo_brawl');
+    this.soloBrawl = new UHCGamemode(data, '_solo_brawl');
     /**
      * Duo Brawl
      * @type {UHCGamemode}
      */
-    this.duoBrawl = new UHCGamemode(data, 'duo_brawl');
+    this.duoBrawl = new UHCGamemode(data, '_duo_brawl');
     /**
      * Wins
      * @type {number}

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

package/src/structures/SkyBlock/Auctions/BaseAuction.js

@@ -32,7 +32,10 @@ class BaseAuction {
      * Item bytes
      * @type {ItemBytes|null}
      */
-    this.itemBytes = includeItemBytes ? new ItemBytes(data.item_bytes) : null;
+    this.itemBytes =
+      includeItemBytes && data.item_bytes
+        ? new ItemBytes(data.item_bytes.data ? data.item_bytes.data : data.item_bytes)
+        : null;
   }
   /**
    * Auction ID

package/src/structures/SkyBlock/SkyblockMuseumItem.js

@@ -14,7 +14,7 @@ class SkyblockMuseumItem {
     this.name = data.name;
     /**
      * Item
-     * @type {SkyblockInventoryItem}
+     * @type {SkyblockInventoryItem[]}
      */
     this.items = [];
     data.decoded.forEach((item) => {

package/src/utils/Constants.js

@@ -104,7 +104,7 @@ module.exports = {
     25: 19050
   },
   skillsCap: {
-    taming: 50,
+    taming: 60,
     farming: 60,
     mining: 60,
     combat: 60,

package/src/utils/Guild.js

@@ -8,6 +8,7 @@ function parseDate(date) {
 }
 
 function parseHistory(historyData) {
+  const expValuesReversed = Object.values(historyData).reverse();
   return Object.entries(historyData).map((x, index) => ({
     day: x[0],
     date:
@@ -18,9 +19,7 @@ function parseHistory(historyData) {
           .map((x) => parseInt(x, 10))
       ) || undefined,
     exp: x[1] || 0,
-    totalExp: Object.values(historyData)
-      .slice(0, index + 1)
-      .reduce((pV, cV) => pV + cV, 0)
+    totalExp: expValuesReversed.slice(0, expValuesReversed.length - index).reduce((pV, cV) => pV + cV)
   }));
 }
 

package/typings/index.d.ts

@@ -579,7 +579,7 @@ declare module 'hypixel-api-reborn' {
         25: 19050;
       };
       skillsCap: {
-        taming: 50;
+        taming: 60;
         farming: 60;
         mining: 60;
         combat: 60;
@@ -1424,7 +1424,7 @@ declare module 'hypixel-api-reborn' {
       walls?: Walls;
       warlords?: Warlords;
       arcade?: Arcade;
-      woolwars?: WoolWars;
+      woolgames?: WoolGames;
       pit?: Pit;
     };
     getRecentGames(): Promise<RecentGame[]>;
@@ -1474,49 +1474,71 @@ declare module 'hypixel-api-reborn' {
     extraAttributes: string | null;
     toString(): string;
   }
-  class WoolWars {
-    static convertXPToLevel(exp: number): number;
-    static generateStatsFor(data: Record<string, unknown>, _class?: string | undefined): WoolWarsStats;
+  class WoolWarsClass {
     constructor(data: Record<string, unknown>);
-    layers: number;
-    xp: number;
-    exactLevel: number;
-    level: number;
-    coins: number;
     wins: number;
+    kills: number;
+    assists: number;
+    deaths: number;
+    KDRatio: number;
     gamesPlayed: number;
     woolsPlaced: number;
     blocksBroken: number;
     placeBreakRatio: number;
-    kills: number;
-    deaths: number;
-    KDRatio: number;
-    assists: number;
     powerups: number;
-    selectedClass: 'ASSAULT' | 'TANK' | 'GOLEM' | 'SWORDSMAN' | 'ENGINEER' | 'ARCHER' | 'NONE';
-    stats: {
-      assault: WoolWarsStats;
-      tank: WoolWarsStats;
-      golem: WoolWarsStats;
-      swordsman: WoolWarsStats;
-      engineer: WoolWarsStats;
-      archer: WoolWarsStats;
-    };
-    ownedCosmetics: string[];
-    privateGamesConfig: PrivateGamesConfig;
   }
-  type WoolWarsStats = {
+  class WoolWars {
+    constructor(data: Record<string, unknown>);
+    selectedClass: 'ASSAULT' | 'TANK' | 'GOLEM' | 'SWORDSMAN' | 'ENGINEER' | 'ARCHER' | 'NONE';
     wins: number;
+    kills: number;
+    assists: number;
+    deaths: number;
+    KDRatio: number;
     gamesPlayed: number;
     woolsPlaced: number;
     blocksBroken: number;
     placeBreakRatio: number;
+    powerups: number;
+    assault: WoolWarsClass;
+    tank: WoolWarsClass;
+    golem: WoolWarsClass;
+    swordsman: WoolWarsClass;
+    engineer: WoolWarsClass;
+    archer: WoolWarsClass;
+  }
+  class CaptureTheWool {
+    constructor(data: Record<string, unknown>);
     kills: number;
+    assists: number;
     deaths: number;
     KDRatio: number;
-    assists: number;
-    powerups: number;
-  };
+    killsWithWool: number;
+    deathsWithWool: number;
+    KDRatioWithWool: number;
+    woolCaptured: number;
+    woolStolen: number;
+    woolCaptureStolenRatio: number;
+  }
+  class SheepWars {
+    constructor(data: Record<string, unknown>);
+    wins: number;
+    kills: number;
+    killsVoid: number;
+    killsBow: number;
+    killsExplosive: number;
+    deaths: number;
+    deathsVoid: number;
+    deathsMelee: number;
+    deathsExplosive: number;
+    KDRatio: number;
+    losses: number;
+    WLRatio: number;
+    gamesPlayed: number;
+    damageDealt: number;
+    sheepThrown: number;
+    magicWoolHit: number;
+  }
   type PrivateGamesConfig = {
     one_hit_one_kill: boolean;
     rainbow_wool: 'Enabled' | 'Disabled';
@@ -1526,6 +1548,20 @@ declare module 'hypixel-api-reborn' {
     no_class: 'Enabled' | 'Disabled';
     respawn_enable: boolean;
   };
+  class WoolGames {
+    constructor(data: Record<string, unknown>);
+    layers: number;
+    xp: number;
+    exactLevel: number;
+    level: number;
+    coins: number;
+    ownedCosmetics: string[];
+    privateGamesConfig: PrivateGamesConfig;
+    playtime: number;
+    woolWars: WoolWars;
+    captureTheWool: CaptureTheWool;
+    sheepWars: SheepWars;
+  }
   class PlayerCosmetics {
     constructor(data: Record<string, unknown>);
     allCosmetics: string[];
@@ -1805,7 +1841,6 @@ declare module 'hypixel-api-reborn' {
     flashDisabled: boolean;
     blockingDead: BlockingDead;
     bountyHunters: BountyHunters;
-    captureTheWool: CaptureTheWool;
     dragonWars: DragonWars;
     dropper: Dropper;
     enderSpleef: EnderSpleef;
@@ -1835,21 +1870,6 @@ declare module 'hypixel-api-reborn' {
     bowKills: number;
     swordKills: number;
   }
-  class CaptureTheWool {
-    constructor(data: Record<string, unknown>);
-    wins: number;
-    losses: number;
-    WLRatio: number;
-    draws: number;
-    kills: number;
-    deaths: number;
-    KDRatio: number;
-    assists: number;
-    woolPickedUp: number;
-    woolCaptured: number;
-    fastestWin: number;
-    longestGame: number;
-  }
   class DragonWars {
     constructor(data: Record<string, unknown>);
     wins: number;
@@ -1914,7 +1934,7 @@ declare module 'hypixel-api-reborn' {
     attackerKills: number;
     defenderKills: number;
   }
-  class PartyPopper {
+  class PartyPooper {
     constructor(data: Record<string, unknown>);
     winsAsSeeker: number;
     winsAsHider: number;
@@ -1928,7 +1948,7 @@ declare module 'hypixel-api-reborn' {
   }
   class HideAndSeek {
     constructor(data: Record<string, unknown>);
-    partyPopper: PartyPopper;
+    partyPooper: PartyPooper;
     propHunt: PropHunt;
     winsAsSeeker: number;
     winsAsHider: number;
@@ -2632,6 +2652,21 @@ declare module 'hypixel-api-reborn' {
     candyUsed: number;
     skin: string | null;
   }
+  class SkyblockMuseumItem {
+    constructor(data: Record<string, unknown>);
+    name: string | null;
+    items: SkyblockInventoryItem[];
+    donatedTime: number;
+    donatedTimeAt: Date;
+    borrowing: boolean;
+    featuredSlot: string | null;
+  }
+  class SkyblockMuseum {
+    constructor(data: Record<string, unknown>);
+    raw: object;
+    getWardrobe(): Promise<SkyblockMuseumItem[]>;
+    getWardrobe(): Promise<SkyblockMuseumItem[]>;
+  }
   class SkyblockGarden {
     constructor(data: Record<string, unknown>);
     level: SKYBLOCK_SKILL_DATA;
@@ -2721,11 +2756,14 @@ declare module 'hypixel-api-reborn' {
         mages: number;
       };
       trophyFish: {
-        total: number;
-        bronze: number;
-        silver: number;
-        gold: number;
-        diamond: number;
+        rank: 'Diamond' | 'Gold' | 'Silver' | 'Bronze' | null;
+        caught: {
+          total: number;
+          bronze: number;
+          silver: number;
+          gold: number;
+          diamond: number;
+        };
       };
       kuudra: {
         none: number;
@@ -2772,14 +2810,14 @@ declare module 'hypixel-api-reborn' {
         selected: string;
       };
       essence: {
-        diamond: numer;
-        dragon: numer;
-        spider: numer;
-        wither: numer;
-        undead: numer;
-        gold: numer;
-        ice: numer;
-        crimson: numer;
+        diamond: number;
+        dragon: number;
+        spider: number;
+        wither: number;
+        undead: number;
+        gold: number;
+        ice: number;
+        crimson: number;
       };
     } | null;
     collections: object;

package/src/structures/MiniGames/WoolWars.js

@@ -1,174 +0,0 @@
-const { divide } = require('../../utils');
-
-/**
- * Wool Wars Class
- */
-class WoolWars {
-  /**
-   * Constructor
-   * @param {Record<string,unknown>} data Data from API
-   */
-  constructor(data) {
-    /**
-     * Sheep layers, similar to prestige
-     * @type {number}
-     */
-    this.layers = data.progression?.available_layers || 0;
-    /**
-     * Wool Wars XP
-     * @type {number}
-     */
-    this.xp = data.progression?.experience || 0;
-    /**
-     * Wool Wars Decimal Level
-     * @type {number}
-     */
-    this.exactLevel = WoolWars.convertXPToLevel(this.xp);
-    /**
-     * Wool wars level (as shown in game)
-     * @type {number}
-     */
-    this.level = Math.floor(this.exactLevel);
-    /**
-     * Coins
-     * @type {number}
-     */
-    this.coins = data.coins || 0;
-    /**
-     * Wins
-     * @type {number}
-     */
-    this.wins = data.wins || 0;
-    /**
-     * gamesPlayed
-     * @type {number}
-     */
-    this.gamesPlayed = data.games_played || 0;
-    /**
-     * woolsPlaced
-     * @type {number}
-     */
-    this.woolsPlaced = data.wool_placed || 0;
-    /**
-     * blocksBroken
-     * @type {number}
-     */
-    this.blocksBroken = data.blocks_broken || 0;
-    /**
-     * placeBreakRatio
-     * @type {number}
-     */
-    this.placeBreakRatio = divide(this.woolsPlaced, this.blocksBroken);
-    /**
-     * kills
-     * @type {number}
-     */
-    this.kills = data.kills || 0;
-    /**
-     * deaths
-     * @type {number}
-     */
-    this.deaths = data.deaths || 0;
-    /**
-     * KDRatio
-     * @type {number}
-     */
-    this.KDRatio = divide(this.kills, this.deaths);
-    /**
-     * assists
-     * @type {number}
-     */
-    this.assists = data.assists || 0;
-    /**
-     * powerups
-     * @type {number}
-     */
-    this.powerups = data.powerups_gotten || 0;
-    /**
-     * Selected class, or NONE if field isn't present in API for some reason
-     * @type {'ASSAULT'|'TANK'|'GOLEM'|'SWORDSMAN'|'ENGINEER'|'ARCHER'|'NONE'}
-     */
-    this.selectedClass = data.wool_wars?.selected_class || 'NONE';
-    this.stats = {
-      assault: WoolWars.generateStatsFor(data.wool_wars?.stats, 'assault'),
-      tank: WoolWars.generateStatsFor(data.wool_wars?.stats, 'tank'),
-      golem: WoolWars.generateStatsFor(data.wool_wars?.stats, 'golem'),
-      swordsman: WoolWars.generateStatsFor(data.wool_wars?.stats, 'swordsman'),
-      engineer: WoolWars.generateStatsFor(data.wool_wars?.stats, 'engineer'),
-      archer: WoolWars.generateStatsFor(data.wool_wars?.stats, 'archer')
-    };
-    /**
-     * Owned Cosmetics
-     * @type {string[]}
-     */
-    this.ownedCosmetics = data.packages || [];
-    /**
-     * Private Games config
-     * @type {PrivateGamesConfig}
-     */
-    this.privateGamesConfig = data.privategames || {};
-  }
-  /**
-   * Converts XP to Level
-   * @param {number} exp xp
-   * @return {number}
-   */
-  static 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;
-  }
-  /**
-   * Generates stats per class/overall
-   * @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
-
-    // eslint-disable-next-line no-underscore-dangle
-    const workingData = (_class ? data?.classes?.[_class] : data) || {};
-    return {
-      wins: workingData.wins || 0,
-      gamesPlayed: workingData.games_played || 0,
-      woolsPlaced: workingData.wool_placed || 0,
-      blocksBroken: workingData.blocks_broken || 0,
-      placeBreakRatio: divide(workingData.wool_placed || 0, workingData.blocks_broken || 0),
-      kills: workingData.kills || 0,
-      deaths: workingData.deaths || 0,
-      KDRatio: divide(workingData.kills, workingData.deaths),
-      assists: workingData.assists || 0,
-      powerups: workingData.powerups_gotten || 0
-    };
-  }
-}
-/**
- * @typedef {Object} PrivateGamesConfig NB. There could be more fields
- * @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 Player speed
- * @property {'Enabled'|'Disabled'} no_class No class
- * @property {boolean} respawn_enable Respawning enabled
- */
-/**
- * @typedef {Object} WoolWarsStats
- * @property {number} wins wins
- * @property {number} gamesPlayed games played
- * @property {number} woolsPlaced wools placed
- * @property {number} blocksBroken blocks broken
- * @property {number} placeBreakRatio broken blocks to placed wool ratio
- * @property {number} kills kills
- * @property {number} deaths deaths
- * @property {number} KDRatio KDR
- * @property {number} assists assists (not included in KDR)
- * @property {number} powerups number of powerups picked up
- */
-module.exports = WoolWars;