hypixel-api-reborn 11.3.4 → 12.0.0-0

package/src/structures/Pet.js

@@ -1,96 +0,0 @@
-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;
-    /**
-     * 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 +0,0 @@
-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;

package/src/structures/Player.js

@@ -1,346 +0,0 @@
-const {
-  playerLevelProgress,
-  parseClaimedRewards,
-  getSocialMedia,
-  getPlayerLevel,
-  getRank
-} = require('../utils/Player');
-const SkyWars = require('./MiniGames/SkyWars');
-const BedWars = require('./MiniGames/BedWars');
-const UHC = require('./MiniGames/UHC');
-const SpeedUHC = require('./MiniGames/SpeedUHC');
-const MurderMystery = require('./MiniGames/MurderMystery');
-const Duels = require('./MiniGames/Duels');
-const BuildBattle = require('./MiniGames/BuildBattle');
-const MegaWalls = require('./MiniGames/MegaWalls');
-const CopsAndCrims = require('./MiniGames/CopsAndCrims');
-const TNTGames = require('./MiniGames/TNTGames');
-const SmashHeroes = require('./MiniGames/SmashHeroes');
-const VampireZ = require('./MiniGames/VampireZ');
-const BlitzSurvivalGames = require('./MiniGames/BlitzSurvivalGames');
-const ArenaBrawl = require('./MiniGames/ArenaBrawl');
-const Arcade = require('./MiniGames/Arcade');
-const Color = require('./Color');
-const Game = require('./Game');
-const PlayerCosmetics = require('./PlayerCosmetics');
-const { recursive } = require('../utils/removeSnakeCase');
-const TurboKartRacers = require('./MiniGames/TurboKartRacers');
-const Paintball = require('./MiniGames/Paintball');
-const Quakecraft = require('./MiniGames/Quakecraft');
-const Walls = require('./MiniGames/Walls');
-const Warlords = require('./MiniGames/Warlords');
-const WoolWars = require('./MiniGames/WoolWars');
-const Pit = require('./MiniGames/Pit');
-const Guild = require('./Guild/Guild');
-const RecentGame = require('./RecentGame');
-/**
- * Player class
- */
-class Player {
-  /**
-   * @param {object} data Player data
-   * @param {Record<string, any>} extraPayload extra data requested alongside player
-   */
-  constructor(data, extraPayload) {
-    /**
-     * Player nickname
-     * @type {string}
-     */
-    this.nickname = data.displayname;
-    /**
-     * Player UUID
-     * @type {string}
-     */
-    this.uuid = data.uuid;
-    /**
-     * Player rank
-     * @type {PlayerRank}
-     */
-    this.rank = getRank(data);
-    /**
-     * Current chat channel, usually ALL, PARTY, or GUILD
-     * @type {string|null}
-     */
-    this.channel = data.channel || null;
-    /**
-     * Timestamp when player last logged in
-     * @type {number|null}
-     */
-    this.firstLoginTimestamp = data.firstLogin || null;
-    /**
-     * Timestamp when player last logged in as Date
-     * @type {Date|null}
-     */
-    this.firstLogin = data.firstLogin ? new Date(data.firstLogin) : null;
-    /**
-     * Timestamp when player last logged in as Date
-     * @type {Game|null}
-     */
-    this.lastLoginTimestamp = data.lastLogin || null;
-    /**
-     * Timestamp when player first logged in unix
-     * @type {number|null}
-     */
-    this.lastLogin = data.lastLogin ? new Date(data.lastLogin) : null;
-    /**
-     * Timestamp when player last logged out as Date
-     * @type {Date|null}
-     */
-    this.lastLogoutTimestamp = data.lastLogout || null;
-    /**
-     * Timestamp when player first logged in unix
-     * @type {number|null}
-     */
-    this.lastLogout = data.lastLogout ? new Date(data.lastLogout) : null;
-    /**
-     * Recently played game
-     * @type {Game|null}
-     */
-    this.recentlyPlayedGame = data.mostRecentGameType ? new Game(data.mostRecentGameType) : null;
-    /**
-     * Player's plus color (must be a MVP+ rank)
-     * @type {Color|null}
-     */
-    this.plusColor =
-      'MVP+' === this.rank || 'MVP++' === this.rank
-        ? data.rankPlusColor
-          ? new Color(data.rankPlusColor)
-          : new Color('RED')
-        : null;
-    /**
-     * MVP++ prefix color
-     * @type {Color|null}
-     */
-    this.prefixColor =
-      'MVP++' === this.rank ? (data.monthlyRankColor ? new Color(data.monthlyRankColor) : new Color('GOLD')) : null;
-    /**
-     * Player karma
-     * @type {number}
-     */
-    this.karma = data.karma || 0;
-    /**
-     * Player achievements
-     * @type {Object}
-     */
-    this.achievements = recursive(data.achievements);
-    /**
-     * Player achievement points
-     * @type {number}
-     */
-    this.achievementPoints = data.achievementPoints || 0;
-    /**
-     * Player total experience
-     * @type {number}
-     */
-    this.totalExperience = data.networkExp || 0;
-    /**
-     * Player level
-     * @type {number}
-     */
-    this.level = getPlayerLevel(this.totalExperience) || 0;
-    /**
-     * Player social media, if any
-     * @type {Array<PlayerSocialMedia>}
-     */
-    this.socialMedia = getSocialMedia(data.socialMedia) || [];
-    /**
-     * Amount of gift bundles sent
-     * @type {number}
-     */
-    this.giftBundlesSent = data.giftingMeta ? data.giftingMeta.realBundlesGiven || 0 : null;
-    /**
-     * Amount of gift bundles received
-     * @type {number}
-     */
-    this.giftBundlesReceived = data.giftingMeta ? data.giftingMeta.realBundlesReceived || 0 : null;
-    /**
-     * Amount of gifts sent
-     * @type {number}
-     */
-    this.giftsSent = data.giftingMeta ? data.giftingMeta.giftsGiven || 0 : null;
-    /**
-     * Is player online?
-     * @type {boolean}
-     */
-    this.isOnline = this.lastLoginTimestamp > this.lastLogoutTimestamp;
-    /**
-     * Last time player claimed the daily reward
-     * @type {Date | null}
-     */
-    this.lastDailyReward = data.lastAdsenseGenerateTime ? new Date(data.lastAdsenseGenerateTime) : null;
-    /**
-     * Last time player claimed the daily reward, as timestamp
-     * @type {number | null}
-     */
-    this.lastDailyRewardTimestamp = data.lastAdsenseGenerateTime || null;
-    /**
-     * Total amount of Daily Rewards
-     * @type {number | null}
-     */
-    this.totalRewards = data.totalRewards || null;
-    /**
-     * Total amount of Daily Rewards claimed
-     * @type {number | null}
-     */
-    this.totalDailyRewards = data.totalDailyRewards || null;
-    /**
-     * Honestly no clue what this is specifically
-     * @type {number | null}
-     */
-    this.rewardStreak = data.rewardStreak || null;
-    /**
-     * Current Daily Rewards streak
-     * @type {number | null}
-     */
-    this.rewardScore = data.rewardScore || null;
-    /**
-     * Highest Daily Rewards streak
-     * @type {number | null}
-     */
-    this.rewardHighScore = data.rewardHighScore || null;
-    /**
-     * Player leveling progress.
-     * @type {LevelProgress}
-     */
-    this.levelProgress = playerLevelProgress(data);
-    /**
-     * Player's Guild if requested in options
-     * @type {Guild|null}
-     */
-    this.guild = extraPayload?.guild || null;
-    /**
-     * Recent Games if requested in options
-     * @type {RecentGame[]|null}
-     */
-    this.recentGames = extraPayload?.recentGames || null;
-    /**
-     * Player stats for each mini-game
-     * @type {PlayerStats}
-     */
-    this.stats = data.stats
-      ? {
-          arcade: data.stats.Arcade ? new Arcade({ ...data.stats.Arcade, ...data.achievements }) : null,
-          arena: data.stats.Arena ? new ArenaBrawl(data.stats.Arena) : null,
-          bedwars: data.stats.Bedwars ? new BedWars(data.stats.Bedwars) : null,
-          blitzsg: data.stats.HungerGames ? new BlitzSurvivalGames(data.stats.HungerGames) : null,
-          buildbattle: data.stats.BuildBattle ? new BuildBattle(data.stats.BuildBattle) : null,
-          copsandcrims: data.stats.MCGO ? new CopsAndCrims(data.stats.MCGO) : null,
-          duels: data.stats.Duels ? new Duels(data.stats.Duels) : null,
-          megawalls: data.stats.Walls3 ? new MegaWalls(data.stats.Walls3) : null,
-          murdermystery: data.stats.MurderMystery ? new MurderMystery(data.stats.MurderMystery) : null,
-          paintball: data.stats.Paintball ? new Paintball(data.stats.Paintball) : null,
-          pit: data.stats.Pit ? new Pit(data.stats.Pit) : null,
-          quakecraft: data.stats.Quake ? new Quakecraft(data.stats.Quake) : null,
-          skywars: data.stats.SkyWars ? new SkyWars(data.stats.SkyWars) : null,
-          smashheroes: data.stats.SuperSmash ? new SmashHeroes(data.stats.SuperSmash) : null,
-          speeduhc: data.stats.SpeedUHC ? new SpeedUHC(data.stats.SpeedUHC) : null,
-          tntgames: data.stats.TNTGames ? new TNTGames(data.stats.TNTGames) : null,
-          turbokartracers: data.stats.GingerBread ? new TurboKartRacers(data.stats.GingerBread) : null,
-          uhc: data.stats.UHC ? new UHC(data.stats.UHC) : null,
-          vampirez: data.stats.VampireZ ? new VampireZ(data.stats.VampireZ) : null,
-          walls: data.stats.Walls ? new Walls(data.stats.Walls) : null,
-          warlords: data.stats.Battleground ? new Warlords(data.stats.Battleground) : null,
-          woolwars: data.stats.WoolGames ? new WoolWars(data.stats.WoolGames) : null
-        }
-      : null;
-    /**
-     * User's current language
-     * @type {string}
-     * @default ENGLISH Default to english
-     */
-    this.userLanguage = data.userLanguage || 'ENGLISH';
-    /**
-     * Claimed Leveling Rewards
-     * @type {number[]}
-     */
-    this.claimedLevelingRewards = parseClaimedRewards(data) || [];
-    /**
-     * Global Cosmetics a player owns
-     * @type {PlayerCosmetics}
-     */
-    this.globalCosmetics = data ? new PlayerCosmetics(data) : null;
-    /**
-     * Time at which the ranks were purchased. Can be all null if bought a long time ago, and some values can be null if player bought directly a rank above that
-     * @type {RanksPurchaseTime}
-     */
-    this.ranksPurchaseTime = {
-      VIP: data.levelUp_VIP ? new Date(data.levelUp_VIP) : null,
-      VIP_PLUS: data.levelUp_VIP_PLUS ? new Date(data.levelUp_VIP_PLUS) : null,
-      MVP: data.levelUp_MVP ? new Date(data.levelUp_MVP) : null,
-      MVP_PLUS: data.levelUp_MVP_PLUS ? new Date(data.levelUp_MVP_PLUS) : null
-    };
-  }
-  /**
-   * Player Name ( at least last known to hypixel )
-   * @return {string}
-   */
-  toString() {
-    return this.nickname;
-  }
-}
-/**
- * @typedef {string} PlayerRank
- * * `Default`
- * * `VIP`
- * * `VIP+`
- * * `MVP`
- * * `MVP+`
- * * `MVP++`
- * * `YouTube`
- * * `Game Master`
- * * `Admin`
- * * `PIG+++`
- * * `INNIT`
- */
-/**
- * @typedef {Object} PlayerSocialMedia
- * Player social media object
- * @property {string} name Twitter, YouTube, Instagram, Twitch, Hypixel, Discord
- * @property {string} link Link to social media
- * @property {string} id TWITTER, YOUTUBE, INSTRAGRAM, TWITCH, HYPIXEL, DISCORD
- */
-/**
- * @typedef {Object|null} PlayerStats
- * Player stats for each mini-game. `null` if player has no stats.
- * <br>
- * Usage: `<Player>.stats.skywars`
- * @property {Arcade|null} arcade Arcade
- * @property {ArenaBrawl|null} arena Arena Brawl
- * @property {BedWars|null} bedwars BedWars
- * @property {BlitzSurvivalGames|null} blitzsg Blitz Survival Games
- * @property {BuildBattle|null} buildbattle BuildBattle
- * @property {CopsAndCrims|null} copsandcrims Cops and Crims
- * @property {Duels|null} duels Duels
- * @property {MegaWalls|null} megawalls MegaWalls
- * @property {MurderMystery|null} murdermystery Murder Mystery
- * @property {Paintball|null} paintball Paint Ball
- * @property {Pit|null} pit Pit
- * @property {Quakecraft|null} quakecraft Quake Craft
- * @property {SkyWars|null} skywars SkyWars
- * @property {SmashHeroes|null} smashheroes Smash Heroes
- * @property {SpeedUHC|null} speedUHC Speed UHC
- * @property {TNTGames|null} tntgames The TNT Games
- * @property {TurboKartRacers|null} turbokartracers Turbo Kart Racers
- * @property {UHC|null} uhc UHC
- * @property {VampireZ|null} vampirez VampireZ
- * @property {Walls|null} walls Walls
- * @property {Warlords|null} warlords Warlords
- * @property {WoolWars|null} woolwars Wool Wars
- */
-/**
- * @typedef {Object} RanksPurchaseTime
- * Time at which ranks were purchased. Beware, even if a player has MVP+(+), every value here *could* be null
- * @property {Date|null} VIP VIP rank
- * @property {Date|null} VIP_PLUS VIP+ rank
- * @property {Date|null} MVP MVP rank
- * @property {Date|null} MVP_PLUS MVP+ rank
- */
-/**
- * @typedef {Object} LevelProgress
- * @property {number} xpToNext Total XP to a player's next level.
- * @property {number} remainingXP XP to the player's next level.
- * @property {number} currentXP XP the player current has.
- * @property {number} percent Player level progress as a percentage.
- * @property {number} percentRemaining Remaining percentage of the percent value.
- */
-module.exports = Player;

