hypixel-api-reborn 11.1.0 → 11.2.1

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');
@@ -13,8 +20,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 +30,9 @@ 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');
+const Guild = require('./Guild/Guild');
+const RecentGame = require('./RecentGame');
 /**
  * Player class
  */
@@ -44,21 +52,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 +73,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 +88,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 +101,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 =
+      'MVP+' === this.rank || 'MVP++' === this.rank
+        ? 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 =
+      'MVP++' === this.rank ? (data.monthlyRankColor ? new Color(data.monthlyRankColor) : new Color('GOLD')) : null;
     /**
      * Player karma
      * @type {number}
@@ -163,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}
@@ -236,7 +240,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;
     /**
@@ -254,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}
@@ -274,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,
-    currentXP,
-    remainingXP,
-    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`
@@ -413,6 +317,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

@@ -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
  */
@@ -12,7 +13,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 +30,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 +44,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 +58,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 +72,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 +86,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 +100,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,15 +114,27 @@ 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_', ''))) || [] : [];
-    return this._rankcolors;
+    if (!this._rankColors) {
+      this._rankColors = this.allCosmetics
+        ? this.allCosmetics
+            .filter((x) => x.startsWith('rankcolor_'))
+            .map((x) => removeSnakeCaseString(x.replace('rankcolor_', ''))) || []
+        : [];
+    }
+    return this._rankColors;
   }
   /**
    * Particle Packs
    * @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 +142,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

@@ -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;
   }
 
@@ -51,4 +52,5 @@ class AuctionInfo {
     return `${this.page} / ${this.totalPages}`;
   }
 }
+
 module.exports = AuctionInfo;

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
@@ -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/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

@@ -0,0 +1,49 @@
+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 {BingoDataType} BingoData
+ * @typedef {BingoType} 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
+      };
+    });
+  }
+}
+
+/**
+ * @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;