hypixel-api-reborn 11.0.1 → 11.2.0

package/src/structures/Player.js

@@ -13,8 +13,6 @@ const VampireZ = require('./MiniGames/VampireZ');
 const BlitzSurvivalGames = require('./MiniGames/BlitzSurvivalGames');
 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 Color = require('./Color');
 const Game = require('./Game');
 const PlayerCosmetics = require('./PlayerCosmetics');
@@ -25,6 +23,7 @@ const Quakecraft = require('./MiniGames/Quakecraft');
 const Walls = require('./MiniGames/Walls');
 const Warlords = require('./MiniGames/Warlords');
 const WoolWars = require('./MiniGames/WoolWars');
+const Pit = require('./MiniGames/Pit');
 /**
  * Player class
  */
@@ -44,21 +43,11 @@ class Player {
      * @type {string}
      */
     this.uuid = data.uuid;
-    /**
-     * Player nickname history known to Hypixel
-     * @type {Array<string>}
-     */
-    this.history = data.knownAliases;
     /**
      * Player rank
      * @type {PlayerRank}
      */
     this.rank = getRank(data);
-    /**
-     * Player minecraft version
-     * @type {string|null}
-     */
-    this.mcVersion = data.mcVersionRp || null;
     /**
      * Current chat channel, usually ALL, PARTY, or GUILD
      * @type {string|null}
@@ -75,12 +64,12 @@ class Player {
      */
     this.firstLogin = data.firstLogin ? new Date(data.firstLogin) : null;
     /**
-     * Player's recently played game
+     * Timestamp when player last logged in as Date
      * @type {Game|null}
      */
     this.lastLoginTimestamp = data.lastLogin || null;
     /**
-     * Timestamp when player first logged in
+     * Timestamp when player first logged in unix
      * @type {number|null}
      */
     this.lastLogin = data.lastLogin ? new Date(data.lastLogin) : null;
@@ -90,8 +79,8 @@ class Player {
      */
     this.lastLogoutTimestamp = data.lastLogout || null;
     /**
-     * Timestamp when player first logged in as Date
-     * @type {Date|null}
+     * Timestamp when player first logged in unix
+     * @type {number|null}
      */
     this.lastLogout = data.lastLogout ? new Date(data.lastLogout) : null;
     /**
@@ -103,12 +92,18 @@ 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) : new Color('RED')) : 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;
+    this.prefixColor =
+      this.rank === 'MVP++' ? (data.monthlyRankColor ? new Color(data.monthlyRankColor) : new Color('GOLD')) : null;
     /**
      * Player karma
      * @type {number}
@@ -236,7 +231,7 @@ class Player {
           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: null
+          pit: data.stats.Pit ? new Pit(data.stats.Pit) : null
         }
       : null;
     /**
@@ -348,8 +343,8 @@ function playerLevelProgress(player) {
   const percentRemaining = Math.round((100 - percent) * 100) / 100;
   return {
     xpToNext,
-    currentXP,
     remainingXP,
+    currentXP,
     percent,
     percentRemaining
   };
@@ -413,6 +408,7 @@ function parseClaimedRewards(data) {
  * @property {BlitzSurvivalGames|null} blitzsg Blitz Survival Games
  * @property {ArenaBrawl|null} arena Arena Brawl
  * @property {Arcade|null} arcade Arcade
+ * @property {WoolWars|null} woolwars Wool Wars
  */
 /**
  * @typedef {Object} RanksPurchaseTime

package/src/structures/PlayerCosmetics.js

@@ -12,7 +12,7 @@ class PlayerCosmetics {
      * All cosmetics
      * @type {string[]}
      */
-    this.allCosmetics = data.vanityMeta ? data.vanityMeta.packages : undefined;
+    this.allCosmetics = data?.vanityMeta?.packages || undefined;
     /**
      * Pets
      * @type {Pets|null}
@@ -29,7 +29,13 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get suits() {
-    if (!this._suits) this._suits = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('suit_')).map((x) => removeSnakeCaseString(x.replace('suit_', ''))) || [] : [];
+    if (!this._suits) {
+      this._suits = this.allCosmetics
+        ? this.allCosmetics
+            .filter((x) => x.startsWith('suit_'))
+            .map((x) => removeSnakeCaseString(x.replace('suit_', ''))) || []
+        : [];
+    }
     return this._suits;
   }
   /**
@@ -37,7 +43,13 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get hats() {
-    if (!this._hats) this._hats = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('hat_')).map((x) => removeSnakeCaseString(x.replace('hat_', ''))) || [] : [];
+    if (!this._hats) {
+      this._hats = this.allCosmetics
+        ? this.allCosmetics
+            .filter((x) => x.startsWith('hat_'))
+            .map((x) => removeSnakeCaseString(x.replace('hat_', ''))) || []
+        : [];
+    }
     return this._hats;
   }
   /**
@@ -45,7 +57,13 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get gadgets() {
-    if (!this._gadgets) this._gadgets = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('gadget_')).map((x) => removeSnakeCaseString(x.replace('gadget_', ''))) || [] : [];
+    if (!this._gadgets) {
+      this._gadgets = this.allCosmetics
+        ? this.allCosmetics
+            .filter((x) => x.startsWith('gadget_'))
+            .map((x) => removeSnakeCaseString(x.replace('gadget_', ''))) || []
+        : [];
+    }
     return this._gadgets;
   }
   /**
@@ -53,7 +71,13 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get morphs() {
-    if (!this._morphs) this._morphs = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('morph_')).map((x) => removeSnakeCaseString(x.replace('morph_', ''))) || [] : [];
+    if (!this._morphs) {
+      this._morphs = this.allCosmetics
+        ? this.allCosmetics
+            .filter((x) => x.startsWith('morph_'))
+            .map((x) => removeSnakeCaseString(x.replace('morph_', ''))) || []
+        : [];
+    }
     return this._morphs;
   }
   /**
@@ -61,7 +85,13 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get cloaks() {
-    if (!this._cloaks) this._cloaks = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('cloak_')).map((x) => removeSnakeCaseString(x.replace('cloak_', ''))) || [] : [];
+    if (!this._cloaks) {
+      this._cloaks = this.allCosmetics
+        ? this.allCosmetics
+            .filter((x) => x.startsWith('cloak_'))
+            .map((x) => removeSnakeCaseString(x.replace('cloak_', ''))) || []
+        : [];
+    }
     return this._cloaks;
   }
   /**
@@ -69,7 +99,13 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get taunts() {
-    if (!this._taunts) this._taunts = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('taunt_')).map((x) => removeSnakeCaseString(x.replace('taunt_', ''))) || [] : [];
+    if (!this._taunts) {
+      this._taunts = this.allCosmetics
+        ? this.allCosmetics
+            .filter((x) => x.startsWith('taunt_'))
+            .map((x) => removeSnakeCaseString(x.replace('taunt_', ''))) || []
+        : [];
+    }
     return this._taunts;
   }
   /**
@@ -77,7 +113,13 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get rankColors() {
-    if (!this._rankcolors) this._rankcolors = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('rankcolor_')).map((x) => removeSnakeCaseString(x.replace('rankcolor_', ''))) || [] : [];
+    if (!this._rankcolors) {
+      this._rankcolors = this.allCosmetics
+        ? this.allCosmetics
+            .filter((x) => x.startsWith('rankcolor_'))
+            .map((x) => removeSnakeCaseString(x.replace('rankcolor_', ''))) || []
+        : [];
+    }
     return this._rankcolors;
   }
   /**
@@ -85,7 +127,13 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get particlePacks() {
-    if (!this._particle) this._particle = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('particlepack_')).map((x) => removeSnakeCaseString(x.replace('particlepack_', ''))) || [] : [];
+    if (!this._particle) {
+      this._particle = this.allCosmetics
+        ? this.allCosmetics
+            .filter((x) => x.startsWith('particlepack_'))
+            .map((x) => removeSnakeCaseString(x.replace('particlepack_', ''))) || []
+        : [];
+    }
     return this._particlepacks;
   }
   /**
@@ -93,7 +141,13 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get clickEffects() {
-    if (!this._clickfx) this._clickfx = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('clickeffects_')).map((x) => removeSnakeCaseString(x.replace('clickeffects_', ''))) || [] : [];
+    if (!this._clickfx) {
+      this._clickfx = this.allCosmetics
+        ? this.allCosmetics
+            .filter((x) => x.startsWith('clickeffects_'))
+            .map((x) => removeSnakeCaseString(x.replace('clickeffects_', ''))) || []
+        : [];
+    }
     return this._clickfx;
   }
 }

package/src/structures/ServerInfo.js

@@ -10,7 +10,7 @@ class ServerInfo {
   constructor(data, ping) {
     /**
      * Protocol used for retrieving info, should be 736
-     * @type {Number}
+     * @type {number}
      */
     this.protocolUsed = data.version.protocol || 736;
     /**

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

@@ -1,5 +1,5 @@
-const Bid = require('./Bid');
 const BaseAuction = require('./BaseAuction');
+const Bid = require('./Bid');
 /**
  * Auction class
  */
@@ -89,6 +89,7 @@ class Auction extends BaseAuction {
     return this.item;
   }
 }
+
 /**
  * @typedef {string} Rarity
  * * `VERY_SPECIAL`
@@ -101,4 +102,5 @@ class Auction extends BaseAuction {
  * * `UNCOMMON`
  * * `COMMON`
  */
+
 module.exports = Auction;

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

@@ -51,4 +51,5 @@ class AuctionInfo {
     return `${this.page} / ${this.totalPages}`;
   }
 }
