hypixel-api-reborn 11.1.0 → 11.2.0

package/src/structures/SkyBlock/SkyblockMuseumItem.js

@@ -0,0 +1,54 @@
+const SkyblockInventoryItem = require('./SkyblockInventoryItem');
+/**
+ * Item class
+ */
+class SkyblockMuseumItem {
+  /**
+   * @param {object} data Item data
+   */
+  constructor(data) {
+    /**
+     * Item name
+     * @type {string|null}
+     **/
+    this.name = data.name;
+    /**
+     * Item
+     * @type {SkyblockInventoryItem}
+     */
+    this.items = [];
+    data.decoded.forEach((item) => {
+      if (!item.tag) return;
+      this.items.push(new SkyblockInventoryItem(item));
+    });
+    /**
+     * Donated Time
+     * @type {number}
+     */
+    this.donatedTime = data.donatedTime;
+    /**
+     * Donated Time as Date
+     * @type {Date}
+     */
+    this.donatedTimeAt = new Date(data.donatedTime);
+    /**
+     * Borrowing
+     * @type {boolean}
+     */
+    this.borrowing = data.borrowing;
+    /**
+     * Featured Slot
+     * @type {string|null}
+     */
+    this.featuredSlot = data.featuredSlot;
+  }
+  /**
+   * Item Name
+   * @return {string}
+   */
+  toString() {
+    return this.name;
+  }
+}
+
+module.exports = SkyblockMuseumItem;

package/src/structures/SkyBlock/SkyblockPet.js

