hypixel-api-reborn 11.3.4 → 12.0.0-0

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

@@ -1,39 +1,183 @@
-const divide = require('../../utils/divide');
+import divide from '../../utils/divide';
 
-const generateStatsForMode = (data, mode) => {
+export type BedWarsPrestige =
+  | 'Stone'
+  | 'Iron'
+  | 'Gold'
+  | 'Diamond'
+  | 'Emerald'
+  | 'Sapphire'
+  | 'Ruby'
+  | 'Crystal'
+  | 'Opal'
+  | 'Amethyst'
+  | 'Rainbow'
+  | 'Iron Prime'
+  | 'Gold Prime'
+  | 'Diamond Prime'
+  | 'Emerald Prime'
+  | 'Sapphire Prime'
+  | 'Ruby Prime'
+  | 'Crystal Prime'
+  | 'Opal Prime'
+  | 'Amethyst Prime'
+  | 'Mirror'
+  | 'Light'
+  | 'Dawn'
+  | 'Dusk'
+  | 'Air'
+  | 'Wind'
+  | 'Nebula'
+  | 'Thunder'
+  | 'Earth'
+  | 'Water'
+  | 'Fire'
+  | 'Sunrise'
+  | 'Eclipse'
+  | 'Gamma'
+  | 'Majestic'
+  | 'Andesine'
+  | 'Marine'
+  | 'Element'
+  | 'Galaxy'
+  | 'Atomic'
+  | 'Sunset'
+  | 'Time'
+  | 'Winter'
+  | 'Obsidian'
+  | 'Spring'
+  | 'Ice'
+  | 'Summer'
+  | 'Spinel'
+  | 'Autumn'
+  | 'Mystic'
+  | 'Eternal';
+
+export interface BedWarsCollectedItems {
+  iron: number;
+  gold: number;
+  diamond: number;
+  emerald: number;
+}
+
+export interface BedWarsAvg {
+  kills: number;
+  finalKills: number;
+  bedsBroken: number;
+}
+
+export interface BedWarsBeds {
+  lost: number;
+  broken: number;
+  BLRatio: number;
+}
+
+export interface BedWarsModeStats {
+  winstreak: number;
+  playedGames: number;
+  kills: number;
+  deaths: number;
+  wins: number;
+  losses: number;
+  finalKills: number;
+  finalDeaths: number;
+  beds: BedWarsBeds;
+  avg: BedWarsAvg;
+  KDR: number;
+  WLR: number;
+  FKDR: number;
+}
+
+export interface BedwarsDreamModeStats {
+  doubles: BedWarsModeStats;
+  fours: BedWarsModeStats;
+}
+
+export interface BedwarsDreamStats {
+  ultimate: BedwarsDreamModeStats;
+  rush: BedwarsDreamModeStats;
+  armed: BedwarsDreamModeStats;
+  lucky: BedwarsDreamModeStats;
+  voidless: BedwarsDreamModeStats;
+}
+
+export interface BedWarsPracticeAttempts {
+  failed: number;
+  successful: number;
+  total: number;
+}
+
+export interface BedWarsPracticeElevation {
+  straight: number;
+  diagonal: number;
+}
+
+export interface BedWarsPracticeElevations {
+  none: BedWarsPracticeElevation;
+  slight: BedWarsPracticeElevation;
+  staircase: BedWarsPracticeElevation;
+}
+
+export interface BedWarsPracticeRecord {
+  elevation: BedWarsPracticeElevations;
+}
+
+export interface BedWarsPracticeRecords {
+  blocks30: BedWarsPracticeRecord;
+  blocks50: BedWarsPracticeRecord;
+  blocks100: BedWarsPracticeRecord;
+}
+
+export interface BedWarsPracticeBridging {
+  blocksPlaced: number;
+  attempts: BedWarsPracticeAttempts;
+  records: BedWarsPracticeRecords;
+}
+
+export interface BedWarsPracticePearlClutching {
+  attempts: BedWarsPracticeAttempts;
+}
+
+export interface BedWarsPracticeBase {
+  blocksPlaced: number;
+  attempts: BedWarsPracticeAttempts;
+}
+
+export interface BedWarsPracticeStats {
+  selected: string;
+  bridging: BedWarsPracticeBridging;
+  fireballJumping: BedWarsPracticeBase;
+  pearlClutching: BedWarsPracticePearlClutching;
+  mlg: BedWarsPracticeBase;
+}
+
+function generateStatsForMode(data: Record<string, any>, mode: string): BedWarsModeStats {
   return {
     winstreak: data[`${mode}_winstreak`] || 0,
     playedGames: data[`${mode}_games_played_bedwars`] || 0,
-
     kills: data[`${mode}_kills_bedwars`] || 0,
     deaths: data[`${mode}_deaths_bedwars`] || 0,
-
     wins: data[`${mode}_wins_bedwars`] || 0,
     losses: data[`${mode}_losses_bedwars`] || 0,
-
     finalKills: data[`${mode}_final_kills_bedwars`] || 0,
     finalDeaths: data[`${mode}_final_deaths_bedwars`] || 0,
-
     beds: {
       broken: data[`${mode}_beds_broken_bedwars`] || 0,
       lost: data[`${mode}_beds_lost_bedwars`] || 0,
       BLRatio: divide(data[`${mode}_beds_broken_bedwars`], data[`${mode}_beds_lost_bedwars`])
     },
-
     avg: {
       kills: divide(data[`${mode}_kills_bedwars`], data[`${mode}_games_played_bedwars`]),
       finalKills: divide(data[`${mode}_final_kills_bedwars`], data[`${mode}_games_played_bedwars`]),
       bedsBroken: divide(data[`${mode}_beds_broken_bedwars`], data[`${mode}_games_played_bedwars`])
     },
-
-    KDRatio: divide(data[`${mode}_kills_bedwars`], data[`${mode}_deaths_bedwars`]),
-    WLRatio: divide(data[`${mode}_wins_bedwars`], data[`${mode}_losses_bedwars`]),
-    finalKDRatio: divide(data[`${mode}_final_kills_bedwars`], data[`${mode}_final_deaths_bedwars`])
+    KDR: divide(data[`${mode}_kills_bedwars`], data[`${mode}_deaths_bedwars`]),
+    WLR: divide(data[`${mode}_wins_bedwars`], data[`${mode}_losses_bedwars`]),
+    FKDR: divide(data[`${mode}_final_kills_bedwars`], data[`${mode}_final_deaths_bedwars`])
   };
-};
+}
 
