hypixel-api-reborn 11.2.0 → 11.2.1

package/src/structures/SkyBlock/SkyblockMember.js

@@ -1,14 +1,22 @@
 const {
-  decode,
-  getLevelByXp,
-  getSlayerLevel,
+  getTrophyFishRank,
   getMemberStats,
-  getTrophyFishRank
+  getLevelByXp,
+  decode,
+  getSkills,
+  getBestiaryLevel,
+  getSlayer,
+  getDungeons,
+  getJacobData,
+  getChocolateFactory,
+  getPetLevel
 } = require('../../utils/SkyblockUtils');
 const SkyblockInventoryItem = require('./SkyblockInventoryItem');
 const Constants = require('../../utils/Constants');
 const skyhelper = require('skyhelper-networth');
 const SkyblockPet = require('./SkyblockPet');
+const Player = require('../Player');
+
 /**
  * Skyblock member class
  */
@@ -72,7 +80,7 @@ class SkyblockMember {
      * Skyblock Level
      * @type {number}
      */
-    this.level = this.experience / 100 ?? 0;
+    this.level = this.experience ? this.experience / 100 : 0;
     /**
      * Heart of the Mountain - MiningSkill
      * @type {number}
@@ -142,7 +150,12 @@ class SkyblockMember {
      * Skyblock jacob data
      * @type {jacobData}
      */
-    this.jacob = getJacobData(data);
+    this.jacob = getJacobData(data.m);
+    /**
+     * Skyblock Chocolate Factory
+     * @type {chocolateFactoryData}
+     */
+    this.chocolate = getChocolateFactory(data.m);
     /**
      * Equipped armor
      * @return {Promise<SkyblockMemberArmor>}
@@ -160,14 +173,14 @@ class SkyblockMember {
     };
     /**
      * Wardrobe contents
-     * @return {Promise<SkyblockMemberItem[]>}
+     * @return {Promise<SkyblockInventoryItem[]>}
      */
     this.getWardrobe = async () => {
       const base64 = data.m?.inventory?.wardrobe_contents?.data;
       if (!base64) return [];
       const decoded = await decode(base64);
       const armor = decoded
-        .filter((item) => Object.keys(item).length !== 0)
+        .filter((item) => 0 !== Object.keys(item).length)
         .map((item) => new SkyblockInventoryItem(item));
       return armor;
     };
@@ -189,7 +202,7 @@ class SkyblockMember {
           edited.push(new SkyblockInventoryItem(chest[i]));
         }
         return edited;
-      } catch (e) {
+      } catch {
         return [];
       }
     };
@@ -211,7 +224,7 @@ class SkyblockMember {
           edited.push(new SkyblockInventoryItem(inventory[i]));
         }
         return edited;
-      } catch (e) {
+      } catch {
         return [];
       }
     };
@@ -222,14 +235,14 @@ class SkyblockMember {
     this.getPetScore = () => {
       const highestRarity = {};
       for (const pet of data.m.pets_data.pets) {
-        if (!(pet.type in highestRarity) || Constants.pet_score[pet.tier] > highestRarity[pet.type]) {
-          highestRarity[pet.type] = Constants.pet_score[pet.tier];
+        if (!(pet.type in highestRarity) || Constants.petScore[pet.tier] > highestRarity[pet.type]) {
+          highestRarity[pet.type] = Constants.petScore[pet.tier];
         }
       }
 
       const highestLevel = {};
       for (const pet of data.m.pets_data.pets) {
-        const maxLevel = pet.type === 'GOLDEN_DRAGON' ? 200 : 100;
+        const maxLevel = 'GOLDEN_DRAGON' === pet.type ? 200 : 100;
         const petLevel = getPetLevel(pet.exp, pet.tier, maxLevel);
 
         if (!(pet.type in highestLevel) || petLevel.level > highestLevel[pet.type]) {
@@ -262,7 +275,7 @@ class SkyblockMember {
           necklace: equipment[0].id ? new SkyblockInventoryItem(equipment[0]) : null
         };
         return playerEquipment;
-      } catch (e) {
+      } catch {
         return [];
       }
     };
@@ -284,7 +297,7 @@ class SkyblockMember {
           edited.push(new SkyblockInventoryItem(vault[i]));
         }
         return edited;
-      } catch (e) {
+      } catch {
         return [];
       }
     };
@@ -301,7 +314,7 @@ class SkyblockMember {
           museumData: data.museum?.raw ?? {}
         });
         return nw;
-      } catch (e) {
+      } catch {
         return [];
       }
     };
