v2.14.2

Update testing, linting and formatting libraries

.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

README.md

@@ -3,7 +3,7 @@
 [![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!**
 
@@ -104,12 +104,16 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 
 ### Minigames
 
-| Minigame               |       Param       |
-| ---------------------- | :---------------: |
-| Bounty Hunter (Rogue)  |     `rogueBH`     |
-| Bounty Hunter (Hunter) |    `hunterBH`     |
-| Last Man Standing      | `lastManStanding` |
-| Soul Wars Zeal         |  `soulWarsZeal`   |
+| Minigame                        |       Param       |
+| ------------------------------- | :---------------: |
+| Bounty Hunter (Legacy - Rogue)  |     `rogueBH`     |
+| Bounty Hunter (Legacy - Hunter) |    `hunterBH`     |
+| Bounty Hunter (Rogue)           |    `rogueBHV2`    |
+| Bounty Hunter (Hunter)          |   `hunterBHV2`    |
+| Last Man Standing               | `lastManStanding` |
+| PvP Arena                       |    `pvpArena`     |
+| Soul Wars Zeal                  |  `soulWarsZeal`   |
+| Rifts Closed                    |   `riftsClosed`   |
 
 ### Leagues
 
@@ -123,9 +127,11 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | --------------------------------- | :----------------------------: |
 | Abyssal Sire                      |         `abyssalSire`          |
 | Alchemical Hydra                  |       `alchemicalHydra`        |
+| Artio                             |            `artio`             |
 | Barrows Chests                    |           `barrows`            |
 | Bryophyta                         |          `bryophyta`           |
 | Callisto                          |           `callisto`           |
+| Calvar'ion                        |          `calvarion`           |
 | Cerberus                          |           `cerberus`           |
 | Chambers Of Xeric                 |       `chambersOfXeric`        |
 | Chambers Of Xeric: Challenge Mode | `chambersOfXericChallengeMode` |
@@ -148,17 +154,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`            |
+| 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`           |
@@ -190,7 +202,9 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
     leaguePoints: {},
     bountyHunter: {},
     lastManStanding: {},
+    pvpArena: {},
     soulWarsZeal: {},
+    riftsClosed: {},
     bosses: {}
   }
 }

__tests__/hiscores.test.ts

@@ -10,7 +10,10 @@ import {
   Stats,
   getPlayerTableURL,
   getSkillPageURL,
-  getStatsURL
+  getStatsURL,
+  BOSSES,
+  INVALID_FORMAT_ERROR,
+  BH_MODES
 } from '../src/index';
 
 const B0ATY_NAME = 'B0ATY';
