hypixel-api-reborn 11.3.4 → 12.0.0-0

package/src/structures/Static/GameAchievements.js

@@ -1,36 +0,0 @@
-const Achievement = require('./Achievement');
-
-/**
- * Game achievements class
- */
-class GameAchievements {
-  /**
-   * @param {string} name game name
-   * @param {object} data data
-   */
-  constructor(name, data) {
-    /**
-     * Name of game/category
-     * @type {StaticGameNames}
-     */
-    this.category = name;
-    /**
-     * Total points possible from all achievements in this game
-     * @type {number}
-     */
-    this.totalPoints = parseInt(data.total_points, 10) || 0;
-    /**
-     * Total legacy points possible from all achievements in this game
-     * @type {number}
-     */
-    this.totalLegacyPoints = parseInt(data.total_legacy_points, 10) || 0;
-    /**
-     * @type {Achievement[]}
-     */
-    this.achievements = Object.entries({ ...(data.one_time || {}), ...(data.tiered || {}) }).map(
-      ([name, data]) => new Achievement(name, data)
-    );
-  }
-}
-
-module.exports = GameAchievements;

package/src/structures/Static/GameChallenges.js

@@ -1,40 +0,0 @@
-/**
- * Game challenges class
- */
-class GameChallenges {
-  /**
-   * @param {string} name game name
-   * @param {object} data data
-   */
-  constructor(name, data) {
-    /**
-     * Name of game/category
-     * @type {StaticGameNames}
-     */
-    this.category = name;
-    /**
-     * @type {Map<string, ChallengeData>}
-     */
-    this.challenges = new Map();
-
-    data.forEach((challenge) => {
-      const content = {
-        id: challenge.id,
-        name: challenge.name,
-        reward: parseInt(challenge.rewards[0].amount, 10) || 0,
-        rewardType: challenge.rewards[0].type
-      };
-      this.challenges.set(challenge.id, content);
-    });
-  }
-}
-
-/**
- * @typedef {Object} ChallengeData
- * @property {string} id String ID of the challenge
- * @property {string} name String name of the challenge
- * @property {number} reward Amount of XP upon challenge completion, always 3700 XP.
- * @property {string} rewardType Type of reward. Always "MultipliedExperienceReward" here
- */
-
-module.exports = GameChallenges;

package/src/structures/Static/GameQuests.js

@@ -1,24 +0,0 @@
-const Quest = require('./Quest');
-
-/**
- * Game quests class
- */
-class GameQuests {
-  /**
-   * @param {string} name game name
-   * @param {object} data data
-   */
-  constructor(name, data) {
-    /**
-     * Name of game
-     * @type {StaticGameNames}
-     */
-    this.game = name;
-    /**
-     * @type {Quest[]}
-     */
-    this.quests = (data || []).map((x) => new Quest(x));
-  }
-}
-
-module.exports = GameQuests;

package/src/structures/Static/GuildAchievements.js

@@ -1,34 +0,0 @@
-const Achievement = require('./Achievement.js');
-
-/**
- * Achievement class
- */
-class GuildAchievements {
-  /**
-   * @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);
-    /**
-     * Achievements
-     * @type {Record<string, Achievement>}
-     */
-    this.achievements = Object.fromEntries(
-      Object.entries({ ...(data.tiered || {}), ...(data.one_time || {}) }).map(([name, value]) => [
-        name,
-        new Achievement(name, value)
-      ])
-    );
-  }
-}
-
-module.exports = GuildAchievements;

package/src/structures/Static/Quest.js

@@ -1,66 +0,0 @@
-/**
- * Quest Class
- */
-class Quest {
-  /**
-   * constructor
-   * @param {Object} data
-   */
-  constructor(data) {
-    /**
-     * Name of quest, trimmed trailing spaces
-     * @type {string}
-     */
-    this.questName = data.name.trim();
-    /**
-     * ID of quest
-     * @type {string}
-     */
-    this.questID = data.id;
-    /**
-     * Description, trimmed trailing spaces
-     * @type {string}
-     */
-    this.description = data.description.trim();
-    /**
-     * Type of quest
-     * @type {'DAILY'|'WEEKLY'}
-     */
-    this.type = 'DailyResetQuestRequirement' === data.requirements?.[0].type ? 'DAILY' : 'WEEKLY';
-    /**
-     * Objectives
-     * @type {Objective[]}
-     */
-    this.objectives = data.objectives.map((objective) => ({
-      id: objective.id,
-      type: 'IntegerObjective' === objective.type ? 'Integer' : 'Boolean',
-      amountNeeded: parseInt(objective.integer || '1', 10)
-    }));
-    /**
-     * Rewards for this quest
-     * @type {QuestReward[]}
-     */
-    this.rewards = data.rewards || [];
-  }
-  /**
-   * As string
-   * @return {string}
-   */
-  toString() {
-    return this.questName;
-  }
-}
-
-/**
- * @typedef {Object} Objective
- * @property {string} id ID
- * @property {'Integer'|'Boolean'} type Integer: a certain amount of something (i.e kills) is needed; Boolean: a condition needs to be fulfilled
- * @property {number} amountNeeded a Boolean-typed objective will have this set to 1. (instead of null in API)
- */
-/**
- * @typedef {Object} QuestReward
- * @property {string} type Types of reward.
- * @property {number} amount Amount
- */
-
-module.exports = Quest;