package/src/structures/RecentGame.js

@@ -1,57 +0,0 @@
-const Game = require('./Game');
-/**
- * RecentGame class
- * @extends {Game}
- */
-class RecentGame extends Game {
-  /**
-   * @param {object} data Recent game data
-   */
-  constructor(data) {
-    super(data.gameType);
-    /**
-     * Date as timestamp
-     * @type {number}
-     */
-    this.dateTimestamp = data.date || null;
-    /**
-     * Date
-     * @type {Date}
-     */
-    this.date = data.date ? new Date(data.date) : null;
-    /**
-     * Game mode
-     * @type {string}
-     */
-    this.mode = data.mode || null;
-    /**
-     * Map
-     * @type {string}
-     */
-    this.map = data.map || null;
-    // Per hypixel API docs : if ended isn't present, the game is ONGOING.
-    /**
-     * Is game ongoing?
-     * @type {boolean}
-     */
-    this.ongoing = Boolean(!data.ended);
-    /**
-     * Game ended at as Date
-     * @type {Date}
-     */
-    this.endedAt = data.ended ? new Date(data.ended) : null;
-    /**
-     * Game ended at
-     * @type {number}
-     */
-    this.endedTimestamp = data.ended ? data.ended : null;
-  }
-  /**
-   * Name of gamemode
-   * @return {string}
-   */
-  toString() {
-    return this.mode;
-  }
-}
-module.exports = RecentGame;

