hypixel-api-reborn 11.1.0 → 11.2.1

package/src/utils/SkyblockUtils.js

@@ -1,208 +1,470 @@
-/* eslint-disable camelcase */
+/* eslint-disable jsdoc/require-jsdoc */
 const constants = require('./Constants');
-module.exports = {
-  async decode(base64, isBuffer = false) {
-    const nbt = require('prismarine-nbt');
-    const parseNbt = require('util').promisify(nbt.parse);
-    const buffer = isBuffer ? base64 : Buffer.from(base64, 'base64');
-    let data = await parseNbt(buffer);
-    data = nbt.simplify(data);
-    const newdata = [];
-    for (let i = 0; i < data.i.length; i++) {
-      newdata.push(data.i[i]);
-    }
-    return newdata;
-  },
-  getLevelByXp(xp, type, levelCap) {
-    let xpTable;
-    switch (type) {
-      case 'runecrafting':
-        xpTable = constants.runecrafting_xp;
-        break;
-      case 'dungeons':
-        xpTable = constants.dungeon_xp;
-        break;
-      case 'hotm':
-        xpTable = constants.hotm_xp;
-        break;
-      default:
-        xpTable = constants.leveling_xp;
-    }
-    let maxLevel = Math.max(...Object.keys(xpTable));
-    if ((constants.skills_cap[type] ?? maxLevel) > maxLevel) {
-      xpTable = Object.assign(constants.xp_past_50, xpTable);
-      maxLevel = typeof levelCap === 'number' ? maxLevel + levelCap : Math.max(...Object.keys(xpTable));
-    }
-    if (isNaN(xp)) {
-      return {
-        xp: 0,
-        level: 0,
-        maxLevel,
-        xpCurrent: 0,
-        xpForNext: xpTable[1],
-        progress: 0
-      };
-    }
-    let xpTotal = 0;
-    let level = 0;
-    let xpForNext = 0;
-    for (let x = 1; x <= maxLevel; x++) {
-      if (!xpTable[x]) continue;
-      xpTotal += xpTable[x];
-      if (xpTotal > xp) {
-        xpTotal -= xpTable[x];
-        break;
-      } else {
-        level = x;
-      }
-    }
-    const xpCurrent = Math.floor(xp - xpTotal);
-    if (level < maxLevel) xpForNext = Math.ceil(xpTable[level + 1]);
-    const progress = Math.floor(Math.max(0, Math.min(xpCurrent / xpForNext, 1)) * 100 * 10) / 10;
 
+async function decode(base64, isBuffer = false) {
+  const nbt = require('prismarine-nbt');
+  const parseNbt = require('util').promisify(nbt.parse);
+  const buffer = isBuffer ? base64 : Buffer.from(base64, 'base64');
+  let data = await parseNbt(buffer);
+  data = nbt.simplify(data);
+  const newdata = [];
+  for (let i = 0; i < data.i.length; i++) {
+    newdata.push(data.i[i]);
+  }
+  return newdata;
+}
+
+function getLevelByXp(xp, type, levelCap) {
+  let xpTable;
+  switch (type) {
+    case 'runecrafting':
+      xpTable = constants.runecraftingXp;
+      break;
+    case 'dungeons':
+      xpTable = constants.dungeonXp;
+      break;
+    case 'hotm':
+      xpTable = constants.hotmXp;
+      break;
+    case 'social':
+      xpTable = constants.socialXp;
+      break;
+    default:
+      xpTable = constants.levelingXp;
+  }
+  let maxLevel = Math.max(...Object.keys(xpTable));
+  if ((constants.skillsCap[type] ?? maxLevel) > maxLevel) {
+    xpTable = Object.assign(constants.xpPast50, xpTable);
+    maxLevel = 'number' === typeof levelCap ? maxLevel + levelCap : Math.max(...Object.keys(xpTable));
+  }
+  if (isNaN(xp)) {
     return {
-      xp,
-      level,
+      xp: 0,
+      level: 0,
       maxLevel,
-      xpCurrent,
-      xpForNext,
-      progress
+      xpCurrent: 0,
+      xpForNext: xpTable[1],
+      progress: 0,
+      cosmetic: Boolean('runecrafting' === type || 'social' === type)
     };
-  },
-  getLevelByAchievement(achievementLevel, type) {
-    let xpTable = constants.leveling_xp;
-    let maxLevel = Math.max(...Object.keys(xpTable));
-    if (constants.skills_cap[type] > maxLevel && type in constants.skills_achievements) {
-      xpTable = Object.assign(constants.xp_past_50, xpTable);
-      maxLevel = Math.max(...Object.keys(xpTable));
-    }
-    if (isNaN(achievementLevel)) {
-      return {
-        xp: 0,
-        level: 0,
-        maxLevel,
-        xpCurrent: 0,
-        xpForNext: xpTable[1],
-        progress: 0
-      };
-    }
-    let xpTotal = 0;
-    let xpForNext = 0;
-    for (let x = 1; x <= achievementLevel; x++) {
-      xpTotal += xpTable[x];
+  }
+  let xpTotal = 0;
+  let level = 0;
+  let xpForNext = 0;
+  for (let x = 1; x <= maxLevel; x++) {
+    if (!xpTable[x]) continue;
+    xpTotal += xpTable[x];
+    if (xpTotal > xp) {
+      xpTotal -= xpTable[x];
+      break;
+    } else {
+      level = x;
     }
-    if (achievementLevel < maxLevel) xpForNext = Math.ceil(xpTable[achievementLevel + 1]);
+  }
+  const xpCurrent = Math.floor(xp - xpTotal);
+  if (level < maxLevel) xpForNext = Math.ceil(xpTable[level + 1]);
+  const progress = Math.floor(Math.max(0, Math.min(xpCurrent / xpForNext, 1)) * 100 * 10) / 10;
+
+  return {
+    xp: xp,
+    level: level,
+    maxLevel: maxLevel,
+    xpCurrent: xpCurrent,
+    xpForNext: xpForNext,
+    progress: progress,
+    cosmetic: Boolean('runecrafting' === type || 'social' === type)
+  };
+}
+
+function getSlayerLevel(slayer) {
+  if (!slayer) {
     return {
-      xp: xpTotal,
-      level: achievementLevel,
-      maxLevel,
-      xpCurrent: 0,
-      xpForNext,
-      progress: 0
+      xp: 0,
+      tier1: 0,
+      tier2: 0,
+      tier3: 0,
+      tier4: 0,
+      tier5: 0,
+      level: 0
     };
-  },
-  getSlayerLevel(slayer) {
-    if (!slayer) {
-      return {
-        xp: 0,
-        tier1: 0,
-        tier2: 0,
-        tier3: 0,
-        tier4: 0,
-        tier5: 0,
-        level: 0
-      };
+  }
+
+  // eslint-disable-next-line camelcase
+  const { claimed_levels } = slayer;
+  let level = 0;
+
+  // eslint-disable-next-line camelcase
+  for (const levelName in claimed_levels) {
+    if (Object.prototype.hasOwnProperty.call(claimed_levels, levelName)) {
+      const newLevel = parseInt(levelName.replace('_special', '').split('_').pop(), 10);
+      if (newLevel > level) {
+        level = newLevel;
+      }
+    }
+  }
+  return {
+    xp: slayer.xp || 0,
+    tier1: slayer.boss_kills_tier_0 || 0,
+    tier2: slayer.boss_kills_tier_1 || 0,
+    tier3: slayer.boss_kills_tier_2 || 0,
+    tier4: slayer.boss_kills_tier_3 || 0,
+    tier5: slayer.boss_kills_tier_4 || 0,
+    level
+  };
+}
+
+function getMemberStats(obj) {
+  return Object.keys(obj).reduce(
+    (result, currentKey) => {
+      const key = currentKey.replace(/_[a-z]/gi, (match) => match[1].toUpperCase());
+
+      if (currentKey.startsWith('kills') || currentKey.startsWith('deaths')) {
+        const category = currentKey.startsWith('kills') ? 'kills' : 'deaths';
+        const subKey = key === category ? 'total' : key;
+
+        result[category][
+          subKey.replace(category, (sub, _, key) => {
+            return key[sub.length].toLowerCase() + key.slice(sub.length + 1);
+          })
+        ] = obj[currentKey];
+      } else {
+        result[key] = obj[currentKey];
+      }
+
+      return result;
+    },
+    { kills: {}, deaths: {} }
+  );
+}
+
+function getTrophyFishRank(level) {
+  if (1 === level) {
+    return 'Bronze';
+  } else if (2 === level) {
+    return 'Silver';
+  } else if (3 === level) {
+    return 'Gold';
+  } else if (4 === level) {
+    return 'Diamond';
+  }
+  return 'Bronze';
+}
+
+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) => true !== skill.cosmetic)
+    .map((skill) => skill.level);
+  skillsObject.average = levels.reduce((a, b) => a + b, 0) / levels.length;
+  return skillsObject;
+}
+
+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;
+}
+
+function getBestiaryLevel(userProfile) {
+  try {
+    if (userProfile.bestiary?.kills === undefined) {
+      return null;
     }
-    const { claimed_levels } = slayer;
-    let level = 0;
-    for (const level_name in claimed_levels) {
-      if (Object.prototype.hasOwnProperty.call(claimed_levels, level_name)) {
-        const _level = parseInt(level_name.replace('_special', '').split('_').pop(), 10);
-        if (_level > level) {
-          level = _level;
+
+    const output = {};
+    let tiersUnlocked = 0;
+    for (const [category, data] of Object.entries(constants.bestiary)) {
+      const { mobs } = data;
+      output[category] = {};
+
+      if ('fishing' === category) {
+        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;
+  }
+}
+
+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)
+  };
+}
+
+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'
+      )
+    }
+  };
+}
+
+function getJacobData(data) {
+  if (!data.jacobs_contest) {
     return {
-      xp: slayer.xp || 0,
-      tier1: slayer.boss_kills_tier_0 || 0,
-      tier2: slayer.boss_kills_tier_1 || 0,
-      tier3: slayer.boss_kills_tier_2 || 0,
-      tier4: slayer.boss_kills_tier_3 || 0,
-      tier5: slayer.boss_kills_tier_4 || 0,
-      level
+      medals: {
+        bronze: 0,
+        silver: 0,
+        gold: 0
+      },
+      perks: {
+        doubleDrops: 0,
+        farmingLevelCap: 0,
+        personalBests: false
+      },
+      contests: {}
     };
-  },
-  getSlayerLevelByXp(xp) {
-    const { slayer_xp } = constants;
-    const maxLevel = Math.max(...Object.keys(slayer_xp));
-    let level = 0;
-    for (let x = 1; x <= maxLevel && slayer_xp[x] <= xp; x++) {
-      level = x;
-    }
-    return level;
-  },
-  getBonusStat(level, skill, max, incremention) {
-    const skill_stats = constants.bonus_stats[skill];
-    const steps = Object.keys(skill_stats)
-      .sort((a, b) => Number(a) - Number(b))
-      .map((a) => Number(a));
-    const bonus = Object.assign({}, constants.stat_template);
-    for (let x = steps[0]; x <= max; x += incremention) {
-      if (level < x) {
-        break;
-      }
-      const skill_step = steps
-        .slice()
-        .reverse()
-        .find((a) => a <= x);
-      const skill_bonus = skill_stats[skill_step];
-      for (const skill in skill_bonus) {
-        if (Object.prototype.hasOwnProperty.call(skill_bonus, skill)) {
-          bonus[skill] += skill_bonus[skill];
+  }
+  return {
+    medals: data.jacobs_contest.medals_inv
+      ? {
+          bronze: data.jacobs_contest.medals_inv.bronze || 0,
+          silver: data.jacobs_contest.medals_inv.silver || 0,
+          gold: data.jacobs_contest.medals_inv.gold || 0
         }
-      }
-    }
-    return bonus;
-  },
-  getEffectiveHealth(health, defense) {
-    if (defense <= 0) return health;
-    return Math.round(health * (1 + defense / 100));
-  },
-  getMemberStats(obj) {
-    return Object.keys(obj).reduce(
-      (result, currentKey) => {
-        const key = currentKey.replace(/_[a-z]/gi, (match) => match[1].toUpperCase());
-
-        if (currentKey.startsWith('kills') || currentKey.startsWith('deaths')) {
-          const category = currentKey.startsWith('kills') ? 'kills' : 'deaths';
-          const subKey = key === category ? 'total' : key;
-
-          result[category][
-            subKey.replace(category, (sub, _, key) => {
-              return key[sub.length].toLowerCase() + key.slice(sub.length + 1);
-            })
-          ] = obj[currentKey];
-        } else {
-          result[key] = obj[currentKey];
+      : { bronze: 0, silver: 0, gold: 0 },
+    perks: data.jacobs_contest.perks
+      ? {
+          doubleDrops: data.jacobs_contest.perks.double_drops || 0,
+          farmingLevelCap: data.jacobs_contest.perks.farming_level_cap || 0,
+          personalBests: data.jacobs_contest.perks.personal_bests || false
         }
+      : { doubleDrops: 0, farmingLevelCap: 0, personalBests: false },
+    contests: data.jacobs_contest.contests || {}
+  };
+}
 
-        return result;
+function getChocolateFactory(data) {
+  if (!data?.events?.easter) {
+    return {
+      employees: {
+        bro: 0,
+        cousin: 0,
+        sis: 0,
+        father: 0,
+        grandma: 0,
+        dog: 0,
+        uncle: 0
+      },
+      chocolate: {
+        current: 0,
+        total: 0,
+        sincePrestige: 0
+      },
+      timeTower: {
+        charges: 0,
+        level: 0
+      },
+      upgrades: {
+        click: 0,
+        multiplier: 0,
+        rabbitRarity: 0
+      },
+      goldenClick: {
+        amount: 0,
+        year: 0
       },
-      { kills: {}, deaths: {} }
-    );
-  },
-  getTrophyFishRank(level) {
-    if (level === 1) {
-      return 'Bronze';
-    } else if (level === 2) {
-      return 'Silver';
-    } else if (level === 3) {
-      return 'Gold';
-    } else if (level === 4) {
-      return 'Diamond';
+      barnCapacity: 0,
+      prestige: 0
+    };
+  }
+  return {
+    employees: {
+      bro: data?.events?.easter?.employees?.rabbit_bro || 0,
+      cousin: data?.events?.easter?.employees?.rabbit_cousin || 0,
+      sis: data?.events?.easter?.employees?.rabbit_sis || 0,
+      father: data?.events?.easter?.employees?.rabbit_father || 0,
+      grandma: data?.events?.easter?.employees?.rabbit_grandma || 0,
+      dog: data?.events?.easter?.employees?.rabbit_dog || 0,
+      uncle: data?.events?.easter?.employees?.rabbit_uncle || 0
+    },
+    chocolate: {
+      current: data?.events?.easter?.chocolate || 0,
+      total: data?.events?.easter?.total_chocolate || 0,
+      sincePrestige: data?.events?.easter?.chocolate_since_prestige || 0
+    },
+    timeTower: {
+      charges: data?.events?.easter?.time_tower?.charges || 0,
+      level: data?.events?.easter?.time_tower?.level || 0
+    },
+    upgrades: {
+      click: data?.events?.easter?.click_upgrades || 0,
+      multiplier: data?.events?.easter?.chocolate_multiplier_upgrades || 0,
+      rabbitRarity: data?.events?.easter?.rabbit_rarity_upgrades || 0
+    },
+    goldenClick: {
+      amount: data?.events?.easter?.golden_click_amount || 0,
+      year: data?.events?.easter?.golden_click_year || 0
+    },
+    barnCapacity: data?.events?.easter?.rabbit_barn_capacity_level || 0,
+    prestige: data?.events?.easter?.chocolate_level || 0
+  };
+}
+
+function getPetLevel(petExp, offsetRarity, maxLevel) {
+  const rarityOffset = constants.petRarityOffset[offsetRarity];
+  const levels = constants.petLevels.slice(rarityOffset, rarityOffset + maxLevel - 1);
+
+  const xpMaxLevel = levels.reduce((a, b) => a + b, 0);
+  let xpTotal = 0;
+  let level = 1;
+
+  let xpForNext;
+
+  for (let i = 0; i < maxLevel; i++) {
+    xpTotal += levels[i];
+
+    if (xpTotal > petExp) {
+      xpTotal -= levels[i];
+      break;
     } else {
-      return 'Bronze';
+      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
+  };
+}
+
+function parseRarity(stringContainingRarity) {
+  const rarityArray = [
+    'COMMON',
+    'UNCOMMON',
+    'RARE',
+    'EPIC',
+    'LEGENDARY',
+    'MYTHIC',
+    'DIVINE',
+    'SPECIAL',
+    'VERY SPECIAL'
+  ];
+  for (const rarity of rarityArray) {
+    if (stringContainingRarity.includes(rarity)) return rarity;
+  }
+}
+
+function parseGearScore(lore) {
+  for (const line of lore) {
+    if (line.match(/Gear Score: §[0-9a-f](\d+)/)) return Number(line.match(/Gear Score: §d(\d+)/)[1]);
+  }
+}
+
+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;
+}
+
+module.exports = {
+  decode,
+  getLevelByXp,
+  getMemberStats,
+  getTrophyFishRank,
+  getSkills,
+  getBestiaryLevel,
+  getSlayer,
+  getDungeons,
+  getJacobData,
+  getChocolateFactory,
+  getPetLevel,
+  parseRarity,
+  parseGearScore,
+  populateGoals
 };

package/src/utils/arrayTools.js

@@ -1,4 +1,4 @@
 module.exports = {
-  isStrArray: (input) => Array.isArray(input) || typeof input === 'string',
+  isStrArray: (input) => Array.isArray(input) || 'string' === typeof input,
   strToArray: (input) => [input].flat()
 };

package/src/utils/divide.js

@@ -1,5 +1,5 @@
 module.exports = (a = 0, b = 1) => {
-  const out = +((a || 0) / (b || 0)).toFixed(2) || 0;
+  const out = Number(((a || 0) / (b || 0)).toFixed(2)) || 0;
   if (isFinite(out)) return out;
   return a;
 };

package/src/utils/index.js

@@ -2,12 +2,13 @@ module.exports = {
   arrayTool: require('./arrayTools'),
   Constants: require('./Constants'),
   divide: require('./divide'),
+  guild: require('./Guild'),
   isGuildID: require('./isGuildID'),
   isUUID: require('./isUUID'),
   oscillation: require('./oscillation'),
+  player: require('./Player'),
   removeSnakeCase: require('./removeSnakeCase'),
   SkyblockUtils: require('./SkyblockUtils'),
-  toIGN: require('./toIGN'),
   toUuid: require('./toUuid'),
   varInt: require('./varInt')
 };

package/src/utils/isGuildID.js

@@ -1,3 +1,3 @@
 module.exports = (id) => {
-  return id.length === 24;
+  return 24 === id.length;
 };