Restrict GH workflow push builds to main

.github/workflows/main.yml

@@ -1,6 +1,10 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 
 jobs:
   build:
@@ -10,6 +14,12 @@ jobs:
       - 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

.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

@@ -4,11 +4,11 @@
 [![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)
 
-**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 +50,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 +83,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:
@@ -200,7 +200,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

@@ -4,7 +4,7 @@ import {
   getStats,
   getStatsByGamemode,
   getRSNFormat,
-  Stats,
+  Stats
 } from '../src/index';
 
 test('Parse CSV to json', () => {
@@ -115,12 +115,12 @@ 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: 23423, score: 478 },
     bountyHunter: {
       hunter: { rank: 99831, score: 23 },
-      rogue: { rank: 89912, score: 37 },
+      rogue: { rank: 89912, score: 37 }
     },
     lastManStanding: { rank: 4814, score: 898 },
     soulWarsZeal: { rank: 37, score: 225 },
@@ -131,7 +131,7 @@ 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 },
@@ -178,17 +178,38 @@ 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 () => {
+describe('Get name format', () => {
+  it('gets a name with a space', async () => {
     jest.setTimeout(30000);
     const data = await getRSNFormat('lYnX tiTaN');
     expect(data).toBe('Lynx Titan');
+  });
+  it('gets a name with an underscore', async () => {
+    jest.setTimeout(30000);
+    const data = await getRSNFormat('lYnX_tiTaN');
+    expect(data).toBe('Lynx Titan');
+  });
+  it('gets a name with a hyphen', async () => {
+    jest.setTimeout(30000);
+    const data = await getRSNFormat('lYnX-tiTaN');
+    expect(data).toBe('Lynx Titan');
+  });
+  it('gets a name with a number', async () => {
+    jest.setTimeout(30000);
+    const data = await getRSNFormat('B0ATY');
+    expect(data).toBe('B0aty');
+  });
+  it('throws an error for a name with invalid characters', async () => {
+    jest.setTimeout(30000);
+    await expect(getRSNFormat('b&aty')).rejects.toBeTruthy();
+  });
 });
 
 test('Get attack top page', async () => {
@@ -200,176 +221,182 @@ 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 () => {
+test('Get non-existent player', async () => {
   jest.setTimeout(30000);
-  getStats('fishy').catch(err => {
+  getStats('fishy').catch((err) => {
     if (err.response) {
       expect(err.response.status).toBe(404);
     }
@@ -403,6 +430,6 @@ 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 }
   });
 });

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,7 +1,7 @@
 {
   "name": "osrs-json-hiscores",
   "version": "2.4.0",
-  "description": "The Oldschool Runescape API wrapper that does more!",
+  "description": "The Old School Runescape API wrapper that does more!",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -11,7 +11,8 @@
     "dev": "watch 'yarn run build' src",
     "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"
   },
@@ -35,22 +36,80 @@
     "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.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",
+    "lint-staged": "^10.5.4",
     "np": "6.5.0",
-    "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",
+    "prettier": "^2.2.1",
+    "ts-jest": "^26.5.4",
+    "typescript": "^4.2.3",
     "watch": "^1.0.2"
   }
 }

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,4 @@
+import { JSDOM } from 'jsdom';
 import {
   Player,
   Activity,
@@ -11,7 +12,7 @@ import {
   PlayerSkillRow,
   ActivityName,
   PlayerActivityRow,
-  Bosses,
+  Bosses
 } from './types';
 import {
   getStatsURL,
@@ -26,10 +27,128 @@ import {
   rsnFromElement,
   getActivityPageURL,
   httpGet,
-  BOSSES,
+  BOSSES
 } from './utils';
-import { JSDOM } from 'jsdom';
 
+/**
+ * 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> {
+  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');
+  }
+}
+
+/**
+ * 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(','));
+
+  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;
+}
+
+/**
+ * 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): Promise<Player> {
   if (typeof rsn !== 'string') {
     throw Error('RSN must be a string');
@@ -42,20 +161,20 @@ export async function getStats(rsn: string): Promise<Player> {
   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),
+      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 player: Player = {
-      name: formattedName || rsn,
+      name: formattedName ?? rsn,
       mode: 'main',
       dead: false,
       deulted: false,
-      deironed: false,
+      deironed: false
     };
     player.main = parseStats(mainRes.data);
 
@@ -107,6 +226,13 @@ 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'
@@ -150,7 +276,7 @@ export async function getSkillPage(
   );
 
   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 +288,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',
@@ -190,7 +324,7 @@ export async function getActivityPage(
   );
 
   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 +334,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/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';
@@ -22,7 +22,7 @@ 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/`
 };
 export const SKILLS: SkillName[] = [
   'overall',
@@ -48,7 +48,7 @@ export const SKILLS: SkillName[] = [
   'farming',
   'runecraft',
   'hunter',
-  'construction',
+  'construction'
 ];
 export const CLUES: ClueType[] = [
   'all',
@@ -57,7 +57,7 @@ export const CLUES: ClueType[] = [
   'medium',
   'hard',
   'elite',
-  'master',
+  'master'
 ];
 export const BH_MODES: BHType[] = ['hunter', 'rogue'];
 export const GAMEMODES: Gamemode[] = [
@@ -67,7 +67,7 @@ export const GAMEMODES: Gamemode[] = [
   'ultimate',
   'deadman',
   'seasonal',
-  'tournament',
+  'tournament'
 ];
 export const BOSSES: Boss[] = [
   'abyssalSire',
@@ -114,7 +114,7 @@ export const BOSSES: Boss[] = [
   'vorkath',
   'wintertodt',
   'zalcano',
-  'zulrah',
+  'zulrah'
 ];
 export const ACTIVITIES: ActivityName[] = [
   'leaguePoints',
@@ -129,7 +129,7 @@ export const ACTIVITIES: ActivityName[] = [
   'masterClues',
   'lastManStanding',
   'soulWarsZeal',
-  ...BOSSES,
+  ...BOSSES
 ];
 
 export type FormattedBossNames = {
@@ -181,7 +181,7 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
   vorkath: 'Vorkath',
   wintertodt: 'Wintertodt',
   zalcano: 'Zalcano',
-  zulrah: 'Zulrah',
+  zulrah: 'Zulrah'
 };
 
 export type FormattedSkillNames = {
@@ -212,7 +212,7 @@ export const FORMATTED_SKILL_NAMES: FormattedSkillNames = {
   farming: 'Farming',
   runecraft: 'Runecraft',
   hunter: 'Hunter',
-  construction: 'Construction',
+  construction: 'Construction'
 };
 
 export type FormattedClueNames = {
@@ -226,7 +226,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 = {
@@ -235,7 +235,7 @@ 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';

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,39 @@ 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 = (url: string) =>
+  axios.get(url, {
     headers: {
       // without User-Agent header requests may be rejected by DDoS protection mechanism
       'User-Agent': ua.firefox(80)
     }
   });
-};

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"
-    ]
-  }
-}