hypixel-api-reborn 10.0.0 → 11.0.1

package/src/structures/MiniGames/WoolWars.js

@@ -0,0 +1,123 @@
+const { divide } = require('../../utils');
+
+/**
+ * Wool Wars Class
+ */
+class WoolWars {
+  /**
+   * Constructor
+   * @param {Record<string,unknown>} data Data from API
+   */
+  constructor(data) {
+    /**
+     * Sheep layers, similar to prestige
+     * @type {number}
+     */
+    this.layers = data.progression?.available_layers || 0;
+    /**
+     * Wool Wars XP
+     * @type {number}
+     */
+    this.xp = data.progression?.experience || 0;
+    /**
+     * Wool Wars Decimal Level
+     * @type {number}
+     */
+    this.exactLevel = WoolWars.convertXPToLevel(this.xp);
+    /**
+     * Wool wars level (as shown in game)
+     * @type {number}
+     */
+    this.level = Math.floor(this.exactLevel);
+    /**
+     * Coins
+     * @type {number}
+     */
+    this.coins = data.coins || 0;
+    /**
+     * Selected class, or NONE if field isn't present in API for some reason
+     * @type {'ASSAULT'|'TANK'|'GOLEM'|'SWORDSMAN'|'ENGINEER'|'ARCHER'|'NONE'}
+     */
+    this.selectedClass = data.wool_wars?.selected_class || 'NONE';
+    this.stats = {
+      overall: WoolWars.generateStatsFor(data.wool_wars?.stats, ''),
+      assault: WoolWars.generateStatsFor(data.wool_wars?.stats, 'assault'),
+      tank: WoolWars.generateStatsFor(data.wool_wars?.stats, 'tank'),
+      golem: WoolWars.generateStatsFor(data.wool_wars?.stats, 'golem'),
+      swordsman: WoolWars.generateStatsFor(data.wool_wars?.stats, 'swordsman'),
+      engineer: WoolWars.generateStatsFor(data.wool_wars?.stats, 'engineer'),
+      archer: WoolWars.generateStatsFor(data.wool_wars?.stats, 'archer')
+    };
+    // Misc fields ig
+    /**
+     * Owned Cosmetics
+     * @type {string[]}
+     */
+    this.ownedCosmetics = data.packages || [];
+    /**
+     * Private Games config
+     * @type {PrivateGamesConfig}
+     */
+    this.privateGamesConfig = data.privategames || {};
+  }
+  /**
+   * Converts XP to Level
+   * @param {number} exp xp
+   * @return {number}
+   */
+  static convertXPToLevel(exp) {
+    const minimalExp = [0, 1e3, 3e3, 6e3, 1e4, 15e3]; // NB: progression is 1k, 2k, 3k, 4k, 5k
+    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 (theoreticalLevel > 100) return 100 + this.convertXPToLevel(exp - expToLevel100);
+    return theoreticalLevel;
+  }
+  /**
+   * Generates stats per class/overall
+   * @param {Record<string, unknwon>} data data
+   * @param {string} [_class=''] Class
+   * @return {WoolWarsStats}
+   */
+  static generateStatsFor(data, _class) {
+    // N.B i called it _class instead of class because reserved keyword
+    const workingData = (_class ? data?.['classes'][_class] : data) || {};
+    return {
+      roundWins: workingData.wins || 0,
+      gamesPlayed: workingData.games_played || 0,
+      woolsPlaced: workingData.wool_placed || 0,
+      blocksBroken: workingData.blocks_broken || 0,
+      placeBreakRatio: divide(workingData.wool_placed, workingData.blocks_broken),
+      kills: workingData.kills || 0,
+      deaths: workingData.deaths || 0,
+      KDRatio: divide(workingData.kills, workingData.deaths),
+      assists: workingData.assists || 0,
+      powerups: workingData.powerups_gotten || 0
+    };
+  }
+}
+/**
+ * @typedef {Object} PrivateGamesConfig NB. There could be more fields
+ * @property {boolean} one_hit_one_kill One hit one kill
+ * @property {'Enabled'|'Disabled'} rainbow_wool Rainbow wool
+ * @property {string} health_buff Health Buff
+ * @property {string} game_speed Game speed
+ * @property {string} speed Player speed
+ * @property {'Enabled'|'Disabled'} no_class No class
+ */
+/**
+ * @typedef {Object} WoolWarsStats
+ * @property {number} roundWins round wins
+ * @property {number} gamesPlayed games played
+ * @property {number} woolsPlaced wools placed
+ * @property {number} blocksBroken blocks broken
+ * @property {number} placeBreakRatio broken blocks to placed wool ratio
+ * @property {number} kills kills
+ * @property {number} deaths deaths
+ * @property {number} KDRatio KDR
+ * @property {number} assists assists (not included in KDR)
+ * @property {number} powerups number of powerups picked up
+ */
+module.exports = WoolWars;

