osrs-json-hiscores 2.16.2 → 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

@@ -170,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);
@@ -177,6 +178,7 @@ function parseJsonStats(json) {
     var stats = {
         skills: skills,
         leaguePoints: leaguePoints,
+        deadmanPoints: deadmanPoints,
         bountyHunter: bountyHunter,
         lastManStanding: lastManStanding,
         pvpArena: pvpArena,
@@ -199,8 +201,7 @@ 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) {
+    if (splitCSV.length !== utils_1.SKILLS.length + utils_1.ACTIVITIES.length) {
         throw new utils_1.InvalidFormatError();
     }
     var skillObjects = splitCSV
@@ -224,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);
@@ -252,6 +253,7 @@ function parseStats(csv) {
     var stats = {
         skills: skills,
         leaguePoints: leaguePoints,
+        deadmanPoints: deadmanPoints,
         bountyHunter: bountyHunter,
         lastManStanding: lastManStanding,
         pvpArena: pvpArena,
@@ -294,8 +296,7 @@ function getStats(rsn, options) {
                         var _a;
                         return __generator(this, function (_b) {
                             return [2 /*return*/, otherGamemodes.includes(mode)
-                                    ? 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; })
+                                    ? 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];
                         });
                     }); };

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,7 @@ 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";

package/lib/utils/constants.js

@@ -24,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.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_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=';
@@ -148,6 +148,7 @@ exports.BOSSES = [
 ];
 exports.ACTIVITIES = __spreadArray([
     'leaguePoints',
+    'deadmanPoints',
     'hunterBHV2',
     'rogueBHV2',
     'hunterBH',
@@ -269,6 +270,7 @@ 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';

package/package.json

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