@@ -314,209 +327,6 @@ class SkyblockMember {
     return this.uuid;
   }
 }
-// eslint-disable-next-line require-jsdoc
-function getSkills(data) {
-  const skillsObject = {};
-  skillsObject['combat'] = getLevelByXp(data?.player_data?.experience?.SKILL_COMBAT ?? 0, 'combat');
-  skillsObject['farming'] = getLevelByXp(
-    data?.player_data?.experience?.SKILL_FARMING ?? 0,
-    'farming',
-    data?.m?.jacobs_contest?.perks?.farming_level_cap ?? 0 + 50
-  );
-  skillsObject['fishing'] = getLevelByXp(data?.player_data?.experience?.SKILL_FISHING ?? 0, 'fishing');
-  skillsObject['mining'] = getLevelByXp(data?.player_data?.experience?.SKILL_MINING ?? 0, 'mining');
-  skillsObject['foraging'] = getLevelByXp(data?.player_data?.experience?.SKILL_FORAGING ?? 0, 'foraging');
-  skillsObject['enchanting'] = getLevelByXp(data?.player_data?.experience?.SKILL_ENCHANTING ?? 0, 'enchanting');
-  skillsObject['alchemy'] = getLevelByXp(data?.player_data?.experience?.SKILL_ALCHEMY ?? 0, 'alchemy');
-  skillsObject['carpentry'] = getLevelByXp(data?.player_data?.experience?.SKILL_CARPENTRY ?? 0, 'carpentry');
-  skillsObject['runecrafting'] = getLevelByXp(data?.player_data?.experience?.SKILL_RUNECRAFTING ?? 0, 'runecrafting');
-  skillsObject['taming'] = getLevelByXp(data?.player_data?.experience?.SKILL_TAMING ?? 0, 'taming');
-  skillsObject['social'] = getLevelByXp(data?.player_data?.experience?.SKILL_SOCIAL ?? 0, 'social');
-  const levels = Object.values(skillsObject)
-    .filter((skill) => skill.cosmetic !== true)
-    .map((skill) => skill.level);
-  skillsObject['average'] = levels.reduce((a, b) => a + b, 0) / levels.length;
-  return skillsObject;
-}
-// eslint-disable-next-line require-jsdoc
-function formatBestiaryMobs(userProfile, mobs) {
-  const output = [];
-  for (const mob of mobs) {
-    const mobBracket = Constants.bestiaryBrackets[mob.bracket];
-
-    const totalKills = mob.mobs.reduce((acc, cur) => {
-      return acc + (userProfile.bestiary.kills[cur] ?? 0);
-    }, 0);
-
-    const maxKills = mob.cap;
-    const nextTierKills = mobBracket.find((tier) => totalKills < tier && tier <= maxKills);
-    const tier = nextTierKills ? mobBracket.indexOf(nextTierKills) : mobBracket.indexOf(maxKills) + 1;
-
-    output.push({
-      tier: tier
-    });
-  }
-
-  return output;
-}
-
-// eslint-disable-next-line require-jsdoc
-function getBestiaryLevel(userProfile) {
-  try {
-    if (userProfile.bestiary?.kills === undefined) {
-      return null;
-    }
-
-    const output = {};
-    let tiersUnlocked = 0;
-    for (const [category, data] of Object.entries(Constants.bestiary)) {
-      const { mobs } = data;
-      output[category] = {};
-
-      if (category === 'fishing') {
-        for (const [key, value] of Object.entries(data)) {
-          output[category][key] = {
-            mobs: formatBestiaryMobs(userProfile, value.mobs)
-          };
-          tiersUnlocked += output[category][key].mobs.reduce((acc, cur) => acc + cur.tier, 0);
-        }
-      } else {
-        output[category].mobs = formatBestiaryMobs(userProfile, mobs);
-        tiersUnlocked += output[category].mobs.reduce((acc, cur) => acc + cur.tier, 0);
-      }
-    }
-
-    return tiersUnlocked / 10;
-  } catch (error) {
-    // eslint-disable-next-line no-console
-    console.log(error);
-    return null;
-  }
-}
-
-// eslint-disable-next-line require-jsdoc
-function getSlayer(data) {
-  if (!data?.slayer?.slayer_bosses) return;
-  return {
-    zombie: getSlayerLevel(data?.slayer?.slayer_bosses?.zombie),
-    spider: getSlayerLevel(data?.slayer?.slayer_bosses?.spider),
-    wolf: getSlayerLevel(data?.slayer?.slayer_bosses?.wolf),
-    enderman: getSlayerLevel(data?.slayer?.slayer_bosses?.enderman),
-    blaze: getSlayerLevel(data?.slayer?.slayer_bosses?.blaze),
-    vampire: getSlayerLevel(data?.slayer?.slayer_bosses?.vampire)
-  };
-}
-// eslint-disable-next-line require-jsdoc
-function getDungeons(data) {
-  return {
-    types: {
-      catacombs: getLevelByXp(
-        data.dungeons?.dungeon_types?.catacombs ? data.dungeons.dungeon_types.catacombs.experience : null,
-        'dungeons'
-      )
-    },
-    classes: {
-      healer: getLevelByXp(
-        data.dungeons?.player_classes?.healer ? data.dungeons.player_classes.healer.experience : null,
-        'dungeons'
-      ),
-      mage: getLevelByXp(
-        data.dungeons?.player_classes?.mage ? data.dungeons.player_classes.mage.experience : null,
-        'dungeons'
-      ),
-      berserk: getLevelByXp(
-        data.dungeons?.player_classes?.berserk ? data.dungeons.player_classes.berserk.experience : null,
-        'dungeons'
-      ),
-      archer: getLevelByXp(
-        data.dungeons?.player_classes?.archer ? data.dungeons.player_classes.archer.experience : null,
-        'dungeons'
-      ),
-      tank: getLevelByXp(
-        data.dungeons?.player_classes?.tank ? data.dungeons.player_classes.tank.experience : null,
-        'dungeons'
-      )
-    }
-  };
-}
-// eslint-disable-next-line require-jsdoc
-function getJacobData(data) {
-  if (!data.m.jacobs_contest) {
-    return {
-      medals: {
-        bronze: 0,
-        silver: 0,
-        gold: 0
-      },
-      perks: {
-        doubleDrops: 0,
-        farmingLevelCap: 0,
-        personalBests: false
-      },
-      contests: {}
-    };
-  }
-  return {
-    medals: data.m.jacobs_contest.medals_inv
-      ? {
-          bronze: data.m.jacobs_contest.medals_inv.bronze || 0,
-          silver: data.m.jacobs_contest.medals_inv.silver || 0,
-          gold: data.m.jacobs_contest.medals_inv.gold || 0
-        }
-      : { bronze: 0, silver: 0, gold: 0 },
-    perks: data.m.jacobs_contest.perks
-      ? {
-          doubleDrops: data.m.jacobs_contest.perks.double_drops || 0,
-          farmingLevelCap: data.m.jacobs_contest.perks.farming_level_cap || 0,
-          personalBests: data.m.jacobs_contest.perks.personal_bests || false
-        }
-      : { doubleDrops: 0, farmingLevelCap: 0, personalBests: false },
-    contests: data.m.jacobs_contest.contests || {}
-  };
-}
-// eslint-disable-next-line require-jsdoc
-function getPetLevel(petExp, offsetRarity, maxLevel) {
-  const rarityOffset = Constants.pet_rarity_offset[offsetRarity];
-  const levels = Constants.pet_levels.slice(rarityOffset, rarityOffset + maxLevel - 1);
-
-  const xpMaxLevel = levels.reduce((a, b) => a + b, 0);
-  let xpTotal = 0;
-  let level = 1;
-
-  let xpForNext = Infinity;
-
-  for (let i = 0; i < maxLevel; i++) {
-    xpTotal += levels[i];
-
-    if (xpTotal > petExp) {
-      xpTotal -= levels[i];
-      break;
-    } else {
-      level++;
-    }
-  }
-
-  let xpCurrent = Math.floor(petExp - xpTotal);
-  let progress;
-
-  if (level < maxLevel) {
-    xpForNext = Math.ceil(levels[level - 1]);
-    progress = Math.max(0, Math.min(xpCurrent / xpForNext, 1));
-  } else {
-    level = maxLevel;
-    xpCurrent = petExp - levels[maxLevel - 1];
-    xpForNext = 0;
-    progress = 1;
-  }
-
-  return {
-    level,
-    xpCurrent,
-    xpForNext,
-    progress,
-    xpMaxLevel
-  };
-}
 /**
  * @typedef {object} SkyblockMemberEquipment
  * @property {SkyblockInventoryItem|null} gauntlet Gauntlet
@@ -916,13 +726,58 @@ function getPetLevel(petExp, offsetRarity, maxLevel) {
  * @property {number} farmingLevelCap Farming level cap
  * @property {boolean} personalBests Personal Bests
  */