package/src/structures/Pet.js

@@ -1,97 +1,96 @@
-const Utils = require('../utils');
-/**
- * Pet Class
- */
-class Pet {
-  /**
-   * @param {string} name Name of pet
-   * @param {object} data data
-   */
-  constructor (name, data) {
-    /**
-     * Is Pet Favorite
-     * @type {boolean}
-     */
-    this.isFavorite = data.vanityFavorites ? Boolean(data.vanityFavorites.includes(name.toUpperCase())) : false;
-    name = name.replace('pet_', '');
-    /**
-     * Official Name of the pet
-     * @type {string}
-     */
-    this.name = Utils.removeSnakeCase.recursive(name) || null;
-    /**
-     * Is Active Pet
-     * @type {boolean}
-     */
-    this.active = data.currentPet === name.toUpperCase();
-    const stats = data.petStats && data.petStats[name.toUpperCase()];
-    /**
-     * Stats of the pet, if any
-     * @type {object}
-     */
-    this.stats = {};
-    if (!stats) return; // don't parse stats because there is none.
-    /**
-     * Hunger value ( 100 is highest )
-     * @type {number|null}
-     */
-    this.stats.hunger = stats.HUNGER ? stats.HUNGER.value : null;
-    /**
-     * Last time the pet was fed ( timestamp )
-     * @type {number|null}
-     */
-    this.stats.lastFed = stats.HUNGER ? stats.HUNGER.timestamp : null;
-    /**
-     * Last time the pet was fed ( Date )
-     * @type {Date|null}
-     */
-    this.stats.lastFedAt = this.stats.lastFed ? new Date(this.stats.lastFed) : null;
-    /**
-     * Thirst value ( 100 is highest )
-     * @type {number|null}
-     */
-    this.stats.thirst = stats.THIRST ? stats.THIRST.value : null;
-    /**
-     * Last time the pet drank ( timestamp )
-     * @type {number|null}
-     */
-    this.stats.lastDrank = stats.THIRST ? stats.THIRST.timestamp : null;
-    /**
-     * Last time the pet drank ( Date )
-     * @type {Date|null}
-     */
-    this.stats.lastDrankAt = this.stats.lastDrank ? new Date(this.stats.lastDrank) : null;
-    /**
-     * Exercise/Entertainment value ( 100 is highest )
-     * @type {number|null}
-     */
-    this.stats.exercise = stats.EXERCISE ? stats.EXERCISE.value : null;
-    /**
-     * Last time the pet was exercised ( timestamp )
-     * @type {number|null}
-     */
-    this.stats.lastExercised = stats.EXERCISE ? stats.EXERCISE.timestamp : null;
-    /**
-     * Last time the pet exercised ( Date )
-     * @type {Date|null}
-     */
-    this.stats.lastExercisedAt = this.stats.lastExercised ? new Date(this.stats.lastExerciced) : null;
-    /**
-     * Raw Nickname, if any
-     * @type {string|null}
-     */
-    this.rawNickname = stats.name || null;
-    /**
-     * Nickname in plain text, if any
-     * @type {string|null}
-     */
-    this.nickname = stats.name ? stats.name.replace(/§([0-9]|[a-f])|§/gm, '') : null;
-    /**
-     * Pet experience
-     * @type {number}
-     */
-    this.experience = stats.experience || 0;
-  }
-}
-
-module.exports = Pet;
+const Utils = require('../utils');
+/**
+ * Pet Class
+ */
+class Pet {
+  /**
+   * @param {string} name Name of pet
+   * @param {object} data data
+   */
+  constructor(name, data) {
+    /**
+     * Is Pet Favorite
+     * @type {boolean}
+     */
+    this.isFavorite = data.vanityFavorites ? Boolean(data.vanityFavorites.includes(name.toUpperCase())) : false;
+    name = name.replace('pet_', '');
+    /**
+     * Official Name of the pet
+     * @type {string}
+     */
+    this.name = Utils.removeSnakeCase.recursive(name) || null;
+    /**
+     * Is Active Pet
+     * @type {boolean}
+     */
+    this.active = data.currentPet === name.toUpperCase();
+    const stats = data.petStats && data.petStats[name.toUpperCase()];
+    /**
+     * Stats of the pet, if any
+     * @type {object}
+     */
+    if (!stats) return; // don't parse stats because there is none.
+    /**
+     * Hunger value ( 100 is highest )
+     * @type {?number}
+     */
+    this.hunger = stats.HUNGER ? stats.HUNGER.value : null;
+    /**
+     * Last time the pet was fed ( timestamp )
+     * @type {?number}
+     */
+    this.lastFed = stats.HUNGER ? stats.HUNGER.timestamp : null;
+    /**
+     * Last time the pet was fed ( Date )
+     * @type {?Date}
+     */
+    this.lastFedAt = this.lastFed ? new Date(this.lastFed) : null;
+    /**
+     * Thirst value ( 100 is highest )
+     * @type {?number}
+     */
+    this.thirst = stats.THIRST ? stats.THIRST.value : null;
+    /**
+     * Last time the pet drank ( timestamp )
+     * @type {?number}
+     */
+    this.lastDrank = stats.THIRST ? stats.THIRST.timestamp : null;
+    /**
+     * Last time the pet drank ( Date )
+     * @type {?Date}
+     */
+    this.lastDrankAt = this.lastDrank ? new Date(this.lastDrank) : null;
+    /**
+     * Exercise/Entertainment value ( 100 is highest )
+     * @type {?number}
+     */
+    this.exercise = stats.EXERCISE ? stats.EXERCISE.value : null;
+    /**
+     * Last time the pet was exercised ( timestamp )
+     * @type {?number}
+     */
+    this.lastExercised = stats.EXERCISE ? stats.EXERCISE.timestamp : null;
+    /**
+     * Last time the pet exercised ( Date )
+     * @type {?Date}
+     */
+    this.lastExercisedAt = this.lastExercised ? new Date(this.lastExerciced) : null;
+    /**
+     * Raw Nickname, if any
+     * @type {?string}
+     */
+    this.rawNickname = stats.name || null;
+    /**
+     * Nickname in plain text, if any
+     * @type {?string}
+     */
+    this.nickname = stats.name ? stats.name.replace(/§([0-9]|[a-f])|§/gm, '') : null;
+    /**
+     * Pet experience
+     * @type {number}
+     */
+    this.experience = stats.experience || 0;
+  }
+}
+
+module.exports = Pet;

