hypixel-api-reborn 10.0.0 → 11.0.0

package/src/structures/PlayerCosmetics.js

@@ -1,95 +1,100 @@
-const Pets = require('./Pets');
-const { removeSnakeCaseString } = require('../utils/removeSnakeCase');
-/**
- * Player Cosmetics class
- */
-class PlayerCosmetics {
-  /**
-   * @param {object} data data
-   */
-  constructor (data) {
-    /**
-     * All cosmetics
-     * @type {string[]}
-     */
-    this.allCosmetics = data.vanityMeta ? data.vanityMeta.packages : undefined;
-    /**
-     * Pets
-     * @type {Pets|null}
-     */
-    this.petManager = this.allCosmetics ? new Pets(this.allCosmetics.filter((x) => x.startsWith('pet_')), data) : null;
-  }
-  /**
-   * Suits
-   * @type {string[]}
-   */
-  get suits () {
-    if (!this._suits) this._suits = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('suit_')).map((x) => removeSnakeCaseString(x.replace('suit_', ''))) || [] : [];
-    return this._suits;
-  }
-  /**
-   * Hats
-   * @type {string[]}
-   */
-  get hats () {
-    if (!this._hats) this._hats = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('hat_')).map((x) => removeSnakeCaseString(x.replace('hat_', ''))) || [] : [];
-    return this._hats;
-  }
-  /**
-   * Gadgets
-   * @type {string[]}
-   */
-  get gadgets () {
-    if (!this._gadgets) this._gadgets = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('gadget_')).map((x) => removeSnakeCaseString(x.replace('gadget_', ''))) || [] : [];
-    return this._gadgets;
-  }
-  /**
-   * Morphs
-   * @type {string[]}
-   */
-  get morphs () {
-    if (!this._morphs) this._morphs = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('morph_')).map((x) => removeSnakeCaseString(x.replace('morph_', ''))) || [] : [];
-    return this._morphs;
-  }
-  /**
-   * Cloaks
-   * @type {string[]}
-   */
-  get cloaks () {
-    if (!this._cloaks) this._cloaks = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('cloak_')).map((x) => removeSnakeCaseString(x.replace('cloak_', ''))) || [] : [];
-    return this._cloaks;
-  }
-  /**
-   * Taunts
-   * @type {string[]}
-   */
-  get taunts () {
-    if (!this._taunts) this._taunts = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('taunt_')).map((x) => removeSnakeCaseString(x.replace('taunt_', ''))) || [] : [];
-    return this._taunts;
-  }
-  /**
-   * rankColors
-   * @type {string[]}
-   */
-  get rankColors () {
-    if (!this._rankcolors) this._rankcolors = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('rankcolor_')).map((x) => removeSnakeCaseString(x.replace('rankcolor_', ''))) || [] : [];
-    return this._rankcolors;
-  }
-  /**
-   * Particle Packs
-   * @type {string[]}
-   */
-  get particlePacks () {
-    if (!this._particle) this._particle = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('particlepack_')).map((x) => removeSnakeCaseString(x.replace('particlepack_', ''))) || [] : [];
-    return this._particlepacks;
-  }
-  /**
-   * Click Effects
-   * @type {string[]}
-   */
-  get clickEffects () {
-    if (!this._clickfx) this._clickfx = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('clickeffects_')).map((x) => removeSnakeCaseString(x.replace('clickeffects_', ''))) || [] : [];
-    return this._clickfx;
-  }
-}
-module.exports = PlayerCosmetics;
+const Pets = require('./Pets');
+const { removeSnakeCaseString } = require('../utils/removeSnakeCase');
+/**
+ * Player Cosmetics class
+ */
+class PlayerCosmetics {
+  /**
+   * @param {object} data data
+   */
+  constructor(data) {
+    /**
+     * All cosmetics
+     * @type {string[]}
+     */
+    this.allCosmetics = data.vanityMeta ? data.vanityMeta.packages : undefined;
+    /**
+     * Pets
+     * @type {Pets|null}
+     */
+    this.petManager = this.allCosmetics
+      ? new Pets(
+          this.allCosmetics.filter((x) => x.startsWith('pet_')),
+          data
+        )
+      : null;
+  }
+  /**
+   * Suits
+   * @type {string[]}
+   */
+  get suits() {
+    if (!this._suits) this._suits = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('suit_')).map((x) => removeSnakeCaseString(x.replace('suit_', ''))) || [] : [];
+    return this._suits;
+  }
+  /**
+   * Hats
+   * @type {string[]}
+   */
+  get hats() {
+    if (!this._hats) this._hats = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('hat_')).map((x) => removeSnakeCaseString(x.replace('hat_', ''))) || [] : [];
+    return this._hats;
+  }
+  /**
+   * Gadgets
+   * @type {string[]}
+   */
+  get gadgets() {
+    if (!this._gadgets) this._gadgets = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('gadget_')).map((x) => removeSnakeCaseString(x.replace('gadget_', ''))) || [] : [];
+    return this._gadgets;
+  }
+  /**
+   * Morphs
+   * @type {string[]}
+   */
+  get morphs() {
+    if (!this._morphs) this._morphs = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('morph_')).map((x) => removeSnakeCaseString(x.replace('morph_', ''))) || [] : [];
+    return this._morphs;
+  }
+  /**
+   * Cloaks
+   * @type {string[]}
+   */
+  get cloaks() {
+    if (!this._cloaks) this._cloaks = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('cloak_')).map((x) => removeSnakeCaseString(x.replace('cloak_', ''))) || [] : [];
+    return this._cloaks;
+  }
+  /**
+   * Taunts
+   * @type {string[]}
+   */
+  get taunts() {
+    if (!this._taunts) this._taunts = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('taunt_')).map((x) => removeSnakeCaseString(x.replace('taunt_', ''))) || [] : [];
+    return this._taunts;
+  }
+  /**
+   * rankColors
+   * @type {string[]}
+   */
+  get rankColors() {
+    if (!this._rankcolors) this._rankcolors = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('rankcolor_')).map((x) => removeSnakeCaseString(x.replace('rankcolor_', ''))) || [] : [];
+    return this._rankcolors;
+  }
+  /**
+   * Particle Packs
+   * @type {string[]}
+   */
+  get particlePacks() {
+    if (!this._particle) this._particle = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('particlepack_')).map((x) => removeSnakeCaseString(x.replace('particlepack_', ''))) || [] : [];
+    return this._particlepacks;
+  }
+  /**
+   * Click Effects
+   * @type {string[]}
+   */
+  get clickEffects() {
+    if (!this._clickfx) this._clickfx = this.allCosmetics ? this.allCosmetics.filter((x) => x.startsWith('clickeffects_')).map((x) => removeSnakeCaseString(x.replace('clickeffects_', ''))) || [] : [];
+    return this._clickfx;
+  }
+}
+module.exports = PlayerCosmetics;

