Better Errors

Hypixel-API-Reborn · Aug 26, 2024 · 3592c0f · 3592c0f
1 parent cc1766c
commit 3592c0f
Show file tree

Hide file tree

Showing 24 changed files with 154 additions and 107 deletions.
diff --git a/src/API/getGuild.ts b/src/API/getGuild.ts
@@ -1,5 +1,6 @@
 import { RequestOptions } from '../Private/Requests';
 import Guild from '../structures/Guild/Guild';
+import Error from '../Private/ErrorHandler';
 import isGuildID from '../utils/isGuildID';
 import Endpoint from '../Private/Endpoint';
 import Client from '../Client';
@@ -16,17 +17,19 @@ class getGuild extends Endpoint {
     query: string,
     options?: RequestOptions
   ): Promise<Guild | null> {
-    if (!query) throw new Error(this.client.errors.NO_GUILD_QUERY);
-    if ('id' === searchParameter && !isGuildID(query)) throw new Error(this.client.errors.INVALID_GUILD_ID);
-    const isPlayerQuery = 'player' === searchParameter;
-    if (isPlayerQuery) query = await this.client.requests.toUUID(query);
     if (!['id', 'name', 'player'].includes(searchParameter)) {
-      throw new Error(this.client.errors.INVALID_GUILD_SEARCH_PARAMETER);
+      throw new Error(this.client.errors.INVALID_GUILD_SEARCH_PARAMETER, 'Fetching Guild Stats');
+    }
+    if (!query) throw new Error(this.client.errors.NO_GUILD_QUERY, 'Fetching Guild Stats');
+    if ('id' === searchParameter && !isGuildID(query)) {
+      throw new Error(this.client.errors.INVALID_GUILD_ID, 'Fetching Guild Stats');
     }
+    const isPlayerQuery = 'player' === searchParameter;
+    if (isPlayerQuery) query = await this.client.requests.toUUID(query);
     const res = await this.client.requests.request(`/guild?${searchParameter}=${encodeURI(query)}`, options);
     if (res.options.raw) return res.data;
     if (!res.data.guild && 'player' !== searchParameter) {
-      throw new Error(this.client.errors.GUILD_DOES_NOT_EXIST);
+      throw new Error(this.client.errors.GUILD_DOES_NOT_EXIST, 'Fetching Guild Stats');
     }
     return res.data.guild ? new Guild(res.data.guild, isPlayerQuery ? query : undefined) : null;
   }

diff --git a/src/API/getHouse.ts b/src/API/getHouse.ts
@@ -1,4 +1,5 @@
 import { RequestOptions } from '../Private/Requests';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import House from '../structures/House';
 import Client from '../Client';