+/**
+ * @typedef {object} jacobDataMedals
+ * @property {number} gold gold medals
+ * @property {number} silver silver medals
+ * @property {number} bronze bronze medals
+ */
 /**
  * @typedef {object} jacobData
- * @property {object} medals Medals
- * @property {number} medals.bronze Bronze medals
- * @property {number} medals.silver Silver medals
- * @property {number} medals.gold Gold medals
+ * @property {jacobDataMedals} medals Medals
  * @property {jacobDataPerks} perks Perks
  * @property {object} contests Contests
  */
+/**
+ * @typedef {object} chocolateFactoryDataEmployees
+ * @property {number} bro bro employee level
+ * @property {number} cousin cousin employee level
+ * @property {number} sis sis employee level
+ * @property {number} father father employee level
+ * @property {number} grandma grandma employee level
+ * @property {number} dog dog employee level
+ * @property {number} uncle uncle employee level
+ */
+/**
+ * @typedef {object} chocolateFactoryDataChocolate
+ * @property {number} count amount of current chocolate
+ * @property {number} total total amount of chocolate
+ * @property {number} sincePrestige amount of chocolate since prestige
+ */
+/**
+ * @typedef {object} chocolateFactoryDataTimeTower
+ * @property {number} charge amount of charges in the time tower
+ * @property {number} level level of the time tower
+ */
+/**
+ * @typedef {object} chocolateFactoryDataUpgrades
+ * @property {number} click amount of click upgrades
+ * @property {number} multiplier amount of multiplier upgrades
+ * @property {number} rabbitRarity amount of rabbit rarity upgrades
+ */
+/**
+ * @typedef {object} chocolateFactoryDataGoldenClick
+ * @property {number} amount amount of golden clicks
+ * @property {number} year year
+ */
+/**
+ * @typedef {object} chocolateFactoryData
+ * @property {chocolateFactoryDataEmployees} employees Employees
+ * @property {chocolateFactoryDataChocolate} chocolate Chocolate
+ * @property {chocolateFactoryDataTimeTower} timeTower Time Tower
+ * @property {chocolateFactoryDataUpgrades} upgrades Upgrades
+ * @property {chocolateFactoryDataGoldenClick} goldenClick Golden Click
+ * @property {number} barnCapacity Barn Capacity
+ * @property {number} prestige Prestige
+ */
 module.exports = SkyblockMember;