package/src/structures/RecentGame.js

@@ -1,57 +1,57 @@
-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;
+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 +1,78 @@
-/**
- * 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;
+/**
+ * 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;

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

@@ -1,104 +1,104 @@
-const Bid = require('./Bid');
-const BaseAuction = require('./BaseAuction');
-/**
- * Auction class
- */
-class Auction extends BaseAuction {
-  /**
-   * @param {object} data
-   * @param {boolean} includeItemBytes
-   */
-  constructor (data, includeItemBytes) {
-    super(data, includeItemBytes);
-    /**
-     * Coop members. Array of UUIDs
-     * @type {string[]}
-     */
-    this.coop = data.coop || [];
-    /**
-     * Auction start timestamp
-     * @type {number|null}
-     */
-    this.auctionStartTimestamp = data.start || null;
-    /**
-     * Auction start timestamp as Date
-     * @type {Date}
-     */
-    this.auctionStart = data.start ? new Date(data.start) : null;
-    /**
-     * Auction end timestamp as Date
-     * @type {Date}
-     */
-    this.auctionEnd = data.end ? new Date(data.end) : null;
-    /**
-     * Auction end timestamp as timestamp
-     * @type {number}
-     */
-    this.auctionEndTimestamp = data.end || null;
-    /**
-     * Auction Item Name
-     * @type {string}
-     */
-    this.item = data.item_name || null;
-    /**
-     * Auction Item lore ( plain text )
-     * @type {string}
-     */
-    this.itemLore = data.item_lore ? data.item_lore.replace(/§([1-9]|[a-l])|§/gm, '') : null;
-    /**
-     * Auctipn Item Lore as it is from the API
-     * @type {string}
-     */
-    this.itemLoreRaw = data.item_lore || null;
-    /**
-     * Rarity of Item
-     * @type {Rarity}
-     */
-    this.rarity = data.tier || null;
-    /**
-     * Auction starting bid, or price for BIN
-     * @type {number}
-     */
-    this.startingBid = data.starting_bid || 0;
-    /**
-    * Auction's highest bid, if it is bidded or price for BIN
-    * @type {number}
-    */
-    this.highestBid = (this.bin) ? data.starting_bid : data.highest_bid_amount || 0;
-    /**
-     * Auction bids
-     * @type {Bid[]}
-     */
-    this.bids = data.bids.length ? data.bids.map((b) => new Bid(b)) : [];
-    /**
-     * is Auction Claimed
-     * @type {boolean}
-     */
-    this.claimed = data.claimed || false;
-    /**
-     * Which bidders, if any, claimed
-     * @type {string[]}
-     */
-    this.claimedBidders = this.claimed ? data.claimed_bidders : [];
-  }
-  /**
-   * Item Name
-   * @return {string}
-   */
-  toString() {
-    return this.item;
-  }
-}
-/**
- * @typedef {string} Rarity
- * * `VERY_SPECIAL`
- * * `SPECIAL`
- * * `SUPREME`
- * * `MYTHIC`
- * * `LEGENDARY`
- * * `EPIC`
- * * `RARE`
- * * `UNCOMMON`
- * * `COMMON`
- */
-module.exports = Auction;
+const Bid = require('./Bid');
+const BaseAuction = require('./BaseAuction');
+/**
+ * Auction class
+ */
+class Auction extends BaseAuction {
+  /**
+   * @param {object} data
+   * @param {boolean} includeItemBytes
+   */
+  constructor(data, includeItemBytes) {
+    super(data, includeItemBytes);
+    /**
+     * Coop members. Array of UUIDs
+     * @type {string[]}
+     */
+    this.coop = data.coop || [];
+    /**
+     * Auction start timestamp
+     * @type {number|null}
+     */
+    this.auctionStartTimestamp = data.start || null;
+    /**
+     * Auction start timestamp as Date
+     * @type {Date}
+     */
+    this.auctionStart = data.start ? new Date(data.start) : null;
+    /**
+     * Auction end timestamp as Date
+     * @type {Date}
+     */
+    this.auctionEnd = data.end ? new Date(data.end) : null;
+    /**
+     * Auction end timestamp as timestamp
+     * @type {number}
+     */
+    this.auctionEndTimestamp = data.end || null;
+    /**
+     * Auction Item Name
+     * @type {string}
+     */
+    this.item = data.item_name || null;
+    /**
+     * Auction Item lore ( plain text )
+     * @type {string}
+     */
+    this.itemLore = data.item_lore ? data.item_lore.replace(/§([1-9]|[a-l])|§/gm, '') : null;
+    /**
+     * Auctipn Item Lore as it is from the API
+     * @type {string}
+     */
+    this.itemLoreRaw = data.item_lore || null;
+    /**
+     * Rarity of Item
+     * @type {Rarity}
+     */
+    this.rarity = data.tier || null;
+    /**
+     * Auction starting bid, or price for BIN
+     * @type {number}
+     */
+    this.startingBid = data.starting_bid || 0;
+    /**
+     * Auction's highest bid, if it is bidded or price for BIN
+     * @type {number}
+     */
+    this.highestBid = this.bin ? data.starting_bid : data.highest_bid_amount || 0;
+    /**
+     * Auction bids
+     * @type {Bid[]}
+     */
+    this.bids = data.bids.length ? data.bids.map((b) => new Bid(b)) : [];
+    /**
+     * is Auction Claimed
+     * @type {boolean}
+     */
+    this.claimed = data.claimed || false;
+    /**
+     * Which bidders, if any, claimed
+     * @type {string[]}
+     */
+    this.claimedBidders = this.claimed ? data.claimed_bidders : [];
+  }
+  /**
+   * Item Name
+   * @return {string}
+   */
+  toString() {
+    return this.item;
+  }
+}
+/**
+ * @typedef {string} Rarity
+ * * `VERY_SPECIAL`
+ * * `SPECIAL`
+ * * `SUPREME`
+ * * `MYTHIC`
+ * * `LEGENDARY`
+ * * `EPIC`
+ * * `RARE`
+ * * `UNCOMMON`
+ * * `COMMON`
+ */
+module.exports = Auction;