package/src/structures/Static/Quests.js

@@ -1,31 +0,0 @@
-const GameQuests = require('./GameQuests.js');
-
-/**
- * Quest class
- */
-class Quests {
-  /**
-   * @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);
-    /**
-     * Quests per game
-     * @type {Record<StaticGameNames, GameQuests>}
-     */
-    this.questsPerGame = Object.fromEntries(
-      Object.entries(data.quests).map(([game, data]) => [game, new GameQuests(game, data)])
-    );
-  }
-}
-
-module.exports = Quests;

package/src/structures/Status.js

@@ -1,41 +0,0 @@
-const Game = require('./Game');
-/**
- * Status class
- */
-class Status {
-  /**
-   * @param {object} data Status data
-   */
-  constructor(data) {
-    /**
-     * Player online status.<br>
-     * <br>
-     * Players can disable this endpoint via in-game settings. When done so the API will return as if the player is offline.
-     * @type {boolean}
-     */
-    this.online = data.online;
-    /**
-     * Game type
-     * @type {Game|null}
-     */
-    this.game = data.gameType ? new Game(data.gameType) : null;
-    /**
-     * Game mode
-     * @type {string|null}
-     */
-    this.mode = data.mode ?? null;
-    /**
-     * Map
-     * @type {string|null}
-     */
-    this.map = data.map ?? null;
-  }
-  /**
-   * Online Status
-   * @return {string}
-   */
-  toString() {
-    return this.online ? 'Online' : 'Offline';
-  }
-}
-module.exports = Status;

package/src/structures/Watchdog/Stats.js

@@ -1,36 +0,0 @@
-/**
- * WatchdogStats class
- */
-class WatchdogStats {
-  /**
-   * @param {object} data Watchdog data
-   */
-  constructor(data) {
-    /**
-     * Total watchdog's bans
-     * @type {number}
-     */
-    this.byWatchdogTotal = data.watchdog_total || 0;
-    /**
-     * Watchdog's bans in the last minute
-     * @type {number}
-     */
-    this.byWatchdogLastMinute = data.watchdog_lastMinute || 0;
-    /**
-     * Watchdog's bans in the last day ( resets at 5 am UTC ).
-     * @type {number}
-     */
-    this.byWatchdogRollingDay = data.watchdog_rollingDaily || 0;
-    /**
-     * Total staff bans
-     * @type {number}
-     */
-    this.byStaffTotal = data.staff_total || 0;
-    /**
-     * Staff bans in the last day ( resets at 5 am UTC ).
-     * @type {number}
-     */
-    this.byStaffRollingDay = data.staff_rollingDaily || 0;
-  }
-}
-module.exports = WatchdogStats;

package/src/utils/Guild.js

