hypixel-api-reborn 11.2.1 → 11.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypixel-api-reborn",
-  "version": "11.2.1",
+  "version": "11.3.0",
   "description": "Feature-rich Hypixel API wrapper for Node.js",
   "main": "./src/index.js",
   "types": "./typings/index.d.ts",
@@ -32,7 +32,7 @@
     "node-fetch": "^3.3.2",
     "prismarine-nbt": "^2.5.0",
     "rss-parser": "^3.13.0",
-    "skyhelper-networth": "latest"
+    "skyhelper-networth": "^1.21.0"
   },
   "license": "MIT",
   "readme": "https://hypixel.stavzdev.me/",
@@ -42,15 +42,15 @@
   "publisher": "StavZ",
   "devDependencies": {
     "@discordjs/docgen": "github:discordjs/docgen",
-    "@types/node": "^20.11.19",
+    "@types/node": "^20.14.11",
     "chai": "^4.3.4",
-    "eslint": "^9.3.0",
-    "eslint-plugin-jsdoc": "^48.2.7",
-    "globals": "^15.3.0",
+    "eslint": "^9.7.0",
+    "eslint-plugin-jsdoc": "^48.8.3",
+    "globals": "^15.8.0",
     "mocha": "^10.4.0",
     "node-env-run": "^4.0.2",
     "path": "^0.12.7",
-    "prettier": "^3.2.5",
-    "typescript": "^5.3.3"
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.3"
   }
 }

package/src/API/housing/getActiveHouses.js

@@ -0,0 +1,7 @@
+module.exports = async function () {
+  const House = require('../../structures/House');
+  // eslint-disable-next-line no-underscore-dangle
+  const res = await this._makeRequest('/housing/active');
+  if (res.raw) return res;
+  return res.length ? res.map((b) => new House(b)) : [];
+};

package/src/API/housing/getHouse.js

@@ -0,0 +1,9 @@
+const Errors = require('../../Errors');
+module.exports = async function (query) {
+  if (!query) throw new Error(Errors.NO_UUID);
+  const House = require('../../structures/House');
+  // eslint-disable-next-line no-underscore-dangle
+  const res = await this._makeRequest(`/housing/house?house=${query}`);
+  if (res.raw) return res;
+  return new House(res);
+};

package/src/API/housing/getPlayerHouses.js

@@ -0,0 +1,11 @@
+const Errors = require('../../Errors');
+const toUuid = require('../../utils/toUuid');
+module.exports = async function (query) {
+  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
+  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
+  const House = require('../../structures/House');
+  // eslint-disable-next-line no-underscore-dangle
+  const res = await this._makeRequest(`/housing/houses?player=${query}`);
+  if (res.raw) return res;
+  return res.length ? res.map((b) => new House(b)) : [];
+};

package/src/API/index.js

@@ -22,9 +22,14 @@ module.exports = {
   getSkyblockBingoByPlayer: require('./skyblock/getBingoByPlayer.js'),
   getSkyblockEndedAuctions: require('./skyblock/getEndedAuctions.js'),
   getSkyblockFireSales: require('./skyblock/getFireSales.js'),
+  getSkyblockGarden: require('./skyblock/getGarden.js'),
   getSkyblockGovernment: require('./skyblock/getGovernment.js'),
   getSkyblockMember: require('./skyblock/getMember.js'),
   getSkyblockMuseum: require('./skyblock/getMuseum.js'),
   getSkyblockNews: require('./skyblock/getNews.js'),
-  getSkyblockProfiles: require('./skyblock/getProfiles.js')
+  getSkyblockProfiles: require('./skyblock/getProfiles.js'),
+
+  getActiveHouses: require('./housing/getActiveHouses.js'),
+  getPlayerHouses: require('./housing/getPlayerHouses.js'),
+  getHouse: require('./housing/getHouse.js')
 };

package/src/API/skyblock/getGarden.js

@@ -0,0 +1,7 @@
+module.exports = async function (profileId) {
+  const SkyblockGarden = require('../../structures/SkyBlock/SkyblockGarden');
+  // eslint-disable-next-line no-underscore-dangle
+  const res = await this._makeRequest(`/skyblock/garden?profile=${profileId}`);
+  if (res.raw) return res;
+  return new SkyblockGarden(res);
+};

package/src/API/skyblock/getMember.js

@@ -1,9 +1,10 @@
 const Errors = require('../../Errors');
 const toUuid = require('../../utils/toUuid');
 const getPlayer = require('../getPlayer');
