osrs-json-hiscores 2.12.0 → 2.13.0

package/README.md

@@ -125,9 +125,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`           |
+| Cal'varion                        |          `calvarion`           |
 | Cerberus                          |           `cerberus`           |
 | Chambers Of Xeric                 |       `chambersOfXeric`        |
 | Chambers Of Xeric: Challenge Mode | `chambersOfXericChallengeMode` |
@@ -158,6 +160,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Sarachnis                         |          `sarachnis`           |
 | Scorpia                           |           `scorpia`            |
 | Skotizo                           |           `skotizo`            |
+| Spindel                           |           `spindel`            |
 | Tempoross                         |          `tempoross`           |
 | The Gauntlet                      |           `gauntlet`           |
 | The Corrupted Gauntlet            |      `corruptedGauntlet`       |

package/lib/hiscores.d.ts

@@ -1,4 +1,4 @@
-import { Player, Stats, Gamemode, SkillName, PlayerSkillRow, ActivityName, PlayerActivityRow } from './types';
+import { Player, Stats, Gamemode, SkillName, PlayerSkillRow, ActivityName, PlayerActivityRow, GetStatsOptions } from './types';
 /**
  * Screen scrapes the hiscores to get the formatted rsn of a player.
  *
@@ -22,7 +22,7 @@ export declare function parseStats(csv: string): Stats;
  * @param rsn Username of the player.
  * @returns Player object.
  */
-export declare function getStats(rsn: string): Promise<Player>;
+export declare function getStats(rsn: string, options?: GetStatsOptions): Promise<Player>;
 /**
  * Fetches stats from the OSRS API and returns them as an object.
  *

package/lib/hiscores.js

@@ -62,15 +62,7 @@ function getRSNFormat(rsn) {
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    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');
-                    }
+                    utils_1.validateRSN(rsn);
                     url = utils_1.getPlayerTableURL('main', rsn);
                     _b.label = 1;
                 case 1:
@@ -177,34 +169,49 @@ exports.parseStats = parseStats;
  * @param rsn Username of the player.
  * @returns Player object.
  */
-function getStats(rsn) {
+function getStats(rsn, options) {
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function () {
-        var mainRes, otherResponses, ironRes, hcRes, ultRes, formattedName, player;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
+        var otherGamemodes, shouldGetFormattedRsn, mainRes, emptyResponse_1, getModeStats, formattedName, _c, player, ironRes, hcRes, ultRes;
+        var _this = this;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
                 case 0:
-                    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');
-                    }
+                    utils_1.validateRSN(rsn);
+                    otherGamemodes = (_a = options === null || options === void 0 ? void 0 : options.otherGamemodes) !== null && _a !== void 0 ? _a : [
+                        'ironman',
+                        'hardcore',
+                        '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))];
                 case 1:
-                    mainRes = _a.sent();
-                    if (!(mainRes.status === 200)) return [3 /*break*/, 3];
-                    return [4 /*yield*/, Promise.all([
-                            utils_1.httpGet(utils_1.getStatsURL('ironman', rsn)).catch(function (err) { return err; }),
-                            utils_1.httpGet(utils_1.getStatsURL('hardcore', rsn)).catch(function (err) { return err; }),
-                            utils_1.httpGet(utils_1.getStatsURL('ultimate', rsn)).catch(function (err) { return err; }),
-                            getRSNFormat(rsn).catch(function () { return undefined; })
-                        ])];
+                    mainRes = _d.sent();
+                    if (!(mainRes.status === 200)) return [3 /*break*/, 9];
+                    emptyResponse_1 = {
+                        status: 404,
+                        data: '',
+                        statusText: '',
+                        headers: {},
+                        config: {}
+                    };
+                    getModeStats = function (mode) { return __awaiter(_this, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, otherGamemodes.includes(mode)
+                                    ? utils_1.httpGet(utils_1.getStatsURL(mode, rsn)).catch(function (err) { return err; })
+                                    : emptyResponse_1];
+                        });
+                    }); };
+                    if (!shouldGetFormattedRsn) return [3 /*break*/, 3];
+                    return [4 /*yield*/, getRSNFormat(rsn).catch(function () { return undefined; })];
                 case 2:
-                    otherResponses = _a.sent();
-                    ironRes = otherResponses[0], hcRes = otherResponses[1], ultRes = otherResponses[2], formattedName = otherResponses[3];
+                    _c = _d.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    _c = undefined;
+                    _d.label = 4;
+                case 4:
+                    formattedName = _c;
                     player = {
                         name: formattedName !== null && formattedName !== void 0 ? formattedName : rsn,
                         mode: 'main',
@@ -213,42 +220,51 @@ function getStats(rsn) {
                         deironed: false
                     };
                     player.main = parseStats(mainRes.data);
-                    if (ironRes.status === 200) {
-                        player.ironman = parseStats(ironRes.data);
-                        if (hcRes.status === 200) {
-                            player.mode = 'hardcore';
-                            player.hardcore = parseStats(hcRes.data);
-                            if (player.ironman.skills.overall.xp !== player.hardcore.skills.overall.xp) {
-                                player.dead = true;
-                                player.mode = 'ironman';
-                            }
-                            if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
-                                player.deironed = true;
-                                player.mode = 'main';
-                            }
+                    return [4 /*yield*/, getModeStats('ironman')];
+                case 5:
+                    ironRes = _d.sent();
+                    if (!(ironRes.status === 200)) return [3 /*break*/, 8];
+                    player.ironman = parseStats(ironRes.data);
+                    return [4 /*yield*/, getModeStats('hardcore')];
+                case 6:
+                    hcRes = _d.sent();
+                    return [4 /*yield*/, getModeStats('ultimate')];
+                case 7:
+                    ultRes = _d.sent();
+                    if (hcRes.status === 200) {
+                        player.mode = 'hardcore';
+                        player.hardcore = parseStats(hcRes.data);
+                        if (player.ironman.skills.overall.xp !== player.hardcore.skills.overall.xp) {
+                            player.dead = true;
+                            player.mode = 'ironman';
                         }
-                        else if (ultRes.status === 200) {
-                            player.mode = 'ultimate';
-                            player.ultimate = parseStats(ultRes.data);
-                            if (player.ironman.skills.overall.xp !== player.ultimate.skills.overall.xp) {
-                                player.deulted = true;
-                                player.mode = 'ironman';
-                            }
-                            if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
-                                player.deironed = true;
-                                player.mode = 'main';
-                            }
+                        if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
+                            player.deironed = true;
+                            player.mode = 'main';
                         }
-                        else {
+                    }
+                    else if (ultRes.status === 200) {
+                        player.mode = 'ultimate';
+                        player.ultimate = parseStats(ultRes.data);
+                        if (player.ironman.skills.overall.xp !== player.ultimate.skills.overall.xp) {
+                            player.deulted = true;
                             player.mode = 'ironman';
-                            if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
-                                player.deironed = true;
-                                player.mode = 'main';
-                            }
+                        }
+                        if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
+                            player.deironed = true;
+                            player.mode = 'main';
+                        }
+                    }
+                    else {
+                        player.mode = 'ironman';
+                        if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
+                            player.deironed = true;
+                            player.mode = 'main';
                         }
                     }
-                    return [2 /*return*/, player];
-                case 3: throw Error('Player not found');
+                    _d.label = 8;
+                case 8: return [2 /*return*/, player];
+                case 9: throw Error('Player not found');
             }
         });
     });
@@ -268,16 +284,8 @@ function getStatsByGamemode(rsn, mode) {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    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 (!utils_1.GAMEMODES.includes(mode)) {
+                    utils_1.validateRSN(rsn);
+                    if (!utils_1.GAMEMODES.includes(mode)) {
                         throw Error('Invalid game mode');
                     }
                     return [4 /*yield*/, utils_1.httpGet(utils_1.getStatsURL(mode, rsn))];

package/lib/types.d.ts

@@ -20,7 +20,7 @@ export declare type BHType = 'rogue' | 'hunter';
 export declare type BH = {
     [Type in BHType]: Activity;
 };
-export declare type Boss = 'abyssalSire' | 'alchemicalHydra' | 'barrows' | 'bryophyta' | 'callisto' | 'cerberus' | 'chambersOfXeric' | 'chambersOfXericChallengeMode' | 'chaosElemental' | 'chaosFanatic' | 'commanderZilyana' | 'corporealBeast' | 'crazyArchaeologist' | 'dagannothPrime' | 'dagannothRex' | 'dagannothSupreme' | 'derangedArchaeologist' | 'generalGraardor' | 'giantMole' | 'grotesqueGuardians' | 'hespori' | 'kalphiteQueen' | 'kingBlackDragon' | 'kraken' | 'kreeArra' | 'krilTsutsaroth' | 'mimic' | 'nex' | 'nightmare' | 'phosanisNightmare' | 'obor' | 'phantomMuspah' | 'sarachnis' | 'scorpia' | 'skotizo' | 'tempoross' | 'gauntlet' | 'corruptedGauntlet' | 'theatreOfBlood' | 'theatreOfBloodHardMode' | 'thermonuclearSmokeDevil' | 'tombsOfAmascut' | 'tombsOfAmascutExpertMode' | 'tzKalZuk' | 'tzTokJad' | 'venenatis' | 'vetion' | 'vorkath' | 'wintertodt' | 'zalcano' | 'zulrah';
+export declare type Boss = 'abyssalSire' | 'alchemicalHydra' | 'artio' | 'barrows' | 'bryophyta' | 'callisto' | 'calvarion' | 'cerberus' | 'chambersOfXeric' | 'chambersOfXericChallengeMode' | 'chaosElemental' | 'chaosFanatic' | 'commanderZilyana' | 'corporealBeast' | 'crazyArchaeologist' | 'dagannothPrime' | 'dagannothRex' | 'dagannothSupreme' | 'derangedArchaeologist' | 'generalGraardor' | 'giantMole' | 'grotesqueGuardians' | 'hespori' | 'kalphiteQueen' | 'kingBlackDragon' | 'kraken' | 'kreeArra' | 'krilTsutsaroth' | 'mimic' | 'nex' | 'nightmare' | 'phosanisNightmare' | 'obor' | 'phantomMuspah' | 'sarachnis' | 'scorpia' | 'skotizo' | 'spindel' | 'tempoross' | 'gauntlet' | 'corruptedGauntlet' | 'theatreOfBlood' | 'theatreOfBloodHardMode' | 'thermonuclearSmokeDevil' | 'tombsOfAmascut' | 'tombsOfAmascutExpertMode' | 'tzKalZuk' | 'tzTokJad' | 'venenatis' | 'vetion' | 'vorkath' | 'wintertodt' | 'zalcano' | 'zulrah';
 export declare type Bosses = {
     [Type in Boss]: Activity;
 };
@@ -54,3 +54,15 @@ 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;
+}

package/lib/utils/constants.js

@@ -69,9 +69,11 @@ exports.GAMEMODES = [
 exports.BOSSES = [
     'abyssalSire',
     'alchemicalHydra',
+    'artio',
     'barrows',
     'bryophyta',
     'callisto',
+    'calvarion',
     'cerberus',
     'chambersOfXeric',
     'chambersOfXericChallengeMode',
@@ -102,6 +104,7 @@ exports.BOSSES = [
     'sarachnis',
     'scorpia',
     'skotizo',
+    'spindel',
     'tempoross',
     'gauntlet',
     'corruptedGauntlet',
@@ -138,9 +141,11 @@ exports.ACTIVITIES = __spreadArray([
 exports.FORMATTED_BOSS_NAMES = {
     abyssalSire: 'Abyssal Sire',
     alchemicalHydra: 'Alchemical Hydra',
+    artio: 'Artio',
     barrows: 'Barrows Chests',
     bryophyta: 'Bryophyta',
     callisto: 'Callisto',
+    calvarion: "Cal'varion",
     cerberus: 'Cerberus',
     chambersOfXeric: 'Chambers of Xeric',
     chambersOfXericChallengeMode: 'Chambers of Xeric: Challenge Mode',
@@ -171,6 +176,7 @@ exports.FORMATTED_BOSS_NAMES = {
     sarachnis: 'Sarachnis',
     scorpia: 'Scorpia',
     skotizo: 'Skotizo',
+    spindel: 'Spindel',
     tempoross: 'Tempoross',
     gauntlet: 'The Gauntlet',
     corruptedGauntlet: 'The Corrupted Gauntlet',

package/lib/utils/helpers.d.ts

@@ -53,4 +53,10 @@ export declare const rsnFromElement: (el: Element | null) => string;
  * @param url URL to run a `GET` request against.
  * @returns Axios response.
  */
-export declare const httpGet: (url: string) => Promise<import("axios").AxiosResponse<any>>;
+export declare const httpGet: <Response_1>(url: string) => Promise<import("axios").AxiosResponse<Response_1>>;
+/**
+ * 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 declare const validateRSN: (rsn: string) => void;

package/lib/utils/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.httpGet = exports.rsnFromElement = exports.numberFromElement = exports.getActivityPageURL = exports.getSkillPageURL = exports.getPlayerTableURL = exports.getStatsURL = void 0;
+exports.validateRSN = exports.httpGet = exports.rsnFromElement = exports.numberFromElement = exports.getActivityPageURL = exports.getSkillPageURL = exports.getPlayerTableURL = exports.getStatsURL = void 0;
 var axios_1 = require("axios");
 var ua = require("useragent-generator");
 var constants_1 = require("./constants");
@@ -90,3 +90,20 @@ var httpGet = function (url) {
     });
 };
 exports.httpGet = httpGet;
+/**
+ * Validates that a provided RSN has the same username restrictions as Jagex.
+ * @param rsn Username to validate.
+ * @throws Error if the RSN fails validation.
+ */
+var validateRSN = function (rsn) {
+    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');
+    }
+};
+exports.validateRSN = validateRSN;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.12.0",
+  "version": "2.13.0",
   "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": {
@@ -106,7 +109,7 @@
     "husky": "^5.2.0",
     "jest": "^26.6.3",
     "lint-staged": "^10.5.4",
-    "np": "6.5.0",
+    "np": "^7.7.0",
     "prettier": "^2.2.1",
     "ts-jest": "^26.5.4",
     "typescript": "^4.2.3"