osrs-json-hiscores 2.16.1 → 2.16.3

package/README.md

@@ -115,11 +115,12 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Soul Wars Zeal                  |  `soulWarsZeal`   |
 | Rifts closed                    |   `riftsClosed`   |
 
-### Leagues
+### Points
 
-| Activity      |     Param      |
-| ------------- | :------------: |
-| League Points | `leaguePoints` |
+| Activity       |      Param      |
+| -------------- | :-------------: |
+| League Points  | `leaguePoints`  |
+| Deadman Points | `deadmanPoints` |
 
 ### Bosses
 

package/lib/hiscores.js

@@ -48,6 +48,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getActivityPage = exports.getSkillPage = exports.getStatsByGamemode = exports.getStats = exports.parseStats = exports.parseJsonStats = exports.getRSNFormat = exports.getOfficialStats = void 0;
+var axios_1 = require("axios");
 var jsdom_1 = require("jsdom");
 var utils_1 = require("./utils");
 /**
@@ -59,9 +60,10 @@ var utils_1 = require("./utils");
  * @returns Official JSON stats object.
  */
 function getOfficialStats(rsn, mode, config) {
+    var _a;
     if (mode === void 0) { mode = 'main'; }
     return __awaiter(this, void 0, void 0, function () {
-        var url, response, _a;
+        var url, response, err_1;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
@@ -75,8 +77,12 @@ function getOfficialStats(rsn, mode, config) {
                     response = _b.sent();
                     return [2 /*return*/, response.data];
                 case 3:
-                    _a = _b.sent();
-                    throw Error(utils_1.PLAYER_NOT_FOUND_ERROR);
+                    err_1 = _b.sent();
+                    if (!axios_1.default.isAxiosError(err_1))
+                        throw err_1;
+                    if (((_a = err_1.response) === null || _a === void 0 ? void 0 : _a.status) === 404)
+                        throw new utils_1.PlayerNotFoundError();
+                    throw new utils_1.HiScoresError();
                 case 4: return [2 /*return*/];
             }
         });
@@ -109,10 +115,10 @@ function getRSNFormat(rsn, config) {
                     if (anchor) {
                         return [2 /*return*/, (0, utils_1.rsnFromElement)(anchor)];
                     }
-                    throw Error(utils_1.PLAYER_NOT_FOUND_ERROR);
+                    throw new utils_1.PlayerNotFoundError();
                 case 3:
                     _a = _b.sent();
-                    throw Error(utils_1.PLAYER_NOT_FOUND_ERROR);
+                    throw new utils_1.HiScoresError();
                 case 4: return [2 /*return*/];
             }
         });
