add achievements and challenges

Author: mat-1

README.md

@@ -2,6 +2,40 @@
 
 A library to make requests to the Hypixel API, but with TypeScript to help you avoid mistakes. This library does not modify or process any data returned, that's up to you.
 
-I made this primarily for [skyblock-api](https://github.com/skyblockstats/skyblock-api), so information for other games may be limited. Feel free to contribute if you want these, though!
+I aim to cover the entire Hypixel API, and the tests automatically check our types with the Hypixel API every day so new fields can be added quickly.
 
-If you find missing/incorrect typings or JSDocs, please also contribute a fix.
+## Usage
+
+Make a request:
+```ts
+import hypixel from 'typed-hypixel-api'
+
+const res = await hypixel.request(
+	'player',
+	{
+		key: 'your-api-key',
+		uuid: '6536bfed869548fd83a1ecd24cf2a0fd'
+	}
+)
+
+if (res.data.success)
+	console.log(res.data.player.playername)
+```
+
+Typed wrapper function (for example to retry on errors or handle ratelimits):
+```ts
+export let sendApiRequest = async<P extends keyof hypixel.Requests>(path: P, options: hypixel.Requests[P]['options']): Promise<hypixel.Requests[P]['response']['data']> => {
+	let response: hypixel.Requests[P]['response']
+	try {
+		response = await hypixel.request(
+			path,
+			options
+		)
+	} catch (e) {
+		await sleep(1000)
+		return await sendApiRequest(path, options)
+	}
+
+	return response.data
+}
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-hypixel-api",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "main": "build/index.js",
   "types": "build/index.d.js",
   "repository": "https://github.com/skyblockstats/typed-hypixel-api.git",

src/index.ts

@@ -1,26 +1,31 @@
 import { fetch, Headers, RequestInit } from 'undici'
 export * from './responses/index'
 import {
+    // errors
     InvalidApiKeyResponse,
     MalformedUuidResponse,
     MissingFieldResponse,
     ThrottleResponse,
 
-    ApiKeyInformationResponse,
-    FriendsResponse,
-    OnlineStatusResponse,
-    PlayerDataResponse,
-    RecentGamesResponse,
-    GuildResponse,
-
+    // resources
     SkyBlockCollectionsResponse,
     SkyBlockElectionResponse,
+    SkyBlockSkillsResponse,
     SkyBlockItemsResponse,
-    SkyBlockProfileResponse,
+    AchievementsResponse,
+    ChallengesResponse,
+
+    // everything else
+    ApiKeyInformationResponse,
+    GamesInformationResponse,
     SkyBlockProfilesResponse,
-    SkyBlockSkillsResponse,
+    SkyBlockProfileResponse,
     RankedSkywarsResponse,
-    GamesInformationResponse,
+    OnlineStatusResponse,
+    RecentGamesResponse,
+    PlayerDataResponse,
+    FriendsResponse,
+    GuildResponse,
 } from './responses/index'
 
 
@@ -71,6 +76,14 @@ export interface Requests {
         options: {}
         response: Response<GamesInformationResponse>
     }
+    'resources/achievements': {
+        options: {}
+        response: Response<AchievementsResponse>
+    }
+    'resources/challenges': {
+        options: {}
+        response: Response<ChallengesResponse>
+    }
     'skyblock/profiles': {
         options: {
             uuid: string
@@ -189,3 +202,4 @@ export const request = async<P extends keyof Requests>(path: P, options: Request
         headers: headers as any
     }
 }
+

src/responses/index.ts

@@ -2,6 +2,8 @@ export * from './resources/skyblock/collections'
 export * from './resources/skyblock/election'
 export * from './resources/skyblock/skills'
 export * from './resources/skyblock/items'
+export * from './resources/achievements'
+export * from './resources/challenges'
 export * from './resources/games'
 
 export * from './skyblock/_profile_member'

src/responses/resources/achievements.ts

@@ -0,0 +1,14 @@
+export interface AchievementsResponse {
+	success: true
+	lastUpdated: number
+	challenges: {
+		[key: string]: {
+			id: string
+			name: string
+			rewards: {
+				type: 'MultipliedExperienceReward'
+				amount: number
+			}[]
+		}
+	}
+}

src/responses/resources/challenges.ts

@@ -0,0 +1,42 @@
+export interface ChallengesResponse {
+	success: true
+	lastUpdated: number
+	/**
+	 * The list of all Hypixel achievements. The keys are lowercase game/category IDs, for example `christmas2017`, `gingerbread`, `skyblock`.
+	 */
+	achievements: {
+		/** The lowercase database names, for example `christmas2017`, `gingerbread`, `skyblock`. */
+		[key: string]: {
+			/** Achievements that can only be unlocked once. */
+			one_time: {
+				[key: string]: {
+					points: number
+					/** The name of the achievement. */
+					name: string
+					/** The description of the achievement. */
+					description: string
+					/** The percentage of people who've played the game who have unlocked the achievement. This is a decimal between 0 and 100. */
+					gamePercentUnlocked: number
+					/** The percentage of people who've unlocked the achievement. This is a decimal between 0 and 100. */
+					globalPercentUnlocked: number
+				}
+			}
+			/** Achievements that have different tiers to them. */
+			tiered: {
+				[key: string]: {
+					/** The name of the achievement. */
+					name: string
+					/** The description of the achievement. */
+					description: string
+					tiers: {
+						tier: number
+						points: number
+						amount: number
+					}[]
+				}
+			}
+			total_points: number
+			total_legacy_points: number
+		}
+	}
+}

test/index.js

@@ -27,10 +27,10 @@ async function testData(typeName, data) {
 		console.error(err.stdout)
 		throw new Error(err)
 	}
-	console.log('Passed', typeName)
+	console.log('\x1b[32m%s\x1b[0m', '✓', 'Passed', typeName)
 }
 
-console.log('ok doing tsc');
+console.log('Running tests. This will take a few moments, be patient!');
 
 (async () => {
 	await exec('cd test')
@@ -69,6 +69,8 @@ console.log('ok doing tsc');
 	}, true))
 
 	await testData('GamesInformationResponse', await request('resources/games', {}, true))
+	await testData('ChallengesResponse', await request('resources/challenges', {}, true))
+	await testData('AchievementsResponse', await request('resources/achievements', {}, true))
 
-	console.log('Everything passed :)')
+	console.log('\x1b[32m%s\x1b[0m', '✓ Everything passed.', 'Good job! :)')
 })()