@@ -1,90 +0,0 @@
-/* eslint-disable jsdoc/require-jsdoc */
-const GuildRank = require('../structures/Guild/GuildRank');
-const dateRegExp = /(\d{4})-(\d{2})-(\d{2})/;
-
-function parseDate(date) {
-  date[1] -= 1;
-  return new Date(Math.round(new Date(new Date().setUTCFullYear(...date)).setUTCHours(5, 0, 0) / 1000) * 1000);
-}
-
-function parseHistory(historyData) {
-  return Object.entries(historyData).map((x, index) => ({
-    day: x[0],
-    date:
-      parseDate(
-        x[0]
-          .match(dateRegExp)
-          .slice(1)
-          .map((x) => parseInt(x, 10))
-      ) || undefined,
-    exp: x[1] || 0,
-    totalExp: Object.values(historyData)
-      .slice(0, index + 1)
-      .reduce((pV, cV) => pV + cV, 0)
-  }));
-}
-
-function getGuildLevel(exp) {
-  const EXP_NEEDED = [
-    100000, 150000, 250000, 500000, 750000, 1000000, 1250000, 1500000, 2000000, 2500000, 2500000, 2500000, 2500000,
-    2500000, 3000000
-  ];
-
-  let level = 0;
-
-  for (let i = 0; 1000 >= i; i += 1) {
-    let need;
-    if (i >= EXP_NEEDED.length) {
-      need = EXP_NEEDED[EXP_NEEDED.length - 1];
-    } else {
-      need = EXP_NEEDED[i];
-    }
-
-    if (0 > exp - need) {
-      return Math.round((level + exp / need) * 100) / 100;
-    }
-    level += 1;
-    exp -= need;
-  }
-
-  return 1000;
-}
-
-function ranks(data) {
-  return data.ranks && data.ranks.length
-    ? data.ranks.map((r) => new GuildRank(r)).sort((a, b) => a.priority - b.priority)
-    : [];
-}
-
-function expLimit(exp) {
-  return 2e5 < exp ? (7e5 < exp ? 2.5e5 + Math.round(exp * 0.03) : 2e5 + Math.round((exp - 2e5) / 10)) : exp;
-}
-
-function calculateExpHistory(data) {
-  const finalObj = {};
-  for (const day of Object.keys(data.members[0].expHistory)) {
-    let gexp = 0;
-    for (const member of data.members) {
-      gexp += member.expHistory[day] || 0;
-    }
-    finalObj[day] = expLimit(gexp);
-  }
-  return parseHistory(finalObj);
-}
-
-/**
- * @typedef {object} ExpHistory
- * @property {string} day String Date ( unparsed )
- * @property {Date} date Parsed Date
- * @property {number} exp Experience of the day
- * @property {number} totalExp Experience earned from day 0 to this day
- */
-
-module.exports = {
-  parseDate,
-  parseHistory,
-  getGuildLevel,
-  ranks,
-  expLimit,
-  calculateExpHistory
-};

package/src/utils/Player.js

@@ -1,112 +0,0 @@
-/* eslint-disable jsdoc/require-jsdoc */
-function getRank(player) {
-  let rank;
-  if (player.prefix) {
-    rank = player.prefix.replace(/§[0-9|a-z]|\[|\]/g, '');
-  } else if (player.rank && 'NORMAL' !== player.rank) {
-    switch (player.rank) {
-      case 'YOUTUBER':
-        rank = 'YouTube';
-        break;
-      case 'GAME_MASTER':
-        rank = 'Game Master';
-        break;
-      case 'ADMIN':
-        rank = 'Admin';
-        break;
-      default:
-        rank = '';
-        break;
-    }
-  } else {
-    switch (player.newPackageRank) {
-      case 'MVP_PLUS':
-        rank = player.monthlyPackageRank && 'SUPERSTAR' === player.monthlyPackageRank ? 'MVP++' : 'MVP+';
-        break;
-      case 'MVP':
-        rank = 'MVP';
-        break;
-      case 'VIP_PLUS':
-        rank = 'VIP+';
-        break;
-      case 'VIP':
-        rank = 'VIP';
-        break;
-      default:
-        rank = player.monthlyPackageRank && 'SUPERSTAR' === player.monthlyPackageRank ? 'MVP++' : 'Default';
-    }
-  }
-  return rank;
-}
-
-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;
-}
-
-function xpToNextLevel(player) {
-  const lvl = getPlayerLevel(player.networkExp);
-  const xpToNext = 2500 * Math.floor(lvl) + 5000;
-  if (10000 > player.networkExp) return 10000;
-  return xpToNext;
-}
-
-function levelToXP(player) {
-  let level = Number(Math.floor(getPlayerLevel(player.networkExp)));
-  level = level - 1;
-  const xp = 1250 * level ** 2 + 8750 * level;
-  return xp;
-}
-
-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
-  };
-}
-
-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) => -1 !== x)
-    .map((x) => ({ name: formattedNames[x], link: links[upperNames[x]], id: upperNames[x] }));
-}
-
-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));
-}
-
-module.exports = {
-  getRank,
-  getPlayerLevel,
-  xpToNextLevel,
-  levelToXP,
-  playerLevelProgress,
-  getSocialMedia,
-  parseClaimedRewards
-};