osrs-json-hiscores 2.14.0 → 2.14.1

package/lib/hiscores.d.ts

@@ -1,11 +1,13 @@
+import { AxiosRequestConfig } from 'axios';
 import { Player, Stats, Gamemode, SkillName, PlayerSkillRow, ActivityName, PlayerActivityRow, GetStatsOptions } from './types';
 /**
  * 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 declare function getRSNFormat(rsn: string): Promise<string>;
+export declare function getRSNFormat(rsn: string, config?: AxiosRequestConfig): Promise<string>;
 /**
  * Parses CSV string of raw stats and returns a stats object.
  *
@@ -28,16 +30,18 @@ export declare function getStats(rsn: string, options?: GetStatsOptions): Promis
  *
  * @param rsn Username of the player.
  * @param mode Gamemode to fetch ranks for.
+ * @param config Optional axios request config object.
  * @returns Stats object.
  */
-export declare function getStatsByGamemode(rsn: string, mode?: Gamemode): Promise<Stats>;
-export declare function getSkillPage(skill: SkillName, mode?: Gamemode, page?: number): Promise<PlayerSkillRow[]>;
+export declare function getStatsByGamemode(rsn: string, mode?: Gamemode, config?: AxiosRequestConfig): Promise<Stats>;
+export declare function getSkillPage(skill: SkillName, mode?: Gamemode, page?: number, config?: AxiosRequestConfig): Promise<PlayerSkillRow[]>;
 /**
  * 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.
+ * @param config Optional axios request config object.
  * @returns Array of `PlayerActivityRow` objects.
  */
-export declare function getActivityPage(activity: ActivityName, mode?: Gamemode, page?: number): Promise<PlayerActivityRow[]>;
+export declare function getActivityPage(activity: ActivityName, mode?: Gamemode, page?: number, config?: AxiosRequestConfig): Promise<PlayerActivityRow[]>;

package/lib/hiscores.js

