Update necessary jsdoc comments.

Add support for the Legacy Bounty Hunter minigame

.gitattributes

@@ -0,0 +1 @@
+*.html linguist-vendored

.github/workflows/main.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3.3.0
+      - uses: borales/actions-yarn@v4.2.0
+        with:
+          cmd: install
+      - uses: borales/actions-yarn@v4.2.0
+        with:
+          cmd: lint
+      - uses: borales/actions-yarn@v4.2.0
+        with:
+          cmd: format
+      - uses: borales/actions-yarn@v4.2.0
+        with:
+          cmd: build
+      - uses: borales/actions-yarn@v4.2.0
+        with:
+          cmd: test

.prettierrc

@@ -1,6 +0,0 @@
-{
-  "trailingComma": "es5",
-  "tabWidth": 2,
-  "semi": true,
-  "singleQuote": true
-}

LICENSE

@@ -0,0 +1,5 @@
+Copyright 2021 maxswa
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -3,12 +3,13 @@
 [![npm](https://img.shields.io/npm/v/osrs-json-hiscores.svg?style=flat-square)](https://www.npmjs.com/package/osrs-json-hiscores)
 [![downloads](https://img.shields.io/npm/dm/osrs-json-hiscores.svg?style=flat-square)](https://npm-stat.com/charts.html?package=osrs-json-hiscores)
 [![types](https://img.shields.io/npm/types/osrs-json-hiscores.svg?style=flat-square)](https://github.com/maxswa/osrs-json-hiscores/blob/master/src/types.ts)
+[![build](https://img.shields.io/github/actions/workflow/status/maxswa/osrs-json-hiscores/main.yml?style=flat-square&branch=main)](https://github.com/maxswa/osrs-json-hiscores/actions/workflows/main.yml?query=branch%3Amain)
 
-**The Oldschool Runescape API wrapper that does more!**
+**The Old School Runescape API wrapper that does more!**
 
 ## What it does
 
-The official hiscores API for Oldschool Runescape (OSRS) returns CSV.
+The official hiscores API for Old School Runescape (OSRS) returns CSV.
 This wrapper converts it to json and provides extra information about the given player. By comparing player info it infers the player's game mode, as well as any previous modes (de-ultimated, de-ironed and/or died as a hardcore ironman).
 
 Additional functions are provided that screen-scrape the OSRS leaderboards and return a list of players as json.
@@ -50,8 +51,8 @@ Once you import it you can call the functions asynchronously:
 ```javascript
 hiscores
   .getStats('Lynx Titan')
-  .then(res => console.log(res))
-  .catch(err => console.error(err));
+  .then((res) => console.log(res))
+  .catch((err) => console.error(err));
 ```
 
 If you are using TypeScript or transpiling your JS you can use ES6 syntax:
@@ -78,13 +79,13 @@ const topPage = await getSkillPage('overall');
 | Tournament       | `tournament` |
 | Leagues          |  `seasonal`  |
 
-`getSkillPage` and `getActivityPage` require a skill/activity and optionally a gamemode and page:
+`getSkillPage` and `getActivityPage` require a skill / activity and optionally a gamemode and page:
 
 ```javascript
 hiscores
   .getSkillPage('attack', 'main', 1)
-  .then(res => console.log(res))
-  .catch(err => console.error(err));
+  .then((res) => console.log(res))
+  .catch((err) => console.error(err));
 ```
 
 Activities consist of all levels of clue scrolls as well as minigames and bosses:
@@ -103,59 +104,81 @@ 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` |
+| 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
+
+| Activity      |     Param      |
+| ------------- | :------------: |
+| League Points | `leaguePoints` |
 
 ### Bosses
 
-| Boss Name                        |             Param              |
-| -------------------------------- | :----------------------------: |
-| Abyssal Sire                     |         `abyssalSire`          |
-| Alchemical Hydra                 |       `alchemicalHydra`        |
-| Barrows Chests                   |           `barrows`            |
-| Bryophyta                        |          `bryophyta`           |
-| Callisto                         |           `callisto`           |
-| Cerberus                         |           `cerberus`           |
-| Chambers Of Xeric                |       `chambersOfXeric`        |
-| Chambers Of Xeric Challenge Mode | `chambersOfXericChallengeMode` |
-| Chaos Elemental                  |        `chaosElemental`        |
-| Chaos Fanatic                    |         `chaosFanatic`         |
-| Commander Zilyana                |       `commanderZilyana`       |
-| Corporeal Beast                  |        `corporealBeast`        |
-| Crazy Archaeologist              |      `crazyArchaeologist`      |
-| Dagannoth Prime                  |        `dagannothPrime`        |
-| Dagannoth Rex                    |         `dagannothRex`         |
-| Dagannoth Supreme                |       `dagannothSupreme`       |
-| Deranged Archaeologist           |    `derangedArchaeologist`     |
-| General Graardor                 |       `generalGraardor`        |
-| Giant Mole                       |          `giantMole`           |
-| Grotesque Guardians              |      `grotesqueGuardians`      |
-| Hespori                          |           `hespori`            |
-| Kalphite Queen                   |        `kalphiteQueen`         |
-| King Black Dragon                |       `kingBlackDragon`        |
-| Kraken                           |            `kraken`            |
-| Kreearra                         |           `kreeArra`           |
-| K'ril Tsutsaroth                 |        `krilTsutsaroth`        |
-| Mimic                            |            `mimic`             |
-| Obor                             |             `obor`             |
-| Sarachnis                        |          `sarachnis`           |
-| Scorpia                          |           `scorpia`            |
-| Skotizo                          |           `skotizo`            |
-| Gauntlet                         |           `gauntlet`           |
-| Corrupted Gauntlet               |      `corruptedGauntlet`       |
-| Theatre Of Blood                 |        `theatreOfBlood`        |
-| Thermonuclear Smoke Devil        |   `thermonuclearSmokeDevil`    |
-| TzKal-Zuk                        |           `tzKalZuk`           |
-| TzTok-Jad                        |           `tzTokJad`           |
-| Venenatis                        |          `venenatis`           |
-| Vetion                           |            `vetion`            |
-| Vorkath                          |           `vorkath`            |
-| Wintertodt                       |          `wintertodt`          |
-| Zalcano                          |           `zalcano`            |
-| Zulrah                           |            `zulrah`            |
+| Boss Name                         |             Param              |
+| --------------------------------- | :----------------------------: |
+| 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` |
+| Chaos Elemental                   |        `chaosElemental`        |
+| Chaos Fanatic                     |         `chaosFanatic`         |
+| Commander Zilyana                 |       `commanderZilyana`       |
+| Corporeal Beast                   |        `corporealBeast`        |
+| Crazy Archaeologist               |      `crazyArchaeologist`      |
+| Dagannoth Prime                   |        `dagannothPrime`        |
+| Dagannoth Rex                     |         `dagannothRex`         |
+| Dagannoth Supreme                 |       `dagannothSupreme`       |
+| Deranged Archaeologist            |    `derangedArchaeologist`     |
+| General Graardor                  |       `generalGraardor`        |
+| Giant Mole                        |          `giantMole`           |
+| Grotesque Guardians               |      `grotesqueGuardians`      |
+| Hespori                           |           `hespori`            |
+| Kalphite Queen                    |        `kalphiteQueen`         |
+| King Black Dragon                 |       `kingBlackDragon`        |
+| Kraken                            |            `kraken`            |
+| Kreearra                          |           `kreeArra`           |
+| K'ril Tsutsaroth                  |        `krilTsutsaroth`        |
+| Mimic                             |            `mimic`             |
+| Nex                               |             `nex`              |
+| The Nightmare of Ashihama         |          `nightmare`           |
+| Phosani's Nightmare               |      `phosanisNightmare`       |
+| Obor                              |             `obor`             |
+| Phantom Muspah                    |        `phantomMuspah`         |
+| Sarachnis                         |          `sarachnis`           |
+| Scorpia                           |           `scorpia`            |
+| Skotizo                           |           `skotizo`            |
+| Spindel                           |           `spindel`            |
+| Tempoross                         |          `tempoross`           |
+| The Gauntlet                      |           `gauntlet`           |
+| The Corrupted Gauntlet            |      `corruptedGauntlet`       |
+| 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`           |
+| Venenatis                         |          `venenatis`           |
+| Vetion                            |            `vetion`            |
+| Vorkath                           |           `vorkath`            |
+| Wintertodt                        |          `wintertodt`          |
+| Zalcano                           |           `zalcano`            |
+| Zulrah                            |            `zulrah`            |
 
 ## What you'll get
 
@@ -179,6 +202,9 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
     leaguePoints: {},
     bountyHunter: {},
     lastManStanding: {},
+    pvpArena: {},
+    soulWarsZeal: {},
+    riftsClosed: {},
     bosses: {}
   }
 }
@@ -190,7 +216,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 [
   { rank: 1, name: 'Lynx Titan', level: 2277, xp: 4600000000, dead: false },
   {},
-  {},
+  {}
   // ...
 ];
 ```

__tests__/hiscores.test.ts

@@ -1,3 +1,6 @@
+import axios from 'axios';
+import { readFileSync } from 'fs';
+
 import {
   parseStats,
   getSkillPage,
@@ -5,186 +8,289 @@ import {
   getStatsByGamemode,
   getRSNFormat,
   Stats,
+  getPlayerTableURL,
+  getSkillPageURL,
+  getStatsURL,
+  BOSSES,
+  INVALID_FORMAT_ERROR,
+  BH_MODES
 } 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', () => {
-  const csv = `40258,2063,218035714
-  20554, 99, 21102621
-  39059, 99, 15364425
-  14245, 99, 26556827
-  19819, 99, 33511407
-  27857, 99, 25774115
-  44278, 91, 6081159
-  40110, 99, 15128024
-  178948, 90, 5347474
-  175463, 81, 2355494
-  138677, 90, 5356303
-  77587, 91, 5904710
-  158478, 85, 3570485
-  93958, 83, 2684426
-  39179, 88, 4425107
-  138406, 77, 1591377
-  33399, 90, 5866307
-  1794, 99, 15057674
-  45551, 91, 6363261
-  121165, 90, 5748493
-  89460, 88, 4624078
-  53099, 80, 2008229
-  169127, 73, 1067670
-  115543, 82, 2546048
-  -1, -1
-  -1, -1
-  -1, -1
-  24817, 476
-  212728, 1
-  94827, 20
-  59099, 74
-  24642, 231
-  5206, 99
-  6293, 51
-  32875, 500
-  374,2780
-  934,3000
-  1936,1452
-  4919,23
-  101,4038
-  152,334
-  6153,133
-  4501,250
-  6806,603
+  const csv = `246,2277,1338203419
+  615,99,77438259
+  428,99,69176307
+  425,99,115218641
+  138,99,181425111
+  160,99,169725807
+  97,99,50666171
+  144,99,93155913
+  2108,99,53198880
+  5750,99,19589494
+  295,99,76386488
+  1304,99,32252994
+  847,99,54325931
+  534,99,26379932
+  7213,99,13246799
+  2475,99,18161285
+  1837,99,14746134
+  668,99,23961670
+  3841,99,17970837
+  265,99,56230978
+  821,99,62123353
+  169,99,43127930
+  810,99,37688883
+  92,99,32005622
+  23423,478
+  89914,35
+  99834,25
+  99831,23
+  89912,37
+  32,12148
+  3105,76
+  1997,505
+  127,4259
+  361,915
+  392,250
+  1,6143
+  4814,898
+  13,4057
+  37,225
+  25,1110
+  382,2780
+  944,3000
+  704,892
+  1981,1452
+  4981,23
+  888,1046
+  444,792
+  613,4856
+  102,4038
+  156,334
+  6240,133
+  4569,250
+  6893,603
   1,17798
-  9160,125
-  1021,2802
-  4295,1655
-  959,2951
-  10009,1
-  1271,2407
-  378,4669
-  543,1567
-  6003,94
-  263,2897
-  4000,1277
-  41016,1477
-  617,2391
+  9320,125
+  1030,2802
+  4342,1655
+  966,2951
+  10151,1
+  1288,2407
+  377,4669
+  545,1567
+  6083,94
+  264,2897
+  4052,1277
+  41643,1477
+  625,2391
   120,2981
   1,109
+  99,39002
+  3,22666
+  2,84
   26,323
-  198,1101
-  81,3404
-  5027,61
+  44,6233
+  201,1101
+  82,3404
+  5085,61
+  678,903
+  18823,23
   63,375
-  2845,6
-  6913,138
-  3999,2000
-  484,8
-  957,47
-  10987,223
-  1923,272
-  8484,1340
-  599,1694
-  12489,435
-  3810,4583`;
+  2870,6
+  6984,138
+  23,923141
+  4043,2000
+  4073,1020
+  289,13070
+  489,8
+  967,47
+  11155,223
+  1940,272
+  8623,1340
+  605,1694
+  -1,-1
+  3867,4583`;
 
   const expectedOutput: Stats = {
     skills: {
-      overall: { rank: 40258, level: 2063, xp: 218035714 },
-      attack: { rank: 20554, level: 99, xp: 21102621 },
-      defence: { rank: 39059, level: 99, xp: 15364425 },
-      strength: { rank: 14245, level: 99, xp: 26556827 },
-      hitpoints: { rank: 19819, level: 99, xp: 33511407 },
-      ranged: { rank: 27857, level: 99, xp: 25774115 },
-      prayer: { rank: 44278, level: 91, xp: 6081159 },
-      magic: { rank: 40110, level: 99, xp: 15128024 },
-      cooking: { rank: 178948, level: 90, xp: 5347474 },
-      woodcutting: { rank: 175463, level: 81, xp: 2355494 },
-      fletching: { rank: 138677, level: 90, xp: 5356303 },
-      fishing: { rank: 77587, level: 91, xp: 5904710 },
-      firemaking: { rank: 158478, level: 85, xp: 3570485 },
-      crafting: { rank: 93958, level: 83, xp: 2684426 },
-      smithing: { rank: 39179, level: 88, xp: 4425107 },
-      mining: { rank: 138406, level: 77, xp: 1591377 },
-      herblore: { rank: 33399, level: 90, xp: 5866307 },
-      agility: { rank: 1794, level: 99, xp: 15057674 },
-      thieving: { rank: 45551, level: 91, xp: 6363261 },
-      slayer: { rank: 121165, level: 90, xp: 5748493 },
-      farming: { rank: 89460, level: 88, xp: 4624078 },
-      runecraft: { rank: 53099, level: 80, xp: 2008229 },
-      hunter: { rank: 169127, level: 73, xp: 1067670 },
-      construction: { rank: 115543, level: 82, xp: 2546048 },
+      overall: { rank: 246, level: 2277, xp: 1338203419 },
+      attack: { rank: 615, level: 99, xp: 77438259 },
+      defence: { rank: 428, level: 99, xp: 69176307 },
+      strength: { rank: 425, level: 99, xp: 115218641 },
+      hitpoints: { rank: 138, level: 99, xp: 181425111 },
+      ranged: { rank: 160, level: 99, xp: 169725807 },
+      prayer: { rank: 97, level: 99, xp: 50666171 },
+      magic: { rank: 144, level: 99, xp: 93155913 },
+      cooking: { rank: 2108, level: 99, xp: 53198880 },
+      woodcutting: { rank: 5750, level: 99, xp: 19589494 },
+      fletching: { rank: 295, level: 99, xp: 76386488 },
+      fishing: { rank: 1304, level: 99, xp: 32252994 },
+      firemaking: { rank: 847, level: 99, xp: 54325931 },
+      crafting: { rank: 534, level: 99, xp: 26379932 },
+      smithing: { rank: 7213, level: 99, xp: 13246799 },
+      mining: { rank: 2475, level: 99, xp: 18161285 },
+      herblore: { rank: 1837, level: 99, xp: 14746134 },
+      agility: { rank: 668, level: 99, xp: 23961670 },
+      thieving: { rank: 3841, level: 99, xp: 17970837 },
+      slayer: { rank: 265, level: 99, xp: 56230978 },
+      farming: { rank: 821, level: 99, xp: 62123353 },
+      runecraft: { rank: 169, level: 99, xp: 43127930 },
+      hunter: { rank: 810, level: 99, xp: 37688883 },
+      construction: { rank: 92, level: 99, xp: 32005622 }
     },
-    leaguePoints: { rank: -1, score: -1 },
+    leaguePoints: { rank: 23423, score: 478 },
     bountyHunter: {
-      rogue: { rank: -1, score: -1 },
-      hunter: { rank: -1, score: -1 },
+      hunterV2: { rank: 89914, score: 35 },
+      rogueV2: { rank: 99834, score: 25 },
+      hunter: { rank: 99831, score: 23 },
+      rogue: { rank: 89912, score: 37 },
     },
-    lastManStanding: { rank: 32875, score: 500 },
+    lastManStanding: { rank: 4814, score: 898 },
+    pvpArena: { rank: 13, score: 4057 },
+    soulWarsZeal: { rank: 37, score: 225 },
+    riftsClosed: { rank: 25, score: 1110 },
     clues: {
-      all: { rank: 24817, score: 476 },
-      beginner: { rank: 212728, score: 1 },
-      easy: { rank: 94827, score: 20 },
-      medium: { rank: 59099, score: 74 },
-      hard: { rank: 24642, score: 231 },
-      elite: { rank: 5206, score: 99 },
-      master: { rank: 6293, score: 51 },
+      all: { rank: 32, score: 12148 },
+      beginner: { rank: 3105, score: 76 },
+      easy: { rank: 1997, score: 505 },
+      medium: { rank: 127, score: 4259 },
+      hard: { rank: 361, score: 915 },
+      elite: { rank: 392, score: 250 },
+      master: { rank: 1, score: 6143 }
     },
     bosses: {
-      abyssalSire: { rank: 374, score: 2780 },
-      alchemicalHydra: { rank: 934, score: 3000 },
-      barrows: { rank: 1936, score: 1452 },
-      bryophyta: { rank: 4919, score: 23 },
-      callisto: { rank: -1, score: -1 },
-      cerberus: { rank: -1, score: -1 },
-      chambersOfXeric: { rank: 101, score: 4038 },
-      chambersOfXericChallengeMode: { rank: 152, score: 334 },
-      chaosElemental: { rank: 6153, score: 133 },
-      chaosFanatic: { rank: 4501, score: 250 },
-      commanderZilyana: { rank: 6806, score: 603 },
+      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 },
+      chaosElemental: { rank: 6240, score: 133 },
+      chaosFanatic: { rank: 4569, score: 250 },
+      commanderZilyana: { rank: 6893, score: 603 },
       corporealBeast: { rank: 1, score: 17798 },
-      crazyArchaeologist: { rank: 9160, score: 125 },
-      dagannothPrime: { rank: 1021, score: 2802 },
-      dagannothRex: { rank: 4295, score: 1655 },
-      dagannothSupreme: { rank: 959, score: 2951 },
-      derangedArchaeologist: { rank: 10009, score: 1 },
-      generalGraardor: { rank: 1271, score: 2407 },
-      giantMole: { rank: 378, score: 4669 },
-      grotesqueGuardians: { rank: 543, score: 1567 },
-      hespori: { rank: 6003, score: 94 },
-      kalphiteQueen: { rank: 263, score: 2897 },
-      kingBlackDragon: { rank: 4000, score: 1277 },
-      kraken: { rank: 41016, score: 1477 },
-      kreeArra: { rank: 617, score: 2391 },
+      crazyArchaeologist: { rank: 9320, score: 125 },
+      dagannothPrime: { rank: 1030, score: 2802 },
+      dagannothRex: { rank: 4342, score: 1655 },
+      dagannothSupreme: { rank: 966, score: 2951 },
+      derangedArchaeologist: { rank: 10151, score: 1 },
+      generalGraardor: { rank: 1288, score: 2407 },
+      giantMole: { rank: 377, score: 4669 },
+      grotesqueGuardians: { rank: 545, score: 1567 },
+      hespori: { rank: 6083, score: 94 },
+      kalphiteQueen: { rank: 264, score: 2897 },
+      kingBlackDragon: { rank: 4052, score: 1277 },
+      kraken: { rank: 41643, score: 1477 },
+      kreeArra: { rank: 625, score: 2391 },
       krilTsutsaroth: { rank: 120, score: 2981 },
       mimic: { rank: 1, score: 109 },
+      nex: { rank: 99, score: 39002 },
+      nightmare: { rank: 3, score: 22666 },
+      phosanisNightmare: { rank: 2, score: 84 },
       obor: { rank: 26, score: 323 },
-      sarachnis: { rank: 198, score: 1101 },
-      scorpia: { rank: 81, score: 3404 },
-      skotizo: { rank: 5027, score: 61 },
+      phantomMuspah: { rank: 44, score: 6233 },
+      sarachnis: { rank: 201, score: 1101 },
+      scorpia: { rank: 82, score: 3404 },
+      skotizo: { rank: 5085, score: 61 },
+      spindel: { rank: 678, score: 903 },
+      tempoross: { rank: 18823, score: 23 },
       gauntlet: { rank: 63, score: 375 },
-      corruptedGauntlet: { rank: 2845, score: 6 },
-      theatreOfBlood: { rank: 6913, score: 138 },
-      thermonuclearSmokeDevil: { rank: 3999, score: 2000 },
-      tzKalZuk: { rank: 484, score: 8 },
-      tzTokJad: { rank: 957, score: 47 },
-      venenatis: { rank: 10987, score: 223 },
-      vetion: { rank: 1923, score: 272 },
-      vorkath: { rank: 8484, score: 1340 },
-      wintertodt: { rank: 599, score: 1694 },
-      zalcano: { rank: 12489, score: 435 },
-      zulrah: { rank: 3810, score: 4583 },
-    },
+      corruptedGauntlet: { rank: 2870, score: 6 },
+      theatreOfBlood: { rank: 6984, score: 138 },
+      theatreOfBloodHardMode: { rank: 23, score: 923141 },
+      thermonuclearSmokeDevil: { rank: 4043, score: 2000 },
+      tombsOfAmascut: { rank: 4073, score: 1020 },
+      tombsOfAmascutExpertMode: { rank: 289, score: 13070 },
+      tzKalZuk: { rank: 489, score: 8 },
+      tzTokJad: { rank: 967, score: 47 },
+      venenatis: { rank: 11155, score: 223 },
+      vetion: { rank: 1940, score: 272 },
+      vorkath: { rank: 8623, score: 1340 },
+      wintertodt: { rank: 605, score: 1694 },
+      zalcano: { rank: -1, score: -1 },
+      zulrah: { rank: 3867, score: 4583 }
+    }
   };
 
   expect(parseStats(csv)).toStrictEqual(expectedOutput);
 });
 
-test('Get name format', async () => {
-  jest.setTimeout(30000);
-  const data = await getRSNFormat('lYnX tiTaN');
-  expect(data).toBe('Lynx Titan');
+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', () => {
+  it('gets a name with a space', async () => {
+    const data = await getRSNFormat(LYNX_TITAN_SPACE_NAME);
+    expect(data).toBe(LYNX_TITAN_FORMATTED_NAME);
+  });
+  it('gets a name with an underscore', async () => {
+    const data = await getRSNFormat(LYNX_TITAN_UNDERSCORE_NAME);
+    expect(data).toBe(LYNX_TITAN_FORMATTED_NAME);
+  });
+  it('gets a name with a hyphen', async () => {
+    const data = await getRSNFormat(LYNX_TITAN_HYPHEN_NAME);
+    expect(data).toBe(LYNX_TITAN_FORMATTED_NAME);
+  });
+  it('gets a name with a number', async () => {
+    const data = await getRSNFormat(B0ATY_NAME);
+    expect(data).toBe(B0ATY_FORMATTED_NAME);
+  });
+  it('throws an error for a name with invalid characters', async () => {
+    await expect(getRSNFormat('b&aty')).rejects.toBeTruthy();
+  });
 });
 
 test('Get attack top page', async () => {
-  jest.setTimeout(30000);
   const data = await getSkillPage('attack');
   expect(data).toMatchObject([
     {
@@ -192,176 +298,181 @@ test('Get attack top page', async () => {
       rank: 1,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 2,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
+    },
+    {
+      name: expect.any(String),
+      rank: 3,
+      level: 99,
+      xp: 200000000,
+      dead: false
     },
-    { name: 'Drakon', rank: 3, level: 99, xp: 200000000, dead: false },
     {
       name: expect.any(String),
       rank: 4,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 5,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 6,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 7,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 8,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 9,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 10,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 11,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 12,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 13,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 14,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 15,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 16,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 17,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 18,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 19,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 20,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 21,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 22,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 23,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 24,
       level: 99,
       xp: 200000000,
-      dead: false,
+      dead: false
     },
     {
       name: expect.any(String),
       rank: 25,
       level: 99,
       xp: 200000000,
-      dead: false,
-    },
+      dead: false
+    }
   ]);
 });
 
-test('Get non-existant player', async () => {
-  jest.setTimeout(30000);
-  getStats('fishy').catch(err => {
+test('Get non-existent player', async () => {
+  getStats('fishy').catch((err) => {
     if (err.response) {
       expect(err.response.status).toBe(404);
     }
@@ -369,8 +480,10 @@ test('Get non-existant player', async () => {
 });
 
 test('Get stats by gamemode', async () => {
-  jest.setTimeout(30000);
-  const { skills } = await getStatsByGamemode('Lynx Titan');
+  const { skills, bosses, bountyHunter } = await getStatsByGamemode(
+    LYNX_TITAN_FORMATTED_NAME
+  );
+
   expect(skills).toMatchObject({
     overall: { rank: expect.any(Number), level: 2277, xp: 4600000000 },
     attack: { rank: expect.any(Number), level: 99, xp: 200000000 },
@@ -395,6 +508,60 @@ test('Get stats by gamemode', async () => {
     farming: { rank: expect.any(Number), level: 99, xp: 200000000 },
     runecraft: { 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();
   });
 });

__tests__/lynxTitanStats.csv

@@ -0,0 +1,94 @@
+1,2277,4600000000
+15,99,200000000
+28,99,200000000
+18,99,200000000
+7,99,200000000
+8,99,200000000
+11,99,200000000
+32,99,200000000
+159,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
+23,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
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+347584,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
+-1,-1
+-1,-1
+-1,-1
+-1,-1

jestconfig.json

@@ -1,7 +0,0 @@
-{
-  "transform": {
-    "^.+\\.(t|j)sx?$": "ts-jest"
-  },
-  "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
-  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
-}

package.json

@@ -1,17 +1,18 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.0.0",
-  "description": "The Oldschool Runescape API wrapper that does more!",
+  "version": "2.14.0",
+  "description": "The Old School Runescape API wrapper that does more!",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
     "lib/**/*"
   ],
   "scripts": {
-    "dev": "watch 'yarn run build' src",
+    "dev": "yarn build --watch",
     "build": "tsc",
     "format": "prettier --write \"src/**/*.ts\"",
-    "test": "jest --config jestconfig.json",
+    "lint": "eslint --fix \"src/**/*.ts\"",
+    "test": "jest",
     "prepublish": "yarn run build",
     "release": "np"
   },
@@ -29,27 +30,88 @@
     "stats",
     "skills"
   ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
   "author": "maxswa",
   "license": "ISC",
   "bugs": {
     "url": "https://github.com/maxswa/osrs-json-hiscores/issues"
   },
   "homepage": "https://github.com/maxswa/osrs-json-hiscores#readme",
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{ts}": [
+      "eslint --fix",
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "eslintConfig": {
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "project": "./tsconfig.eslint.json"
+    },
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "extends": [
+      "eslint-config-airbnb-typescript",
+      "prettier"
+    ],
+    "ignorePatterns": [
+      "**/@types/*"
+    ]
+  },
+  "prettier": {
+    "trailingComma": "none",
+    "tabWidth": 2,
+    "semi": true,
+    "singleQuote": true
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.(t|j)sx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "jsx",
+      "json",
+      "node"
+    ],
+    "testEnvironment": "node"
+  },
   "dependencies": {
-    "axios": "^0.19.0",
-    "cheerio": "^1.0.0-rc.3"
+    "axios": "^0.21.1",
+    "jsdom": "^16.3.0",
+    "useragent-generator": "^1.1.0"
   },
   "devDependencies": {
-    "@types/cheerio": "^0.22.11",
-    "@types/jest": "^24.0.14",
-    "jest": "^24.8.0",
-    "np": "^5.0.3",
-    "prettier": "^1.19.1",
-    "ts-jest": "^24.0.2",
-    "tslint": "^5.17.0",
-    "tslint-config-airbnb": "^5.11.1",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.5.2",
-    "watch": "^1.0.2"
+    "@types/jest": "^26.0.21",
+    "@types/jsdom": "^16.2.3",
+    "@typescript-eslint/eslint-plugin": "^4.19.0",
+    "@typescript-eslint/parser": "^4.19.0",
+    "eslint": "^7.22.0",
+    "eslint-config-airbnb-typescript": "^12.3.1",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-react": "^7.23.1",
+    "eslint-plugin-react-hooks": "^4.2.0",
+    "husky": "^5.2.0",
+    "jest": "^26.6.3",
+    "lint-staged": "^10.5.4",
+    "np": "^7.7.0",
+    "prettier": "^2.2.1",
+    "ts-jest": "^26.5.4",
+    "typescript": "^4.2.3"
   }
 }

src/@types/useragent-generator.d.ts

@@ -0,0 +1,109 @@
+declare module 'useragent-generator' {
+  /** *****************
+   *  Google Chrome   *
+  /****************** */
+  export function chrome(
+    opt: number | string | { version: string; os?: string }
+  ): string;
+  export namespace chrome {
+    function androidPhone(
+      opt:
+        | number
+        | string
+        | { version: string; androidVersion?: string; device?: string }
+    ): string;
+    function androidTablet(
+      opt:
+        | number
+        | string
+        | { version: string; androidVersion?: string; device?: string }
+    ): string;
+    function androidWebview(
+      opt:
+        | number
+        | string
+        | { androidVersion: string; chromeVersion?: string; device?: string }
+    ): string;
+    function chromecast(opt: number | string | { version: string }): string;
+    function iOS(
+      opt:
+        | number
+        | string
+        | { iOSVersion: string; chromeVersion?: string; device?: string }
+    ): string;
+  }
+  export function chromium(
+    opt: number | string | { version: string; os?: string }
+  ): string;
+  /** ************
+   *   Firefox   *
+  /************* */
+  export function firefox(
+    opt: number | string | { version: string; os?: string }
+  ): string;
+  export namespace firefox {
+    function androidPhone(
+      opt:
+        | number
+        | string
+        | { version: string; androidVersion?: string; device?: string }
+    ): string;
+    function androidTablet(
+      opt:
+        | number
+        | string
+        | { version: string; androidVersion?: string; device?: string }
+    ): string;
+    function iOS(
+      opt: number | string | { iOSVersion: string; device?: string }
+    ): string;
+  }
+  /** ***********
+   *   Safari   *
+  /************ */
+  export function safari(
+    opt: number | string | { version: string; os?: string }
+  ): string;
+  export namespace safari {
+    function iOS(
+      opt:
+        | number
+        | string
+        | { iOSVersion: string; safariVersion?: string; device?: string }
+    ): string;
+    function iOSWebview(
+      opt:
+        | number
+        | string
+        | { iOSVersion: string; safariVersion?: string; device?: string }
+    ): string;
+  }
+  /** ********************
+   *  Internet Explorer  *
+  /********************* */
+  export function ie(
+    opt: number | string | { version: string; os?: string }
+  ): string;
+  export namespace ie {
+    function windowsPhone(
+      opt: number | string | { version: string; device?: string }
+    ): string;
+  }
+  /** *******************
+   *   Microsoft Edge   *
+  /******************** */
+  export function edge(
+    opt:
+      | number
+      | string
+      | { version: string; chromeVersion?: string; os?: string }
+  ): string;
+  /** *********************
+   *  Search Engine Bots  *
+  /********************** */
+  export function googleBot(
+    opt?: number | string | { version?: string }
+  ): string;
+  export function bingBot(opt?: number | string | { version?: string }): string;
+  export function yahooBot(): string;
+}

src/hiscores.ts

@@ -1,5 +1,5 @@
-import axios from 'axios';
-import * as cheerio from 'cheerio';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { BinaryData, JSDOM } from 'jsdom';
 import {
   Player,
   Activity,
@@ -14,7 +14,7 @@ import {
   ActivityName,
   PlayerActivityRow,
   Bosses,
-  Boss,
+  GetStatsOptions
 } from './types';
 import {
   getStatsURL,
@@ -28,40 +28,198 @@ import {
   numberFromElement,
   rsnFromElement,
   getActivityPageURL,
+  httpGet,
   BOSSES,
+  INVALID_FORMAT_ERROR,
+  validateRSN
 } from './utils';
 
-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');
+/**
+ * Screen scrapes the hiscores to get the formatted rsn of a player.
+ *
+ * @param rsn Username of the player.
+ * @param config Optional axios request config object.
+ * @returns Formatted version of the rsn.
+ */
+export async function getRSNFormat(
+  rsn: string,
+  config?: AxiosRequestConfig
+): Promise<string> {
+  validateRSN(rsn);
+
+  const url = getPlayerTableURL('main', rsn);
+  try {
+    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'
+    );
+    if (anchor) {
+      return rsnFromElement(anchor);
+    }
+    throw Error('Player not found');
+  } catch {
+    throw Error('Player not found');
+  }
+}
+
+/**
+ * Parses CSV string of raw stats and returns a stats object.
+ *
+ * @param csv Raw CSV from the official OSRS API.
+ * @returns Parsed stats object.
+ */
+export function parseStats(csv: string): Stats {
+  const splitCSV = csv
+    .split('\n')
+    .filter((entry) => !!entry)
+    .map((stat) => stat.split(','));
+
+  if (
+    splitCSV.length !==
+    SKILLS.length + BH_MODES.length + CLUES.length + BOSSES.length + 5
+  ) {
+    throw Error(INVALID_FORMAT_ERROR);
   }
 
-  const mainRes = await axios(getStatsURL('main', rsn));
-  if (mainRes.status === 200) {
-    const otherResponses = await Promise.all([
-      axios(getStatsURL('ironman', rsn)).catch(err => err),
-      axios(getStatsURL('hardcore', rsn)).catch(err => err),
-      axios(getStatsURL('ultimate', rsn)).catch(err => err),
-      getRSNFormat(rsn),
-    ]);
+  const skillObjects: Skill[] = splitCSV
+    .filter((stat) => stat.length === 3)
+    .map((stat) => {
+      const [rank, level, xp] = stat;
+      const skill: Skill = {
+        rank: parseInt(rank, 10),
+        level: parseInt(level, 10),
+        xp: parseInt(xp, 10)
+      };
+      return skill;
+    });
 
-    const [ironRes, hcRes, ultRes, formattedName] = otherResponses;
+  const activityObjects: Activity[] = splitCSV
+    .filter((stat) => stat.length === 2)
+    .map((stat) => {
+      const [rank, score] = stat;
+      const activity: Activity = {
+        rank: parseInt(rank, 10),
+        score: parseInt(score, 10)
+      };
+      return activity;
+    });
+
+  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 bossObjects = activityObjects.splice(0, BOSSES.length);
+
+  const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
+    const newSkills = { ...prev };
+    newSkills[SKILLS[index]] = curr;
+    return newSkills;
+  }, {} as Skills);
+
+  const bountyHunter: BH = bhObjects.reduce<BH>((prev, curr, index) => {
+    const newBH = { ...prev };
+    newBH[BH_MODES[index]] = curr;
+    return newBH;
+  }, {} as BH);
+
+  const clues: Clues = clueObjects.reduce<Clues>((prev, curr, index) => {
+    const newClues = { ...prev };
+    newClues[CLUES[index]] = curr;
+    return newClues;
+  }, {} as Clues);
+
+  const bosses: Bosses = bossObjects.reduce<Bosses>((prev, curr, index) => {
+    const newBosses = { ...prev };
+    newBosses[BOSSES[index]] = curr;
+    return newBosses;
+  }, {} as Bosses);
+
+  const stats: Stats = {
+    skills,
+    leaguePoints,
+    bountyHunter,
+    lastManStanding,
+    pvpArena,
+    soulWarsZeal,
+    riftsClosed,
+    clues,
+    bosses
+  };
+
+  return stats;
+}
+
+/**
+ * Fetches stats from the OSRS API and consolidates the info into a player object.
+ *
+ * **Note:** This function will make up to 5 separate network requests.
+ * As such, it is highly subject to the performance of the official OSRS API.
+ *
+ * @param rsn Username of the player.
+ * @returns Player object.
+ */
+export async function getStats(
+  rsn: string,
+  options?: GetStatsOptions
+): Promise<Player> {
+  validateRSN(rsn);
+  const otherGamemodes = options?.otherGamemodes ?? [
+    'ironman',
+    'hardcore',
+    'ultimate'
+  ];
+  const shouldGetFormattedRsn = options?.shouldGetFormattedRsn ?? true;
+
+  const mainRes = await httpGet<string>(
+    getStatsURL('main', rsn),
+    options?.axiosConfigs?.main
+  );
+  if (mainRes.status === 200) {
+    const emptyResponse: AxiosResponse<string> = {
+      status: 404,
+      data: '',
+      statusText: '',
+      headers: {},
+      config: {}
+    };
+    const getModeStats = async (
+      mode: Extract<Gamemode, 'ironman' | 'hardcore' | 'ultimate'>
+    ): Promise<AxiosResponse<string>> =>
+      otherGamemodes.includes(mode)
+        ? httpGet<string>(
+            getStatsURL(mode, rsn),
+            options?.axiosConfigs?.[mode]
+          ).catch((err) => err)
+        : emptyResponse;
+    const formattedName = shouldGetFormattedRsn
+      ? await getRSNFormat(rsn, options?.axiosConfigs?.rsn).catch(
+          () => undefined
+        )
+      : undefined;
 
     const player: Player = {
-      name: formattedName,
+      name: formattedName ?? rsn,
       mode: 'main',
       dead: false,
       deulted: false,
-      deironed: false,
+      deironed: false
     };
     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);
@@ -108,20 +266,24 @@ export async function getStats(rsn: string): Promise<Player> {
   throw Error('Player not found');
 }
 
+/**
+ * Fetches stats from the OSRS API and returns them as an object.
+ *
+ * @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 axios(getStatsURL(mode, rsn));
+  const response = await httpGet<string>(getStatsURL(mode, rsn), config);
   if (response.status !== 200) {
     throw Error('Player not found');
   }
@@ -133,7 +295,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');
@@ -144,31 +307,49 @@ export async function getSkillPage(
   }
   const url = getSkillPageURL(mode, skill, page);
 
-  const response = await axios(url);
-  const $ = cheerio.load(response.data);
-  const playersHTML = $('.personal-hiscores__row').toArray();
+  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'
+  );
 
-  const players: PlayerSkillRow[] = playersHTML.map(row => {
-    const cells = row.children.filter(el => el.name === 'td');
-    const [rankEl, nameCell, levelEl, xpEl] = cells;
-    const [nameEl] = nameCell.children.filter(el => el.name === 'a');
+  const players: PlayerSkillRow[] = [];
+  playersHTML.forEach((row) => {
+    const rankEl = row.querySelector('td');
+    const nameEl = row.querySelector('td a');
+    const levelEl = row.querySelector('td.left + td');
+    const xpEl = row.querySelector('td.left + td + td');
+    const isDead = !!row.querySelector('td img');
 
-    return {
+    players.push({
       name: rsnFromElement(nameEl),
       rank: numberFromElement(rankEl),
       level: numberFromElement(levelEl),
       xp: numberFromElement(xpEl),
-      dead: nameCell.children.length === 4,
-    };
+      dead: isDead
+    });
   });
 
   return players;
 }
 
+/**
+ * Screen scrapes a hiscores page of an activity or boss and returns an array of up to 25 players.
+ *
+ * @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');
@@ -179,134 +360,29 @@ export async function getActivityPage(
   }
   const url = getActivityPageURL(mode, activity, page);
 
-  const response = await axios(url);
-  const $ = cheerio.load(response.data);
-  const playersHTML = $('.personal-hiscores__row').toArray();
+  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'
+  );
 
-  const players: PlayerActivityRow[] = playersHTML.map(row => {
-    const cells = row.children.filter(el => el.name === 'td');
-    const [rankEl, nameCell, scoreEl] = cells;
-    const [nameEl] = nameCell.children.filter(el => el.name === 'a');
+  const players: PlayerActivityRow[] = [];
+  playersHTML.forEach((row) => {
+    const rankEl = row.querySelector('td');
+    const nameEl = row.querySelector('td a');
+    const scoreEl = row.querySelector('td.left + td');
+    const isDead = !!row.querySelector('td img');
 
-    return {
+    players.push({
       name: rsnFromElement(nameEl),
       rank: numberFromElement(rankEl),
       score: numberFromElement(scoreEl),
-      dead: nameCell.children.length === 4,
-    };
+      dead: isDead
+    });
   });
 
   return players;
 }
-
-export async function getRSNFormat(rsn: string): Promise<string> {
-  if (typeof rsn !== 'string') {
-    throw Error('RSN must be a string');
-  } else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) {
-    throw Error('RSN contains invalid character');
-  } else if (rsn.length > 12 || rsn.length < 1) {
-    throw Error('RSN must be between 1 and 12 characters');
-  }
-
-  const url = getPlayerTableURL('main', rsn);
-  try {
-    const response = await axios(url);
-    const $ = cheerio.load(response.data);
-    const rawName = $('[style="color:#AA0022;"]')[1].children[0].data;
-    if (rawName) {
-      return rawName.replace(/\uFFFD/g, ' ');
-    }
-    throw Error('Player not found');
-  } catch {
-    throw Error('Player not found');
-  }
-}
-
-export function parseStats(csv: string): Stats {
-  const splitCSV = csv
-    .split('\n')
-    .filter(entry => !!entry)
-    .map(stat => stat.split(','));
-
-  const skillObjects: Skill[] = splitCSV
-    .filter(stat => stat.length === 3)
-    .map(stat => {
-      const [rank, level, xp] = stat;
-      const skill: Skill = {
-        rank: parseInt(rank, 10),
-        level: parseInt(level, 10),
-        xp: parseInt(xp, 10),
-      };
-      return skill;
-    });
-
-  const activityObjects: Activity[] = splitCSV
-    .filter(stat => stat.length === 2)
-    .map(stat => {
-      const [rank, score] = stat;
-      const activity: Activity = {
-        rank: parseInt(rank, 10),
-        score: parseInt(score, 10),
-      };
-      return activity;
-    });
-
-  const [leaguePoints] = activityObjects.splice(0, 1);
-  const bhObjects = activityObjects.splice(0, BH_MODES.length);
-  const clueObjects = activityObjects.splice(0, CLUES.length);
-  const [lastManStanding] = activityObjects.splice(0, 1);
-  const bossObjects = activityObjects.splice(0, BOSSES.length);
-
-  const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
-    const newSkills = { ...prev };
-    newSkills[SKILLS[index]] = curr;
-    return newSkills;
-  }, {} as Skills);
-
-  const bountyHunter: BH = bhObjects.reduce<BH>((prev, curr, index) => {
-    const newBH = { ...prev };
-    newBH[BH_MODES[index]] = curr;
-    return newBH;
-  }, {} as BH);
-
-  const clues: Clues = clueObjects.reduce<Clues>((prev, curr, index) => {
-    const newClues = { ...prev };
-    newClues[CLUES[index]] = curr;
-    return newClues;
-  }, {} as Clues);
-
-  // TODO Remove as soon as Jagex's API is fixed
-  const brokenBosses: Boss[] = ['callisto', 'cerberus'];
-  const TEMPBOSSES: Boss[] = BOSSES.reduce<Boss[]>(
-    (prev, curr) => (brokenBosses.includes(curr) ? prev : [...prev, curr]),
-    []
-  );
-
-  const bosses: Bosses = bossObjects.reduce<Bosses>((prev, curr, index) => {
-    const newBosses = { ...prev };
-
-    // TODO Remove as soon as Jagex's API is fixed
-    if (BOSSES[index] === brokenBosses[0]) {
-      brokenBosses.forEach(broken => {
-        newBosses[broken] = {
-          rank: -1,
-          score: -1,
-        };
-      });
-    }
-
-    newBosses[TEMPBOSSES[index]] = curr;
-    return newBosses;
-  }, {} as Bosses);
-
-  const stats: Stats = {
-    skills,
-    leaguePoints,
-    bountyHunter,
-    lastManStanding,
-    clues,
-    bosses,
-  };
-
-  return stats;
-}

src/types.ts

@@ -1,3 +1,5 @@
+import { AxiosRequestConfig } from 'axios';
+
 export type Gamemode =
   | 'main'
   | 'ironman'
@@ -5,7 +7,10 @@ export type Gamemode =
   | 'hardcore'
   | 'deadman'
   | 'seasonal'
-  | 'tournament';
+  | 'tournament'
+  | 'skiller'
+  | 'oneDefence'
+  | 'freshStart';
 
 export interface Skill {
   rank: number;
@@ -57,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'
@@ -89,14 +96,23 @@ export type Boss =
   | 'kreeArra'
   | 'krilTsutsaroth'
   | 'mimic'
+  | 'nex'
+  | 'nightmare'
+  | 'phosanisNightmare'
   | 'obor'
+  | 'phantomMuspah'
   | 'sarachnis'
   | 'scorpia'
   | 'skotizo'
+  | 'spindel'
+  | 'tempoross'
   | 'gauntlet'
   | 'corruptedGauntlet'
   | 'theatreOfBlood'
+  | 'theatreOfBloodHardMode'
   | 'thermonuclearSmokeDevil'
+  | 'tombsOfAmascut'
+  | 'tombsOfAmascutExpertMode'
   | 'tzKalZuk'
   | 'tzTokJad'
   | 'venenatis'
@@ -109,9 +125,15 @@ export type Boss =
 export type Bosses = { [Type in Boss]: Activity };
 
 export type ActivityName =
+  | 'leaguePoints'
+  | 'hunterBHV2'
+  | 'rogueBHV2'
   | 'hunterBH'
   | 'rogueBH'
   | 'lastManStanding'
+  | 'pvpArena'
+  | 'soulWarsZeal'
+  | 'riftsClosed'
   | 'allClues'
   | 'beginnerClues'
   | 'easyClues'
@@ -127,6 +149,9 @@ export interface Stats {
   leaguePoints: Activity;
   bountyHunter: BH;
   lastManStanding: Activity;
+  pvpArena: Activity;
+  soulWarsZeal: Activity;
+  riftsClosed: Activity;
   bosses: Bosses;
 }
 export type Modes = { [M in Gamemode]?: Stats };
@@ -148,3 +173,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;
+  };
+}

src/utils/constants.ts

@@ -4,10 +4,10 @@ import {
   ClueType,
   Gamemode,
   SkillName,
-  ActivityName,
+  ActivityName
 } from '../types';
 
-export const BASE_URL = 'http://services.runescape.com/m=hiscore_oldschool';
+export const BASE_URL = 'https://secure.runescape.com/m=hiscore_oldschool';
 export const STATS_URL = 'index_lite.ws?player=';
 export const SCORES_URL = 'overall.ws?';
 
@@ -23,6 +23,9 @@ export const GAMEMODE_URL: GamemodeUrl = {
   deadman: `${BASE_URL}_deadman/`,
   seasonal: `${BASE_URL}_seasonal/`,
   tournament: `${BASE_URL}_tournament/`,
+  skiller: `${BASE_URL}_skiller/`,
+  oneDefence: `${BASE_URL}_skiller_defence/`,
+  freshStart: `${BASE_URL}_fresh_start/`
 };
 export const SKILLS: SkillName[] = [
   'overall',
@@ -48,7 +51,7 @@ export const SKILLS: SkillName[] = [
   'farming',
   'runecraft',
   'hunter',
-  'construction',
+  'construction'
 ];
 export const CLUES: ClueType[] = [
   'all',
@@ -57,21 +60,9 @@ export const CLUES: ClueType[] = [
   'medium',
   'hard',
   'elite',
-  'master',
-];
-export const BH_MODES: BHType[] = ['rogue', 'hunter'];
-export const ACTIVITIES: ActivityName[] = [
-  'hunterBH',
-  'rogueBH',
-  'lastManStanding',
-  'allClues',
-  'beginnerClues',
-  'easyClues',
-  'mediumClues',
-  'hardClues',
-  'eliteClues',
-  'masterClues',
+  'master'
 ];
+export const BH_MODES: BHType[] = ['hunterV2', 'rogueV2', 'hunter', 'rogue'];
 export const GAMEMODES: Gamemode[] = [
   'main',
   'ironman',
@@ -79,14 +70,16 @@ export const GAMEMODES: Gamemode[] = [
   'ultimate',
   'deadman',
   'seasonal',
-  'tournament',
+  'tournament'
 ];
 export const BOSSES: Boss[] = [
   'abyssalSire',
   'alchemicalHydra',
+  'artio',
   'barrows',
   'bryophyta',
   'callisto',
+  'calvarion',
   'cerberus',
   'chambersOfXeric',
   'chambersOfXericChallengeMode',
@@ -109,14 +102,23 @@ export const BOSSES: Boss[] = [
   'kreeArra',
   'krilTsutsaroth',
   'mimic',
+  'nex',
+  'nightmare',
+  'phosanisNightmare',
   'obor',
+  'phantomMuspah',
   'sarachnis',
   'scorpia',
   'skotizo',
+  'spindel',
+  'tempoross',
   'gauntlet',
   'corruptedGauntlet',
   'theatreOfBlood',
+  'theatreOfBloodHardMode',
   'thermonuclearSmokeDevil',
+  'tombsOfAmascut',
+  'tombsOfAmascutExpertMode',
   'tzKalZuk',
   'tzTokJad',
   'venenatis',
@@ -124,7 +126,26 @@ export const BOSSES: Boss[] = [
   'vorkath',
   'wintertodt',
   'zalcano',
-  'zulrah',
+  'zulrah'
+];
+export const ACTIVITIES: ActivityName[] = [
+  'leaguePoints',
+  'hunterBHV2',
+  'rogueBHV2',
+  'hunterBH',
+  'rogueBH',
+  'allClues',
+  'beginnerClues',
+  'easyClues',
+  'mediumClues',
+  'hardClues',
+  'eliteClues',
+  'masterClues',
+  'lastManStanding',
+  'pvpArena',
+  'soulWarsZeal',
+  'riftsClosed',
+  ...BOSSES
 ];
 
 export type FormattedBossNames = {
@@ -134,9 +155,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',
@@ -159,14 +182,23 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
   kreeArra: "Kree'Arra",
   krilTsutsaroth: "K'ril Tsutsaroth",
   mimic: 'Mimic',
+  nex: 'Nex',
+  nightmare: 'The Nightmare of Ashihama',
+  phosanisNightmare: "Phosani's Nightmare",
   obor: 'Obor',
+  phantomMuspah: 'Phantom Muspah',
   sarachnis: 'Sarachnis',
   scorpia: 'Scorpia',
   skotizo: 'Skotizo',
+  spindel: 'Spindel',
+  tempoross: 'Tempoross',
   gauntlet: 'The Gauntlet',
   corruptedGauntlet: 'The Corrupted Gauntlet',
   theatreOfBlood: 'Theatre of Blood',
+  theatreOfBloodHardMode: 'Theatre of Blood: Hard Mode',
   thermonuclearSmokeDevil: 'Thermonuclear Smoke Devil',
+  tombsOfAmascut: 'Tombs of Amascut',
+  tombsOfAmascutExpertMode: 'Tombs of Amascut: Expert Mode',
   tzKalZuk: 'TzKal-Zuk',
   tzTokJad: 'TzTok-Jad',
   venenatis: 'Venenatis',
@@ -174,7 +206,7 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
   vorkath: 'Vorkath',
   wintertodt: 'Wintertodt',
   zalcano: 'Zalcano',
-  zulrah: 'Zulrah',
+  zulrah: 'Zulrah'
 };
 
 export type FormattedSkillNames = {
@@ -205,7 +237,7 @@ export const FORMATTED_SKILL_NAMES: FormattedSkillNames = {
   farming: 'Farming',
   runecraft: 'Runecraft',
   hunter: 'Hunter',
-  construction: 'Construction',
+  construction: 'Construction'
 };
 
 export type FormattedClueNames = {
@@ -219,7 +251,7 @@ export const FORMATTED_CLUE_NAMES: FormattedClueNames = {
   medium: 'Clue Scrolls (medium)',
   hard: 'Clue Scrolls (hard)',
   elite: 'Clue Scrolls (elite)',
-  master: 'Clue Scrolls (master)',
+  master: 'Clue Scrolls (master)'
 };
 
 export type FormattedBHNames = {
@@ -227,9 +259,16 @@ 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';
+export const FORMATTED_PVP_ARENA = 'PvP Arena';
+export const FORMATTED_SOUL_WARS = 'Soul Wars Zeal';
 export const FORMATTED_LEAGUE_POINTS = 'League Points';
+export const FORMATTED_RIFTS_CLOSED = 'Rifts Closed';
+
+export const INVALID_FORMAT_ERROR = 'Invalid hiscores format';

src/utils/helpers.ts

@@ -1,20 +1,44 @@
+import axios, { AxiosRequestConfig } from 'axios';
+import * as ua from 'useragent-generator';
 import { Gamemode, SkillName, ActivityName } from '../types';
 import {
   GAMEMODE_URL,
   STATS_URL,
   SCORES_URL,
   SKILLS,
-  ACTIVITIES,
+  ACTIVITIES
 } from './constants';
 
+/**
+ * Will generate a stats URL for the official OSRS API.
+ *
+ * @param gamemode Gamemode to fetch ranks for.
+ * @param rsn Username of the player.
+ * @returns Encoded stats URL.
+ */
 export const getStatsURL = (gamemode: Gamemode, rsn: string) =>
   `${GAMEMODE_URL[gamemode]}${STATS_URL}${encodeURIComponent(rsn)}`;
 
+/**
+ * Will generate a player table URL for the official OSRS hiscores website.
+ *
+ * @param gamemode Gamemode to fetch ranks for.
+ * @param rsn Username of the player.
+ * @returns Encoded player table URL.
+ */
 export const getPlayerTableURL = (gamemode: Gamemode, rsn: string) =>
   `${GAMEMODE_URL[gamemode]}${SCORES_URL}table=0&user=${encodeURIComponent(
     rsn
   )}`;
 
+/**
+ * Will generate a skill table URL for the official OSRS hiscores website.
+ *
+ * @param gamemode Gamemode to fetch ranks for.
+ * @param skill Skill to fetch ranks for.
+ * @param page Page number.
+ * @returns
+ */
 export const getSkillPageURL = (
   gamemode: Gamemode,
   skill: SkillName,
@@ -24,6 +48,14 @@ export const getSkillPageURL = (
     skill
   )}&page=${page}`;
 
+/**
+ * Will generate an activity table URL for the official OSRS hiscores website.
+ *
+ * @param gamemode Gamemode to fetch ranks for.
+ * @param activity Activity or boss to fetch ranks for.
+ * @param page Page number.
+ * @returns
+ */
 export const getActivityPageURL = (
   gamemode: Gamemode,
   activity: ActivityName,
@@ -35,13 +67,58 @@ export const getActivityPageURL = (
     activity
   )}&page=${page}`;
 
-export const numberFromElement = (el: CheerioElement) => {
-  const innerText = el.firstChild.data;
-  const number = innerText ? innerText.replace(/[\n|,]/g, '') : '-1';
+/**
+ * Extracts a number from an OSRS hiscores table cell element.
+ *
+ * @param el OSRS hiscores table cell element.
+ * @returns Number parsed from cell text.
+ */
+export const numberFromElement = (el: Element | null) => {
+  const { innerHTML } = el ?? {};
+  const number = innerHTML?.replace(/[\n|,]/g, '') ?? '-1';
   return parseInt(number, 10);
 };
 
-export const rsnFromElement = (el: CheerioElement) => {
-  const innerText = el.firstChild.data;
-  return innerText ? innerText.replace(/\uFFFD/g, ' ') : '';
+/**
+ * Extracts a RSN from an OSRS hiscores table cell element.
+ *
+ * @param el OSRS hiscores table cell element.
+ * @returns RSN parsed from cell text.
+ */
+export const rsnFromElement = (el: Element | null) => {
+  const { innerHTML } = el ?? {};
+  return innerHTML?.replace(/\uFFFD/g, ' ') ?? '';
+};
+
+/**
+ * Will run an Axios `GET` request against a given URL after injecting a `User-Agent` header.
+ *
+ * @param url URL to run a `GET` request against.
+ * @returns Axios response.
+ */
+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');
+  }
 };

tsconfig.eslint.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./lib",
+    "strict": true
+  },
+  "include": ["src", "**/__tests__/*"],
+  "exclude": ["node_modules"]
+}

tsconfig.json

@@ -4,7 +4,12 @@
     "module": "commonjs",
     "declaration": true,
     "outDir": "./lib",
-    "strict": true
+    "strict": true,
+    "lib": ["ES2015", "DOM", "DOM.Iterable"],
+    "typeRoots": [
+      "./node_modules/@types",
+      "./src/@types"
+    ]
   },
   "include": ["src"],
   "exclude": ["node_modules", "**/__tests__/*"]

tslint.json

@@ -1,20 +0,0 @@
-{
-  "extends": ["tslint-config-airbnb", "tslint-config-prettier"],
-  "rules": {
-    "import-name": false,
-    "indent": [true, "spaces", 2],
-    "max-line-length": [true, 120],
-    "ter-arrow-parens": [false],
-    "strict-boolean-expressions": [false],
-    "variable-name": [false],
-    "semicolon": [true, "always", "ignore-bound-class-methods"],
-    "prefer-array-literal": [false],
-    "quotemark": [
-      true,
-      "single",
-      "jsx-double",
-      "avoid-escape",
-      "avoid-template"
-    ]
-  }
-}