@@ -164,6 +170,7 @@ function parseJsonStats(json) {
     var clues = reduceActivity(utils_1.CLUES, utils_1.FORMATTED_CLUE_NAMES);
     var bosses = reduceActivity(utils_1.BOSSES, utils_1.FORMATTED_BOSS_NAMES);
     var leaguePoints = getActivity(utils_1.FORMATTED_LEAGUE_POINTS);
+    var deadmanPoints = getActivity(utils_1.FORMATTED_DEADMAN_POINTS);
     var lastManStanding = getActivity(utils_1.FORMATTED_LMS);
     var pvpArena = getActivity(utils_1.FORMATTED_PVP_ARENA);
     var soulWarsZeal = getActivity(utils_1.FORMATTED_SOUL_WARS);
@@ -171,6 +178,7 @@ function parseJsonStats(json) {
     var stats = {
         skills: skills,
         leaguePoints: leaguePoints,
+        deadmanPoints: deadmanPoints,
         bountyHunter: bountyHunter,
         lastManStanding: lastManStanding,
         pvpArena: pvpArena,
@@ -193,9 +201,8 @@ function parseStats(csv) {
         .split('\n')
         .filter(function (entry) { return !!entry; })
         .map(function (stat) { return stat.split(','); });
-    if (splitCSV.length !==
-        utils_1.SKILLS.length + utils_1.BH_MODES.length + utils_1.CLUES.length + utils_1.BOSSES.length + 5) {
-        throw Error(utils_1.INVALID_FORMAT_ERROR);
+    if (splitCSV.length !== utils_1.SKILLS.length + utils_1.ACTIVITIES.length) {
+        throw new utils_1.InvalidFormatError();
     }
     var skillObjects = splitCSV
         .filter(function (stat) { return stat.length === 3; })
@@ -218,10 +225,10 @@ function parseStats(csv) {
         };
         return activity;
     });
-    var leaguePoints = activityObjects.splice(0, 1)[0];
+    var _a = activityObjects.splice(0, 2), leaguePoints = _a[0], deadmanPoints = _a[1];
     var bhObjects = activityObjects.splice(0, utils_1.BH_MODES.length);
     var clueObjects = activityObjects.splice(0, utils_1.CLUES.length);
-    var _a = activityObjects.splice(0, 4), lastManStanding = _a[0], pvpArena = _a[1], soulWarsZeal = _a[2], riftsClosed = _a[3];
+    var _b = activityObjects.splice(0, 4), lastManStanding = _b[0], pvpArena = _b[1], soulWarsZeal = _b[2], riftsClosed = _b[3];
     var bossObjects = activityObjects.splice(0, utils_1.BOSSES.length);
     var skills = skillObjects.reduce(function (prev, curr, index) {
         var newSkills = __assign({}, prev);
@@ -246,6 +253,7 @@ function parseStats(csv) {
     var stats = {
         skills: skills,
         leaguePoints: leaguePoints,
+        deadmanPoints: deadmanPoints,
         bountyHunter: bountyHunter,
         lastManStanding: lastManStanding,
         pvpArena: pvpArena,
@@ -269,7 +277,7 @@ exports.parseStats = parseStats;
 function getStats(rsn, options) {
     var _a, _b, _c, _d;
     return __awaiter(this, void 0, void 0, function () {
-        var otherGamemodes, shouldGetFormattedRsn, mainRes, emptyResponse_1, getModeStats, formattedName, _e, player, ironRes, hcRes, ultRes;
+        var otherGamemodes, shouldGetFormattedRsn, main, getModeStats, formattedName, _e, player, iron, hc, ult;
         var _this = this;
         return __generator(this, function (_f) {
             switch (_f.label) {
@@ -281,23 +289,15 @@ 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*/, (0, utils_1.httpGet)((0, utils_1.getStatsURL)('main', rsn, true), (_c = options === null || options === void 0 ? void 0 : options.axiosConfigs) === null || _c === void 0 ? void 0 : _c.main)];
+                    return [4 /*yield*/, getOfficialStats(rsn, 'main', (_c = options === null || options === void 0 ? void 0 : options.axiosConfigs) === null || _c === void 0 ? void 0 : _c.main)];
                 case 1:
-                    mainRes = _f.sent();
-                    if (!(mainRes.status === 200)) return [3 /*break*/, 9];
-                    emptyResponse_1 = {
-                        status: 404,
-                        data: { skills: [], activities: [] },
-                        statusText: '',
-                        headers: {},
-                        config: {}
-                    };
+                    main = _f.sent();
                     getModeStats = function (mode) { return __awaiter(_this, void 0, void 0, function () {
                         var _a;
                         return __generator(this, function (_b) {
                             return [2 /*return*/, otherGamemodes.includes(mode)
-                                    ? (0, utils_1.httpGet)((0, utils_1.getStatsURL)(mode, rsn, true), (_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];
+                                    ? getOfficialStats(rsn, mode, (_a = options === null || options === void 0 ? void 0 : options.axiosConfigs) === null || _a === void 0 ? void 0 : _a[mode]).catch(function () { return undefined; })
+                                    : undefined];
                         });
                     }); };
                     if (!shouldGetFormattedRsn) return [3 /*break*/, 3];
@@ -317,21 +317,21 @@ function getStats(rsn, options) {
                         deulted: false,
                         deironed: false
                     };
-                    player.main = parseJsonStats(mainRes.data);
+                    player.main = parseJsonStats(main);
                     return [4 /*yield*/, getModeStats('ironman')];
                 case 5:
-                    ironRes = _f.sent();
-                    if (!(ironRes.status === 200)) return [3 /*break*/, 8];
-                    player.ironman = parseJsonStats(ironRes.data);
+                    iron = _f.sent();
+                    if (!iron) return [3 /*break*/, 8];
+                    player.ironman = parseJsonStats(iron);
                     return [4 /*yield*/, getModeStats('hardcore')];
                 case 6:
-                    hcRes = _f.sent();
+                    hc = _f.sent();
                     return [4 /*yield*/, getModeStats('ultimate')];
                 case 7:
-                    ultRes = _f.sent();
-                    if (hcRes.status === 200) {
+                    ult = _f.sent();
+                    if (hc) {
                         player.mode = 'hardcore';
-                        player.hardcore = parseJsonStats(hcRes.data);
+                        player.hardcore = parseJsonStats(hc);
                         if (player.ironman.skills.overall.xp !== player.hardcore.skills.overall.xp) {
                             player.dead = true;
                             player.mode = 'ironman';
@@ -341,9 +341,9 @@ function getStats(rsn, options) {
                             player.mode = 'main';
                         }
                     }
-                    else if (ultRes.status === 200) {
+                    else if (ult) {
                         player.mode = 'ultimate';
-                        player.ultimate = parseJsonStats(ultRes.data);
+                        player.ultimate = parseJsonStats(ult);
                         if (player.ironman.skills.overall.xp !== player.ultimate.skills.overall.xp) {
                             player.deulted = true;
                             player.mode = 'ironman';
@@ -362,7 +362,6 @@ function getStats(rsn, options) {
                     }
                     _f.label = 8;
                 case 8: return [2 /*return*/, player];
-                case 9: throw Error(utils_1.PLAYER_NOT_FOUND_ERROR);
             }
         });
     });

package/lib/types.d.ts

@@ -25,11 +25,18 @@ export type Boss = 'abyssalSire' | 'alchemicalHydra' | 'artio' | 'barrows' | 'br
 export type Bosses = {
     [Type in Boss]: Activity;
 };
-export type ActivityName = 'leaguePoints' | 'hunterBHV2' | 'rogueBHV2' | 'hunterBH' | 'rogueBH' | 'lastManStanding' | 'pvpArena' | 'soulWarsZeal' | 'riftsClosed' | 'allClues' | 'beginnerClues' | 'easyClues' | 'mediumClues' | 'hardClues' | 'eliteClues' | 'masterClues' | Boss;
+export type ActivityName = 'leaguePoints' | 'deadmanPoints' | 'hunterBHV2' | 'rogueBHV2' | 'hunterBH' | 'rogueBH' | 'lastManStanding' | 'pvpArena' | 'soulWarsZeal' | 'riftsClosed' | 'allClues' | 'beginnerClues' | 'easyClues' | 'mediumClues' | 'hardClues' | 'eliteClues' | 'masterClues' | Boss;
 export interface Stats {
     skills: Skills;
     clues: Clues;
+    /**
+     * Will only contain rank and score data for the `seasonal` gamemode.
+     */
     leaguePoints: Activity;
+    /**
+     * Will only contain rank and score data for the `tournament` gamemode.
+     */
+    deadmanPoints: Activity;
     bountyHunter: BH;
     lastManStanding: Activity;
     pvpArena: Activity;

package/lib/utils/constants.d.ts

@@ -33,6 +33,24 @@ export declare const FORMATTED_LMS = "LMS - Rank";
 export declare const FORMATTED_PVP_ARENA = "PvP Arena - Rank";
 export declare const FORMATTED_SOUL_WARS = "Soul Wars Zeal";
 export declare const FORMATTED_LEAGUE_POINTS = "League Points";
+export declare const FORMATTED_DEADMAN_POINTS = "Deadman Points";
 export declare const FORMATTED_RIFTS_CLOSED = "Rifts closed";
 export declare const INVALID_FORMAT_ERROR = "Invalid hiscores format";
 export declare const PLAYER_NOT_FOUND_ERROR = "Player not found";
+export declare const HISCORES_ERROR = "HiScores not responding";
+export declare class InvalidFormatError extends Error {
+    __proto__: ErrorConstructor;
+    constructor();
+}
+export declare class InvalidRSNError extends Error {
+    __proto__: ErrorConstructor;
+    constructor(message: string);
+}
+export declare class PlayerNotFoundError extends Error {
+    __proto__: ErrorConstructor;
+    constructor();
+}
+export declare class HiScoresError extends Error {
+    __proto__: ErrorConstructor;
+    constructor();
+}

package/lib/utils/constants.js

@@ -1,4 +1,19 @@
 "use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
 var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
         if (ar || !(i in from)) {
@@ -9,7 +24,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PLAYER_NOT_FOUND_ERROR = exports.INVALID_FORMAT_ERROR = exports.FORMATTED_RIFTS_CLOSED = exports.FORMATTED_LEAGUE_POINTS = exports.FORMATTED_SOUL_WARS = exports.FORMATTED_PVP_ARENA = exports.FORMATTED_LMS = exports.FORMATTED_BH_NAMES = exports.FORMATTED_CLUE_NAMES = exports.FORMATTED_SKILL_NAMES = exports.FORMATTED_BOSS_NAMES = exports.ACTIVITIES = exports.BOSSES = exports.GAMEMODES = exports.BH_MODES = exports.CLUES = exports.SKILLS = exports.GAMEMODE_URL = exports.SCORES_URL = exports.JSON_STATS_URL = exports.STATS_URL = exports.BASE_URL = void 0;
+exports.HiScoresError = exports.PlayerNotFoundError = exports.InvalidRSNError = exports.InvalidFormatError = exports.HISCORES_ERROR = exports.PLAYER_NOT_FOUND_ERROR = exports.INVALID_FORMAT_ERROR = exports.FORMATTED_RIFTS_CLOSED = exports.FORMATTED_DEADMAN_POINTS = exports.FORMATTED_LEAGUE_POINTS = exports.FORMATTED_SOUL_WARS = exports.FORMATTED_PVP_ARENA = exports.FORMATTED_LMS = exports.FORMATTED_BH_NAMES = exports.FORMATTED_CLUE_NAMES = exports.FORMATTED_SKILL_NAMES = exports.FORMATTED_BOSS_NAMES = exports.ACTIVITIES = exports.BOSSES = exports.GAMEMODES = exports.BH_MODES = exports.CLUES = exports.SKILLS = exports.GAMEMODE_URL = exports.SCORES_URL = exports.JSON_STATS_URL = exports.STATS_URL = exports.BASE_URL = void 0;
 exports.BASE_URL = 'https://secure.runescape.com/m=hiscore_oldschool';
 exports.STATS_URL = 'index_lite.ws?player=';
 exports.JSON_STATS_URL = 'index_lite.json?player=';
@@ -133,6 +148,7 @@ exports.BOSSES = [
 ];
 exports.ACTIVITIES = __spreadArray([
     'leaguePoints',
+    'deadmanPoints',
     'hunterBHV2',
     'rogueBHV2',
     'hunterBH',
@@ -254,6 +270,52 @@ exports.FORMATTED_LMS = 'LMS - Rank';
 exports.FORMATTED_PVP_ARENA = 'PvP Arena - Rank';
 exports.FORMATTED_SOUL_WARS = 'Soul Wars Zeal';
 exports.FORMATTED_LEAGUE_POINTS = 'League Points';
+exports.FORMATTED_DEADMAN_POINTS = 'Deadman Points';
 exports.FORMATTED_RIFTS_CLOSED = 'Rifts closed';
 exports.INVALID_FORMAT_ERROR = 'Invalid hiscores format';
 exports.PLAYER_NOT_FOUND_ERROR = 'Player not found';
+exports.HISCORES_ERROR = 'HiScores not responding';
+var InvalidFormatError = /** @class */ (function (_super) {
+    __extends(InvalidFormatError, _super);
+    function InvalidFormatError() {
+        var _this = _super.call(this, exports.INVALID_FORMAT_ERROR) || this;
+        _this.__proto__ = Error;
+        Object.setPrototypeOf(_this, InvalidFormatError.prototype);
+        return _this;
+    }
+    return InvalidFormatError;
+}(Error));
+exports.InvalidFormatError = InvalidFormatError;
+var InvalidRSNError = /** @class */ (function (_super) {
+    __extends(InvalidRSNError, _super);
+    function InvalidRSNError(message) {
+        var _this = _super.call(this, message) || this;
+        _this.__proto__ = Error;
+        Object.setPrototypeOf(_this, InvalidRSNError.prototype);
+        return _this;
+    }
+    return InvalidRSNError;
+}(Error));
+exports.InvalidRSNError = InvalidRSNError;
+var PlayerNotFoundError = /** @class */ (function (_super) {
+    __extends(PlayerNotFoundError, _super);
+    function PlayerNotFoundError() {
+        var _this = _super.call(this, exports.PLAYER_NOT_FOUND_ERROR) || this;
+        _this.__proto__ = Error;
+        Object.setPrototypeOf(_this, PlayerNotFoundError.prototype);
+        return _this;
+    }
+    return PlayerNotFoundError;
+}(Error));
+exports.PlayerNotFoundError = PlayerNotFoundError;
+var HiScoresError = /** @class */ (function (_super) {
+    __extends(HiScoresError, _super);
+    function HiScoresError() {
+        var _this = _super.call(this, exports.HISCORES_ERROR) || this;
+        _this.__proto__ = Error;
+        Object.setPrototypeOf(_this, HiScoresError.prototype);
+        return _this;
+    }
+    return HiScoresError;
+}(Error));
+exports.HiScoresError = HiScoresError;

package/lib/utils/helpers.js

@@ -109,13 +109,13 @@ exports.httpGet = httpGet;
  */
 var validateRSN = function (rsn) {
     if (typeof rsn !== 'string') {
-        throw Error('RSN must be a string');
+        throw new constants_1.InvalidRSNError('RSN must be a string');
     }
     else if (!/^[a-zA-Z0-9 _-]+$/.test(rsn)) {
-        throw Error('RSN contains invalid character');
+        throw new constants_1.InvalidRSNError('RSN contains invalid character');
     }
     else if (rsn.length > 12 || rsn.length < 1) {
-        throw Error('RSN must be between 1 and 12 characters');
+        throw new constants_1.InvalidRSNError('RSN must be between 1 and 12 characters');
     }
 };
 exports.validateRSN = validateRSN;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.16.1",
+  "version": "2.16.3",
   "description": "The Old School Runescape API wrapper that does more!",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -67,7 +67,10 @@
     ],
     "ignorePatterns": [
       "**/@types/*"
-    ]
+    ],
+    "rules": {
+      "max-classes-per-file": "off"
+    }
   },
   "prettier": {
     "trailingComma": "none",