hypixel-api-reborn 8.3.0 → 10.0.0

package/src/structures/MiniGames/TurboKartRacers.js

@@ -41,6 +41,136 @@ class TurboKartRacers {
      * @type {number}
      */
     this.boxPickups = data.box_pickups || 0;
+    /**
+     * Horn
+     * @type {'DEFAULT' | 'SHY' | 'ALIEN' | 'TAXI' | 'KLAXON' | 'TRICYCLE' | 'ALARM' | 'KLOON' | 'TEDDY' | 'TRUCK' | 'JERRY'}
+     */
+    this.horn = data.horn || 'DEFAULT';
+    /**
+     * Retro Map Plays
+     * @type {number}
+     */
+    this.retroPlays = data.retro_plays || 0;
+    /**
+     * Hypixel GP Map Plays
+     * @type {number}
+     */
+    this.hypixelgpPlays = data.hypixelgp_plays || 0;
+    /**
+     * Olympus Map Plays
+     * @type {number}
+     */
+    this.olympusPlays = data.olympus_plays || 0;
+    /**
+     * Jungle Rush Map Plays
+     * @type {number}
+     */
+    this.junglerushPlays = data.junglerush_plays || 0;
+    /**
+     * Canyon Map Plays
+     * @type {number}
+     */
+    this.canyonPlays = data.canyon_plays || 0;
+    /**
+     * Retro Bronze Trophies
+     * @type {number}
+     */
+    this.retroBronzeTrophies = data.bronze_trophy_retro || 0;
+    /**
+    * Jungle Rush Map Plays
+    * @type {number}
+    */
+    this.retroSilverTrophies = data.silver_trophy_retro || 0;
+    /**
+     * Jungle Rush Map Plays
+     * @type {number}
+     */
+    this.retroGoldTrophies = data.gold_trophy_retro || 0;
+    /**
+     * hypixelgp Bronze Trophies
+     * @type {number}
+     */
+    this.hypixelgpBronzeTrophies = data.bronze_trophy_hypixelgp || 0;
+    /**
+    * hypixelgp Silver Trophies
+    * @type {number}
+    */
+    this.hypixelgpSilverTrophies = data.silver_trophy_hypixelgp || 0;
+    /**
+     * hypixelgp Gold Trophies
+     * @type {number}
+     */
+    this.hypixelgpGoldTrophies = data.gold_trophy_hypixelgp || 0;
+    /**
+     * olympus Bronze Trophies
+     * @type {number}
+     */
+    this.olympusBronzeTrophies = data.bronze_trophy_olympus || 0;
+    /**
+    * olympus Silver Trophies
+    * @type {number}
+    */
+    this.olympusSilverTrophies = data.silver_trophy_olympus || 0;
+    /**
+     * olympus Gold Trophies
+     * @type {number}
+     */
+    this.olympusGoldTrophies = data.gold_trophy_olympus || 0;
+    /**
+     * junglerush Bronze Trophies
+     * @type {number}
+     */
+    this.junglerushBronzeTrophies = data.bronze_trophy_junglerush || 0;
+    /**
+     * junglerush Silver Trophies
+     * @type {number}
+     */
+    this.junglerushSilverTrophies = data.silver_trophy_junglerush || 0;
+    /**
+     * junglerush Gold Trophies
+     * @type {number}
+     */
+    this.junglerushGoldTrophies = data.gold_trophy_junglerush || 0;
+    /**
+     * Canyon Bronze Trophies
+     * @type {number}
+     */
+    this.canyonBronzeTrophies = data.gold_trophy_canyon || 0;
+    /**
+     * Canyon Silver Trophies
+     * @type {number}
+     */
+    this.canyonSilverTrophies = data.gold_trophy_canyon || 0;
+    /**
+     * Canyon Gold Trophies
+     * @type {number}
+     */
+    this.canyonGoldTrophies = data.gold_trophy_canyon || 0;
+    /**
+     * Bananas Recived
+     * @type {number}
+     */
+    this.bananaHitsReceived = data.banana_hits_received || 0;
+    /**
+    * Bananas Sent
+    * @type {number}
+    */
+    this.bananaHitsSent = data.banana_hits_sent || 0;
+    /**
+     * Blue Torpedos Hit
+     * @type {number}
+     */
+    this.blueTorpedoHit = data.blue_torpedo_hit || 0;
+    /**
+     * Grand Prix Status
+     * @type {boolean}
+     */
+    this.grandPrix = data.grand_prix || 'false';
+    /**
+     * Grand Prix Tokens
+     * @type {number}
+     */
+    this.grandPrixTokens = data.grand_prix_tokens || 0;
   }
 }
 module.exports = TurboKartRacers;