@@ -38,6 +38,7 @@ class SkyblockPet {
      * Skyblock Pet score
      * @type {number}
      */
+    // eslint-disable-next-line camelcase
     this.petScore = pet_score[data.tier] || 0;
     /**
      * Skyblock Pet held item

package/src/structures/SkyBlock/SkyblockProfile.js

@@ -12,27 +12,55 @@ class SkyblockProfile {
      * Skyblock profile ID
      * @type {string}
      */
-    this.profileId = data.profile_id;
+    this.profileId = data.profileId;
     /**
      * Skyblock profile name
      * @type {string}
      */
-    this.profileName = data.profile_name;
+    this.profileName = data.profileName;
     /**
-     * Skyblock profile members
-     * @type {SkyblockMember[]}
+     * Profile's gamemode
+     * @type {string|null}
      */
-    this.members = edit(data.members, this.profileName).map((m) => new SkyblockMember(m));
+    this.gameMode = data.gameMode;
     /**
-     * Queried player's member stats
-     * @type {SkyblockMember}
+     * Profile's banking
+     * @type {object}
      */
-    this.me = this.members.find((x) => x.uuid === data.me);
+    this.banking = data.banking;
     /**
-     * Is the profile selected
+     * Profile's community upgrades
+     * @type {object}
+     */
+    this.communityUpgrades = data.communityUpgrades;
+    /**
+     * Profile is selected
      * @type {boolean}
      */
     this.selected = data.selected;
+    /**
+     * Skyblock profile members
+     * @type {SkyblockMember[]}
+     */
+    this.members = Object.keys(data.members).map(
+      (uuid) =>
+        new SkyblockMember({
+          uuid: uuid,
+          profileId: this.profileId,
+          profileName: this.profileName,
+          gameMode: this.gameMode,
+          m: data.members[uuid],
+          banking: this.banking,
+          communityUpgrades: this.communityUpgrades,
+          museum: null,
+          selected: this.selected
+        })
+    );
+    /**
+     * Queried player's member stats
+     * @type {SkyblockMember}
+     */
+    this.me = this.members.find((x) => x.uuid === data.uuid);
   }
   /**
    * Profile Name
@@ -43,18 +71,4 @@ class SkyblockProfile {
   }
 }
 
-// eslint-disable-next-line require-jsdoc
-function edit(members, profileName) {
-  const edited = [];
-  Object.keys(members).forEach((k) => {
-    const m = members[k];
-    edited.push({
-      uuid: k,
-      profileName,
-      m
-    });
-  });
-  return edited;
-}
-
 module.exports = SkyblockProfile;

package/src/structures/SkyBlock/Static/Bingo.js

@@ -0,0 +1,102 @@
+/**
+ * Bingo class
+ */
+class Bingo {
+  /**
+   * Constructor
+   * @param {Object} data data
+   * @param {number} position Position
+   */
+  constructor(data, position = 0) {
+    /**
+     * Name of this bingo goal
+     * @type {string}
+     */
+    this.name = data.name;
+    /**
+     * string ID (code name)
+     * @type {string}
+     */
+    this.id = data.id;
+    const [row, column] = parsePosition(position);
+    /**
+     * 1-indexed row
+     * @type {number|null}
+     */
+    this.row = row;
+    /**
+     * 1-indexed colmun
+     * @type {number|null}
+     */
+    this.column = column;
+    /**
+     * Bingo lore, with color codes
+     * @type {string}
+     */
+    this.rawLore = data.lore;
+    /**
+     * Bingo lore in plain text
+     * @type {string}
+     */
+    this.lore = data.lore?.replace?.(/§([1-9]|[a-l])|§/gm, '') || null;
+    /**
+     * Only available for TIERED bingos
+     * Shows you the requirement for each tier of this achievement
+     * @type {number[]}
+     */
+    this.tiers = Array.isArray(data.tiers) ? data.tiers.map((x) => parseInt(x, 10) || 0) : null;
+    /**
+     * Only available for TIERED bingos
+     * Difference between each tier requirement, if it is constant
+     * @type {number|null}
+     */
+    this.tierStep = this.#getTierStep();
+    /**
+     * Only available for ONE_TIERED bingos
+     * @type {number|null}
+     */
+    this.requiredAmount = parseInt(data.requiredAmount, 10) ?? null;
+    /**
+     * Type of Bingo
+     * ONE_TIME means the goal doesn't have a specific amount
+     * ONE_TIER means the goal specifies 1 amount to achieve
+     * TIERED means the goal specifies more than 1 amount to achieve
+     * @type {'ONE_TIME'|'ONE_TIER'|'TIERED'}
+     */
+    this.type = this.tiers ? 'TIERED' : this.requiredAmount ? 'ONE_TIER' : 'ONE_TIME';
+  }
+  /**
+   * As string
+   * BEWARE this returns ID to assure compatibility with PlayerBingo
+   * @return {string}
+   */
+  toString() {
+    return this.id;
+  }
+  /**
+   * Gets tier step, if constant
+   * @private
+   * @returns {number|null}
+   */
+  #getTierStep() {
+    if (this.type !== 'TIERED') return null;
+    // No step possible
+    if (this.tiers.length < 2) return null;
+    const hypotheticStep = this.tiers[1] - this.tiers[0];
+    // Check if every 2 elements have the same step
+    const isConstant = this.tiers.slice(1).every((el, index) => {
+      return hypotheticStep === this.tiers[index - 1] - el;
+    });
+    if (!isConstant) return null;
+    return hypotheticStep;
+  }
+}
+
+// eslint-disable-next-line require-jsdoc
+function parsePosition(position) {
+  const x = (position % 5) + 1;
+  const y = Math.floor(position / 5) + 1;
+  return [x, y];
+}
+
+module.exports = Bingo;

package/src/structures/SkyBlock/Static/BingoData.js

@@ -0,0 +1,45 @@
+const Bingo = require('./Bingo.js');
+
+/**
+ * SB Bingo Class
+ */
+class BingoData {
+  /**
+   * constructor
+   * @param {Object} data
+   */
+  constructor(data) {
+    /**
+     * Last time this resource was updated
+     * @type {number}
+     */
+    this.lastUpdatedTimestamp = parseInt(data.lastUpdated, 10);
+    /**
+     * Last time this resource was updated, as Date
+     * @type {Date|null}
+     */
+    this.lastUpdatedAt = new Date(this.lastUpdatedTimestamp);
+    /**
+     * Bingo ID
+     * @type {number|null}
+     */
+    this.id = parseInt(data.id, 10) || null;
+    /**
+     * Goals
+     * @type {Bingo[]|null}
+     */
+    this.goals = Array.isArray(data.goals) ? data.goals.map((goal, index) => new Bingo(goal, index)) : null;
+  }
+  /**
+   * Gets a goal on the bingo table by row and column
+   * @param {number} column Column number (starts at 1)
+   * @param {number} row Row number (starts at 1)
+   * @returns {Bingo|undefined}
+   */
+  getGoal(column, row) {
+    if (!this.goals || this.goals.length < 1) return;
+    return this.goals.find((goal) => goal.row === row && goal.column === column);
+  }
+}
+
+module.exports = BingoData;