@@ -75,6 +78,8 @@ test('Parse CSV to json', () => {
   810,99,37688883
   92,99,32005622
   23423,478
+  89914,35
+  99834,25
   99831,23
   89912,37
   32,12148
@@ -85,12 +90,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
@@ -113,17 +122,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
@@ -162,11 +177,15 @@ test('Parse CSV to json', () => {
     },
     leaguePoints: { rank: 23423, score: 478 },
     bountyHunter: {
+      hunterV2: { rank: 89914, score: 35 },
+      rogueV2: { rank: 99834, score: 25 },
       hunter: { rank: 99831, score: 23 },
-      rogue: { rank: 89912, score: 37 }
+      rogue: { rank: 89912, score: 37 },
     },
     lastManStanding: { rank: 4814, score: 898 },
+    pvpArena: { rank: 13, score: 4057 },
     soulWarsZeal: { rank: 37, score: 225 },
+    riftsClosed: { rank: 25, score: 1110 },
     clues: {
       all: { rank: 32, score: 12148 },
       beginner: { rank: 3105, score: 76 },
@@ -179,9 +198,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 },
@@ -204,17 +225,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 },
@@ -229,6 +256,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(
+    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);
@@ -441,7 +480,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 +510,58 @@ 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),
+      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

@@ -15,7 +15,7 @@
 3,99,200000000
 25,99,200000000
 5,99,200000000
-24,99,200000000
+23,99,200000000
 12,99,200000000
 2,99,200000000
 19,99,200000000
@@ -29,7 +29,20 @@
 -1,-1
 -1,-1
 -1,-1
-344430,22
+-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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.5.0",
+  "version": "2.14.2",
   "description": "The Old School Runescape API wrapper that does more!",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -30,6 +30,9 @@
     "stats",
     "skills"
   ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
   "author": "maxswa",
   "license": "ISC",
   "bugs": {
@@ -58,7 +61,8 @@
       "@typescript-eslint"
     ],
     "extends": [
-      "eslint-config-airbnb-typescript",
+      "airbnb-base",
+      "airbnb-typescript/base",
       "prettier"
     ],
     "ignorePatterns": [
@@ -69,7 +73,8 @@
     "trailingComma": "none",
     "tabWidth": 2,
     "semi": true,
-    "singleQuote": true
+    "singleQuote": true,
+    "endOfLine": "auto"
   },
   "jest": {
     "transform": {
@@ -88,27 +93,24 @@
   },
   "dependencies": {
     "axios": "^0.21.1",
-    "jsdom": "^16.3.0",
+    "jsdom": "^22.1.0",
     "useragent-generator": "^1.1.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.21",
-    "@types/jsdom": "^16.2.3",
-    "@typescript-eslint/eslint-plugin": "^4.19.0",
-    "@typescript-eslint/parser": "^4.19.0",
-    "eslint": "^7.22.0",
-    "eslint-config-airbnb-typescript": "^12.3.1",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-react": "^7.23.1",
-    "eslint-plugin-react-hooks": "^4.2.0",
+    "@types/jest": "^29.5.3",
+    "@types/jsdom": "^21.1.1",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.44.0",
+    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
     "husky": "^5.2.0",
-    "jest": "^26.6.3",
-    "lint-staged": "^10.5.4",
-    "np": "6.5.0",
-    "prettier": "^2.2.1",
-    "ts-jest": "^26.5.4",
-    "typescript": "^4.2.3"
+    "jest": "^29.6.1",
+    "lint-staged": "^13.2.3",
+    "np": "^7.7.0",
+    "prettier": "^3.0.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.1.6"
   }
 }

src/hiscores.ts

@@ -1,4 +1,5 @@
-import { JSDOM } from 'jsdom';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { BinaryData, JSDOM } from 'jsdom';
 import {
   Player,
   Activity,
@@ -12,7 +13,8 @@ import {
   PlayerSkillRow,
   ActivityName,
   PlayerActivityRow,
-  Bosses
+  Bosses,
+  GetStatsOptions
 } from './types';
 import {
   getStatsURL,
@@ -27,34 +29,36 @@ import {
   rsnFromElement,
   getActivityPageURL,
   httpGet,
-  BOSSES
+  BOSSES,
+  INVALID_FORMAT_ERROR,
+  validateRSN
 } from './utils';
 
 /**
  * Screen scrapes the hiscores to get the formatted rsn of a player.
  *
  * @param rsn Username of the player.
+ * @param config Optional axios request config object.
  * @returns Formatted version of the rsn.
  */
-export async function getRSNFormat(rsn: string): Promise<string> {
-  if (typeof rsn !== 'string') {
-    throw Error('RSN must be a string');
-  } else if (!/^[a-zA-Z0-9 _-]+$/.test(rsn)) {
-    throw Error('RSN contains invalid character');
-  } else if (rsn.length > 12 || rsn.length < 1) {
-    throw Error('RSN must be between 1 and 12 characters');
-  }
+export async function getRSNFormat(
+  rsn: string,
+  config?: AxiosRequestConfig
+): Promise<string> {
+  validateRSN(rsn);
 
   const url = getPlayerTableURL('main', rsn);
   try {
-    const response = await httpGet(url);
-    const 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');
   } catch {
@@ -74,6 +78,13 @@ export function parseStats(csv: string): Stats {
     .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 skillObjects: Skill[] = splitCSV
     .filter((stat) => stat.length === 3)
     .map((stat) => {
@@ -100,7 +111,8 @@ export function parseStats(csv: string): Stats {
   const [leaguePoints] = activityObjects.splice(0, 1);
   const bhObjects = activityObjects.splice(0, BH_MODES.length);
   const clueObjects = activityObjects.splice(0, CLUES.length);
-  const [lastManStanding, soulWarsZeal] = activityObjects.splice(0, 2);
+  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) => {
@@ -132,7 +144,9 @@ export function parseStats(csv: string): Stats {
     leaguePoints,
     bountyHunter,
     lastManStanding,
+    pvpArena,
     soulWarsZeal,
+    riftsClosed,
     clues,
     bosses
   };
@@ -149,25 +163,44 @@ export function parseStats(csv: string): Stats {
  * @param rsn Username of the player.
  * @returns Player object.
  */
-export async function getStats(rsn: string): Promise<Player> {
-  if (typeof rsn !== 'string') {
-    throw Error('RSN must be a string');
-  } else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) {
-    throw Error('RSN contains invalid character');
-  } else if (rsn.length > 12 || rsn.length < 1) {
-    throw Error('RSN must be between 1 and 12 characters');
-  }
+export async function getStats(
+  rsn: string,
+  options?: GetStatsOptions
+): Promise<Player> {
+  validateRSN(rsn);
+  const otherGamemodes = options?.otherGamemodes ?? [
+    'ironman',
+    'hardcore',
+    'ultimate'
+  ];
+  const shouldGetFormattedRsn = options?.shouldGetFormattedRsn ?? true;
 
-  const mainRes = await httpGet(getStatsURL('main', rsn));
+  const mainRes = await httpGet<string>(
+    getStatsURL('main', rsn),
+    options?.axiosConfigs?.main
+  );
   if (mainRes.status === 200) {
-    const otherResponses = await Promise.all([
-      httpGet(getStatsURL('ironman', rsn)).catch((err) => err),
-      httpGet(getStatsURL('hardcore', rsn)).catch((err) => err),
-      httpGet(getStatsURL('ultimate', rsn)).catch((err) => err),
-      getRSNFormat(rsn).catch(() => undefined)
-    ]);
-
-    const [ironRes, hcRes, ultRes, formattedName] = otherResponses;
+    const emptyResponse: AxiosResponse<string> = {
+      status: 404,
+      data: '',
+      statusText: '',
+      headers: {},
+      config: {}
+    };
+    const getModeStats = async (
+      mode: Extract<Gamemode, 'ironman' | 'hardcore' | 'ultimate'>
+    ): Promise<AxiosResponse<string>> =>
+      otherGamemodes.includes(mode)
+        ? httpGet<string>(
+            getStatsURL(mode, rsn),
+            options?.axiosConfigs?.[mode]
+          ).catch((err) => err)
+        : emptyResponse;
+    const formattedName = shouldGetFormattedRsn
+      ? await getRSNFormat(rsn, options?.axiosConfigs?.rsn).catch(
+          () => undefined
+        )
+      : undefined;
 
     const player: Player = {
       name: formattedName ?? rsn,
@@ -178,8 +211,11 @@ export async function getStats(rsn: string): Promise<Player> {
     };
     player.main = parseStats(mainRes.data);
 
+    const ironRes = await getModeStats('ironman');
     if (ironRes.status === 200) {
       player.ironman = parseStats(ironRes.data);
+      const hcRes = await getModeStats('hardcore');
+      const ultRes = await getModeStats('ultimate');
       if (hcRes.status === 200) {
         player.mode = 'hardcore';
         player.hardcore = parseStats(hcRes.data);
@@ -231,22 +267,19 @@ export async function getStats(rsn: string): Promise<Player> {
  *
  * @param rsn Username of the player.
  * @param mode Gamemode to fetch ranks for.
+ * @param config Optional axios request config object.
  * @returns Stats object.
  */
 export async function getStatsByGamemode(
   rsn: string,
-  mode: Gamemode = 'main'
+  mode: Gamemode = 'main',
+  config?: AxiosRequestConfig
 ): Promise<Stats> {
-  if (typeof rsn !== 'string') {
-    throw Error('RSN must be a string');
-  } else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) {
-    throw Error('RSN contains invalid character');
-  } else if (rsn.length > 12 || rsn.length < 1) {
-    throw Error('RSN must be between 1 and 12 characters');
-  } else if (!GAMEMODES.includes(mode)) {
+  validateRSN(rsn);
+  if (!GAMEMODES.includes(mode)) {
     throw Error('Invalid game mode');
   }
-  const response = await httpGet(getStatsURL(mode, rsn));
+  const response = await httpGet<string>(getStatsURL(mode, rsn), config);
   if (response.status !== 200) {
     throw Error('Player not found');
   }
@@ -258,7 +291,8 @@ export async function getStatsByGamemode(
 export async function getSkillPage(
   skill: SkillName,
   mode: Gamemode = 'main',
-  page: number = 1
+  page: number = 1,
+  config?: AxiosRequestConfig
 ): Promise<PlayerSkillRow[]> {
   if (!GAMEMODES.includes(mode)) {
     throw Error('Invalid game mode');
@@ -269,7 +303,10 @@ export async function getSkillPage(
   }
   const url = getSkillPageURL(mode, skill, page);
 
-  const response = await httpGet(url);
+  const response = await httpGet<string | Buffer | BinaryData | undefined>(
+    url,
+    config
+  );
   const dom = new JSDOM(response.data);
   const playersHTML = dom.window.document.querySelectorAll(
     '.personal-hiscores__row'
@@ -301,12 +338,14 @@ export async function getSkillPage(
  * @param activity Name of the activity or boss to fetch hiscores for.
  * @param mode Gamemode to fetch ranks for.
  * @param page Page number.
+ * @param config Optional axios request config object.
  * @returns Array of `PlayerActivityRow` objects.
  */
 export async function getActivityPage(
   activity: ActivityName,
   mode: Gamemode = 'main',
-  page: number = 1
+  page: number = 1,
+  config?: AxiosRequestConfig
 ): Promise<PlayerActivityRow[]> {
   if (!GAMEMODES.includes(mode)) {
     throw Error('Invalid game mode');
@@ -317,7 +356,10 @@ export async function getActivityPage(
   }
   const url = getActivityPageURL(mode, activity, page);
 
-  const response = await httpGet(url);
+  const response = await httpGet<string | Buffer | BinaryData | undefined>(
+    url,
+    config
+  );
   const dom = new JSDOM(response.data);
   const playersHTML = dom.window.document.querySelectorAll(
     '.personal-hiscores__row'

src/types.ts

@@ -1,3 +1,5 @@
+import { AxiosRequestConfig } from 'axios';
+
 export type Gamemode =
   | 'main'
   | 'ironman'
@@ -5,7 +7,10 @@ export type Gamemode =
   | 'hardcore'
   | 'deadman'
   | 'seasonal'
-  | 'tournament';
+  | 'tournament'
+  | 'skiller'
+  | 'oneDefence'
+  | 'freshStart';
 
 export interface Skill {
   rank: number;
@@ -57,16 +62,18 @@ export type ClueType =
 
 export type Clues = { [Type in ClueType]: Activity };
 
-export type BHType = 'rogue' | 'hunter';
+export type BHType = 'rogue' | 'hunter' | 'rogueV2' | 'hunterV2';
 
 export type BH = { [Type in BHType]: Activity };
 
 export type Boss =
   | 'abyssalSire'
   | 'alchemicalHydra'
+  | 'artio'
   | 'barrows'
   | 'bryophyta'
   | 'callisto'
+  | 'calvarion'
   | 'cerberus'
   | 'chambersOfXeric'
   | 'chambersOfXericChallengeMode'
@@ -89,17 +96,23 @@ export type Boss =
   | 'kreeArra'
   | 'krilTsutsaroth'
   | 'mimic'
+  | 'nex'
   | 'nightmare'
+  | 'phosanisNightmare'
   | 'obor'
+  | 'phantomMuspah'
   | 'sarachnis'
   | 'scorpia'
   | 'skotizo'
+  | 'spindel'
   | 'tempoross'
   | 'gauntlet'
   | 'corruptedGauntlet'
   | 'theatreOfBlood'
   | 'theatreOfBloodHardMode'
   | 'thermonuclearSmokeDevil'
+  | 'tombsOfAmascut'
+  | 'tombsOfAmascutExpertMode'
   | 'tzKalZuk'
   | 'tzTokJad'
   | 'venenatis'
@@ -113,10 +126,14 @@ export type Bosses = { [Type in Boss]: Activity };
 
 export type ActivityName =
   | 'leaguePoints'
+  | 'hunterBHV2'
+  | 'rogueBHV2'
   | 'hunterBH'
   | 'rogueBH'
   | 'lastManStanding'
+  | 'pvpArena'
   | 'soulWarsZeal'
+  | 'riftsClosed'
   | 'allClues'
   | 'beginnerClues'
   | 'easyClues'
@@ -132,7 +149,9 @@ export interface Stats {
   leaguePoints: Activity;
   bountyHunter: BH;
   lastManStanding: Activity;
+  pvpArena: Activity;
   soulWarsZeal: Activity;
+  riftsClosed: Activity;
   bosses: Bosses;
 }
 export type Modes = { [M in Gamemode]?: Stats };
@@ -154,3 +173,25 @@ export interface PlayerActivityRow extends Activity {
   name: string;
   dead: boolean;
 }
+
+export interface GetStatsOptions {
+  /**
+   * Other game modes to fetch ranks for.
+   * @defaultvalue `['ironman', 'hardcore', 'ultimate']`
+   */
+  otherGamemodes?: Extract<Gamemode, 'ironman' | 'hardcore' | 'ultimate'>[];
+  /**
+   * If true, the formatted RSN will be fetched. Otherwise it will return the provided, unformatted RSN.
+   * @defaultvalue `true`
+   */
+  shouldGetFormattedRsn?: boolean;
+  /**
+   * Map of configs for each requests that can take place in the `getStats` function.
+   */
+  axiosConfigs?: Partial<Record<Gamemode, AxiosRequestConfig>> & {
+    /**
+     * The axios request config object to use for the RSN format request.
+     */
+    rsn?: AxiosRequestConfig;
+  };
+}

src/utils/constants.ts

@@ -22,7 +22,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 +62,7 @@ export const CLUES: ClueType[] = [
   'elite',
   'master'
 ];
-export const BH_MODES: BHType[] = ['hunter', 'rogue'];
+export const BH_MODES: BHType[] = ['hunterV2', 'rogueV2', 'hunter', 'rogue'];
 export const GAMEMODES: Gamemode[] = [
   'main',
   'ironman',
@@ -72,9 +75,11 @@ export const GAMEMODES: Gamemode[] = [
 export const BOSSES: Boss[] = [
   'abyssalSire',
   'alchemicalHydra',
+  'artio',
   'barrows',
   'bryophyta',
   'callisto',
+  'calvarion',
   'cerberus',
   'chambersOfXeric',
   'chambersOfXericChallengeMode',
@@ -97,17 +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',
@@ -119,6 +130,8 @@ export const BOSSES: Boss[] = [
 ];
 export const ACTIVITIES: ActivityName[] = [
   'leaguePoints',
+  'hunterBHV2',
+  'rogueBHV2',
   'hunterBH',
   'rogueBH',
   'allClues',
@@ -129,7 +142,9 @@ export const ACTIVITIES: ActivityName[] = [
   'eliteClues',
   'masterClues',
   'lastManStanding',
+  'pvpArena',
   'soulWarsZeal',
+  'riftsClosed',
   ...BOSSES
 ];
 
@@ -140,9 +155,11 @@ export type FormattedBossNames = {
 export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
   abyssalSire: 'Abyssal Sire',
   alchemicalHydra: 'Alchemical Hydra',
+  artio: 'Artio',
   barrows: 'Barrows Chests',
   bryophyta: 'Bryophyta',
   callisto: 'Callisto',
+  calvarion: "Calvar'ion",
   cerberus: 'Cerberus',
   chambersOfXeric: 'Chambers of Xeric',
   chambersOfXericChallengeMode: 'Chambers of Xeric: Challenge Mode',
@@ -165,17 +182,23 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
   kreeArra: "Kree'Arra",
   krilTsutsaroth: "K'ril Tsutsaroth",
   mimic: 'Mimic',
+  nex: 'Nex',
   nightmare: 'The Nightmare of Ashihama',
+  phosanisNightmare: "Phosani's Nightmare",
   obor: 'Obor',
+  phantomMuspah: 'Phantom Muspah',
   sarachnis: 'Sarachnis',
   scorpia: 'Scorpia',
   skotizo: 'Skotizo',
+  spindel: 'Spindel',
   tempoross: 'Tempoross',
   gauntlet: 'The Gauntlet',
   corruptedGauntlet: 'The Corrupted Gauntlet',
   theatreOfBlood: 'Theatre of Blood',
   theatreOfBloodHardMode: 'Theatre of Blood: Hard Mode',
   thermonuclearSmokeDevil: 'Thermonuclear Smoke Devil',
+  tombsOfAmascut: 'Tombs of Amascut',
+  tombsOfAmascutExpertMode: 'Tombs of Amascut: Expert Mode',
   tzKalZuk: 'TzKal-Zuk',
   tzTokJad: 'TzTok-Jad',
   venenatis: 'Venenatis',
@@ -236,10 +259,16 @@ export type FormattedBHNames = {
 };
 
 export const FORMATTED_BH_NAMES: FormattedBHNames = {
-  rogue: 'Bounty Hunter - Rogue',
-  hunter: 'Bounty Hunter - Hunter'
+  rogue: 'Bounty Hunter (Legacy) - Rogue',
+  hunter: 'Bounty Hunter (Legacy) - Hunter',
+  rogueV2: 'Bounty Hunter - Rogue',
+  hunterV2: 'Bounty Hunter - Hunter'
 };
 
 export const FORMATTED_LMS = 'Last Man Standing';
+export const FORMATTED_PVP_ARENA = 'PvP Arena';
 export const FORMATTED_SOUL_WARS = 'Soul Wars Zeal';
 export const FORMATTED_LEAGUE_POINTS = 'League Points';
+export const FORMATTED_RIFTS_CLOSED = 'Rifts Closed';
+
+export const INVALID_FORMAT_ERROR = 'Invalid hiscores format';

src/utils/helpers.ts

@@ -1,4 +1,4 @@
-import axios from 'axios';
+import axios, { AxiosRequestConfig } from 'axios';
 import * as ua from 'useragent-generator';
 import { Gamemode, SkillName, ActivityName } from '../types';
 import {
@@ -96,10 +96,29 @@ export const rsnFromElement = (el: Element | null) => {
  * @param url URL to run a `GET` request against.
  * @returns Axios response.
  */
-export const httpGet = (url: string) =>
-  axios.get(url, {
+export const httpGet = <Response>(
+  url: string,
+  config: AxiosRequestConfig = {}
+) =>
+  axios.get<Response>(url, {
     headers: {
       // without User-Agent header requests may be rejected by DDoS protection mechanism
       'User-Agent': ua.firefox(80)
-    }
+    },
+    ...config
   });
+
+/**
+ * Validates that a provided RSN has the same username restrictions as Jagex.
+ * @param rsn Username to validate.
+ * @throws Error if the RSN fails validation.
+ */
+export const validateRSN = (rsn: string) => {
+  if (typeof rsn !== 'string') {
+    throw Error('RSN must be a string');
+  } else if (!/^[a-zA-Z0-9 _-]+$/.test(rsn)) {
+    throw Error('RSN contains invalid character');
+  } else if (rsn.length > 12 || rsn.length < 1) {
+    throw Error('RSN must be between 1 and 12 characters');
+  }
+};

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__/*"]