aboutsummaryrefslogtreecommitdiff
path: root/src/cleaners/skyblock/member.ts
blob: 9d68796a8e29d5dac35cc692fb4c4df0c9a09e00 (plain)
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
import { AccessoryBagUpgrades, cleanAccessoryBagUpgrades } from './accessoryBagUpgrades.js'
import { cleanExperimentation, Experimentation } from './experimentation.js'
import { cleanFarmingContests, FarmingContests } from './farmingContents.js'
import { cleanCoopInvitation, CoopInvitation } from './coopInvitation.js'
import { cleanCollections, Collection } from './collections.js'
import { cleanInventories, Inventories } from './inventory.js'
import { cleanFairySouls, FairySouls } from './fairysouls.js'
import { cleanObjectives, Objective } from './objectives.js'
import { CleanFullProfileBasicMembers } from './profile.js'
import { cleanProfileStats, StatItem } from './stats.js'
import { CleanMinion, cleanMinions } from './minions.js'
import { cleanSlayers, SlayerData } from './slayers.js'
import { AccountCustomization } from '../../database.js'
import { cleanEssence, Essence } from './essence.js'
import { cleanVisitedZones, Zone } from './zones.js'
import { cleanSkills, Skills } from './skills.js'
import * as cached from '../../hypixelCached.js'
import typedHypixelApi from 'typed-hypixel-api'
import { cleanPets, PetsData } from './pets.js'
import { cleanHarp, HarpData } from './harp.js'
import * as constants from '../../constants.js'
import { Included } from '../../hypixel.js'
import { CleanPlayer } from '../player.js'
import { CleanRank } from '../rank.js'

export interface CleanBasicMember {
	uuid: string
	username: string
	lastSave: number | null
	firstJoin: number | null
	rank: CleanRank
	left?: boolean
}

interface ExtraCleanMemberFields {
	purse: number
	stats: StatItem[]
	rawHypixelStats: { [key: string]: number }
	minions: CleanMinion[]
	fairySouls: FairySouls
	inventories?: Inventories
	objectives: Objective[]
	skills: Skills
	zones: Zone[]
	collections: Collection[]
	slayers: SlayerData
	pets: PetsData
	harp: HarpData
	coopInvitation: CoopInvitation | null
	farmingContests: FarmingContests
	accessoryBagUpgrades: AccessoryBagUpgrades
	experimentation: Experimentation
	/** Whether the user left the coop */
	essence: Essence
	/** Whether the member left the coop. */
	left: boolean
}

export type CleanMember = CleanBasicMember & ExtraCleanMemberFields

export async function cleanSkyBlockProfileMemberResponseBasic(member: typedHypixelApi.SkyBlockProfileMember & { uuid: string }): Promise<CleanBasicMember | null> {
	const player = await cached.fetchPlayer(member.uuid, false)
	if (!player) return null
	return {
		uuid: member.uuid,
		username: player.username,
		lastSave: member.last_save ?? null,
		firstJoin: member.first_join ?? null,
		rank: player.rank
	}
}

/** Cleans up a member (from skyblock/profile) */
export async function cleanSkyBlockProfileMemberResponse(member: typedHypixelApi.SkyBlockProfileMember & { uuid: string }, profileId?: string, included: Included[] | undefined = undefined): Promise<CleanMember | null> {
	const inventoriesIncluded = included === undefined || included.includes('inventories')
	const player = await cached.fetchPlayer(member.uuid, true)
	if (!player) return null

	const fairySouls = await cleanFairySouls(member)

	const { max_fairy_souls: maxFairySouls } = await constants.fetchConstantValues()
	if (fairySouls.total > (maxFairySouls ?? 0))
		await constants.setConstantValues({ max_fairy_souls: fairySouls.total })

	const coopInvitationPromise = cleanCoopInvitation(member, member.uuid)
	const minionsPromise = cleanMinions(member)
	const skillsPromise = cleanSkills(member, player)
	const zonesPromise = cleanVisitedZones(member)
	const petsPromise = cleanPets(member)
	const harpPromise = cleanHarp(member)
	const inventoriesPromise = inventoriesIncluded ? cleanInventories(member) : Promise.resolve(undefined)
	const farmingContestsPromise = cleanFarmingContests(member)
	const experimentationTablePromise = cleanExperimentation(member)

	return {
		uuid: member.uuid,
		username: player.username,
		// members that haven't joined the profile have no last save or first join
		lastSave: member.last_save ?? null,
		firstJoin: member.first_join ?? null,
		rank: player.rank,

		purse: member.coin_purse ?? 0,

		stats: cleanProfileStats(member),

		// this is used for leaderboards
		rawHypixelStats: member.stats ?? {},

		minions: await minionsPromise,
		fairySouls: fairySouls,
		inventories: inventoriesPromise ? await inventoriesPromise : undefined,
		objectives: cleanObjectives(member),

		skills: await skillsPromise,

		zones: await zonesPromise,
		collections: cleanCollections(member),
		slayers: cleanSlayers(member),
		pets: await petsPromise,
		harp: await harpPromise,
		coopInvitation: await coopInvitationPromise,
		farmingContests: await farmingContestsPromise,
		accessoryBagUpgrades: cleanAccessoryBagUpgrades(member),
		experimentation: await experimentationTablePromise,
		essence: cleanEssence(member),

		left: (player.profiles?.find(profile => profile.uuid === profileId) === undefined) ?? false
	}
}


export type CleanMemberProfilePlayer = CleanPlayer & {
	// The profile name may be different for each player, so we put it here
	profileName: string
	firstJoin: number | null
	lastSave: number | null
} & ExtraCleanMemberFields

export interface CleanMemberProfile {
	member: CleanMemberProfilePlayer
	profile: CleanFullProfileBasicMembers
	customization?: AccountCustomization
}