hypixel-api-reborn 11.3.5 → 12.0.0-0

package/src/structures/MiniGames/{UHC.js → UHC.ts}

@@ -1,8 +1,7 @@
-const divide = require('../../utils/divide');
+import divide from '../../utils/divide';
 
-// eslint-disable-next-line jsdoc/require-jsdoc
-function getStarLevel(kills, wins) {
-  const sum = Number(kills) + wins * 10;
+function getStarLevel(kills: number, wins: number): number {
+  const sum = kills + wins * 10;
   let starLevel = 1;
   const sums = [0, 1, 6, 21, 46, 96, 171, 271, 521, 1021, 1321, 1621, 1921, 2221, 2521, Infinity];
   starLevel += sums.map((x) => x * 10 - sum).findIndex((x) => 0 < x) - 1;
@@ -10,107 +9,53 @@ function getStarLevel(kills, wins) {
 }
 
 class UHCGamemode {
-  /**
-   * @param {object} data UHC data
-   * @param {string} mode UHC Mode Name
-   */
-  constructor(data, mode) {
+  kills: number;
+  deaths: number;
+  wins: number;
+  headsEaten: number;
+  ultimatesCrafted: number;
+  extraUltimatesCrafted: number;
+  constructor(data: Record<string, any>, mode?: string) {
     if (mode) mode = `_${mode}`;
-    /**
-     * Kills
-     * @type {number}
-     */
     this.kills = data[`kills${mode}`] || 0;
-    /**
-     * Deaths
-     * @type {number}
-     */
     this.deaths = data[`deaths${mode}`] || 0;
-    /**
-     * Wins
-     * @type {number}
-     */
     this.wins = data[`wins${mode}`] || 0;
-    /**
-     * Golden Heads Eaten
-     * @type {number}
-     */
     this.headsEaten = data[`heads_eaten${mode}`] || 0;
-    /**
-     * Ultimates Crafted
-     * @type {number}
-     */
     this.ultimatesCrafted = data[`ultimates_crafted${mode}`] || 0;
-    /**
-     * Extra Ultimates Crafted
-     * @type {number}
-     */
     this.extraUltimatesCrafted = data[`extra_ultimates_crafted${mode}`] || 0;
   }
 }
 
-/**
- * UHC class
- */
 class UHC {
-  /**
-   * @param {object} data UHC data
-   */
-  constructor(data) {
-    /**
-     * Coins
-     * @type {number}
-     */
+  coins: number;
+  score: number;
+  kit: string;
+  solo: UHCGamemode;
+  team: UHCGamemode;
+  redVsBlue: UHCGamemode;
+  noDiamond: UHCGamemode;
+  brawl: UHCGamemode;
+  soloBrawl: UHCGamemode;
+  duoBrawl: UHCGamemode;
+  wins: number;
+  kills: number;
+  deaths: number;
+  KDR: number;
+  headsEaten: number;
+  ultimatesCrafted: number;
+  extraUltimatesCrafted: number;
+  starLevel: number;
+  constructor(data: Record<string, any>) {
     this.coins = data.coins || 0;
-    /**
-     * Score
-     * @type {number}
-     */
     this.score = data.score || 0;
-    /**
-     * Selected Kit
-     * @type {string}
-     */
     this.kit = data.equippedKit || '';
-    /**
-     * Solo
-     * @type {UHCGamemode}
-     */
     this.solo = new UHCGamemode(data, 'solo');
-    /**
-     * Teams
-     * @type {UHCGamemode}
-     */
     this.team = new UHCGamemode(data);
-    /**
-     * Red vs Blue
-     * @type {UHCGamemode}
-     */
     this.redVsBlue = new UHCGamemode(data, 'red_vs_blue');
-    /**
-     * No Diamond
-     * @type {UHCGamemode}
-     */
     this.noDiamond = new UHCGamemode(data, 'no_diamonds');
-    /**
-     * Brawl
-     * @type {UHCGamemode}
-     */
     this.brawl = new UHCGamemode(data, 'brawl');
-    /**
-     * Solo brawl
-     * @type {UHCGamemode}
-     */
     this.soloBrawl = new UHCGamemode(data, 'solo_brawl');
-    /**
-     * Duo Brawl
-     * @type {UHCGamemode}
-     */
     this.duoBrawl = new UHCGamemode(data, 'duo_brawl');
-    /**
-     * Wins
-     * @type {number}
-     */
     this.wins =
       this.solo.wins +
       this.team.wins +
@@ -119,10 +64,6 @@ class UHC {
       this.brawl.wins +
       this.soloBrawl.wins +
       this.duoBrawl.wins;
-    /**
-     * Kills
-     * @type {number}
-     */
     this.kills =
       this.solo.kills +
       this.team.kills +
@@ -131,10 +72,6 @@ class UHC {
       this.brawl.kills +
       this.soloBrawl.kills +
       this.duoBrawl.kills;
-    /**
-     * Deaths
-     * @type {number}
-     */
     this.deaths =
       this.solo.deaths +
       this.team.deaths +
@@ -143,15 +80,7 @@ class UHC {
       this.brawl.deaths +
       this.soloBrawl.deaths +
       this.duoBrawl.deaths;
-    /**
-     * Kill/Death ratio
-     * @type {number}
-     */
-    this.KDRatio = divide(this.kills, this.deaths);
-    /**
-     * Heads eaten
-     * @type {number}
-     */
+    this.KDR = divide(this.kills, this.deaths);
     this.headsEaten =
       this.solo.headsEaten +
       this.team.headsEaten +
@@ -160,10 +89,6 @@ class UHC {
       this.brawl.headsEaten +
       this.soloBrawl.headsEaten +
       this.duoBrawl.headsEaten;
-    /**
-     * Ultimates Crafted
-     * @type {number}
-     */
     this.ultimatesCrafted =
       this.solo.ultimatesCrafted +
       this.team.ultimatesCrafted +
@@ -172,10 +97,6 @@ class UHC {
       this.brawl.ultimatesCrafted +
       this.soloBrawl.ultimatesCrafted +
       this.duoBrawl.ultimatesCrafted;
-    /**
-     * Extra Ultimates Crafted
-     * @type {number}
-     */
     this.extraUltimatesCrafted =
       this.solo.extraUltimatesCrafted +
       this.team.extraUltimatesCrafted +
@@ -184,11 +105,8 @@ class UHC {
       this.brawl.extraUltimatesCrafted +
       this.soloBrawl.extraUltimatesCrafted +
       this.duoBrawl.extraUltimatesCrafted;
-    /**
-     * Star level
-     * @type {number}
-     */
     this.starLevel = getStarLevel(this.kills, this.wins);
   }
 }
-module.exports = UHC;
+
+export default UHC;

package/src/structures/MiniGames/VampireZ.ts

@@ -0,0 +1,41 @@
+import divide from '../../utils/divide';
+
+class VampireZRole {
+  kills: number;
+  deaths: number;
+  KDR: number;
+  wins: number;
+  constructor(data: Record<string, any>, role: string) {
+    this.kills = data[`${role}_kills`];
+    this.deaths = data[`${role}_deaths`];
+    this.KDR = divide(this.kills, this.deaths);
+    this.wins = data[`${role}_wins`];
+  }
+}
+
+class VampireZ {
+  coins: number;
+  goldBought: number;
+  blood: boolean;
+  zombieKills: number;
+  human: VampireZRole;
+  vampire: VampireZRole;
+  kills: number;
+  deaths: number;
+  KDR: number;
+  wins: number;
+  constructor(data: Record<string, any>) {
+    this.coins = data.coins || 0;
+    this.goldBought = data.gold_bought || 0;
+    this.blood = data.blood || false;
+    this.zombieKills = data.zombie_kills || 0;
+    this.human = new VampireZRole(data, 'human');
+    this.vampire = new VampireZRole(data, 'vampire');
+    this.kills = this.human.kills + this.vampire.kills;
+    this.deaths = this.human.deaths + this.vampire.deaths;
+    this.KDR = divide(this.kills, this.deaths);
+    this.wins = this.human.wins + this.vampire.wins;
+  }
+}
+
+export default VampireZ;

package/src/structures/MiniGames/Walls.ts

@@ -0,0 +1,24 @@
+import divide from '../../utils/divide';
+
+class Walls {
+  coins: number;
+  kills: number;
+  deaths: number;
+  KDR: number;
+  wins: number;
+  losses: number;
+  WLR: number;
+  assists: number;
+  constructor(data: Record<string, any>) {
+    this.coins = data.coins || 0;
+    this.kills = data.kills || 0;
+    this.deaths = data.deaths || 0;
+    this.KDR = divide(this.kills, this.deaths);
+    this.wins = data.wins || 0;
+    this.losses = data.losses || 0;
+    this.WLR = divide(this.wins, this.losses);
+    this.assists = data.assists || 0;
+  }
+}
+
+export default Walls;

package/src/structures/MiniGames/Warlords.ts

@@ -0,0 +1,79 @@
+import divide from '../../utils/divide';
+
+class WarlordsClass {
+  wins: number;
+  losses: number;
+  WLR: number;
+  gamesPlayed: number;
+  damage: number;
+  heal: number;
+  damagePrevented: number;
+  constructor(data: Record<string, any>, className: string) {
+    this.wins = data[`wins_${className}`] || 0;
+    this.losses = data[`losses_${className}`] || 0;
+    this.WLR = divide(this.wins, this.losses);
+    this.gamesPlayed = data[`${className}_plays`];
+    this.damage = data[`damage_${className}`] || 0;
+    this.heal = data[`heal_${className}`] || 0;
+    this.damagePrevented = data[`damage_prevented_${className}`] || 0;
+  }
+}
+
+class Warlords {
+  coins: number;
+  kills: number;
+  deaths: number;
+  KDR: number;
+  wins: number;
+  losses: number;
+  WLR: number;
+  winstreak: number;
+  assists: number;
+  class: string;
+  pyromancer: WarlordsClass;
+  mage: WarlordsClass;
+  thunderlord: WarlordsClass;
+  shaman: WarlordsClass;
+  earthwarden: WarlordsClass;
+  aquamancer: WarlordsClass;
+  paladin: WarlordsClass;
+  avenger: WarlordsClass;
+  warrior: WarlordsClass;
+  defender: WarlordsClass;
+  cryomancer: WarlordsClass;
+  crusader: WarlordsClass;
+  berserker: WarlordsClass;
+  protector: WarlordsClass;
+  revenant: WarlordsClass;
+  spiritguard: WarlordsClass;
+  constructor(data: Record<string, any>) {
+    this.coins = data.coins || 0;
+    this.kills = data.kills || 0;
+    this.deaths = data.deaths || 0;
+    this.KDR = divide(this.kills, this.deaths);
+    this.wins = data.wins || 0;
+    this.losses = data.losses || 0;
+    this.WLR = divide(this.wins, this.losses);
+    this.winstreak = data.win_streak || 0;
+    this.assists = data.assists || 0;
+    this.class = data.chosen_class || '';
+    this.pyromancer = new WarlordsClass(data, 'pyromancer');
+    this.mage = new WarlordsClass(data, 'mage');
+    this.thunderlord = new WarlordsClass(data, 'thunderlord');
+    this.shaman = new WarlordsClass(data, 'shaman');
+    this.earthwarden = new WarlordsClass(data, 'earthwarden');
+    this.aquamancer = new WarlordsClass(data, 'aquamancer');
+    this.paladin = new WarlordsClass(data, 'paladin');
+    this.avenger = new WarlordsClass(data, 'avenger');
+    this.warrior = new WarlordsClass(data, 'warrior');
+    this.defender = new WarlordsClass(data, 'defender');
+    this.cryomancer = new WarlordsClass(data, 'cryomancer');
+    this.crusader = new WarlordsClass(data, 'crusader');
+    this.berserker = new WarlordsClass(data, 'berserker');
+    this.protector = new WarlordsClass(data, 'protector');
+    this.revenant = new WarlordsClass(data, 'revenant');
+    this.spiritguard = new WarlordsClass(data, 'spiritguard');
+  }
+}
+
+export default Warlords;

package/src/structures/MiniGames/WoolWars.ts

@@ -0,0 +1,106 @@
+import divide from '../../utils/divide';
+
+export interface WoolWarsStats {
+  wins: number;
+  gamesPlayed: number;
+  woolsPlaced: number;
+  blocksBroken: number;
+  placeBreakRatio: number;
+  kills: number;
+  deaths: number;
+  KDR: number;
+  assists: number;
+  powerups: number;
+}
+
+export interface WoolWarsPrivateGamesConfig {
+  one_hit_one_kil: boolean;
+  rainbow_wool: 'Enabled' | 'Disabled';
+  health_buff: string;
+  game_speed: string;
+  speed: string;
+  no_class: 'Enabled' | 'Disabled';
+  respawn_enable: boolean;
+}
+
+function convertXPToLevel(exp: number): number {
+  const minimalExp = [0, 1e3, 3e3, 6e3, 1e4, 15e3];
+  const baseLevel = minimalExp.length;
+  const baseExp = minimalExp[minimalExp.length - 1];
+  const expToLevel100 = 49e4;
+  if (exp < baseExp) return minimalExp.findIndex((x) => exp < x);
+  const theoreticalLevel = (exp - baseExp) / 5e3 + baseLevel;
+  if (100 < theoreticalLevel) return 100 + convertXPToLevel(exp - expToLevel100);
+  return theoreticalLevel;
+}
+
+function generateStatsFor(data: Record<string, any>, className: string): WoolWarsStats {
+  const workingData = (className ? data?.classes?.[className] : data) || {};
+  return {
+    wins: workingData.wins || 0,
+    gamesPlayed: workingData.games_played || 0,
+    woolsPlaced: workingData.wool_placed || 0,
+    blocksBroken: workingData.blocks_broken || 0,
+    placeBreakRatio: divide(workingData.wool_placed || 0, workingData.blocks_broken || 0),
+    kills: workingData.kills || 0,
+    deaths: workingData.deaths || 0,
+    KDR: divide(workingData.kills, workingData.deaths),
+    assists: workingData.assists || 0,
+    powerups: workingData.powerups_gotten || 0
+  };
+}
+
+class WoolWars {
+  layers: number;
+  xp: number;
+  exactLevel: number;
+  level: number;
+  coins: number;
+  wins: number;
+  gamesPlayed: number;
+  woolsPlaced: number;
+  blocksBroken: number;
+  placeBreakRatio: number;
+  kills: number;
+  deaths: number;
+  KDR: number;
+  assists: number;
+  powerups: number;
+  selectedClass: 'ASSAULT' | 'TANK' | 'GOLEM' | 'SWORDSMAN' | 'ENGINEER' | 'ARCHER' | 'NONE';
+  assault: WoolWarsStats;
+  tank: WoolWarsStats;
+  golem: WoolWarsStats;
+  swordsman: WoolWarsStats;
+  engineer: WoolWarsStats;
+  archer: WoolWarsStats;
+  ownedCosmetics: string[];
+  privateGamesConfig: WoolWarsPrivateGamesConfig;
+  constructor(data: Record<string, any>) {
+    this.layers = data.progression?.available_layers || 0;
+    this.xp = data.progression?.experience || 0;
+    this.exactLevel = convertXPToLevel(this.xp);
+    this.level = Math.floor(this.exactLevel);
+    this.coins = data.coins || 0;
+    this.wins = data.wins || 0;
+    this.gamesPlayed = data.games_played || 0;
+    this.woolsPlaced = data.wool_placed || 0;
+    this.blocksBroken = data.blocks_broken || 0;
+    this.placeBreakRatio = divide(this.woolsPlaced, this.blocksBroken);
+    this.kills = data.kills || 0;
+    this.deaths = data.deaths || 0;
+    this.KDR = divide(this.kills, this.deaths);
+    this.assists = data.assists || 0;
+    this.powerups = data.powerups_gotten || 0;
+    this.selectedClass = data.wool_wars?.selected_class || 'NONE';
+    this.assault = generateStatsFor(data.wool_wars?.stats, 'assault');
+    this.tank = generateStatsFor(data.wool_wars?.stats, 'tank');
+    this.golem = generateStatsFor(data.wool_wars?.stats, 'golem');
+    this.swordsman = generateStatsFor(data.wool_wars?.stats, 'swordsman');
+    this.engineer = generateStatsFor(data.wool_wars?.stats, 'engineer');
+    this.archer = generateStatsFor(data.wool_wars?.stats, 'archer');
+    this.ownedCosmetics = data.packages || [];
+    this.privateGamesConfig = data.privategames || {};
+  }
+}
+
+export default WoolWars;

package/src/structures/Pet.ts

@@ -0,0 +1,40 @@
+import { recursive } from '../utils/removeSnakeCase';
+
+class Pet {
+  isFavorite: boolean;
+  name: string | null;
+  active: boolean;
+  hunger: number | null;
+  lastFed: number | null;
+  lastFedAt: Date | null;
+  thirst: number | null;
+  lastDrank: number | null;
+  lastDrankAt: Date | null;
+  exercise: number | null;
+  lastExercised: number | null;
+  lastExercisedAt: Date | null;
+  rawNickname: string | null;
+  nickname: string | null;
+  experience: number;
+  constructor(name: string, data: Record<string, any>) {
+    this.isFavorite = data.vanityFavorites ? Boolean(data.vanityFavorites.includes(name.toUpperCase())) : false;
+    name = name.replace('pet_', '');
+    this.name = recursive(name) || null;
+    this.active = data?.currentPet === name.toUpperCase();
+    const stats = data?.petStats && data.petStats[name.toUpperCase()];
+    this.hunger = stats?.HUNGER ? stats.HUNGER.value : null;
+    this.lastFed = stats?.HUNGER ? stats.HUNGER.timestamp : null;
+    this.lastFedAt = this.lastFed ? new Date(this.lastFed) : null;
+    this.thirst = stats?.THIRST ? stats.THIRST.value : null;
+    this.lastDrank = stats?.THIRST ? stats.THIRST.timestamp : null;
+    this.lastDrankAt = this.lastDrank ? new Date(this.lastDrank) : null;
+    this.exercise = stats?.EXERCISE ? stats.EXERCISE.value : null;
+    this.lastExercised = stats?.EXERCISE ? stats.EXERCISE.timestamp : null;
+    this.lastExercisedAt = this.lastExercised ? new Date(this.lastExercised) : null;
+    this.rawNickname = stats?.name || null;
+    this.nickname = stats?.name ? stats.name.replace(/§([0-9]|[a-f])|§/gm, '') : null;
+    this.experience = stats?.experience || 0;
+  }
+}
+
+export default Pet;

package/src/structures/Pets.ts

@@ -0,0 +1,46 @@
+import Pet from './Pet';
+
+export interface PetConsumables {
+  BAKED_POTATO: number;
+  COOKIE: number;
+  FEATHER: number;
+  HAY_BLOCK: number;
+  SLIME_BALL: number;
+  COOKED_BEEF: number;
+  RED_ROSE: number;
+  WATER_BUCKET: number;
+  MELON: number;
+  STICK: number;
+  WOOD_SWORD: number;
+  MILK_BUCKET: number;
+  GOLD_RECORD: number;
+  LEASH: number;
+  LAVA_BUCKET: number;
+  BONE: number;
+  MAGMA_CREAM: number;
+  WHEAT: number;
+  MUSHROOM_SOUP: number;
+  BREAD: number;
+  PUMPKIN_PIE: number;
+  APPLE: number;
+  CARROT_ITEM: number;
+  RAW_FISH: number;
+  PORK: number;
+  CAKE: number;
+  ROTTEN_FLESH: number;
+}
+
+class Pets {
+  pets: Pet[];
+  lastJourneyTimestamp: number | null;
+  lastJourneyAt: Date | null;
+  petConsumables: PetConsumables;
+  constructor(pets: string[], data: Record<string, any>) {
+    this.pets = pets.map((x) => new Pet(x, data));
+    this.lastJourneyTimestamp = data.petJourneyTimestamp || null;
+    this.lastJourneyAt = this.lastJourneyTimestamp ? new Date(this.lastJourneyTimestamp) : null;
+    this.petConsumables = data.petConsumables;
+  }
+}
+
+export default Pets;