Add wilderness boss variants.

Add `validateRSN`, `GetStatsOptions`

.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@v2
+      - uses: borales/actions-yarn@v2.0.0
+        with:
+          cmd: install
+      - uses: borales/actions-yarn@v2.0.0
+        with:
+          cmd: lint
+      - uses: borales/actions-yarn@v2.0.0
+        with:
+          cmd: format
+      - uses: borales/actions-yarn@v2.0.0
+        with:
+          cmd: build
+      - uses: borales/actions-yarn@v2.0.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:
@@ -83,8 +84,8 @@ const topPage = await getSkillPage('overall');
 ```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:
@@ -108,7 +109,9 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Bounty Hunter (Rogue)  |     `rogueBH`     |
 | Bounty Hunter (Hunter) |    `hunterBH`     |
 | Last Man Standing      | `lastManStanding` |
+| PvP Arena              |    `pvpArena`     |
 | Soul Wars Zeal         |  `soulWarsZeal`   |
+| Rifts Closed           |   `riftsClosed`   |
 
 ### Leagues
 
@@ -119,15 +122,17 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 ### Bosses
 
 | Boss Name                         |             Param              |
-| -------------------------------- | :----------------------------: |
+| --------------------------------- | :----------------------------: |
 | Abyssal Sire                      |         `abyssalSire`          |
 | Alchemical Hydra                  |       `alchemicalHydra`        |
+| Artio                             |            `artio`             |
 | Barrows Chests                    |           `barrows`            |
 | Bryophyta                         |          `bryophyta`           |
 | Callisto                          |           `callisto`           |
+| Cal'varion                        |          `calvarion`           |
 | Cerberus                          |           `cerberus`           |
 | Chambers Of Xeric                 |       `chambersOfXeric`        |
-| Chambers Of Xeric Challenge Mode | `chambersOfXericChallengeMode` |
+| Chambers Of Xeric: Challenge Mode | `chambersOfXericChallengeMode` |
 | Chaos Elemental                   |        `chaosElemental`        |
 | Chaos Fanatic                     |         `chaosFanatic`         |
 | Commander Zilyana                 |       `commanderZilyana`       |
@@ -147,15 +152,23 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | 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`            |
-| Gauntlet                         |           `gauntlet`           |
-| Corrupted Gauntlet               |      `corruptedGauntlet`       |
+| 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`           |
@@ -187,7 +200,9 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
     leaguePoints: {},
     bountyHunter: {},
     lastManStanding: {},
+    pvpArena: {},
     soulWarsZeal: {},
+    riftsClosed: {},
     bosses: {}
   }
 }
@@ -199,7 +214,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,8 +8,49 @@ import {
   getStatsByGamemode,
   getRSNFormat,
   Stats,
+  getPlayerTableURL,
+  getSkillPageURL,
+  getStatsURL,
+  BOSSES,
+  INVALID_FORMAT_ERROR
 } 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 = `246,2277,1338203419
   615,99,77438259