-// eslint-disable-next-line jsdoc/require-jsdoc
-function getBedWarsPrestige(level) {
+function getBedWarsPrestige(level: number): BedWarsPrestige | string {
   if (5000 <= level) return 'Eternal';
   return (
     [
@@ -96,17 +240,14 @@ const EASY_LEVELS_XP = 7000;
 const XP_PER_PRESTIGE = 96 * 5000 + EASY_LEVELS_XP;
 const LEVELS_PER_PRESTIGE = 100;
 const HIGHEST_PRESTIGE = 10;
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-function getLevelRespectingPrestige(level) {
+function getLevelRespectingPrestige(level: number) {
   if (level > HIGHEST_PRESTIGE * LEVELS_PER_PRESTIGE) {
     return level - HIGHEST_PRESTIGE * LEVELS_PER_PRESTIGE;
   }
   return level % LEVELS_PER_PRESTIGE;
 }
 
-// eslint-disable-next-line jsdoc/require-jsdoc
-function getExpForLevel(level) {
+function getExpForLevel(level: number) {
   if (0 === level) return 0;
   const respectedLevel = getLevelRespectingPrestige(level);
   if (respectedLevel > EASY_LEVELS) return 5000;
@@ -125,12 +266,10 @@ function getExpForLevel(level) {
   }
 }
 
-// eslint-disable-next-line jsdoc/require-jsdoc
-function getLevelForExp(exp) {
+function getLevelForExp(exp: number) {
   const prestiges = Math.floor(exp / XP_PER_PRESTIGE);
   let level = prestiges * LEVELS_PER_PRESTIGE;
   let expWithoutPrestiges = exp - prestiges * XP_PER_PRESTIGE;
-
   for (let i = 1; i <= EASY_LEVELS; ++i) {
     const expForEasyLevel = getExpForLevel(i);
     if (expWithoutPrestiges < expForEasyLevel) {
@@ -142,8 +281,7 @@ function getLevelForExp(exp) {
   return level + Math.floor(expWithoutPrestiges / 5000);
 }
 
-// eslint-disable-next-line jsdoc/require-jsdoc
-function generateStatsForPractice(data) {
+function generateStatsForPractice(data: Record<string, any>): BedWarsPracticeStats {
   return {
     selected: data?.practice?.selected || 'NONE',
     bridging: {
@@ -229,146 +367,73 @@ function generateStatsForPractice(data) {
     }
   };
 }
-/**
- * BedWars class
- */
+
 class BedWars {
-  /**
-   * @param {object} data BedWars data
-   */
-  constructor(data) {
-    /**
-     * Tokens
-     * @type {number}
-     */
+  tokens: number;
+  level: number;
+  experience: number;
+  prestige: BedWarsPrestige | string;
+  playedGames: number;
+  wins: number;
+  winstreak: number;
+  kills: number;
+  finalKills: number;
+  losses: number;
+  deaths: number;
+  finalDeaths: number;
+  collectedItemsTotal: BedWarsCollectedItems;
+  beds: BedWarsBeds;
+  avg: BedWarsAvg;
+  KDR: number;
+  FKDR: number;
+  WLR: number;
+  solo: BedWarsModeStats;
+  doubles: BedWarsModeStats;
+  threes: BedWarsModeStats;
+  fours: BedWarsModeStats;
+  '4v4': BedWarsModeStats;
+  dream: BedwarsDreamStats | object;
+  castle: BedWarsModeStats;
+  practice: BedWarsPracticeStats;
+  slumberTickets: number;
+  totalSlumberTicket: number;
+  constructor(data: Record<string, any>) {
     this.tokens = data.coins || 0;
-    /**
-     * Level
-     * @type {number}
-     */
     this.level = data.Experience ? getLevelForExp(data.Experience) : 0;
-    /**
-     * Experience
-     * @type {number}
-     */
     this.experience = data.Experience || 0;
-    /**
-     * Prestige
-     * @type {BedWarsPrestige}
-     */
-    this.prestige = data.Experience ? getBedWarsPrestige(getLevelForExp(data.Experience)) : 'Stone';
-    /**
-     * Played games
-     * @type {number}
-     */
+    this.prestige = getBedWarsPrestige(getLevelForExp(data.Experience));
     this.playedGames = data.games_played_bedwars || 0;
-    /**
-     * Wins
-     * @type {number}
-     */
     this.wins = data.wins_bedwars || 0;
-    /**
-     * Winstreak
-     * @type {number}
-     */
     this.winstreak = data.winstreak || 0;
-    /**
-     * Kills
-     * @type {number}
-     */
     this.kills = data.kills_bedwars || 0;
-    /**
-     * Final kills
-     * @type {number}
-     */
     this.finalKills = data.final_kills_bedwars || 0;
-    /**
-     * Losses
-     * @type {number}
-     */
     this.losses = data.losses_bedwars || 0;
-    /**
-     * Deaths
-     * @type {number}
-     */
     this.deaths = data.deaths_bedwars || 0;
-    /**
-     * Final deaths
-     * @type {number}
-     */
     this.finalDeaths = data.final_deaths_bedwars || 0;
-    /**
-     * Collected items
-     * @type {BedWarsCollectedItems}
-     */
     this.collectedItemsTotal = {
       iron: data.iron_resources_collected_bedwars || 0,
       gold: data.gold_resources_collected_bedwars || 0,
       diamond: data.diamond_resources_collected_bedwars || 0,
       emerald: data.emerald_resources_collected_bedwars || 0
     };
-    /**
-     * Beds lost/broken/BL Ratio
-     * @type {BedWarsBeds}
-     */
     this.beds = {
       lost: data.beds_lost_bedwars || 0,
       broken: data.beds_broken_bedwars || 0,
       BLRatio: divide(data.beds_broken_bedwars, data.beds_lost_bedwars)
     };
-    /**
-     * Average Kills/Final kills/Beds broken
-     * @type {BedWarsAvg}
-     */
     this.avg = {
       kills: divide(this.kills, this.playedGames),
       finalKills: divide(this.finalKills, this.playedGames),
       bedsBroken: divide(this.beds.broken, this.playedGames)
     };
-    /**
-     * Kill Death ratio
-     * @type {number}
-     */
-    this.KDRatio = divide(this.kills, this.deaths);
-    /**
-     * Final kill death ratio
-     * @type {number}
-     */
-    this.finalKDRatio = divide(this.finalKills, this.finalDeaths);
-    /**
-     * Win Loss ratio
-     * @type {number}
-     */
-    this.WLRatio = divide(this.wins, this.losses);
-    /**
-     * BedWars Solo stats
-     * @type {BedWarsModeStats}
-     */
+    this.KDR = divide(this.kills, this.deaths);
+    this.FKDR = divide(this.finalKills, this.finalDeaths);
+    this.WLR = divide(this.wins, this.losses);
     this.solo = generateStatsForMode(data, 'eight_one');
-    /**
-     * BedWars Doubles stats
-     * @type {BedWarsModeStats}
-     */
     this.doubles = generateStatsForMode(data, 'eight_two');
-    /**
-     * BedWars 3v3v3v3 stats
-     * @type {BedWarsModeStats}
-     */
     this.threes = generateStatsForMode(data, 'four_three');
-    /**
-     * BedWars 4v4v4v4 stats
-     * @type {BedWarsModeStats}
-     */
     this.fours = generateStatsForMode(data, 'four_four');
-    /**
-     * BedWars 4v4 stats
-     * @type {BedWarsModeStats}
-     */
     this['4v4'] = generateStatsForMode(data, 'two_four');
-    /**
-     * BedWars Dream Mode Stats
-     * @type {BedwarsDreamStats}
-     */
     this.dream = ['ultimate', 'rush', 'armed', 'lucky', 'voidless'].reduce(
       (ac, mode) => ({
         [mode]: {
@@ -379,176 +444,11 @@ class BedWars {
       }),
       {}
     );
-    /**
-     * BedWars Castle Stats
-     * @type {BedWarsModeStats}
-     */
     this.castle = generateStatsForMode(data, 'castle');
-    /**
-     * BedWars Practice Stats
-     * @type {BedWarsPracticeStats}
-     */
     this.practice = generateStatsForPractice(data);
-    /**
-     * Bedwars Slumber Tickets
-     * @type {number}
-     */
     this.slumberTickets = data.slumber?.tickets ?? 0;
-    /**
-     * Bedwars Slumber Total Tickets
-     * @type {number}
-     */
     this.totalSlumberTicket = data.slumber?.total_tickets ?? 0;
   }
 }
-/**
- * @typedef {string} BedWarsPrestige
- * * `Stone`
- * * `Iron`
- * * `Gold`
- * * `Diamond`
- * * `Emerald`
- * * `Sapphire`
- * * `Ruby`
- * * `Crystal`
- * * `Opal`
- * * `Amethyst`
- * * `Rainbow`
- * * `Iron Prime`
- * * `Gold Prime`
- * * `Diamond Prime`
- * * `Emerald Prime`
- * * `Sapphire Prime`
- * * `Ruby Prime`
- * * `Crystal Prime`
- * * `Opal Prime`
- * * `Amethyst Prime`
- * * `Mirror`
- * * `Light`
- * * `Dawn`
- * * `Dusk`
- * * `Air`
- * * `Wind`
- * * `Nebula`
- * * `Thunder`
- * * `Earth`
- * * `Water`
- * * `Fire`
- * * `Sunrise`
- * * `Eclipse`
- * * `Gamma`
- * * `Majestic`
- * * `Andesine`
- * * `Marine`
- * * `Element`
- * * `Galaxy`
- * * `Atomic`
- * * `Sunset`
- * * `Time`
- * * `Winter`
- * * `Obsidian`
- * * `Spring`
- * * `Ice`
- * * `Summer`
- * * `Spinel`
- * * `Autumn`
- * * `Mystic`
- * * `Eternal`
- */
-/**
- * @typedef {object} BedWarsAvg
- * @property {number} kills Average kills
- * @property {number} finalKills Average final kills
- * @property {number} bedsBroken Average beds broken
- */
-/**
- * @typedef {object} BedWarsCollectedItems
- * @property {number} iron Iron
- * @property {number} gold Gold
- * @property {number} diamond Diamond
- * @property {number} emerald Emerald
- */
-/**
- * @typedef {object} BedWarsBeds
- * @property {number} lost Beds lost
- * @property {number} broken Beds broken
- * @property {number} BLRatio Beds broken/Beds lost ratio
- */
-/**
- * @typedef {Object} BedWarsModeStats
- * @property {number} winstreak Winstreak
- * @property {number} playedGames Played games
- * @property {number} kills Kills
- * @property {number} deaths Deaths
- * @property {number} wins Wins
- * @property {number} losses Losses
- * @property {number} finalKills Final kills
- * @property {number} finalDeaths Final deaths
- * @property {BedWarsBeds} beds Beds
- * @property {BedWarsAvg} avg Average Kills/Final kills/Beds broken
- * @property {number} KDRatio Kill Death ratio
- * @property {number} WLRatio Win Loss ratio
- * @property {number} finalKDRatio Final kills/Final deaths ratio
- */
-/**
- * @typedef {Object} BedwarsDreamStats
- * @property {BedwarsDreamModeStats} ultimate Ultimate stats
- * @property {BedwarsDreamModeStats} rush Rush stats
- * @property {BedwarsDreamModeStats} armed Armed stats
- * @property {BedwarsDreamModeStats} lucky Lucky Blocks stats (true api naming)
- * @property {BedwarsDreamModeStats} voidless Voidless stats
- */
-/**
- * @typedef {Object} BedwarsDreamModeStats
- * @property {BedWarsModeStats} doubles Doubles
- * @property {BedWarsModeStats} fours Fours
- */
-/**
- * @typedef {Object} BedWarsPracticeAttempts
- * @property {number} failed Total failed attempts
- * @property {number} successful Total successful attempts
- * @property {number} total Total Number of attempts
- */
-/**
- * @typedef {Object} BedWarsPracticeElevation
- * @property {number} straight straight
- * @property {number} diagonal diagonal
- */
-/**
- * @typedef {Object} BedWarsPracticeElevations
- * @property {BedWarsPracticeElevation} none none
- * @property {BedWarsPracticeElevation} slight slight
- * @property {BedWarsPracticeElevation} staircase staircase
- */
-/**
- * @typedef {Object} BedWarsPracticeRecord
- * @property {BedWarsPracticeElevations} elevation Elevation
- */
-/**
- * @typedef {Object} BedWarsPracticeRecords
- * @property {BedWarsPracticeRecord} blocks30 30 Blocks
- * @property {BedWarsPracticeRecord} blocks50 50 Blocks
- * @property {BedWarsPracticeRecord} blocks100 100 Blocks
- */
-/**
- * @typedef {Object} BedWarsPracticeBridging
- * @property {number} blocksPlaced Blocks placed
- * @property {BedWarsPracticeAttempts} attempts Attempts
- */
-/**
- * @typedef {Object} BedWarsPracticePearlClutching
- * @property {BedWarsPracticeAttempts} attempts Attempts
- */
-/**
- * @typedef {Object} BedWarsPracticeMLG
- * @property {number} blocksPlaced Blocks placed
- * @property {BedWarsPracticeAttempts} attempts Attempts
- */
-/**
- * @typedef {Object} BedWarsPracticeStats
- * @property {string} selected Selected Type of Practice
- * @property {BedWarsPracticeBridging} bridging Bridging stats
- * @property {BedWarsPracticePearlClutching} pearlClutching Pearl Clutching stats
- * @property {BedWarsPracticeMLG} mlg  MLG stats
- */
-module.exports = BedWars;
+
+export default BedWars;