hypixel-api-reborn 11.0.0 → 11.1.0

package/.prettierrc

@@ -1,13 +1,13 @@
-{
-  "bracketSameLine": true,
-  "trailingComma": "none",
-  "arrowParens": "always",
-  "bracketSpacing": true,
-  "proseWrap": "always",
-  "singleQuote": true,
-  "printWidth": 210,
-  "useTabs": false,
-  "tabWidth": 2,
-  "semi": true,
-  "endOfLine": "lf"
-}
+{
+  "bracketSameLine": true,
+  "trailingComma": "none",
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "proseWrap": "always",
+  "singleQuote": true,
+  "printWidth": 210,
+  "useTabs": false,
+  "tabWidth": 2,
+  "semi": true,
+  "endOfLine": "lf"
+}

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 StavZDev
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2020 StavZDev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,65 +1,65 @@
-<div align="center">
-<img src="https://i.imgur.com/cDFoQZU.png?1">
-<h1>Hypixel API • Reborn</h1>
-<a href="https://discord.gg/NSEBNMM"><img src="https://discordapp.com/api/guilds/660416184252104705/embed.png"></a>
-<a href="https://travis-ci.org/StavZ/hypixel-api-reborn"><img src="https://flat.badgen.net/travis/hypixel-api-reborn/hypixel-api-reborn"></a>
-<a href="https://app.codacy.com/gh/Hypixel-API-Reborn/hypixel-api-reborn?utm_source=github.com&utm_medium=referral&utm_content=Hypixel-API-Reborn/hypixel-api-reborn&utm_campaign=Badge_Grade"><img src="https://flat.badgen.net/codacy/grade/71cd7e95499b496cb2dd11c29b9def33/master"></a>
-<img src="https://flat.badgen.net/npm/v/hypixel-api-reborn">
-<img src="https://flat.badgen.net/npm/node/hypixel-api-reborn">
-<img src="https://flat.badgen.net/npm/license/hypixel-api-reborn">
-<a href="https://github.com/Hypixel-API-Reborn/hypixel-api-reborn"><img src="https://flat.badgen.net/github/stars/hypixel-api-reborn/hypixel-api-reborn"></a>
-<a href="https://www.npmjs.com/package/hypixel-api-reborn"><img src="https://nodei.co/npm/hypixel-api-reborn.png?compact=true"></a>
-<h2>A feature-rich Hypixel API wrapper for Node.js</h2>
-<br>
-</div>
-
-### Links
-
-[Discord Support](https://discord.gg/NSEBNMM) | [Documentation](https://hypixel-api-reborn.github.io/) | [NPM](https://www.npmjs.com/package/hypixel-api-reborn) |
-[GitHub](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn) | [ToDo](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/projects/1) | [CLI](https://github.com/Hypixel-API-Reborn/cli)
-
-#### Requirements
-
-**For Node.js users >= v14.x.x** <br> **For TypeScript users >= v3.5**
-
-### Installation & Usage
-
-```shell
-npm i hypixel-api-reborn
-```
-
-```js
-const Hypixel = require('hypixel-api-reborn');
-const hypixel = new Hypixel.Client('API-KEY');
-// https://stavzdev.is-inside.me/cCMiZdoy.gif
-
-// getPlayer
-hypixel
-  .getPlayer('StavZDev')
-  .then((player) => {
-    console.log(player.level); // 141
-  })
-  .catch((e) => {
-    console.error(e);
-  });
-
-// getGuild
-hypixel
-  .getGuild('name', 'The Foundation')
-  .then((guild) => {
-    console.log(guild.level); // 111
-  })
-  .catch((e) => {
-    console.error(e);
-  });
-```
-
-For more examples go to our [documentation](https://hypixel-api-reborn.github.io/).
-
-## Changelog
-
-[v10.0.0](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/releases/tag/10.0.0)
-
-### Try it now
-
-**[Code Sandbox](https://codesandbox.io/s/clever-babbage-xqmfw?file=/src/index.js)**
+<div align="center">
+<img src="https://i.imgur.com/cDFoQZU.png?1">
+<h1>Hypixel API • Reborn</h1>
+<a href="https://discord.gg/NSEBNMM"><img src="https://discordapp.com/api/guilds/660416184252104705/embed.png"></a>
+<a href="https://travis-ci.org/StavZ/hypixel-api-reborn"><img src="https://flat.badgen.net/travis/hypixel-api-reborn/hypixel-api-reborn"></a>
+<a href="https://app.codacy.com/gh/Hypixel-API-Reborn/hypixel-api-reborn?utm_source=github.com&utm_medium=referral&utm_content=Hypixel-API-Reborn/hypixel-api-reborn&utm_campaign=Badge_Grade"><img src="https://flat.badgen.net/codacy/grade/71cd7e95499b496cb2dd11c29b9def33/master"></a>
+<img src="https://flat.badgen.net/npm/v/hypixel-api-reborn">
+<img src="https://flat.badgen.net/npm/node/hypixel-api-reborn">
+<img src="https://flat.badgen.net/npm/license/hypixel-api-reborn">
+<a href="https://github.com/Hypixel-API-Reborn/hypixel-api-reborn"><img src="https://flat.badgen.net/github/stars/hypixel-api-reborn/hypixel-api-reborn"></a>
+<a href="https://www.npmjs.com/package/hypixel-api-reborn"><img src="https://nodei.co/npm/hypixel-api-reborn.png?compact=true"></a>
+<h2>A feature-rich Hypixel API wrapper for Node.js</h2>
+<br>
+</div>
+
+### Links
+
+[Discord Support](https://discord.gg/NSEBNMM) | [Documentation](https://hypixel-api-reborn.github.io/) | [NPM](https://www.npmjs.com/package/hypixel-api-reborn) |
+[GitHub](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn) | [ToDo](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/projects/1) | [CLI](https://github.com/Hypixel-API-Reborn/cli)
+
+#### Requirements
+
+**For Node.js users >= v14.x.x** <br> **For TypeScript users >= v3.5**
+
+### Installation & Usage
+
+```shell
+npm i hypixel-api-reborn
+```
+
+```js
+const Hypixel = require('hypixel-api-reborn');
+const hypixel = new Hypixel.Client('API-KEY');
+// https://stavzdev.is-inside.me/cCMiZdoy.gif
+
+// getPlayer
+hypixel
+  .getPlayer('StavZDev')
+  .then((player) => {
+    console.log(player.level); // 141
+  })
+  .catch((e) => {
+    console.error(e);
+  });
+
+// getGuild
+hypixel
+  .getGuild('name', 'The Foundation')
+  .then((guild) => {
+    console.log(guild.level); // 111
+  })
+  .catch((e) => {
+    console.error(e);
+  });
+```
+
+For more examples go to our [documentation](https://hypixel-api-reborn.github.io/).
+
+## Changelog
+
+[v11.0.0](https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/releases/tag/11.0.0)
+
+### Try it now
+
+**[Code Sandbox](https://codesandbox.io/s/clever-babbage-xqmfw?file=/src/index.js)**

package/package.json

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

package/src/API/getAPIStatus.js

@@ -3,6 +3,6 @@ const Parser = new Rss();
 module.exports = async function (options) {
   const Status = require('../structures/APIStatus.js');
   const parsed = await Parser.parseURL('https://status.hypixel.net/history.rss');
-  if (options.raw) return parsed;
+  if (options && options.raw) return parsed;
   return new Status(parsed);
 };

package/src/API/skyblock/getSkyblockMember.js

@@ -7,9 +7,7 @@ module.exports = async function (query, options = { fetchPlayer: false }) {
   query = await toUuid(query);
   const res = await this._makeRequest(`/skyblock/profiles?uuid=${query}`);
   if (res.raw) return res;
-  if (!res.profiles || !res.profiles.length) {
-    return new Map();
-  }
+  if (!res.profiles || !res.profiles.length) throw new Error(Errors.NO_SKYBLOCK_PROFILES);
   const player = options.fetchPlayer ? await getPlayer.call(this, query, options) : null;
   const memberByProfileName = new Map();
   for (const profile of res.profiles) {

package/src/API/skyblock/getSkyblockProfiles.js

@@ -7,11 +7,7 @@ module.exports = async function (query, options = { fetchPlayer: false }) {
   query = await toUuid(query);
   const res = await this._makeRequest(`/skyblock/profiles?uuid=${query}`);
   if (res.raw) return res;
-
-  if (!res.profiles || !res.profiles.length) {
-    return [];
-  }
-
+  if (!res.profiles || !res.profiles.length) throw new Error(Errors.NO_SKYBLOCK_PROFILES);
   const players = new Map();
   if (options.fetchPlayer) {
     const uniqueUuids = [...new Set(res.profiles.map((profile) => Object.keys(profile.members)).flat())];

package/src/Client.js

@@ -42,10 +42,10 @@ class Client extends EventEmitter {
           args
         );
       };
+    }
 
-      if (this.options.checkForUpdates) {
-        updater.checkForUpdates();
-      }
+    if (this.options.checkForUpdates) {
+      updater.checkForUpdates();
     }
     /**
      * All cache entries
@@ -357,7 +357,7 @@ class Client extends EventEmitter {
  * @prop {number} [cacheSize=-1] The amount how many results will be cached. (`-1` for infinity)
  * @prop {boolean} [silent=false] Don't automatically put warnings into console.
  * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request.
- * @prop {boolean} [checkForUpdates=false] Enable/Disable check for new version of hypixel-api-reborn.
+ * @prop {boolean} [checkForUpdates=true] Enable/Disable check for new version of hypixel-api-reborn.
  */
 const defaultCache = require('./Private/defaultCache.js');
 /**

package/src/Errors.js

@@ -40,5 +40,6 @@ module.exports = {
   UNEXPECTED_ERROR:
     "[hypixel-api-reborn] The data provided to hypixel API is malformed and thus not recognized by hypixel, but this shouldn't be your fault. Please report this error in our Discord Server https://discord.gg/NSEBNMM or GitHub. ",
   RATE_LIMIT_EXCEEDED:
-    "[hypixel-api-reborn] The rate limitations on your API Key has been exceeded. There might be an outage (Check Hypixel's status page), or you simply did too many requests in a short time. Hint: Enable rate limit options! They can help you avoid this error! For help join our Discord Server https://discord.gg/NSEBNMM"
+    "[hypixel-api-reborn] The rate limitations on your API Key has been exceeded. There might be an outage (Check Hypixel's status page), or you simply did too many requests in a short time. Hint: Enable rate limit options! They can help you avoid this error! For help join our Discord Server https://discord.gg/NSEBNMM",
+  NO_SKYBLOCK_PROFILES: '[hypixel-api-reborn] The player has no skyblock profiles.'
 };

package/src/Private/requests.js

@@ -1,7 +1,7 @@
 /* eslint-disable require-jsdoc */
 const requireFetch = !globalThis.fetch;
 const externalFetch = require('node-fetch');
-const BASE_URL = 'https://api.hypixel.net';
+const BASE_URL = 'https://api.hypixel.net/v2';
 const Errors = require('../Errors');
 const Cache = require('./defaultCache');
 const Client = require('../Client.js');

package/src/Private/updater.js

@@ -1,5 +1,5 @@
-/* eslint-disable no-console */
 /* eslint-disable require-jsdoc */
+/* eslint-disable no-console */
 const fetch = require('node-fetch');
 const Errors = require('../Errors');
 class Updater {
@@ -11,23 +11,9 @@ class Updater {
     const latestVersion = metadata['dist-tags'].latest;
     const compare = this.compare(currentVersion, latestVersion);
     if (compare === -1) {
-      this.notify(latestVersion);
+      console.log(`New version of hypixel-api-reborn is available! Current version: ${currentVersion}, Latest version: ${latestVersion}`);
     }
   }
-  notify(newVersion) {
-    console.log(`
-
-    New version of hypixel-api-reborn is available!
-    
-    v${newVersion}
-    Changelog: https://github.com/Hypixel-API-Reborn/hypixel-api-reborn/releases/tag/${newVersion}
-
-    \x1b[33mnpm i hypixel-api-reborn@${newVersion}\x1b[0m
-    or
-    \x1b[33myarn add hypixel-api-reborn@${newVersion}\x1b[0m
-    
-    `);
-  }
   compare(a, b) {
     const pa = a.split('.');
     const pb = b.split('.');

package/src/Private/validate.js

@@ -38,7 +38,7 @@ class Validation {
       syncWithHeaders: !!options.syncWithHeaders,
       headers: options.headers || {},
       silent: !!options.silent,
-      checkForUpdates: options.checkForUpdates || false
+      checkForUpdates: options.checkForUpdates || true
     };
   }
 

package/src/structures/MiniGames/WoolWars.js

@@ -83,7 +83,7 @@ class WoolWars {
    */
   static generateStatsFor(data, _class) {
     // N.B i called it _class instead of class because reserved keyword
-    const workingData = (_class ? data?.['classes'][_class] : data) || {};
+    const workingData = (_class ? data?.['classes']?.[_class] : data) || {};
     return {
       roundWins: workingData.wins || 0,
       gamesPlayed: workingData.games_played || 0,

package/src/structures/Pet.js

@@ -44,7 +44,7 @@ class Pet {
      * Last time the pet was fed ( Date )
      * @type {?Date}
      */
-    this.lastFedAt = this.lastFed ? new Date(this.stats.lastFed) : null;
+    this.lastFedAt = this.lastFed ? new Date(this.lastFed) : null;
     /**
      * Thirst value ( 100 is highest )
      * @type {?number}
@@ -59,7 +59,7 @@ class Pet {
      * Last time the pet drank ( Date )
      * @type {?Date}
      */
-    this.lastDrankAt = this.lastDrank ? new Date(this.stats.lastDrank) : null;
+    this.lastDrankAt = this.lastDrank ? new Date(this.lastDrank) : null;
     /**
      * Exercise/Entertainment value ( 100 is highest )
      * @type {?number}
@@ -74,7 +74,7 @@ class Pet {
      * Last time the pet exercised ( Date )
      * @type {?Date}
      */
-    this.lastExercisedAt = this.lastExercised ? new Date(this.stats.lastExerciced) : null;
+    this.lastExercisedAt = this.lastExercised ? new Date(this.lastExerciced) : null;
     /**
      * Raw Nickname, if any
      * @type {?string}

package/src/utils/Constants.js

@@ -756,7 +756,8 @@ module.exports = {
     IDLE: 'Idle',
     QUEUE: 'Queue',
     MAIN_LOBBY: 'Main Lobby',
-    TOURNAMENT_LOBBY: 'Tournament Lobby'
+    TOURNAMENT_LOBBY: 'Tournament Lobby',
+    WOOL_GAMES: 'Wool Wars'
   },
   SkyWarsPrestigeIcons: {
     default: '⋆',
@@ -815,6 +816,7 @@ module.exports = {
     { name: 'The Pit', code: 'PIT', id: 64 },
     { name: 'Replay', code: 'REPLAY', id: 65 },
     { name: 'SMP', code: 'SMP', id: 67 },
+    { name: 'Wool Wars', code: 'WOOL_GAMES', id: 68 },
     { name: 'Limbo', code: 'LIMBO', id: -2 },
     { name: 'Queue', code: 'QUEUE', id: -3 },
     { name: 'Main Lobby', code: 'MAIN_LOBBY', id: -4 },

package/typings/index.d.ts

@@ -41,8 +41,9 @@ export type GAME_NAME =
   | 'Main Lobby'
   | 'Tournament Lobby'
   | 'Idle'
-  | 'SMP';
-export type GAME_ID = 2 | 3 | 4 | 5 | 6 | 7 | 13 | 14 | 17 | 20 | 21 | 23 | 24 | 25 | 26 | 51 | 52 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 63 | 64 | 65 | 67 | -1 | -2 | -3 | -4 | -5 | -6;
+  | 'SMP'
+  | 'Wool Wars';
+export type GAME_ID = 2 | 3 | 4 | 5 | 6 | 7 | 13 | 14 | 17 | 20 | 21 | 23 | 24 | 25 | 26 | 51 | 52 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 63 | 64 | 65 | 67 | 68 | -1 | -2 | -3 | -4 | -5 | -6;
 export type GAME_CODE =
   | 'QUAKECRAFT'
   | 'WALLS'
@@ -76,7 +77,8 @@ export type GAME_CODE =
   | 'QUEUE'
   | 'MAIN_LOBBY'
   | 'TOURNAMENT_LOBBY'
-  | 'SMP';
+  | 'SMP'
+  | 'WOOL_GAMES';
 export type SKYWARS_PRESTIGE = 'Iron' | 'Gold' | 'Diamond' | 'Emerald' | 'Sapphire' | 'Ruby' | 'Crystal' | 'Opal' | 'Amethyst' | 'Rainbow' | 'Mythic';
 export type SKYWARS_PRESTIGE_ICON = '⋆' | '★' | '☆' | '⁕' | '✶' | '✳' | '✴' | '✷' | '❋' | '✼' | '❂' | '❁' | '☬' | '✙' | '❤️' | '☠' | '✦' | '✌' | '❦' | '✵' | '❣' | '☯' | '✺' | 'ಠ_ಠ' | '⚔';
 export type BEDWARS_PRESTIGE =