package/src/structures/SkyBlock/SkyblockPet.js

@@ -1,5 +1,4 @@
-// eslint-disable-next-line camelcase
-const { pet_score } = require('../../utils/Constants');
+const { petScore } = require('../../utils/Constants');
 /**
  * Skyblock Pet class
  */
@@ -38,8 +37,8 @@ class SkyblockPet {
      * Skyblock Pet score
      * @type {number}
      */
-    // eslint-disable-next-line camelcase
-    this.petScore = pet_score[data.tier] || 0;
+
+    this.petScore = petScore[data.tier] || 0;
     /**
      * Skyblock Pet held item
      * @type {string|null}

package/src/structures/SkyBlock/Static/Bingo.js

@@ -1,3 +1,9 @@
+// eslint-disable-next-line jsdoc/require-jsdoc
+function parsePosition(position) {
+  const x = (position % 5) + 1;
+  const y = Math.floor(position / 5) + 1;
+  return [x, y];
+}
 /**
  * Bingo class
  */
@@ -50,7 +56,7 @@ class Bingo {
      * Difference between each tier requirement, if it is constant
      * @type {number|null}
      */
-    this.tierStep = this.#getTierStep();
+    this.tierStep = this.getTierStep();
     /**
      * Only available for ONE_TIERED bingos
      * @type {number|null}
@@ -78,10 +84,10 @@ class Bingo {
    * @private
    * @returns {number|null}
    */
-  #getTierStep() {
-    if (this.type !== 'TIERED') return null;
+  getTierStep() {
+    if ('TIERED' !== this.type) return null;
     // No step possible
-    if (this.tiers.length < 2) return null;
+    if (2 > this.tiers.length) return null;
     const hypotheticStep = this.tiers[1] - this.tiers[0];
     // Check if every 2 elements have the same step
     const isConstant = this.tiers.slice(1).every((el, index) => {
@@ -92,11 +98,4 @@ class Bingo {
   }
 }
 
-// eslint-disable-next-line require-jsdoc
-function parsePosition(position) {
-  const x = (position % 5) + 1;
-  const y = Math.floor(position / 5) + 1;
-  return [x, y];
-}
-
 module.exports = Bingo;

package/src/structures/SkyBlock/Static/BingoData.js

@@ -37,7 +37,7 @@ class BingoData {
    * @returns {Bingo|undefined}
    */
   getGoal(column, row) {
-    if (!this.goals || this.goals.length < 1) return;
+    if (!this.goals || 1 > this.goals.length) return;
     return this.goals.find((goal) => goal.row === row && goal.column === column);
   }
 }

package/src/structures/Static/Achievement.js

@@ -1,5 +1,17 @@
 const AchievementTier = require('./AchievementTier');
 
+// eslint-disable-next-line jsdoc/require-jsdoc
+function collectAll(data) {
+  const mTier = data.maxTier;
+  let totalPoints = 0;
+  let totalAmount = 0;
+  for (let i = 1; i <= mTier; i++) {
+    totalPoints += data.getTier(i).pointsRewarded;
+    totalAmount += data.getTier(i).amountRequired;
+  }
+  return { totalPoints, totalAmount };
+}
+
 /**
  * Achievement Class
  */
@@ -48,20 +60,20 @@ class Achievement {
      * ONLY AVAILABLE FOR TIERED
      * @type {AchievementTier|null}
      */
-    this.tierInformation = this.type === 'TIERED' ? new AchievementTier(data.tiers) : null;
+    this.tierInformation = 'TIERED' === this.type ? new AchievementTier(data.tiers) : null;
 
-    const { totalPoints, totalAmount } = this.type === 'TIERED' ? collectAll(this.tierInformation) : {};
+    const { totalPoints, totalAmount } = 'TIERED' === this.type ? collectAll(this.tierInformation) : {};
     /**
      * Total points worth (sum of all tiers if tiered)
      * This is always 0 for Guild Achievements
      * @type {number}
      */
-    this.points = this.type === 'ONE_TIME' ? parseInt(data.points, 10) : totalPoints;
+    this.points = 'ONE_TIME' === this.type ? parseInt(data.points, 10) : totalPoints;
     /**
      * Total amount required to reach max tier, only for tiered
      * @type {number|null}
      */
-    this.totalAmountRequired = this.type === 'TIERED' ? totalAmount : null;
+    this.totalAmountRequired = 'TIERED' === this.type ? totalAmount : null;
   }
   /**
    * As string
@@ -72,15 +84,4 @@ class Achievement {
   }
 }
 
-// eslint-disable-next-line require-jsdoc
-function collectAll(data) {
-  const mTier = data.maxTier;
-  let totalPoints = 0;
-  let totalAmount = 0;
-  for (let i = 1; i <= mTier; i++) {
-    totalPoints += data.getTier(i).pointsRewarded;
-    totalAmount += data.getTier(i).amountRequired;
-  }
-  return { totalPoints, totalAmount };
-}
 module.exports = Achievement;

package/src/structures/Static/AchievementTier.js

@@ -13,7 +13,7 @@ class AchievementTier {
      */
     this.maxTier = data.length;
     // Still make sure it is well sorted
-    this._tierInfo = data.sort(({ tier: tierA }, { tier: tierB }) => Number(tierA) - Number(tierB));
+    this.tierInfo = data.sort(({ tier: tierA }, { tier: tierB }) => Number(tierA) - Number(tierB));
   }
   /**
    * Gets information for tier
@@ -22,7 +22,7 @@ class AchievementTier {
    */
   getTier(tier) {
     const index = tier - 1;
-    const info = this._tierInfo[index];
+    const info = this.tierInfo[index];
     return {
       pointsRewarded: parseInt(info.points, 10) || 0,
       amountRequired: parseInt(info.amount, 10) || 0

package/src/structures/Static/Quest.js

@@ -26,14 +26,14 @@ class Quest {
      * Type of quest
      * @type {'DAILY'|'WEEKLY'}
      */
-    this.type = data.requirements?.[0].type === 'DailyResetQuestRequirement' ? 'DAILY' : 'WEEKLY';
+    this.type = 'DailyResetQuestRequirement' === data.requirements?.[0].type ? 'DAILY' : 'WEEKLY';
     /**
      * Objectives
      * @type {Objective[]}
      */
     this.objectives = data.objectives.map((objective) => ({
       id: objective.id,
-      type: objective.type === 'IntegerObjective' ? 'Integer' : 'Boolean',
+      type: 'IntegerObjective' === objective.type ? 'Integer' : 'Boolean',
       amountNeeded: parseInt(objective.integer || '1', 10)
     }));
     /**