hypixel-api-reborn 11.3.4 → 12.0.0-0

package/src/structures/Player.ts

@@ -0,0 +1,199 @@
+import Arcade from './MiniGames/Arcade';
+import ArenaBrawl from './MiniGames/ArenaBrawl';
+import BedWars from './MiniGames/BedWars';
+import BlitzSurvivalGames from './MiniGames/BlitzSurvivalGames';
+import BuildBattle from './MiniGames/BuildBattle';
+import Color from './Color';
+import CopsAndCrims from './MiniGames/CopsAndCrims';
+import Duels from './MiniGames/Duels';
+import Game from './Game';
+import Guild from './Guild/Guild';
+import House from './House';
+import MegaWalls from './MiniGames/MegaWalls';
+import MurderMystery from './MiniGames/MurderMystery';
+import Paintball from './MiniGames/Paintball';
+import Pit from './MiniGames/Pit';
+import PlayerCosmetics from './PlayerCosmetics';
+import Quakecraft from './MiniGames/Quakecraft';
+import RecentGame from './RecentGame';
+import SkyWars from './MiniGames/SkyWars';
+import SmashHeroes from './MiniGames/SmashHeroes';
+import SpeedUHC from './MiniGames/SpeedUHC';
+import TNTGames from './MiniGames/TNTGames';
+import TurboKartRacers from './MiniGames/TurboKartRacers';
+import UHC from './MiniGames/UHC';
+import VampireZ from './MiniGames/VampireZ';
+import Walls from './MiniGames/Walls';
+import Warlords from './MiniGames/Warlords';
+import WoolWars from './MiniGames/WoolWars';
+import { getPlayerLevel, getRank, getSocialMedia, parseClaimedRewards, playerLevelProgress } from '../utils/Player';
+import { recursive } from '../utils/removeSnakeCase';
+
+export interface LevelProgress {
+  xpToNext: number;
+  remainingXP: number;
+  currentXP: number;
+  percent: number;
+  percentRemaining: number;
+}
+
+export interface PlayerSocialMedia {
+  name: string;
+  link: string;
+  id: string;
+}
+
+export type PlayerRank =
+  | 'Default'
+  | 'VIP'
+  | 'VIP+'
+  | 'MVP'
+  | 'MVP+'
+  | 'MVP++'
+  | 'Game Master'
+  | 'Admin'
+  | 'YouTube'
+  | 'Events'
+  | 'Mojang'
+  | 'Owner'
+  | 'PIG+++'
+  | 'Innit';
+
+export interface RanksPurchaseTime {
+  VIP: Date | null;
+  VIP_PLUS: Date | null;
+  MVP: Date | null;
+  MVP_PLUS: Date | null;
+}
+
+class Player {
+  nickname: string;
+  uuid: string;
+  rank: PlayerRank;
+  guild: Guild | null;
+  houses: House[] | null;
+  recentGames: RecentGame[] | null;
+  channel: string | null;
+  firstLoginTimestamp: number | null;
+  firstLogin: Date | null;
+  lastLoginTimestamp: number | null;
+  lastLogin: Date | null;
+  lastLogoutTimestamp: number | null;
+  lastLogout: Date | null;
+  recentlyPlayedGame: Game | null;
+  plusColor: Color | null;
+  prefixColor: Color | null;
+  karma: number;
+  achievements: object;
+  achievementPoints: number;
+  totalExperience: number;
+  level: number;
+  socialMedia: PlayerSocialMedia[];
+  giftBundlesSent: number;
+  giftBundlesReceived: number;
+  giftsSent: number;
+  isOnline: boolean;
+  lastDailyReward: Date | null;
+  lastDailyRewardTimestamp: number | null;
+  totalRewards: number | null;
+  totalDailyRewards: number | null;
+  rewardStreak: number | null;
+  rewardScore: number | null;
+  rewardHighScore: number | null;
+  levelProgress: LevelProgress;
+  stats: object | null;
+  userLanguage: string;
+  claimedLevelingRewards: number[];
+  globalCosmetics: PlayerCosmetics | null;
+  ranksPurchaseTime: RanksPurchaseTime;
+
+  constructor(
+    data: Record<string, any>,
+    extra: { guild: Guild | null; houses: House[] | null; recentGames: RecentGame[] | null }
+  ) {
+    this.nickname = data.displayname;
+    this.uuid = data.uuid;
+    this.rank = getRank(data);
+    this.guild = extra.guild;
+    this.houses = extra.houses;
+    this.recentGames = extra.recentGames;
+    this.channel = data.channel || null;
+    this.firstLoginTimestamp = data.firstLogin || null;
+    this.firstLogin = data.firstLogin ? new Date(data.firstLogin) : null;
+    this.lastLoginTimestamp = data.lastLogin || null;
+    this.lastLogin = data.lastLogin ? new Date(data.lastLogin) : null;
+    this.lastLogoutTimestamp = data.lastLogout || null;
+    this.lastLogout = data.lastLogout ? new Date(data.lastLogout) : null;
+    this.recentlyPlayedGame = data.mostRecentGameType ? new Game(data.mostRecentGameType) : null;
+    this.plusColor =
+      'MVP+' === this.rank || 'MVP++' === this.rank
+        ? data.rankPlusColor
+          ? new Color(data.rankPlusColor)
+          : new Color('RED')
+        : null;
+    this.prefixColor =
+      'MVP++' === this.rank ? (data.monthlyRankColor ? new Color(data.monthlyRankColor) : new Color('GOLD')) : null;
+    this.karma = data.karma || 0;
+    this.achievements = recursive(data.achievements);
+    this.achievementPoints = data.achievementPoints || 0;
+    this.totalExperience = data.networkExp || 0;
+    this.level = getPlayerLevel(this.totalExperience) || 0;
+    this.socialMedia = getSocialMedia(data.socialMedia) || [];
+    this.giftBundlesSent = data.giftingMeta ? data.giftingMeta.realBundlesGiven || 0 : null;
+    this.giftBundlesReceived = data.giftingMeta ? data.giftingMeta.realBundlesReceived || 0 : null;
+    this.giftsSent = data.giftingMeta ? data.giftingMeta.giftsGiven || 0 : null;
+    this.isOnline =
+      null !== this.lastLoginTimestamp &&
+      null !== this.lastLogoutTimestamp &&
+      this.lastLoginTimestamp > this.lastLogoutTimestamp;
+    this.lastDailyReward = data.lastAdsenseGenerateTime ? new Date(data.lastAdsenseGenerateTime) : null;
+    this.lastDailyRewardTimestamp = data.lastAdsenseGenerateTime || null;
+    this.totalRewards = data.totalRewards || null;
+    this.totalDailyRewards = data.totalDailyRewards || null;
+    this.rewardStreak = data.rewardStreak || null;
+    this.rewardScore = data.rewardScore || null;
+    this.rewardHighScore = data.rewardHighScore || null;
+    this.levelProgress = playerLevelProgress(data.networkExp);
+    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;
+    this.userLanguage = data.userLanguage || 'ENGLISH';
+    this.claimedLevelingRewards = parseClaimedRewards(data) || [];
+    this.globalCosmetics = data ? new PlayerCosmetics(data) : null;
+    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
+    };
+  }
+
+  toString(): string {
+    return this.nickname;
+  }
+}
+
+export default Player;

