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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12x 12x 12x 12x 12x 12x 12x 12x 12x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12x 12x 12x 12x 12x 12x 12x 12x 12x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 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 1x 1x 1x 12x | import { HoyoAPIError } from '../../../error'
import { LanguageEnum } from '../../../language'
import { HTTPRequest } from '../../../request'
import {
HSR_RECORD_CHARACTER_API,
HSR_RECORD_FORGOTTEN_HALL_API,
HSR_RECORD_INDEX_API,
HSR_RECORD_NOTE_API,
} from '../../../routes'
import {
IHSRCharacterFull,
IHSRForgottenHall,
IHSRNote,
IHSRRecord,
} from './interfaces'
import { ForgottenHallScheduleEnum } from './record.enum'
/**
* HSRRecordModule class provides methods to interact with Honkai Star Rail record module endpoints.
*
* @class
* @internal
* @category Module
*/
export class HSRRecordModule {
/**
* Creates an instance of HSRRecordModule.
*
* @param request The HTTPRequest object used for making API requests.
* @param lang The language enum value.
* @param region The region string or null if not provided.
* @param uid The UID number or null if not provided.
*/
constructor(
private request: HTTPRequest,
private lang: LanguageEnum,
private region: string | null,
private uid: number | null,
) {}
/**
* Retrieves the characters associated with the provided region and UID.
*
* @returns {Promise<IHSRCharacterFull[]>} A Promise that resolves to an array of full HSR characters.
* @throws {HoyoAPIError} if the region or UID parameters are missing or failed to be filled.
* @throws {HoyoAPIError} if failed to retrieve data, please double-check the provided UID.
*/
async characters(): Promise<IHSRCharacterFull[]> {
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,
body,
params,
headers,
} = await this.request.send(HSR_RECORD_CHARACTER_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,
},
},
)
}
const data = res.data as any
return data.avatar_list as IHSRCharacterFull[]
}
/**
* Retrieves the records associated with the provided region and UID.
*
* @returns {Promise<IHSRRecord>} A Promise that resolves to the HSR record object.
* @throws {HoyoAPIError} if the region or UID parameters are missing or failed to be filled.
* @throws {HoyoAPIError} if failed to retrieve data, please double-check the provided UID.
*/
async records(): Promise<IHSRRecord> {
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,
body,
params,
headers,
} = await this.request.send(HSR_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 IHSRRecord
}
/**
* Retrieves the note associated with the provided region and UID.
*
* @returns {Promise<IHSRNote>} A Promise that resolves to the HSR note object.
* @throws {HoyoAPIError} if the region or UID parameters are missing or failed to be filled.
* @throws {HoyoAPIError} if failed to retrieve data, please double-check the provided UID.
*/
async note(): Promise<IHSRNote> {
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,
body,
params,
headers,
} = await this.request.send(HSR_RECORD_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 IHSRNote
}
/**
* Retrieves the forgotten hall information associated with the provided region and UID.
*
* @param scheduleType The schedule type for the forgotten hall (optional, defaults to CURRENT).
* @returns {Promise<IHSRForgottenHall>} A Promise that resolves to the forgotten hall information object.
* @throws {HoyoAPIError} if the region or UID parameters are missing or failed to be filled.
* @throws {HoyoAPIError} if the given scheduleType parameter is invalid.
* @throws {HoyoAPIError} if failed to retrieve data, please double-check the provided UID.
*/
async forgottenHall(
scheduleType: ForgottenHallScheduleEnum = ForgottenHallScheduleEnum.CURRENT,
): Promise<IHSRForgottenHall> {
if (!this.region || !this.uid) {
throw new HoyoAPIError('UID parameter is missing or failed to be filled')
}
if (
Object.values(ForgottenHallScheduleEnum).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,
lang: this.lang,
need_all: 'true',
})
.setDs()
const {
response: res,
body,
params,
headers,
} = await this.request.send(HSR_RECORD_FORGOTTEN_HALL_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 IHSRForgottenHall
}
}
|