package/src/structures/ServerInfo.js

@@ -1,78 +0,0 @@
-/**
- * Server Info class - parses info obtained from handshaking with hypixel
- */
-class ServerInfo {
-  /**
-   * Constructor
-   * @param {Object} data data parsed from packet
-   * @param {number} ping Ping
-   */
-  constructor(data, ping) {
-    /**
-     * Protocol used for retrieving info, should be 736
-     * @type {number}
-     */
-    this.protocolUsed = data.version.protocol || 736;
-    /**
-     * Version required / Server version used
-     * @type {string}
-     */
-    this.versionInfo = data.version.name || 'Unknown';
-    /**
-     * Amount of players online and max players
-     * @type {PlayerInfo}
-     */
-    this.players = {
-      max: data.players.max || 0,
-      online: data.players.online || 0,
-      players: data.players.sample || [],
-      toString: () => `${this.players.online}/${this.players.max}`
-    };
-    /**
-     * Server MOTD, as it is received
-     * @type {string}
-     */
-    this.rawMOTD = data.description || '';
-    /**
-     * Clean MOTD, no color codes
-     * @type {string}
-     */
-    this.cleanMOTD = this.rawMOTD.replace(/§[a-z0-9]/gi, '');
-    /**
-     * MOTD without surrounding white spaces for centering
-     * @type {string}
-     */
-    this.textMOTD = this.cleanMOTD.replace(/^\s+/gm, '');
-    /**
-     * base64 Favicon - as it is received
-     * @type {string}
-     */
-    this.faviconB64 = data.favicon || undefined;
-    /**
-     * Favicon as buffer
-     * @type {Buffer}
-     */
-    this.favicon = Buffer.from(this.faviconB64, 'base64');
-    /**
-     * Ping in ms
-     * @type {number}
-     */
-    this.ping = parseInt(ping, 10);
-  }
-  /**
-   * toString override
-   * @returns {string}
-   */
-  toString() {
-    return `${this.textMOTD} - ${this.players} Players (${this.ping} ms) - ${this.versionInfo}`;
-  }
-}
-
-/**
- * @typedef {Object} PlayerInfo
- * @property {number} max Max amount of players online possible for the server
- * @property {number} online Current amount of online players
- * @property {any[]} players Some or all IGNs of online players, usually not provided by Hypixel
- */
-
-module.exports = ServerInfo;