mirror of
https://github.com/maxswa/osrs-json-hiscores.git
synced 2025-10-15 10:19:04 +00:00
Compare commits
128 Commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
c43858eac1 | ||
![]() |
0d0081f4f6 | ||
![]() |
3570f0f07d | ||
![]() |
3ddda54e02 | ||
![]() |
388f01522a | ||
![]() |
24b3de2a29 | ||
![]() |
fc7897d4c7 | ||
![]() |
72ea31490f | ||
![]() |
66825955c1 | ||
![]() |
4b4bf8c702 | ||
![]() |
53981e7468 | ||
![]() |
a90e5b98dd | ||
![]() |
16a975f10b | ||
![]() |
c800501188 | ||
![]() |
8a320df015 | ||
![]() |
169462c446 | ||
![]() |
317a972314 | ||
![]() |
c558f8402c | ||
![]() |
41c6da4d5c | ||
![]() |
99ad5eb662 | ||
![]() |
a8cf1713af | ||
![]() |
11391c90f2 | ||
![]() |
e4d2b10488 | ||
![]() |
0cfd0e2471 | ||
![]() |
9c284ad4b0 | ||
![]() |
ec60a72c08 | ||
![]() |
d45e2efcfd | ||
![]() |
f80b417121 | ||
![]() |
415fe2f02b | ||
![]() |
968799176f | ||
![]() |
f45ae67813 | ||
![]() |
7724636b40 | ||
![]() |
3954b04acc | ||
![]() |
ee7389455c | ||
![]() |
54c11635e0 | ||
![]() |
dc799cf363 | ||
![]() |
d4c7aaff2a | ||
![]() |
03c089ebff | ||
![]() |
96641d875a | ||
![]() |
b2bdd3d2ce | ||
![]() |
a4ddfaf199 | ||
![]() |
efbcdfc709 | ||
![]() |
fe913aba1f | ||
![]() |
1497653bab | ||
![]() |
f76de38eb1 | ||
![]() |
2f1d10b309 | ||
![]() |
f08424cb81 | ||
![]() |
69088db3b6 | ||
![]() |
9cc89735cd | ||
![]() |
a126ae4fc7 | ||
![]() |
52f3df1838 | ||
![]() |
2891bbddc4 | ||
![]() |
e2ea2fe33d | ||
![]() |
b7ae812f45 | ||
![]() |
240628d9cc | ||
![]() |
b754663f6d | ||
![]() |
0678f7c979 | ||
![]() |
2a60283a93 | ||
![]() |
b912731cf9 | ||
![]() |
cf44c57ec6 | ||
![]() |
3f34c9ab61 | ||
![]() |
1ef73b6b0c | ||
![]() |
08ecf68689 | ||
![]() |
ab3ee70237 | ||
![]() |
cad20d41cb | ||
![]() |
2877b9c8a1 | ||
![]() |
afbb22749a | ||
![]() |
eebf76a34c | ||
![]() |
e60442a7ce | ||
![]() |
1132a085e1 | ||
![]() |
a2a34a46e3 | ||
![]() |
71a76a12fd | ||
![]() |
3a72315498 | ||
![]() |
c1c9833ad0 | ||
![]() |
9fe03746e1 | ||
![]() |
66a4fb47a6 | ||
![]() |
83c44148a7 | ||
![]() |
44dea6b35c | ||
![]() |
0bf491638c | ||
![]() |
febca534b0 | ||
![]() |
8daee5c39b | ||
![]() |
f98cf8aaaa | ||
![]() |
5d9f6a6bac | ||
![]() |
8737b50a82 | ||
![]() |
1255e7e3d2 | ||
![]() |
f4135d0b0f | ||
![]() |
6135ff459c | ||
![]() |
9fb7e4cebc | ||
![]() |
11350b2444 | ||
![]() |
e0d6c5b20f | ||
![]() |
c8a4440ac3 | ||
![]() |
f3781cf142 | ||
![]() |
5fbc04217b | ||
![]() |
eb5d0ba49f | ||
![]() |
c68e3bebea | ||
![]() |
aa6fd6f39a | ||
![]() |
cc9aae8ced | ||
![]() |
12882b4e34 | ||
![]() |
b17a8b9299 | ||
![]() |
50f2c19257 | ||
![]() |
d892f8e67b | ||
![]() |
af5664ae6e | ||
![]() |
20c5c2f730 | ||
![]() |
04e59cff04 | ||
![]() |
ad2249ba76 | ||
![]() |
5c52bfd883 | ||
![]() |
947d994cdf | ||
![]() |
130446ab74 | ||
![]() |
f96e7e3e2d | ||
![]() |
90d66b6b2c | ||
![]() |
14cedb5877 | ||
![]() |
4703812b52 | ||
![]() |
a11ac96f68 | ||
![]() |
f97caa6a15 | ||
![]() |
e7e54741d2 | ||
![]() |
062e5e02b2 | ||
![]() |
ed7036f9c0 | ||
![]() |
74aba3e818 | ||
![]() |
09fe7ed539 | ||
![]() |
7a78e1ea0a | ||
![]() |
7a4163aed2 | ||
![]() |
85464d02fe | ||
![]() |
592d82f86b | ||
![]() |
a28a9e253e | ||
![]() |
0bd15f2402 | ||
![]() |
ed8ad51b4d | ||
![]() |
311ea88c61 | ||
![]() |
e056d052a5 |
1
.gitattributes
vendored
Normal file
1
.gitattributes
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
*.html linguist-vendored
|
12
.github/workflows/main.yml
vendored
12
.github/workflows/main.yml
vendored
@@ -10,19 +10,19 @@ jobs:
|
|||||||
build:
|
build:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v3.3.0
|
||||||
- uses: borales/actions-yarn@v2.0.0
|
- uses: borales/actions-yarn@v4.2.0
|
||||||
with:
|
with:
|
||||||
cmd: install
|
cmd: install
|
||||||
- uses: borales/actions-yarn@v2.0.0
|
- uses: borales/actions-yarn@v4.2.0
|
||||||
with:
|
with:
|
||||||
cmd: lint
|
cmd: lint
|
||||||
- uses: borales/actions-yarn@v2.0.0
|
- uses: borales/actions-yarn@v4.2.0
|
||||||
with:
|
with:
|
||||||
cmd: format
|
cmd: format
|
||||||
- uses: borales/actions-yarn@v2.0.0
|
- uses: borales/actions-yarn@v4.2.0
|
||||||
with:
|
with:
|
||||||
cmd: build
|
cmd: build
|
||||||
- uses: borales/actions-yarn@v2.0.0
|
- uses: borales/actions-yarn@v4.2.0
|
||||||
with:
|
with:
|
||||||
cmd: test
|
cmd: test
|
||||||
|
126
README.md
126
README.md
@@ -3,6 +3,7 @@
|
|||||||
[](https://www.npmjs.com/package/osrs-json-hiscores)
|
[](https://www.npmjs.com/package/osrs-json-hiscores)
|
||||||
[](https://npm-stat.com/charts.html?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/blob/master/src/types.ts)
|
||||||
|
[](https://github.com/maxswa/osrs-json-hiscores/actions/workflows/main.yml?query=branch%3Amain)
|
||||||
|
|
||||||
**The Old School Runescape API wrapper that does more!**
|
**The Old School Runescape API wrapper that does more!**
|
||||||
|
|
||||||
@@ -103,12 +104,16 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
|
|||||||
|
|
||||||
### Minigames
|
### Minigames
|
||||||
|
|
||||||
| Minigame | Param |
|
| Minigame | Param |
|
||||||
| ---------------------- | :---------------: |
|
| ------------------------------- | :---------------: |
|
||||||
| Bounty Hunter (Rogue) | `rogueBH` |
|
| Bounty Hunter (Legacy - Rogue) | `rogueBH` |
|
||||||
| Bounty Hunter (Hunter) | `hunterBH` |
|
| Bounty Hunter (Legacy - Hunter) | `hunterBH` |
|
||||||
| Last Man Standing | `lastManStanding` |
|
| Bounty Hunter (Rogue) | `rogueBHV2` |
|
||||||
| Soul Wars Zeal | `soulWarsZeal` |
|
| Bounty Hunter (Hunter) | `hunterBHV2` |
|
||||||
|
| Last Man Standing | `lastManStanding` |
|
||||||
|
| PvP Arena | `pvpArena` |
|
||||||
|
| Soul Wars Zeal | `soulWarsZeal` |
|
||||||
|
| Rifts Closed | `riftsClosed` |
|
||||||
|
|
||||||
### Leagues
|
### Leagues
|
||||||
|
|
||||||
@@ -118,53 +123,66 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
|
|||||||
|
|
||||||
### Bosses
|
### Bosses
|
||||||
|
|
||||||
| Boss Name | Param |
|
| Boss Name | Param |
|
||||||
| -------------------------------- | :----------------------------: |
|
| --------------------------------- | :----------------------------: |
|
||||||
| Abyssal Sire | `abyssalSire` |
|
| Abyssal Sire | `abyssalSire` |
|
||||||
| Alchemical Hydra | `alchemicalHydra` |
|
| Alchemical Hydra | `alchemicalHydra` |
|
||||||
| Barrows Chests | `barrows` |
|
| Artio | `artio` |
|
||||||
| Bryophyta | `bryophyta` |
|
| Barrows Chests | `barrows` |
|
||||||
| Callisto | `callisto` |
|
| Bryophyta | `bryophyta` |
|
||||||
| Cerberus | `cerberus` |
|
| Callisto | `callisto` |
|
||||||
| Chambers Of Xeric | `chambersOfXeric` |
|
| Calvar'ion | `calvarion` |
|
||||||
| Chambers Of Xeric Challenge Mode | `chambersOfXericChallengeMode` |
|
| Cerberus | `cerberus` |
|
||||||
| Chaos Elemental | `chaosElemental` |
|
| Chambers Of Xeric | `chambersOfXeric` |
|
||||||
| Chaos Fanatic | `chaosFanatic` |
|
| Chambers Of Xeric: Challenge Mode | `chambersOfXericChallengeMode` |
|
||||||
| Commander Zilyana | `commanderZilyana` |
|
| Chaos Elemental | `chaosElemental` |
|
||||||
| Corporeal Beast | `corporealBeast` |
|
| Chaos Fanatic | `chaosFanatic` |
|
||||||
| Crazy Archaeologist | `crazyArchaeologist` |
|
| Commander Zilyana | `commanderZilyana` |
|
||||||
| Dagannoth Prime | `dagannothPrime` |
|
| Corporeal Beast | `corporealBeast` |
|
||||||
| Dagannoth Rex | `dagannothRex` |
|
| Crazy Archaeologist | `crazyArchaeologist` |
|
||||||
| Dagannoth Supreme | `dagannothSupreme` |
|
| Dagannoth Prime | `dagannothPrime` |
|
||||||
| Deranged Archaeologist | `derangedArchaeologist` |
|
| Dagannoth Rex | `dagannothRex` |
|
||||||
| General Graardor | `generalGraardor` |
|
| Dagannoth Supreme | `dagannothSupreme` |
|
||||||
| Giant Mole | `giantMole` |
|
| Deranged Archaeologist | `derangedArchaeologist` |
|
||||||
| Grotesque Guardians | `grotesqueGuardians` |
|
| Duke Sucellus | `dukeSucellus` |
|
||||||
| Hespori | `hespori` |
|
| General Graardor | `generalGraardor` |
|
||||||
| Kalphite Queen | `kalphiteQueen` |
|
| Giant Mole | `giantMole` |
|
||||||
| King Black Dragon | `kingBlackDragon` |
|
| Grotesque Guardians | `grotesqueGuardians` |
|
||||||
| Kraken | `kraken` |
|
| Hespori | `hespori` |
|
||||||
| Kreearra | `kreeArra` |
|
| Kalphite Queen | `kalphiteQueen` |
|
||||||
| K'ril Tsutsaroth | `krilTsutsaroth` |
|
| King Black Dragon | `kingBlackDragon` |
|
||||||
| Mimic | `mimic` |
|
| Kraken | `kraken` |
|
||||||
| The Nightmare of Ashihama | `nightmare` |
|
| Kreearra | `kreeArra` |
|
||||||
| Obor | `obor` |
|
| K'ril Tsutsaroth | `krilTsutsaroth` |
|
||||||
| Sarachnis | `sarachnis` |
|
| Mimic | `mimic` |
|
||||||
| Scorpia | `scorpia` |
|
| Nex | `nex` |
|
||||||
| Skotizo | `skotizo` |
|
| The Nightmare of Ashihama | `nightmare` |
|
||||||
| Tempoross | `tempoross` |
|
| Phosani's Nightmare | `phosanisNightmare` |
|
||||||
| Gauntlet | `gauntlet` |
|
| Obor | `obor` |
|
||||||
| Corrupted Gauntlet | `corruptedGauntlet` |
|
| Phantom Muspah | `phantomMuspah` |
|
||||||
| Theatre Of Blood | `theatreOfBlood` |
|
| Sarachnis | `sarachnis` |
|
||||||
| Thermonuclear Smoke Devil | `thermonuclearSmokeDevil` |
|
| Scorpia | `scorpia` |
|
||||||
| TzKal-Zuk | `tzKalZuk` |
|
| Skotizo | `skotizo` |
|
||||||
| TzTok-Jad | `tzTokJad` |
|
| Spindel | `spindel` |
|
||||||
| Venenatis | `venenatis` |
|
| Tempoross | `tempoross` |
|
||||||
| Vetion | `vetion` |
|
| The Gauntlet | `gauntlet` |
|
||||||
| Vorkath | `vorkath` |
|
| The Corrupted Gauntlet | `corruptedGauntlet` |
|
||||||
| Wintertodt | `wintertodt` |
|
| The Leviathan | `leviathan` |
|
||||||
| Zalcano | `zalcano` |
|
| The Whisperer | `whisperer` |
|
||||||
| Zulrah | `zulrah` |
|
| 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` |
|
||||||
|
| Wintertodt | `wintertodt` |
|
||||||
|
| Zalcano | `zalcano` |
|
||||||
|
| Zulrah | `zulrah` |
|
||||||
|
|
||||||
## What you'll get
|
## What you'll get
|
||||||
|
|
||||||
@@ -188,7 +206,9 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
|
|||||||
leaguePoints: {},
|
leaguePoints: {},
|
||||||
bountyHunter: {},
|
bountyHunter: {},
|
||||||
lastManStanding: {},
|
lastManStanding: {},
|
||||||
|
pvpArena: {},
|
||||||
soulWarsZeal: {},
|
soulWarsZeal: {},
|
||||||
|
riftsClosed: {},
|
||||||
bosses: {}
|
bosses: {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
1393
__tests__/attackTopPage.html
vendored
Normal file
1393
__tests__/attackTopPage.html
vendored
Normal file
File diff suppressed because it is too large
Load Diff
1472
__tests__/b0atyNamePage.html
vendored
Normal file
1472
__tests__/b0atyNamePage.html
vendored
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,12 +1,57 @@
|
|||||||
|
import axios from 'axios';
|
||||||
|
import { readFileSync } from 'fs';
|
||||||
|
|
||||||
import {
|
import {
|
||||||
parseStats,
|
parseStats,
|
||||||
getSkillPage,
|
getSkillPage,
|
||||||
getStats,
|
getStats,
|
||||||
getStatsByGamemode,
|
getStatsByGamemode,
|
||||||
getRSNFormat,
|
getRSNFormat,
|
||||||
Stats
|
Stats,
|
||||||
|
getPlayerTableURL,
|
||||||
|
getSkillPageURL,
|
||||||
|
getStatsURL,
|
||||||
|
BOSSES,
|
||||||
|
INVALID_FORMAT_ERROR,
|
||||||
|
BH_MODES
|
||||||
} from '../src/index';
|
} from '../src/index';
|
||||||
|
|
||||||
|
const B0ATY_NAME = 'B0ATY';
|
||||||
|
const B0ATY_FORMATTED_NAME = 'B0aty';
|
||||||
|
const LYNX_TITAN_SPACE_NAME = 'lYnX tiTaN';
|
||||||
|
const LYNX_TITAN_UNDERSCORE_NAME = 'lYnX_tiTaN';
|
||||||
|
const LYNX_TITAN_HYPHEN_NAME = 'lYnX-tiTaN';
|
||||||
|
const LYNX_TITAN_FORMATTED_NAME = 'Lynx Titan';
|
||||||
|
|
||||||
|
const attackTopPage = readFileSync(`${__dirname}/attackTopPage.html`, 'utf8');
|
||||||
|
const b0atyNamePage = readFileSync(`${__dirname}/b0atyNamePage.html`, 'utf8');
|
||||||
|
const lynxTitanStats = readFileSync(`${__dirname}/lynxTitanStats.csv`, 'utf8');
|
||||||
|
const lynxTitanNamePage = readFileSync(
|
||||||
|
`${__dirname}/lynxTitanNamePage.html`,
|
||||||
|
'utf8'
|
||||||
|
);
|
||||||
|
|
||||||
|
jest.spyOn(axios, 'get').mockImplementation((url) => {
|
||||||
|
const lynxUrls = [
|
||||||
|
getPlayerTableURL('main', LYNX_TITAN_SPACE_NAME),
|
||||||
|
getPlayerTableURL('main', LYNX_TITAN_UNDERSCORE_NAME),
|
||||||
|
getPlayerTableURL('main', LYNX_TITAN_HYPHEN_NAME)
|
||||||
|
];
|
||||||
|
if (lynxUrls.includes(url)) {
|
||||||
|
return Promise.resolve({ data: lynxTitanNamePage });
|
||||||
|
}
|
||||||
|
if (getPlayerTableURL('main', B0ATY_NAME) === url) {
|
||||||
|
return Promise.resolve({ data: b0atyNamePage });
|
||||||
|
}
|
||||||
|
if (getSkillPageURL('main', 'attack', 1) === url) {
|
||||||
|
return Promise.resolve({ data: attackTopPage });
|
||||||
|
}
|
||||||
|
if (getStatsURL('main', LYNX_TITAN_FORMATTED_NAME) === url) {
|
||||||
|
return Promise.resolve({ status: 200, data: lynxTitanStats });
|
||||||
|
}
|
||||||
|
throw new Error(`No mock response for URL: ${url}`);
|
||||||
|
});
|
||||||
|
|
||||||
test('Parse CSV to json', () => {
|
test('Parse CSV to json', () => {
|
||||||
const csv = `246,2277,1338203419
|
const csv = `246,2277,1338203419
|
||||||
615,99,77438259
|
615,99,77438259
|
||||||
@@ -33,6 +78,8 @@ test('Parse CSV to json', () => {
|
|||||||
810,99,37688883
|
810,99,37688883
|
||||||
92,99,32005622
|
92,99,32005622
|
||||||
23423,478
|
23423,478
|
||||||
|
89914,35
|
||||||
|
99834,25
|
||||||
99831,23
|
99831,23
|
||||||
89912,37
|
89912,37
|
||||||
32,12148
|
32,12148
|
||||||
@@ -43,12 +90,16 @@ test('Parse CSV to json', () => {
|
|||||||
392,250
|
392,250
|
||||||
1,6143
|
1,6143
|
||||||
4814,898
|
4814,898
|
||||||
|
13,4057
|
||||||
37,225
|
37,225
|
||||||
|
25,1110
|
||||||
382,2780
|
382,2780
|
||||||
944,3000
|
944,3000
|
||||||
|
704,892
|
||||||
1981,1452
|
1981,1452
|
||||||
4981,23
|
4981,23
|
||||||
888,1046
|
888,1046
|
||||||
|
444,792
|
||||||
613,4856
|
613,4856
|
||||||
102,4038
|
102,4038
|
||||||
156,334
|
156,334
|
||||||
@@ -61,6 +112,7 @@ test('Parse CSV to json', () => {
|
|||||||
4342,1655
|
4342,1655
|
||||||
966,2951
|
966,2951
|
||||||
10151,1
|
10151,1
|
||||||
|
1289,2477
|
||||||
1288,2407
|
1288,2407
|
||||||
377,4669
|
377,4669
|
||||||
545,1567
|
545,1567
|
||||||
@@ -71,18 +123,28 @@ test('Parse CSV to json', () => {
|
|||||||
625,2391
|
625,2391
|
||||||
120,2981
|
120,2981
|
||||||
1,109
|
1,109
|
||||||
|
99,39002
|
||||||
3,22666
|
3,22666
|
||||||
|
2,84
|
||||||
26,323
|
26,323
|
||||||
|
44,6233
|
||||||
201,1101
|
201,1101
|
||||||
82,3404
|
82,3404
|
||||||
5085,61
|
5085,61
|
||||||
|
678,903
|
||||||
18823,23
|
18823,23
|
||||||
63,375
|
63,375
|
||||||
2870,6
|
2870,6
|
||||||
|
2871,7
|
||||||
|
2872,8
|
||||||
6984,138
|
6984,138
|
||||||
|
23,923141
|
||||||
4043,2000
|
4043,2000
|
||||||
|
4073,1020
|
||||||
|
289,13070
|
||||||
489,8
|
489,8
|
||||||
967,47
|
967,47
|
||||||
|
968,48
|
||||||
11155,223
|
11155,223
|
||||||
1940,272
|
1940,272
|
||||||
8623,1340
|
8623,1340
|
||||||
@@ -119,11 +181,15 @@ test('Parse CSV to json', () => {
|
|||||||
},
|
},
|
||||||
leaguePoints: { rank: 23423, score: 478 },
|
leaguePoints: { rank: 23423, score: 478 },
|
||||||
bountyHunter: {
|
bountyHunter: {
|
||||||
|
hunterV2: { rank: 89914, score: 35 },
|
||||||
|
rogueV2: { rank: 99834, score: 25 },
|
||||||
hunter: { rank: 99831, score: 23 },
|
hunter: { rank: 99831, score: 23 },
|
||||||
rogue: { rank: 89912, score: 37 }
|
rogue: { rank: 89912, score: 37 },
|
||||||
},
|
},
|
||||||
lastManStanding: { rank: 4814, score: 898 },
|
lastManStanding: { rank: 4814, score: 898 },
|
||||||
|
pvpArena: { rank: 13, score: 4057 },
|
||||||
soulWarsZeal: { rank: 37, score: 225 },
|
soulWarsZeal: { rank: 37, score: 225 },
|
||||||
|
riftsClosed: { rank: 25, score: 1110 },
|
||||||
clues: {
|
clues: {
|
||||||
all: { rank: 32, score: 12148 },
|
all: { rank: 32, score: 12148 },
|
||||||
beginner: { rank: 3105, score: 76 },
|
beginner: { rank: 3105, score: 76 },
|
||||||
@@ -136,9 +202,11 @@ test('Parse CSV to json', () => {
|
|||||||
bosses: {
|
bosses: {
|
||||||
abyssalSire: { rank: 382, score: 2780 },
|
abyssalSire: { rank: 382, score: 2780 },
|
||||||
alchemicalHydra: { rank: 944, score: 3000 },
|
alchemicalHydra: { rank: 944, score: 3000 },
|
||||||
|
artio: { rank: 704, score: 892 },
|
||||||
barrows: { rank: 1981, score: 1452 },
|
barrows: { rank: 1981, score: 1452 },
|
||||||
bryophyta: { rank: 4981, score: 23 },
|
bryophyta: { rank: 4981, score: 23 },
|
||||||
callisto: { rank: 888, score: 1046 },
|
callisto: { rank: 888, score: 1046 },
|
||||||
|
calvarion: { rank: 444, score: 792 },
|
||||||
cerberus: { rank: 613, score: 4856 },
|
cerberus: { rank: 613, score: 4856 },
|
||||||
chambersOfXeric: { rank: 102, score: 4038 },
|
chambersOfXeric: { rank: 102, score: 4038 },
|
||||||
chambersOfXericChallengeMode: { rank: 156, score: 334 },
|
chambersOfXericChallengeMode: { rank: 156, score: 334 },
|
||||||
@@ -151,6 +219,7 @@ test('Parse CSV to json', () => {
|
|||||||
dagannothRex: { rank: 4342, score: 1655 },
|
dagannothRex: { rank: 4342, score: 1655 },
|
||||||
dagannothSupreme: { rank: 966, score: 2951 },
|
dagannothSupreme: { rank: 966, score: 2951 },
|
||||||
derangedArchaeologist: { rank: 10151, score: 1 },
|
derangedArchaeologist: { rank: 10151, score: 1 },
|
||||||
|
dukeSucellus: { rank: 1289, score: 2477 },
|
||||||
generalGraardor: { rank: 1288, score: 2407 },
|
generalGraardor: { rank: 1288, score: 2407 },
|
||||||
giantMole: { rank: 377, score: 4669 },
|
giantMole: { rank: 377, score: 4669 },
|
||||||
grotesqueGuardians: { rank: 545, score: 1567 },
|
grotesqueGuardians: { rank: 545, score: 1567 },
|
||||||
@@ -161,18 +230,28 @@ test('Parse CSV to json', () => {
|
|||||||
kreeArra: { rank: 625, score: 2391 },
|
kreeArra: { rank: 625, score: 2391 },
|
||||||
krilTsutsaroth: { rank: 120, score: 2981 },
|
krilTsutsaroth: { rank: 120, score: 2981 },
|
||||||
mimic: { rank: 1, score: 109 },
|
mimic: { rank: 1, score: 109 },
|
||||||
|
nex: { rank: 99, score: 39002 },
|
||||||
nightmare: { rank: 3, score: 22666 },
|
nightmare: { rank: 3, score: 22666 },
|
||||||
|
phosanisNightmare: { rank: 2, score: 84 },
|
||||||
obor: { rank: 26, score: 323 },
|
obor: { rank: 26, score: 323 },
|
||||||
|
phantomMuspah: { rank: 44, score: 6233 },
|
||||||
sarachnis: { rank: 201, score: 1101 },
|
sarachnis: { rank: 201, score: 1101 },
|
||||||
scorpia: { rank: 82, score: 3404 },
|
scorpia: { rank: 82, score: 3404 },
|
||||||
skotizo: { rank: 5085, score: 61 },
|
skotizo: { rank: 5085, score: 61 },
|
||||||
|
spindel: { rank: 678, score: 903 },
|
||||||
tempoross: { rank: 18823, score: 23 },
|
tempoross: { rank: 18823, score: 23 },
|
||||||
gauntlet: { rank: 63, score: 375 },
|
gauntlet: { rank: 63, score: 375 },
|
||||||
corruptedGauntlet: { rank: 2870, score: 6 },
|
corruptedGauntlet: { rank: 2870, score: 6 },
|
||||||
|
leviathan: { rank: 2871, score: 7 },
|
||||||
|
whisperer: { rank: 2872, score: 8 },
|
||||||
theatreOfBlood: { rank: 6984, score: 138 },
|
theatreOfBlood: { rank: 6984, score: 138 },
|
||||||
|
theatreOfBloodHardMode: { rank: 23, score: 923141 },
|
||||||
thermonuclearSmokeDevil: { rank: 4043, score: 2000 },
|
thermonuclearSmokeDevil: { rank: 4043, score: 2000 },
|
||||||
|
tombsOfAmascut: { rank: 4073, score: 1020 },
|
||||||
|
tombsOfAmascutExpertMode: { rank: 289, score: 13070 },
|
||||||
tzKalZuk: { rank: 489, score: 8 },
|
tzKalZuk: { rank: 489, score: 8 },
|
||||||
tzTokJad: { rank: 967, score: 47 },
|
tzTokJad: { rank: 967, score: 47 },
|
||||||
|
vardorvis: { rank: 968, score: 48 },
|
||||||
venenatis: { rank: 11155, score: 223 },
|
venenatis: { rank: 11155, score: 223 },
|
||||||
vetion: { rank: 1940, score: 272 },
|
vetion: { rank: 1940, score: 272 },
|
||||||
vorkath: { rank: 8623, score: 1340 },
|
vorkath: { rank: 8623, score: 1340 },
|
||||||
@@ -185,35 +264,41 @@ test('Parse CSV to json', () => {
|
|||||||
expect(parseStats(csv)).toStrictEqual(expectedOutput);
|
expect(parseStats(csv)).toStrictEqual(expectedOutput);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('Parse CSV with unknown activity', () => {
|
||||||
|
const statsWithUnknownActivity = `${lynxTitanStats}
|
||||||
|
-1,-1`;
|
||||||
|
expect(() => parseStats(statsWithUnknownActivity)).toThrow(
|
||||||
|
INVALID_FORMAT_ERROR
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('Parse invalid CSV', () => {
|
||||||
|
expect(() => parseStats('invalid')).toThrow(INVALID_FORMAT_ERROR);
|
||||||
|
});
|
||||||
|
|
||||||
describe('Get name format', () => {
|
describe('Get name format', () => {
|
||||||
it('gets a name with a space', async () => {
|
it('gets a name with a space', async () => {
|
||||||
jest.setTimeout(30000);
|
const data = await getRSNFormat(LYNX_TITAN_SPACE_NAME);
|
||||||
const data = await getRSNFormat('lYnX tiTaN');
|
expect(data).toBe(LYNX_TITAN_FORMATTED_NAME);
|
||||||
expect(data).toBe('Lynx Titan');
|
|
||||||
});
|
});
|
||||||
it('gets a name with an underscore', async () => {
|
it('gets a name with an underscore', async () => {
|
||||||
jest.setTimeout(30000);
|
const data = await getRSNFormat(LYNX_TITAN_UNDERSCORE_NAME);
|
||||||
const data = await getRSNFormat('lYnX_tiTaN');
|
expect(data).toBe(LYNX_TITAN_FORMATTED_NAME);
|
||||||
expect(data).toBe('Lynx Titan');
|
|
||||||
});
|
});
|
||||||
it('gets a name with a hyphen', async () => {
|
it('gets a name with a hyphen', async () => {
|
||||||
jest.setTimeout(30000);
|
const data = await getRSNFormat(LYNX_TITAN_HYPHEN_NAME);
|
||||||
const data = await getRSNFormat('lYnX-tiTaN');
|
expect(data).toBe(LYNX_TITAN_FORMATTED_NAME);
|
||||||
expect(data).toBe('Lynx Titan');
|
|
||||||
});
|
});
|
||||||
it('gets a name with a number', async () => {
|
it('gets a name with a number', async () => {
|
||||||
jest.setTimeout(30000);
|
const data = await getRSNFormat(B0ATY_NAME);
|
||||||
const data = await getRSNFormat('B0ATY');
|
expect(data).toBe(B0ATY_FORMATTED_NAME);
|
||||||
expect(data).toBe('B0aty');
|
|
||||||
});
|
});
|
||||||
it('throws an error for a name with invalid characters', async () => {
|
it('throws an error for a name with invalid characters', async () => {
|
||||||
jest.setTimeout(30000);
|
|
||||||
await expect(getRSNFormat('b&aty')).rejects.toBeTruthy();
|
await expect(getRSNFormat('b&aty')).rejects.toBeTruthy();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Get attack top page', async () => {
|
test('Get attack top page', async () => {
|
||||||
jest.setTimeout(30000);
|
|
||||||
const data = await getSkillPage('attack');
|
const data = await getSkillPage('attack');
|
||||||
expect(data).toMatchObject([
|
expect(data).toMatchObject([
|
||||||
{
|
{
|
||||||
@@ -395,7 +480,6 @@ test('Get attack top page', async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test('Get non-existent player', async () => {
|
test('Get non-existent player', async () => {
|
||||||
jest.setTimeout(30000);
|
|
||||||
getStats('fishy').catch((err) => {
|
getStats('fishy').catch((err) => {
|
||||||
if (err.response) {
|
if (err.response) {
|
||||||
expect(err.response.status).toBe(404);
|
expect(err.response.status).toBe(404);
|
||||||
@@ -404,8 +488,10 @@ test('Get non-existent player', async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test('Get stats by gamemode', async () => {
|
test('Get stats by gamemode', async () => {
|
||||||
jest.setTimeout(30000);
|
const { skills, bosses, bountyHunter } = await getStatsByGamemode(
|
||||||
const { skills } = await getStatsByGamemode('Lynx Titan');
|
LYNX_TITAN_FORMATTED_NAME
|
||||||
|
);
|
||||||
|
|
||||||
expect(skills).toMatchObject({
|
expect(skills).toMatchObject({
|
||||||
overall: { rank: expect.any(Number), level: 2277, xp: 4600000000 },
|
overall: { rank: expect.any(Number), level: 2277, xp: 4600000000 },
|
||||||
attack: { rank: expect.any(Number), level: 99, xp: 200000000 },
|
attack: { rank: expect.any(Number), level: 99, xp: 200000000 },
|
||||||
@@ -432,4 +518,58 @@ test('Get stats by gamemode', async () => {
|
|||||||
hunter: { rank: expect.any(Number), level: 99, xp: 200000000 },
|
hunter: { rank: expect.any(Number), level: 99, xp: 200000000 },
|
||||||
construction: { rank: expect.any(Number), level: 99, xp: 200000000 }
|
construction: { rank: expect.any(Number), level: 99, xp: 200000000 }
|
||||||
});
|
});
|
||||||
|
|
||||||
|
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();
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
1462
__tests__/lynxTitanNamePage.html
vendored
Normal file
1462
__tests__/lynxTitanNamePage.html
vendored
Normal file
File diff suppressed because it is too large
Load Diff
98
__tests__/lynxTitanStats.csv
Normal file
98
__tests__/lynxTitanStats.csv
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
1,2277,4600000000
|
||||||
|
15,99,200000000
|
||||||
|
28,99,200000000
|
||||||
|
18,99,200000000
|
||||||
|
7,99,200000000
|
||||||
|
8,99,200000000
|
||||||
|
11,99,200000000
|
||||||
|
32,99,200000000
|
||||||
|
157,99,200000000
|
||||||
|
15,99,200000000
|
||||||
|
12,99,200000000
|
||||||
|
9,99,200000000
|
||||||
|
48,99,200000000
|
||||||
|
4,99,200000000
|
||||||
|
3,99,200000000
|
||||||
|
25,99,200000000
|
||||||
|
5,99,200000000
|
||||||
|
24,99,200000000
|
||||||
|
12,99,200000000
|
||||||
|
2,99,200000000
|
||||||
|
19,99,200000000
|
||||||
|
7,99,200000000
|
||||||
|
4,99,200000000
|
||||||
|
4,99,200000000
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
764013,22
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
480246,22
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-1,-1
|
||||||
|
-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.
|
49
package.json
49
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "osrs-json-hiscores",
|
"name": "osrs-json-hiscores",
|
||||||
"version": "2.4.1",
|
"version": "2.15.0",
|
||||||
"description": "The Old School Runescape API wrapper that does more!",
|
"description": "The Old School Runescape API wrapper that does more!",
|
||||||
"main": "lib/index.js",
|
"main": "lib/index.js",
|
||||||
"types": "lib/index.d.ts",
|
"types": "lib/index.d.ts",
|
||||||
@@ -8,7 +8,7 @@
|
|||||||
"lib/**/*"
|
"lib/**/*"
|
||||||
],
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "watch 'yarn run build' src",
|
"dev": "yarn build --watch",
|
||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
"format": "prettier --write \"src/**/*.ts\"",
|
"format": "prettier --write \"src/**/*.ts\"",
|
||||||
"lint": "eslint --fix \"src/**/*.ts\"",
|
"lint": "eslint --fix \"src/**/*.ts\"",
|
||||||
@@ -30,6 +30,9 @@
|
|||||||
"stats",
|
"stats",
|
||||||
"skills"
|
"skills"
|
||||||
],
|
],
|
||||||
|
"publishConfig": {
|
||||||
|
"registry": "https://registry.npmjs.org"
|
||||||
|
},
|
||||||
"author": "maxswa",
|
"author": "maxswa",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
@@ -52,13 +55,14 @@
|
|||||||
"root": true,
|
"root": true,
|
||||||
"parser": "@typescript-eslint/parser",
|
"parser": "@typescript-eslint/parser",
|
||||||
"parserOptions": {
|
"parserOptions": {
|
||||||
"project": "./tsconfig.json"
|
"project": "./tsconfig.eslint.json"
|
||||||
},
|
},
|
||||||
"plugins": [
|
"plugins": [
|
||||||
"@typescript-eslint"
|
"@typescript-eslint"
|
||||||
],
|
],
|
||||||
"extends": [
|
"extends": [
|
||||||
"eslint-config-airbnb-typescript",
|
"airbnb-base",
|
||||||
|
"airbnb-typescript/base",
|
||||||
"prettier"
|
"prettier"
|
||||||
],
|
],
|
||||||
"ignorePatterns": [
|
"ignorePatterns": [
|
||||||
@@ -69,7 +73,8 @@
|
|||||||
"trailingComma": "none",
|
"trailingComma": "none",
|
||||||
"tabWidth": 2,
|
"tabWidth": 2,
|
||||||
"semi": true,
|
"semi": true,
|
||||||
"singleQuote": true
|
"singleQuote": true,
|
||||||
|
"endOfLine": "auto"
|
||||||
},
|
},
|
||||||
"jest": {
|
"jest": {
|
||||||
"transform": {
|
"transform": {
|
||||||
@@ -88,28 +93,24 @@
|
|||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"axios": "^0.21.1",
|
"axios": "^0.21.1",
|
||||||
"jsdom": "^16.3.0",
|
"jsdom": "^22.1.0",
|
||||||
"useragent-generator": "^1.1.0"
|
"useragent-generator": "^1.1.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/jest": "^26.0.21",
|
"@types/jest": "^29.5.3",
|
||||||
"@types/jsdom": "^16.2.3",
|
"@types/jsdom": "^21.1.1",
|
||||||
"@typescript-eslint/eslint-plugin": "^4.19.0",
|
"@typescript-eslint/eslint-plugin": "^6.0.0",
|
||||||
"@typescript-eslint/parser": "^4.19.0",
|
"@typescript-eslint/parser": "^6.0.0",
|
||||||
"eslint": "^7.22.0",
|
"eslint": "^8.44.0",
|
||||||
"eslint-config-airbnb-typescript": "^12.3.1",
|
"eslint-config-airbnb-typescript": "^17.1.0",
|
||||||
"eslint-config-prettier": "^8.1.0",
|
"eslint-config-prettier": "^8.8.0",
|
||||||
"eslint-plugin-import": "^2.22.1",
|
"eslint-plugin-import": "^2.27.5",
|
||||||
"eslint-plugin-jsx-a11y": "^6.4.1",
|
|
||||||
"eslint-plugin-react": "^7.23.1",
|
|
||||||
"eslint-plugin-react-hooks": "^4.2.0",
|
|
||||||
"husky": "^5.2.0",
|
"husky": "^5.2.0",
|
||||||
"jest": "^26.6.3",
|
"jest": "^29.6.1",
|
||||||
"lint-staged": "^10.5.4",
|
"lint-staged": "^13.2.3",
|
||||||
"np": "6.5.0",
|
"np": "^7.7.0",
|
||||||
"prettier": "^2.2.1",
|
"prettier": "^3.0.0",
|
||||||
"ts-jest": "^26.5.4",
|
"ts-jest": "^29.1.1",
|
||||||
"typescript": "^4.2.3",
|
"typescript": "^5.1.6"
|
||||||
"watch": "^1.0.2"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
140
src/hiscores.ts
140
src/hiscores.ts
@@ -1,4 +1,5 @@
|
|||||||
import { JSDOM } from 'jsdom';
|
import { AxiosRequestConfig, AxiosResponse } from 'axios';
|
||||||
|
import { BinaryData, JSDOM } from 'jsdom';
|
||||||
import {
|
import {
|
||||||
Player,
|
Player,
|
||||||
Activity,
|
Activity,
|
||||||
@@ -12,7 +13,8 @@ import {
|
|||||||
PlayerSkillRow,
|
PlayerSkillRow,
|
||||||
ActivityName,
|
ActivityName,
|
||||||
PlayerActivityRow,
|
PlayerActivityRow,
|
||||||
Bosses
|
Bosses,
|
||||||
|
GetStatsOptions
|
||||||
} from './types';
|
} from './types';
|
||||||
import {
|
import {
|
||||||
getStatsURL,
|
getStatsURL,
|
||||||
@@ -27,34 +29,36 @@ import {
|
|||||||
rsnFromElement,
|
rsnFromElement,
|
||||||
getActivityPageURL,
|
getActivityPageURL,
|
||||||
httpGet,
|
httpGet,
|
||||||
BOSSES
|
BOSSES,
|
||||||
|
INVALID_FORMAT_ERROR,
|
||||||
|
validateRSN
|
||||||
} from './utils';
|
} from './utils';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Screen scrapes the hiscores to get the formatted rsn of a player.
|
* Screen scrapes the hiscores to get the formatted rsn of a player.
|
||||||
*
|
*
|
||||||
* @param rsn Username of the player.
|
* @param rsn Username of the player.
|
||||||
|
* @param config Optional axios request config object.
|
||||||
* @returns Formatted version of the rsn.
|
* @returns Formatted version of the rsn.
|
||||||
*/
|
*/
|
||||||
export async function getRSNFormat(rsn: string): Promise<string> {
|
export async function getRSNFormat(
|
||||||
if (typeof rsn !== 'string') {
|
rsn: string,
|
||||||
throw Error('RSN must be a string');
|
config?: AxiosRequestConfig
|
||||||
} else if (!/^[a-zA-Z0-9 _-]+$/.test(rsn)) {
|
): Promise<string> {
|
||||||
throw Error('RSN contains invalid character');
|
validateRSN(rsn);
|
||||||
} else if (rsn.length > 12 || rsn.length < 1) {
|
|
||||||
throw Error('RSN must be between 1 and 12 characters');
|
|
||||||
}
|
|
||||||
|
|
||||||
const url = getPlayerTableURL('main', rsn);
|
const url = getPlayerTableURL('main', rsn);
|
||||||
try {
|
try {
|
||||||
const response = await httpGet(url);
|
const response = await httpGet<string | Buffer | BinaryData | undefined>(
|
||||||
const dom = new JSDOM(response.data);
|
url,
|
||||||
const spans = dom.window.document.querySelectorAll(
|
config
|
||||||
'span[style="color:#AA0022;"]'
|
|
||||||
);
|
);
|
||||||
if (spans.length >= 2) {
|
const dom = new JSDOM(response.data);
|
||||||
const nameSpan = spans[1];
|
const anchor = dom.window.document.querySelector(
|
||||||
return rsnFromElement(nameSpan);
|
'.personal-hiscores__row.personal-hiscores__row--type-highlight a'
|
||||||
|
);
|
||||||
|
if (anchor) {
|
||||||
|
return rsnFromElement(anchor);
|
||||||
}
|
}
|
||||||
throw Error('Player not found');
|
throw Error('Player not found');
|
||||||
} catch {
|
} catch {
|
||||||
@@ -74,6 +78,13 @@ export function parseStats(csv: string): Stats {
|
|||||||
.filter((entry) => !!entry)
|
.filter((entry) => !!entry)
|
||||||
.map((stat) => stat.split(','));
|
.map((stat) => stat.split(','));
|
||||||
|
|
||||||
|
if (
|
||||||
|
splitCSV.length !==
|
||||||
|
SKILLS.length + BH_MODES.length + CLUES.length + BOSSES.length + 5
|
||||||
|
) {
|
||||||
|
throw Error(INVALID_FORMAT_ERROR);
|
||||||
|
}
|
||||||
|
|
||||||
const skillObjects: Skill[] = splitCSV
|
const skillObjects: Skill[] = splitCSV
|
||||||
.filter((stat) => stat.length === 3)
|
.filter((stat) => stat.length === 3)
|
||||||
.map((stat) => {
|
.map((stat) => {
|
||||||
@@ -100,7 +111,8 @@ export function parseStats(csv: string): Stats {
|
|||||||
const [leaguePoints] = activityObjects.splice(0, 1);
|
const [leaguePoints] = activityObjects.splice(0, 1);
|
||||||
const bhObjects = activityObjects.splice(0, BH_MODES.length);
|
const bhObjects = activityObjects.splice(0, BH_MODES.length);
|
||||||
const clueObjects = activityObjects.splice(0, CLUES.length);
|
const clueObjects = activityObjects.splice(0, CLUES.length);
|
||||||
const [lastManStanding, soulWarsZeal] = activityObjects.splice(0, 2);
|
const [lastManStanding, pvpArena, soulWarsZeal, riftsClosed] =
|
||||||
|
activityObjects.splice(0, 4);
|
||||||
const bossObjects = activityObjects.splice(0, BOSSES.length);
|
const bossObjects = activityObjects.splice(0, BOSSES.length);
|
||||||
|
|
||||||
const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
|
const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
|
||||||
@@ -132,7 +144,9 @@ export function parseStats(csv: string): Stats {
|
|||||||
leaguePoints,
|
leaguePoints,
|
||||||
bountyHunter,
|
bountyHunter,
|
||||||
lastManStanding,
|
lastManStanding,
|
||||||
|
pvpArena,
|
||||||
soulWarsZeal,
|
soulWarsZeal,
|
||||||
|
riftsClosed,
|
||||||
clues,
|
clues,
|
||||||
bosses
|
bosses
|
||||||
};
|
};
|
||||||
@@ -149,25 +163,44 @@ export function parseStats(csv: string): Stats {
|
|||||||
* @param rsn Username of the player.
|
* @param rsn Username of the player.
|
||||||
* @returns Player object.
|
* @returns Player object.
|
||||||
*/
|
*/
|
||||||
export async function getStats(rsn: string): Promise<Player> {
|
export async function getStats(
|
||||||
if (typeof rsn !== 'string') {
|
rsn: string,
|
||||||
throw Error('RSN must be a string');
|
options?: GetStatsOptions
|
||||||
} else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) {
|
): Promise<Player> {
|
||||||
throw Error('RSN contains invalid character');
|
validateRSN(rsn);
|
||||||
} else if (rsn.length > 12 || rsn.length < 1) {
|
const otherGamemodes = options?.otherGamemodes ?? [
|
||||||
throw Error('RSN must be between 1 and 12 characters');
|
'ironman',
|
||||||
}
|
'hardcore',
|
||||||
|
'ultimate'
|
||||||
|
];
|
||||||
|
const shouldGetFormattedRsn = options?.shouldGetFormattedRsn ?? true;
|
||||||
|
|
||||||
const mainRes = await httpGet(getStatsURL('main', rsn));
|
const mainRes = await httpGet<string>(
|
||||||
|
getStatsURL('main', rsn),
|
||||||
|
options?.axiosConfigs?.main
|
||||||
|
);
|
||||||
if (mainRes.status === 200) {
|
if (mainRes.status === 200) {
|
||||||
const otherResponses = await Promise.all([
|
const emptyResponse: AxiosResponse<string> = {
|
||||||
httpGet(getStatsURL('ironman', rsn)).catch((err) => err),
|
status: 404,
|
||||||
httpGet(getStatsURL('hardcore', rsn)).catch((err) => err),
|
data: '',
|
||||||
httpGet(getStatsURL('ultimate', rsn)).catch((err) => err),
|
statusText: '',
|
||||||
getRSNFormat(rsn).catch(() => undefined)
|
headers: {},
|
||||||
]);
|
config: {}
|
||||||
|
};
|
||||||
const [ironRes, hcRes, ultRes, formattedName] = otherResponses;
|
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 player: Player = {
|
const player: Player = {
|
||||||
name: formattedName ?? rsn,
|
name: formattedName ?? rsn,
|
||||||
@@ -178,8 +211,11 @@ export async function getStats(rsn: string): Promise<Player> {
|
|||||||
};
|
};
|
||||||
player.main = parseStats(mainRes.data);
|
player.main = parseStats(mainRes.data);
|
||||||
|
|
||||||
|
const ironRes = await getModeStats('ironman');
|
||||||
if (ironRes.status === 200) {
|
if (ironRes.status === 200) {
|
||||||
player.ironman = parseStats(ironRes.data);
|
player.ironman = parseStats(ironRes.data);
|
||||||
|
const hcRes = await getModeStats('hardcore');
|
||||||
|
const ultRes = await getModeStats('ultimate');
|
||||||
if (hcRes.status === 200) {
|
if (hcRes.status === 200) {
|
||||||
player.mode = 'hardcore';
|
player.mode = 'hardcore';
|
||||||
player.hardcore = parseStats(hcRes.data);
|
player.hardcore = parseStats(hcRes.data);
|
||||||
@@ -231,22 +267,19 @@ export async function getStats(rsn: string): Promise<Player> {
|
|||||||
*
|
*
|
||||||
* @param rsn Username of the player.
|
* @param rsn Username of the player.
|
||||||
* @param mode Gamemode to fetch ranks for.
|
* @param mode Gamemode to fetch ranks for.
|
||||||
|
* @param config Optional axios request config object.
|
||||||
* @returns Stats object.
|
* @returns Stats object.
|
||||||
*/
|
*/
|
||||||
export async function getStatsByGamemode(
|
export async function getStatsByGamemode(
|
||||||
rsn: string,
|
rsn: string,
|
||||||
mode: Gamemode = 'main'
|
mode: Gamemode = 'main',
|
||||||
|
config?: AxiosRequestConfig
|
||||||
): Promise<Stats> {
|
): Promise<Stats> {
|
||||||
if (typeof rsn !== 'string') {
|
validateRSN(rsn);
|
||||||
throw Error('RSN must be a string');
|
if (!GAMEMODES.includes(mode)) {
|
||||||
} 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');
|
throw Error('Invalid game mode');
|
||||||
}
|
}
|
||||||
const response = await httpGet(getStatsURL(mode, rsn));
|
const response = await httpGet<string>(getStatsURL(mode, rsn), config);
|
||||||
if (response.status !== 200) {
|
if (response.status !== 200) {
|
||||||
throw Error('Player not found');
|
throw Error('Player not found');
|
||||||
}
|
}
|
||||||
@@ -258,7 +291,8 @@ export async function getStatsByGamemode(
|
|||||||
export async function getSkillPage(
|
export async function getSkillPage(
|
||||||
skill: SkillName,
|
skill: SkillName,
|
||||||
mode: Gamemode = 'main',
|
mode: Gamemode = 'main',
|
||||||
page: number = 1
|
page: number = 1,
|
||||||
|
config?: AxiosRequestConfig
|
||||||
): Promise<PlayerSkillRow[]> {
|
): Promise<PlayerSkillRow[]> {
|
||||||
if (!GAMEMODES.includes(mode)) {
|
if (!GAMEMODES.includes(mode)) {
|
||||||
throw Error('Invalid game mode');
|
throw Error('Invalid game mode');
|
||||||
@@ -269,7 +303,10 @@ export async function getSkillPage(
|
|||||||
}
|
}
|
||||||
const url = getSkillPageURL(mode, skill, page);
|
const url = getSkillPageURL(mode, skill, page);
|
||||||
|
|
||||||
const response = await httpGet(url);
|
const response = await httpGet<string | Buffer | BinaryData | undefined>(
|
||||||
|
url,
|
||||||
|
config
|
||||||
|
);
|
||||||
const dom = new JSDOM(response.data);
|
const dom = new JSDOM(response.data);
|
||||||
const playersHTML = dom.window.document.querySelectorAll(
|
const playersHTML = dom.window.document.querySelectorAll(
|
||||||
'.personal-hiscores__row'
|
'.personal-hiscores__row'
|
||||||
@@ -301,12 +338,14 @@ export async function getSkillPage(
|
|||||||
* @param activity Name of the activity or boss to fetch hiscores for.
|
* @param activity Name of the activity or boss to fetch hiscores for.
|
||||||
* @param mode Gamemode to fetch ranks for.
|
* @param mode Gamemode to fetch ranks for.
|
||||||
* @param page Page number.
|
* @param page Page number.
|
||||||
|
* @param config Optional axios request config object.
|
||||||
* @returns Array of `PlayerActivityRow` objects.
|
* @returns Array of `PlayerActivityRow` objects.
|
||||||
*/
|
*/
|
||||||
export async function getActivityPage(
|
export async function getActivityPage(
|
||||||
activity: ActivityName,
|
activity: ActivityName,
|
||||||
mode: Gamemode = 'main',
|
mode: Gamemode = 'main',
|
||||||
page: number = 1
|
page: number = 1,
|
||||||
|
config?: AxiosRequestConfig
|
||||||
): Promise<PlayerActivityRow[]> {
|
): Promise<PlayerActivityRow[]> {
|
||||||
if (!GAMEMODES.includes(mode)) {
|
if (!GAMEMODES.includes(mode)) {
|
||||||
throw Error('Invalid game mode');
|
throw Error('Invalid game mode');
|
||||||
@@ -317,7 +356,10 @@ export async function getActivityPage(
|
|||||||
}
|
}
|
||||||
const url = getActivityPageURL(mode, activity, page);
|
const url = getActivityPageURL(mode, activity, page);
|
||||||
|
|
||||||
const response = await httpGet(url);
|
const response = await httpGet<string | Buffer | BinaryData | undefined>(
|
||||||
|
url,
|
||||||
|
config
|
||||||
|
);
|
||||||
const dom = new JSDOM(response.data);
|
const dom = new JSDOM(response.data);
|
||||||
const playersHTML = dom.window.document.querySelectorAll(
|
const playersHTML = dom.window.document.querySelectorAll(
|
||||||
'.personal-hiscores__row'
|
'.personal-hiscores__row'
|
||||||
|
50
src/types.ts
50
src/types.ts
@@ -1,3 +1,5 @@
|
|||||||
|
import { AxiosRequestConfig } from 'axios';
|
||||||
|
|
||||||
export type Gamemode =
|
export type Gamemode =
|
||||||
| 'main'
|
| 'main'
|
||||||
| 'ironman'
|
| 'ironman'
|
||||||
@@ -5,7 +7,10 @@ export type Gamemode =
|
|||||||
| 'hardcore'
|
| 'hardcore'
|
||||||
| 'deadman'
|
| 'deadman'
|
||||||
| 'seasonal'
|
| 'seasonal'
|
||||||
| 'tournament';
|
| 'tournament'
|
||||||
|
| 'skiller'
|
||||||
|
| 'oneDefence'
|
||||||
|
| 'freshStart';
|
||||||
|
|
||||||
export interface Skill {
|
export interface Skill {
|
||||||
rank: number;
|
rank: number;
|
||||||
@@ -57,16 +62,18 @@ export type ClueType =
|
|||||||
|
|
||||||
export type Clues = { [Type in ClueType]: Activity };
|
export type Clues = { [Type in ClueType]: Activity };
|
||||||
|
|
||||||
export type BHType = 'rogue' | 'hunter';
|
export type BHType = 'rogue' | 'hunter' | 'rogueV2' | 'hunterV2';
|
||||||
|
|
||||||
export type BH = { [Type in BHType]: Activity };
|
export type BH = { [Type in BHType]: Activity };
|
||||||
|
|
||||||
export type Boss =
|
export type Boss =
|
||||||
| 'abyssalSire'
|
| 'abyssalSire'
|
||||||
| 'alchemicalHydra'
|
| 'alchemicalHydra'
|
||||||
|
| 'artio'
|
||||||
| 'barrows'
|
| 'barrows'
|
||||||
| 'bryophyta'
|
| 'bryophyta'
|
||||||
| 'callisto'
|
| 'callisto'
|
||||||
|
| 'calvarion'
|
||||||
| 'cerberus'
|
| 'cerberus'
|
||||||
| 'chambersOfXeric'
|
| 'chambersOfXeric'
|
||||||
| 'chambersOfXericChallengeMode'
|
| 'chambersOfXericChallengeMode'
|
||||||
@@ -79,6 +86,7 @@ export type Boss =
|
|||||||
| 'dagannothRex'
|
| 'dagannothRex'
|
||||||
| 'dagannothSupreme'
|
| 'dagannothSupreme'
|
||||||
| 'derangedArchaeologist'
|
| 'derangedArchaeologist'
|
||||||
|
| 'dukeSucellus'
|
||||||
| 'generalGraardor'
|
| 'generalGraardor'
|
||||||
| 'giantMole'
|
| 'giantMole'
|
||||||
| 'grotesqueGuardians'
|
| 'grotesqueGuardians'
|
||||||
@@ -89,18 +97,28 @@ export type Boss =
|
|||||||
| 'kreeArra'
|
| 'kreeArra'
|
||||||
| 'krilTsutsaroth'
|
| 'krilTsutsaroth'
|
||||||
| 'mimic'
|
| 'mimic'
|
||||||
|
| 'nex'
|
||||||
| 'nightmare'
|
| 'nightmare'
|
||||||
|
| 'phosanisNightmare'
|
||||||
| 'obor'
|
| 'obor'
|
||||||
|
| 'phantomMuspah'
|
||||||
| 'sarachnis'
|
| 'sarachnis'
|
||||||
| 'scorpia'
|
| 'scorpia'
|
||||||
| 'skotizo'
|
| 'skotizo'
|
||||||
|
| 'spindel'
|
||||||
| 'tempoross'
|
| 'tempoross'
|
||||||
| 'gauntlet'
|
| 'gauntlet'
|
||||||
| 'corruptedGauntlet'
|
| 'corruptedGauntlet'
|
||||||
|
| 'leviathan'
|
||||||
|
| 'whisperer'
|
||||||
| 'theatreOfBlood'
|
| 'theatreOfBlood'
|
||||||
|
| 'theatreOfBloodHardMode'
|
||||||
| 'thermonuclearSmokeDevil'
|
| 'thermonuclearSmokeDevil'
|
||||||
|
| 'tombsOfAmascut'
|
||||||
|
| 'tombsOfAmascutExpertMode'
|
||||||
| 'tzKalZuk'
|
| 'tzKalZuk'
|
||||||
| 'tzTokJad'
|
| 'tzTokJad'
|
||||||
|
| 'vardorvis'
|
||||||
| 'venenatis'
|
| 'venenatis'
|
||||||
| 'vetion'
|
| 'vetion'
|
||||||
| 'vorkath'
|
| 'vorkath'
|
||||||
@@ -112,10 +130,14 @@ export type Bosses = { [Type in Boss]: Activity };
|
|||||||
|
|
||||||
export type ActivityName =
|
export type ActivityName =
|
||||||
| 'leaguePoints'
|
| 'leaguePoints'
|
||||||
|
| 'hunterBHV2'
|
||||||
|
| 'rogueBHV2'
|
||||||
| 'hunterBH'
|
| 'hunterBH'
|
||||||
| 'rogueBH'
|
| 'rogueBH'
|
||||||
| 'lastManStanding'
|
| 'lastManStanding'
|
||||||
|
| 'pvpArena'
|
||||||
| 'soulWarsZeal'
|
| 'soulWarsZeal'
|
||||||
|
| 'riftsClosed'
|
||||||
| 'allClues'
|
| 'allClues'
|
||||||
| 'beginnerClues'
|
| 'beginnerClues'
|
||||||
| 'easyClues'
|
| 'easyClues'
|
||||||
@@ -131,7 +153,9 @@ export interface Stats {
|
|||||||
leaguePoints: Activity;
|
leaguePoints: Activity;
|
||||||
bountyHunter: BH;
|
bountyHunter: BH;
|
||||||
lastManStanding: Activity;
|
lastManStanding: Activity;
|
||||||
|
pvpArena: Activity;
|
||||||
soulWarsZeal: Activity;
|
soulWarsZeal: Activity;
|
||||||
|
riftsClosed: Activity;
|
||||||
bosses: Bosses;
|
bosses: Bosses;
|
||||||
}
|
}
|
||||||
export type Modes = { [M in Gamemode]?: Stats };
|
export type Modes = { [M in Gamemode]?: Stats };
|
||||||
@@ -153,3 +177,25 @@ export interface PlayerActivityRow extends Activity {
|
|||||||
name: string;
|
name: string;
|
||||||
dead: boolean;
|
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,7 +22,10 @@ export const GAMEMODE_URL: GamemodeUrl = {
|
|||||||
ultimate: `${BASE_URL}_ultimate/`,
|
ultimate: `${BASE_URL}_ultimate/`,
|
||||||
deadman: `${BASE_URL}_deadman/`,
|
deadman: `${BASE_URL}_deadman/`,
|
||||||
seasonal: `${BASE_URL}_seasonal/`,
|
seasonal: `${BASE_URL}_seasonal/`,
|
||||||
tournament: `${BASE_URL}_tournament/`
|
tournament: `${BASE_URL}_tournament/`,
|
||||||
|
skiller: `${BASE_URL}_skiller/`,
|
||||||
|
oneDefence: `${BASE_URL}_skiller_defence/`,
|
||||||
|
freshStart: `${BASE_URL}_fresh_start/`
|
||||||
};
|
};
|
||||||
export const SKILLS: SkillName[] = [
|
export const SKILLS: SkillName[] = [
|
||||||
'overall',
|
'overall',
|
||||||
@@ -59,7 +62,7 @@ export const CLUES: ClueType[] = [
|
|||||||
'elite',
|
'elite',
|
||||||
'master'
|
'master'
|
||||||
];
|
];
|
||||||
export const BH_MODES: BHType[] = ['hunter', 'rogue'];
|
export const BH_MODES: BHType[] = ['hunterV2', 'rogueV2', 'hunter', 'rogue'];
|
||||||
export const GAMEMODES: Gamemode[] = [
|
export const GAMEMODES: Gamemode[] = [
|
||||||
'main',
|
'main',
|
||||||
'ironman',
|
'ironman',
|
||||||
@@ -72,9 +75,11 @@ export const GAMEMODES: Gamemode[] = [
|
|||||||
export const BOSSES: Boss[] = [
|
export const BOSSES: Boss[] = [
|
||||||
'abyssalSire',
|
'abyssalSire',
|
||||||
'alchemicalHydra',
|
'alchemicalHydra',
|
||||||
|
'artio',
|
||||||
'barrows',
|
'barrows',
|
||||||
'bryophyta',
|
'bryophyta',
|
||||||
'callisto',
|
'callisto',
|
||||||
|
'calvarion',
|
||||||
'cerberus',
|
'cerberus',
|
||||||
'chambersOfXeric',
|
'chambersOfXeric',
|
||||||
'chambersOfXericChallengeMode',
|
'chambersOfXericChallengeMode',
|
||||||
@@ -87,6 +92,7 @@ export const BOSSES: Boss[] = [
|
|||||||
'dagannothRex',
|
'dagannothRex',
|
||||||
'dagannothSupreme',
|
'dagannothSupreme',
|
||||||
'derangedArchaeologist',
|
'derangedArchaeologist',
|
||||||
|
'dukeSucellus',
|
||||||
'generalGraardor',
|
'generalGraardor',
|
||||||
'giantMole',
|
'giantMole',
|
||||||
'grotesqueGuardians',
|
'grotesqueGuardians',
|
||||||
@@ -97,18 +103,28 @@ export const BOSSES: Boss[] = [
|
|||||||
'kreeArra',
|
'kreeArra',
|
||||||
'krilTsutsaroth',
|
'krilTsutsaroth',
|
||||||
'mimic',
|
'mimic',
|
||||||
|
'nex',
|
||||||
'nightmare',
|
'nightmare',
|
||||||
|
'phosanisNightmare',
|
||||||
'obor',
|
'obor',
|
||||||
|
'phantomMuspah',
|
||||||
'sarachnis',
|
'sarachnis',
|
||||||
'scorpia',
|
'scorpia',
|
||||||
'skotizo',
|
'skotizo',
|
||||||
|
'spindel',
|
||||||
'tempoross',
|
'tempoross',
|
||||||
'gauntlet',
|
'gauntlet',
|
||||||
'corruptedGauntlet',
|
'corruptedGauntlet',
|
||||||
|
'leviathan',
|
||||||
|
'whisperer',
|
||||||
'theatreOfBlood',
|
'theatreOfBlood',
|
||||||
|
'theatreOfBloodHardMode',
|
||||||
'thermonuclearSmokeDevil',
|
'thermonuclearSmokeDevil',
|
||||||
|
'tombsOfAmascut',
|
||||||
|
'tombsOfAmascutExpertMode',
|
||||||
'tzKalZuk',
|
'tzKalZuk',
|
||||||
'tzTokJad',
|
'tzTokJad',
|
||||||
|
'vardorvis',
|
||||||
'venenatis',
|
'venenatis',
|
||||||
'vetion',
|
'vetion',
|
||||||
'vorkath',
|
'vorkath',
|
||||||
@@ -118,6 +134,8 @@ export const BOSSES: Boss[] = [
|
|||||||
];
|
];
|
||||||
export const ACTIVITIES: ActivityName[] = [
|
export const ACTIVITIES: ActivityName[] = [
|
||||||
'leaguePoints',
|
'leaguePoints',
|
||||||
|
'hunterBHV2',
|
||||||
|
'rogueBHV2',
|
||||||
'hunterBH',
|
'hunterBH',
|
||||||
'rogueBH',
|
'rogueBH',
|
||||||
'allClues',
|
'allClues',
|
||||||
@@ -128,7 +146,9 @@ export const ACTIVITIES: ActivityName[] = [
|
|||||||
'eliteClues',
|
'eliteClues',
|
||||||
'masterClues',
|
'masterClues',
|
||||||
'lastManStanding',
|
'lastManStanding',
|
||||||
|
'pvpArena',
|
||||||
'soulWarsZeal',
|
'soulWarsZeal',
|
||||||
|
'riftsClosed',
|
||||||
...BOSSES
|
...BOSSES
|
||||||
];
|
];
|
||||||
|
|
||||||
@@ -139,9 +159,11 @@ export type FormattedBossNames = {
|
|||||||
export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
|
export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
|
||||||
abyssalSire: 'Abyssal Sire',
|
abyssalSire: 'Abyssal Sire',
|
||||||
alchemicalHydra: 'Alchemical Hydra',
|
alchemicalHydra: 'Alchemical Hydra',
|
||||||
|
artio: 'Artio',
|
||||||
barrows: 'Barrows Chests',
|
barrows: 'Barrows Chests',
|
||||||
bryophyta: 'Bryophyta',
|
bryophyta: 'Bryophyta',
|
||||||
callisto: 'Callisto',
|
callisto: 'Callisto',
|
||||||
|
calvarion: "Calvar'ion",
|
||||||
cerberus: 'Cerberus',
|
cerberus: 'Cerberus',
|
||||||
chambersOfXeric: 'Chambers of Xeric',
|
chambersOfXeric: 'Chambers of Xeric',
|
||||||
chambersOfXericChallengeMode: 'Chambers of Xeric: Challenge Mode',
|
chambersOfXericChallengeMode: 'Chambers of Xeric: Challenge Mode',
|
||||||
@@ -154,6 +176,7 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
|
|||||||
dagannothRex: 'Dagannoth Rex',
|
dagannothRex: 'Dagannoth Rex',
|
||||||
dagannothSupreme: 'Dagannoth Supreme',
|
dagannothSupreme: 'Dagannoth Supreme',
|
||||||
derangedArchaeologist: 'Deranged Archaeologist',
|
derangedArchaeologist: 'Deranged Archaeologist',
|
||||||
|
dukeSucellus: 'Duke Sucellus',
|
||||||
generalGraardor: 'General Graardor',
|
generalGraardor: 'General Graardor',
|
||||||
giantMole: 'Giant Mole',
|
giantMole: 'Giant Mole',
|
||||||
grotesqueGuardians: 'Grotesque Guardians',
|
grotesqueGuardians: 'Grotesque Guardians',
|
||||||
@@ -164,18 +187,28 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
|
|||||||
kreeArra: "Kree'Arra",
|
kreeArra: "Kree'Arra",
|
||||||
krilTsutsaroth: "K'ril Tsutsaroth",
|
krilTsutsaroth: "K'ril Tsutsaroth",
|
||||||
mimic: 'Mimic',
|
mimic: 'Mimic',
|
||||||
|
nex: 'Nex',
|
||||||
nightmare: 'The Nightmare of Ashihama',
|
nightmare: 'The Nightmare of Ashihama',
|
||||||
|
phosanisNightmare: "Phosani's Nightmare",
|
||||||
obor: 'Obor',
|
obor: 'Obor',
|
||||||
|
phantomMuspah: 'Phantom Muspah',
|
||||||
sarachnis: 'Sarachnis',
|
sarachnis: 'Sarachnis',
|
||||||
scorpia: 'Scorpia',
|
scorpia: 'Scorpia',
|
||||||
skotizo: 'Skotizo',
|
skotizo: 'Skotizo',
|
||||||
|
spindel: 'Spindel',
|
||||||
tempoross: 'Tempoross',
|
tempoross: 'Tempoross',
|
||||||
gauntlet: 'The Gauntlet',
|
gauntlet: 'The Gauntlet',
|
||||||
corruptedGauntlet: 'The Corrupted Gauntlet',
|
corruptedGauntlet: 'The Corrupted Gauntlet',
|
||||||
|
leviathan: 'The Leviathan',
|
||||||
|
whisperer: 'The Whisperer',
|
||||||
theatreOfBlood: 'Theatre of Blood',
|
theatreOfBlood: 'Theatre of Blood',
|
||||||
|
theatreOfBloodHardMode: 'Theatre of Blood: Hard Mode',
|
||||||
thermonuclearSmokeDevil: 'Thermonuclear Smoke Devil',
|
thermonuclearSmokeDevil: 'Thermonuclear Smoke Devil',
|
||||||
|
tombsOfAmascut: 'Tombs of Amascut',
|
||||||
|
tombsOfAmascutExpertMode: 'Tombs of Amascut: Expert Mode',
|
||||||
tzKalZuk: 'TzKal-Zuk',
|
tzKalZuk: 'TzKal-Zuk',
|
||||||
tzTokJad: 'TzTok-Jad',
|
tzTokJad: 'TzTok-Jad',
|
||||||
|
vardorvis: 'Vardorvis',
|
||||||
venenatis: 'Venenatis',
|
venenatis: 'Venenatis',
|
||||||
vetion: "Vet'ion",
|
vetion: "Vet'ion",
|
||||||
vorkath: 'Vorkath',
|
vorkath: 'Vorkath',
|
||||||
@@ -234,10 +267,16 @@ export type FormattedBHNames = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
export const FORMATTED_BH_NAMES: FormattedBHNames = {
|
export const FORMATTED_BH_NAMES: FormattedBHNames = {
|
||||||
rogue: 'Bounty Hunter - Rogue',
|
rogue: 'Bounty Hunter (Legacy) - Rogue',
|
||||||
hunter: 'Bounty Hunter - Hunter'
|
hunter: 'Bounty Hunter (Legacy) - Hunter',
|
||||||
|
rogueV2: 'Bounty Hunter - Rogue',
|
||||||
|
hunterV2: 'Bounty Hunter - Hunter'
|
||||||
};
|
};
|
||||||
|
|
||||||
export const FORMATTED_LMS = 'Last Man Standing';
|
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_SOUL_WARS = 'Soul Wars Zeal';
|
||||||
export const FORMATTED_LEAGUE_POINTS = 'League Points';
|
export const FORMATTED_LEAGUE_POINTS = 'League Points';
|
||||||
|
export const FORMATTED_RIFTS_CLOSED = 'Rifts Closed';
|
||||||
|
|
||||||
|
export const INVALID_FORMAT_ERROR = 'Invalid hiscores format';
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
import axios from 'axios';
|
import axios, { AxiosRequestConfig } from 'axios';
|
||||||
import * as ua from 'useragent-generator';
|
import * as ua from 'useragent-generator';
|
||||||
import { Gamemode, SkillName, ActivityName } from '../types';
|
import { Gamemode, SkillName, ActivityName } from '../types';
|
||||||
import {
|
import {
|
||||||
@@ -96,10 +96,29 @@ export const rsnFromElement = (el: Element | null) => {
|
|||||||
* @param url URL to run a `GET` request against.
|
* @param url URL to run a `GET` request against.
|
||||||
* @returns Axios response.
|
* @returns Axios response.
|
||||||
*/
|
*/
|
||||||
export const httpGet = (url: string) =>
|
export const httpGet = <Response>(
|
||||||
axios.get(url, {
|
url: string,
|
||||||
|
config: AxiosRequestConfig = {}
|
||||||
|
) =>
|
||||||
|
axios.get<Response>(url, {
|
||||||
headers: {
|
headers: {
|
||||||
// without User-Agent header requests may be rejected by DDoS protection mechanism
|
// without User-Agent header requests may be rejected by DDoS protection mechanism
|
||||||
'User-Agent': ua.firefox(80)
|
'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');
|
||||||
|
}
|
||||||
|
};
|
||||||
|
11
tsconfig.eslint.json
Normal file
11
tsconfig.eslint.json
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "es5",
|
||||||
|
"module": "commonjs",
|
||||||
|
"declaration": true,
|
||||||
|
"outDir": "./lib",
|
||||||
|
"strict": true
|
||||||
|
},
|
||||||
|
"include": ["src", "**/__tests__/*"],
|
||||||
|
"exclude": ["node_modules"]
|
||||||
|
}
|
@@ -4,7 +4,12 @@
|
|||||||
"module": "commonjs",
|
"module": "commonjs",
|
||||||
"declaration": true,
|
"declaration": true,
|
||||||
"outDir": "./lib",
|
"outDir": "./lib",
|
||||||
"strict": true
|
"strict": true,
|
||||||
|
"lib": ["ES2015", "DOM", "DOM.Iterable"],
|
||||||
|
"typeRoots": [
|
||||||
|
"./node_modules/@types",
|
||||||
|
"./src/@types"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"include": ["src"],
|
"include": ["src"],
|
||||||
"exclude": ["node_modules", "**/__tests__/*"]
|
"exclude": ["node_modules", "**/__tests__/*"]
|
||||||
|
Reference in New Issue
Block a user