package/src/structures/SkyBlock/Static/Candidate.js

@@ -0,0 +1,40 @@
+const Perk = require('./Perk');
+/**
+ * Candidate class
+ */
+class Candidate {
+  /**
+   * Constructor
+   * @param {Object} data data
+   * @param {boolean} [isMayor=false] if this candidate is the current mayor
+   */
+  constructor(data, isMayor = false) {
+    /**
+     * Mayor's name
+     * @type {string}
+     */
+    this.name = data.name;
+    /**
+     * Mayor's Key Benefit (in 1 word)
+     * @type {string}
+     */
+    this.keyBenefit = data.key;
+    /**
+     * Perks
+     * @type {Perk[]}
+     */
+    this.perks = data.perks.map((x) => new Perk(x));
+    /**
+     * If this candidate is the current mayor
+     * @type {boolean}
+     */
+    this.isMayor = isMayor || false;
+    /**
+     * The number of votes received by this candidate
+     * @type {number}
+     */
+    this.votesReceived = parseInt(data.votes, 10) || 0;
+  }
+}
+
+module.exports = Candidate;

package/src/structures/SkyBlock/Static/FireSale.js

@@ -0,0 +1,55 @@
+/**
+ * SB Fire Sale
+ */
+class FireSale {
+  /**
+   * constructor
+   * @param {Object} data
+   */
+  constructor(data) {
+    /**
+     * Item ID
+     * @type {string|null}
+     */
+    this.itemId = data.item_id || null;
+    /**
+     * Start Timestamp as a unix
+     * @type {number}
+     */
+    this.startTimestamp = parseInt(data.start, 10);
+    /**
+     * Start Date
+     * @type {Date}
+     */
+    this.startAt = new Date(this.startTimestamp);
+    /**
+     * End Timestamp as a unix
+     * @type {number}
+     */
+    this.endTimestamp = parseInt(data.end, 10);
+    /**
+     * End Date
+     * @type {Date}
+     */
+    this.endAt = new Date(this.endTimestamp);
+    /**
+     * Amount of items being sold
+     * @type {number}
+     */
+    this.amount = data.amount || 0;
+    /**
+     * Price
+     * @type {number}
+     */
+    this.price = data.price || 0;
+  }
+  /**
+   * Item Id
+   * @return {string|null}
+   */
+  toString() {
+    return this.itemId;
+  }
+}
+
+module.exports = FireSale;

package/src/structures/SkyBlock/Static/Government.js

