v2.14.2

Update testing, linting and formatting libraries

package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.14.0",
+  "version": "2.14.2",
   "description": "The Old School Runescape API wrapper that does more!",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -61,7 +61,8 @@
       "@typescript-eslint"
     ],
     "extends": [
-      "eslint-config-airbnb-typescript",
+      "airbnb-base",
+      "airbnb-typescript/base",
       "prettier"
     ],
     "ignorePatterns": [
@@ -72,7 +73,8 @@
     "trailingComma": "none",
     "tabWidth": 2,
     "semi": true,
-    "singleQuote": true
+    "singleQuote": true,
+    "endOfLine": "auto"
   },
   "jest": {
     "transform": {
@@ -91,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",
+    "jest": "^29.6.1",
+    "lint-staged": "^13.2.3",
     "np": "^7.7.0",
-    "prettier": "^2.2.1",
-    "ts-jest": "^26.5.4",
-    "typescript": "^4.2.3"
+    "prettier": "^3.0.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.1.6"
   }
 }

src/hiscores.ts

@@ -1,4 +1,4 @@
-import { AxiosResponse } from 'axios';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
 import { BinaryData, JSDOM } from 'jsdom';
 import {
   Player,
@@ -38,15 +38,20 @@ import {
  * 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> {
+export async function getRSNFormat(
+  rsn: string,
+  config?: AxiosRequestConfig
+): Promise<string> {
   validateRSN(rsn);
 
   const url = getPlayerTableURL('main', rsn);
   try {
     const response = await httpGet<string | Buffer | BinaryData | undefined>(
-      url
+      url,
+      config
     );
     const dom = new JSDOM(response.data);
     const anchor = dom.window.document.querySelector(
@@ -106,12 +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,
-    pvpArena,
-    soulWarsZeal,
-    riftsClosed
-  ] = activityObjects.splice(0, 4);
+  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) => {
@@ -174,7 +175,10 @@ export async function getStats(
   ];
   const shouldGetFormattedRsn = options?.shouldGetFormattedRsn ?? true;
 
-  const mainRes = await httpGet<string>(getStatsURL('main', rsn));
+  const mainRes = await httpGet<string>(
+    getStatsURL('main', rsn),
+    options?.axiosConfigs?.main
+  );
   if (mainRes.status === 200) {
     const emptyResponse: AxiosResponse<string> = {
       status: 404,
@@ -187,10 +191,15 @@ export async function getStats(
       mode: Extract<Gamemode, 'ironman' | 'hardcore' | 'ultimate'>
     ): Promise<AxiosResponse<string>> =>
       otherGamemodes.includes(mode)
-        ? httpGet<string>(getStatsURL(mode, rsn)).catch((err) => err)
+        ? httpGet<string>(
+            getStatsURL(mode, rsn),
+            options?.axiosConfigs?.[mode]
+          ).catch((err) => err)
         : emptyResponse;
     const formattedName = shouldGetFormattedRsn
-      ? await getRSNFormat(rsn).catch(() => undefined)
+      ? await getRSNFormat(rsn, options?.axiosConfigs?.rsn).catch(
+          () => undefined
+        )
       : undefined;
 
     const player: Player = {
@@ -258,17 +267,19 @@ export async function getStats(
  *
  * @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> {
   validateRSN(rsn);
   if (!GAMEMODES.includes(mode)) {
     throw Error('Invalid game mode');
   }
-  const response = await httpGet<string>(getStatsURL(mode, rsn));
+  const response = await httpGet<string>(getStatsURL(mode, rsn), config);
   if (response.status !== 200) {
     throw Error('Player not found');
   }
@@ -280,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');
@@ -291,7 +303,10 @@ export async function getSkillPage(
   }
   const url = getSkillPageURL(mode, skill, page);
 
-  const response = await httpGet<string | Buffer | BinaryData | undefined>(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'
@@ -323,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');
@@ -339,7 +356,10 @@ export async function getActivityPage(
   }
   const url = getActivityPageURL(mode, activity, page);
 
-  const response = await httpGet<string | Buffer | BinaryData | undefined>(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'
@@ -183,4 +185,13 @@ export interface GetStatsOptions {
    * @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/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,12 +96,16 @@ export const rsnFromElement = (el: Element | null) => {
  * @param url URL to run a `GET` request against.
  * @returns Axios response.
  */
-export const httpGet = <Response>(url: string) =>
+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
   });
 
 /**