-module.exports = async function (query, options = { fetchPlayer: false, getMuseum: false }) {
+module.exports = async function (query, options = { fetchPlayer: false, getMuseum: false, getGarden: false }) {
   const SkyblockMember = require('../../structures/SkyBlock/SkyblockMember');
-  const getSkyblockMuseum = require('../skyblock/getMuseum');
+  const getSkyblockMuseum = require('./getMuseum');
+  const getSkyblockGarden = require('./getGarden');
   if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
   query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
   // eslint-disable-next-line no-underscore-dangle
@@ -25,6 +26,7 @@ module.exports = async function (query, options = { fetchPlayer: false, getMuseu
         banking: profile.banking,
         communityUpgrades: profile.community_upgrades,
         museum: options.getMuseum ? await getSkyblockMuseum.call(this, query, profile.profile_id) : null,
+        garden: options.getGarden ? await getSkyblockGarden.call(this, profile.profile_id) : null,
         selected: profile.selected
       })
     );

package/src/API/skyblock/getProfiles.js

@@ -1,9 +1,10 @@
 const Errors = require('../../Errors');
 const toUuid = require('../../utils/toUuid');
 const getPlayer = require('../getPlayer');
-module.exports = async function (query, options = { fetchPlayer: false, getMuseum: false }) {
+module.exports = async function (query, options = { fetchPlayer: false, getMuseum: false, getGarden: false }) {
   const SkyblockProfile = require('../../structures/SkyBlock/SkyblockProfile');
-  const getSkyblockMuseum = require('../skyblock/getMuseum');
+  const getSkyblockMuseum = require('./getMuseum');
+  const getSkyblockGarden = require('./getGarden');
   if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
   query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
   // eslint-disable-next-line no-underscore-dangle
@@ -38,6 +39,7 @@ module.exports = async function (query, options = { fetchPlayer: false, getMuseu
       banking: res.profiles[i].banking,
       communityUpgrades: res.profiles[i].community_upgrades,
       museum: options.getMuseum ? await getSkyblockMuseum.call(this, query, res.profiles[i].profile_id) : null,
+      garden: options.getGarden ? await getSkyblockGarden.call(this, res.profiles[i].profile_id) : null,
       selected: res.profiles[i].selected,
       members: res.profiles[i].members
     });

package/src/Client.js

@@ -15,6 +15,7 @@ const Booster = require('./structures/Boosters/Booster');
 const SkyblockProfile = require('./structures/SkyBlock/SkyblockProfile');
 const SkyblockMember = require('./structures/SkyBlock/SkyblockMember');
 const SkyblockMuseum = require('./structures/SkyBlock/SkyblockMuseum');
+const SkyblockGarden = require('./structures/SkyBlock/SkyblockGarden');
 const APIStatus = require('./structures/APIStatus');
 const Leaderboard = require('./structures/Leaderboard');
 const ServerInfo = require('./structures/ServerInfo');
@@ -30,6 +31,7 @@ const GovernmentData = require('./structures/SkyBlock/Static/Government');
 const FireSale = require('./structures/SkyBlock/Static/FireSale');
 const SkyblockNews = require('./structures/SkyBlock/News/SkyblockNews');
 const GameCounts = require('./structures/GameCounts');
+const House = require('./structures/House.js');
 /* eslint-enable */
 
 /**
@@ -252,6 +254,24 @@ class Client extends EventEmitter {
    * const member = await hypixel.getSkyblockMember('StavZDev').catch(console.log);
    * console.log(member.get('Cucumber').uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
    */
+  /**
+   * Allows you to get a player's skyblock member data from all their profiles
+   * @method
+   * @name Client#getSkyblockGarden
+   * @param {string} profileId Profile id of the garden you want
+   * @param {MethodOptions} [options={}] Method options
+   * @return {Promise<SkyblockGarden>}
+   * @example
+   * hypixel.getSkyblockMember('StavZDev').then(member => {
+   *   // 'Cucumber' - profile name
+   *   console.log(member.get('Cucumber').uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
+   * }).catch(e => {
+   *   console.log(e);
+   * })
+   * @example
+   * const member = await hypixel.getSkyblockMember('StavZDev').catch(console.log);
+   * console.log(member.get('Cucumber').uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
+   */
   /**
    * Allows you to get a player's skyblock profile museum
    * @method
@@ -403,6 +423,29 @@ class Client extends EventEmitter {
    * @param {MethodOptions} [options={}] Options
    * @return {Promise<FireSale[]>}
    */
+  /**
+   * Get a array of active houses
+   * @method
+   * @name Client#getActiveHouses
+   * @param {MethodOptions} [options={}] Options
+   * @return {Promise<House[]>}
+   */
+  /**
+   * Get a array of houses for a user
+   * @method
+   * @name Client#getPlayerHouses
+   * @param {string} query UUID / IGN of player
+   * @param {MethodOptions} [options={}] Options
+   * @return {Promise<House[]>}
+   */
+  /**
+   * Get a house
+   * @method
+   * @name Client#getHouse
+   * @param {string} query House UUID
+   * @param {MethodOptions} [options={}] Options
+   * @return {Promise<House>}
+   */
   /**
    * Allows you to get skyblock news
    * @method
@@ -477,11 +520,12 @@ const defaultCache = require('./Private/defaultCache.js');
  */
 /**
  * @typedef {object} SkyblockMethodOptions
- * @property {boolean} [fetchPlayer=false] Raw data
- * @property {boolean} [getMuseum=false] Raw data
+ * @property {boolean} [raw=false] Raw data
  * @property {boolean} [noCacheCheck=false] Disable/Enable cache checking
  * @property {boolean} [noCaching=false] Disable/Enable writing to cache
  * @property {?boolean} [fetchPlayer=false] Disable/Enable player profile request for each member
+ * @property {?boolean} [getMuseum=false] Disable/Enable player museum request for each member
+ * @property {?boolean} [getGarden=false] Disable/Enable player garden request for each member
  * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
  */
 /**

package/src/Private/requests.js

@@ -34,7 +34,7 @@ class Requests {
     if (422 === res.status) throw new Error(Errors.UNEXPECTED_ERROR);
     if (429 === res.status) throw new Error(Errors.RATE_LIMIT_EXCEEDED);
     if (200 !== res.status) throw new Error(Errors.ERROR_STATUSTEXT.replace(/{statustext}/, res.statusText));
-    if (!parsedRes.success) {
+    if (!parsedRes.success && !endpoint.startsWith('/housing')) {
       throw new Error(Errors.SOMETHING_WENT_WRONG.replace(/{cause}/, res.cause));
     }
     // eslint-disable-next-line no-underscore-dangle

package/src/index.js

@@ -29,6 +29,7 @@ module.exports = {
   /* SkyBlock */
   SkyblockProfile: require('./structures/SkyBlock/SkyblockProfile.js'),
   SkyblockMember: require('./structures/SkyBlock/SkyblockMember.js'),
+  SkyblockGarden: require('./structures/SkyBlock/SkyblockGarden.js'),
   SkyblockInventoryItem: require('./structures/SkyBlock/SkyblockInventoryItem.js'),
   SkyblockPet: require('./structures/SkyBlock/SkyblockPet'),
   GovernmentData: require('./structures/SkyBlock/Static/Government.js'),
@@ -54,6 +55,9 @@ module.exports = {
   /* Booster */
   Booster: require('./structures/Boosters/Booster.js'),
 
+  /* House */
+  House: require('./structures/House.js'),
+
   /* MiniGames */
   Arcade: require('./structures/MiniGames/Arcade.js'),
   ArenaBrawl: require('./structures/MiniGames/ArenaBrawl.js'),
@@ -65,6 +69,7 @@ module.exports = {
   MegaWalls: require('./structures/MiniGames/MegaWalls.js'),
   MurderMystery: require('./structures/MiniGames/MurderMystery.js'),
   Paintball: require('./structures/MiniGames/Paintball.js'),
+  Pit: require('./structures/MiniGames/Pit.js'),
   Quakecraft: require('./structures/MiniGames/Quakecraft.js'),
   SkyWars: require('./structures/MiniGames/SkyWars.js'),
   SmashHeroes: require('./structures/MiniGames/SmashHeroes.js'),

package/src/structures/House.js

@@ -0,0 +1,54 @@
+/**
+ * House class
+ */
+class House {
+  /**
+   * @param {object} data data
+   */
+  constructor(data) {
+    /**
+     * Name of the house
+     * @type {string}
+     */
+    this.name = data.name || '';
+    /**
+     * UUID of the house
+     * @type {string}
+     */
+    this.uuid = data.uuid || '';
+    /**
+     * UUID of the house owner
+     * @type {string}
+     */
+    this.owner = data.owner || '';
+    /**
+     * Timestamp when the house was created
+     * @type {number}
+     */
+    this.createdAtTimestamp = data.createdAt || 0;
+    /**
+     * Date when the house was created
+     * @type {Date|null}
+     */
+    this.createdAt = new Date(this.createdAtTimestamp);
+    /**
+     * Number of players currently at the house
+     * @type {number}
+     */
+    this.players = data.players || 0;
+    /**
+     * Number of cookies the house has
+     * @type {number}
+     */
+    this.cookies = data.cookies?.current || 0;
+  }
+  /**
+   * House Nmae
+   * @return {string}
+   */
+  toString() {
+    return this.name;
+  }
+}
+
+module.exports = House;