v2.18.0

Add Colosseum Glory, Lunar Chests, Sol Heredit

.github/workflows/main.yml

@@ -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

.gitignore

@@ -1,3 +1,4 @@
 .idea/
 node_modules
 /lib
+.vscode

README.md

@@ -3,24 +3,26 @@
 [![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/workflow/status/maxswa/osrs-json-hiscores/CI?style=flat-square)](https://github.com/maxswa/osrs-json-hiscores/actions/workflows/main.yml?query=branch%3Amain)
+[![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 Old School Runescape API wrapper that does more!**
+**The Old School RuneScape API wrapper that does more!**
 
 ## What it does
 
-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).
+The official hiscores API for Old School RuneScape (OSRS) can return CSV or a simple JSON array.
+This wrapper converts the hiscores data into a more usable JSON object 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.
+Additional functions are provided that screen-scrape the OSRS leaderboards and return a list of players as json. Also simple utility functions are provided to fetch the raw responses from Jagex's APIs, if desired.
 
 `osrs-json-hiscores` has TypeScript support, with full definitions for all functions and custom data types.
 
 ---
 
-### Disclaimer
+### ⚠ Disclaimer ⚠
 
-Jagex does not provide `Access-Control-Allow-Origin` headers in their responses. This means that [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) will block all browser requests to their hiscores API. In order to get around this, osrs-json-hiscores should be installed on the server side and exposed to the front end via a simple API. Here is an example of this in use: [codesandbox.io/s/osrs-json-hiscores-demo](https://codesandbox.io/s/osrs-json-hiscores-demo-qz656)
+Jagex does not provide `Access-Control-Allow-Origin` headers in their responses. This means that [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) will block all browser requests to their hiscores API. In order to get around this, osrs-json-hiscores needs to be installed on the server side and exposed to the front end via a simple API. Here is an example of this in use: [codesandbox.io/s/osrs-json-hiscores-demo](https://codesandbox.io/s/osrs-json-hiscores-demo-qz656)
+
+TLDR: You cannot use this library directly in your client side app e.g. React or Vue, you must set up a server which uses this lib internally and have your client fetch data from your server.
 
 ---
 
@@ -42,27 +44,14 @@ $ yarn add osrs-json-hiscores
 
 Install the package and then import it into your project:
 
-```javascript
-const hiscores = require('osrs-json-hiscores');
+```typescript
+import { getStatsByGamemode, getSkillPage } from 'osrs-json-hiscores';
 ```
 
 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));
-```
-
-If you are using TypeScript or transpiling your JS you can use ES6 syntax:
-
-```javascript
-import hiscores, { getSkillPage } from 'osrs-json-hiscores';
-
-// ...
-
-const stats = await hiscores.getStats('Lynx Titan');
+```typescript
+const stats = await getStatsByGamemode('Lynx Titan');
 const topPage = await getSkillPage('overall');
 ```
 
@@ -81,9 +70,8 @@ const topPage = await getSkillPage('overall');
 
 `getSkillPage` and `getActivityPage` require a skill / activity and optionally a gamemode and page:
 
-```javascript
-hiscores
-  .getSkillPage('attack', 'main', 1)
+```typescript
+getSkillPage('attack', 'main', 1)
   .then((res) => console.log(res))
   .catch((err) => console.error(err));
 ```
@@ -104,18 +92,24 @@ 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` |
-| Soul Wars Zeal         |  `soulWarsZeal`   |
+| Minigame                        |       Param       |
+| ------------------------------- | :---------------: |
+| Bounty Hunter (Legacy - Rogue)  |     `rogueBH`     |
+| Bounty Hunter (Legacy - Hunter) |    `hunterBH`     |
+| Bounty Hunter (Rogue)           |    `rogueBHV2`    |
+| Bounty Hunter (Hunter)          |   `hunterBHV2`    |
+| LMS - Rank                      | `lastManStanding` |
+| PvP Arena - Rank                |    `pvpArena`     |
+| Soul Wars Zeal                  |  `soulWarsZeal`   |
+| Rifts closed                    |   `riftsClosed`   |
+| Colosseum Glory                 | `colosseumGlory`  |
 
-### Leagues
+### Points
 
-| Activity      |     Param      |
-| ------------- | :------------: |
-| League Points | `leaguePoints` |
+| Activity       |      Param      |
+| -------------- | :-------------: |
+| League Points  | `leaguePoints`  |
+| Deadman Points | `deadmanPoints` |
 
 ### Bosses
 
@@ -123,9 +117,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` |
@@ -138,6 +134,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`      |
@@ -147,20 +144,32 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Kraken                            |            `kraken`            |
 | Kreearra                          |           `kreeArra`           |
 | K'ril Tsutsaroth                  |        `krilTsutsaroth`        |
+| Lunar Chests                      |         `lunarChests`          |
 | Mimic                             |            `mimic`             |
-| The Nightmare of Ashihama         |          `nightmare`           |
+| Nex                               |             `nex`              |
+| Nightmare                         |          `nightmare`           |
+| Phosani's Nightmare               |      `phosanisNightmare`       |
 | Obor                              |             `obor`             |
+| Phantom Muspah                    |        `phantomMuspah`         |
 | Sarachnis                         |          `sarachnis`           |
 | Scorpia                           |           `scorpia`            |
+| Scurrius                          |           `scurrius`           |
 | Skotizo                           |           `skotizo`            |
+| Sol Heredit                       |          `solHeredit`          |
+| Spindel                           |           `spindel`            |
 | Tempoross                         |          `tempoross`           |
 | The Gauntlet                      |           `gauntlet`           |
 | The Corrupted Gauntlet            |      `corruptedGauntlet`       |
+| The Leviathan                     |          `leviathan`           |
+| The Whisperer                     |          `whisperer`           |
 | Theatre Of Blood                  |        `theatreOfBlood`        |
 | Theatre Of Blood: Hard Mode       |    `theatreOfBloodHardMode`    |
 | Thermonuclear Smoke Devil         |   `thermonuclearSmokeDevil`    |
+| Tombs of Amascut                  |        `tombsOfAmascut`        |
+| Tombs of Amascut: Expert Mode     |   `tombsOfAmascutExpertMode`   |
 | TzKal-Zuk                         |           `tzKalZuk`           |
 | TzTok-Jad                         |           `tzTokJad`           |
+| Vardorvis                         |          `vardorvis`           |
 | Venenatis                         |          `venenatis`           |
 | Vetion                            |            `vetion`            |
 | Vorkath                           |           `vorkath`            |
@@ -172,7 +181,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 
 `getStats` returns a player object that looks like this:
 
-```javascript
+```typescript
 {
   name: 'Lynx Titan',
   mode: 'main',
@@ -190,7 +199,9 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
     leaguePoints: {},
     bountyHunter: {},
     lastManStanding: {},
+    pvpArena: {},
     soulWarsZeal: {},
+    riftsClosed: {},
     bosses: {}
   }
 }
@@ -198,7 +209,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 
 `getSkillPage` returns and array of 25 players (This represents a page on the hiscores):
 
-```javascript
+```typescript
 [
   { rank: 1, name: 'Lynx Titan', level: 2277, xp: 4600000000, dead: false },
   {},
@@ -211,7 +222,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 
 Get the properly formatted name of any skill, boss, clue or other activity:
 
-```javascript
+```typescript
 // kril === "K'ril Tsutsaroth"
 const kril = FORMATTED_BOSS_NAMES['krilTsutsaroth'];
 ```

__tests__/b0atyStats.csv

@@ -0,0 +1,103 @@
+2910,2277,943515557
+24996,99,30606377
+4759,99,40283500
+1523,99,171953134
+2244,99,147696928
+5929,99,118171038
+4560,99,15170201
+2503,99,71406360
+141823,99,13354119
+22348,99,18680181
+56125,99,13456850
+23026,99,16655688
+18672,99,19123987
+48108,99,14072560
+10956,99,16552060
+27980,99,14967150
+40661,99,13252766
+7114,99,15760818
+53839,99,14058762
+5352,99,34669574
+2456,99,84892847
+4849,99,22734071
+16368,99,17968711
+1147,99,18027875
+-1,-1
+-1,-1
+28384,10
+14076,3
+148183,8
+102684,7
+338,9641
+1002,825
+114,6000
+2246,1606
+44261,298
+603,460
+1238,452
+15827,2521
+-1,-1
+7898,14780
+5421,1060
+7,24522
+2902,2192
+94883,594
+34000,143
+3834,1830
+218428,5
+36717,293
+74959,58
+19421,1905
+186551,34
+2571,515
+85921,50
+154580,26
+54677,287
+2586,2000
+153371,41
+33154,707
+43433,698
+33088,714
+81968,25
+12249,731
+20424,1228
+70188,474
+2248,2140
+11128,226
+2117,2046
+50095,580
+120438,1908
+10997,920
+2326,1444
+-1,-1
+700,40
+31471,626
+4119,749
+4349,500
+1078,217
+20126,301
+70523,119
+114632,26
+2945,1245
+385801,9
+-1,-1
+2412,1569
+43814,273
+207949,7
+86335,201
+7905,601
+732,1783
+21039,310
+4949,192
+7584,3066
+109360,36
+160,1500
+6733,7
+131888,8
+3128,2113
+209,7096
+75591,51
+15167,2780
+911570,62
+173436,25
+233645,275

__tests__/b0atyStats.json

@@ -0,0 +1,205 @@
+{
+  "skills": [
+    {
+      "id": 0,
+      "name": "Overall",
+      "rank": 2910,
+      "level": 2277,
+      "xp": 943515557
+    },
+    { "id": 1, "name": "Attack", "rank": 24996, "level": 99, "xp": 30606377 },
+    { "id": 2, "name": "Defence", "rank": 4759, "level": 99, "xp": 40283500 },
+    { "id": 3, "name": "Strength", "rank": 1523, "level": 99, "xp": 171953134 },
+    {
+      "id": 4,
+      "name": "Hitpoints",
+      "rank": 2244,
+      "level": 99,
+      "xp": 147696928
+    },
+    { "id": 5, "name": "Ranged", "rank": 5929, "level": 99, "xp": 118171038 },
+    { "id": 6, "name": "Prayer", "rank": 4560, "level": 99, "xp": 15170201 },
+    { "id": 7, "name": "Magic", "rank": 2503, "level": 99, "xp": 71406360 },
+    { "id": 8, "name": "Cooking", "rank": 141823, "level": 99, "xp": 13354119 },
+    {
+      "id": 9,
+      "name": "Woodcutting",
+      "rank": 22348,
+      "level": 99,
+      "xp": 18680181
+    },
+    {
+      "id": 10,
+      "name": "Fletching",
+      "rank": 56125,
+      "level": 99,
+      "xp": 13456850
+    },
+    { "id": 11, "name": "Fishing", "rank": 23026, "level": 99, "xp": 16655688 },
+    {
+      "id": 12,
+      "name": "Firemaking",
+      "rank": 18672,
+      "level": 99,
+      "xp": 19123987
+    },
+    {
+      "id": 13,
+      "name": "Crafting",
+      "rank": 48108,
+      "level": 99,
+      "xp": 14072560
+    },
+    {
+      "id": 14,
+      "name": "Smithing",
+      "rank": 10956,
+      "level": 99,
+      "xp": 16552060
+    },
+    { "id": 15, "name": "Mining", "rank": 27980, "level": 99, "xp": 14967150 },
+    {
+      "id": 16,
+      "name": "Herblore",
+      "rank": 40661,
+      "level": 99,
+      "xp": 13252766
+    },
+    { "id": 17, "name": "Agility", "rank": 7114, "level": 99, "xp": 15760818 },
+    {
+      "id": 18,
+      "name": "Thieving",
+      "rank": 53839,
+      "level": 99,
+      "xp": 14058762
+    },
+    { "id": 19, "name": "Slayer", "rank": 5352, "level": 99, "xp": 34669574 },
+    { "id": 20, "name": "Farming", "rank": 2456, "level": 99, "xp": 84892847 },
+    {
+      "id": 21,
+      "name": "Runecraft",
+      "rank": 4849,
+      "level": 99,
+      "xp": 22734071
+    },
+    { "id": 22, "name": "Hunter", "rank": 16368, "level": 99, "xp": 17968711 },
+    {
+      "id": 23,
+      "name": "Construction",
+      "rank": 1147,
+      "level": 99,
+      "xp": 18027875
+    }
+  ],
+  "activities": [
+    { "id": 0, "name": "League Points", "rank": -1, "score": -1 },
+    { "id": 1, "name": "Deadman Points", "rank": -1, "score": -1 },
+    { "id": 2, "name": "Bounty Hunter - Hunter", "rank": 28384, "score": 10 },
+    { "id": 3, "name": "Bounty Hunter - Rogue", "rank": 14076, "score": 3 },
+    {
+      "id": 4,
+      "name": "Bounty Hunter (Legacy) - Hunter",
+      "rank": 148183,
+      "score": 8
+    },
+    {
+      "id": 5,
+      "name": "Bounty Hunter (Legacy) - Rogue",
+      "rank": 102684,
+      "score": 7
+    },
+    { "id": 6, "name": "Clue Scrolls (all)", "rank": 338, "score": 9641 },
+    { "id": 7, "name": "Clue Scrolls (beginner)", "rank": 1002, "score": 825 },
+    { "id": 8, "name": "Clue Scrolls (easy)", "rank": 114, "score": 6000 },
+    { "id": 9, "name": "Clue Scrolls (medium)", "rank": 2246, "score": 1606 },
+    { "id": 10, "name": "Clue Scrolls (hard)", "rank": 44261, "score": 298 },
+    { "id": 11, "name": "Clue Scrolls (elite)", "rank": 603, "score": 460 },
+    { "id": 12, "name": "Clue Scrolls (master)", "rank": 1238, "score": 452 },
+    { "id": 13, "name": "LMS - Rank", "rank": 15827, "score": 2521 },
+    { "id": 14, "name": "PvP Arena - Rank", "rank": -1, "score": -1 },
+    { "id": 15, "name": "Soul Wars Zeal", "rank": 7898, "score": 14780 },
+    { "id": 16, "name": "Rifts closed", "rank": 5421, "score": 1060 },
+    { "id": 17, "name": "Colosseum Glory", "rank": 7, "score": 24522 },
+    { "id": 18, "name": "Abyssal Sire", "rank": 2902, "score": 2192 },
+    { "id": 19, "name": "Alchemical Hydra", "rank": 94883, "score": 594 },
+    { "id": 20, "name": "Artio", "rank": 34000, "score": 143 },
+    { "id": 21, "name": "Barrows Chests", "rank": 3834, "score": 1830 },
+    { "id": 22, "name": "Bryophyta", "rank": 218428, "score": 5 },
+    { "id": 23, "name": "Callisto", "rank": 36717, "score": 293 },
+    { "id": 24, "name": "Calvar'ion", "rank": 74959, "score": 58 },
+    { "id": 25, "name": "Cerberus", "rank": 19421, "score": 1905 },
+    { "id": 26, "name": "Chambers of Xeric", "rank": 186551, "score": 34 },
+    {
+      "id": 27,
+      "name": "Chambers of Xeric: Challenge Mode",
+      "rank": 2571,
+      "score": 515
+    },
+    { "id": 28, "name": "Chaos Elemental", "rank": 85921, "score": 50 },
+    { "id": 29, "name": "Chaos Fanatic", "rank": 154580, "score": 26 },
+    { "id": 30, "name": "Commander Zilyana", "rank": 54677, "score": 287 },
+    { "id": 31, "name": "Corporeal Beast", "rank": 2586, "score": 2000 },
+    { "id": 32, "name": "Crazy Archaeologist", "rank": 153371, "score": 41 },
+    { "id": 33, "name": "Dagannoth Prime", "rank": 33154, "score": 707 },
+    { "id": 34, "name": "Dagannoth Rex", "rank": 43433, "score": 698 },
+    { "id": 35, "name": "Dagannoth Supreme", "rank": 33088, "score": 714 },
+    { "id": 36, "name": "Deranged Archaeologist", "rank": 81968, "score": 25 },
+    { "id": 37, "name": "Duke Sucellus", "rank": 12249, "score": 731 },
+    { "id": 38, "name": "General Graardor", "rank": 20424, "score": 1228 },
+    { "id": 39, "name": "Giant Mole", "rank": 70188, "score": 474 },
+    { "id": 40, "name": "Grotesque Guardians", "rank": 2248, "score": 2140 },
+    { "id": 41, "name": "Hespori", "rank": 11128, "score": 226 },
+    { "id": 42, "name": "Kalphite Queen", "rank": 2117, "score": 2046 },
+    { "id": 43, "name": "King Black Dragon", "rank": 50095, "score": 580 },
+    { "id": 44, "name": "Kraken", "rank": 120438, "score": 1908 },
+    { "id": 45, "name": "Kree'Arra", "rank": 10997, "score": 920 },
+    { "id": 46, "name": "K'ril Tsutsaroth", "rank": 2326, "score": 1444 },
+    { "id": 47, "name": "Lunar Chests", "rank": -1, "score": -1 },
+    { "id": 48, "name": "Mimic", "rank": 700, "score": 40 },
+    { "id": 49, "name": "Nex", "rank": 31471, "score": 626 },
+    { "id": 50, "name": "Nightmare", "rank": 4119, "score": 749 },
+    { "id": 51, "name": "Phosani's Nightmare", "rank": 4349, "score": 500 },
+    { "id": 52, "name": "Obor", "rank": 1078, "score": 217 },
+    { "id": 53, "name": "Phantom Muspah", "rank": 20126, "score": 301 },
+    { "id": 54, "name": "Sarachnis", "rank": 70523, "score": 119 },
+    { "id": 55, "name": "Scorpia", "rank": 114632, "score": 26 },
+    { "id": 56, "name": "Scurrius", "rank": 2945, "score": 1245 },
+    { "id": 57, "name": "Skotizo", "rank": 385801, "score": 9 },
+    { "id": 58, "name": "Sol Heredit", "rank": -1, "score": -1 },
+    { "id": 59, "name": "Spindel", "rank": 2412, "score": 1569 },
+    { "id": 60, "name": "Tempoross", "rank": 43814, "score": 273 },
+    { "id": 61, "name": "The Gauntlet", "rank": 207949, "score": 7 },
+    { "id": 62, "name": "The Corrupted Gauntlet", "rank": 86335, "score": 201 },
+    { "id": 63, "name": "The Leviathan", "rank": 7905, "score": 601 },
+    { "id": 64, "name": "The Whisperer", "rank": 732, "score": 1783 },
+    { "id": 65, "name": "Theatre of Blood", "rank": 21039, "score": 310 },
+    {
+      "id": 66,
+      "name": "Theatre of Blood: Hard Mode",
+      "rank": 4949,
+      "score": 192
+    },
+    {
+      "id": 67,
+      "name": "Thermonuclear Smoke Devil",
+      "rank": 7584,
+      "score": 3066
+    },
+    { "id": 68, "name": "Tombs of Amascut", "rank": 109360, "score": 36 },
+    {
+      "id": 69,
+      "name": "Tombs of Amascut: Expert Mode",
+      "rank": 160,
+      "score": 1500
+    },
+    { "id": 70, "name": "TzKal-Zuk", "rank": 6733, "score": 7 },
+    { "id": 71, "name": "TzTok-Jad", "rank": 131888, "score": 8 },
+    { "id": 72, "name": "Vardorvis", "rank": 3128, "score": 2113 },
+    { "id": 73, "name": "Venenatis", "rank": 209, "score": 7096 },
+    { "id": 74, "name": "Vet'ion", "rank": 75591, "score": 51 },
+    { "id": 75, "name": "Vorkath", "rank": 15167, "score": 2780 },
+    { "id": 76, "name": "Wintertodt", "rank": 911570, "score": 62 },
+    { "id": 77, "name": "Zalcano", "rank": 173436, "score": 25 },
+    { "id": 78, "name": "Zulrah", "rank": 233645, "score": 275 }
+  ]
+}

__tests__/hiscores.test.ts

@@ -10,7 +10,12 @@ import {
   Stats,
   getPlayerTableURL,
   getSkillPageURL,
-  getStatsURL
+  getStatsURL,
+  BOSSES,
+  InvalidFormatError,
+  BH_MODES,
+  parseJsonStats,
+  HiscoresResponse
 } from '../src/index';
 
 const B0ATY_NAME = 'B0ATY';
@@ -22,7 +27,13 @@ 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 b0atyStatsCsv = readFileSync(`${__dirname}/b0atyStats.csv`, 'utf8');
+const b0atyStatsJson: HiscoresResponse = JSON.parse(
+  readFileSync(`${__dirname}/b0atyStats.json`, 'utf8')
+);
+const lynxTitanStats = JSON.parse(
+  readFileSync(`${__dirname}/lynxTitanStats.json`, 'utf8')
+);
 const lynxTitanNamePage = readFileSync(
   `${__dirname}/lynxTitanNamePage.html`,
   'utf8'
@@ -43,7 +54,7 @@ jest.spyOn(axios, 'get').mockImplementation((url) => {
   if (getSkillPageURL('main', 'attack', 1) === url) {
     return Promise.resolve({ data: attackTopPage });
   }
-  if (getStatsURL('main', LYNX_TITAN_FORMATTED_NAME) === url) {
+  if (getStatsURL('main', LYNX_TITAN_FORMATTED_NAME, true) === url) {
     return Promise.resolve({ status: 200, data: lynxTitanStats });
   }
   throw new Error(`No mock response for URL: ${url}`);
@@ -75,6 +86,9 @@ test('Parse CSV to json', () => {
   810,99,37688883
   92,99,32005622
   23423,478
+  89554,301
+  89914,35
+  99834,25
   99831,23
   89912,37
   32,12148
@@ -85,12 +99,17 @@ test('Parse CSV to json', () => {
   392,250
   1,6143
   4814,898
+  13,4057
   37,225
+  25,1110
+  7827,43249
   382,2780
   944,3000
+  704,892
   1981,1452
   4981,23
   888,1046
+  444,792
   613,4856
   102,4038
   156,334
@@ -103,6 +122,7 @@ test('Parse CSV to json', () => {
   4342,1655
   966,2951
   10151,1
+  1289,2477
   1288,2407
   377,4669
   545,1567
@@ -112,20 +132,32 @@ test('Parse CSV to json', () => {
   41643,1477
   625,2391
   120,2981
+  54,2958
   1,109
+  99,39002
   3,22666
+  2,84
   26,323
+  44,6233
   201,1101
   82,3404
+  555,7079
   5085,61
+  8731,1423
+  678,903
   18823,23
   63,375
   2870,6
+  2871,7
+  2872,8
   6984,138
   23,923141
   4043,2000
+  4073,1020
+  289,13070
   489,8
   967,47
+  968,48
   11155,223
   1940,272
   8623,1340
@@ -161,12 +193,18 @@ test('Parse CSV to json', () => {
       construction: { rank: 92, level: 99, xp: 32005622 }
     },
     leaguePoints: { rank: 23423, score: 478 },
+    deadmanPoints: { rank: 89554, score: 301 },
     bountyHunter: {
+      hunterV2: { rank: 89914, score: 35 },
+      rogueV2: { rank: 99834, score: 25 },
       hunter: { rank: 99831, score: 23 },
       rogue: { rank: 89912, score: 37 }
     },
     lastManStanding: { rank: 4814, score: 898 },
+    pvpArena: { rank: 13, score: 4057 },
     soulWarsZeal: { rank: 37, score: 225 },
+    riftsClosed: { rank: 25, score: 1110 },
+    colosseumGlory: { rank: 7827, score: 43249 },
     clues: {
       all: { rank: 32, score: 12148 },
       beginner: { rank: 3105, score: 76 },
@@ -179,9 +217,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 },
@@ -194,6 +234,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 },
@@ -203,20 +244,32 @@ test('Parse CSV to json', () => {
       kraken: { rank: 41643, score: 1477 },
       kreeArra: { rank: 625, score: 2391 },
       krilTsutsaroth: { rank: 120, score: 2981 },
+      lunarChests: { rank: 54, score: 2958 },
       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 },
+      phantomMuspah: { rank: 44, score: 6233 },
       sarachnis: { rank: 201, score: 1101 },
       scorpia: { rank: 82, score: 3404 },
+      scurrius: { rank: 555, score: 7079 },
       skotizo: { rank: 5085, score: 61 },
+      solHeredit: { rank: 8731, score: 1423 },
+      spindel: { rank: 678, score: 903 },
       tempoross: { rank: 18823, score: 23 },
       gauntlet: { rank: 63, score: 375 },
       corruptedGauntlet: { rank: 2870, score: 6 },
+      leviathan: { rank: 2871, score: 7 },
+      whisperer: { rank: 2872, score: 8 },
       theatreOfBlood: { rank: 6984, score: 138 },
       theatreOfBloodHardMode: { rank: 23, score: 923141 },
       thermonuclearSmokeDevil: { rank: 4043, score: 2000 },
+      tombsOfAmascut: { rank: 4073, score: 1020 },
+      tombsOfAmascutExpertMode: { rank: 289, score: 13070 },
       tzKalZuk: { rank: 489, score: 8 },
       tzTokJad: { rank: 967, score: 47 },
+      vardorvis: { rank: 968, score: 48 },
       venenatis: { rank: 11155, score: 223 },
       vetion: { rank: 1940, score: 272 },
       vorkath: { rank: 8623, score: 1340 },
@@ -229,6 +282,18 @@ test('Parse CSV to json', () => {
   expect(parseStats(csv)).toStrictEqual(expectedOutput);
 });
 
+test('Parse CSV with unknown activity', () => {
+  const statsWithUnknownActivity = `${lynxTitanStats}
+    -1,-1`;
+  expect(() => parseStats(statsWithUnknownActivity)).toThrow(
+    InvalidFormatError
+  );
+});
+
+test('Parse invalid CSV', () => {
+  expect(() => parseStats('invalid')).toThrow(InvalidFormatError);
+});
+
 describe('Get name format', () => {
   it('gets a name with a space', async () => {
     const data = await getRSNFormat(LYNX_TITAN_SPACE_NAME);
@@ -441,7 +506,10 @@ test('Get non-existent player', async () => {
 });
 
 test('Get stats by gamemode', async () => {
-  const { skills } = await getStatsByGamemode(LYNX_TITAN_FORMATTED_NAME);
+  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 },
@@ -468,4 +536,70 @@ test('Get stats by gamemode', async () => {
     hunter: { 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, true),
+      getPlayerTableURL('main', rsn),
+      getStatsURL('ironman', rsn, true),
+      getStatsURL('hardcore', rsn, true),
+      getStatsURL('ultimate', rsn, true)
+    ]);
+  });
+  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();
+  });
+  it('omits excluded gamemodes', async () => {
+    const response = await getStats(rsn, {
+      otherGamemodes: ['ironman', 'ultimate']
+    });
+    expect(response.hardcore).toBeUndefined();
+  });
+});
+
+test('CSV and JSON parsing outputs identical object', async () => {
+  const csvOutput = parseStats(b0atyStatsCsv);
+  const jsonOutput = parseJsonStats(b0atyStatsJson);
+  expect(csvOutput).toEqual(jsonOutput);
 });

__tests__/lynxTitanStats.csv

@@ -1,81 +0,0 @@
-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
-24,99,200000000
-12,99,200000000
-2,99,200000000
-19,99,200000000
-7,99,200000000
-4,99,200000000
-4,99,200000000
--1,-1
--1,-1
--1,-1
--1,-1
--1,-1
--1,-1
--1,-1
-344430,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

__tests__/lynxTitanStats.json

@@ -0,0 +1,152 @@
+{
+  "skills": [
+    { "id": 0, "name": "Overall", "rank": 1, "level": 2277, "xp": 4600000000 },
+    { "id": 1, "name": "Attack", "rank": 15, "level": 99, "xp": 200000000 },
+    { "id": 2, "name": "Defence", "rank": 28, "level": 99, "xp": 200000000 },
+    { "id": 3, "name": "Strength", "rank": 18, "level": 99, "xp": 200000000 },
+    { "id": 4, "name": "Hitpoints", "rank": 7, "level": 99, "xp": 200000000 },
+    { "id": 5, "name": "Ranged", "rank": 8, "level": 99, "xp": 200000000 },
+    { "id": 6, "name": "Prayer", "rank": 11, "level": 99, "xp": 200000000 },
+    { "id": 7, "name": "Magic", "rank": 30, "level": 99, "xp": 200000000 },
+    { "id": 8, "name": "Cooking", "rank": 154, "level": 99, "xp": 200000000 },
+    {
+      "id": 9,
+      "name": "Woodcutting",
+      "rank": 15,
+      "level": 99,
+      "xp": 200000000
+    },
+    { "id": 10, "name": "Fletching", "rank": 12, "level": 99, "xp": 200000000 },
+    { "id": 11, "name": "Fishing", "rank": 9, "level": 99, "xp": 200000000 },
+    {
+      "id": 12,
+      "name": "Firemaking",
+      "rank": 48,
+      "level": 99,
+      "xp": 200000000
+    },
+    { "id": 13, "name": "Crafting", "rank": 4, "level": 99, "xp": 200000000 },
+    { "id": 14, "name": "Smithing", "rank": 3, "level": 99, "xp": 200000000 },
+    { "id": 15, "name": "Mining", "rank": 24, "level": 99, "xp": 200000000 },
+    { "id": 16, "name": "Herblore", "rank": 5, "level": 99, "xp": 200000000 },
+    { "id": 17, "name": "Agility", "rank": 24, "level": 99, "xp": 200000000 },
+    { "id": 18, "name": "Thieving", "rank": 12, "level": 99, "xp": 200000000 },
+    { "id": 19, "name": "Slayer", "rank": 2, "level": 99, "xp": 200000000 },
+    { "id": 20, "name": "Farming", "rank": 19, "level": 99, "xp": 200000000 },
+    { "id": 21, "name": "Runecraft", "rank": 6, "level": 99, "xp": 200000000 },
+    { "id": 22, "name": "Hunter", "rank": 4, "level": 99, "xp": 200000000 },
+    {
+      "id": 23,
+      "name": "Construction",
+      "rank": 4,
+      "level": 99,
+      "xp": 200000000
+    }
+  ],
+  "activities": [
+    { "id": 0, "name": "League Points", "rank": -1, "score": -1 },
+    { "id": 1, "name": "Deadman Points", "rank": -1, "score": -1 },
+    { "id": 2, "name": "Bounty Hunter - Hunter", "rank": -1, "score": -1 },
+    { "id": 3, "name": "Bounty Hunter - Rogue", "rank": -1, "score": -1 },
+    {
+      "id": 4,
+      "name": "Bounty Hunter (Legacy) - Hunter",
+      "rank": -1,
+      "score": -1
+    },
+    {
+      "id": 5,
+      "name": "Bounty Hunter (Legacy) - Rogue",
+      "rank": -1,
+      "score": -1
+    },
+    { "id": 6, "name": "Clue Scrolls (all)", "rank": 832420, "score": 22 },
+    { "id": 7, "name": "Clue Scrolls (beginner)", "rank": -1, "score": -1 },
+    { "id": 8, "name": "Clue Scrolls (easy)", "rank": -1, "score": -1 },
+    { "id": 9, "name": "Clue Scrolls (medium)", "rank": -1, "score": -1 },
+    { "id": 10, "name": "Clue Scrolls (hard)", "rank": 517091, "score": 22 },
+    { "id": 11, "name": "Clue Scrolls (elite)", "rank": -1, "score": -1 },
+    { "id": 12, "name": "Clue Scrolls (master)", "rank": -1, "score": -1 },
+    { "id": 13, "name": "LMS - Rank", "rank": -1, "score": -1 },
+    { "id": 14, "name": "PvP Arena - Rank", "rank": -1, "score": -1 },
+    { "id": 15, "name": "Soul Wars Zeal", "rank": -1, "score": -1 },
+    { "id": 16, "name": "Rifts closed", "rank": -1, "score": -1 },
+    { "id": 17, "name": "Colosseum Glory", "rank": -1, "score": -1 },
+    { "id": 18, "name": "Abyssal Sire", "rank": -1, "score": -1 },
+    { "id": 19, "name": "Alchemical Hydra", "rank": -1, "score": -1 },
+    { "id": 20, "name": "Artio", "rank": -1, "score": -1 },
+    { "id": 21, "name": "Barrows Chests", "rank": -1, "score": -1 },
+    { "id": 22, "name": "Bryophyta", "rank": -1, "score": -1 },
+    { "id": 23, "name": "Callisto", "rank": -1, "score": -1 },
+    { "id": 24, "name": "Calvar'ion", "rank": -1, "score": -1 },
+    { "id": 25, "name": "Cerberus", "rank": -1, "score": -1 },
+    { "id": 26, "name": "Chambers of Xeric", "rank": -1, "score": -1 },
+    {
+      "id": 27,
+      "name": "Chambers of Xeric: Challenge Mode",
+      "rank": -1,
+      "score": -1
+    },
+    { "id": 28, "name": "Chaos Elemental", "rank": -1, "score": -1 },
+    { "id": 29, "name": "Chaos Fanatic", "rank": -1, "score": -1 },
+    { "id": 30, "name": "Commander Zilyana", "rank": -1, "score": -1 },
+    { "id": 31, "name": "Corporeal Beast", "rank": -1, "score": -1 },
+    { "id": 32, "name": "Crazy Archaeologist", "rank": -1, "score": -1 },
+    { "id": 33, "name": "Dagannoth Prime", "rank": -1, "score": -1 },
+    { "id": 34, "name": "Dagannoth Rex", "rank": -1, "score": -1 },
+    { "id": 35, "name": "Dagannoth Supreme", "rank": -1, "score": -1 },
+    { "id": 36, "name": "Deranged Archaeologist", "rank": -1, "score": -1 },
+    { "id": 37, "name": "Duke Sucellus", "rank": -1, "score": -1 },
+    { "id": 38, "name": "General Graardor", "rank": -1, "score": -1 },
+    { "id": 39, "name": "Giant Mole", "rank": -1, "score": -1 },
+    { "id": 40, "name": "Grotesque Guardians", "rank": -1, "score": -1 },
+    { "id": 41, "name": "Hespori", "rank": -1, "score": -1 },
+    { "id": 42, "name": "Kalphite Queen", "rank": -1, "score": -1 },
+    { "id": 43, "name": "King Black Dragon", "rank": -1, "score": -1 },
+    { "id": 44, "name": "Kraken", "rank": -1, "score": -1 },
+    { "id": 45, "name": "Kree'Arra", "rank": -1, "score": -1 },
+    { "id": 46, "name": "K'ril Tsutsaroth", "rank": -1, "score": -1 },
+    { "id": 47, "name": "Lunar Chests", "rank": -1, "score": -1 },
+    { "id": 48, "name": "Mimic", "rank": -1, "score": -1 },
+    { "id": 49, "name": "Nex", "rank": -1, "score": -1 },
+    { "id": 50, "name": "Nightmare", "rank": -1, "score": -1 },
+    { "id": 51, "name": "Phosani's Nightmare", "rank": -1, "score": -1 },
+    { "id": 52, "name": "Obor", "rank": -1, "score": -1 },
+    { "id": 53, "name": "Phantom Muspah", "rank": -1, "score": -1 },
+    { "id": 54, "name": "Sarachnis", "rank": -1, "score": -1 },
+    { "id": 55, "name": "Scorpia", "rank": -1, "score": -1 },
+    { "id": 56, "name": "Scurrius", "rank": -1, "score": -1 },
+    { "id": 57, "name": "Skotizo", "rank": -1, "score": -1 },
+    { "id": 58, "name": "Sol Heredit", "rank": -1, "score": -1 },
+    { "id": 59, "name": "Spindel", "rank": -1, "score": -1 },
+    { "id": 60, "name": "Tempoross", "rank": -1, "score": -1 },
+    { "id": 61, "name": "The Gauntlet", "rank": -1, "score": -1 },
+    { "id": 62, "name": "The Corrupted Gauntlet", "rank": -1, "score": -1 },
+    { "id": 63, "name": "The Leviathan", "rank": -1, "score": -1 },
+    { "id": 64, "name": "The Whisperer", "rank": -1, "score": -1 },
+    { "id": 65, "name": "Theatre of Blood", "rank": -1, "score": -1 },
+    {
+      "id": 66,
+      "name": "Theatre of Blood: Hard Mode",
+      "rank": -1,
+      "score": -1
+    },
+    { "id": 67, "name": "Thermonuclear Smoke Devil", "rank": -1, "score": -1 },
+    { "id": 68, "name": "Tombs of Amascut", "rank": -1, "score": -1 },
+    {
+      "id": 69,
+      "name": "Tombs of Amascut: Expert Mode",
+      "rank": -1,
+      "score": -1
+    },
+    { "id": 70, "name": "TzKal-Zuk", "rank": -1, "score": -1 },
+    { "id": 71, "name": "TzTok-Jad", "rank": 251, "score": 186 },
+    { "id": 72, "name": "Vardorvis", "rank": -1, "score": -1 },
+    { "id": 73, "name": "Venenatis", "rank": -1, "score": -1 },
+    { "id": 74, "name": "Vet'ion", "rank": -1, "score": -1 },
+    { "id": 75, "name": "Vorkath", "rank": -1, "score": -1 },
+    { "id": 76, "name": "Wintertodt", "rank": -1, "score": -1 },
+    { "id": 77, "name": "Zalcano", "rank": -1, "score": -1 },
+    { "id": 78, "name": "Zulrah", "rank": -1, "score": -1 }
+  ]
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.4.2",
+  "version": "2.18.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,18 +61,23 @@
       "@typescript-eslint"
     ],
     "extends": [
-      "eslint-config-airbnb-typescript",
+      "airbnb-base",
+      "airbnb-typescript/base",
       "prettier"
     ],
     "ignorePatterns": [
       "**/@types/*"
-    ]
+    ],
+    "rules": {
+      "max-classes-per-file": "off"
+    }
   },
   "prettier": {
     "trailingComma": "none",
     "tabWidth": 2,
     "semi": true,
-    "singleQuote": true
+    "singleQuote": true,
+    "endOfLine": "auto"
   },
   "jest": {
     "transform": {
@@ -87,28 +95,25 @@
     "testEnvironment": "node"
   },
   "dependencies": {
-    "axios": "^0.21.1",
-    "jsdom": "^16.3.0",
+    "axios": "^1.6.2",
+    "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"
   }
 }

src/hiscores.ts

@@ -1,4 +1,5 @@
-import { JSDOM } from 'jsdom';
+import axios, { AxiosRequestConfig } from 'axios';
+import { BinaryData, JSDOM } from 'jsdom';
 import {
   Player,
   Activity,
@@ -12,7 +13,9 @@ import {
   PlayerSkillRow,
   ActivityName,
   PlayerActivityRow,
-  Bosses
+  Bosses,
+  GetStatsOptions,
+  HiscoresResponse
 } from './types';
 import {
   getStatsURL,
@@ -27,41 +30,158 @@ import {
   rsnFromElement,
   getActivityPageURL,
   httpGet,
-  BOSSES
+  BOSSES,
+  InvalidFormatError,
+  PlayerNotFoundError,
+  HiScoresError,
+  validateRSN,
+  FORMATTED_SKILL_NAMES,
+  FORMATTED_BH_NAMES,
+  FORMATTED_CLUE_NAMES,
+  FORMATTED_BOSS_NAMES,
+  FORMATTED_LEAGUE_POINTS,
+  FORMATTED_LMS,
+  FORMATTED_PVP_ARENA,
+  FORMATTED_SOUL_WARS,
+  FORMATTED_RIFTS_CLOSED,
+  FORMATTED_DEADMAN_POINTS,
+  FORMATTED_COLOSSEUM_GLORY
 } from './utils';
 
+/**
+ * Gets a player's stats from the official OSRS JSON endpoint.
+ *
+ * @param rsn Username of the player.
+ * @param mode Gamemode to fetch ranks for.
+ * @param config Optional axios request config object.
+ * @returns Official JSON stats object.
+ */
+export async function getOfficialStats(
+  rsn: string,
+  mode: Gamemode = 'main',
+  config?: AxiosRequestConfig
+): Promise<HiscoresResponse> {
+  validateRSN(rsn);
+
+  const url = getStatsURL(mode, rsn, true);
+  try {
+    const response = await httpGet<HiscoresResponse>(url, config);
+    return response.data;
+  } catch (err) {
+    if (!axios.isAxiosError(err)) throw err;
+
+    if (err.response?.status === 404) throw new PlayerNotFoundError();
+
+    throw new HiScoresError();
+  }
+}
+
 /**
  * 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 dom = new JSDOM(response.data);
-    const spans = dom.window.document.querySelectorAll(
-      'span[style="color:#AA0022;"]'
+    const response = await httpGet<string | Buffer | BinaryData | undefined>(
+      url,
+      config
     );
-    if (spans.length >= 2) {
-      const nameSpan = spans[1];
-      return rsnFromElement(nameSpan);
+    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');
+    throw new PlayerNotFoundError();
   } catch {
-    throw Error('Player not found');
+    throw new HiScoresError();
   }
 }
 
+/**
+ * Parses official JSON object of raw stats and returns a stats object.
+ *
+ * @param csv Raw JSON from the official OSRS API.
+ * @returns Parsed stats object.
+ */
+export function parseJsonStats(json: HiscoresResponse): Stats {
+  const getActivity = (formattedName: string): Activity => {
+    const hiscoresActivity = json.activities.find(
+      // We must match on name here since id is not guaranteed to be the same between updates
+      ({ name }) => name.toLowerCase() === formattedName.toLowerCase()
+    );
+    return {
+      rank: hiscoresActivity?.rank ?? -1,
+      score: hiscoresActivity?.score ?? -1
+    };
+  };
+  const reduceActivity = <Key extends string, Reduced = Record<Key, Activity>>(
+    keys: Key[],
+    formattedNames: Record<Key, string>
+  ): Reduced =>
+    keys.reduce<Reduced>(
+      (reducer, key) => ({
+        ...reducer,
+        [key]: getActivity(formattedNames[key])
+      }),
+      {} as Reduced
+    );
+
+  const skills = SKILLS.reduce<Skills>((skillsObject, skillName) => {
+    const hiscoresSkill = json.skills.find(
+      // We must match on name here since id is not guaranteed to be the same between updates
+      ({ name }) =>
+        name.toLowerCase() === FORMATTED_SKILL_NAMES[skillName].toLowerCase()
+    );
+    return {
+      ...skillsObject,
+      [skillName]: {
+        rank: hiscoresSkill?.rank ?? -1,
+        level: hiscoresSkill?.level ?? -1,
+        xp: hiscoresSkill?.xp ?? -1
+      }
+    };
+  }, {} as Skills);
+
+  const bountyHunter = reduceActivity(BH_MODES, FORMATTED_BH_NAMES);
+  const clues = reduceActivity(CLUES, FORMATTED_CLUE_NAMES);
+  const bosses = reduceActivity(BOSSES, FORMATTED_BOSS_NAMES);
+
+  const leaguePoints = getActivity(FORMATTED_LEAGUE_POINTS);
+  const deadmanPoints = getActivity(FORMATTED_DEADMAN_POINTS);
+  const lastManStanding = getActivity(FORMATTED_LMS);
+  const pvpArena = getActivity(FORMATTED_PVP_ARENA);
+  const soulWarsZeal = getActivity(FORMATTED_SOUL_WARS);
+  const riftsClosed = getActivity(FORMATTED_RIFTS_CLOSED);
+  const colosseumGlory = getActivity(FORMATTED_COLOSSEUM_GLORY);
+
+  const stats: Stats = {
+    skills,
+    leaguePoints,
+    deadmanPoints,
+    bountyHunter,
+    lastManStanding,
+    pvpArena,
+    soulWarsZeal,
+    riftsClosed,
+    colosseumGlory,
+    clues,
+    bosses
+  };
+
+  return stats;
+}
+
 /**
  * Parses CSV string of raw stats and returns a stats object.
  *
@@ -74,6 +194,10 @@ export function parseStats(csv: string): Stats {
     .filter((entry) => !!entry)
     .map((stat) => stat.split(','));
 
+  if (splitCSV.length !== SKILLS.length + ACTIVITIES.length) {
+    throw new InvalidFormatError();
+  }
+
   const skillObjects: Skill[] = splitCSV
     .filter((stat) => stat.length === 3)
     .map((stat) => {
@@ -97,10 +221,11 @@ export function parseStats(csv: string): Stats {
       return activity;
     });
 
-  const [leaguePoints] = activityObjects.splice(0, 1);
+  const [leaguePoints, deadmanPoints] = activityObjects.splice(0, 2);
   const bhObjects = activityObjects.splice(0, BH_MODES.length);
   const clueObjects = activityObjects.splice(0, CLUES.length);
-  const [lastManStanding, soulWarsZeal] = activityObjects.splice(0, 2);
+  const [lastManStanding, pvpArena, soulWarsZeal, riftsClosed, colosseumGlory] =
+    activityObjects.splice(0, 5);
   const bossObjects = activityObjects.splice(0, BOSSES.length);
 
   const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
@@ -130,9 +255,13 @@ export function parseStats(csv: string): Stats {
   const stats: Stats = {
     skills,
     leaguePoints,
+    deadmanPoints,
     bountyHunter,
     lastManStanding,
+    pvpArena,
     soulWarsZeal,
+    riftsClosed,
+    colosseumGlory,
     clues,
     bosses
   };
@@ -149,81 +278,82 @@ 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));
-  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 main = await getOfficialStats(rsn, 'main', options?.axiosConfigs?.main);
 
-    const [ironRes, hcRes, ultRes, formattedName] = otherResponses;
+  const getModeStats = async (
+    mode: Extract<Gamemode, 'ironman' | 'hardcore' | 'ultimate'>
+  ): Promise<HiscoresResponse | undefined> =>
+    otherGamemodes.includes(mode)
+      ? getOfficialStats(rsn, mode, options?.axiosConfigs?.[mode]).catch(
+          () => undefined
+        )
+      : undefined;
+  const formattedName = shouldGetFormattedRsn
+    ? await getRSNFormat(rsn, options?.axiosConfigs?.rsn).catch(() => undefined)
+    : undefined;
 
-    const player: Player = {
-      name: formattedName ?? rsn,
-      mode: 'main',
-      dead: false,
-      deulted: false,
-      deironed: false
-    };
-    player.main = parseStats(mainRes.data);
+  const player: Player = {
+    name: formattedName ?? rsn,
+    mode: 'main',
+    dead: false,
+    deulted: false,
+    deironed: false
+  };
+  player.main = parseJsonStats(main);
 
-    if (ironRes.status === 200) {
-      player.ironman = parseStats(ironRes.data);
-      if (hcRes.status === 200) {
-        player.mode = 'hardcore';
-        player.hardcore = parseStats(hcRes.data);
-        if (
-          player.ironman.skills.overall.xp !== player.hardcore.skills.overall.xp
-        ) {
-          player.dead = true;
-          player.mode = 'ironman';
-        }
-        if (
-          player.main.skills.overall.xp !== player.ironman.skills.overall.xp
-        ) {
-          player.deironed = true;
-          player.mode = 'main';
-        }
-      } else if (ultRes.status === 200) {
-        player.mode = 'ultimate';
-        player.ultimate = parseStats(ultRes.data);
-        if (
-          player.ironman.skills.overall.xp !== player.ultimate.skills.overall.xp
-        ) {
-          player.deulted = true;
-          player.mode = 'ironman';
-        }
-        if (
-          player.main.skills.overall.xp !== player.ironman.skills.overall.xp
-        ) {
-          player.deironed = true;
-          player.mode = 'main';
-        }
-      } else {
+  const iron = await getModeStats('ironman');
+  if (iron) {
+    player.ironman = parseJsonStats(iron);
+    const hc = await getModeStats('hardcore');
+    const ult = await getModeStats('ultimate');
+    if (hc) {
+      player.mode = 'hardcore';
+      player.hardcore = parseJsonStats(hc);
+      if (
+        player.ironman.skills.overall.xp !== player.hardcore.skills.overall.xp
+      ) {
+        player.dead = true;
         player.mode = 'ironman';
-        if (
-          player.main.skills.overall.xp !== player.ironman.skills.overall.xp
-        ) {
-          player.deironed = true;
-          player.mode = 'main';
-        }
+      }
+      if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
+        player.deironed = true;
+        player.mode = 'main';
+      }
+    } else if (ult) {
+      player.mode = 'ultimate';
+      player.ultimate = parseJsonStats(ult);
+      if (
+        player.ironman.skills.overall.xp !== player.ultimate.skills.overall.xp
+      ) {
+        player.deulted = true;
+        player.mode = 'ironman';
+      }
+      if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
+        player.deironed = true;
+        player.mode = 'main';
+      }
+    } else {
+      player.mode = 'ironman';
+      if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
+        player.deironed = true;
+        player.mode = 'main';
       }
     }
-
-    return player;
   }
-  throw Error('Player not found');
+
+  return player;
 }
 
 /**
@@ -231,26 +361,20 @@ 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));
-  if (response.status !== 200) {
-    throw Error('Player not found');
-  }
-  const stats = parseStats(response.data);
+  const response = await getOfficialStats(rsn, mode, config);
+  const stats = parseJsonStats(response);
 
   return stats;
 }
@@ -258,7 +382,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');
@@ -269,7 +394,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'
@@ -301,12 +429,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');
@@ -317,7 +447,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'

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'
@@ -79,6 +86,7 @@ export type Boss =
   | 'dagannothRex'
   | 'dagannothSupreme'
   | 'derangedArchaeologist'
+  | 'dukeSucellus'
   | 'generalGraardor'
   | 'giantMole'
   | 'grotesqueGuardians'
@@ -88,20 +96,32 @@ export type Boss =
   | 'kraken'
   | 'kreeArra'
   | 'krilTsutsaroth'
+  | 'lunarChests'
   | 'mimic'
+  | 'nex'
   | 'nightmare'
+  | 'phosanisNightmare'
   | 'obor'
+  | 'phantomMuspah'
   | 'sarachnis'
   | 'scorpia'
+  | 'scurrius'
   | 'skotizo'
+  | 'solHeredit'
+  | 'spindel'
   | 'tempoross'
   | 'gauntlet'
   | 'corruptedGauntlet'
+  | 'leviathan'
+  | 'whisperer'
   | 'theatreOfBlood'
   | 'theatreOfBloodHardMode'
   | 'thermonuclearSmokeDevil'
+  | 'tombsOfAmascut'
+  | 'tombsOfAmascutExpertMode'
   | 'tzKalZuk'
   | 'tzTokJad'
+  | 'vardorvis'
   | 'venenatis'
   | 'vetion'
   | 'vorkath'
@@ -113,10 +133,15 @@ export type Bosses = { [Type in Boss]: Activity };
 
 export type ActivityName =
   | 'leaguePoints'
+  | 'deadmanPoints'
+  | 'hunterBHV2'
+  | 'rogueBHV2'
   | 'hunterBH'
   | 'rogueBH'
   | 'lastManStanding'
+  | 'pvpArena'
   | 'soulWarsZeal'
+  | 'riftsClosed'
   | 'allClues'
   | 'beginnerClues'
   | 'easyClues'
@@ -124,15 +149,26 @@ export type ActivityName =
   | 'hardClues'
   | 'eliteClues'
   | 'masterClues'
+  | 'colosseumGlory'
   | Boss;
 
 export interface Stats {
   skills: Skills;
   clues: Clues;
+  /**
+   * Will only contain rank and score data for the `seasonal` gamemode.
+   */
   leaguePoints: Activity;
+  /**
+   * Will only contain rank and score data for the `tournament` gamemode.
+   */
+  deadmanPoints: Activity;
   bountyHunter: BH;
   lastManStanding: Activity;
+  pvpArena: Activity;
   soulWarsZeal: Activity;
+  riftsClosed: Activity;
+  colosseumGlory: Activity;
   bosses: Bosses;
 }
 export type Modes = { [M in Gamemode]?: Stats };
@@ -154,3 +190,63 @@ 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;
+  };
+}
+
+export interface HiscoresCommon {
+  /**
+   * This field behaves more like an index than a true unique ID.
+   */
+  id: number;
+  /**
+   * The display name of this skill / activity.
+   */
+  name: string;
+  /**
+   * The player's official hiscores rank in this skill / activity.
+   */
+  rank: number;
+}
+
+export interface HiscoresSkill extends HiscoresCommon {
+  /**
+   * The player's current level in this skill.
+   */
+  level: number;
+  /**
+   * The player's current experience in this skill.
+   */
+  xp: number;
+}
+
+export interface HiscoresActivity extends HiscoresCommon {
+  /**
+   * The player's current score in this activity.
+   */
+  score: number;
+}
+
+export interface HiscoresResponse {
+  skills: HiscoresSkill[];
+  activities: HiscoresActivity[];
+}

src/utils/constants.ts

@@ -9,6 +9,7 @@ import {
 
 export const BASE_URL = 'https://secure.runescape.com/m=hiscore_oldschool';
 export const STATS_URL = 'index_lite.ws?player=';
+export const JSON_STATS_URL = 'index_lite.json?player=';
 export const SCORES_URL = 'overall.ws?';
 
 export type GamemodeUrl = {
@@ -22,7 +23,10 @@ export const GAMEMODE_URL: GamemodeUrl = {
   ultimate: `${BASE_URL}_ultimate/`,
   deadman: `${BASE_URL}_deadman/`,
   seasonal: `${BASE_URL}_seasonal/`,
-  tournament: `${BASE_URL}_tournament/`
+  tournament: `${BASE_URL}_tournament/`,
+  skiller: `${BASE_URL}_skiller/`,
+  oneDefence: `${BASE_URL}_skiller_defence/`,
+  freshStart: `${BASE_URL}_fresh_start/`
 };
 export const SKILLS: SkillName[] = [
   'overall',
@@ -59,7 +63,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',
@@ -72,9 +76,11 @@ export const GAMEMODES: Gamemode[] = [
 export const BOSSES: Boss[] = [
   'abyssalSire',
   'alchemicalHydra',
+  'artio',
   'barrows',
   'bryophyta',
   'callisto',
+  'calvarion',
   'cerberus',
   'chambersOfXeric',
   'chambersOfXericChallengeMode',
@@ -87,6 +93,7 @@ export const BOSSES: Boss[] = [
   'dagannothRex',
   'dagannothSupreme',
   'derangedArchaeologist',
+  'dukeSucellus',
   'generalGraardor',
   'giantMole',
   'grotesqueGuardians',
@@ -96,20 +103,32 @@ export const BOSSES: Boss[] = [
   'kraken',
   'kreeArra',
   'krilTsutsaroth',
+  'lunarChests',
   'mimic',
+  'nex',
   'nightmare',
+  'phosanisNightmare',
   'obor',
+  'phantomMuspah',
   'sarachnis',
   'scorpia',
+  'scurrius',
   'skotizo',
+  'solHeredit',
+  'spindel',
   'tempoross',
   'gauntlet',
   'corruptedGauntlet',
+  'leviathan',
+  'whisperer',
   'theatreOfBlood',
   'theatreOfBloodHardMode',
   'thermonuclearSmokeDevil',
+  'tombsOfAmascut',
+  'tombsOfAmascutExpertMode',
   'tzKalZuk',
   'tzTokJad',
+  'vardorvis',
   'venenatis',
   'vetion',
   'vorkath',
@@ -119,6 +138,9 @@ export const BOSSES: Boss[] = [
 ];
 export const ACTIVITIES: ActivityName[] = [
   'leaguePoints',
+  'deadmanPoints',
+  'hunterBHV2',
+  'rogueBHV2',
   'hunterBH',
   'rogueBH',
   'allClues',
@@ -129,7 +151,10 @@ export const ACTIVITIES: ActivityName[] = [
   'eliteClues',
   'masterClues',
   'lastManStanding',
+  'pvpArena',
   'soulWarsZeal',
+  'riftsClosed',
+  'colosseumGlory',
   ...BOSSES
 ];
 
@@ -140,9 +165,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',
@@ -155,6 +182,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',
@@ -164,20 +192,32 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
   kraken: 'Kraken',
   kreeArra: "Kree'Arra",
   krilTsutsaroth: "K'ril Tsutsaroth",
+  lunarChests: 'Lunar Chests',
   mimic: 'Mimic',
-  nightmare: 'The Nightmare of Ashihama',
+  nex: 'Nex',
+  nightmare: 'Nightmare',
+  phosanisNightmare: "Phosani's Nightmare",
   obor: 'Obor',
+  phantomMuspah: 'Phantom Muspah',
   sarachnis: 'Sarachnis',
   scorpia: 'Scorpia',
+  scurrius: 'Scurrius',
   skotizo: 'Skotizo',
+  solHeredit: 'Sol Heredit',
+  spindel: 'Spindel',
   tempoross: 'Tempoross',
   gauntlet: 'The Gauntlet',
   corruptedGauntlet: 'The Corrupted Gauntlet',
+  leviathan: 'The Leviathan',
+  whisperer: 'The Whisperer',
   theatreOfBlood: 'Theatre of Blood',
   theatreOfBloodHardMode: 'Theatre of Blood: Hard Mode',
   thermonuclearSmokeDevil: 'Thermonuclear Smoke Devil',
+  tombsOfAmascut: 'Tombs of Amascut',
+  tombsOfAmascutExpertMode: 'Tombs of Amascut: Expert Mode',
   tzKalZuk: 'TzKal-Zuk',
   tzTokJad: 'TzTok-Jad',
+  vardorvis: 'Vardorvis',
   venenatis: 'Venenatis',
   vetion: "Vet'ion",
   vorkath: 'Vorkath',
@@ -236,10 +276,56 @@ 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_LMS = 'LMS - Rank';
+export const FORMATTED_PVP_ARENA = 'PvP Arena - Rank';
 export const FORMATTED_SOUL_WARS = 'Soul Wars Zeal';
 export const FORMATTED_LEAGUE_POINTS = 'League Points';
+export const FORMATTED_DEADMAN_POINTS = 'Deadman Points';
+export const FORMATTED_RIFTS_CLOSED = 'Rifts closed';
+export const FORMATTED_COLOSSEUM_GLORY = 'Colosseum Glory';
+
+export const INVALID_FORMAT_ERROR = 'Invalid hiscores format';
+export const PLAYER_NOT_FOUND_ERROR = 'Player not found';
+export const HISCORES_ERROR = 'HiScores not responding';
+
+export class InvalidFormatError extends Error {
+  __proto__ = Error;
+
+  constructor() {
+    super(INVALID_FORMAT_ERROR);
+    Object.setPrototypeOf(this, InvalidFormatError.prototype);
+  }
+}
+
+export class InvalidRSNError extends Error {
+  __proto__ = Error;
+
+  constructor(message: string) {
+    super(message);
+    Object.setPrototypeOf(this, InvalidRSNError.prototype);
+  }
+}
+
+export class PlayerNotFoundError extends Error {
+  __proto__ = Error;
+
+  constructor() {
+    super(PLAYER_NOT_FOUND_ERROR);
+    Object.setPrototypeOf(this, PlayerNotFoundError.prototype);
+  }
+}
+
+export class HiScoresError extends Error {
+  __proto__ = Error;
+
+  constructor() {
+    super(HISCORES_ERROR);
+    Object.setPrototypeOf(this, HiScoresError.prototype);
+  }
+}

src/utils/helpers.ts

@@ -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 {
@@ -6,7 +6,9 @@ import {
   STATS_URL,
   SCORES_URL,
   SKILLS,
-  ACTIVITIES
+  ACTIVITIES,
+  JSON_STATS_URL,
+  InvalidRSNError
 } from './constants';
 
 /**
@@ -14,10 +16,13 @@ import {
  *
  * @param gamemode Gamemode to fetch ranks for.
  * @param rsn Username of the player.
+ * @param json If the JSON endpoint is desired instead of CSV.
  * @returns Encoded stats URL.
  */
-export const getStatsURL = (gamemode: Gamemode, rsn: string) =>
-  `${GAMEMODE_URL[gamemode]}${STATS_URL}${encodeURIComponent(rsn)}`;
+export const getStatsURL = (gamemode: Gamemode, rsn: string, json = false) =>
+  `${GAMEMODE_URL[gamemode]}${
+    json ? JSON_STATS_URL : STATS_URL
+  }${encodeURIComponent(rsn)}`;
 
 /**
  * Will generate a player table URL for the official OSRS hiscores website.
@@ -96,10 +101,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 new InvalidRSNError('RSN must be a string');
+  } else if (!/^[a-zA-Z0-9 _-]+$/.test(rsn)) {
+    throw new InvalidRSNError('RSN contains invalid character');
+  } else if (rsn.length > 12 || rsn.length < 1) {
+    throw new InvalidRSNError('RSN must be between 1 and 12 characters');
+  }
+};

tsconfig.json

@@ -4,7 +4,9 @@
     "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__/*"]