@@ -11,7 +12,7 @@ class getHouse extends Endpoint {
   }
 
   async execute(query: string, options?: RequestOptions): Promise<House> {
-    if (!query) throw new Error(this.client.errors.NO_UUID);
+    if (!query) throw new Error(this.client.errors.NO_UUID, 'Fetching a House');
     const res = await this.client.requests.request(`/housing/house?house=${query}`, options);
     if (res.options.raw) return res.data;
     return new House(res.data);

diff --git a/src/API/getLeaderboards.ts b/src/API/getLeaderboards.ts
@@ -1,7 +1,8 @@
 import { RequestOptions } from '../Private/Requests';
 import Leaderboard from '../structures/Leaderboard';
-import Constants from '../utils/Constants';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
+import Constants from '../utils/Constants';
 import Client from '../Client';
 
 class getLeaderboards extends Endpoint {
@@ -15,7 +16,9 @@ class getLeaderboards extends Endpoint {
     const res = await this.client.requests.request('/leaderboards', options);
     if (res.options.raw) return res.data;
     if (!res.data.leaderboards) {
-      throw new Error(this.client.errors.SOMETHING_WENT_WRONG.replace(/{cause}/, 'Try again.'));
+      throw new Error(this.client.errors.SOMETHING_WENT_WRONG, 'Fetching Leaderboards', {
+        cause: 'Data is missing. Try again.'
+      });
     }
     const lbnames = Object.create(Constants.leaderboardNames);
     for (const name in lbnames) {

diff --git a/src/API/getPlayer.ts b/src/API/getPlayer.ts
@@ -1,4 +1,5 @@
 import { PlayerRequestOptions } from './API';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import Player from '../structures/Player';
 import Client from '../Client';
@@ -11,11 +12,11 @@ class getPlayer extends Endpoint {
   }
 
   async execute(query: string, options?: PlayerRequestOptions): Promise<Player> {
-    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID);
+    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID, 'Fetching Player');
     query = await this.client.requests.toUUID(query);
     const res = await this.client.requests.request(`/player?uuid=${query}`, options);
     if (res.options.raw) return res.data;
-    if (query && !res.data.player) throw new Error(this.client.errors.PLAYER_HAS_NEVER_LOGGED);
+    if (query && !res.data.player) throw new Error(this.client.errors.PLAYER_HAS_NEVER_LOGGED, 'Fetching Player');
     return new Player(res.data.player, {
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-expect-error

diff --git a/src/API/getPlayerHouses.ts b/src/API/getPlayerHouses.ts
@@ -1,4 +1,5 @@
 import { RequestOptions } from '../Private/Requests';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import House from '../structures/House';
 import Client from '../Client';
@@ -11,7 +12,7 @@ class getPlayerHouses extends Endpoint {
   }
 
   async execute(query: string, options?: RequestOptions): Promise<House[]> {
-    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID);
+    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID, 'Fetching Player Houses');
     query = await this.client.requests.toUUID(query);
     const res = await this.client.requests.request(`/housing/houses?player=${query}`, options);
     if (res.options.raw) return res.data;

diff --git a/src/API/getRecentGames.ts b/src/API/getRecentGames.ts
@@ -1,5 +1,6 @@
 import { RequestOptions } from '../Private/Requests';
 import RecentGame from '../structures/RecentGame';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import Client from '../Client';
 
@@ -11,7 +12,7 @@ class getRecentGames extends Endpoint {
   }
 
   async execute(query: string, options?: RequestOptions): Promise<RecentGame[]> {
-    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID);
+    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID, 'Fetching Recent Games');
     query = await this.client.requests.toUUID(query);
     const res = await this.client.requests.request(`/recentgames?uuid=${query}`, options);
     if (res.options.raw) return res.data;

diff --git a/src/API/getSkyblockAuction.ts b/src/API/getSkyblockAuction.ts
@@ -1,5 +1,6 @@
 import Auction from '../structures/SkyBlock/Auctions/Auction';
 import { AuctionRequestOptions } from './API';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import Client from '../Client';
 
@@ -24,12 +25,14 @@ class getSkyblockAction extends Endpoint {
     } else if ('auction' === type) {
       filter = 'uuid';
     } else {
-      throw new Error(this.client.errors.BAD_AUCTION_FILTER);
+      throw new Error(this.client.errors.BAD_AUCTION_FILTER, 'Fetching Skyblock Auction');
     }
-    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID);
+    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID, 'Fetching Skyblock Auction');
     const res = await this.client.requests.request(`/skyblock/auction?${filter}=${query}`, options);
     if (res.options.raw) return res.data;
-    return res.data.auctions.map((a: any) => new Auction(a, options?.includeItemBytes ?? false));
+    return res.data.auctions.map(
+      (a: Record<string, string | number | object>) => new Auction(a, options?.includeItemBytes ?? false)
+    );
   }
 }
 

diff --git a/src/API/getSkyblockAuctions.ts b/src/API/getSkyblockAuctions.ts
@@ -1,6 +1,7 @@
 import AuctionInfo from '../structures/SkyBlock/Auctions/AuctionInfo';
 import Auction from '../structures/SkyBlock/Auctions/Auction';
 import { AuctionRequestOptions } from './API';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import Client from '../Client';
 
