hypixel-api-reborn 11.3.0 → 11.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypixel-api-reborn",
-  "version": "11.3.0",
+  "version": "11.3.2",
   "description": "Feature-rich Hypixel API wrapper for Node.js",
   "main": "./src/index.js",
   "types": "./typings/index.d.ts",

package/src/API/skyblock/getFireSales.js

@@ -3,5 +3,5 @@ module.exports = async function () {
   // eslint-disable-next-line no-underscore-dangle
   const res = await this._makeRequest('/skyblock/firesales');
   if (res.raw) return res;
-  return res.sales.length ? res.sales.map((a) => new FireSale(a)) : [];
+  return res.sales.length ? res.sales.map((sale) => new FireSale(sale)) : [];
 };

package/src/structures/MiniGames/Duels.js

@@ -113,6 +113,11 @@ class DuelsGamemode {
      * @type {number}
      */
     this.goldenApplesEatan = data[`${mode}_golden_apples_eaten`] || 0;
+    /**
+     * Goals (only shows up in bridge)
+     * @type {number}
+     */
+    this.goals = data[`${mode}_goals`] || 0;
   }
 }
 
@@ -803,6 +808,18 @@ class DuelsBridge {
       this['2v2v2v2'].goldenApplesEatan +
       this['3v3v3v3'].goldenApplesEatan +
       this.ctf.goldenApplesEatan;
+    /**
+     * Goals
+     * @type {number}
+     */
+    this.goals =
+      this.solo.goals +
+      this.doubles.goals +
+      this.threes.goals +
+      this.fours.goals +
+      this['2v2v2v2'].goals +
+      this['3v3v3v3'].goals +
+      this.ctf.goals;
   }
 }
 

package/src/structures/Player.js

