hypixel-api-reborn 11.2.0 → 11.3.0

package/src/structures/MiniGames/WoolWars.js

@@ -34,13 +34,62 @@ class WoolWars {
      * @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 = {
-      overall: WoolWars.generateStatsFor(data.wool_wars?.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'),
@@ -48,7 +97,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,30 +114,32 @@ 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,
+      wins: workingData.wins || 0,
       gamesPlayed: workingData.games_played || 0,
       woolsPlaced: workingData.wool_placed || 0,
       blocksBroken: workingData.blocks_broken || 0,
-      placeBreakRatio: divide(workingData.wool_placed, workingData.blocks_broken),
+      placeBreakRatio: divide(workingData.wool_placed || 0, workingData.blocks_broken || 0),
       kills: workingData.kills || 0,
       deaths: workingData.deaths || 0,
       KDRatio: divide(workingData.kills, workingData.deaths),
@@ -106,10 +156,11 @@ class WoolWars {
  * @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} roundWins round wins
+ * @property {number} wins wins
  * @property {number} gamesPlayed games played
  * @property {number} woolsPlaced wools placed
  * @property {number} blocksBroken blocks broken

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}

package/src/structures/Player.js

@@ -1,3 +1,10 @@
+const {
+  playerLevelProgress,
+  parseClaimedRewards,
+  getSocialMedia,
+  getPlayerLevel,
+  getRank
+} = require('../utils/Player');
 const SkyWars = require('./MiniGames/SkyWars');
 const BedWars = require('./MiniGames/BedWars');
 const UHC = require('./MiniGames/UHC');
@@ -24,6 +31,8 @@ const Walls = require('./MiniGames/Walls');
 const Warlords = require('./MiniGames/Warlords');
 const WoolWars = require('./MiniGames/WoolWars');
 const Pit = require('./MiniGames/Pit');
+const Guild = require('./Guild/Guild');
+const RecentGame = require('./RecentGame');
 /**
  * Player class
  */
@@ -93,7 +102,7 @@ class Player {
      * @type {Color|null}
      */
     this.plusColor =
-      this.rank === 'MVP+' || this.rank === 'MVP++'
+      'MVP+' === this.rank || 'MVP++' === this.rank
         ? data.rankPlusColor
           ? new Color(data.rankPlusColor)
           : new Color('RED')
@@ -103,7 +112,7 @@ class Player {
      * @type {Color|null}
      */
     this.prefixColor =
-      this.rank === 'MVP++' ? (data.monthlyRankColor ? new Color(data.monthlyRankColor) : new Color('GOLD')) : null;
+      'MVP++' === this.rank ? (data.monthlyRankColor ? new Color(data.monthlyRankColor) : new Color('GOLD')) : null;
     /**
      * Player karma
      * @type {number}
@@ -158,7 +167,7 @@ class Player {
      * Last time player claimed the daily reward
      * @type {Date | null}
      */
-    this.lastDailyReward = new Date(data.lastAdsenseGenerateTime) || null;
+    this.lastDailyReward = data.lastAdsenseGenerateTime ? new Date(data.lastAdsenseGenerateTime) : null;
     /**
      * Last time player claimed the daily reward, as timestamp
      * @type {number | null}
@@ -210,28 +219,28 @@ class Player {
      */
     this.stats = data.stats
       ? {
-          skywars: data.stats.SkyWars ? new SkyWars(data.stats.SkyWars) : null,
+          arcade: data.stats.Arcade ? new Arcade({ ...data.stats.Arcade, ...data.achievements }) : null,
+          arena: data.stats.Arena ? new ArenaBrawl(data.stats.Arena) : null,
           bedwars: data.stats.Bedwars ? new BedWars(data.stats.Bedwars) : null,
-          uhc: data.stats.UHC ? new UHC(data.stats.UHC) : null,
-          speeduhc: data.stats.SpeedUHC ? new SpeedUHC(data.stats.SpeedUHC) : null,
-          murdermystery: data.stats.MurderMystery ? new MurderMystery(data.stats.MurderMystery) : null,
-          duels: data.stats.Duels ? new Duels(data.stats.Duels) : null,
+          blitzsg: data.stats.HungerGames ? new BlitzSurvivalGames(data.stats.HungerGames) : null,
           buildbattle: data.stats.BuildBattle ? new BuildBattle(data.stats.BuildBattle) : null,
-          megawalls: data.stats.Walls3 ? new MegaWalls(data.stats.Walls3) : null,
           copsandcrims: data.stats.MCGO ? new CopsAndCrims(data.stats.MCGO) : null,
-          tntgames: data.stats.TNTGames ? new TNTGames(data.stats.TNTGames) : null,
-          smashheroes: data.stats.SuperSmash ? new SmashHeroes(data.stats.SuperSmash) : null,
-          vampirez: data.stats.VampireZ ? new VampireZ(data.stats.VampireZ) : null,
-          blitzsg: data.stats.HungerGames ? new BlitzSurvivalGames(data.stats.HungerGames) : null,
-          arena: data.stats.Arena ? new ArenaBrawl(data.stats.Arena) : null,
-          arcade: data.stats.Arcade ? new Arcade({ ...data.stats.Arcade, ...data.achievements }) : null,
+          duels: data.stats.Duels ? new Duels(data.stats.Duels) : null,
+          megawalls: data.stats.Walls3 ? new MegaWalls(data.stats.Walls3) : null,
+          murdermystery: data.stats.MurderMystery ? new MurderMystery(data.stats.MurderMystery) : null,
           paintball: data.stats.Paintball ? new Paintball(data.stats.Paintball) : null,
+          pit: data.stats.Pit ? new Pit(data.stats.Pit) : null,
           quakecraft: data.stats.Quake ? new Quakecraft(data.stats.Quake) : null,
+          skywars: data.stats.SkyWars ? new SkyWars(data.stats.SkyWars) : null,
+          smashheroes: data.stats.SuperSmash ? new SmashHeroes(data.stats.SuperSmash) : null,
+          speeduhc: data.stats.SpeedUHC ? new SpeedUHC(data.stats.SpeedUHC) : null,
+          tntgames: data.stats.TNTGames ? new TNTGames(data.stats.TNTGames) : null,
           turbokartracers: data.stats.GingerBread ? new TurboKartRacers(data.stats.GingerBread) : null,
+          uhc: data.stats.UHC ? new UHC(data.stats.UHC) : null,
+          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,
-          pit: data.stats.Pit ? new Pit(data.stats.Pit) : null
+          woolwars: data.stats.WoolGames ? new WoolWars(data.stats.WoolGames) : null
         }
       : null;
     /**
@@ -249,7 +258,7 @@ class Player {
      * Global Cosmetics a player owns
      * @type {PlayerCosmetics}
      */
-    this.globalCosmetics = new PlayerCosmetics(data) || null;
+    this.globalCosmetics = data ? new PlayerCosmetics(data) : null;
     /**
      * Time at which the ranks were purchased. Can be all null if bought a long time ago, and some values can be null if player bought directly a rank above that
      * @type {RanksPurchaseTime}
@@ -269,106 +278,6 @@ class Player {
     return this.nickname;
   }
 }
-
-// eslint-disable-next-line require-jsdoc
-function getRank(player) {
-  let rank;
-  if (player.prefix) {
-    rank = player.prefix.replace(/§[0-9|a-z]|\[|\]/g, '');
-  } else if (player.rank && player.rank !== 'NORMAL') {
-    switch (player.rank) {
-      case 'YOUTUBER':
-        rank = 'YouTube';
-        break;
-      case 'GAME_MASTER':
-        rank = 'Game Master';
-        break;
-      case 'ADMIN':
-        rank = 'Admin';
-        break;
-    }
-  } else {
-    switch (player.newPackageRank) {
-      case 'MVP_PLUS':
-        rank = player.monthlyPackageRank && player.monthlyPackageRank === 'SUPERSTAR' ? 'MVP++' : 'MVP+';
-        break;
-      case 'MVP':
-        rank = 'MVP';
-        break;
-      case 'VIP_PLUS':
-        rank = 'VIP+';
-        break;
-      case 'VIP':
-        rank = 'VIP';
-        break;
-      default:
-        rank = player.monthlyPackageRank && player.monthlyPackageRank === 'SUPERSTAR' ? 'MVP++' : 'Default';
-    }
-  }
-  return rank;
-}
-// eslint-disable-next-line require-jsdoc
-function getPlayerLevel(exp) {
-  const base = 10000;
-  const growth = 2500;
-  const reversePqPrefix = -(base - 0.5 * growth) / growth;
-  const reverseConst = reversePqPrefix * reversePqPrefix;
-  const growthDivides2 = 2 / growth;
-  const num = 1 + reversePqPrefix + Math.sqrt(reverseConst + growthDivides2 * exp);
-  const level = Math.round(num * 100) / 100;
-  return level;
-}
-// eslint-disable-next-line require-jsdoc
-function xpToNextLevel(player) {
-  const lvl = getPlayerLevel(player.networkExp);
-  const xpToNext = 2500 * Math.floor(lvl) + 5000;
-  if (player.networkExp < 10000) return 10000;
-  return xpToNext;
-}
-// eslint-disable-next-line require-jsdoc
-function levelToXP(player) {
-  let level = Number(Math.floor(getPlayerLevel(player.networkExp)));
-  level = level - 1;
-  const xp = 1250 * level ** 2 + 8750 * level;
-  return xp;
-}
-// eslint-disable-next-line require-jsdoc
-function playerLevelProgress(player) {
-  const xpFromLevel = levelToXP(player);
-  let currentXP = player.networkExp - xpFromLevel;
-  const xpToNext = xpToNextLevel(player);
-  const remainingXP = xpToNext - currentXP + 2500;
-  currentXP = currentXP - 2500;
-  const percent = Math.round((currentXP / xpToNext) * 100 * 100) / 100;
-  const percentRemaining = Math.round((100 - percent) * 100) / 100;
-  return {
-    xpToNext,
-    remainingXP,
-    currentXP,
-    percent,
-    percentRemaining
-  };
-}
-// eslint-disable-next-line require-jsdoc
-function getSocialMedia(data) {
-  if (!data) return null;
-  const links = data.links;
-  const formattedNames = ['Twitter', 'YouTube', 'Instagram', 'Twitch', 'Hypixel', 'Discord'];
-  const upperNames = ['TWITTER', 'YOUTUBE', 'INSTAGRAM', 'TWITCH', 'HYPIXEL', 'DISCORD'];
-  if (!links) return null;
-  return Object.keys(links)
-    .map((x) => upperNames.indexOf(x))
-    .filter((x) => x !== -1)
-    .map((x) => ({ name: formattedNames[x], link: links[upperNames[x]], id: upperNames[x] }));
-}
-// eslint-disable-next-line require-jsdoc
-function parseClaimedRewards(data) {
-  if (!data) return null;
-  return Object.keys(data)
-    .map((x) => x.match(/levelingReward_(\d+)/))
-    .filter((x) => x)
-    .map((x) => parseInt(x[1], 10));
-}
 /**
  * @typedef {string} PlayerRank
  * * `Default`
@@ -393,21 +302,27 @@ function parseClaimedRewards(data) {
  * Player stats for each mini-game. `null` if player has no stats.
  * <br>
  * Usage: `<Player>.stats.skywars`
- * @property {SkyWars|null} skywars SkyWars
+ * @property {Arcade|null} arcade Arcade
+ * @property {ArenaBrawl|null} arena Arena Brawl
  * @property {BedWars|null} bedwars BedWars
- * @property {UHC|null} uhc UHC
- * @property {SpeedUHC|null} speedUHC Speed UHC
- * @property {MurderMystery|null} murdermystery Murder Mystery
- * @property {Duels|null} duels Duels
+ * @property {BlitzSurvivalGames|null} blitzsg Blitz Survival Games
  * @property {BuildBattle|null} buildbattle BuildBattle
- * @property {MegaWalls|null} megawalls MegaWalls
  * @property {CopsAndCrims|null} copsandcrims Cops and Crims
- * @property {TNTGames|null} tntgames The TNT Games
+ * @property {Duels|null} duels Duels
+ * @property {MegaWalls|null} megawalls MegaWalls
+ * @property {MurderMystery|null} murdermystery Murder Mystery
+ * @property {Paintball|null} paintball Paint Ball
+ * @property {Pit|null} pit Pit
+ * @property {Quakecraft|null} quakecraft Quake Craft
+ * @property {SkyWars|null} skywars SkyWars
  * @property {SmashHeroes|null} smashheroes Smash Heroes
+ * @property {SpeedUHC|null} speedUHC Speed UHC
+ * @property {TNTGames|null} tntgames The TNT Games
+ * @property {TurboKartRacers|null} turbokartracers Turbo Kart Racers
+ * @property {UHC|null} uhc UHC
  * @property {VampireZ|null} vampirez VampireZ
- * @property {BlitzSurvivalGames|null} blitzsg Blitz Survival Games
- * @property {ArenaBrawl|null} arena Arena Brawl
- * @property {Arcade|null} arcade Arcade
+ * @property {Walls|null} walls Walls
+ * @property {Warlords|null} warlords Warlords
  * @property {WoolWars|null} woolwars Wool Wars
  */
 /**

package/src/structures/PlayerCosmetics.js

@@ -1,5 +1,6 @@
-const Pets = require('./Pets');
+/* eslint-disable no-underscore-dangle */
 const { removeSnakeCaseString } = require('../utils/removeSnakeCase');
+const Pets = require('./Pets');
 /**
  * Player Cosmetics class
  */
@@ -113,14 +114,14 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get rankColors() {
-    if (!this._rankcolors) {
-      this._rankcolors = this.allCosmetics
+    if (!this._rankColors) {
+      this._rankColors = this.allCosmetics
         ? this.allCosmetics
             .filter((x) => x.startsWith('rankcolor_'))
             .map((x) => removeSnakeCaseString(x.replace('rankcolor_', ''))) || []
         : [];
     }
-    return this._rankcolors;
+    return this._rankColors;
   }
   /**
    * Particle Packs

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

@@ -1,4 +1,3 @@
-/* eslint-disable require-jsdoc */
 /**
  * Auction info class
  */
@@ -36,6 +35,8 @@ class AuctionInfo {
      * Age
      * @type {number}
      */
+
+    // eslint-disable-next-line no-underscore-dangle
     this.age = parseInt(data._headers.get('age'), 10) || 0;
   }
 

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

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

package/src/structures/SkyBlock/News/SkyblockNews.js

@@ -1,5 +1,19 @@
-const dateRegExp = /(\d{1,2})(?:st|nd|rd|th|) ([A-z]+) (\d+)/;
+const dateRegExp = /(\d{1,2})(?:st|nd|rd|th|) ([A-Za-z]+) (\d+)/;
 const versionRegExp = /v\d+(\.\d+){1,}/;
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+function parseDate(stringDate) {
+  const matched = stringDate.match(dateRegExp);
+  if (!matched) return null;
+  return new Date(matched.slice(1).join(' '));
+}
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+function parseVer(stringVer) {
+  const matches = versionRegExp.exec(stringVer);
+  if (!matches?.length) return null;
+  return matches[0];
+}
 /**
  * SkyblockNews
  */
@@ -32,7 +46,6 @@ class SkyblockNews {
      * The version from the title (Skyblock v0.12.57673856757.327.2 => v0.12.57673856757.327.2)
      * @author linearaccelerator
      * @type {string | null}
-     * @version >6.0.1
      */
     this.version = parseVer(this.title);
   }
@@ -44,17 +57,4 @@ class SkyblockNews {
     return this.title;
   }
 }
-// eslint-disable-next-line require-jsdoc
-function parseDate(stringDate) {
-  const matched = stringDate.match(dateRegExp);
-  if (!matched) return null;
-  return new Date(matched.slice(1).join(' ')); // Ok this is lazy, but should work
-}
-
-// eslint-disable-next-line require-jsdoc
-function parseVer(stringVer) {
-  const matches = versionRegExp.exec(stringVer);
-  if (!matches?.length) return null; // this shouldn't really happen
-  return matches[0];
-}
 module.exports = SkyblockNews;

package/src/structures/SkyBlock/PlayerBingo.js

@@ -1,6 +1,11 @@
+const { populateGoals } = require('../../utils/SkyblockUtils');
+// eslint-disable-next-line no-unused-vars
+const BingoDataType = require('./Static/BingoData.js');
+// eslint-disable-next-line no-unused-vars
+const BingoType = require('./Static/Bingo.js');
 /**
- * @typedef {require('./Static/BingoData.js')} BingoData
- * @typedef {require('./Static/Bingo.js')} Bingo
+ * @typedef {BingoDataType} BingoData
+ * @typedef {BingoType} Bingo
  */
 
 /**
@@ -33,18 +38,6 @@ class PlayerBingo {
   }
 }
 
-// eslint-disable-next-line require-jsdoc
-function populateGoals(achieved, all) {
-  const populatedAchieved = [];
-  const unachieved = [];
-  for (const goal of all) {
-    if (achieved.find((str) => str === goal.name)) populatedAchieved.push(goal);
-    else unachieved.push(goal);
-  }
-  populatedAchieved.unachievedGoals = unachieved;
-  return populatedAchieved;
-}
-
 /**
  * @typedef {Object} PlayerBingoDataPerEvent
  * @property {number} eventId ID of event

package/src/structures/SkyBlock/SkyblockGarden.js

@@ -0,0 +1,146 @@
+const { getLevelByXp } = require('../../utils/SkyblockUtils');
+
+/**
+ * Skyblock Garden class
+ */
+class SkyblockGarden {
+  /**
+   * @param {object} data Skyblock member data
+   */
+  constructor(data) {
+    /**
+     * level
+     * @type {SkyblockSkillLevel}
+     */
+    this.level = getLevelByXp(data?.garden?.garden_experience || 0, 'garden');
+    /**
+     * Current Barn Skin
+     * @type {string}
+     */
+    this.barnSkin = data.garden?.selected_barn_skin || '';
+    /**
+     * Unlocked Plots
+     * @type {string[]}
+     */
+    this.unlockedPlots = data.garden?.unlocked_plots_ids || [];
+    /**
+     * Visitor Stats
+     * @type {SkyblockGardenVisitor}
+     */
+    this.visitors = {
+      visited: data.garden?.commission_data?.visits || {},
+      completed: data.garden?.commission_data?.completed || {},
+      served: {
+        total: data.garden?.commission_data?.total_completed || 0,
+        unique: data.garden?.commission_data?.unique_npcs_served || 0
+      }
+    };
+    /**
+     * Crop Milestones
+     * @type {SkyblockGarenCropMilestones}
+     */
+    this.cropMilestones = {
+      wheat: getLevelByXp(data.garden?.resources_collected?.WHEAT || 0, 'wheat'),
+      carrot: getLevelByXp(data.garden?.resources_collected?.CARROT_ITEM || 0, 'carrot'),
+      sugarCane: getLevelByXp(data.garden?.resources_collected?.SUGAR_CANE || 0, 'sugarCane'),
+      potato: getLevelByXp(data.garden?.resources_collected?.POTATO_ITEM || 0, 'potato'),
+      pumpkin: getLevelByXp(data.garden?.resources_collected?.PUMPKIN || 0, 'pumpkin'),
+      melon: getLevelByXp(data.garden?.resources_collected?.MELON || 0, 'melon'),
+      cactus: getLevelByXp(data.garden?.resources_collected?.CACTUS || 0, 'cactus'),
+      cocoBeans: getLevelByXp(data.garden?.resources_collected?.['INK_SACK:3'] || 0, 'cocoBeans'),
+      mushroom: getLevelByXp(data.garden?.resources_collected?.MUSHROOM_COLLECTION || 0, 'mushroom'),
+      netherWart: getLevelByXp(data.garden?.resources_collected?.NETHER_STALK || 0, 'netherWart')
+    };
+    /**
+     * Composter
+     * @type {SkyblockGardenComposter}
+     */
+    this.composter = {
+      organicMatter: data.garden?.composter_data?.organic_matter || 0,
+      fuelUnits: data.garden?.composter_data?.fuel_units || 0,
+      compostUnits: data.garden?.composter_data?.compost_units || 0,
+      compostItems: data.garden?.composter_data?.compost_items || 0,
+      conversionTicks: data.garden?.composter_data?.conversion_ticks || 0,
+      upgrades: {
+        speed: data.garden?.composter_data?.upgrades?.speed || 0,
+        multiDrop: data.garden?.composter_data?.upgrades?.multi_drop || 0,
+        fuelCap: data.garden?.composter_data?.upgrades?.fuel_cap || 0,
+        organicMatterCap: data.garden?.composter_data?.upgrades?.organic_matter_cap || 0,
+        costReduction: data.garden?.composter_data?.upgrades?.cost_reduction || 0
+      }
+    };
+    /**
+     * Crop Upgrades
+     * @type {SkyblockGarenCrops}
+     */
+    this.cropUpgrades = {
+      wheat: data.garden?.crop_upgrade_levels?.WHEAT || 0,
+      carrot: data.garden?.crop_upgrade_levels?.CARROT_ITEM || 0,
+      sugarCane: data.garden?.crop_upgrade_levels?.SUGAR_CANE || 0,
+      potato: data.garden?.crop_upgrade_levels?.POTATO_ITEM || 0,
+      pumpkin: data.garden?.crop_upgrade_levels?.PUMPKIN || 0,
+      melon: data.garden?.crop_upgrade_levels?.MELON || 0,
+      cactus: data.garden?.crop_upgrade_levels?.CACTUS || 0,
+      cocoBeans: data.garden?.crop_upgrade_levels?.['INK_SACK:3'] || 0,
+      mushroom: data.garden?.crop_upgrade_levels?.MUSHROOM_COLLECTION || 0,
+      netherWart: data.garden?.crop_upgrade_levels?.NETHER_STALK || 0
+    };
+  }
+}
+
+/**
+ * @typedef {object} SkyblockGardenVisitor
+ * @property {Record<string, number>} visited Visited
+ * @property {Record<string, number>} completed Completed
+ * @property {SkyblockGardenVisitorServed} served served
+ */
+/**
+ * @typedef {object} SkyblockGardenVisitorServed
+ * @property {number} total total
+ * @property {number} unique unique
+ */
+/**
+ * @typedef {object} SkyblockGardenComposter
+ * @property {number} organicMatter Organic Matter
+ * @property {number} fuelUnits Fuel Units
+ * @property {number} compostUnits Compost Units
+ * @property {number} compostItems Compost Items
+ * @property {number} conversionTicks Conversion Ticks
+ * @property {SkyblockGardenComposterUpgrades} upgrades upgrades
+ */
+/**
+ * @typedef {object} SkyblockGardenComposterUpgrades
+ * @property {number} speed Speed
+ * @property {number} multiDrop Multi Drop
+ * @property {number} fuelCap Fuel Cap
+ * @property {number} organicMatterCap Organic Matter Cap
+ * @property {number} costReduction Cost Reduction
+ */
+/**
+ * @typedef {object} SkyblockGarenCrops
+ * @property {number} wheat Wheat
+ * @property {number} carrot Carrot
+ * @property {number} sugarCane Sugar Cane
+ * @property {number} potato Potato
+ * @property {number} pumpkin Pumpkin
+ * @property {number} melon Melon
+ * @property {number} cactus Cactus
+ * @property {number} cocoBeans Coco Beans
+ * @property {number} mushroom Mushroom
+ * @property {number} netherWart Nether Wart
+ */
+/**
+ * @typedef {object} SkyblockGarenCropMilestones
+ * @property {SkyblockSkillLevel} wheat Wheat
+ * @property {SkyblockSkillLevel} carrot Carrot
+ * @property {SkyblockSkillLevel} sugarCane Sugar Cane
+ * @property {SkyblockSkillLevel} potato Potato
+ * @property {SkyblockSkillLevel} pumpkin Pumpkin
+ * @property {SkyblockSkillLevel} melon Melon
+ * @property {SkyblockSkillLevel} cactus Cactus
+ * @property {SkyblockSkillLevel} cocoBeans Coco Beans
+ * @property {SkyblockSkillLevel} mushroom Mushroom
+ * @property {SkyblockSkillLevel} netherWart Nether Wart
+ */
+
+module.exports = SkyblockGarden;