@@ -16,9 +17,13 @@ class getSkyblockAuctions extends Endpoint {
     query: number | '*',
     options?: AuctionRequestOptions
   ): Promise<{ info: AuctionInfo; auctions: Auction[] }> {
-    if (!query) throw new Error(this.client.errors.INVALID_OPTION_VALUE);
-    if ('number' === typeof query && 0 >= query) throw new Error(this.client.errors.INVALID_OPTION_VALUE);
-    if ('number' !== typeof query && '*' !== query) throw new Error(this.client.errors.INVALID_OPTION_VALUE);
+    if (!query) throw new Error(this.client.errors.INVALID_OPTION_VALUE, 'Fetching Skyblock Auctions');
+    if ('number' === typeof query && 0 >= query) {
+      throw new Error(this.client.errors.INVALID_OPTION_VALUE, 'Fetching Skyblock Auctions');
+    }
+    if ('number' !== typeof query && '*' !== query) {
+      throw new Error(this.client.errors.INVALID_OPTION_VALUE, 'Fetching Skyblock Auctions');
+    }
     this.options = this.parseOptions(options);
     if ('*' === query) return await this.getAllPages();
     return await this.getPage(query);

diff --git a/src/API/getSkyblockAuctionsByPlayer.ts b/src/API/getSkyblockAuctionsByPlayer.ts
@@ -1,5 +1,6 @@
 import Auction from '../structures/SkyBlock/Auctions/Auction';
 import { AuctionRequestOptions } from './API';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import Client from '../Client';
 
@@ -11,7 +12,7 @@ class getSkyblockActionsByPlayer extends Endpoint {
   }
 
   async execute(query: string, options?: AuctionRequestOptions): Promise<Auction[]> {
-    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID);
+    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID, 'Fetching Skyb,oock Auctions By Player');
     query = await this.client.requests.toUUID(query);
     const res = await this.client.requests.request(`/skyblock/auction?player=${query}`);
     if (res.options.raw) return res.data;

diff --git a/src/API/getSkyblockGarden.ts b/src/API/getSkyblockGarden.ts
@@ -1,5 +1,6 @@
 import SkyblockGarden from '../structures/SkyBlock/SkyblockGarden';
 import { RequestOptions } from '../Private/Requests';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import Client from '../Client';
 
@@ -11,7 +12,7 @@ class getSkyblockGarden extends Endpoint {
   }
 
   async execute(profileId: string, options?: RequestOptions): Promise<SkyblockGarden> {
-    if (!profileId) throw new Error(this.client.errors.NO_UUID);
+    if (!profileId) throw new Error(this.client.errors.NO_UUID, 'Fetching Skyblock Garden');
     const res = await this.client.requests.request(`/skyblock/garden?profile=${profileId}`, options);
     if (res.options.raw) return res.data;
     return new SkyblockGarden(res.data);

diff --git a/src/API/getSkyblockMember.ts b/src/API/getSkyblockMember.ts
@@ -1,5 +1,6 @@
 import SkyblockMember from '../structures/SkyBlock/SkyblockMember';
 import { SkyblockRequestOptions } from './API';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import Client from '../Client';
 
@@ -11,11 +12,13 @@ class getSkyblockMember extends Endpoint {
   }
 
   async execute(query: string, options?: SkyblockRequestOptions): Promise<Map<string, SkyblockMember>> {
-    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID);
+    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID, 'Fetching Skyblock Member');
     query = await this.client.requests.toUUID(query);
     const res = await this.client.requests.request(`/skyblock/profiles?uuid=${query}`, options);
     if (res.options.raw) return res.data;