+
 module.exports = AuctionInfo;

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

@@ -42,4 +42,5 @@ class BaseAuction {
     return this.auctionId;
   }
 }
+
 module.exports = BaseAuction;

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

@@ -45,4 +45,5 @@ class Bid {
     return `${this.bidder} bid ${this.amount} coins`;
   }
 }
+
 module.exports = Bid;

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

@@ -22,4 +22,5 @@ class PartialAuction extends BaseAuction {
     this.price = parseInt(data.price, 10) || 0;
   }
 }
+
 module.exports = PartialAuction;

package/src/structures/SkyBlock/PlayerBingo.js

@@ -0,0 +1,56 @@
+/**
+ * @typedef {require('./Static/BingoData.js')} BingoData
+ * @typedef {require('./Static/Bingo.js')} Bingo
+ */
+
+/**
+ * Player Bingo Class
+ */
+class PlayerBingo {
+  /**
+   * Constructor
+   * @param {Object} data data
+   * @param {BingoData|null} bingoData bingo data
+   */
+  constructor(data, bingoData) {
+    const events = data.success && Array.isArray(data.events) ? data.events : [];
+    /**
+     * Data per event
+     * @type {PlayerBingoDataPerEvent}
+     */
+    this.dataPerEvent = events.map((eventData) => {
+      let doneGoals = eventData.completed_goals;
+      if (!Array.isArray(doneGoals)) doneGoals = [];
+      const enrichable = parseInt(eventData.key, 10) === bingoData?.id;
+      if (enrichable) doneGoals = populateGoals(doneGoals, bingoData.goals);
+      return {
+        eventId: parseInt(eventData.key, 10) || null,
+        points: parseInt(eventData.points, 10) || 0,
+        goalsCompleted: doneGoals,
+        enrichedGoals: enrichable
+      };
+    });
+  }
+}
+
+// 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
+ * @property {number} points Points acquired
+ * @property {boolean} enrichedGoals Whether the goals are enriched (populated with data from static skyblock bingp data)
+ * @property {Bingo[]|string[]} goalsCompleted Special Bingo Array if enrichedGoals is true. You can however always treat SpecialBingoArray as string[]
+ */
+
+module.exports = PlayerBingo;

