Compare commits

...

36 Commits

Author SHA1 Message Date
maxswa
c43858eac1 v2.15.0 2023-07-26 18:50:54 -04:00
Max Swartwout
0d0081f4f6 Merge pull request #81 from wpdough/main
Add new DT2 bosses
2023-07-26 18:49:03 -04:00
wpdough
3570f0f07d Update README and revert yarn.lock 2023-07-26 14:32:13 -04:00
wpdough
3ddda54e02 Merge branch 'main' of https://github.com/wpdough/osrs-json-hiscores into main 2023-07-26 14:08:46 -04:00
wpdough
388f01522a Add new DT2 bosses 2023-07-26 14:08:38 -04:00
wpdough
24b3de2a29 Add new DT2 bosses 2023-07-26 12:00:23 -04:00
maxswa
fc7897d4c7 v2.14.2 2023-07-15 20:48:08 -04:00
Max Swartwout
72ea31490f Merge pull request #80 from maxswa/update-test-lint-format-libs
Update testing, linting and formatting libraries
2023-07-13 16:40:08 -04:00
maxswa
66825955c1 Update linting and formatting libraries. 2023-07-13 16:36:37 -04:00
maxswa
4b4bf8c702 Update jest, jsdom, typescript 2023-07-13 16:16:07 -04:00
Max Swartwout
53981e7468 Merge pull request #78 from maxswa/dependabot/npm_and_yarn/semver-5.7.2
Bump semver from 5.7.1 to 5.7.2
2023-07-13 16:04:52 -04:00
dependabot[bot]
a90e5b98dd Bump semver from 5.7.1 to 5.7.2
Bumps [semver](https://github.com/npm/node-semver) from 5.7.1 to 5.7.2.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/v5.7.2/CHANGELOG.md)
- [Commits](https://github.com/npm/node-semver/compare/v5.7.1...v5.7.2)

---
updated-dependencies:
- dependency-name: semver
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-07-11 11:51:33 +00:00
maxswa
16a975f10b v2.14.1 2023-06-16 15:36:44 -04:00
Max Swartwout
c800501188 Merge pull request #77 from maxswa/axios-config
Add optional axios config argument
2023-06-16 15:36:14 -04:00
maxswa
8a320df015 Update necessary jsdoc comments. 2023-05-28 13:47:21 -04:00
maxswa
169462c446 Add optional config arg to all fns using httpGet 2023-05-28 13:42:37 -04:00
maxswa
317a972314 Add optional axios configs to GetStatsOptions 2023-05-28 13:41:53 -04:00
maxswa
c558f8402c Add optional axios config arg to httpGet 2023-05-28 13:41:02 -04:00
maxswa
41c6da4d5c v2.14.0 2023-05-26 09:40:51 -04:00
Max Swartwout
99ad5eb662 Merge pull request #76 from dmeredith96/fix-invalid-format-err
Add support for the Legacy Bounty Hunter minigame
2023-05-26 09:38:31 -04:00
David Meredith
a8cf1713af Change approach to tracking the new Bounty Hunter stats 2023-05-25 09:37:30 -05:00
David Meredith
11391c90f2 Add support for the Legacy Bounty Hunter minigame 2023-05-24 08:48:46 -05:00
maxswa
e4d2b10488 v2.13.1 2023-04-12 21:51:49 -04:00
Max Swartwout
0cfd0e2471 Merge pull request #73 from davidvorona/main
Fix spelling of Calvar'ion
2023-04-12 21:50:54 -04:00
David Vorona
9c284ad4b0 Fix spelling of Calvar'ion 2023-04-12 10:26:06 -07:00
Max Swartwout
ec60a72c08 Merge pull request #71 from maxswa/fix-gh-workflow
Update GH action versions.
2023-04-12 13:04:45 -04:00
maxswa
d45e2efcfd Update GH action versions. 2023-04-12 13:00:18 -04:00
maxswa
f80b417121 v2.13.0 2023-04-12 12:53:39 -04:00
maxswa
415fe2f02b Update np 2023-04-12 12:50:41 -04:00
Max Swartwout
968799176f Merge pull request #70 from maxswa/wilderness-boss-variants
Add wilderness boss variants.
2023-04-12 12:46:11 -04:00
maxswa
f45ae67813 Add wilderness boss variants. 2023-04-12 12:42:37 -04:00
maxswa
7724636b40 v2.12.1 2023-03-19 23:33:33 -04:00
maxswa
3954b04acc Add publishConfig to package.json 2023-03-19 23:33:03 -04:00
Max Swartwout
ee7389455c Merge pull request #68 from maxswa/add-options
Add `validateRSN`, `GetStatsOptions`
2023-03-19 23:28:34 -04:00
maxswa
54c11635e0 Add GetStatsOptions for getStats 2023-03-19 23:14:10 -04:00
maxswa
dc799cf363 Add validateRSN helper function. 2023-03-19 22:38:45 -04:00
12 changed files with 3193 additions and 3485 deletions

View File

@@ -10,19 +10,19 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: borales/actions-yarn@v2.0.0
- uses: actions/checkout@v3.3.0
- uses: borales/actions-yarn@v4.2.0
with:
cmd: install
- uses: borales/actions-yarn@v2.0.0
- uses: borales/actions-yarn@v4.2.0
with:
cmd: lint
- uses: borales/actions-yarn@v2.0.0
- uses: borales/actions-yarn@v4.2.0
with:
cmd: format
- uses: borales/actions-yarn@v2.0.0
- uses: borales/actions-yarn@v4.2.0
with:
cmd: build
- uses: borales/actions-yarn@v2.0.0
- uses: borales/actions-yarn@v4.2.0
with:
cmd: test

View File

@@ -104,14 +104,16 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
### Minigames
| Minigame | Param |
| ---------------------- | :---------------: |
| Bounty Hunter (Rogue) | `rogueBH` |
| Bounty Hunter (Hunter) | `hunterBH` |
| Last Man Standing | `lastManStanding` |
| PvP Arena | `pvpArena` |
| Soul Wars Zeal | `soulWarsZeal` |
| Rifts Closed | `riftsClosed` |
| 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` |
### Leagues
@@ -125,9 +127,11 @@ 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` |
@@ -140,6 +144,7 @@ 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` |
@@ -158,9 +163,12 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
| 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` |
@@ -168,6 +176,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
| Tombs of Amascut: Expert Mode | `tombsOfAmascutExpertMode` |
| TzKal-Zuk | `tzKalZuk` |
| TzTok-Jad | `tzTokJad` |
| Vardorvis | `vardorvis` |
| Venenatis | `venenatis` |
| Vetion | `vetion` |
| Vorkath | `vorkath` |

File diff suppressed because it is too large Load Diff

View File

@@ -12,7 +12,8 @@ import {
getSkillPageURL,
getStatsURL,
BOSSES,
INVALID_FORMAT_ERROR
INVALID_FORMAT_ERROR,
BH_MODES
} from '../src/index';
const B0ATY_NAME = 'B0ATY';
@@ -77,6 +78,8 @@ test('Parse CSV to json', () => {
810,99,37688883
92,99,32005622
23423,478
89914,35
99834,25
99831,23
89912,37
32,12148
@@ -92,9 +95,11 @@ test('Parse CSV to json', () => {
25,1110
382,2780
944,3000
704,892
1981,1452
4981,23
888,1046
444,792
613,4856
102,4038
156,334
@@ -107,6 +112,7 @@ test('Parse CSV to json', () => {
4342,1655
966,2951
10151,1
1289,2477
1288,2407
377,4669
545,1567
@@ -125,9 +131,12 @@ test('Parse CSV to json', () => {
201,1101
82,3404
5085,61
678,903
18823,23
63,375
2870,6
2871,7
2872,8
6984,138
23,923141
4043,2000
@@ -135,6 +144,7 @@ test('Parse CSV to json', () => {
289,13070
489,8
967,47
968,48
11155,223
1940,272
8623,1340
@@ -171,8 +181,10 @@ 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 },
@@ -190,9 +202,11 @@ 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 },
@@ -205,6 +219,7 @@ 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 },
@@ -223,9 +238,12 @@ test('Parse CSV to json', () => {
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 },
@@ -233,6 +251,7 @@ test('Parse CSV to json', () => {
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 },
@@ -469,7 +488,7 @@ test('Get non-existent player', async () => {
});
test('Get stats by gamemode', async () => {
const { skills, bosses } = await getStatsByGamemode(
const { skills, bosses, bountyHunter } = await getStatsByGamemode(
LYNX_TITAN_FORMATTED_NAME
);
@@ -502,6 +521,55 @@ 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(2);
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();
});
});

View File

@@ -9,7 +9,7 @@
<!--<![endif]-->
<head>
<link
href="https://www.runescape.com/css/rsp777_basic-104.css"
href="https://www.runescape.com/a=135/css/rsp777_basic-104.css"
rel="stylesheet"
type="text/css"
media="all"
@@ -51,7 +51,7 @@
data-blockingmode="auto"
></script>
<script
src="https://www.runescape.com/js/c/responsive/vendor-151.js"
src="https://www.runescape.com/a=135/js/c/responsive/vendor-151.js"
data-cookieconsent="ignore"
></script>
<title>Old School Hiscores</title>
@@ -86,7 +86,7 @@
property="og:image"
content="https://www.runescape.com/img/rsp777/social-share-fb.jpg?1"
/>
<meta property="og:url" content="https://www.runescape.com" />
<meta property="og:url" content="https://www.runescape.com/a=135" />
<meta
property="og:description"
content="If you're a RuneScape veteran hungry for nostalgia, get stuck right in to Old School RuneScape. Sign up for membership and re-live the adventure."
@@ -102,7 +102,7 @@
/>
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:domain" content="Oldschool.RuneScape.com" />
<meta name="twitter:url" content="https://www.runescape.com" />
<meta name="twitter:url" content="https://www.runescape.com/a=135" />
<meta name="twitter:title" content="Old School Hiscores" />
<meta
name="twitter:description"
@@ -118,7 +118,7 @@
content="pUwl5KYHKSZ6tbbgsR2wYNv1kbVmsYral3iFmijHTWM"
/>
<link
href="https://www.runescape.com/css/rsp777_hiscore-108.css"
href="https://www.runescape.com/a=135/css/rsp777_hiscore-108.css"
rel="stylesheet"
type="text/css"
media="all"
@@ -136,6 +136,14 @@
content: url('https://www.runescape.com/img/rsp777/game_icon_bountyhunterrogue.png?2');
}
.bountyhunterlegacyhunter:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_bountyhunterlegacyhunter.png?2');
}
.bountyhunterlegacyrogue:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_bountyhunterlegacyrogue.png?2');
}
.cluescrollsall:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_cluescrollsall.png?2');
}
@@ -188,6 +196,10 @@
content: url('https://www.runescape.com/img/rsp777/game_icon_alchemicalhydra.png?2');
}
.artio:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_artio.png?2');
}
.barrowschests:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_barrowschests.png?2');
}
@@ -200,6 +212,10 @@
content: url('https://www.runescape.com/img/rsp777/game_icon_callisto.png?2');
}
.calvarion:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_calvarion.png?2');
}
.cerberus:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_cerberus.png?2');
}
@@ -304,6 +320,10 @@
content: url('https://www.runescape.com/img/rsp777/game_icon_obor.png?2');
}
.phantommuspah:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_phantommuspah.png?2');
}
.sarachnis:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_sarachnis.png?2');
}
@@ -316,6 +336,10 @@
content: url('https://www.runescape.com/img/rsp777/game_icon_skotizo.png?2');
}
.spindel:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_spindel.png?2');
}
.tempoross:before {
content: url('https://www.runescape.com/img/rsp777/game_icon_tempoross.png?2');
}
@@ -387,7 +411,7 @@
<span style="float: right"
><a
id="loginLink"
href="https://secure.runescape.com/m=weblogin/loginform?theme=oldschool&mod=hiscore_oldschool&amp;ssl=1&amp;dest=overall.ws?table=0&amp;user=lYnX%20tiTAn"
href="https://secure.runescape.com/m=weblogin/a=135/loginform?theme=oldschool&mod=hiscore_oldschool&amp;ssl=1&amp;dest=overall.ws?table=0&amp;user=lynx%20titan"
>Log in</a
></span
>
@@ -396,7 +420,7 @@
<div class="hiscoretitlebground">
<div class="hiscoretitleframe">
<strong>Old School Hiscores</strong><br />
<a href="https://oldschool.runescape.com/">Home</a>
<a href="https://oldschool.runescape.com/a=135/">Home</a>
</div>
</div>
<br />
@@ -412,17 +436,17 @@
<div class="ironman-nav__submenu">
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_ironman/"
href="https://secure.runescape.com/m=hiscore_oldschool_ironman/a=135/"
>Ironman</a
>
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_ultimate/"
href="https://secure.runescape.com/m=hiscore_oldschool_ultimate/a=135/"
>Ultimate Ironman</a
>
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_hardcore_ironman/"
href="https://secure.runescape.com/m=hiscore_oldschool_hardcore_ironman/a=135/"
>Hardcore Ironman</a
>
</div>
@@ -434,17 +458,17 @@
<div class="ironman-nav__submenu">
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_deadman/"
href="https://secure.runescape.com/m=hiscore_oldschool_deadman/a=135/"
>Deadman Mode</a
>
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_seasonal/"
href="https://secure.runescape.com/m=hiscore_oldschool_seasonal/a=135/"
>Leagues</a
>
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_tournament/"
href="https://secure.runescape.com/m=hiscore_oldschool_tournament/a=135/"
>Tournament</a
>
</div>
@@ -456,12 +480,12 @@
<div class="ironman-nav__submenu">
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_ironman/group-ironman/"
href="https://secure.runescape.com/m=hiscore_oldschool_ironman/a=135/group-ironman/"
>Group Ironman</a
>
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_hardcore_ironman/group-ironman/"
href="https://secure.runescape.com/m=hiscore_oldschool_hardcore_ironman/a=135/group-ironman/"
>Hardcore Group Ironman</a
>
</div>
@@ -469,11 +493,28 @@
<div class="ironman-nav__group">
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_fresh_start/"
href="https://secure.runescape.com/m=hiscore_oldschool_fresh_start/a=135/"
>
Fresh Start Worlds
</a>
</div>
<div class="ironman-nav__group">
<a class="ironman-nav__option ironman-nav__option--parent">
Account Builds
</a>
<div class="ironman-nav__submenu">
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_skiller/a=135/"
>Skillers</a
>
<a
class="ironman-nav__option"
href="https://secure.runescape.com/m=hiscore_oldschool_skiller_defence/a=135/"
>1 Defence</a
>
</div>
</div>
</div>
<div class="personal-hiscores">
<nav class="personal-hiscores__side-banner">
@@ -486,393 +527,423 @@
>Up</a
>
<div id="contentCategory">
<a href="overall?table=0&user=lYnX tiTAn" class="Overall">
<a href="overall?table=0&user=lynx titan" class="Overall">
Overall
</a>
<a href="overall?table=1&user=lYnX tiTAn" class="Attack">
<a href="overall?table=1&user=lynx titan" class="Attack">
Attack
</a>
<a href="overall?table=2&user=lYnX tiTAn" class="Defence">
<a href="overall?table=2&user=lynx titan" class="Defence">
Defence
</a>
<a href="overall?table=3&user=lYnX tiTAn" class="Strength">
<a href="overall?table=3&user=lynx titan" class="Strength">
Strength
</a>
<a href="overall?table=4&user=lYnX tiTAn" class="Hitpoints">
<a href="overall?table=4&user=lynx titan" class="Hitpoints">
Hitpoints
</a>
<a href="overall?table=5&user=lYnX tiTAn" class="Ranged">
<a href="overall?table=5&user=lynx titan" class="Ranged">
Ranged
</a>
<a href="overall?table=6&user=lYnX tiTAn" class="Prayer">
<a href="overall?table=6&user=lynx titan" class="Prayer">
Prayer
</a>
<a href="overall?table=7&user=lYnX tiTAn" class="Magic">
<a href="overall?table=7&user=lynx titan" class="Magic">
Magic
</a>
<a href="overall?table=8&user=lYnX tiTAn" class="Cooking">
<a href="overall?table=8&user=lynx titan" class="Cooking">
Cooking
</a>
<a href="overall?table=9&user=lYnX tiTAn" class="Woodcutting">
<a href="overall?table=9&user=lynx titan" class="Woodcutting">
Woodcutting
</a>
<a href="overall?table=10&user=lYnX tiTAn" class="Fletching">
<a href="overall?table=10&user=lynx titan" class="Fletching">
Fletching
</a>
<a href="overall?table=11&user=lYnX tiTAn" class="Fishing">
<a href="overall?table=11&user=lynx titan" class="Fishing">
Fishing
</a>
<a href="overall?table=12&user=lYnX tiTAn" class="Firemaking">
<a href="overall?table=12&user=lynx titan" class="Firemaking">
Firemaking
</a>
<a href="overall?table=13&user=lYnX tiTAn" class="Crafting">
<a href="overall?table=13&user=lynx titan" class="Crafting">
Crafting
</a>
<a href="overall?table=14&user=lYnX tiTAn" class="Smithing">
<a href="overall?table=14&user=lynx titan" class="Smithing">
Smithing
</a>
<a href="overall?table=15&user=lYnX tiTAn" class="Mining">
<a href="overall?table=15&user=lynx titan" class="Mining">
Mining
</a>
<a href="overall?table=16&user=lYnX tiTAn" class="Herblore">
<a href="overall?table=16&user=lynx titan" class="Herblore">
Herblore
</a>
<a href="overall?table=17&user=lYnX tiTAn" class="Agility">
<a href="overall?table=17&user=lynx titan" class="Agility">
Agility
</a>
<a href="overall?table=18&user=lYnX tiTAn" class="Thieving">
<a href="overall?table=18&user=lynx titan" class="Thieving">
Thieving
</a>
<a href="overall?table=19&user=lYnX tiTAn" class="Slayer">
<a href="overall?table=19&user=lynx titan" class="Slayer">
Slayer
</a>
<a href="overall?table=20&user=lYnX tiTAn" class="Farming">
<a href="overall?table=20&user=lynx titan" class="Farming">
Farming
</a>
<a href="overall?table=21&user=lYnX tiTAn" class="Runecraft">
<a href="overall?table=21&user=lynx titan" class="Runecraft">
Runecraft
</a>
<a href="overall?table=22&user=lYnX tiTAn" class="Hunter">
<a href="overall?table=22&user=lynx titan" class="Hunter">
Hunter
</a>
<a href="overall?table=23&user=lYnX tiTAn" class="Construction">
<a href="overall?table=23&user=lynx titan" class="Construction">
Construction
</a>
<span style="color: #d9c27e; display: block; text-align: center"
>----</span
>
<a
href="overall?category_type=1&table=1&user=lYnX tiTAn"
href="overall?category_type=1&table=1&user=lynx titan"
class="activity-link bountyhunterhunter"
>Bounty Hunter - Hunter</a
>
<a
href="overall?category_type=1&table=2&user=lYnX tiTAn"
href="overall?category_type=1&table=2&user=lynx titan"
class="activity-link bountyhunterrogue"
>Bounty Hunter - Rogue</a
>
<a
href="overall?category_type=1&table=3&user=lYnX tiTAn"
href="overall?category_type=1&table=3&user=lynx titan"
class="activity-link bountyhunterlegacyhunter"
>Bounty Hunter (Legacy) - Hunter</a
>
<a
href="overall?category_type=1&table=4&user=lynx titan"
class="activity-link bountyhunterlegacyrogue"
>Bounty Hunter (Legacy) - Rogue</a
>
<a
href="overall?category_type=1&table=5&user=lynx titan"
class="activity-link cluescrollsall"
>Clue Scrolls (all)</a
>
<a
href="overall?category_type=1&table=4&user=lYnX tiTAn"
href="overall?category_type=1&table=6&user=lynx titan"
class="activity-link cluescrollsbeginner"
>Clue Scrolls (beginner)</a
>
<a
href="overall?category_type=1&table=5&user=lYnX tiTAn"
href="overall?category_type=1&table=7&user=lynx titan"
class="activity-link cluescrollseasy"
>Clue Scrolls (easy)</a
>
<a
href="overall?category_type=1&table=6&user=lYnX tiTAn"
href="overall?category_type=1&table=8&user=lynx titan"
class="activity-link cluescrollsmedium"
>Clue Scrolls (medium)</a
>
<a
href="overall?category_type=1&table=7&user=lYnX tiTAn"
href="overall?category_type=1&table=9&user=lynx titan"
class="activity-link cluescrollshard"
>Clue Scrolls (hard)</a
>
<a
href="overall?category_type=1&table=8&user=lYnX tiTAn"
href="overall?category_type=1&table=10&user=lynx titan"
class="activity-link cluescrollselite"
>Clue Scrolls (elite)</a
>
<a
href="overall?category_type=1&table=9&user=lYnX tiTAn"
href="overall?category_type=1&table=11&user=lynx titan"
class="activity-link cluescrollsmaster"
>Clue Scrolls (master)</a
>
<a
href="overall?category_type=1&table=10&user=lYnX tiTAn"
href="overall?category_type=1&table=12&user=lynx titan"
class="activity-link lmsrank"
>LMS - Rank</a
>
<a
href="overall?category_type=1&table=11&user=lYnX tiTAn"
href="overall?category_type=1&table=13&user=lynx titan"
class="activity-link pvparenarank"
>PvP Arena - Rank</a
>
<a
href="overall?category_type=1&table=12&user=lYnX tiTAn"
href="overall?category_type=1&table=14&user=lynx titan"
class="activity-link soulwarszeal"
>Soul Wars Zeal</a
>
<a
href="overall?category_type=1&table=13&user=lYnX tiTAn"
href="overall?category_type=1&table=15&user=lynx titan"
class="activity-link riftsclosed"
>Rifts closed</a
>
<a
href="overall?category_type=1&table=14&user=lYnX tiTAn"
href="overall?category_type=1&table=16&user=lynx titan"
class="activity-link abyssalsire"
>Abyssal Sire</a
>
<a
href="overall?category_type=1&table=15&user=lYnX tiTAn"
href="overall?category_type=1&table=17&user=lynx titan"
class="activity-link alchemicalhydra"
>Alchemical Hydra</a
>
<a
href="overall?category_type=1&table=16&user=lYnX tiTAn"
href="overall?category_type=1&table=18&user=lynx titan"
class="activity-link artio"
>Artio</a
>
<a
href="overall?category_type=1&table=19&user=lynx titan"
class="activity-link barrowschests"
>Barrows Chests</a
>
<a
href="overall?category_type=1&table=17&user=lYnX tiTAn"
href="overall?category_type=1&table=20&user=lynx titan"
class="activity-link bryophyta"
>Bryophyta</a
>
<a
href="overall?category_type=1&table=18&user=lYnX tiTAn"
href="overall?category_type=1&table=21&user=lynx titan"
class="activity-link callisto"
>Callisto</a
>
<a
href="overall?category_type=1&table=19&user=lYnX tiTAn"
href="overall?category_type=1&table=22&user=lynx titan"
class="activity-link calvarion"
>Calvar'ion</a
>
<a
href="overall?category_type=1&table=23&user=lynx titan"
class="activity-link cerberus"
>Cerberus</a
>
<a
href="overall?category_type=1&table=20&user=lYnX tiTAn"
href="overall?category_type=1&table=24&user=lynx titan"
class="activity-link chambersofxeric"
>Chambers of Xeric</a
>
<a
href="overall?category_type=1&table=21&user=lYnX tiTAn"
href="overall?category_type=1&table=25&user=lynx titan"
class="activity-link chambersofxericchallengemode"
>Chambers of Xeric: Challenge Mode</a
>
<a
href="overall?category_type=1&table=22&user=lYnX tiTAn"
href="overall?category_type=1&table=26&user=lynx titan"
class="activity-link chaoselemental"
>Chaos Elemental</a
>
<a
href="overall?category_type=1&table=23&user=lYnX tiTAn"
href="overall?category_type=1&table=27&user=lynx titan"
class="activity-link chaosfanatic"
>Chaos Fanatic</a
>
<a
href="overall?category_type=1&table=24&user=lYnX tiTAn"
href="overall?category_type=1&table=28&user=lynx titan"
class="activity-link commanderzilyana"
>Commander Zilyana</a
>
<a
href="overall?category_type=1&table=25&user=lYnX tiTAn"
href="overall?category_type=1&table=29&user=lynx titan"
class="activity-link corporealbeast"
>Corporeal Beast</a
>
<a
href="overall?category_type=1&table=26&user=lYnX tiTAn"
href="overall?category_type=1&table=30&user=lynx titan"
class="activity-link crazyarchaeologist"
>Crazy Archaeologist</a
>
<a
href="overall?category_type=1&table=27&user=lYnX tiTAn"
href="overall?category_type=1&table=31&user=lynx titan"
class="activity-link dagannothprime"
>Dagannoth Prime</a
>
<a
href="overall?category_type=1&table=28&user=lYnX tiTAn"
href="overall?category_type=1&table=32&user=lynx titan"
class="activity-link dagannothrex"
>Dagannoth Rex</a
>
<a
href="overall?category_type=1&table=29&user=lYnX tiTAn"
href="overall?category_type=1&table=33&user=lynx titan"
class="activity-link dagannothsupreme"
>Dagannoth Supreme</a
>
<a
href="overall?category_type=1&table=30&user=lYnX tiTAn"
href="overall?category_type=1&table=34&user=lynx titan"
class="activity-link derangedarchaeologist"
>Deranged Archaeologist</a
>
<a
href="overall?category_type=1&table=31&user=lYnX tiTAn"
href="overall?category_type=1&table=35&user=lynx titan"
class="activity-link generalgraardor"
>General Graardor</a
>
<a
href="overall?category_type=1&table=32&user=lYnX tiTAn"
href="overall?category_type=1&table=36&user=lynx titan"
class="activity-link giantmole"
>Giant Mole</a
>
<a
href="overall?category_type=1&table=33&user=lYnX tiTAn"
href="overall?category_type=1&table=37&user=lynx titan"
class="activity-link grotesqueguardians"
>Grotesque Guardians</a
>
<a
href="overall?category_type=1&table=34&user=lYnX tiTAn"
href="overall?category_type=1&table=38&user=lynx titan"
class="activity-link hespori"
>Hespori</a
>
<a
href="overall?category_type=1&table=35&user=lYnX tiTAn"
href="overall?category_type=1&table=39&user=lynx titan"
class="activity-link kalphitequeen"
>Kalphite Queen</a
>
<a
href="overall?category_type=1&table=36&user=lYnX tiTAn"
href="overall?category_type=1&table=40&user=lynx titan"
class="activity-link kingblackdragon"
>King Black Dragon</a
>
<a
href="overall?category_type=1&table=37&user=lYnX tiTAn"
href="overall?category_type=1&table=41&user=lynx titan"
class="activity-link kraken"
>Kraken</a
>
<a
href="overall?category_type=1&table=38&user=lYnX tiTAn"
href="overall?category_type=1&table=42&user=lynx titan"
class="activity-link kreearra"
>Kree'Arra</a
>
<a
href="overall?category_type=1&table=39&user=lYnX tiTAn"
href="overall?category_type=1&table=43&user=lynx titan"
class="activity-link kriltsutsaroth"
>K'ril Tsutsaroth</a
>
<a
href="overall?category_type=1&table=40&user=lYnX tiTAn"
href="overall?category_type=1&table=44&user=lynx titan"
class="activity-link mimic"
>Mimic</a
>
<a
href="overall?category_type=1&table=41&user=lYnX tiTAn"
href="overall?category_type=1&table=45&user=lynx titan"
class="activity-link nex"
>Nex</a
>
<a
href="overall?category_type=1&table=42&user=lYnX tiTAn"
href="overall?category_type=1&table=46&user=lynx titan"
class="activity-link nightmare"
>Nightmare</a
>
<a
href="overall?category_type=1&table=43&user=lYnX tiTAn"
href="overall?category_type=1&table=47&user=lynx titan"
class="activity-link phosanisnightmare"
>Phosani's Nightmare</a
>
<a
href="overall?category_type=1&table=44&user=lYnX tiTAn"
href="overall?category_type=1&table=48&user=lynx titan"
class="activity-link obor"
>Obor</a
>
<a
href="overall?category_type=1&table=45&user=lYnX tiTAn"
href="overall?category_type=1&table=49&user=lynx titan"
class="activity-link phantommuspah"
>Phantom Muspah</a
>
<a
href="overall?category_type=1&table=50&user=lynx titan"
class="activity-link sarachnis"
>Sarachnis</a
>
<a
href="overall?category_type=1&table=46&user=lYnX tiTAn"
href="overall?category_type=1&table=51&user=lynx titan"
class="activity-link scorpia"
>Scorpia</a
>
<a
href="overall?category_type=1&table=47&user=lYnX tiTAn"
href="overall?category_type=1&table=52&user=lynx titan"
class="activity-link skotizo"
>Skotizo</a
>
<a
href="overall?category_type=1&table=48&user=lYnX tiTAn"
href="overall?category_type=1&table=53&user=lynx titan"
class="activity-link spindel"
>Spindel</a
>
<a
href="overall?category_type=1&table=54&user=lynx titan"
class="activity-link tempoross"
>Tempoross</a
>
<a
href="overall?category_type=1&table=49&user=lYnX tiTAn"
href="overall?category_type=1&table=55&user=lynx titan"
class="activity-link thegauntlet"
>The Gauntlet</a
>
<a
href="overall?category_type=1&table=50&user=lYnX tiTAn"
href="overall?category_type=1&table=56&user=lynx titan"
class="activity-link thecorruptedgauntlet"
>The Corrupted Gauntlet</a
>
<a
href="overall?category_type=1&table=51&user=lYnX tiTAn"
href="overall?category_type=1&table=57&user=lynx titan"
class="activity-link theatreofblood"
>Theatre of Blood</a
>
<a
href="overall?category_type=1&table=52&user=lYnX tiTAn"
href="overall?category_type=1&table=58&user=lynx titan"
class="activity-link theatreofbloodhardmode"
>Theatre of Blood: Hard Mode</a
>
<a
href="overall?category_type=1&table=53&user=lYnX tiTAn"
href="overall?category_type=1&table=59&user=lynx titan"
class="activity-link thermonuclearsmokedevil"
>Thermonuclear Smoke Devil</a
>
<a
href="overall?category_type=1&table=54&user=lYnX tiTAn"
href="overall?category_type=1&table=60&user=lynx titan"
class="activity-link tombsofamascut"
>Tombs of Amascut</a
>
<a
href="overall?category_type=1&table=55&user=lYnX tiTAn"
href="overall?category_type=1&table=61&user=lynx titan"
class="activity-link tombsofamascutexpertmode"
>Tombs of Amascut: Expert Mode</a
>
<a
href="overall?category_type=1&table=56&user=lYnX tiTAn"
href="overall?category_type=1&table=62&user=lynx titan"
class="activity-link tzkalzuk"
>TzKal-Zuk</a
>
<a
href="overall?category_type=1&table=57&user=lYnX tiTAn"
href="overall?category_type=1&table=63&user=lynx titan"
class="activity-link tztokjad"
>TzTok-Jad</a
>
<a
href="overall?category_type=1&table=58&user=lYnX tiTAn"
href="overall?category_type=1&table=64&user=lynx titan"
class="activity-link venenatis"
>Venenatis</a
>
<a
href="overall?category_type=1&table=59&user=lYnX tiTAn"
href="overall?category_type=1&table=65&user=lynx titan"
class="activity-link vetion"
>Vet'ion</a
>
<a
href="overall?category_type=1&table=60&user=lYnX tiTAn"
href="overall?category_type=1&table=66&user=lynx titan"
class="activity-link vorkath"
>Vorkath</a
>
<a
href="overall?category_type=1&table=61&user=lYnX tiTAn"
href="overall?category_type=1&table=67&user=lynx titan"
class="activity-link wintertodt"
>Wintertodt</a
>
<a
href="overall?category_type=1&table=62&user=lYnX tiTAn"
href="overall?category_type=1&table=68&user=lynx titan"
class="activity-link zalcano"
>Zalcano</a
>
<a
href="overall?category_type=1&table=63&user=lYnX tiTAn"
href="overall?category_type=1&table=69&user=lynx titan"
class="activity-link zulrah"
>Zulrah</a
>
@@ -1190,7 +1261,7 @@
</div>
</form>
<form
action="https://secure.runescape.com/m=hiscore_oldschool/compare"
action="https://secure.runescape.com/m=hiscore_oldschool/a=135/compare"
method="post"
class="compareForm"
>
@@ -1229,7 +1300,7 @@
yourself to your friends<br />
</div>
<a
href="https://secure.runescape.com/m=weblogin/oldschool_login?mod=hiscore_oldschool&amp;ssl=0&amp;dest=hiscorefriends_all"
href="https://secure.runescape.com/m=weblogin/a=135/oldschool_login?mod=hiscore_oldschool&amp;ssl=0&amp;dest=hiscorefriends_all"
class="linkToFriends"
>Click here</a
>
@@ -1246,7 +1317,7 @@
alt="Jagex Software"
/></a>
<p class="tandc__copy">
This website and its contents are copyright &copy; 1999 - 2022 Jagex
This website and its contents are copyright &copy; 1999 - 2023 Jagex
Ltd, 220 Science Park, Cambridge, CB4 0WA, United Kingdom.<br />Use of
this website is subject to our
<a href="https://www.jagex.com/en-GB/terms/terms.ws" target="_blank"
@@ -1269,16 +1340,16 @@
<a
class="osrsRSS"
target="_BLANK"
href="https://secure.runescape.com/m=news/latest_news.rss?oldschool=true"
href="https://secure.runescape.com/m=news/a=135/latest_news.rss?oldschool=true"
><img
src="https://www.runescape.com/img/rsp777/rss.png"
title="OSRS RSS Feed"
alt="OSRS RSS Feed"
/></a>
</div>
<script src="https://www.runescape.com/js/c/rs3/modernizr_3_0_0_min-100.js"></script>
<script src="https://www.runescape.com/js/rsp777_basic-105.js"></script>
<script src="https://www.runescape.com/js/rsp777_twitter-100.js"></script>
<script src="https://www.runescape.com/a=135/js/c/rs3/modernizr_3_0_0_min-100.js"></script>
<script src="https://www.runescape.com/a=135/js/rsp777_basic-105.js"></script>
<script src="https://www.runescape.com/a=135/js/rsp777_twitter-100.js"></script>
<script type="text/javascript">
if ($('#fb-root').length == 0) {
@@ -1313,7 +1384,7 @@
_target
) {
$.getJSON(
'https://secure.runescape.com/m=sn-integration/checkLogin.ws?json=?',
'https://secure.runescape.com/m=sn-integration/a=135/checkLogin.ws?json=?',
{
tps: 0,
token: FB.getAuthResponse().accessToken,
@@ -1369,7 +1440,7 @@
</script>
<script
type="text/javascript"
src="https://www.runescape.com/js/rs3/plugins-100.js"
src="https://www.runescape.com/a=135/js/rs3/plugins-100.js"
data-cookieconsent="ignore"
></script>
<script>
@@ -1383,7 +1454,7 @@
</script>
<script
type="text/javascript"
src="https://www.runescape.com/js/osrs/gtm-100.js"
src="https://www.runescape.com/a=135/js/osrs/gtm-100.js"
data-cookieconsent="ignore"
></script>
</div>

View File

@@ -6,7 +6,7 @@
8,99,200000000
11,99,200000000
32,99,200000000
159,99,200000000
157,99,200000000
15,99,200000000
12,99,200000000
9,99,200000000
@@ -15,7 +15,7 @@
3,99,200000000
25,99,200000000
5,99,200000000
23,99,200000000
24,99,200000000
12,99,200000000
2,99,200000000
19,99,200000000
@@ -27,9 +27,11 @@
-1,-1
-1,-1
-1,-1
764013,22
-1,-1
-1,-1
347584,22
-1,-1
480246,22
-1,-1
-1,-1
-1,-1
@@ -86,4 +88,11 @@
-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.

View File

@@ -1,6 +1,6 @@
{
"name": "osrs-json-hiscores",
"version": "2.12.0",
"version": "2.15.0",
"description": "The Old School Runescape API wrapper that does more!",
"main": "lib/index.js",
"types": "lib/index.d.ts",
@@ -30,6 +30,9 @@
"stats",
"skills"
],
"publishConfig": {
"registry": "https://registry.npmjs.org"
},
"author": "maxswa",
"license": "ISC",
"bugs": {
@@ -58,7 +61,8 @@
"@typescript-eslint"
],
"extends": [
"eslint-config-airbnb-typescript",
"airbnb-base",
"airbnb-typescript/base",
"prettier"
],
"ignorePatterns": [
@@ -69,7 +73,8 @@
"trailingComma": "none",
"tabWidth": 2,
"semi": true,
"singleQuote": true
"singleQuote": true,
"endOfLine": "auto"
},
"jest": {
"transform": {
@@ -88,27 +93,24 @@
},
"dependencies": {
"axios": "^0.21.1",
"jsdom": "^16.3.0",
"jsdom": "^22.1.0",
"useragent-generator": "^1.1.0"
},
"devDependencies": {
"@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",
"@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",
"husky": "^5.2.0",
"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"
"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"
}
}

View File

@@ -1,4 +1,5 @@
import { JSDOM } from 'jsdom';
import { AxiosRequestConfig, AxiosResponse } from 'axios';
import { BinaryData, JSDOM } from 'jsdom';
import {
Player,
Activity,
@@ -12,7 +13,8 @@ import {
PlayerSkillRow,
ActivityName,
PlayerActivityRow,
Bosses
Bosses,
GetStatsOptions
} from './types';
import {
getStatsURL,
@@ -28,27 +30,29 @@ import {
getActivityPageURL,
httpGet,
BOSSES,
INVALID_FORMAT_ERROR
INVALID_FORMAT_ERROR,
validateRSN
} 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): 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');
}
export async function getRSNFormat(
rsn: string,
config?: AxiosRequestConfig
): Promise<string> {
validateRSN(rsn);
const url = getPlayerTableURL('main', rsn);
try {
const response = await httpGet(url);
const response = await httpGet<string | Buffer | BinaryData | undefined>(
url,
config
);
const dom = new JSDOM(response.data);
const anchor = dom.window.document.querySelector(
'.personal-hiscores__row.personal-hiscores__row--type-highlight a'
@@ -107,12 +111,8 @@ 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, pvpArena, soulWarsZeal, riftsClosed] =
activityObjects.splice(0, 4);
const bossObjects = activityObjects.splice(0, BOSSES.length);
const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
@@ -163,25 +163,44 @@ export function parseStats(csv: string): Stats {
* @param rsn Username of the player.
* @returns Player object.
*/
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');
}
export async function getStats(
rsn: string,
options?: GetStatsOptions
): Promise<Player> {
validateRSN(rsn);
const otherGamemodes = options?.otherGamemodes ?? [
'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) {
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 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 player: Player = {
name: formattedName ?? rsn,
@@ -192,8 +211,11 @@ export async function getStats(rsn: string): Promise<Player> {
};
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);
@@ -245,22 +267,19 @@ export async function getStats(rsn: string): Promise<Player> {
*
* @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'
mode: Gamemode = 'main',
config?: AxiosRequestConfig
): Promise<Stats> {
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)) {
validateRSN(rsn);
if (!GAMEMODES.includes(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) {
throw Error('Player not found');
}
@@ -272,7 +291,8 @@ export async function getStatsByGamemode(
export async function getSkillPage(
skill: SkillName,
mode: Gamemode = 'main',
page: number = 1
page: number = 1,
config?: AxiosRequestConfig
): Promise<PlayerSkillRow[]> {
if (!GAMEMODES.includes(mode)) {
throw Error('Invalid game mode');
@@ -283,7 +303,10 @@ export async function getSkillPage(
}
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 playersHTML = dom.window.document.querySelectorAll(
'.personal-hiscores__row'
@@ -315,12 +338,14 @@ 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
page: number = 1,
config?: AxiosRequestConfig
): Promise<PlayerActivityRow[]> {
if (!GAMEMODES.includes(mode)) {
throw Error('Invalid game mode');
@@ -331,7 +356,10 @@ export async function getActivityPage(
}
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 playersHTML = dom.window.document.querySelectorAll(
'.personal-hiscores__row'

View File

@@ -1,3 +1,5 @@
import { AxiosRequestConfig } from 'axios';
export type Gamemode =
| 'main'
| 'ironman'
@@ -60,16 +62,18 @@ export type ClueType =
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 Boss =
| 'abyssalSire'
| 'alchemicalHydra'
| 'artio'
| 'barrows'
| 'bryophyta'
| 'callisto'
| 'calvarion'
| 'cerberus'
| 'chambersOfXeric'
| 'chambersOfXericChallengeMode'
@@ -82,6 +86,7 @@ export type Boss =
| 'dagannothRex'
| 'dagannothSupreme'
| 'derangedArchaeologist'
| 'dukeSucellus'
| 'generalGraardor'
| 'giantMole'
| 'grotesqueGuardians'
@@ -100,9 +105,12 @@ export type Boss =
| 'sarachnis'
| 'scorpia'
| 'skotizo'
| 'spindel'
| 'tempoross'
| 'gauntlet'
| 'corruptedGauntlet'
| 'leviathan'
| 'whisperer'
| 'theatreOfBlood'
| 'theatreOfBloodHardMode'
| 'thermonuclearSmokeDevil'
@@ -110,6 +118,7 @@ export type Boss =
| 'tombsOfAmascutExpertMode'
| 'tzKalZuk'
| 'tzTokJad'
| 'vardorvis'
| 'venenatis'
| 'vetion'
| 'vorkath'
@@ -121,6 +130,8 @@ export type Bosses = { [Type in Boss]: Activity };
export type ActivityName =
| 'leaguePoints'
| 'hunterBHV2'
| 'rogueBHV2'
| 'hunterBH'
| 'rogueBH'
| 'lastManStanding'
@@ -166,3 +177,25 @@ 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;
};
}

View File

@@ -62,7 +62,7 @@ export const CLUES: ClueType[] = [
'elite',
'master'
];
export const BH_MODES: BHType[] = ['hunter', 'rogue'];
export const BH_MODES: BHType[] = ['hunterV2', 'rogueV2', 'hunter', 'rogue'];
export const GAMEMODES: Gamemode[] = [
'main',
'ironman',
@@ -75,9 +75,11 @@ export const GAMEMODES: Gamemode[] = [
export const BOSSES: Boss[] = [
'abyssalSire',
'alchemicalHydra',
'artio',
'barrows',
'bryophyta',
'callisto',
'calvarion',
'cerberus',
'chambersOfXeric',
'chambersOfXericChallengeMode',
@@ -90,6 +92,7 @@ export const BOSSES: Boss[] = [
'dagannothRex',
'dagannothSupreme',
'derangedArchaeologist',
'dukeSucellus',
'generalGraardor',
'giantMole',
'grotesqueGuardians',
@@ -108,9 +111,12 @@ export const BOSSES: Boss[] = [
'sarachnis',
'scorpia',
'skotizo',
'spindel',
'tempoross',
'gauntlet',
'corruptedGauntlet',
'leviathan',
'whisperer',
'theatreOfBlood',
'theatreOfBloodHardMode',
'thermonuclearSmokeDevil',
@@ -118,6 +124,7 @@ export const BOSSES: Boss[] = [
'tombsOfAmascutExpertMode',
'tzKalZuk',
'tzTokJad',
'vardorvis',
'venenatis',
'vetion',
'vorkath',
@@ -127,6 +134,8 @@ export const BOSSES: Boss[] = [
];
export const ACTIVITIES: ActivityName[] = [
'leaguePoints',
'hunterBHV2',
'rogueBHV2',
'hunterBH',
'rogueBH',
'allClues',
@@ -150,9 +159,11 @@ 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',
@@ -165,6 +176,7 @@ 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',
@@ -183,9 +195,12 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
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',
@@ -193,6 +208,7 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
tombsOfAmascutExpertMode: 'Tombs of Amascut: Expert Mode',
tzKalZuk: 'TzKal-Zuk',
tzTokJad: 'TzTok-Jad',
vardorvis: 'Vardorvis',
venenatis: 'Venenatis',
vetion: "Vet'ion",
vorkath: 'Vorkath',
@@ -251,8 +267,10 @@ export type FormattedBHNames = {
};
export const FORMATTED_BH_NAMES: FormattedBHNames = {
rogue: 'Bounty Hunter - Rogue',
hunter: 'Bounty Hunter - Hunter'
rogue: 'Bounty Hunter (Legacy) - Rogue',
hunter: 'Bounty Hunter (Legacy) - Hunter',
rogueV2: 'Bounty Hunter - Rogue',
hunterV2: 'Bounty Hunter - Hunter'
};
export const FORMATTED_LMS = 'Last Man Standing';

View File

@@ -1,4 +1,4 @@
import axios from 'axios';
import axios, { AxiosRequestConfig } from 'axios';
import * as ua from 'useragent-generator';
import { Gamemode, SkillName, ActivityName } from '../types';
import {
@@ -96,10 +96,29 @@ export const rsnFromElement = (el: Element | null) => {
* @param url URL to run a `GET` request against.
* @returns Axios response.
*/
export const httpGet = (url: string) =>
axios.get(url, {
export const httpGet = <Response>(
url: string,
config: AxiosRequestConfig = {}
) =>
axios.get<Response>(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');
}
};

5388
yarn.lock

File diff suppressed because it is too large Load Diff