/** * Fetch the clean Hypixel API */ import { cleanSkyblockProfileResponse, CleanProfile, CleanBasicProfile, CleanFullProfile, CleanFullProfileBasicMembers } from './cleaners/skyblock/profile' import { AccountCustomization, AccountSchema, fetchAccount, queueUpdateDatabaseMember, queueUpdateDatabaseProfile } from './database' import { CleanBasicMember, CleanMemberProfile } from './cleaners/skyblock/member' import { chooseApiKey, HypixelResponse, sendApiRequest } from './hypixelApi' import { cleanSkyblockProfilesResponse } from './cleaners/skyblock/profiles' import { CleanPlayer, cleanPlayerResponse } from './cleaners/player' import * as cached from './hypixelCached' import { debug } from '.' 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 /** Only get the most basic information, like uuids and names */ basic?: boolean } /** Sends an API request to Hypixel and cleans it up. */ export async function sendCleanApiRequest({ path, args }, included?: Included[], options?: ApiOptions): Promise { 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): Promise { // 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 customization?: AccountCustomization } /** * 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'], customization?: boolean): Promise { if (!uuid) { // If the uuid isn't provided, get it uuid = await cached.uuidFromUser(user || username) } const websiteAccountPromise = customization ? fetchAccount(uuid) : null if (!uuid) { // the user doesn't exist. if (debug) console.debug('error:', user, 'doesnt 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 if (playerData) delete playerData.profiles } 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 } } } let websiteAccount: AccountSchema = undefined if (websiteAccountPromise) { websiteAccount = await websiteAccountPromise } return { player: playerData ?? null, profiles: profilesData ?? basicProfilesData, activeProfile: includeProfiles ? activeProfile?.uuid : undefined, online: includeProfiles ? lastOnline > (Date.now() - saveInterval): undefined, customization: websiteAccount?.customization } } /** * 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 * @param customization Whether stuff like the user's custom background will be returned */ export async function fetchMemberProfile(user: string, profile: string, customization: boolean): Promise { const playerUuid = await cached.uuidFromUser(user) // we don't await the promise immediately so it can load while we do other stuff const websiteAccountPromise = customization ? fetchAccount(playerUuid) : null const profileUuid = await cached.fetchProfileUuid(user, profile) // if the profile or player doesn't have an id, just return if (!profileUuid) return null if (!playerUuid) return null const player = await cached.fetchPlayer(playerUuid) const cleanProfile = await cached.fetchProfile(playerUuid, profileUuid) as CleanFullProfileBasicMembers 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 let websiteAccount: AccountSchema = undefined if (websiteAccountPromise) websiteAccount = await websiteAccountPromise 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, customization: websiteAccount?.customization } } /** * Fetches the Hypixel API to get a CleanFullProfile. This doesn't do any caching and you should use hypixelCached.fetchProfile instead * @param playerUuid The UUID of the Minecraft player * @param profileUuid The UUID of the Hypixel SkyBlock profile */ export async function fetchMemberProfileUncached(playerUuid: string, profileUuid: string): Promise { const profile: CleanFullProfile = await sendCleanApiRequest( { path: 'skyblock/profile', args: { profile: profileUuid } }, null, { mainMemberUuid: playerUuid } ) // queue updating the leaderboard positions for the member, eventually for (const member of profile.members) queueUpdateDatabaseMember(member, profile) queueUpdateDatabaseProfile(profile) return profile } /** * Fetches the Hypixel API to get a CleanProfile from its id. This doesn't do any caching and you should use hypixelCached.fetchBasicProfileFromUuid instead * @param playerUuid The UUID of the Minecraft player * @param profileUuid The UUID of the Hypixel SkyBlock profile */ export async function fetchBasicProfileFromUuidUncached(profileUuid: string): Promise { const profile: CleanFullProfile = await sendCleanApiRequest( { path: 'skyblock/profile', args: { profile: profileUuid } }, null, { basic: true } ) return profile } export async function fetchMemberProfilesUncached(playerUuid: string): Promise { const profiles: CleanFullProfile[] = await sendCleanApiRequest({ path: 'skyblock/profiles', args: { uuid: playerUuid }}, null, { // only the inventories for the main player are generated, this is for optimization purposes mainMemberUuid: playerUuid } ) for (const profile of profiles) { for (const member of profile.members) { queueUpdateDatabaseMember(member, profile) } queueUpdateDatabaseProfile(profile) } return profiles }