@@ -32,9 +76,9 @@ test('Parse CSV to json', () => {
   169,99,43127930
   810,99,37688883
   92,99,32005622
-  -1,-1
-  -1,-1
-  -1,-1
+  23423,478
+  99831,23
+  89912,37
   32,12148
   3105,76
   1997,505
@@ -43,12 +87,16 @@ test('Parse CSV to json', () => {
   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
@@ -71,15 +119,23 @@ test('Parse CSV to json', () => {
   625,2391
   120,2981
   1,109
+  99,39002
   3,22666
+  2,84
   26,323
+  44,6233
   201,1101
   82,3404
   5085,61
+  678,903
+  18823,23
   63,375
   2870,6
   6984,138
+  23,923141
   4043,2000
+  4073,1020
+  289,13070
   489,8
   967,47
   11155,223
@@ -114,15 +170,17 @@ test('Parse CSV to json', () => {
       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 },
+      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 },
+      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 },
     clues: {
       all: { rank: 32, score: 12148 },
       beginner: { rank: 3105, score: 76 },
@@ -130,14 +188,16 @@ test('Parse CSV to json', () => {
       medium: { rank: 127, score: 4259 },
       hard: { rank: 361, score: 915 },
       elite: { rank: 392, score: 250 },
-      master: { rank: 1, score: 6143 },
+      master: { rank: 1, score: 6143 }
     },
     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 },
@@ -160,15 +220,23 @@ test('Parse CSV to json', () => {
       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 },
+      phantomMuspah: { rank: 44, score: 6233 },
       sarachnis: { rank: 201, score: 1101 },
       scorpia: { rank: 82, score: 3404 },
       skotizo: { rank: 5085, score: 61 },
+      spindel: { rank: 678, score: 903 },
+      tempoross: { rank: 18823, score: 23 },
       gauntlet: { rank: 63, score: 375 },
       corruptedGauntlet: { rank: 2870, score: 6 },
       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 },
@@ -176,21 +244,48 @@ test('Parse CSV to json', () => {
       vorkath: { rank: 8623, score: 1340 },
       wintertodt: { rank: 605, score: 1694 },
       zalcano: { rank: -1, score: -1 },
-      zulrah: { rank: 3867, score: 4583 },
-    },
+      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([
     {
@@ -198,176 +293,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);
     }
@@ -375,8 +475,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 } = 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 },
@@ -401,6 +503,58 @@ 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);
+
+  expect.assertions(2);
+});
+
+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,92 @@
+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
+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,8 +0,0 @@
-{
-  "transform": {
-    "^.+\\.(t|j)sx?$": "ts-jest"
-  },
-  "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
-  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
-  "testEnvironment": "node"
-}

package.json

@@ -1,17 +1,18 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.3.1",
-  "description": "The Oldschool Runescape API wrapper that does more!",
+  "version": "2.12.1",
+  "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,28 +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.21.1",
     "jsdom": "^16.3.0",
     "useragent-generator": "^1.1.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.20",
+    "@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",
-    "np": "^5.0.3",
-    "prettier": "^1.19.1",
-    "ts-jest": "^26.4.4",
-    "tslint": "^5.17.0",
-    "tslint-config-airbnb": "^5.11.1",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.5.2",
-    "watch": "^1.0.2"
+    "lint-staged": "^10.5.4",
+    "np": "6.5.0",
+    "prettier": "^2.2.1",
+    "ts-jest": "^26.5.4",
+    "typescript": "^4.2.3"
   }
 }

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

@@ -1,51 +1,109 @@
 declare module 'useragent-generator' {
-  /********************
+  /** *****************
    *  Google Chrome   *
-   /*******************/
-  export function chrome(opt: number | string | { version: string, os?: string }): string;
+  /****************** */
+  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 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;
+    function iOS(
+      opt:
+        | number
+        | string
+        | { iOSVersion: string; chromeVersion?: string; device?: string }
+    ): string;
   }
-  export function chromium(opt: number | string | { version: string, os?: 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 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;
+    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 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;
+    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 function ie(
+    opt: number | string | { version: string; os?: string }
+  ): string;
   export namespace ie {
-    function windowsPhone(opt: number | string | { version: string, device?: string }): string;
+    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;
-  /************************
+  /******************** */
+  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 googleBot(
+    opt?: number | string | { version?: string }
+  ): string;
   export function bingBot(opt?: number | string | { version?: string }): string;
   export function yahooBot(): string;
 }

src/hiscores.ts

@@ -1,3 +1,5 @@
+import { AxiosResponse } from 'axios';
+import { BinaryData, JSDOM } from 'jsdom';
 import {
   Player,
   Activity,
@@ -12,6 +14,7 @@ import {
   ActivityName,
   PlayerActivityRow,
   Bosses,
+  GetStatsOptions
 } from './types';
 import {
   getStatsURL,
@@ -27,40 +30,183 @@ import {
   getActivityPageURL,
   httpGet,
   BOSSES,
+  INVALID_FORMAT_ERROR,
+  validateRSN
 } from './utils';
-import { JSDOM } from 'jsdom';
 
-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.
+ * @returns Formatted version of the rsn.
+ */
+export async function getRSNFormat(rsn: string): Promise<string> {
+  validateRSN(rsn);
+
+  const url = getPlayerTableURL('main', rsn);
+  try {
+    const response = await httpGet<string | Buffer | BinaryData | undefined>(
+      url
+    );
+    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 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 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));
+  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)).catch((err) => err)
+        : emptyResponse;
+    const formattedName = shouldGetFormattedRsn
+      ? await getRSNFormat(rsn).catch(() => undefined)
+      : undefined;
 
     const player: Player = {
-      name: formattedName || rsn,
+      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);
@@ -107,20 +253,22 @@ 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.
+ * @returns Stats object.
+ */
 export async function getStatsByGamemode(
   rsn: string,
   mode: Gamemode = 'main'
 ): Promise<Stats> {
-  if (typeof rsn !== 'string') {
-    throw Error('RSN must be a string');
-  } else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) {
-    throw Error('RSN contains invalid character');
-  } else if (rsn.length > 12 || rsn.length < 1) {
-    throw Error('RSN must be between 1 and 12 characters');
-  } else if (!GAMEMODES.includes(mode)) {
+  validateRSN(rsn);
+  if (!GAMEMODES.includes(mode)) {
     throw Error('Invalid game mode');
   }
-  const response = await httpGet(getStatsURL(mode, rsn));
+  const response = await httpGet<string>(getStatsURL(mode, rsn));
   if (response.status !== 200) {
     throw Error('Player not found');
   }
@@ -143,14 +291,14 @@ export async function getSkillPage(
   }
   const url = getSkillPageURL(mode, skill, page);
 
-  const response = await httpGet(url);
+  const response = await httpGet<string | Buffer | BinaryData | undefined>(url);
   const dom = new JSDOM(response.data);
   const playersHTML = dom.window.document.querySelectorAll(
     '.personal-hiscores__row'
   );
 
   const players: PlayerSkillRow[] = [];
-  playersHTML.forEach(row => {
+  playersHTML.forEach((row) => {
     const rankEl = row.querySelector('td');
     const nameEl = row.querySelector('td a');
     const levelEl = row.querySelector('td.left + td');
@@ -162,13 +310,21 @@ export async function getSkillPage(
       rank: numberFromElement(rankEl),
       level: numberFromElement(levelEl),
       xp: numberFromElement(xpEl),
-      dead: isDead,
+      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.
+ * @returns Array of `PlayerActivityRow` objects.
+ */
 export async function getActivityPage(
   activity: ActivityName,
   mode: Gamemode = 'main',
@@ -183,14 +339,14 @@ export async function getActivityPage(
   }
   const url = getActivityPageURL(mode, activity, page);
 
-  const response = await httpGet(url);
+  const response = await httpGet<string | Buffer | BinaryData | undefined>(url);
   const dom = new JSDOM(response.data);
   const playersHTML = dom.window.document.querySelectorAll(
     '.personal-hiscores__row'
   );
 
   const players: PlayerActivityRow[] = [];
-  playersHTML.forEach(row => {
+  playersHTML.forEach((row) => {
     const rankEl = row.querySelector('td');
     const nameEl = row.querySelector('td a');
     const scoreEl = row.querySelector('td.left + td');
@@ -200,107 +356,9 @@ export async function getActivityPage(
       name: rsnFromElement(nameEl),
       rank: numberFromElement(rankEl),
       score: numberFromElement(scoreEl),
-      dead: isDead,
+      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 httpGet(url);
-    const dom = new JSDOM(response.data);
-    const spans = dom.window.document.querySelectorAll(
-      'span[style="color:#AA0022;"]'
-    );
-    if (spans.length >= 2) {
-      const nameSpan = spans[1];
-      return rsnFromElement(nameSpan);
-    }
-    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, soulWarsZeal] = activityObjects.splice(0, 2);
-  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,
-    soulWarsZeal,
-    clues,
-    bosses,
-  };
-
-  return stats;
-}

src/types.ts

@@ -5,7 +5,10 @@ export type Gamemode =
   | 'hardcore'
   | 'deadman'
   | 'seasonal'
-  | 'tournament';
+  | 'tournament'
+  | 'skiller'
+  | 'oneDefence'
+  | 'freshStart';
 
 export interface Skill {
   rank: number;
@@ -64,9 +67,11 @@ export type BH = { [Type in BHType]: Activity };
 export type Boss =
   | 'abyssalSire'
   | 'alchemicalHydra'
+  | 'artio'
   | 'barrows'
   | 'bryophyta'
   | 'callisto'
+  | 'calvarion'
   | 'cerberus'
   | 'chambersOfXeric'
   | 'chambersOfXericChallengeMode'
@@ -89,15 +94,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'
@@ -114,7 +127,9 @@ export type ActivityName =
   | 'hunterBH'
   | 'rogueBH'
   | 'lastManStanding'
+  | 'pvpArena'
   | 'soulWarsZeal'
+  | 'riftsClosed'
   | 'allClues'
   | 'beginnerClues'
   | 'easyClues'
@@ -130,7 +145,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 };
@@ -152,3 +169,16 @@ 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;
+}

src/utils/constants.ts

@@ -4,7 +4,7 @@ import {
   ClueType,
   Gamemode,
   SkillName,
-  ActivityName,
+  ActivityName
 } from '../types';
 
 export const BASE_URL = 'https://secure.runescape.com/m=hiscore_oldschool';
@@ -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,9 +60,9 @@ export const CLUES: ClueType[] = [
   'medium',
   'hard',
   'elite',
-  'master',
+  'master'
 ];
-export const BH_MODES: BHType[] = ['rogue', 'hunter'];
+export const BH_MODES: BHType[] = ['hunter', 'rogue'];
 export const GAMEMODES: Gamemode[] = [
   'main',
   'ironman',
@@ -67,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',
@@ -97,15 +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',
@@ -113,7 +126,7 @@ export const BOSSES: Boss[] = [
   'vorkath',
   'wintertodt',
   'zalcano',
-  'zulrah',
+  'zulrah'
 ];
 export const ACTIVITIES: ActivityName[] = [
   'leaguePoints',
@@ -127,8 +140,10 @@ export const ACTIVITIES: ActivityName[] = [
   'eliteClues',
   'masterClues',
   'lastManStanding',
+  'pvpArena',
   'soulWarsZeal',
-  ...BOSSES,
+  'riftsClosed',
+  ...BOSSES
 ];
 
 export type FormattedBossNames = {
@@ -138,9 +153,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: "Cal'varion",
   cerberus: 'Cerberus',
   chambersOfXeric: 'Chambers of Xeric',
   chambersOfXericChallengeMode: 'Chambers of Xeric: Challenge Mode',
@@ -163,15 +180,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',
@@ -179,7 +204,7 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
   vorkath: 'Vorkath',
   wintertodt: 'Wintertodt',
   zalcano: 'Zalcano',
-  zulrah: 'Zulrah',
+  zulrah: 'Zulrah'
 };
 
 export type FormattedSkillNames = {
@@ -210,7 +235,7 @@ export const FORMATTED_SKILL_NAMES: FormattedSkillNames = {
   farming: 'Farming',
   runecraft: 'Runecraft',
   hunter: 'Hunter',
-  construction: 'Construction',
+  construction: 'Construction'
 };
 
 export type FormattedClueNames = {
@@ -224,7 +249,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 = {
@@ -233,9 +258,13 @@ export type FormattedBHNames = {
 
 export const FORMATTED_BH_NAMES: FormattedBHNames = {
   rogue: 'Bounty Hunter - Rogue',
-  hunter: 'Bounty Hunter - Hunter',
+  hunter: 'Bounty Hunter - Hunter'
 };
 
 export const FORMATTED_LMS = 'Last Man Standing';
+export const FORMATTED_PVP_ARENA = 'PvP Arena';
 export const FORMATTED_SOUL_WARS = 'Soul Wars Zeal';
 export const FORMATTED_LEAGUE_POINTS = 'League Points';
+export const FORMATTED_RIFTS_CLOSED = 'Rifts Closed';
+
+export const INVALID_FORMAT_ERROR = 'Invalid hiscores format';

src/utils/helpers.ts

@@ -6,17 +6,39 @@ import {
   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,
@@ -26,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,
@@ -37,22 +67,54 @@ export const getActivityPageURL = (
     activity
   )}&page=${page}`;
 
+/**
+ * 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 { innerHTML } = el ?? {};
   const number = innerHTML?.replace(/[\n|,]/g, '') ?? '-1';
   return parseInt(number, 10);
 };
 
+/**
+ * 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, ' ') || '';
+  const { innerHTML } = el ?? {};
+  return innerHTML?.replace(/\uFFFD/g, ' ') ?? '';
 };
 
-export const httpGet = (url: string) => {
-  return axios.get(url, {
+/**
+ * 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) =>
+  axios.get<Response>(url, {
     headers: {
       // without User-Agent header requests may be rejected by DDoS protection mechanism
       'User-Agent': ua.firefox(80)
     }
   });
+
+/**
+ * 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"
-    ]
-  }
-}