package/src/structures/{PlayerCosmetics.js → PlayerCosmetics.ts}

@@ -1,23 +1,22 @@
 /* eslint-disable no-underscore-dangle */
-const { removeSnakeCaseString } = require('../utils/removeSnakeCase');
-const Pets = require('./Pets');
-/**
- * Player Cosmetics class
- */
+import Pets from './Pets';
+import { removeSnakeCaseString } from '../utils/removeSnakeCase';
+
 class PlayerCosmetics {
-  /**
-   * @param {object} data data
-   */
-  constructor(data) {
-    /**
-     * All cosmetics
-     * @type {string[]}
-     */
+  allCosmetics: string[];
+  petManager: Pets | null;
+  _suits: any;
+  _hats: any;
+  _gadgets: any;
+  _morphs: any;
+  _cloaks: any;
+  _taunts: any;
+  _rankColors: any;
+  _particle: any;
+  _particlepacks: any;
+  _clickfx: any;
+  constructor(data: Record<string, any>) {
     this.allCosmetics = data?.vanityMeta?.packages || undefined;
-    /**
-     * Pets
-     * @type {Pets|null}
-     */
     this.petManager = this.allCosmetics
       ? new Pets(
           this.allCosmetics.filter((x) => x.startsWith('pet_')),
@@ -25,11 +24,8 @@ class PlayerCosmetics {
         )
       : null;
   }
-  /**
-   * Suits
-   * @type {string[]}
-   */
-  get suits() {
+
+  suits(): string[] {
     if (!this._suits) {
       this._suits = this.allCosmetics
         ? this.allCosmetics
@@ -39,11 +35,8 @@ class PlayerCosmetics {
     }
     return this._suits;
   }
-  /**
-   * Hats
-   * @type {string[]}
-   */
-  get hats() {
+
+  hats(): string[] {
     if (!this._hats) {
       this._hats = this.allCosmetics
         ? this.allCosmetics
@@ -53,11 +46,8 @@ class PlayerCosmetics {
     }
     return this._hats;
   }
-  /**
-   * Gadgets
-   * @type {string[]}
-   */
-  get gadgets() {
+
+  gadgets(): string[] {
     if (!this._gadgets) {
       this._gadgets = this.allCosmetics
         ? this.allCosmetics
@@ -67,11 +57,8 @@ class PlayerCosmetics {
     }
     return this._gadgets;
   }
-  /**
-   * Morphs
-   * @type {string[]}
-   */
-  get morphs() {
+
+  morphs(): string[] {
     if (!this._morphs) {
       this._morphs = this.allCosmetics
         ? this.allCosmetics
@@ -81,11 +68,8 @@ class PlayerCosmetics {
     }
     return this._morphs;
   }
-  /**
-   * Cloaks
-   * @type {string[]}
-   */
-  get cloaks() {
+
+  cloaks(): string[] {
     if (!this._cloaks) {
       this._cloaks = this.allCosmetics
         ? this.allCosmetics
@@ -95,11 +79,8 @@ class PlayerCosmetics {
     }
     return this._cloaks;
   }
-  /**
-   * Taunts
-   * @type {string[]}
-   */
-  get taunts() {
+
+  taunts(): string[] {
     if (!this._taunts) {
       this._taunts = this.allCosmetics
         ? this.allCosmetics
@@ -109,11 +90,8 @@ class PlayerCosmetics {
     }
     return this._taunts;
   }
-  /**
-   * rankColors
-   * @type {string[]}
-   */
-  get rankColors() {
+
+  rankColors(): string[] {
     if (!this._rankColors) {
       this._rankColors = this.allCosmetics
         ? this.allCosmetics
@@ -123,11 +101,8 @@ class PlayerCosmetics {
     }
     return this._rankColors;
   }
-  /**
-   * Particle Packs
-   * @type {string[]}
-   */
-  get particlePacks() {
+
+  particlePacks(): string[] {
     if (!this._particle) {
       this._particle = this.allCosmetics
         ? this.allCosmetics
@@ -137,11 +112,8 @@ class PlayerCosmetics {
     }
     return this._particlepacks;
   }
-  /**
-   * Click Effects
-   * @type {string[]}
-   */
-  get clickEffects() {
+
+  clickEffects(): string[] {
     if (!this._clickfx) {
       this._clickfx = this.allCosmetics
         ? this.allCosmetics
@@ -152,4 +124,5 @@ class PlayerCosmetics {
     return this._clickfx;
   }
 }
-module.exports = PlayerCosmetics;
+
+export default PlayerCosmetics;

package/src/structures/RecentGame.ts

@@ -0,0 +1,27 @@
+import Game from './Game';
+
+class RecentGame extends Game {
+  dateTimestamp: number | null;
+  date: Date | null;
+  mode: string | null;
+  map: string | null;
+  ongoing: boolean;
+  endedAt: Date | null;
+  endedTimestamp: number | null;
+  constructor(data: Record<string, any>) {
+    super(data.gameType);
+    this.dateTimestamp = data.date || null;
+    this.date = data.date ? new Date(data.date) : null;
+    this.mode = data.mode || null;
+    this.map = data.map || null;
+    this.ongoing = Boolean(!data.ended);
+    this.endedAt = data.ended ? new Date(data.ended) : null;
+    this.endedTimestamp = data.ended ? data.ended : null;
+  }
+
+  toString(): any {
+    return this.mode;
+  }
+}
+
+export default RecentGame;

package/src/structures/ServerInfo.ts

@@ -0,0 +1,40 @@
+export interface PlayerInfo {
+  max: number;
+  online: number;
+  players: any[];
+  toString(): string;
+}
+
+class ServerInfo {
+  protocolUsed: number;
+  versionInfo: string;
+  players: PlayerInfo;
+  rawMOTD: string;
+  cleanMOTD: string;
+  textMOTD: string;
+  faviconB64: string;
+  favicon: Buffer;
+  ping: number;
+  constructor(data: Record<string, any>, ping: string | number) {
+    this.protocolUsed = data.version.protocol || 736;
+    this.versionInfo = data.version.name || 'Unknown';
+    this.players = {
+      max: data.players.max || 0,
+      online: data.players.online || 0,
+      players: data.players.sample || [],
+      toString: () => `${this.players.online}/${this.players.max}`
+    };
+    this.rawMOTD = data.description || '';
+    this.cleanMOTD = this.rawMOTD.replace(/§[a-z0-9]/gi, '');
+    this.textMOTD = this.cleanMOTD.replace(/^\s+/gm, '');
+    this.faviconB64 = data.favicon;
+    this.favicon = Buffer.from(this.faviconB64, 'base64');
+    this.ping = parseInt(String(ping), 10);
+  }
+
+  toString(): string {
+    return `${this.textMOTD} - ${this.players} Players (${this.ping} ms) - ${this.versionInfo}`;
+  }
+}
+
+export default ServerInfo;

package/src/structures/SkyBlock/Auctions/Auction.ts

@@ -0,0 +1,43 @@
+import BaseAuction from './BaseAuction';
+import Bid from './Bid';
+import { SkyblockRarity } from '../../../utils/SkyblockUtils';
+
+class Auction extends BaseAuction {
+  coop: string[];
+  auctionStartTimestamp: number;
+  auctionStart: Date;
+  auctionEndTimestamp: number | null;
+  auctionEnd: Date | null;
+  item: string;
+  itemLore: string;
+  itemLoreRaw: string;
+  rarity: SkyblockRarity;
+  startingBid: number;
+  highestBid: number;
+  bids: Bid[];
+  claimed: boolean;
+  claimedBidders: string[];
+  constructor(data: Record<string, any>, includeItemBytes: boolean = false) {
+    super(data, includeItemBytes);
+    this.coop = data.coop || [];
+    this.auctionStartTimestamp = data.start;
+    this.auctionStart = new Date(this.auctionStartTimestamp);
+    this.auctionEndTimestamp = data.end || null;
+    this.auctionEnd = this.auctionEndTimestamp ? new Date(this.auctionEndTimestamp) : null;
+    this.item = data.item_name || null;
+    this.itemLore = data.item_lore ? data.item_lore.replace(/§([1-9]|[a-l])|§/gm, '') : null;
+    this.itemLoreRaw = data.item_lore || null;
+    this.rarity = data.tier || null;
+    this.startingBid = data.starting_bid || 0;
+    this.highestBid = this.bin ? data.starting_bid : data.highest_bid_amount || 0;
+    this.bids = data.bids.length ? data.bids.map((b: any) => new Bid(b)) : [];
+    this.claimed = data.claimed || false;
+    this.claimedBidders = this.claimed ? data.claimed_bidders : [];
+  }
+
+  toString(): string {
+    return this.item;
+  }
+}
+
+export default Auction;

package/src/structures/SkyBlock/Auctions/AuctionInfo.ts

@@ -0,0 +1,20 @@
+class AuctionInfo {
+  page: number;
+  totalPages: number;
+  totalAuctions: number;
+  lastUpdatedTimestamp: number;
+  lastUpdatedAt: Date;
+  constructor(data: Record<string, any>) {
+    this.page = parseInt(data.page, 10);
+    this.totalPages = parseInt(data.totalPages, 10);
+    this.totalAuctions = parseInt(data.totalAuctions, 10);
+    this.lastUpdatedTimestamp = data.lastUpdated;
+    this.lastUpdatedAt = new Date(this.lastUpdatedTimestamp);
+  }
+
+  toString(): string {
+    return `${this.page}/${this.totalPages}`;
+  }
+}
+
+export default AuctionInfo;

package/src/structures/SkyBlock/Auctions/BaseAuction.ts

@@ -0,0 +1,22 @@
+import ItemBytes from '../../ItemBytes';
+
+class BaseAuction {
+  auctionId: string | null;
+  auctioneerUuid: string | null;
+  auctioneerProfile: string | null;
+  bin: boolean;
+  itemBytes: ItemBytes | null;
+  constructor(data: Record<string, any>, includeItemBytes: boolean) {
+    this.auctionId = data.uuid || data.auction_id || null;
+    this.auctioneerUuid = data.auctioneer || data.seller || null;
+    this.auctioneerProfile = data.profile_id || data.seller_profile || null;
+    this.bin = data.bin || false;
+    this.itemBytes = includeItemBytes ? new ItemBytes(data.item_bytes) : null;
+  }
+
+  toString(): string | null {
+    return this.auctionId;
+  }
+}
+
+export default BaseAuction;

package/src/structures/SkyBlock/Auctions/Bid.ts

@@ -0,0 +1,22 @@
+class Bid {
+  auctionId: string | null;
+  profileId: string | null;
+  amount: number;
+  timestamp: number | null;
+  at: Date | null;
+  bidder: string | null;
+  constructor(data: Record<string, any>) {
+    this.auctionId = data.auction_id || null;
+    this.profileId = data.profile_id || null;
+    this.amount = data.amount || 0;
+    this.timestamp = data.timestamp || null;
+    this.at = this.timestamp ? new Date(this.timestamp) : null;
+    this.bidder = data.bidder || null;
+  }
+
+  toString(): string {
+    return `${this.bidder} bid ${this.amount} coins`;
+  }
+}
+
+export default Bid;

package/src/structures/SkyBlock/Bazzar/Order.ts

@@ -0,0 +1,18 @@
+class Order {
+  amount: number;
+  pricePerUnit: number;
+  totalPrice: number;
+  orders: number;
+  constructor(data: Record<string, any>) {
+    this.amount = data.amount || 0;
+    this.pricePerUnit = data.pricePerUnit || 0;
+    this.totalPrice = Math.round(this.amount * this.pricePerUnit * 10) / 10;
+    this.orders = data.orders || 0;
+  }
+
+  toString(): number {
+    return this.totalPrice;
+  }
+}
+
+export default Order;

package/src/structures/SkyBlock/Bazzar/Product.ts

@@ -0,0 +1,40 @@
+import Order from './Order';
+
+export interface ProductStatus {
+  sellPrice: number;
+  buyPrice: number;
+  sellVolume: number;
+  buyVolume: number;
+  sellMovingWeek: number;
+  buyMovingWeek: number;
+  sellOrders: number;
+  buyOrders: number;
+}
+
+class Product {
+  productId: string;
+  sellSummary: Order[];
+  buySummary: Order[];
+  status: ProductStatus;
+  constructor(data: Record<string, any>) {
+    this.productId = data.product_id;
+    this.sellSummary = data.sell_summary.length
+      ? data.sell_summary.map((sellOrder: Record<string, any>) => new Order(sellOrder))
+      : [];
+    this.buySummary = data.buy_summary.length
+      ? data.buy_summary.map((buyOrder: Record<string, any>) => new Order(buyOrder))
+      : [];
+    this.status = {
+      sellPrice: isNaN(data.quick_status.sellPrice) ? 0 : Math.round(data.quick_status.sellPrice * 100) / 100,
+      buyPrice: isNaN(data.quick_status.buyPrice) ? 0 : Math.round(data.quick_status.buyPrice * 100) / 100,
+      sellVolume: isNaN(data.quick_status.sellVolume) ? 0 : data.quick_status.sellVolume,
+      buyVolume: isNaN(data.quick_status.buyVolume) ? 0 : data.quick_status.buyVolume,
+      sellMovingWeek: isNaN(data.quick_status.sellMovingWeek) ? 0 : data.quick_status.sellMovingWeek,
+      buyMovingWeek: isNaN(data.quick_status.buyMovingWeek) ? 0 : data.quick_status.buyMovingWeek,
+      sellOrders: isNaN(data.quick_status.sellOrders) ? 0 : data.quick_status.sellOrders,
+      buyOrders: isNaN(data.quick_status.buyOrders) ? 0 : data.quick_status.buyOrders
+    };
+  }
+}
+
+export default Product;

package/src/structures/SkyBlock/News/SkyblockNews.ts

@@ -0,0 +1,35 @@
+const dateRegExp = /(\d{1,2})(?:st|nd|rd|th|) ([A-Za-z]+) (\d+)/;
+const versionRegExp = /v\d+(\.\d+){1,}/;
+
+function parseDate(stringDate: string): Date | null {
+  const matched = stringDate.match(dateRegExp);
+  if (!matched) return null;
+  return new Date(matched.slice(1).join(' '));
+}
+
+function parseVer(stringVer: string): string | null {
+  const matches = versionRegExp.exec(stringVer);
+  if (!matches?.length) return null;
+  return matches[0];
+}
+
+class SkyblockNews {
+  title: string;
+  link: string;
+  rawDate: string;
+  date: Date | null;
+  version: string | null;
+  constructor(data: Record<string, any>) {
+    this.title = data.title;
+    this.link = data.link;
+    this.rawDate = data.text;
+    this.date = parseDate(data.text);
+    this.version = parseVer(this.title);
+  }
+
+  toString(): string {
+    return this.title;
+  }
+}
+
+export default SkyblockNews;