@@ -286,9 +286,11 @@ class Player {
  * * `MVP`
  * * `MVP+`
  * * `MVP++`
+ * * `YouTube`
  * * `Game Master`
  * * `Admin`
- * * `YouTube`
+ * * `PIG+++`
+ * * `INNIT`
  */
 /**
  * @typedef {Object} PlayerSocialMedia

package/typings/index.d.ts

@@ -17,10 +17,8 @@ export type PLAYER_RANK =
   | 'YouTube'
   | 'Game Master'
   | 'Admin'
-  | 'EVENTS'
-  | 'MCP'
-  | 'MOJANG'
-  | 'PIG+++';
+  | 'PIG+++'
+  | 'INNIT';
 export type GAME_NAME =
   | 'Quake Craft'
   | 'Walls'
@@ -377,13 +375,13 @@ export interface methodOptions {
   noCaching?: boolean;
 }
 export interface playerMethodOptions extends methodOptions {
-  raw?: boolean;
   guild?: boolean;
   recentGames?: boolean;
 }
 export interface skyblockMemberOptions extends methodOptions {
-  raw?: boolean;
   fetchPlayer?: boolean;
+  getMuseum?: boolean;
+  getGarden?: boolean;
 }
 export interface auctionsOptions extends methodOptions {
   noInfo?: boolean;
@@ -1125,172 +1123,208 @@ declare module 'hypixel-api-reborn' {
      * @description Returns all cache entries
      */
     readonly cache: Map<string, any>;
+    /**
+     * @description Retrieves information about Hypixel achievements.
+     * @param {methodOptions} [options] - The method options.
+     */
+    getAchievements(options?: methodOptions): Promise<Achievements>;
+    /**
+     * @description Parses the RSS feed from status.hypixel.net
+     * @param {methodOptions} [options] - The method options.
+     */
+    getAPIStatus(options?: methodOptions): Promise<APIStatus>;
+    /**
+     * @description Allows you to get all active boosters
+     * @param {methodOptions} [options] - The method options.
+     */
+    getBoosters(options?: methodOptions): Promise<Booster[]>;
+    /**
+     * @description Allows you to get information about hypixel challenges [NO KEY REQUIRED]
+     * @param {methodOptions} [options] - The method options.
+     */
+    getChallenges(options?: methodOptions): Promise<Challenges>;
+    /**
+     * @description Allows you to get player count along with the player count of each public game
+     * @param {methodOptions} [options] - The method options.
+     */
+    getGameCounts(options?: methodOptions): Promise<GameCounts>;
+    /**
+     * @description Allows you to get statistics of hypixel guild
+     * @param {"id"|"name"|"player"} searchParameter - How you want to search
+     * @param {string} query - guild name, player nickname or guild id
+     * @param {methodOptions} [options] - The method options.
+     */
+    getGuild(searchParameter: 'id' | 'name' | 'player', query: string, options?: methodOptions): Promise<Guild>;
+    /**
+     * @description Allows you to get information about hypixel guild achievements [NO KEY REQUIRED]
+     * @param {methodOptions} [options] - The method options.
+     */
+    getGuildAchievements(options?: methodOptions): Promise<GuildAchievements>;
+    /**
+     * @description Allows you to get leaderboards of each mini-game
+     * @param {methodOptions} [options] - The method options.
+     */
+    getLeaderboards(options?: methodOptions): Promise<{
+      ARENA: Leaderboard[];
+      COPS_AND_CRIMS: Leaderboard[];
+      WARLORDS: Leaderboard[];
+      BLITZ_SURVIVAL_GAMES: Leaderboard[];
+      UHC: Leaderboard[];
+      WALLS: Leaderboard[];
+      PROTOTYPE: Leaderboard[];
+      PAINTBALL: Leaderboard[];
+      SKYWARS: Leaderboard[];
+      MURDER_MYSTERY: Leaderboard[];
+      SMASH_HEROES: Leaderboard[];
+      DUELS: Leaderboard[];
+      SPEED_UHC: Leaderboard[];
+      TNTGAMES: Leaderboard[];
+      BEDWARS: Leaderboard[];
+      TURBO_KART_RACERS: Leaderboard[];
+      BUILD_BATTLE: Leaderboard[];
+      ARCADE: Leaderboard[];
+      SKYCLASH: Leaderboard[];
+      QUAKECRAFT: Leaderboard[];
+      CRAZY_WALLS: Leaderboard[];
+      MEGA_WALLS: Leaderboard[];
+      VAMPIREZ: Leaderboard[];
+    }>;
     /**
      * @description Allows you to get statistics of player
-     * @param query - player nickname or uuid
-     * @param options - player search options
+     * @param {string} query - player nickname or uuid
+     * @param {playerMethodOptions} [options] - player search options
      */
     getPlayer(query: string, options?: playerMethodOptions): Promise<Player>;
     /**
-     * @description Allows you to get statistics of hypixel guild
-     * @param searchParameter - 'name', 'player' or 'id'
-     * @param query - guild name, player nickname or guild id
+     * @description Allows you to get information about hypixel quests [NO KEY REQUIRED]
+     * @param {methodOptions} [options] - Options
      */
-    getGuild(searchParameter: 'name' | 'player' | 'id', query: string, options?: methodOptions): Promise<Guild>;
+    getQuests(options?: methodOptions): Promise<Quests>;
     /**
-     * @description Allows you to get statistics of watchdog anticheat
+     * @description Allows you to get recent games of a player
+     * @param {string} query - player nickname or uuid
+     * @param {methodOptions} [options] - Options
      */
-    getWatchdogStats(options?: methodOptions): Promise<WatchdogStats>;
+    getRecentGames(query: string, options?: methodOptions): Promise<RecentGame[]>;
     /**
-     * @description Allows you to get all active boosters
+     * @description Parses information returned by hypixel upon a status request packet
+     * @param {number} repeats Amount of times to ping hypixel, preferably between 1 and 10 times.
      */
-    getBoosters(options?: methodOptions): Promise<Booster[]>;
+    getServerInfo(repeats?: number): Promise<ServerInfo>;
     /**
-     * @description Allows you to get a player's skyblock profiles
-     * @param query - player nickname or uuid
+     * @description Allows you to get player's network status
+     * @param {string} query - player nickname or uuid
+     * @param {methodOptions} [options] - Options
      */
-    getSkyblockProfiles(query: string, options?: skyblockMemberOptions): Promise<SkyblockProfile[]>;
+    getStatus(query: string, options?: methodOptions): Promise<Status>;
     /**
-     * @description Allows you to get a player's skyblock member data from all their profiles
-     * @param query - player nickname or uuid
+     * @description Allows you to get statistics of watchdog anticheat
+     * @param {methodOptions} [options] - Options
      */
-    getSkyblockMember(query: string, options?: skyblockMemberOptions): Promise<Map<string, SkyblockMember>>;
+    getWatchdogStats(options?: methodOptions): Promise<WatchdogStats>;
     /**
-     * Allows you to get filtered skyblock auctions
-     * Using auction ID will return an array of at most 1 element
-     * @method
+     * @description Allows you to get filtered skyblock auctions. Using auction ID will return an array of at most 1 element
      * @name Client#getSkyblockAuction
-     * @param type - Filter to use
-     * @param query - uuid of profile, player, or auction. IGN can be used as well
-     * @param includeItemBytes - include item bytes (optional)
-     * @param options - Options
+     * @param  {'PROFILE' | 'PLAYER' | 'AUCTION'} type - Filter to use
+     * @param {string} query - uuid of profile, player, or auction. IGN can be used as well
+     * @param {boolean} includeItemBytes - include item bytes (optional)
+     * @param {methodOptions} [options] - Options
      */
     getSkyblockAuction(
       type: 'PROFILE' | 'PLAYER' | 'AUCTION',
       query: string,
       includeItemBytes?: boolean,
       options?: methodOptions
-    ): Promise<Auction[]>; /**
-     * @description Allows you to get all auctions of player
-     * @deprecated Use Client#getSkyblockAuction
-     * @param query - player nickname or uuid
-     * @param includeItemBytes - include item bytes (optional)
+    ): Promise<Auction[]>;
+    /**
+     * Allows you to get skyblock auctions
+     * @param {string|number|number[]} page - "*", a page number, or an array with the start and the end page number ( automatically sorted )
+     * @param {auctionsOptions} [options={}] Options
+     * @return {Promise<{info:AuctionInfo,auctions:Auction[]}>}
      */
-    getEndedSkyblockAuctions(
-      includeItemBytes?: boolean,
-      options?: methodOptions
-    ): Promise<{ info: AuctionInfo; auctions: PartialAuction[] }>;
+    getSkyblockAuctions(
+      page: string | number | number[],
+      options: auctionsOptions
+    ): Promise<{ info: AuctionInfo; auctions: Auction[] }>;
     /**
      * @description Allows you to get all auctions of player
-     * @param query - player nickname or uuid
-     * @param includeItemBytes - include item bytes (optional)
+     * @param {string} query - player nickname or uuid
+     * @param {boolean} includeItemBytes - include item bytes (optional)
+     * @param {methodOptions} [options] - Options
      */
     getSkyblockAuctionsByPlayer(query: string, includeItemBytes?: boolean, options?: methodOptions): Promise<Auction[]>;
     /**
      * @description Allows you to get list of products
+     * @param {methodOptions} [options] - Options
      */
     getSkyblockBazaar(options?: methodOptions): Promise<Product[]>;
     /**
      * @description Gets bingo data
+     * @param {methodOptions} [options] - Options
      */
     getSkyblockBingo(options?: methodOptions): Promise<BingoData>;
     /**
      * @description Gets bingo data of a player
-     * @param query - UUID/IGN of player
+     * @param {string} query - UUID/IGN of player
+     * @param {methodOptions} [options] - Options
      */
     getSkyblockBingoByPlayer(query: string, options?: playerBingoOptions): Promise<PlayerBingo>;
+    /**
+     * @description Allows you to get list of active skyblock firesales
+     * @param {methodOptions} [options] - Options
+     */
+    getSkyblockFireSales(options?: methodOptions): Promise<FireSale[]>;
+    /**
+     * @description Allows you to get a profiles skyblock garden
+     * @param {methodOptions} [options] - Options
+     */
+    getSkyblockGarden(profileId: string, options?: methodOptions);
     /**
      * @description Gets data of skyblock government
+     * @param {methodOptions} [options] - Options
      */
     getSkyblockGovernment(options?: methodOptions): Promise<GovernmentData>;
     /**
-     * @description Gets data of skyblock government
+     * @description Allows you to get a player's skyblock member data from all their profiles
+     * @param query - player nickname or uuid
+     * @param {methodOptions} [options] - Options
      */
-    getSkyblockGovernment(options?: methodOptions): Promise<FireSale[]>;
+    getSkyblockMember(query: string, options?: skyblockMemberOptions): Promise<Map<string, SkyblockMember>>;
+    /**
+     * @description Allows you to get statistics of player
+     * @param {string} query - player nickname or uuid
+     * @param {string} profileId - profile id
+     * @param {methodOptions} [options] - Options
+     */
+    getSkyblockMuseum(query: string, profileId: string, options?: methodOptions);
     /**
      * @description Allows you to get skyblock news
+     * @param {methodOptions} [options] - Options
      */
     getSkyblockNews(options?: methodOptions): Promise<SkyblockNews>;
+    /**
+     * @description Allows you to get a player's skyblock profiles
+     * @param query - player nickname or uuid
+     * @param {methodOptions} [options] - Options
+     */
+    getSkyblockProfiles(query: string, options?: skyblockMemberOptions): Promise<SkyblockProfile[]>;
     /**
      * @description Get a array of active houses
+     * @param {methodOptions} [options] - Options
      */
     getActiveHouses(options?: methodOptions): Promise<House[]>;
     /**
      * @description Get a array of houses for a user
      * @param query - UUID / IGN of player
+     * @param {methodOptions} [options] - Options
      */
     getPlayerHouses(query: string, options?: methodOptions): Promise<House[]>;
     /**
      * @description Get a house
      * @param query - house uuid
+     * @param {methodOptions} [options] - Options
      */
     getHouse(query: string, options?: methodOptions): Promise<House>;
-    /**
-     * @description Allows you to get player's network status
-     * @param query - player nickname or uuid
-     */
-    getStatus(query: string, options?: methodOptions): Promise<Status>;
-    /**
-     * @description Allows you to get leaderboards of each mini-game
-     */
-    getLeaderboards(options?: methodOptions): Promise<{
-      ARENA: Leaderboard[];
-      COPS_AND_CRIMS: Leaderboard[];
-      WARLORDS: Leaderboard[];
-      BLITZ_SURVIVAL_GAMES: Leaderboard[];
-      UHC: Leaderboard[];
-      WALLS: Leaderboard[];
-      PROTOTYPE: Leaderboard[];
-      PAINTBALL: Leaderboard[];
-      SKYWARS: Leaderboard[];
-      MURDER_MYSTERY: Leaderboard[];
-      SMASH_HEROES: Leaderboard[];
-      DUELS: Leaderboard[];
-      SPEED_UHC: Leaderboard[];
-      TNTGAMES: Leaderboard[];
-      BEDWARS: Leaderboard[];
-      TURBO_KART_RACERS: Leaderboard[];
-      BUILD_BATTLE: Leaderboard[];
-      ARCADE: Leaderboard[];
-      SKYCLASH: Leaderboard[];
-      QUAKECRAFT: Leaderboard[];
-      CRAZY_WALLS: Leaderboard[];
-      MEGA_WALLS: Leaderboard[];
-      VAMPIREZ: Leaderboard[];
-    }>;
-    /**
-     * @description Allows you to get recent games of a player
-     */
-    getRecentGames(query: string, options?: methodOptions): Promise<RecentGame[]>;
-    /**
-     * @description Allows you to get player count along with the player count of each public game
-     */
-    getGameCounts(options?: methodOptions): Promise<GameCounts>;
-    /**
-     * @param repeats Amount of times to ping hypixel, preferably between 1 and 10 times.
-     * @description Parses information returned by hypixel upon a status request packet
-     */
-    getServerInfo(repeats?: number): Promise<ServerInfo>;
-    /**
-     * @description Parses the RSS feed from status.hypixel.net
-     */
-    getAPIStatus(): Promise<APIStatus>;
-    /**
-     * @description Allows you to get information about hypixel challenges [NO KEY REQUIRED]
-     */
-    getChallenges(options?: methodOptions): Promise<Challenges>;
-    /**
-     * @description Allows you to get information about hypixel quests [NO KEY REQUIRED]
-     */
-    getQuests(options?: methodOptions): Promise<Quests>;
-    /**
-     * Allows you to get information about hypixel achievements [NO KEY REQUIRED]
-     */
-    getAchievements(options?: methodOptions): Promise<Achievements>;
-    /**
-     * @description Allows you to get information about hypixel guild achievements [NO KEY REQUIRED]
-     */
-    getGuildAchievements(options?: methodOptions): Promise<GuildAchievements>;
     /**
      * @param amount - Amount of cache entries to delete
      * @description Allows you to clear cache
@@ -3816,6 +3850,7 @@ declare module 'hypixel-api-reborn' {
     blocksPlaced: number;
     healthRegenerated: number;
     goldenApplesEatan: number;
+    goals: number;
   }
   class DuelsUHC {
     constructor(data: Record<string, unknown>, mode: string, title: string);
@@ -3943,6 +3978,7 @@ declare module 'hypixel-api-reborn' {
     blocksPlaced: number;
     healthRegenerated: number;
     goldenApplesEatan: number;
+    goals: number;
   }
   class Duels {
     constructor(data: Record<string, unknown>);