package/src/structures/Pets.js

@@ -1,64 +1,64 @@
-const Pet = require('./Pet');
-/**
- * Pets class
- */
-class Pets {
-  /**
-   * @param {string[]} pets Array of pets
-   * @param {object} data data
-   */
-  constructor (pets, data) {
-    /**
-     * Array of pets
-     * @type {Pet[]}
-     */
-    this.pets = pets.map((x) => new Pet(x, data));
-    /**
-     * Last Pet Journey ( as timestamp )
-     * @type {number|null}
-     */
-    this.lastJourneyTimestamp = data.petJourneyTimestamp || null;
-    /**
-     * Last Pet Journey ( as Date )
-     * @type {Date|null}
-     */
-    this.lastJourneyAt = this.lastJourneyTimestamp ? new Date(this.lastJourneyTimestamp) : null;
-    /**
-     * Pet food/drink/toys
-     * @type {PetConsumables}
-     */
-    this.petConsumables = data.petConsumables;
-  }
-}
-/**
- * @typedef {Object} PetConsumables
- * @property {number} BAKED_POTATO Food
- * @property {number} COOKIE Food
- * @property {number} FEATHER Toy
- * @property {number} HAY_BLOCK Food
- * @property {number} SLIME_BALL Toy
- * @property {number} COOKED_BEEF Food
- * @property {number} RED_ROSE Food
- * @property {number} WATER_BUCKET Drinks
- * @property {number} MELON Food
- * @property {number} STICK Toy
- * @property {number} WOOD_SWORD Toy ( but not irl )
- * @property {number} MILK_BUCKET Drinks
- * @property {number} GOLD_RECORD Food
- * @property {number} LEASH Toy
- * @property {number} LAVA_BUCKET Drinks
- * @property {number} BONE Food
- * @property {number} MAGMA_CREAM Food
- * @property {number} WHEAT Food
- * @property {number} MUSHROOM_SOUP Food
- * @property {number} BREAD Food
- * @property {number} PUMPKIN_PIE Food
- * @property {number} APPLE Food
- * @property {number} CARROT_ITEM Carrots
- * @property {number} RAW_FISH Food
- * @property {number} PORK Food
- * @property {number} CAKE Food
- * @property {number} ROTTEN_FLESH Food
- */
-
-module.exports = Pets;
+const Pet = require('./Pet');
+/**
+ * Pets class
+ */
+class Pets {
+  /**
+   * @param {string[]} pets Array of pets
+   * @param {object} data data
+   */
+  constructor(pets, data) {
+    /**
+     * Array of pets
+     * @type {Pet[]}
+     */
+    this.pets = pets.map((x) => new Pet(x, data));
+    /**
+     * Last Pet Journey ( as timestamp )
+     * @type {number|null}
+     */
+    this.lastJourneyTimestamp = data.petJourneyTimestamp || null;
+    /**
+     * Last Pet Journey ( as Date )
+     * @type {Date|null}
+     */
+    this.lastJourneyAt = this.lastJourneyTimestamp ? new Date(this.lastJourneyTimestamp) : null;
+    /**
+     * Pet food/drink/toys
+     * @type {PetConsumables}
+     */
+    this.petConsumables = data.petConsumables;
+  }
+}
+/**
+ * @typedef {Object} PetConsumables
+ * @property {number} BAKED_POTATO Food
+ * @property {number} COOKIE Food
+ * @property {number} FEATHER Toy
+ * @property {number} HAY_BLOCK Food
+ * @property {number} SLIME_BALL Toy
+ * @property {number} COOKED_BEEF Food
+ * @property {number} RED_ROSE Food
+ * @property {number} WATER_BUCKET Drinks
+ * @property {number} MELON Food
+ * @property {number} STICK Toy
+ * @property {number} WOOD_SWORD Toy ( but not irl )
+ * @property {number} MILK_BUCKET Drinks
+ * @property {number} GOLD_RECORD Food
+ * @property {number} LEASH Toy
+ * @property {number} LAVA_BUCKET Drinks
+ * @property {number} BONE Food
+ * @property {number} MAGMA_CREAM Food
+ * @property {number} WHEAT Food
+ * @property {number} MUSHROOM_SOUP Food
+ * @property {number} BREAD Food
+ * @property {number} PUMPKIN_PIE Food
+ * @property {number} APPLE Food
+ * @property {number} CARROT_ITEM Carrots
+ * @property {number} RAW_FISH Food
+ * @property {number} PORK Food
+ * @property {number} CAKE Food
+ * @property {number} ROTTEN_FLESH Food
+ */
+
+module.exports = Pets;