1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/**
* Fetch the clean Hypixel API
*/
import { CleanPlayer, cleanPlayerResponse } from './cleaners/player'
import { chooseApiKey, HypixelResponse, sendApiRequest } from './hypixelApi'
import * as cached from './hypixelCached'
import { CleanBasicMember, CleanMemberProfile } from './cleaners/skyblock/member'
import { cleanSkyblockProfileResponse, CleanProfile, CleanBasicProfile } from './cleaners/skyblock/profile'
import { cleanSkyblockProfilesResponse } from './cleaners/skyblock/profiles'
export type Included = 'profiles' | 'player' | 'stats' | 'inventories'
// the interval at which the "last_save" parameter updates in the hypixel api, this is 3 minutes
export const saveInterval = 60 * 3 * 1000
// the highest level a minion can be
export const maxMinion = 11
/**
* Send a request to api.hypixel.net using a random key, clean it up to be more useable, and return it
*/
export interface ApiOptions {
mainMemberUuid?: string
}
export async function sendCleanApiRequest({ path, args }, included?: Included[], options?: ApiOptions) {
const key = await chooseApiKey()
const rawResponse = await sendApiRequest({ path, key, args })
if (rawResponse.throttled) {
// if it's throttled, wait a second and try again
await new Promise(resolve => setTimeout(resolve, 1000))
return await sendCleanApiRequest({ path, args }, included, options)
}
// clean the response
return await cleanResponse({ path, data: rawResponse }, options ?? {})
}
async function cleanResponse({ path, data }: { path: string, data: HypixelResponse }, options: ApiOptions) {
// Cleans up an api response
switch (path) {
case 'player': return await cleanPlayerResponse(data.player)
case 'skyblock/profile': return await cleanSkyblockProfileResponse(data.profile, options)
case 'skyblock/profiles': return await cleanSkyblockProfilesResponse(data.profiles)
}
}
/* ----------------------------- */
export interface UserAny {
user?: string
uuid?: string
username?: string
}
export interface CleanUser {
player: CleanPlayer
profiles?: CleanProfile[]
activeProfile?: string
online?: boolean
}
/**
* Higher level function that requests the api for a user, and returns the cleaned response
* This is safe to fetch many times because the results are cached!
* @param included lets you choose what is returned, so there's less processing required on the backend
* used inclusions: player, profiles
*/
export async function fetchUser({ user, uuid, username }: UserAny, included: Included[]=['player']): Promise<CleanUser> {
if (!uuid) {
// If the uuid isn't provided, get it
uuid = await cached.uuidFromUser(user || username)
}
if (!uuid) {
// the user doesn't exist.
return null
}
const includePlayers = included.includes('player')
const includeProfiles = included.includes('profiles')
let profilesData: CleanProfile[]
let basicProfilesData: CleanBasicProfile[]
let playerData: CleanPlayer
if (includePlayers) {
playerData = await cached.fetchPlayer(uuid)
// if not including profiles, include lightweight profiles just in case
if (!includeProfiles)
basicProfilesData = playerData.profiles
playerData.profiles = undefined
}
if (includeProfiles) {
profilesData = await cached.fetchSkyblockProfiles(uuid)
}
let activeProfile: CleanProfile = null
let lastOnline: number = 0
if (includeProfiles) {
for (const profile of profilesData) {
const member = profile.members.find(member => member.uuid === uuid)
if (member.last_save > lastOnline) {
lastOnline = member.last_save
activeProfile = profile
}
}
}
return {
player: playerData ?? null,
profiles: profilesData ?? basicProfilesData,
activeProfile: includeProfiles ? activeProfile?.uuid : undefined,
online: includeProfiles ? lastOnline > (Date.now() - saveInterval): undefined
}
}
/**
* Fetch a CleanMemberProfile from a user and string
* This is safe to use many times as the results are cached!
* @param user A username or uuid
* @param profile A profile name or profile uuid
*/
export async function fetchMemberProfile(user: string, profile: string): Promise<CleanMemberProfile> {
const playerUuid = await cached.uuidFromUser(user)
const profileUuid = await cached.fetchProfileUuid(user, profile)
// if the profile doesn't have an id, just return
if (!profileUuid) return null
const player = await cached.fetchPlayer(playerUuid)
const cleanProfile = await cached.fetchProfile(playerUuid, profileUuid)
const member = cleanProfile.members.find(m => m.uuid === playerUuid)
// remove unnecessary member data
const simpleMembers: CleanBasicMember[] = cleanProfile.members.map(m => {
return {
uuid: m.uuid,
username: m.username,
first_join: m.first_join,
last_save: m.last_save,
rank: m.rank
}
})
cleanProfile.members = simpleMembers
return {
member: {
// the profile name is in member rather than profile since they sometimes differ for each member
profileName: cleanProfile.name,
// add all the member data
...member,
// add all other data relating to the hypixel player, such as username, rank, etc
...player
},
profile: cleanProfile
}
}
|