@@ -0,0 +1,74 @@
+const Candidate = require('./Candidate');
+
+/**
+ * SB Government Class
+ */
+class GovernmentData {
+  /**
+   * constructor
+   * @param {Object} data
+   */
+  constructor(data) {
+    /**
+     * Last time this resource was updated
+     * @type {number}
+     */
+    this.lastUpdatedTimestamp = parseInt(data.lastUpdated, 10);
+    /**
+     * Last time this resource was updated, as Date
+     * @type {Date|null}
+     */
+    this.lastUpdatedAt = new Date(this.lastUpdatedTimestamp);
+    const lastElectionResults = data.mayor.election.candidates.map((x) => new Candidate(x, x.name === data.mayor.name));
+    /**
+     * A map of last election results for each candidate
+     * Sorted ascendingly by votes received
+     * @type {Map<string, Candidate>}
+     */
+    this.lastElectionResults = new Map(
+      lastElectionResults
+        .sort((a, b) => a.votesReceived - b.votesReceived)
+        .reverse()
+        .map((x) => [x.name, x])
+    );
+    /**
+     * The mayor
+     * @type {Candidate}
+     */
+    this.mayor = this.lastElectionResults.get(data.mayor.name);
+    /**
+     * The year the mayor will be running for
+     * @type {number}
+     */
+    this.runningYear = parseInt(data.mayor.election.year, 10) || 0;
+    const thisElection = data.current?.candidates.map((x) => new Candidate(x, x.name === data.mayor.name)) || null;
+    /**
+     * Current elections, valid for next year
+     * Sorted ascendingly by votes received
+     * RESULTS MIGHT BE TEMPORARY
+     * @type {Map<string, Candidate>|null}
+     */
+    this.currentElectionResults = thisElection
+      ? new Map(
+          thisElection
+            .sort((a, b) => a.votesReceived - b.votesReceived)
+            .reverse()
+            .map((x) => [x.name, x])
+        )
+      : null;
+    /**
+     * The year the current election will be effective for
+     * @type {number|null}
+     */
+    this.currentElectionFor = parseInt(data.current?.year, 10) || null;
+  }
+  /**
+   * Current Mayor
+   * @return {string}
+   */
+  toString() {
+    return this.mayor.name;
+  }
+}
+
+module.exports = GovernmentData;

package/src/structures/SkyBlock/Static/Perk.js

@@ -0,0 +1,24 @@
+/**
+ * Candidate class
+ */
+class Perk {
+  /**
+   * Constructor
+   * @param {Object} data data
+   * @param {boolean} [isMayor=false] if this candidate is the current mayor
+   */
+  constructor(data) {
+    /**
+     * Perk's Name
+     * @type {string}
+     */
+    this.name = data.name;
+    /**
+     * Perk's Description
+     * @type {string}
+     */
+    this.description = data.description;
+  }
+}
+
+module.exports = Perk;

package/src/structures/Static/Achievement.js

@@ -0,0 +1,86 @@
+const AchievementTier = require('./AchievementTier');
+
+/**
+ * Achievement Class
+ */
+class Achievement {
+  /**
+   * constructor
+   * @param {string} achievementName Name of achievement
+   * @param {Object} data
+   */
+  constructor(achievementName, data) {
+    /**
+     * Name of achievement, trimmed trailing spaces
+     * @type {string}
+     */
+    this.name = data.name.trim();
+    /**
+     * Code name of achievement
+     * @type {string}
+     */
+    this.codeName = achievementName;
+    /**
+     * Description, trimmed trailing spaces
+     * @type {string}
+     */
+    this.description = data.description.trim();
+    /**
+     * Type of achievement
+     * @type {'ONE_TIME'|'TIERED'}
+     */
+    this.type = data.tiers ? 'TIERED' : 'ONE_TIME';
+    /**
+     * ONLY AVAILABLE IN PERSONAL ONE TIME ACHIEVEMENTS, last checked April 26th
+     * Unlock rate of this achievement
+     * Local : Fraction of players that have played the game and gotten this achievement (0 to 1 inclusive)
+     * Global : Fraction of players that have played Hypixel and gotten this achievement (0 to 1 inclusive)
+     * ...percentage : In percentage (0 to 100 inclusive)
+     * @type {Record<'local'|'localPercentage'|'global'|'globalPercentage', number>|null}
+     */
+    this.rarity = {
+      local: parseFloat(data.gamePercentUnlocked) || 0,
+      localPercentage: parseFloat(data.gamePercentUnlocked) * 100 || 0,
+      global: data.globalPercentUnlocked,
+      globalPercentage: parseFloat(data.globalPercentUnlocked) * 100 || 0
+    };
+    /**
+     * ONLY AVAILABLE FOR TIERED
+     * @type {AchievementTier|null}
+     */
+    this.tierInformation = this.type === 'TIERED' ? new AchievementTier(data.tiers) : null;
+
+    const { totalPoints, totalAmount } = this.type === 'TIERED' ? collectAll(this.tierInformation) : {};
+    /**
+     * Total points worth (sum of all tiers if tiered)
+     * This is always 0 for Guild Achievements
+     * @type {number}
+     */
+    this.points = this.type === 'ONE_TIME' ? parseInt(data.points, 10) : totalPoints;
+    /**
+     * Total amount required to reach max tier, only for tiered
+     * @type {number|null}
+     */
+    this.totalAmountRequired = this.type === 'TIERED' ? totalAmount : null;
+  }
+  /**
+   * As string
+   * @return {string}
+   */
+  toString() {
+    return this.achievementName;
+  }
+}
+
+// eslint-disable-next-line require-jsdoc
+function collectAll(data) {
+  const mTier = data.maxTier;
+  let totalPoints = 0;
+  let totalAmount = 0;
+  for (let i = 1; i <= mTier; i++) {
+    totalPoints += data.getTier(i).pointsRewarded;
+    totalAmount += data.getTier(i).amountRequired;
+  }
+  return { totalPoints, totalAmount };
+}
+module.exports = Achievement;

