hypixel-api-reborn 11.2.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');
@@ -24,6 +31,8 @@ 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
  */
@@ -93,7 +102,7 @@ class Player {
      * @type {Color|null}
      */
     this.plusColor =
-      this.rank === 'MVP+' || this.rank === 'MVP++'
+      'MVP+' === this.rank || 'MVP++' === this.rank
         ? data.rankPlusColor
           ? new Color(data.rankPlusColor)
           : new Color('RED')
@@ -103,7 +112,7 @@ class Player {
      * @type {Color|null}
      */
     this.prefixColor =
-      this.rank === 'MVP++' ? (data.monthlyRankColor ? new Color(data.monthlyRankColor) : new Color('GOLD')) : null;
+      'MVP++' === this.rank ? (data.monthlyRankColor ? new Color(data.monthlyRankColor) : new Color('GOLD')) : null;
     /**
      * Player karma
      * @type {number}
@@ -158,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}
@@ -249,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}
@@ -269,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,
-    remainingXP,
-    currentXP,
-    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`

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
  */
@@ -113,14 +114,14 @@ class PlayerCosmetics {
    * @type {string[]}
    */
   get rankColors() {
-    if (!this._rankcolors) {
-      this._rankcolors = this.allCosmetics
+    if (!this._rankColors) {
+      this._rankColors = this.allCosmetics
         ? this.allCosmetics
             .filter((x) => x.startsWith('rankcolor_'))
             .map((x) => removeSnakeCaseString(x.replace('rankcolor_', ''))) || []
         : [];
     }
-    return this._rankcolors;
+    return this._rankColors;
   }
   /**
    * Particle Packs

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;
   }
 

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

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

@@ -1,6 +1,11 @@
+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 {require('./Static/BingoData.js')} BingoData
- * @typedef {require('./Static/Bingo.js')} Bingo
+ * @typedef {BingoDataType} BingoData
+ * @typedef {BingoType} Bingo
  */
 
 /**
@@ -33,18 +38,6 @@ class PlayerBingo {
   }
 }
 
-// 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

package/src/structures/SkyBlock/SkyblockInventoryItem.js

@@ -1,3 +1,4 @@
+const { parseRarity, parseGearScore } = require('../../utils/SkyblockUtils');
 /**
  * Item class
  */
@@ -21,7 +22,7 @@ class SkyblockInventoryItem {
      * @type {string}
      */
     this.name =
-      data.tag.display.Name !== null ? data.tag.display.Name.toString().replace(/§([1-9]|[a-f])|§/gm, '') : null;
+      null !== data.tag.display.Name ? data.tag.display.Name.toString().replace(/§([1-9]|[a-f])|§/gm, '') : null;
     /**
      * Item lore
      * @type {string}
@@ -58,7 +59,6 @@ class SkyblockInventoryItem {
      */
     this.gemstones = data.tag.ExtraAttributes.gems
       ? Object.entries(data.tag.ExtraAttributes.gems).map((gem) => {
-          // eslint-disable-next-line no-new-object
           return new Object({ type: gem[0].split('_')[0], quality: gem[1] });
         })
       : null;
@@ -71,7 +71,6 @@ class SkyblockInventoryItem {
      * What rarity the item has, as an uppercase string
      * @author linearaccelerator
      * @type {string}
-     * @version >6.0.1
      */
     this.rarity = parseRarity(this.loreArray[this.loreArray.length - 1]);
     /**
@@ -94,7 +93,7 @@ class SkyblockInventoryItem {
      * Is the item soulbound
      * @type {boolean}
      */
-    this.soulbound = data.tag.ExtraAttributes.donated_museum === 1;
+    this.soulbound = 1 === data.tag.ExtraAttributes.donated_museum;
     /**
      * Amount of art of war books applied to the item
      * @type {number}
@@ -114,7 +113,7 @@ class SkyblockInventoryItem {
      * Is the item recombobulated
      * @type {boolean}
      */
-    this.recombobulated = data.tag.ExtraAttributes.rarity_upgrades === 1;
+    this.recombobulated = 1 === data.tag.ExtraAttributes.rarity_upgrades;
     /**
      * Item attributes
      * @type {object}
@@ -159,29 +158,6 @@ class SkyblockInventoryItem {
     return this.name;
   }
 }
-// eslint-disable-next-line require-jsdoc
-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;
-  }
-}
-// eslint-disable-next-line require-jsdoc
-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]);
-  }
-}
 
 /**
  * @typedef {object} SkyblockItemGemstone