-    if (!res.data.profiles || !res.data.profiles.length) throw new Error(this.client.errors.NO_SKYBLOCK_PROFILES);
+    if (!res.data.profiles || !res.data.profiles.length) {
+      throw new Error(this.client.errors.NO_SKYBLOCK_PROFILES, 'Fetching Skyblock Member');
+    }
     const memberByProfileName = new Map();
     for (const profile of res.data.profiles) {
       memberByProfileName.set(

diff --git a/src/API/getSkyblockMuseum.ts b/src/API/getSkyblockMuseum.ts
@@ -1,5 +1,6 @@
 import SkyblockMuseum from '../structures/SkyBlock/SkyblockMuseum';
 import { RequestOptions } from '../Private/Requests';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import Client from '../Client';
 
@@ -11,7 +12,7 @@ class getSkyblockMuseum extends Endpoint {
   }
 
   async execute(query: string, profileId: string, options?: RequestOptions): Promise<SkyblockMuseum> {
-    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID);
+    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID, 'Fetching Skyblock Museum');
     query = await this.client.requests.toUUID(query);
     const res = await this.client.requests.request(`/skyblock/museum?uuid=${query}&profile=${profileId}`, options);
     if (res.options.raw) return res.data;

diff --git a/src/API/getSkyblockProfiles.ts b/src/API/getSkyblockProfiles.ts
@@ -1,5 +1,6 @@
 import SkyblockProfile from '../structures/SkyBlock/SkyblockProfile';
 import { SkyblockRequestOptions } from './API';
+import Error from '../Private/ErrorHandler';
 import Endpoint from '../Private/Endpoint';
 import Client from '../Client';
 
@@ -11,11 +12,13 @@ class getSkyblockProfiles extends Endpoint {
   }
 
   async execute(query: string, options?: SkyblockRequestOptions): Promise<SkyblockProfile[]> {
-    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID);
+    if (!query) throw new Error(this.client.errors.NO_NICKNAME_UUID, 'Fetching Skyblock Profiles');
     query = await this.client.requests.toUUID(query);
     const res = await this.client.requests.request(`/skyblock/profiles?uuid=${query}`, options);
     if (res.options.raw) return res.data;
-    if (!res.data.profiles || !res.data.profiles.length) throw new Error(this.client.errors.NO_SKYBLOCK_PROFILES);
+    if (!res.data.profiles || !res.data.profiles.length) {
+      throw new Error(this.client.errors.NO_SKYBLOCK_PROFILES, 'Fetching Skyblock Profiles');
+    }
     const profiles = [];
     for (let i = 0; i < res.data.profiles.length; i++) {
       profiles.push({

diff --git a/src/Client.test.ts b/src/Client.test.ts
@@ -4,7 +4,7 @@ import { ClientOptions } from './typings/Client';
 import Requests from './Private/Requests';
 import Updater from './Private/Updater';
 import Client from './Client';
-import Errors from './Errors';
+import Errors from './Private/ErrorHandler';
 const errors = new Errors();
 
 test('Client (No Key)', () => {

diff --git a/src/Client.ts b/src/Client.ts
@@ -1,9 +1,9 @@
+import Error, { Errors } from './Private/ErrorHandler';
 import CacheHandler from './Private/CacheHandler';
 import { ClientOptions } from './typings/Client';
 import RateLimit from './Private/RateLimit';
 import Requests from './Private/Requests';
 import Updater from './Private/Updater';
-import Errors from './Errors';
 import API from './API';
 
 const clients: Client[] = [];
@@ -20,7 +20,7 @@ class Client {
   constructor(key: string, options?: ClientOptions) {
     this.key = key;
     this.errors = new Errors();
-    if (!this.key.length) throw new Error(this.errors.NO_API_KEY);
+    if (!this.key.length) throw new Error(this.errors.NO_API_KEY, 'Initializing Client');
     this.options = this.parasOptions(options);
     this.requests = new Requests(this);
     this.cacheHandler = new CacheHandler(this);

diff --git a/src/Errors.ts b/src/Errors.ts
diff --git a/src/Private/Endpoint.ts b/src/Private/Endpoint.ts
@@ -1,3 +1,4 @@
+import Error from '../Private/ErrorHandler';
 import Client from '../Client';
 
 class Endpoint {
@@ -7,7 +8,7 @@ class Endpoint {
   }
 
   execute(...args: any[]): Promise<any> | any {
-    throw new Error(this.client.errors.NOT_IMPLEMENTED);
+    throw new Error(this.client.errors.NOT_IMPLEMENTED, 'Unknown endpoint');
   }
 }