@@ -54,9 +54,10 @@ var utils_1 = require("./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.
  */
-function getRSNFormat(rsn) {
+function getRSNFormat(rsn, config) {
     return __awaiter(this, void 0, void 0, function () {
         var url, response, dom, anchor, _a;
         return __generator(this, function (_b) {
@@ -67,7 +68,7 @@ function getRSNFormat(rsn) {
                     _b.label = 1;
                 case 1:
                     _b.trys.push([1, 3, , 4]);
-                    return [4 /*yield*/, utils_1.httpGet(url)];
+                    return [4 /*yield*/, utils_1.httpGet(url, config)];
                 case 2:
                     response = _b.sent();
                     dom = new jsdom_1.JSDOM(response.data);
@@ -170,12 +171,12 @@ exports.parseStats = parseStats;
  * @returns Player object.
  */
 function getStats(rsn, options) {
-    var _a, _b;
+    var _a, _b, _c, _d;
     return __awaiter(this, void 0, void 0, function () {
-        var otherGamemodes, shouldGetFormattedRsn, mainRes, emptyResponse_1, getModeStats, formattedName, _c, player, ironRes, hcRes, ultRes;
+        var otherGamemodes, shouldGetFormattedRsn, mainRes, emptyResponse_1, getModeStats, formattedName, _e, player, ironRes, hcRes, ultRes;
         var _this = this;
-        return __generator(this, function (_d) {
-            switch (_d.label) {
+        return __generator(this, function (_f) {
+            switch (_f.label) {
                 case 0:
                     utils_1.validateRSN(rsn);
                     otherGamemodes = (_a = options === null || options === void 0 ? void 0 : options.otherGamemodes) !== null && _a !== void 0 ? _a : [
@@ -184,9 +185,9 @@ function getStats(rsn, options) {
                         'ultimate'
                     ];
                     shouldGetFormattedRsn = (_b = options === null || options === void 0 ? void 0 : options.shouldGetFormattedRsn) !== null && _b !== void 0 ? _b : true;
-                    return [4 /*yield*/, utils_1.httpGet(utils_1.getStatsURL('main', rsn))];
+                    return [4 /*yield*/, utils_1.httpGet(utils_1.getStatsURL('main', rsn), (_c = options === null || options === void 0 ? void 0 : options.axiosConfigs) === null || _c === void 0 ? void 0 : _c.main)];
                 case 1:
-                    mainRes = _d.sent();
+                    mainRes = _f.sent();
                     if (!(mainRes.status === 200)) return [3 /*break*/, 9];
                     emptyResponse_1 = {
                         status: 404,
@@ -196,22 +197,23 @@ function getStats(rsn, options) {
                         config: {}
                     };
                     getModeStats = function (mode) { return __awaiter(_this, void 0, void 0, function () {
-                        return __generator(this, function (_a) {
+                        var _a;
+                        return __generator(this, function (_b) {
                             return [2 /*return*/, otherGamemodes.includes(mode)
-                                    ? utils_1.httpGet(utils_1.getStatsURL(mode, rsn)).catch(function (err) { return err; })
+                                    ? utils_1.httpGet(utils_1.getStatsURL(mode, rsn), (_a = options === null || options === void 0 ? void 0 : options.axiosConfigs) === null || _a === void 0 ? void 0 : _a[mode]).catch(function (err) { return err; })
                                     : emptyResponse_1];
                         });
                     }); };
                     if (!shouldGetFormattedRsn) return [3 /*break*/, 3];
-                    return [4 /*yield*/, getRSNFormat(rsn).catch(function () { return undefined; })];
+                    return [4 /*yield*/, getRSNFormat(rsn, (_d = options === null || options === void 0 ? void 0 : options.axiosConfigs) === null || _d === void 0 ? void 0 : _d.rsn).catch(function () { return undefined; })];
                 case 2:
-                    _c = _d.sent();
+                    _e = _f.sent();
                     return [3 /*break*/, 4];
                 case 3:
-                    _c = undefined;
-                    _d.label = 4;
+                    _e = undefined;
+                    _f.label = 4;
                 case 4:
-                    formattedName = _c;
+                    formattedName = _e;
                     player = {
                         name: formattedName !== null && formattedName !== void 0 ? formattedName : rsn,
                         mode: 'main',
@@ -222,15 +224,15 @@ function getStats(rsn, options) {
                     player.main = parseStats(mainRes.data);
                     return [4 /*yield*/, getModeStats('ironman')];
                 case 5:
-                    ironRes = _d.sent();
+                    ironRes = _f.sent();
                     if (!(ironRes.status === 200)) return [3 /*break*/, 8];
                     player.ironman = parseStats(ironRes.data);
                     return [4 /*yield*/, getModeStats('hardcore')];
                 case 6:
-                    hcRes = _d.sent();
+                    hcRes = _f.sent();
                     return [4 /*yield*/, getModeStats('ultimate')];
                 case 7:
-                    ultRes = _d.sent();
+                    ultRes = _f.sent();
                     if (hcRes.status === 200) {
                         player.mode = 'hardcore';
                         player.hardcore = parseStats(hcRes.data);
@@ -262,7 +264,7 @@ function getStats(rsn, options) {
                             player.mode = 'main';
                         }
                     }
-                    _d.label = 8;
+                    _f.label = 8;
                 case 8: return [2 /*return*/, player];
                 case 9: throw Error('Player not found');
             }
@@ -275,9 +277,10 @@ exports.getStats = getStats;
  *
  * @param rsn Username of the player.
  * @param mode Gamemode to fetch ranks for.
+ * @param config Optional axios request config object.
  * @returns Stats object.
  */
-function getStatsByGamemode(rsn, mode) {
+function getStatsByGamemode(rsn, mode, config) {
     if (mode === void 0) { mode = 'main'; }
     return __awaiter(this, void 0, void 0, function () {
         var response, stats;
@@ -288,7 +291,7 @@ function getStatsByGamemode(rsn, mode) {
                     if (!utils_1.GAMEMODES.includes(mode)) {
                         throw Error('Invalid game mode');
                     }
-                    return [4 /*yield*/, utils_1.httpGet(utils_1.getStatsURL(mode, rsn))];
+                    return [4 /*yield*/, utils_1.httpGet(utils_1.getStatsURL(mode, rsn), config)];
                 case 1:
                     response = _a.sent();
                     if (response.status !== 200) {
@@ -301,7 +304,7 @@ function getStatsByGamemode(rsn, mode) {
     });
 }
 exports.getStatsByGamemode = getStatsByGamemode;
-function getSkillPage(skill, mode, page) {
+function getSkillPage(skill, mode, page, config) {
     if (mode === void 0) { mode = 'main'; }
     if (page === void 0) { page = 1; }
     return __awaiter(this, void 0, void 0, function () {
@@ -319,7 +322,7 @@ function getSkillPage(skill, mode, page) {
                         throw Error('Invalid skill');
                     }
                     url = utils_1.getSkillPageURL(mode, skill, page);
-                    return [4 /*yield*/, utils_1.httpGet(url)];
+                    return [4 /*yield*/, utils_1.httpGet(url, config)];
                 case 1:
                     response = _a.sent();
                     dom = new jsdom_1.JSDOM(response.data);
@@ -351,9 +354,10 @@ exports.getSkillPage = 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.
  */
-function getActivityPage(activity, mode, page) {
+function getActivityPage(activity, mode, page, config) {
     if (mode === void 0) { mode = 'main'; }
     if (page === void 0) { page = 1; }
     return __awaiter(this, void 0, void 0, function () {
@@ -371,7 +375,7 @@ function getActivityPage(activity, mode, page) {
                         throw Error('Invalid activity');
                     }
                     url = utils_1.getActivityPageURL(mode, activity, page);
-                    return [4 /*yield*/, utils_1.httpGet(url)];
+                    return [4 /*yield*/, utils_1.httpGet(url, config)];
                 case 1:
                     response = _a.sent();
                     dom = new jsdom_1.JSDOM(response.data);

package/lib/types.d.ts

@@ -1,3 +1,4 @@
+import { AxiosRequestConfig } from 'axios';
 export declare type Gamemode = 'main' | 'ironman' | 'ultimate' | 'hardcore' | 'deadman' | 'seasonal' | 'tournament' | 'skiller' | 'oneDefence' | 'freshStart';
 export interface Skill {
     rank: number;
@@ -65,4 +66,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;
+    };
 }

package/lib/utils/helpers.d.ts

@@ -1,3 +1,4 @@
+import { AxiosRequestConfig } from 'axios';
 import { Gamemode, SkillName, ActivityName } from '../types';
 /**
  * Will generate a stats URL for the official OSRS API.
@@ -53,7 +54,7 @@ export declare const rsnFromElement: (el: Element | null) => string;
  * @param url URL to run a `GET` request against.
  * @returns Axios response.
  */
-export declare const httpGet: <Response_1>(url: string) => Promise<import("axios").AxiosResponse<Response_1>>;
+export declare const httpGet: <Response_1>(url: string, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<Response_1>>;
 /**
  * Validates that a provided RSN has the same username restrictions as Jagex.
  * @param rsn Username to validate.

package/lib/utils/helpers.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateRSN = exports.httpGet = exports.rsnFromElement = exports.numberFromElement = exports.getActivityPageURL = exports.getSkillPageURL = exports.getPlayerTableURL = exports.getStatsURL = void 0;
 var axios_1 = require("axios");
@@ -81,13 +92,12 @@ exports.rsnFromElement = rsnFromElement;
  * @param url URL to run a `GET` request against.
  * @returns Axios response.
  */
-var httpGet = function (url) {
-    return axios_1.default.get(url, {
-        headers: {
+var httpGet = function (url, config) {
+    if (config === void 0) { config = {}; }
+    return axios_1.default.get(url, __assign({ headers: {
             // without User-Agent header requests may be rejected by DDoS protection mechanism
             'User-Agent': ua.firefox(80)
-        }
-    });
+        } }, config));
 };
 exports.httpGet = httpGet;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.14.0",
+  "version": "2.14.1",
   "description": "The Old School Runescape API wrapper that does more!",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",