package/src/structures/Static/AchievementTier.js

@@ -0,0 +1,33 @@
+/**
+ * AchievementTier class
+ */
+class AchievementTier {
+  /**
+   * @param {Record<string, number>} data
+   */
+  constructor(data) {
+    /**
+     * Maximum tier reachable
+     * getTier will be take any integer from 1 to this number (inclusive)
+     * @type {number}
+     */
+    this.maxTier = data.length;
+    // Still make sure it is well sorted
+    this._tierInfo = data.sort(({ tier: tierA }, { tier: tierB }) => Number(tierA) - Number(tierB));
+  }
+  /**
+   * Gets information for tier
+   * @param {number} tier Tier number (1-indexed!)
+   * @returns {Record<'pointsRewarded'|'amountRequired', number>}
+   */
+  getTier(tier) {
+    const index = tier - 1;
+    const info = this._tierInfo[index];
+    return {
+      pointsRewarded: parseInt(info.points, 10) || 0,
+      amountRequired: parseInt(info.amount, 10) || 0
+    };
+  }
+}
+
+module.exports = AchievementTier;

package/src/structures/Static/Achievements.js

@@ -0,0 +1,30 @@
+const GameAchievements = require('./GameAchievements.js');
+
+/**
+ * Achievement class
+ */
+class Achievements {
+  /**
+   * @param {object} data data
+   */
+  constructor(data) {
+    /**
+     * Last time this resource was updated
+     * @type {number}
+     */
+    this.lastUpdatedTimestamp = parseInt(data.lastUpdated, 10);
+    /**
+     * Last time this resource was updated, as Date
+     * @type {Date|null}
+     */
+    this.lastUpdatedAt = new Date(this.lastUpdatedTimestamp);
+    /**
+     * @type {Record<StaticGameNames, GameAchievements>}
+     */
+    this.achievementsPerGame = Object.fromEntries(
+      Object.entries(data.achievements).map(([game, data]) => [game, new GameAchievements(game, data)])
+    );
+  }
+}
+
+module.exports = Achievements;

package/src/structures/Static/Challenges.js

@@ -0,0 +1,29 @@
+const GameChallenges = require('./GameChallenges.js');
+/**
+ * Achievement class
+ */
+class Challenges {
+  /**
+   * @param {object} data data
+   */
+  constructor(data) {
+    /**
+     * Last time this resource was updated
+     * @type {number}
+     */
+    this.lastUpdatedTimestamp = parseInt(data.lastUpdated, 10);
+    /**
+     * Last time this resource was updated, as Date
+     * @type {Date|null}
+     */
+    this.lastUpdatedAt = new Date(this.lastUpdatedTimestamp);
+    /**
+     * @type {Record<StaticGameNames, GameChallenges>}
+     */
+    this.challengesPerGame = Object.fromEntries(
+      Object.entries(data.challenges).map(([game, data]) => [game, new GameChallenges(game, data)])
+    );
+  }
+}
+
+module.exports = Challenges;