package/src/structures/SkyBlock/SkyblockInventoryItem.js

@@ -1,5 +1,3 @@
-const rgbToHexColor = require('../../utils/rgbToHexColor');
-
 /**
  * Item class
  */
@@ -22,12 +20,13 @@ class SkyblockInventoryItem {
      * Item name
      * @type {string}
      */
-    this.name = data.tag.display.Name !== null ? data.tag.display.Name.toString().replace(/§([1-9]|[a-f])|§/gm, '') : null;
+    this.name =
+      data.tag.display.Name !== null ? data.tag.display.Name.toString().replace(/§([1-9]|[a-f])|§/gm, '') : null;
     /**
      * Item lore
      * @type {string}
      */
-    this.lore = data.tag.display.Lore.join('<br>');
+    this.lore = data.tag.display.Lore.join('\n');
     /**
      * Item lore
      * @type {string[]}
@@ -40,19 +39,19 @@ class SkyblockInventoryItem {
     this.loreForEmbed = this.lore.replace(/§([0-9]|[a-f])|§/gm, '').replace(/<br>/gm, '\n');
     /**
      * Hexadecimal color code of armor
-     * @type {string}
+     * @type {string|null}
      */
-    this.color = data.tag.ExtraAttributes.color ? rgbToHexColor(data.tag.ExtraAttributes.color.split(':')) : null;
+    this.color = data.tag.ExtraAttributes.color ?? data.tag.display.color ?? null;
     /**
      * Item enchantments
-     * @type {object}
+     * @type {Record<string, number>}
      */
-    this.enchantments = data.tag.ExtraAttributes.enchantments ? data.tag.ExtraAttributes.enchantments : null;
+    this.enchantments = data.tag.ExtraAttributes.enchantments ?? null;
     /**
      * Armor reforge
      * @type {string}
      */
-    this.reforge = data.tag.ExtraAttributes.modifier ? data.tag.ExtraAttributes.modifier : null;
+    this.reforge = data.tag.ExtraAttributes.modifier ?? null;
     /**
      * Equipment gemstones (if any)
      * @type {SkyblockItemGemstone}
@@ -60,14 +59,9 @@ class SkyblockInventoryItem {
     this.gemstones = data.tag.ExtraAttributes.gems
       ? Object.entries(data.tag.ExtraAttributes.gems).map((gem) => {
           // eslint-disable-next-line no-new-object
-          new Object({ type: gem[0].split('_')[0], quality: gem[1] });
+          return new Object({ type: gem[0].split('_')[0], quality: gem[1] });
         })
       : null;
-    /**
-     * Anvil uses
-     * @type {number}
-     */
-    this.anvilUses = data.tag.ExtraAttributes.anvil_uses ? data.tag.ExtraAttributes.anvil_uses : 0;
     /**
      * Damage
      * @type {number}
@@ -82,16 +76,80 @@ class SkyblockInventoryItem {
     this.rarity = parseRarity(this.loreArray[this.loreArray.length - 1]);
     /**
      * The amount of dungeon stars the item has (each star equates to a 10% stat boost while in dungeons)
-     * @author linearaccelerator
      * @type {number}
      */
-    this.dungeonStars = this.name.match(/(\u272a)/g) ? this.name.match(/(\u272a)/g).length : 0;
+    this.dungeonStars = data.tag.ExtraAttributes.upgrade_level ?? 0;
     /**
      * Dungeon gear score of the item (or null if not present)
      * @author linearaccelerator
      * @type {number}
      */
     this.gearScore = parseGearScore(this.loreArray) || null;
+    /**
+     * UUID of the item
+     * @type {string}
+     */
+    this.uuid = data.tag.ExtraAttributes.uuid ?? '';
+    /**
+     * Is the item soulbound
+     * @type {boolean}
+     */
+    this.soulbound = data.tag.ExtraAttributes.donated_museum === 1;
+    /**
+     * Amount of art of war books applied to the item
+     * @type {number}
+     */
+    this.artOfWar = data.tag.ExtraAttributes.art_of_war_count ?? 0;
+    /**
+     * Rune
+     * @type {object}
+     */
+    this.rune = data.tag.ExtraAttributes.runes ?? null;
+    /**
+     * The amount of applied potato books
+     * @type {number}
+     */
+    this.hotPotatoBooks = data.tag.ExtraAttributes.hot_potato_count ?? 0;
+    /**
+     * Is the item recombobulated
+     * @type {boolean}
+     */
+    this.recombobulated = data.tag.ExtraAttributes.rarity_upgrades === 1;
+    /**
+     * Item attributes
+     * @type {object}
+     */
+    this.attributes = data.tag.ExtraAttributes.attributes ?? {};
+    /**
+     * Hecatomb runs
+     * @type {number}
+     */
+    this.hecatomb = data.tag.ExtraAttributes.hecatomb_s_runs ?? 0;
+    /**
+     * Champion xp
+     * @type {number}
+     */
+    this.champion = data.tag.ExtraAttributes.champion_combat_xp ?? 0;
+    /**
+     * Cultivating
+     * @type {number}
+     */
+    this.cultivating = data.tag.ExtraAttributes.farmed_cultivating ?? 0;
+    /**
+     * Expertise Kills
+     * @type {number}
+     */
+    this.expertise = data.tag.ExtraAttributes.expertise_kills ?? 0;
+    /**
+     * Compact blocks Mined
+     * @type {number}
+     */
+    this.compact = data.tag.ExtraAttributes.compact_blocks ?? 0;
+    /**
+     * Armadillos Blocks Walked
+     * @type {number}
+     */
+    this.blocksWalked = data.tag.ExtraAttributes.blocks_walked ?? 0;
   }
   /**
    * Item Name
@@ -103,7 +161,17 @@ class SkyblockInventoryItem {
 }
 // eslint-disable-next-line require-jsdoc
 function parseRarity(stringContainingRarity) {
-  const rarityArray = ['COMMON', 'UNCOMMON', 'RARE', 'EPIC', 'LEGENDARY', 'MYTHIC', 'DIVINE', '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;
   }