mirror of
https://github.com/maxswa/osrs-json-hiscores.git
synced 2025-10-15 10:19:04 +00:00
Compare commits
1 Commits
v2.15.0
...
add-guardi
| Author | SHA1 | Date | |
|---|---|---|---|
|
e77737f422 |
12
.github/workflows/main.yml
vendored
12
.github/workflows/main.yml
vendored
@@ -10,19 +10,19 @@ jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3.3.0
|
||||
- uses: borales/actions-yarn@v4.2.0
|
||||
- uses: actions/checkout@v2
|
||||
- uses: borales/actions-yarn@v2.0.0
|
||||
with:
|
||||
cmd: install
|
||||
- uses: borales/actions-yarn@v4.2.0
|
||||
- uses: borales/actions-yarn@v2.0.0
|
||||
with:
|
||||
cmd: lint
|
||||
- uses: borales/actions-yarn@v4.2.0
|
||||
- uses: borales/actions-yarn@v2.0.0
|
||||
with:
|
||||
cmd: format
|
||||
- uses: borales/actions-yarn@v4.2.0
|
||||
- uses: borales/actions-yarn@v2.0.0
|
||||
with:
|
||||
cmd: build
|
||||
- uses: borales/actions-yarn@v4.2.0
|
||||
- uses: borales/actions-yarn@v2.0.0
|
||||
with:
|
||||
cmd: test
|
||||
|
||||
30
README.md
30
README.md
@@ -3,7 +3,7 @@
|
||||
[](https://www.npmjs.com/package/osrs-json-hiscores)
|
||||
[](https://npm-stat.com/charts.html?package=osrs-json-hiscores)
|
||||
[](https://github.com/maxswa/osrs-json-hiscores/blob/master/src/types.ts)
|
||||
[](https://github.com/maxswa/osrs-json-hiscores/actions/workflows/main.yml?query=branch%3Amain)
|
||||
[](https://github.com/maxswa/osrs-json-hiscores/actions/workflows/main.yml?query=branch%3Amain)
|
||||
|
||||
**The Old School Runescape API wrapper that does more!**
|
||||
|
||||
@@ -104,16 +104,13 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
|
||||
|
||||
### Minigames
|
||||
|
||||
| Minigame | Param |
|
||||
| ------------------------------- | :---------------: |
|
||||
| Bounty Hunter (Legacy - Rogue) | `rogueBH` |
|
||||
| Bounty Hunter (Legacy - Hunter) | `hunterBH` |
|
||||
| Bounty Hunter (Rogue) | `rogueBHV2` |
|
||||
| Bounty Hunter (Hunter) | `hunterBHV2` |
|
||||
| Last Man Standing | `lastManStanding` |
|
||||
| PvP Arena | `pvpArena` |
|
||||
| Soul Wars Zeal | `soulWarsZeal` |
|
||||
| Rifts Closed | `riftsClosed` |
|
||||
| Minigame | Param |
|
||||
| ---------------------- | :---------------: |
|
||||
| Bounty Hunter (Rogue) | `rogueBH` |
|
||||
| Bounty Hunter (Hunter) | `hunterBH` |
|
||||
| Last Man Standing | `lastManStanding` |
|
||||
| Soul Wars Zeal | `soulWarsZeal` |
|
||||
| Rifts Closed | `riftsClosed` |
|
||||
|
||||
### Leagues
|
||||
|
||||
@@ -127,11 +124,9 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
|
||||
| --------------------------------- | :----------------------------: |
|
||||
| Abyssal Sire | `abyssalSire` |
|
||||
| Alchemical Hydra | `alchemicalHydra` |
|
||||
| Artio | `artio` |
|
||||
| Barrows Chests | `barrows` |
|
||||
| Bryophyta | `bryophyta` |
|
||||
| Callisto | `callisto` |
|
||||
| Calvar'ion | `calvarion` |
|
||||
| Cerberus | `cerberus` |
|
||||
| Chambers Of Xeric | `chambersOfXeric` |
|
||||
| Chambers Of Xeric: Challenge Mode | `chambersOfXericChallengeMode` |
|
||||
@@ -144,7 +139,6 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
|
||||
| Dagannoth Rex | `dagannothRex` |
|
||||
| Dagannoth Supreme | `dagannothSupreme` |
|
||||
| Deranged Archaeologist | `derangedArchaeologist` |
|
||||
| Duke Sucellus | `dukeSucellus` |
|
||||
| General Graardor | `generalGraardor` |
|
||||
| Giant Mole | `giantMole` |
|
||||
| Grotesque Guardians | `grotesqueGuardians` |
|
||||
@@ -159,24 +153,17 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
|
||||
| The Nightmare of Ashihama | `nightmare` |
|
||||
| Phosani's Nightmare | `phosanisNightmare` |
|
||||
| Obor | `obor` |
|
||||
| Phantom Muspah | `phantomMuspah` |
|
||||
| Sarachnis | `sarachnis` |
|
||||
| Scorpia | `scorpia` |
|
||||
| Skotizo | `skotizo` |
|
||||
| Spindel | `spindel` |
|
||||
| Tempoross | `tempoross` |
|
||||
| The Gauntlet | `gauntlet` |
|
||||
| The Corrupted Gauntlet | `corruptedGauntlet` |
|
||||
| The Leviathan | `leviathan` |
|
||||
| The Whisperer | `whisperer` |
|
||||
| Theatre Of Blood | `theatreOfBlood` |
|
||||
| Theatre Of Blood: Hard Mode | `theatreOfBloodHardMode` |
|
||||
| Thermonuclear Smoke Devil | `thermonuclearSmokeDevil` |
|
||||
| Tombs of Amascut | `tombsOfAmascut` |
|
||||
| Tombs of Amascut: Expert Mode | `tombsOfAmascutExpertMode` |
|
||||
| TzKal-Zuk | `tzKalZuk` |
|
||||
| TzTok-Jad | `tzTokJad` |
|
||||
| Vardorvis | `vardorvis` |
|
||||
| Venenatis | `venenatis` |
|
||||
| Vetion | `vetion` |
|
||||
| Vorkath | `vorkath` |
|
||||
@@ -206,7 +193,6 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
|
||||
leaguePoints: {},
|
||||
bountyHunter: {},
|
||||
lastManStanding: {},
|
||||
pvpArena: {},
|
||||
soulWarsZeal: {},
|
||||
riftsClosed: {},
|
||||
bosses: {}
|
||||
|
||||
2338
__tests__/attackTopPage.html
vendored
2338
__tests__/attackTopPage.html
vendored
File diff suppressed because it is too large
Load Diff
2419
__tests__/b0atyNamePage.html
vendored
2419
__tests__/b0atyNamePage.html
vendored
File diff suppressed because it is too large
Load Diff
@@ -12,8 +12,7 @@ import {
|
||||
getSkillPageURL,
|
||||
getStatsURL,
|
||||
BOSSES,
|
||||
INVALID_FORMAT_ERROR,
|
||||
BH_MODES
|
||||
INVALID_FORMAT_ERROR
|
||||
} from '../src/index';
|
||||
|
||||
const B0ATY_NAME = 'B0ATY';
|
||||
@@ -78,8 +77,6 @@ test('Parse CSV to json', () => {
|
||||
810,99,37688883
|
||||
92,99,32005622
|
||||
23423,478
|
||||
89914,35
|
||||
99834,25
|
||||
99831,23
|
||||
89912,37
|
||||
32,12148
|
||||
@@ -90,16 +87,13 @@ test('Parse CSV to json', () => {
|
||||
392,250
|
||||
1,6143
|
||||
4814,898
|
||||
13,4057
|
||||
37,225
|
||||
25,1110
|
||||
23,467
|
||||
382,2780
|
||||
944,3000
|
||||
704,892
|
||||
1981,1452
|
||||
4981,23
|
||||
888,1046
|
||||
444,792
|
||||
613,4856
|
||||
102,4038
|
||||
156,334
|
||||
@@ -112,7 +106,6 @@ test('Parse CSV to json', () => {
|
||||
4342,1655
|
||||
966,2951
|
||||
10151,1
|
||||
1289,2477
|
||||
1288,2407
|
||||
377,4669
|
||||
545,1567
|
||||
@@ -127,24 +120,17 @@ test('Parse CSV to json', () => {
|
||||
3,22666
|
||||
2,84
|
||||
26,323
|
||||
44,6233
|
||||
201,1101
|
||||
82,3404
|
||||
5085,61
|
||||
678,903
|
||||
18823,23
|
||||
63,375
|
||||
2870,6
|
||||
2871,7
|
||||
2872,8
|
||||
6984,138
|
||||
23,923141
|
||||
4043,2000
|
||||
4073,1020
|
||||
289,13070
|
||||
489,8
|
||||
967,47
|
||||
968,48
|
||||
11155,223
|
||||
1940,272
|
||||
8623,1340
|
||||
@@ -181,15 +167,12 @@ test('Parse CSV to json', () => {
|
||||
},
|
||||
leaguePoints: { rank: 23423, score: 478 },
|
||||
bountyHunter: {
|
||||
hunterV2: { rank: 89914, score: 35 },
|
||||
rogueV2: { rank: 99834, score: 25 },
|
||||
hunter: { rank: 99831, score: 23 },
|
||||
rogue: { rank: 89912, score: 37 },
|
||||
rogue: { rank: 89912, score: 37 }
|
||||
},
|
||||
lastManStanding: { rank: 4814, score: 898 },
|
||||
pvpArena: { rank: 13, score: 4057 },
|
||||
soulWarsZeal: { rank: 37, score: 225 },
|
||||
riftsClosed: { rank: 25, score: 1110 },
|
||||
riftsClosed: { rank: 23, score: 467 },
|
||||
clues: {
|
||||
all: { rank: 32, score: 12148 },
|
||||
beginner: { rank: 3105, score: 76 },
|
||||
@@ -202,11 +185,9 @@ test('Parse CSV to json', () => {
|
||||
bosses: {
|
||||
abyssalSire: { rank: 382, score: 2780 },
|
||||
alchemicalHydra: { rank: 944, score: 3000 },
|
||||
artio: { rank: 704, score: 892 },
|
||||
barrows: { rank: 1981, score: 1452 },
|
||||
bryophyta: { rank: 4981, score: 23 },
|
||||
callisto: { rank: 888, score: 1046 },
|
||||
calvarion: { rank: 444, score: 792 },
|
||||
cerberus: { rank: 613, score: 4856 },
|
||||
chambersOfXeric: { rank: 102, score: 4038 },
|
||||
chambersOfXericChallengeMode: { rank: 156, score: 334 },
|
||||
@@ -219,7 +200,6 @@ test('Parse CSV to json', () => {
|
||||
dagannothRex: { rank: 4342, score: 1655 },
|
||||
dagannothSupreme: { rank: 966, score: 2951 },
|
||||
derangedArchaeologist: { rank: 10151, score: 1 },
|
||||
dukeSucellus: { rank: 1289, score: 2477 },
|
||||
generalGraardor: { rank: 1288, score: 2407 },
|
||||
giantMole: { rank: 377, score: 4669 },
|
||||
grotesqueGuardians: { rank: 545, score: 1567 },
|
||||
@@ -234,24 +214,17 @@ test('Parse CSV to json', () => {
|
||||
nightmare: { rank: 3, score: 22666 },
|
||||
phosanisNightmare: { rank: 2, score: 84 },
|
||||
obor: { rank: 26, score: 323 },
|
||||
phantomMuspah: { rank: 44, score: 6233 },
|
||||
sarachnis: { rank: 201, score: 1101 },
|
||||
scorpia: { rank: 82, score: 3404 },
|
||||
skotizo: { rank: 5085, score: 61 },
|
||||
spindel: { rank: 678, score: 903 },
|
||||
tempoross: { rank: 18823, score: 23 },
|
||||
gauntlet: { rank: 63, score: 375 },
|
||||
corruptedGauntlet: { rank: 2870, score: 6 },
|
||||
leviathan: { rank: 2871, score: 7 },
|
||||
whisperer: { rank: 2872, score: 8 },
|
||||
theatreOfBlood: { rank: 6984, score: 138 },
|
||||
theatreOfBloodHardMode: { rank: 23, score: 923141 },
|
||||
thermonuclearSmokeDevil: { rank: 4043, score: 2000 },
|
||||
tombsOfAmascut: { rank: 4073, score: 1020 },
|
||||
tombsOfAmascutExpertMode: { rank: 289, score: 13070 },
|
||||
tzKalZuk: { rank: 489, score: 8 },
|
||||
tzTokJad: { rank: 967, score: 47 },
|
||||
vardorvis: { rank: 968, score: 48 },
|
||||
venenatis: { rank: 11155, score: 223 },
|
||||
vetion: { rank: 1940, score: 272 },
|
||||
vorkath: { rank: 8623, score: 1340 },
|
||||
@@ -488,7 +461,7 @@ test('Get non-existent player', async () => {
|
||||
});
|
||||
|
||||
test('Get stats by gamemode', async () => {
|
||||
const { skills, bosses, bountyHunter } = await getStatsByGamemode(
|
||||
const { skills, bosses } = await getStatsByGamemode(
|
||||
LYNX_TITAN_FORMATTED_NAME
|
||||
);
|
||||
|
||||
@@ -521,55 +494,6 @@ test('Get stats by gamemode', async () => {
|
||||
|
||||
const bossKeys = Object.keys(bosses);
|
||||
expect(bossKeys).toStrictEqual(BOSSES);
|
||||
const bountyHunterKeys = Object.keys(bountyHunter);
|
||||
expect(bountyHunterKeys).toStrictEqual(BH_MODES);
|
||||
|
||||
expect.assertions(3);
|
||||
});
|
||||
|
||||
describe('Get stats options', () => {
|
||||
const rsn = 'player';
|
||||
let axiosMock: jest.Mock;
|
||||
beforeEach(() => {
|
||||
axios.get = jest.fn(
|
||||
(url) =>
|
||||
new Promise<any>((resolve) =>
|
||||
resolve(
|
||||
url === getPlayerTableURL('main', rsn)
|
||||
? { data: lynxTitanNamePage }
|
||||
: { status: 200, data: lynxTitanStats }
|
||||
)
|
||||
)
|
||||
);
|
||||
axiosMock = axios.get as any;
|
||||
axiosMock.mockClear();
|
||||
});
|
||||
it('fetches all gamemodes and formatted RSN when no options provided', async () => {
|
||||
await getStats(rsn);
|
||||
expect(axiosMock.mock.calls.map((val) => val[0])).toEqual([
|
||||
getStatsURL('main', rsn),
|
||||
getPlayerTableURL('main', rsn),
|
||||
getStatsURL('ironman', rsn),
|
||||
getStatsURL('hardcore', rsn),
|
||||
getStatsURL('ultimate', rsn)
|
||||
]);
|
||||
});
|
||||
it('skips fetching formatted RSN when option is provided', async () => {
|
||||
await getStats(rsn, { shouldGetFormattedRsn: false });
|
||||
expect(
|
||||
axiosMock.mock.calls.some(
|
||||
(val) => val[0] === getPlayerTableURL('main', rsn)
|
||||
)
|
||||
).toBeFalsy();
|
||||
});
|
||||
it('skips fetching game mode when option is provided', async () => {
|
||||
await getStats(rsn, {
|
||||
otherGamemodes: ['ironman', 'ultimate']
|
||||
});
|
||||
expect(
|
||||
axiosMock.mock.calls.some(
|
||||
(val) => val[0] === getStatsURL('hardcore', rsn)
|
||||
)
|
||||
).toBeFalsy();
|
||||
});
|
||||
expect.assertions(2);
|
||||
});
|
||||
|
||||
2406
__tests__/lynxTitanNamePage.html
vendored
2406
__tests__/lynxTitanNamePage.html
vendored
File diff suppressed because it is too large
Load Diff
@@ -6,7 +6,7 @@
|
||||
8,99,200000000
|
||||
11,99,200000000
|
||||
32,99,200000000
|
||||
157,99,200000000
|
||||
159,99,200000000
|
||||
15,99,200000000
|
||||
12,99,200000000
|
||||
9,99,200000000
|
||||
@@ -15,7 +15,7 @@
|
||||
3,99,200000000
|
||||
25,99,200000000
|
||||
5,99,200000000
|
||||
24,99,200000000
|
||||
23,99,200000000
|
||||
12,99,200000000
|
||||
2,99,200000000
|
||||
19,99,200000000
|
||||
@@ -27,11 +27,10 @@
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
764013,22
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
480246,22
|
||||
347584,22
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
@@ -83,16 +82,4 @@
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
196,186
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
-1,-1
|
||||
|
Can't render this file because it has a wrong number of fields in line 25.
|
44
package.json
44
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "osrs-json-hiscores",
|
||||
"version": "2.15.0",
|
||||
"version": "2.7.0",
|
||||
"description": "The Old School Runescape API wrapper that does more!",
|
||||
"main": "lib/index.js",
|
||||
"types": "lib/index.d.ts",
|
||||
@@ -30,9 +30,6 @@
|
||||
"stats",
|
||||
"skills"
|
||||
],
|
||||
"publishConfig": {
|
||||
"registry": "https://registry.npmjs.org"
|
||||
},
|
||||
"author": "maxswa",
|
||||
"license": "ISC",
|
||||
"bugs": {
|
||||
@@ -61,8 +58,7 @@
|
||||
"@typescript-eslint"
|
||||
],
|
||||
"extends": [
|
||||
"airbnb-base",
|
||||
"airbnb-typescript/base",
|
||||
"eslint-config-airbnb-typescript",
|
||||
"prettier"
|
||||
],
|
||||
"ignorePatterns": [
|
||||
@@ -73,8 +69,7 @@
|
||||
"trailingComma": "none",
|
||||
"tabWidth": 2,
|
||||
"semi": true,
|
||||
"singleQuote": true,
|
||||
"endOfLine": "auto"
|
||||
"singleQuote": true
|
||||
},
|
||||
"jest": {
|
||||
"transform": {
|
||||
@@ -93,24 +88,27 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"axios": "^0.21.1",
|
||||
"jsdom": "^22.1.0",
|
||||
"jsdom": "^16.3.0",
|
||||
"useragent-generator": "^1.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.5.3",
|
||||
"@types/jsdom": "^21.1.1",
|
||||
"@typescript-eslint/eslint-plugin": "^6.0.0",
|
||||
"@typescript-eslint/parser": "^6.0.0",
|
||||
"eslint": "^8.44.0",
|
||||
"eslint-config-airbnb-typescript": "^17.1.0",
|
||||
"eslint-config-prettier": "^8.8.0",
|
||||
"eslint-plugin-import": "^2.27.5",
|
||||
"@types/jest": "^26.0.21",
|
||||
"@types/jsdom": "^16.2.3",
|
||||
"@typescript-eslint/eslint-plugin": "^4.19.0",
|
||||
"@typescript-eslint/parser": "^4.19.0",
|
||||
"eslint": "^7.22.0",
|
||||
"eslint-config-airbnb-typescript": "^12.3.1",
|
||||
"eslint-config-prettier": "^8.1.0",
|
||||
"eslint-plugin-import": "^2.22.1",
|
||||
"eslint-plugin-jsx-a11y": "^6.4.1",
|
||||
"eslint-plugin-react": "^7.23.1",
|
||||
"eslint-plugin-react-hooks": "^4.2.0",
|
||||
"husky": "^5.2.0",
|
||||
"jest": "^29.6.1",
|
||||
"lint-staged": "^13.2.3",
|
||||
"np": "^7.7.0",
|
||||
"prettier": "^3.0.0",
|
||||
"ts-jest": "^29.1.1",
|
||||
"typescript": "^5.1.6"
|
||||
"jest": "^26.6.3",
|
||||
"lint-staged": "^10.5.4",
|
||||
"np": "6.5.0",
|
||||
"prettier": "^2.2.1",
|
||||
"ts-jest": "^26.5.4",
|
||||
"typescript": "^4.2.3"
|
||||
}
|
||||
}
|
||||
|
||||
137
src/hiscores.ts
137
src/hiscores.ts
@@ -1,5 +1,4 @@
|
||||
import { AxiosRequestConfig, AxiosResponse } from 'axios';
|
||||
import { BinaryData, JSDOM } from 'jsdom';
|
||||
import { JSDOM } from 'jsdom';
|
||||
import {
|
||||
Player,
|
||||
Activity,
|
||||
@@ -13,8 +12,7 @@ import {
|
||||
PlayerSkillRow,
|
||||
ActivityName,
|
||||
PlayerActivityRow,
|
||||
Bosses,
|
||||
GetStatsOptions
|
||||
Bosses
|
||||
} from './types';
|
||||
import {
|
||||
getStatsURL,
|
||||
@@ -31,34 +29,34 @@ import {
|
||||
httpGet,
|
||||
BOSSES,
|
||||
INVALID_FORMAT_ERROR,
|
||||
validateRSN
|
||||
EXTRA_ACTIVITY_COUNT
|
||||
} from './utils';
|
||||
|
||||
/**
|
||||
* Screen scrapes the hiscores to get the formatted rsn of a player.
|
||||
*
|
||||
* @param rsn Username of the player.
|
||||
* @param config Optional axios request config object.
|
||||
* @returns Formatted version of the rsn.
|
||||
*/
|
||||
export async function getRSNFormat(
|
||||
rsn: string,
|
||||
config?: AxiosRequestConfig
|
||||
): Promise<string> {
|
||||
validateRSN(rsn);
|
||||
export async function getRSNFormat(rsn: string): Promise<string> {
|
||||
if (typeof rsn !== 'string') {
|
||||
throw Error('RSN must be a string');
|
||||
} else if (!/^[a-zA-Z0-9 _-]+$/.test(rsn)) {
|
||||
throw Error('RSN contains invalid character');
|
||||
} else if (rsn.length > 12 || rsn.length < 1) {
|
||||
throw Error('RSN must be between 1 and 12 characters');
|
||||
}
|
||||
|
||||
const url = getPlayerTableURL('main', rsn);
|
||||
try {
|
||||
const response = await httpGet<string | Buffer | BinaryData | undefined>(
|
||||
url,
|
||||
config
|
||||
);
|
||||
const response = await httpGet(url);
|
||||
const dom = new JSDOM(response.data);
|
||||
const anchor = dom.window.document.querySelector(
|
||||
'.personal-hiscores__row.personal-hiscores__row--type-highlight a'
|
||||
const spans = dom.window.document.querySelectorAll(
|
||||
'span[style="color:#AA0022;"]'
|
||||
);
|
||||
if (anchor) {
|
||||
return rsnFromElement(anchor);
|
||||
if (spans.length >= 2) {
|
||||
const nameSpan = spans[1];
|
||||
return rsnFromElement(nameSpan);
|
||||
}
|
||||
throw Error('Player not found');
|
||||
} catch {
|
||||
@@ -80,7 +78,11 @@ export function parseStats(csv: string): Stats {
|
||||
|
||||
if (
|
||||
splitCSV.length !==
|
||||
SKILLS.length + BH_MODES.length + CLUES.length + BOSSES.length + 5
|
||||
SKILLS.length +
|
||||
BH_MODES.length +
|
||||
CLUES.length +
|
||||
BOSSES.length +
|
||||
EXTRA_ACTIVITY_COUNT
|
||||
) {
|
||||
throw Error(INVALID_FORMAT_ERROR);
|
||||
}
|
||||
@@ -111,8 +113,10 @@ export function parseStats(csv: string): Stats {
|
||||
const [leaguePoints] = activityObjects.splice(0, 1);
|
||||
const bhObjects = activityObjects.splice(0, BH_MODES.length);
|
||||
const clueObjects = activityObjects.splice(0, CLUES.length);
|
||||
const [lastManStanding, pvpArena, soulWarsZeal, riftsClosed] =
|
||||
activityObjects.splice(0, 4);
|
||||
const [lastManStanding, soulWarsZeal, riftsClosed] = activityObjects.splice(
|
||||
0,
|
||||
3
|
||||
);
|
||||
const bossObjects = activityObjects.splice(0, BOSSES.length);
|
||||
|
||||
const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
|
||||
@@ -144,7 +148,6 @@ export function parseStats(csv: string): Stats {
|
||||
leaguePoints,
|
||||
bountyHunter,
|
||||
lastManStanding,
|
||||
pvpArena,
|
||||
soulWarsZeal,
|
||||
riftsClosed,
|
||||
clues,
|
||||
@@ -163,44 +166,25 @@ export function parseStats(csv: string): Stats {
|
||||
* @param rsn Username of the player.
|
||||
* @returns Player object.
|
||||
*/
|
||||
export async function getStats(
|
||||
rsn: string,
|
||||
options?: GetStatsOptions
|
||||
): Promise<Player> {
|
||||
validateRSN(rsn);
|
||||
const otherGamemodes = options?.otherGamemodes ?? [
|
||||
'ironman',
|
||||
'hardcore',
|
||||
'ultimate'
|
||||
];
|
||||
const shouldGetFormattedRsn = options?.shouldGetFormattedRsn ?? true;
|
||||
export async function getStats(rsn: string): Promise<Player> {
|
||||
if (typeof rsn !== 'string') {
|
||||
throw Error('RSN must be a string');
|
||||
} else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) {
|
||||
throw Error('RSN contains invalid character');
|
||||
} else if (rsn.length > 12 || rsn.length < 1) {
|
||||
throw Error('RSN must be between 1 and 12 characters');
|
||||
}
|
||||
|
||||
const mainRes = await httpGet<string>(
|
||||
getStatsURL('main', rsn),
|
||||
options?.axiosConfigs?.main
|
||||
);
|
||||
const mainRes = await httpGet(getStatsURL('main', rsn));
|
||||
if (mainRes.status === 200) {
|
||||
const emptyResponse: AxiosResponse<string> = {
|
||||
status: 404,
|
||||
data: '',
|
||||
statusText: '',
|
||||
headers: {},
|
||||
config: {}
|
||||
};
|
||||
const getModeStats = async (
|
||||
mode: Extract<Gamemode, 'ironman' | 'hardcore' | 'ultimate'>
|
||||
): Promise<AxiosResponse<string>> =>
|
||||
otherGamemodes.includes(mode)
|
||||
? httpGet<string>(
|
||||
getStatsURL(mode, rsn),
|
||||
options?.axiosConfigs?.[mode]
|
||||
).catch((err) => err)
|
||||
: emptyResponse;
|
||||
const formattedName = shouldGetFormattedRsn
|
||||
? await getRSNFormat(rsn, options?.axiosConfigs?.rsn).catch(
|
||||
() => undefined
|
||||
)
|
||||
: undefined;
|
||||
const otherResponses = await Promise.all([
|
||||
httpGet(getStatsURL('ironman', rsn)).catch((err) => err),
|
||||
httpGet(getStatsURL('hardcore', rsn)).catch((err) => err),
|
||||
httpGet(getStatsURL('ultimate', rsn)).catch((err) => err),
|
||||
getRSNFormat(rsn).catch(() => undefined)
|
||||
]);
|
||||
|
||||
const [ironRes, hcRes, ultRes, formattedName] = otherResponses;
|
||||
|
||||
const player: Player = {
|
||||
name: formattedName ?? rsn,
|
||||
@@ -211,11 +195,8 @@ export async function getStats(
|
||||
};
|
||||
player.main = parseStats(mainRes.data);
|
||||
|
||||
const ironRes = await getModeStats('ironman');
|
||||
if (ironRes.status === 200) {
|
||||
player.ironman = parseStats(ironRes.data);
|
||||
const hcRes = await getModeStats('hardcore');
|
||||
const ultRes = await getModeStats('ultimate');
|
||||
if (hcRes.status === 200) {
|
||||
player.mode = 'hardcore';
|
||||
player.hardcore = parseStats(hcRes.data);
|
||||
@@ -267,19 +248,22 @@ export async function getStats(
|
||||
*
|
||||
* @param rsn Username of the player.
|
||||
* @param mode Gamemode to fetch ranks for.
|
||||
* @param config Optional axios request config object.
|
||||
* @returns Stats object.
|
||||
*/
|
||||
export async function getStatsByGamemode(
|
||||
rsn: string,
|
||||
mode: Gamemode = 'main',
|
||||
config?: AxiosRequestConfig
|
||||
mode: Gamemode = 'main'
|
||||
): Promise<Stats> {
|
||||
validateRSN(rsn);
|
||||
if (!GAMEMODES.includes(mode)) {
|
||||
if (typeof rsn !== 'string') {
|
||||
throw Error('RSN must be a string');
|
||||
} else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) {
|
||||
throw Error('RSN contains invalid character');
|
||||
} else if (rsn.length > 12 || rsn.length < 1) {
|
||||
throw Error('RSN must be between 1 and 12 characters');
|
||||
} else if (!GAMEMODES.includes(mode)) {
|
||||
throw Error('Invalid game mode');
|
||||
}
|
||||
const response = await httpGet<string>(getStatsURL(mode, rsn), config);
|
||||
const response = await httpGet(getStatsURL(mode, rsn));
|
||||
if (response.status !== 200) {
|
||||
throw Error('Player not found');
|
||||
}
|
||||
@@ -291,8 +275,7 @@ export async function getStatsByGamemode(
|
||||
export async function getSkillPage(
|
||||
skill: SkillName,
|
||||
mode: Gamemode = 'main',
|
||||
page: number = 1,
|
||||
config?: AxiosRequestConfig
|
||||
page: number = 1
|
||||
): Promise<PlayerSkillRow[]> {
|
||||
if (!GAMEMODES.includes(mode)) {
|
||||
throw Error('Invalid game mode');
|
||||
@@ -303,10 +286,7 @@ export async function getSkillPage(
|
||||
}
|
||||
const url = getSkillPageURL(mode, skill, page);
|
||||
|
||||
const response = await httpGet<string | Buffer | BinaryData | undefined>(
|
||||
url,
|
||||
config
|
||||
);
|
||||
const response = await httpGet(url);
|
||||
const dom = new JSDOM(response.data);
|
||||
const playersHTML = dom.window.document.querySelectorAll(
|
||||
'.personal-hiscores__row'
|
||||
@@ -338,14 +318,12 @@ export async function getSkillPage(
|
||||
* @param activity Name of the activity or boss to fetch hiscores for.
|
||||
* @param mode Gamemode to fetch ranks for.
|
||||
* @param page Page number.
|
||||
* @param config Optional axios request config object.
|
||||
* @returns Array of `PlayerActivityRow` objects.
|
||||
*/
|
||||
export async function getActivityPage(
|
||||
activity: ActivityName,
|
||||
mode: Gamemode = 'main',
|
||||
page: number = 1,
|
||||
config?: AxiosRequestConfig
|
||||
page: number = 1
|
||||
): Promise<PlayerActivityRow[]> {
|
||||
if (!GAMEMODES.includes(mode)) {
|
||||
throw Error('Invalid game mode');
|
||||
@@ -356,10 +334,7 @@ export async function getActivityPage(
|
||||
}
|
||||
const url = getActivityPageURL(mode, activity, page);
|
||||
|
||||
const response = await httpGet<string | Buffer | BinaryData | undefined>(
|
||||
url,
|
||||
config
|
||||
);
|
||||
const response = await httpGet(url);
|
||||
const dom = new JSDOM(response.data);
|
||||
const playersHTML = dom.window.document.querySelectorAll(
|
||||
'.personal-hiscores__row'
|
||||
|
||||
45
src/types.ts
45
src/types.ts
@@ -1,5 +1,3 @@
|
||||
import { AxiosRequestConfig } from 'axios';
|
||||
|
||||
export type Gamemode =
|
||||
| 'main'
|
||||
| 'ironman'
|
||||
@@ -7,10 +5,7 @@ export type Gamemode =
|
||||
| 'hardcore'
|
||||
| 'deadman'
|
||||
| 'seasonal'
|
||||
| 'tournament'
|
||||
| 'skiller'
|
||||
| 'oneDefence'
|
||||
| 'freshStart';
|
||||
| 'tournament';
|
||||
|
||||
export interface Skill {
|
||||
rank: number;
|
||||
@@ -62,18 +57,16 @@ export type ClueType =
|
||||
|
||||
export type Clues = { [Type in ClueType]: Activity };
|
||||
|
||||
export type BHType = 'rogue' | 'hunter' | 'rogueV2' | 'hunterV2';
|
||||
export type BHType = 'rogue' | 'hunter';
|
||||
|
||||
export type BH = { [Type in BHType]: Activity };
|
||||
|
||||
export type Boss =
|
||||
| 'abyssalSire'
|
||||
| 'alchemicalHydra'
|
||||
| 'artio'
|
||||
| 'barrows'
|
||||
| 'bryophyta'
|
||||
| 'callisto'
|
||||
| 'calvarion'
|
||||
| 'cerberus'
|
||||
| 'chambersOfXeric'
|
||||
| 'chambersOfXericChallengeMode'
|
||||
@@ -86,7 +79,6 @@ export type Boss =
|
||||
| 'dagannothRex'
|
||||
| 'dagannothSupreme'
|
||||
| 'derangedArchaeologist'
|
||||
| 'dukeSucellus'
|
||||
| 'generalGraardor'
|
||||
| 'giantMole'
|
||||
| 'grotesqueGuardians'
|
||||
@@ -101,24 +93,17 @@ export type Boss =
|
||||
| 'nightmare'
|
||||
| 'phosanisNightmare'
|
||||
| 'obor'
|
||||
| 'phantomMuspah'
|
||||
| 'sarachnis'
|
||||
| 'scorpia'
|
||||
| 'skotizo'
|
||||
| 'spindel'
|
||||
| 'tempoross'
|
||||
| 'gauntlet'
|
||||
| 'corruptedGauntlet'
|
||||
| 'leviathan'
|
||||
| 'whisperer'
|
||||
| 'theatreOfBlood'
|
||||
| 'theatreOfBloodHardMode'
|
||||
| 'thermonuclearSmokeDevil'
|
||||
| 'tombsOfAmascut'
|
||||
| 'tombsOfAmascutExpertMode'
|
||||
| 'tzKalZuk'
|
||||
| 'tzTokJad'
|
||||
| 'vardorvis'
|
||||
| 'venenatis'
|
||||
| 'vetion'
|
||||
| 'vorkath'
|
||||
@@ -130,12 +115,9 @@ export type Bosses = { [Type in Boss]: Activity };
|
||||
|
||||
export type ActivityName =
|
||||
| 'leaguePoints'
|
||||
| 'hunterBHV2'
|
||||
| 'rogueBHV2'
|
||||
| 'hunterBH'
|
||||
| 'rogueBH'
|
||||
| 'lastManStanding'
|
||||
| 'pvpArena'
|
||||
| 'soulWarsZeal'
|
||||
| 'riftsClosed'
|
||||
| 'allClues'
|
||||
@@ -153,7 +135,6 @@ export interface Stats {
|
||||
leaguePoints: Activity;
|
||||
bountyHunter: BH;
|
||||
lastManStanding: Activity;
|
||||
pvpArena: Activity;
|
||||
soulWarsZeal: Activity;
|
||||
riftsClosed: Activity;
|
||||
bosses: Bosses;
|
||||
@@ -177,25 +158,3 @@ export interface PlayerActivityRow extends Activity {
|
||||
name: string;
|
||||
dead: boolean;
|
||||
}
|
||||
|
||||
export interface GetStatsOptions {
|
||||
/**
|
||||
* Other game modes to fetch ranks for.
|
||||
* @defaultvalue `['ironman', 'hardcore', 'ultimate']`
|
||||
*/
|
||||
otherGamemodes?: Extract<Gamemode, 'ironman' | 'hardcore' | 'ultimate'>[];
|
||||
/**
|
||||
* If true, the formatted RSN will be fetched. Otherwise it will return the provided, unformatted RSN.
|
||||
* @defaultvalue `true`
|
||||
*/
|
||||
shouldGetFormattedRsn?: boolean;
|
||||
/**
|
||||
* Map of configs for each requests that can take place in the `getStats` function.
|
||||
*/
|
||||
axiosConfigs?: Partial<Record<Gamemode, AxiosRequestConfig>> & {
|
||||
/**
|
||||
* The axios request config object to use for the RSN format request.
|
||||
*/
|
||||
rsn?: AxiosRequestConfig;
|
||||
};
|
||||
}
|
||||
|
||||
@@ -22,10 +22,7 @@ export const GAMEMODE_URL: GamemodeUrl = {
|
||||
ultimate: `${BASE_URL}_ultimate/`,
|
||||
deadman: `${BASE_URL}_deadman/`,
|
||||
seasonal: `${BASE_URL}_seasonal/`,
|
||||
tournament: `${BASE_URL}_tournament/`,
|
||||
skiller: `${BASE_URL}_skiller/`,
|
||||
oneDefence: `${BASE_URL}_skiller_defence/`,
|
||||
freshStart: `${BASE_URL}_fresh_start/`
|
||||
tournament: `${BASE_URL}_tournament/`
|
||||
};
|
||||
export const SKILLS: SkillName[] = [
|
||||
'overall',
|
||||
@@ -62,7 +59,7 @@ export const CLUES: ClueType[] = [
|
||||
'elite',
|
||||
'master'
|
||||
];
|
||||
export const BH_MODES: BHType[] = ['hunterV2', 'rogueV2', 'hunter', 'rogue'];
|
||||
export const BH_MODES: BHType[] = ['hunter', 'rogue'];
|
||||
export const GAMEMODES: Gamemode[] = [
|
||||
'main',
|
||||
'ironman',
|
||||
@@ -75,11 +72,9 @@ export const GAMEMODES: Gamemode[] = [
|
||||
export const BOSSES: Boss[] = [
|
||||
'abyssalSire',
|
||||
'alchemicalHydra',
|
||||
'artio',
|
||||
'barrows',
|
||||
'bryophyta',
|
||||
'callisto',
|
||||
'calvarion',
|
||||
'cerberus',
|
||||
'chambersOfXeric',
|
||||
'chambersOfXericChallengeMode',
|
||||
@@ -92,7 +87,6 @@ export const BOSSES: Boss[] = [
|
||||
'dagannothRex',
|
||||
'dagannothSupreme',
|
||||
'derangedArchaeologist',
|
||||
'dukeSucellus',
|
||||
'generalGraardor',
|
||||
'giantMole',
|
||||
'grotesqueGuardians',
|
||||
@@ -107,24 +101,17 @@ export const BOSSES: Boss[] = [
|
||||
'nightmare',
|
||||
'phosanisNightmare',
|
||||
'obor',
|
||||
'phantomMuspah',
|
||||
'sarachnis',
|
||||
'scorpia',
|
||||
'skotizo',
|
||||
'spindel',
|
||||
'tempoross',
|
||||
'gauntlet',
|
||||
'corruptedGauntlet',
|
||||
'leviathan',
|
||||
'whisperer',
|
||||
'theatreOfBlood',
|
||||
'theatreOfBloodHardMode',
|
||||
'thermonuclearSmokeDevil',
|
||||
'tombsOfAmascut',
|
||||
'tombsOfAmascutExpertMode',
|
||||
'tzKalZuk',
|
||||
'tzTokJad',
|
||||
'vardorvis',
|
||||
'venenatis',
|
||||
'vetion',
|
||||
'vorkath',
|
||||
@@ -134,8 +121,6 @@ export const BOSSES: Boss[] = [
|
||||
];
|
||||
export const ACTIVITIES: ActivityName[] = [
|
||||
'leaguePoints',
|
||||
'hunterBHV2',
|
||||
'rogueBHV2',
|
||||
'hunterBH',
|
||||
'rogueBH',
|
||||
'allClues',
|
||||
@@ -146,7 +131,6 @@ export const ACTIVITIES: ActivityName[] = [
|
||||
'eliteClues',
|
||||
'masterClues',
|
||||
'lastManStanding',
|
||||
'pvpArena',
|
||||
'soulWarsZeal',
|
||||
'riftsClosed',
|
||||
...BOSSES
|
||||
@@ -159,11 +143,9 @@ export type FormattedBossNames = {
|
||||
export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
|
||||
abyssalSire: 'Abyssal Sire',
|
||||
alchemicalHydra: 'Alchemical Hydra',
|
||||
artio: 'Artio',
|
||||
barrows: 'Barrows Chests',
|
||||
bryophyta: 'Bryophyta',
|
||||
callisto: 'Callisto',
|
||||
calvarion: "Calvar'ion",
|
||||
cerberus: 'Cerberus',
|
||||
chambersOfXeric: 'Chambers of Xeric',
|
||||
chambersOfXericChallengeMode: 'Chambers of Xeric: Challenge Mode',
|
||||
@@ -176,7 +158,6 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
|
||||
dagannothRex: 'Dagannoth Rex',
|
||||
dagannothSupreme: 'Dagannoth Supreme',
|
||||
derangedArchaeologist: 'Deranged Archaeologist',
|
||||
dukeSucellus: 'Duke Sucellus',
|
||||
generalGraardor: 'General Graardor',
|
||||
giantMole: 'Giant Mole',
|
||||
grotesqueGuardians: 'Grotesque Guardians',
|
||||
@@ -191,24 +172,17 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
|
||||
nightmare: 'The Nightmare of Ashihama',
|
||||
phosanisNightmare: "Phosani's Nightmare",
|
||||
obor: 'Obor',
|
||||
phantomMuspah: 'Phantom Muspah',
|
||||
sarachnis: 'Sarachnis',
|
||||
scorpia: 'Scorpia',
|
||||
skotizo: 'Skotizo',
|
||||
spindel: 'Spindel',
|
||||
tempoross: 'Tempoross',
|
||||
gauntlet: 'The Gauntlet',
|
||||
corruptedGauntlet: 'The Corrupted Gauntlet',
|
||||
leviathan: 'The Leviathan',
|
||||
whisperer: 'The Whisperer',
|
||||
theatreOfBlood: 'Theatre of Blood',
|
||||
theatreOfBloodHardMode: 'Theatre of Blood: Hard Mode',
|
||||
thermonuclearSmokeDevil: 'Thermonuclear Smoke Devil',
|
||||
tombsOfAmascut: 'Tombs of Amascut',
|
||||
tombsOfAmascutExpertMode: 'Tombs of Amascut: Expert Mode',
|
||||
tzKalZuk: 'TzKal-Zuk',
|
||||
tzTokJad: 'TzTok-Jad',
|
||||
vardorvis: 'Vardorvis',
|
||||
venenatis: 'Venenatis',
|
||||
vetion: "Vet'ion",
|
||||
vorkath: 'Vorkath',
|
||||
@@ -267,16 +241,18 @@ export type FormattedBHNames = {
|
||||
};
|
||||
|
||||
export const FORMATTED_BH_NAMES: FormattedBHNames = {
|
||||
rogue: 'Bounty Hunter (Legacy) - Rogue',
|
||||
hunter: 'Bounty Hunter (Legacy) - Hunter',
|
||||
rogueV2: 'Bounty Hunter - Rogue',
|
||||
hunterV2: 'Bounty Hunter - Hunter'
|
||||
rogue: 'Bounty Hunter - Rogue',
|
||||
hunter: 'Bounty Hunter - Hunter'
|
||||
};
|
||||
|
||||
export const FORMATTED_LMS = 'Last Man Standing';
|
||||
export const FORMATTED_PVP_ARENA = 'PvP Arena';
|
||||
export const FORMATTED_SOUL_WARS = 'Soul Wars Zeal';
|
||||
export const FORMATTED_LEAGUE_POINTS = 'League Points';
|
||||
export const FORMATTED_RIFTS_CLOSED = 'Rifts Closed';
|
||||
|
||||
/**
|
||||
* Count of activities not including bosses, bounty hunter, or clues.
|
||||
*/
|
||||
export const EXTRA_ACTIVITY_COUNT = 4;
|
||||
|
||||
export const INVALID_FORMAT_ERROR = 'Invalid hiscores format';
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import axios, { AxiosRequestConfig } from 'axios';
|
||||
import axios from 'axios';
|
||||
import * as ua from 'useragent-generator';
|
||||
import { Gamemode, SkillName, ActivityName } from '../types';
|
||||
import {
|
||||
@@ -96,29 +96,10 @@ export const rsnFromElement = (el: Element | null) => {
|
||||
* @param url URL to run a `GET` request against.
|
||||
* @returns Axios response.
|
||||
*/
|
||||
export const httpGet = <Response>(
|
||||
url: string,
|
||||
config: AxiosRequestConfig = {}
|
||||
) =>
|
||||
axios.get<Response>(url, {
|
||||
export const httpGet = (url: string) =>
|
||||
axios.get(url, {
|
||||
headers: {
|
||||
// without User-Agent header requests may be rejected by DDoS protection mechanism
|
||||
'User-Agent': ua.firefox(80)
|
||||
},
|
||||
...config
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* Validates that a provided RSN has the same username restrictions as Jagex.
|
||||
* @param rsn Username to validate.
|
||||
* @throws Error if the RSN fails validation.
|
||||
*/
|
||||
export const validateRSN = (rsn: string) => {
|
||||
if (typeof rsn !== 'string') {
|
||||
throw Error('RSN must be a string');
|
||||
} else if (!/^[a-zA-Z0-9 _-]+$/.test(rsn)) {
|
||||
throw Error('RSN contains invalid character');
|
||||
} else if (rsn.length > 12 || rsn.length < 1) {
|
||||
throw Error('RSN must be between 1 and 12 characters');
|
||||
}
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user