API Return Types

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = crlf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = false

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+ "recommendations": [
+ "editorconfig.editorconfig",
+ "dbaeumer.vscode-eslint",
+ "esbenp.prettier-vscode",
+ "eamodio.gitlens",
+ "aaron-bond.better-comments"
+ ]
+}

src/API/getAchievements.ts

@@ -9,7 +9,7 @@ export default class getAchievements extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<Achievements> {
  const res = await this.client.requests.request('/resources/achievements');
  if (res.raw) return res;
  return new Achievements(res);

src/API/getActiveHouses.ts

@@ -9,7 +9,7 @@ export default class getActiveHouses extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<House[]> {
  const res = await this.client.requests.request('/housing/active');
  if (res.raw) return res;
  return res.length ? res.map((b: any) => new House(b)) : [];

src/API/getBoosters.ts

@@ -9,7 +9,7 @@ export default class getBoosters extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<Booster[]> {
  const res = await this.client.requests.request('/boosters');
  if (res.raw) return res;
  return res.boosters.length ? res.boosters.map((b: any) => new Booster(b)).reverse() : [];

src/API/getChallenges.ts

@@ -9,7 +9,7 @@ export default class getChallenges extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<Challenges> {
  const res = await this.client.requests.request('/resources/challenges');
  if (res.raw) return res;
  return new Challenges(res);

src/API/getGameCounts.ts

@@ -9,7 +9,7 @@ export default class getGameCounts extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<GameCounts> {
  const res = await this.client.requests.request('/counts');
  if (res.raw) return res;
  return new GameCounts(res);

src/API/getGuild.ts

@@ -12,7 +12,7 @@ export default class getGuild extends Endpoint {
  this.client = client;
  }
 
- async execute(searchParameter: 'id' | 'name' | 'player', query: string) {
+ async execute(searchParameter: 'id' | 'name' | 'player', query: string): Promise<Guild | null> {
  if (!query) throw new Error(Errors.NO_GUILD_QUERY);
  if ('id' === searchParameter && !isGuildID(query)) throw new Error(Errors.INVALID_GUILD_ID);
  const isPlayerQuery = 'player' === searchParameter;

src/API/getGuildAchievements.ts

@@ -9,7 +9,7 @@ export default class getGuildAchievements extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<GuildAchievements> {
  const res = await this.client.requests.request('/resources/guilds/achievements');
  if (res.raw) return res;
  return new GuildAchievements(res);

src/API/getHouse.ts

@@ -10,7 +10,7 @@ export default class getHouse extends Endpoint {
  this.client = client;
  }
 
- async execute(query: string) {
+ async execute(query: string): Promise<House> {
  if (!query) throw new Error(Errors.NO_UUID);
  const res = await this.client.requests.request(`/housing/house?house=${query}`);
  if (res.raw) return res;

src/API/getLeaderboards.ts

@@ -11,7 +11,7 @@ export default class getLeaderboards extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<any> {
  const res = await this.client.requests.request('/leaderboards');
  if (res.raw) return res;
  if (!res.leaderboards) throw new Error(Errors.SOMETHING_WENT_WRONG.replace(/{cause}/, 'Try again.'));

src/API/getPlayer.ts

@@ -11,7 +11,7 @@ export default class getPlayer extends Endpoint {
  this.client = client;
  }
 
- async execute(query: string) {
+ async execute(query: string): Promise<Player> {
  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
  query = await toUuid(query);
  const res = await this.client.requests.request(`/player?uuid=${query}`);

src/API/getPlayerHouses.ts

@@ -11,7 +11,7 @@ export default class getPlayerHouses extends Endpoint {
  this.client = client;
  }
 
- async execute(query: string): Promise<House[] | { raw: any }> {
+ async execute(query: string): Promise<House[]> {
  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
  query = await toUuid(query);
  const res = await this.client.requests.request(`/housing/houses?player=${query}`);

src/API/getQuests.ts

@@ -9,7 +9,7 @@ export default class getQuests extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<Quests> {
  const res = await this.client.requests.request('/resources/quests');
  if (res.raw) return res;
  return new Quests(res);

src/API/getRecentGames.ts

@@ -11,7 +11,7 @@ export default class getRecentGames extends Endpoint {
  this.client = client;
  }
 
- async execute(query: string) {
+ async execute(query: string): Promise<RecentGame[]> {
  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
  query = await toUuid(query);
  const res = await this.client.requests.request(`/recentgames?uuid=${query}`);

src/API/getSkyblockAuction.ts

@@ -11,7 +11,11 @@ export default class getSkyblockAction extends Endpoint {
  this.client = client;
  }
 
- async execute(query: string, type: 'PROFILE' | 'PLAYER' | 'AUCTION', includeItemBytes: boolean = false) {
+ async execute(
+ query: string,
+ type: 'PROFILE' | 'PLAYER' | 'AUCTION',
+ includeItemBytes: boolean = false
+ ): Promise<Auction[]> {
  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
  let filter;
  if ('PROFILE' === type) {

src/API/getSkyblockAuctionsByPlayer.ts

@@ -11,7 +11,7 @@ export default class getSkyblockActionsByPlayer extends Endpoint {
  this.client = client;
  }
 
- async execute(query: string, includeItemBytes: boolean) {
+ async execute(query: string, includeItemBytes: boolean): Promise<Auction[]> {
  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
  query = await toUuid(query);
  const res = await this.client.requests.request(`/skyblock/auction?player=${query}`);

src/API/getSkyblockBazaar.ts

@@ -9,7 +9,7 @@ export default class getSkyblockBazaar extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<Product[]> {
  const res = await this.client.requests.request('/skyblock/bazaar');
  if (res.raw) return res;
  const productsKeys = Object.keys(res.products);

src/API/getSkyblockBingo.ts

@@ -9,7 +9,7 @@ export default class getSkyblockBingo extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<BingoData> {
  const res = await this.client.requests.request('/resources/skyblock/bingo');
  if (res.raw) return res;
  return new BingoData(res);

src/API/getSkyblockBingoByPlayer.ts

@@ -11,7 +11,7 @@ export default class getBingoByPlayer extends Endpoint {
  this.client = client;
  }
 
- async execute(query: string) {
+ async execute(query: string): Promise<PlayerBingo> {
  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
  query = await toUuid(query);
  const res = await this.client.requests.request(`/skyblock/uuid?player=${query}`);

src/API/getSkyblockEndedAuctions.ts

@@ -10,7 +10,7 @@ export default class getSkyblockEndedAuctions extends Endpoint {
  this.client = client;
  }
 
- async execute(includeItemBytes: any): Promise<any> {
+ async execute(includeItemBytes: any): Promise<{ info: AuctionInfo; auctions: PartialAuction[] }> {
  const res = await this.client.requests.request('/skyblock/auctions_ended');
  if (res.raw) return res;
  return {

src/API/getSkyblockFireSales.ts

@@ -9,7 +9,7 @@ export default class getSkyblockFireSales extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<FireSale[]> {
  const res = await this.client.requests.request('/skyblock/firesales');
  if (res.raw) return res;
  return res.sales.length ? res.sales.map((a: any) => new FireSale(a)) : [];

src/API/getSkyblockGarden.ts

@@ -9,7 +9,7 @@ export default class getSkyblockGarden extends Endpoint {
  this.client = client;
  }
 
- async execute(profileId: string) {
+ async execute(profileId: string): Promise<SkyblockGarden> {
  const res = await this.client.requests.request(`/skyblock/garden?profile=${profileId}`);
  if (res.raw) return res;
  return new SkyblockGarden(res);

src/API/getSkyblockGovernment.ts

@@ -9,7 +9,7 @@ export default class getSkyblockGovernment extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<GovernmentData> {
  const res = await this.client.requests.request('/resources/skyblock/election');
  if (res.raw) return res;
  return new GovernmentData(res);

src/API/getSkyblockMember.ts

@@ -11,7 +11,7 @@ export default class getSkyblockMember extends Endpoint {
  this.client = client;
  }
 
- async execute(query: string) {
+ async execute(query: string): Promise<Map<string, SkyblockMember>> {
  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
  query = await toUuid(query);
  const res = await this.client.requests.request(`/skyblock/profiles?uuid=${query}`);

src/API/getSkyblockMuseum.ts

@@ -11,7 +11,7 @@ export default class getSkyblockMuseum extends Endpoint {
  this.client = client;
  }
 
- async execute(query: string, profileId: string) {
+ async execute(query: string, profileId: string): Promise<SkyblockMuseum> {
  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
  query = await toUuid(query);
  const res = await this.client.requests.request(`/skyblock/museum?uuid=${query}&profile=${profileId}`);

src/API/getSkyblockNews.ts

@@ -9,7 +9,7 @@ export default class getSkyblockNews extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<SkyblockNews[]> {
  const res = await this.client.requests.request('/skyblock/news');
  if (res.raw) return res;
  return res.items.map((i: any) => new SkyblockNews(i));

src/API/getSkyblockProfiles.ts

@@ -10,7 +10,7 @@ export default class getSkyblockProfiles extends Endpoint {
  this.client = client;
  }
 
- async execute(query: string) {
+ async execute(query: string): Promise<SkyblockProfile[]> {
  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
  query = await toUuid(query);
  const res = await this.client.requests.request(`/skyblock/profiles?uuid=${query}`);

src/API/getWatchdogStats.ts

@@ -9,7 +9,7 @@ export default class getWatchdogStatsEndpoint extends Endpoint {
  this.client = client;
  }
 
- async execute() {
+ async execute(): Promise<WatchdogStats> {
  const res = await this.client.requests.request('/punishmentstats');
  if (res.raw) return res;
  return new WatchdogStats(res);

src/Client.ts

@@ -20,7 +20,6 @@ class Client {
  declare rateLimit?: 'AUTO' | 'HARD' | 'NONE';
  declare silent: boolean;
  declare checkForUpdates: boolean;
- declare endpoints: any;
 
  constructor(key: string, options?: ClientOptions) {
  this.key = key;
@@ -37,7 +36,11 @@ class Client {
  this.cacheHandler = new CacheHandler(this);
 
  for (const func in API) {
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+ // @ts-expect-error
  const endpoint = new API[func](this);
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+ // @ts-expect-error
  this[func] = endpoint.execute.bind(endpoint);
  }