Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 3x 3x 3x 1x 1x 2x 2x 2x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 1x 1x 1x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 38x | import { HoyoAPIError } from '../../../error'
import { LanguageEnum } from '../../../language'
import { HTTPRequest } from '../../../request'
import {
GENSHIN_RECORD_AVATAR_BASIC_INFO_API,
GENSHIN_RECORD_CHARACTER_API,
GENSHIN_RECORD_DAILY_NOTE_API,
GENSHIN_RECORD_INDEX_API,
GENSHIN_RECORD_SPIRAL_ABYSS_API,
} from '../../../routes'
import {
IGenshinCharacterSummary,
IGenshinCharacters,
IGenshinDailyNote,
IGenshinRecord,
IGenshinSpiralAbyss,
} from './interfaces'
import { SpiralAbyssScheduleEnum } from './record.enum'
/**
* GenshinRecordModule class provides methods to interact with Genshin Impact's record module endpoints.
*
* @class
* @internal
* @category Module
*/
export class GenshinRecordModule {
/**
* Creates an instance of GenshinRecordModule.
*
* @constructor
* @param {HTTPRequest} request - An instance of Request class.
* @param {LanguageEnum} lang - The language code to be used in requests.
* @param {string | null} region - The server region code in which the user's account resides.
* @param {number | null} uid - The user ID of the Genshin Impact account.
*/
constructor(
private request: HTTPRequest,
private lang: LanguageEnum,
private region: string | null,
private uid: number | null,
) {}
/**
* Get user's Genshin Impact record
*
* @async
* @function
* @returns {Promise<IGenshinRecord>} - User's Genshin Impact record
* @throws {HoyoAPIError} If UID parameter is missing or failed to be filled
* @remarks
* This method sends a request to the Genshin Impact API to get the daily note information for a user.
* The user's region and UID must be set before calling this method, otherwise an error will be thrown.
*/
async records(): Promise<IGenshinRecord> {
if (!this.region || !this.uid) {
throw new HoyoAPIError('UID parameter is missing or failed to be filled')
}
this.request
.setQueryParams({
server: this.region,
role_id: this.uid,
lang: this.lang,
})
.setDs(true)
const {
response: res,
headers,
body,
params,
} = await this.request.send(GENSHIN_RECORD_INDEX_API)
if (res.retcode !== 0) {
throw new HoyoAPIError(
res.message ??
'Failed to retrieve data, please double-check the provided UID.',
res.retcode,
{
response: res,
request: {
body,
headers,
params,
},
},
)
}
return res.data as IGenshinRecord
}
/**
*
* Retrieves the Genshin characters of the user.
*
* @async
* @returns {Promise<IGenshinCharacters>} A Promise that contains the Genshin characters object.
* @throws {HoyoAPIError} If UID parameter is missing or failed to be filled.
* @remarks
* This method sends a request to the Genshin Impact API to get the daily note information for a user.
* The user's region and UID must be set before calling this method, otherwise an error will be thrown.
*/
async characters(): Promise<IGenshinCharacters> {
if (!this.region || !this.uid) {
throw new HoyoAPIError('UID parameter is missing or failed to be filled')
}
this.request
.setBody({
server: this.region,
role_id: this.uid,
})
.setDs(true)
const {
response: res,
headers,
body,
params,
} = await this.request.send(GENSHIN_RECORD_CHARACTER_API, 'POST')
if (res.retcode !== 0) {
throw new HoyoAPIError(
res.message ??
'Failed to retrieve data, please double-check the provided UID.',
res.retcode,
{
response: res,
request: {
body,
headers,
params,
},
},
)
}
return res.data as IGenshinCharacters
}
/**
* Returns the summary information of Genshin Impact game characters.
*
* @param characterIds - An array of character IDs to retrieve the summary information for.
* @returns {Promise<IGenshinCharacterSummary>} A Promise that resolves to an object containing the summary information of the characters.
* @throws Throws an error if the UID parameter is missing or failed to be filled.
* @remarks
* This method sends a request to the Genshin Impact API to get the daily note information for a user.
* The user's region and UID must be set before calling this method, otherwise an error will be thrown.
*/
async charactersSummary(
characterIds: number[],
): Promise<IGenshinCharacterSummary> {
if (!this.region || !this.uid) {
throw new HoyoAPIError('UID parameter is missing or failed to be filled')
}
this.request
.setBody({
character_ids: characterIds,
role_id: this.uid,
server: this.region,
})
.setDs()
const {
response: res,
headers,
body,
params,
} = await this.request.send(GENSHIN_RECORD_AVATAR_BASIC_INFO_API, 'POST')
if (res.retcode !== 0) {
throw new HoyoAPIError(
res.message ??
'Failed to retrieve data, please double-check the provided UID.',
res.retcode,
{
response: res,
request: {
body,
headers,
params,
},
},
)
}
return res.data as IGenshinCharacterSummary
}
/**
* Retrieves information about the player's performance in the Spiral Abyss.
*
* @param scheduleType - The schedule type of the Abyss, either CURRENT or PREVIOUS.
* @returns A Promise that resolves with an object containing the player's Spiral Abyss data.
* @throws {HoyoAPIError} if UID parameter is missing or failed to be filled, or if the given scheduleType parameter is invalid.
* @remarks
* This method sends a request to the Genshin Impact API to get the daily note information for a user.
* The user's region and UID must be set before calling this method, otherwise an error will be thrown.
*/
async spiralAbyss(
scheduleType: SpiralAbyssScheduleEnum = SpiralAbyssScheduleEnum.CURRENT,
): Promise<IGenshinSpiralAbyss> {
if (!this.region || !this.uid) {
throw new HoyoAPIError('UID parameter is missing or failed to be filled')
}
if (
Object.values(SpiralAbyssScheduleEnum).includes(scheduleType) === false
) {
throw new HoyoAPIError('The given scheduleType parameter is invalid !')
}
this.request
.setQueryParams({
server: this.region,
role_id: this.uid,
schedule_type: scheduleType,
})
.setDs()
const {
response: res,
headers,
body,
params,
} = await this.request.send(GENSHIN_RECORD_SPIRAL_ABYSS_API)
if (res.retcode !== 0) {
throw new HoyoAPIError(
res.message ??
'Failed to retrieve data, please double-check the provided UID.',
res.retcode,
{
response: res,
request: {
body,
headers,
params,
},
},
)
}
return res.data as IGenshinSpiralAbyss
}
/**
* Retrieve the daily note information for a Genshin Impact user.
* @returns {Promise<IGenshinDailyNote>} The daily note information.
* @throws {HoyoAPIError} if the UID parameter is missing or failed to be filled.
* @remarks
* This method sends a request to the Genshin Impact API to get the daily note information for a user.
* The user's region and UID must be set before calling this method, otherwise an error will be thrown.
*/
async dailyNote(): Promise<IGenshinDailyNote> {
if (!this.region || !this.uid) {
throw new HoyoAPIError('UID parameter is missing or failed to be filled')
}
this.request
.setQueryParams({
server: this.region,
role_id: this.uid,
})
.setDs()
const {
response: res,
headers,
body,
params,
} = await this.request.send(GENSHIN_RECORD_DAILY_NOTE_API)
if (res.retcode !== 0) {
throw new HoyoAPIError(
res.message ??
'Failed to retrieve data, please double-check the provided UID.',
res.retcode,
{
response: res,
request: {
body,
headers,
params,
},
},
)
}
return res.data as IGenshinDailyNote
}
}
|