package/src/structures/Player.js

@@ -15,7 +15,6 @@ const ArenaBrawl = require('./MiniGames/ArenaBrawl');
 const Arcade = require('./MiniGames/Arcade');
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const Pit = require('./MiniGames/Pit');
-const getRecentGames = require('../API/getRecentGames');
 const Color = require('./Color');
 const Game = require('./Game');
 const PlayerCosmetics = require('./PlayerCosmetics');
@@ -31,9 +30,9 @@ const Warlords = require('./MiniGames/Warlords');
 class Player {
   /**
    * @param {object} data Player data
-   * @param {object} fakethis
+   * @param {Record<string, any>} extraPayload extra data requested alongside player
    */
-  constructor (data, fakethis) {
+  constructor (data, extraPayload) {
     /**
      * Player nickname
      * @type {string}
@@ -103,18 +102,12 @@ class Player {
      * Player's plus color (must be a MVP+ rank)
      * @type {Color|null}
      */
-    this.plusColor = this.rank === 'MVP+' || this.rank === 'MVP++' ? (data.rankPlusColor ? new Color(data.rankPlusColor) : null) : null;
+    this.plusColor = this.rank === 'MVP+' || this.rank === 'MVP++' ? (data.rankPlusColor ? new Color(data.rankPlusColor) : new Color('RED')) : null;
     /**
      * MVP++ prefix color
      * @type {Color|null}
      */
     this.prefixColor = this.rank === 'MVP++' ? (data.monthlyRankColor ? new Color(data.monthlyRankColor) : new Color('GOLD')) : null;
-    /**
-     * Player's guild. Guild option must be `true`. <br>
-     * Example: {@link Client#getPlayer}
-     * @type {Guild}
-     */
-    this.guild = data.guild ? data.guild : null;
     /**
      * Player karma
      * @type {number}
@@ -206,18 +199,21 @@ class Player {
      */
     this.levelProgress = playerLevelProgress(data);
     /**
-     * Player recent games
-     * @return {Promise<Array<RecentGame>>}
+     * Player's Guild if requested in options
+     * @type {Guild|null}
      */
-    this.getRecentGames = function () {
-      return getRecentGames.call(fakethis, this.uuid, this);
-    };
+    this.guild = extraPayload?.guild || null;
+    /**
+     * Recent Games if requested in options
+     * @type {RecentGame[]|null}
+     */
+    this.recentGames = extraPayload?.recentGames || null;
     /**
      * Player stats for each mini-game
      * @type {PlayerStats}
      */
     this.stats = (data.stats ? {
-      skywars: (data.stats.SkyWars ? new SkyWars(data.stats.SkyWars) : null),
+      skywars: (data.stats.SkyWars ? new SkyWars(data.stats.SkyWars, extraPayload?.rankedSW || null) : 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),
@@ -287,14 +283,11 @@ function getRank (player) {
     rank = player.prefix.replace(/§[0-9|a-z]|\[|\]/g, '');
   } else if (player.rank && player.rank !== 'NORMAL') {
     switch (player.rank) {
-      case 'MODERATOR':
-        rank = 'Moderator';
-        break;
       case 'YOUTUBER':
         rank = 'YouTube';
         break;
-      case 'HELPER':
-        rank = 'Helper';
+      case 'GAME_MASTER':
+        rank = 'Game Master';
         break;
       case 'ADMIN':
         rank = 'Admin';
@@ -405,8 +398,7 @@ function parseClaimedRewards (data) {
  * * `MVP`
  * * `MVP+`
  * * `MVP++`
- * * `Helper`
- * * `Moderator`
+ * * `Game Master`
  * * `Admin`
  * * `YouTube`
  */

package/src/structures/ServerInfo.js

@@ -57,7 +57,7 @@ class ServerInfo {
      * Ping in ms
      * @type {number}
      */
-    this.ping = parseInt(ping);
+    this.ping = parseInt(ping, 10);
   }
   /**
    * toString override

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

@@ -1,5 +1,5 @@
 const dateRegExp = /(\d{1,2})(?:st|nd|rd|th|) ([A-z]+) (\d+)/;
-const versionRegExp = /v\d+(.\d+){1,}/;
+const versionRegExp = /v\d+(\.\d+){1,}/;
 /**
  * SkyblockNews
  */
@@ -61,8 +61,8 @@ function parseDate(stringDate) {
  * @returns {string | null}
  */
 function parseVer(stringVer) {
-  const matched = stringVer.match(versionRegExp)[0];
-  if (!matched) return null; // this shouldn't really happen
-  return matched;
+  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/SkyblockInventoryItem.js

@@ -1,3 +1,5 @@
+const rgbToHexColor = require('../../utils/rgbToHexColor');
+
 /**
  * Item class
  */
@@ -36,11 +38,30 @@ class SkyblockInventoryItem {
      * @type {string}
      */
     this.loreForEmbed = this.lore.replace(/§([0-9]|[a-f])|§/gm, '').replace(/<br>/gm, '\n');
+    /**
+     * Hexadecimal color code of armor
+     * @type {string}
+     */
+    this.color = data.tag.ExtraAttributes.color ? rgbToHexColor(data.tag.ExtraAttributes.color.split(':')) : null;
     /**
      * Item enchantments
      * @type {object}
      */
     this.enchantments = data.tag.ExtraAttributes.enchantments ? data.tag.ExtraAttributes.enchantments : null;
+    /**
+     * Armor reforge
+     * @type {string}
+     */
+    this.reforge = data.tag.ExtraAttributes.modifier ? data.tag.ExtraAttributes.modifier : null;
+    /**
+     * Equipment gemstones (if any)
+     * @type {SkyblockItemGemstone}
+     */
+    // eslint-disable-next-line no-new-object
+    this.gemstones = data.tag.ExtraAttributes.gems ? Object.entries(data.tag.ExtraAttributes.gems).map((gem) => new Object({
+      type: gem[0].split('_')[0],
+      quality: gem[1]
+    })) : null;
     /**
      * Anvil uses
      * @type {number}
@@ -85,7 +106,7 @@ class SkyblockInventoryItem {
  * @return {string}
  */
 function parseRarity (stringContainingRarity) {
-  const rarityArray = ['COMMON', 'UNCOMMON', 'RARE', 'EPIC', 'LEGENDARY', 'MYTHIC', 'SUPREME', 'SPECIAL', 'VERY SPECIAL'];
+  const rarityArray = ['COMMON', 'UNCOMMON', 'RARE', 'EPIC', 'LEGENDARY', 'MYTHIC', 'DIVINE', 'SPECIAL', 'VERY SPECIAL'];
   for (const rarity of rarityArray) {
     if (stringContainingRarity.includes(rarity)) return rarity;
   }
@@ -99,4 +120,11 @@ function parseGearScore (lore) {
     if (line.match(/Gear Score: §[0-9a-f](\d+)/)) return Number(line.match(/Gear Score: §d(\d+)/)[1]);
   }
 }
+
+/**
+ * @typedef {object} SkyblockItemGemstone
+ * @property {string} type Gemstone type
+ * @property {string} quality Gemstone quality (rough, flawed, fine, flawless, perfect)
+ */
+
 module.exports = SkyblockInventoryItem;

package/src/structures/SkyBlock/SkyblockMember.js

@@ -12,7 +12,7 @@ class SkyblockMember {
   /**
    * @param {object} data Skyblock member data
    */
-  constructor (data) {
+  constructor(data) {
     /**
      * Skyblock member UUID
      * @type {string}
@@ -53,22 +53,22 @@ class SkyblockMember {
      * Last save timestamp
      * @type {number}
      */
-    this.lastSave = data.m.last_save;
+    this.lastSaveTimestamp = data.m.last_save;
     /**
      * Last save timestamp as Date
      * @type {Date}
      */
     this.lastSaveAt = new Date(data.m.last_save);
+    /**
+     * Last save timestamp
+     * @type {number}
+     */
+    this.lastDeathTimestamp = data.m.last_death;
     /**
      * Last death timestamp as Date
      * @type {Date}
      */
     this.lastDeathAt = new Date(skyblock_year_0 + data.m.last_death * 1000);
-    /**
-     * Last save timestamp
-     * @type {number}
-     */
-    this.lastDeath = data.m.last_death;
     /**
      * Equipped armor
      * @return {Promise<SkyblockMemberArmor>}
@@ -84,6 +84,18 @@ class SkyblockMember {
       };
       return armor;
     };
+    /**
+     * Wardrobe contents
+     * @return {Promise<SkyblockMemberItem[]>}
+     */
+    this.getWardrobe = async () => {
+      const base64 = data.m?.wardrobe_contents?.data;
+      if (!base64) return [];
+      const decoded = await decode(base64);
+      const armor = decoded.filter((item) => Object.keys(item).length !== 0)
+        .map((item) => new SkyblockInventoryItem(item));
+      return armor;
+    };
     /**
      * Collected fairy souls
      * @type {number}
@@ -184,14 +196,14 @@ class SkyblockMember {
    * Skyblock Member pet score
    * @return {number}
    */
-  getPetScore () {
+  getPetScore() {
     return this.pets.reduce((acc, cur) => acc + (cur.petScore || 0), 0);
   }
   /**
    * UUID
    * @return {string}
    */
-  toString () {
+  toString() {
     return this.uuid;
   }
 }
@@ -199,7 +211,7 @@ class SkyblockMember {
  * @param {object} data
  * @return {object}
  */
-function getSkills (data) {
+function getSkills(data) {
   const skillsObject = {};
   if (!objectPath.has(data, 'experience_skill_foraging')) {
     if (data.player) {
@@ -221,7 +233,7 @@ function getSkills (data) {
  * @param {object} data
  * @return {object}
  */
-function getSlayer (data) {
+function getSlayer(data) {
   if (!objectPath.has(data, 'slayer_bosses')) {
     return null;
   }
@@ -235,7 +247,7 @@ function getSlayer (data) {
  * @param {object} data
  * @return {object}
  */
-function getDungeons (data) {
+function getDungeons(data) {
   if (!objectPath.has(data, 'dungeons')) {
     return null;
   }
@@ -256,7 +268,7 @@ function getDungeons (data) {
  * @param {object} data
  * @return {jacobData}
  */
-function getJacobData (data) {
+function getJacobData(data) {
   if (!data.m.jacob2) {
     return {
       medals: {

package/src/utils/Constants.js

@@ -1,6 +1,20 @@
 module.exports = {
   skyblock_year_0: 1.5602757e+12,
 
+  duels_divisions: [
+    { name: 'Rookie', key: 'rookie' },
+    { name: 'Iron', key: 'iron' },
+    { name: 'Gold', key: 'gold' },
+    { name: 'Diamond', key: 'diamond' },
+    { name: 'Master', key: 'master' },
+    { name: 'Legend', key: 'legend' },
+    { name: 'Grandmaster', key: 'grandmaster' },
+    { name: 'Godlike', key: 'godlike' },
+    { name: 'WORLD ELITE', key: 'world_elite' },
+    { name: 'WORLD MASTER', key: 'world_master' },
+    { name: 'WORLD\'S BEST', key: 'worlds_best' }
+  ],
+
   leveling_xp: {
     1: 50,
     2: 125,

package/src/utils/index.js

@@ -1,9 +1,13 @@
-/* eslint-disable no-extend-native */
-const fs = require('fs');
-// eslint-disable-next-line no-path-concat
-const curDir = __dirname + '/';
-module.exports = Array.from(fs.readdirSync(curDir, { withFileTypes: true }))
-  .filter((x) => x.name !== 'index.js')
-  .map((x) => x.isDirectory() ? Array.from(fs.readdirSync(curDir + x.name)).map((y) => ([y.split('.')[0], x.name + '/' + y])) : [[x.name.split('.')[0], x.name]])
-  .flat(1)
-  .reduce((pV, cV) => Object.assign(pV, { [cV[0]]: require(curDir + cV[1]) }), {});
+module.exports = {
+  arrayTool: require('./arrayTools'),
+  Constants: require('./Constants'),
+  divide: require('./divide'),
+  isGuildID: require('./isGuildID'),
+  isUUID: require('./isUUID'),
+  oscillation: require('./oscillation'),
+  removeSnakeCase: require('./removeSnakeCase'),
+  SkyblockUtils: require('./SkyblockUtils'),
+  toIGN: require('./toIGN'),
+  toUuid: require('./toUuid'),
+  varInt: require('./varInt')
+};

package/src/utils/rgbToHexColor.js

@@ -0,0 +1,8 @@
+module.exports = (rgb) => {
+  let hexCode = '#';
+  for (const num of rgb) {
+    const hex = Number(num).toString(16);
+    hexCode += (hex.length === 1 ? '0' + hex : hex);
+  }
+  return hexCode;
+};

package/src/utils/romanize.js

@@ -0,0 +1,13 @@
+module.exports = (num) => {
+  if (isNaN(num)) return NaN;
+  const digits = String(+num).split('');
+  const key = ['', 'C', 'CC', 'CCC', 'CD', 'D', 'DC', 'DCC', 'DCCC', 'CM',
+    '', 'X', 'XX', 'XXX', 'XL', 'L', 'LX', 'LXX', 'LXXX', 'XC',
+    '', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX'];
+  let roman = '';
+  let i = 3;
+  while (i--) {
+    roman = (key[+ digits.pop() + (i * 10)] || '') + roman;
+  }
+  return Array(+digits.join('') + 1).join('M') + roman;
+};

package/src/utils/varInt.js

@@ -7,7 +7,7 @@ function readVarInt(bytes) {
   let numRead = 0;
   let result = 0;
   do {
-    read = bytes[numRead];
+    const read = bytes[numRead];
     const value = (read & 0b01111111);
     result |= (value << (7 * numRead));
     numRead++;