v2.3.1

Bump dot-prop from 4.2.0 to 4.2.1

package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "The Oldschool Runescape API wrapper that does more!",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -37,15 +37,16 @@
   "homepage": "https://github.com/maxswa/osrs-json-hiscores#readme",
   "dependencies": {
     "axios": "^0.21.1",
-    "jsdom": "^16.3.0"
+    "jsdom": "^16.3.0",
+    "useragent-generator": "^1.1.0"
   },
   "devDependencies": {
-    "@types/jest": "^24.0.14",
+    "@types/jest": "^26.0.20",
     "@types/jsdom": "^16.2.3",
-    "jest": "^24.8.0",
+    "jest": "^26.6.3",
     "np": "^5.0.3",
     "prettier": "^1.19.1",
-    "ts-jest": "^24.0.2",
+    "ts-jest": "^26.4.4",
     "tslint": "^5.17.0",
     "tslint-config-airbnb": "^5.11.1",
     "tslint-config-prettier": "^1.18.0",

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

@@ -0,0 +1,51 @@
+declare module 'useragent-generator' {
+  /********************
+   *  Google Chrome   *
+   /*******************/
+  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 chromecast(opt: number | string | { version: 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;
+  /***************
+   *   Firefox   *
+   /*************/
+  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;
+  }
+  /**************
+   *   Safari   *
+   /************/
+  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;
+  }
+  /***********************
+   *  Internet Explorer  *
+   /*********************/
+  export function ie(opt: number | string | { version: string, os?: string }): string;
+  export namespace ie {
+    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;
+  /************************
+   *  Search Engine Bots  *
+   /**********************/
+  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,4 +1,3 @@
-import axios from 'axios';
 import {
   Player,
   Activity,
@@ -26,6 +25,7 @@ import {
   numberFromElement,
   rsnFromElement,
   getActivityPageURL,
+  httpGet,
   BOSSES,
 } from './utils';
 import { JSDOM } from 'jsdom';
@@ -39,12 +39,12 @@ export async function getStats(rsn: string): Promise<Player> {
     throw Error('RSN must be between 1 and 12 characters');
   }
 
-  const mainRes = await axios(getStatsURL('main', rsn));
+  const mainRes = await httpGet(getStatsURL('main', rsn));
   if (mainRes.status === 200) {
     const otherResponses = await Promise.all([
-      axios(getStatsURL('ironman', rsn)).catch(err => err),
-      axios(getStatsURL('hardcore', rsn)).catch(err => err),
-      axios(getStatsURL('ultimate', rsn)).catch(err => err),
+      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),
     ]);
 
@@ -120,7 +120,7 @@ export async function getStatsByGamemode(
   } else if (!GAMEMODES.includes(mode)) {
     throw Error('Invalid game mode');
   }
-  const response = await axios(getStatsURL(mode, rsn));
+  const response = await httpGet(getStatsURL(mode, rsn));
   if (response.status !== 200) {
     throw Error('Player not found');
   }
@@ -143,7 +143,7 @@ export async function getSkillPage(
   }
   const url = getSkillPageURL(mode, skill, page);
 
-  const response = await axios(url);
+  const response = await httpGet(url);
   const dom = new JSDOM(response.data);
   const playersHTML = dom.window.document.querySelectorAll(
     '.personal-hiscores__row'
@@ -183,7 +183,7 @@ export async function getActivityPage(
   }
   const url = getActivityPageURL(mode, activity, page);
 
-  const response = await axios(url);
+  const response = await httpGet(url);
   const dom = new JSDOM(response.data);
   const playersHTML = dom.window.document.querySelectorAll(
     '.personal-hiscores__row'
@@ -218,7 +218,7 @@ export async function getRSNFormat(rsn: string): Promise<string> {
 
   const url = getPlayerTableURL('main', rsn);
   try {
-    const response = await axios(url);
+    const response = await httpGet(url);
     const dom = new JSDOM(response.data);
     const spans = dom.window.document.querySelectorAll(
       'span[style="color:#AA0022;"]'

src/utils/helpers.ts

@@ -1,3 +1,5 @@
+import axios from 'axios';
+import * as ua from 'useragent-generator';
 import { Gamemode, SkillName, ActivityName } from '../types';
 import {
   GAMEMODE_URL,
@@ -45,3 +47,12 @@ export const rsnFromElement = (el: Element | null) => {
   const { innerHTML } = el || {};
   return innerHTML?.replace(/\uFFFD/g, ' ') || '';
 };
+
+export const httpGet = (url: string) => {
+  return axios.get(url, {
+    headers: {
+      // without User-Agent header requests may be rejected by DDoS protection mechanism
+      'User-Agent': ua.firefox(80)
+    }
+  });
+};