osrs-json-hiscores 2.24.0 → 2.25.0

package/README.md

@@ -122,6 +122,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Araxxor                           |           `araxxor`            |
 | Artio                             |            `artio`             |
 | Barrows Chests                    |           `barrows`            |
+| Brutus                            |            `brutus`            |
 | Bryophyta                         |          `bryophyta`           |
 | Callisto                          |           `callisto`           |
 | Calvar'ion                        |          `calvarion`           |

package/lib/hiscores.js

@@ -97,28 +97,30 @@ exports.getOfficialStats = getOfficialStats;
  * @returns Formatted version of the rsn.
  */
 function getRSNFormat(rsn, config, mode) {
+    var _a, _b;
     if (mode === void 0) { mode = 'main'; }
     return __awaiter(this, void 0, void 0, function () {
-        var url, response, dom, anchor, _a;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
+        var url, response, dom, row, innerHTML, _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
                 case 0:
                     (0, utils_1.validateRSN)(rsn);
                     url = (0, utils_1.getPlayerTableURL)(mode, rsn);
-                    _b.label = 1;
+                    _d.label = 1;
                 case 1:
-                    _b.trys.push([1, 3, , 4]);
+                    _d.trys.push([1, 3, , 4]);
                     return [4 /*yield*/, (0, utils_1.httpGet)(url, config)];
                 case 2:
-                    response = _b.sent();
+                    response = _d.sent();
                     dom = new jsdom_1.JSDOM(response.data);
-                    anchor = dom.window.document.querySelector('.personal-hiscores__row.personal-hiscores__row--type-highlight a');
-                    if (anchor) {
-                        return [2 /*return*/, (0, utils_1.rsnFromElement)(anchor)];
+                    row = dom.window.document.querySelector('tr.personal-hiscores__row.personal-hiscores__row--type-highlight');
+                    if (row) {
+                        innerHTML = (row !== null && row !== void 0 ? row : {}).innerHTML;
+                        return [2 /*return*/, ((_b = (_a = innerHTML === null || innerHTML === void 0 ? void 0 : innerHTML.match(new RegExp(rsn.replace(utils_1.WHITESPACE_REGEX, utils_1.WHITESPACE_REGEX_STRING), 'gi'))) === null || _a === void 0 ? void 0 : _a[0]) !== null && _b !== void 0 ? _b : rsn)];
                     }
                     return [3 /*break*/, 4];
                 case 3:
-                    _a = _b.sent();
+                    _c = _d.sent();
                     throw new utils_1.HiScoresError();
                 case 4: throw new utils_1.PlayerNotFoundError();
             }
@@ -425,19 +427,18 @@ function getSkillPage(skill, mode, page, config) {
                 case 1:
                     response = _a.sent();
                     dom = new jsdom_1.JSDOM(response.data);
-                    playersHTML = dom.window.document.querySelectorAll('.personal-hiscores__row');
+                    playersHTML = dom.window.document.querySelectorAll('tr.personal-hiscores__row');
                     players = [];
                     playersHTML.forEach(function (row) {
-                        var rankEl = row.querySelector('td');
-                        var nameEl = row.querySelector('td a');
-                        var levelEl = row.querySelector('td.left + td');
-                        var xpEl = row.querySelector('td.left + td + td');
-                        var isDead = !!row.querySelector('td img');
+                        // Omit first cell (pre-sailing link)
+                        var _a = Array.from(row.cells), rankCell = _a[1], nameCell = _a[2], levelCell = _a[3], xpCell = _a[4];
+                        var isDead = !!nameCell.querySelector('img');
+                        var nameElement = nameCell.querySelector('a');
                         players.push({
-                            name: (0, utils_1.rsnFromElement)(nameEl),
-                            rank: (0, utils_1.numberFromElement)(rankEl),
-                            level: (0, utils_1.numberFromElement)(levelEl),
-                            xp: (0, utils_1.numberFromElement)(xpEl),
+                            name: (0, utils_1.rsnFromElement)(nameElement),
+                            rank: (0, utils_1.numberFromElement)(rankCell),
+                            level: (0, utils_1.numberFromElement)(levelCell),
+                            xp: (0, utils_1.numberFromElement)(xpCell),
                             dead: isDead
                         });
                     });
@@ -478,17 +479,16 @@ function getActivityPage(activity, mode, page, config) {
                 case 1:
                     response = _a.sent();
                     dom = new jsdom_1.JSDOM(response.data);
-                    playersHTML = dom.window.document.querySelectorAll('.personal-hiscores__row');
+                    playersHTML = dom.window.document.querySelectorAll('tr.personal-hiscores__row');
                     players = [];
                     playersHTML.forEach(function (row) {
-                        var rankEl = row.querySelector('td');
-                        var nameEl = row.querySelector('td a');
-                        var scoreEl = row.querySelector('td.left + td');
-                        var isDead = !!row.querySelector('td img');
+                        var _a = Array.from(row.cells), rankCell = _a[0], nameCell = _a[1], scoreCell = _a[2];
+                        var isDead = !!nameCell.querySelector('img');
+                        var nameElement = nameCell.querySelector('a');
                         players.push({
-                            name: (0, utils_1.rsnFromElement)(nameEl),
-                            rank: (0, utils_1.numberFromElement)(rankEl),
-                            score: (0, utils_1.numberFromElement)(scoreEl),
+                            name: (0, utils_1.rsnFromElement)(nameElement),
+                            rank: (0, utils_1.numberFromElement)(rankCell),
+                            score: (0, utils_1.numberFromElement)(scoreCell),
                             dead: isDead
                         });
                     });

package/lib/utils/constants.d.ts

@@ -2,6 +2,8 @@ export declare const BASE_URL = "https://secure.runescape.com/m=hiscore_oldschoo
 export declare const STATS_URL = "index_lite.ws?player=";
 export declare const JSON_STATS_URL = "index_lite.json?player=";
 export declare const SCORES_URL = "overall.ws?";
+export declare const WHITESPACE_REGEX_STRING = "( |-|_)";
+export declare const WHITESPACE_REGEX: RegExp;
 export type GamemodeUrl = {
     [key in Gamemode]: string;
 };
@@ -14,9 +16,9 @@ export declare const BH_MODES: readonly ["hunterV2", "rogueV2", "hunter", "rogue
 export type BHType = (typeof BH_MODES)[number];
 export declare const GAMEMODES: readonly ["main", "ironman", "hardcore", "ultimate", "deadman", "seasonal", "tournament", "skiller", "oneDefence", "freshStart"];
 export type Gamemode = (typeof GAMEMODES)[number];
-export declare const BOSSES: readonly ["abyssalSire", "alchemicalHydra", "amoxliatl", "araxxor", "artio", "barrows", "bryophyta", "callisto", "calvarion", "cerberus", "chambersOfXeric", "chambersOfXericChallengeMode", "chaosElemental", "chaosFanatic", "commanderZilyana", "corporealBeast", "crazyArchaeologist", "dagannothPrime", "dagannothRex", "dagannothSupreme", "derangedArchaeologist", "doomOfMokhaiotl", "dukeSucellus", "generalGraardor", "giantMole", "grotesqueGuardians", "hespori", "kalphiteQueen", "kingBlackDragon", "kraken", "kreeArra", "krilTsutsaroth", "lunarChests", "mimic", "nex", "nightmare", "phosanisNightmare", "obor", "phantomMuspah", "sarachnis", "scorpia", "scurrius", "shellbaneGryphon", "skotizo", "solHeredit", "spindel", "tempoross", "gauntlet", "corruptedGauntlet", "hueycoatl", "leviathan", "royalTitans", "whisperer", "theatreOfBlood", "theatreOfBloodHardMode", "thermonuclearSmokeDevil", "tombsOfAmascut", "tombsOfAmascutExpertMode", "tzKalZuk", "tzTokJad", "vardorvis", "venenatis", "vetion", "vorkath", "wintertodt", "yama", "zalcano", "zulrah"];
+export declare const BOSSES: readonly ["abyssalSire", "alchemicalHydra", "amoxliatl", "araxxor", "artio", "barrows", "brutus", "bryophyta", "callisto", "calvarion", "cerberus", "chambersOfXeric", "chambersOfXericChallengeMode", "chaosElemental", "chaosFanatic", "commanderZilyana", "corporealBeast", "crazyArchaeologist", "dagannothPrime", "dagannothRex", "dagannothSupreme", "derangedArchaeologist", "doomOfMokhaiotl", "dukeSucellus", "generalGraardor", "giantMole", "grotesqueGuardians", "hespori", "kalphiteQueen", "kingBlackDragon", "kraken", "kreeArra", "krilTsutsaroth", "lunarChests", "mimic", "nex", "nightmare", "phosanisNightmare", "obor", "phantomMuspah", "sarachnis", "scorpia", "scurrius", "shellbaneGryphon", "skotizo", "solHeredit", "spindel", "tempoross", "gauntlet", "corruptedGauntlet", "hueycoatl", "leviathan", "royalTitans", "whisperer", "theatreOfBlood", "theatreOfBloodHardMode", "thermonuclearSmokeDevil", "tombsOfAmascut", "tombsOfAmascutExpertMode", "tzKalZuk", "tzTokJad", "vardorvis", "venenatis", "vetion", "vorkath", "wintertodt", "yama", "zalcano", "zulrah"];
 export type Boss = (typeof BOSSES)[number];
-export declare const ACTIVITIES: readonly ["leaguePoints", "deadmanPoints", "hunterBHV2", "rogueBHV2", "hunterBH", "rogueBH", "allClues", "beginnerClues", "easyClues", "mediumClues", "hardClues", "eliteClues", "masterClues", "lastManStanding", "pvpArena", "soulWarsZeal", "riftsClosed", "colosseumGlory", "collectionsLogged", "abyssalSire", "alchemicalHydra", "amoxliatl", "araxxor", "artio", "barrows", "bryophyta", "callisto", "calvarion", "cerberus", "chambersOfXeric", "chambersOfXericChallengeMode", "chaosElemental", "chaosFanatic", "commanderZilyana", "corporealBeast", "crazyArchaeologist", "dagannothPrime", "dagannothRex", "dagannothSupreme", "derangedArchaeologist", "doomOfMokhaiotl", "dukeSucellus", "generalGraardor", "giantMole", "grotesqueGuardians", "hespori", "kalphiteQueen", "kingBlackDragon", "kraken", "kreeArra", "krilTsutsaroth", "lunarChests", "mimic", "nex", "nightmare", "phosanisNightmare", "obor", "phantomMuspah", "sarachnis", "scorpia", "scurrius", "shellbaneGryphon", "skotizo", "solHeredit", "spindel", "tempoross", "gauntlet", "corruptedGauntlet", "hueycoatl", "leviathan", "royalTitans", "whisperer", "theatreOfBlood", "theatreOfBloodHardMode", "thermonuclearSmokeDevil", "tombsOfAmascut", "tombsOfAmascutExpertMode", "tzKalZuk", "tzTokJad", "vardorvis", "venenatis", "vetion", "vorkath", "wintertodt", "yama", "zalcano", "zulrah"];
+export declare const ACTIVITIES: readonly ["leaguePoints", "deadmanPoints", "hunterBHV2", "rogueBHV2", "hunterBH", "rogueBH", "allClues", "beginnerClues", "easyClues", "mediumClues", "hardClues", "eliteClues", "masterClues", "lastManStanding", "pvpArena", "soulWarsZeal", "riftsClosed", "colosseumGlory", "collectionsLogged", "abyssalSire", "alchemicalHydra", "amoxliatl", "araxxor", "artio", "barrows", "brutus", "bryophyta", "callisto", "calvarion", "cerberus", "chambersOfXeric", "chambersOfXericChallengeMode", "chaosElemental", "chaosFanatic", "commanderZilyana", "corporealBeast", "crazyArchaeologist", "dagannothPrime", "dagannothRex", "dagannothSupreme", "derangedArchaeologist", "doomOfMokhaiotl", "dukeSucellus", "generalGraardor", "giantMole", "grotesqueGuardians", "hespori", "kalphiteQueen", "kingBlackDragon", "kraken", "kreeArra", "krilTsutsaroth", "lunarChests", "mimic", "nex", "nightmare", "phosanisNightmare", "obor", "phantomMuspah", "sarachnis", "scorpia", "scurrius", "shellbaneGryphon", "skotizo", "solHeredit", "spindel", "tempoross", "gauntlet", "corruptedGauntlet", "hueycoatl", "leviathan", "royalTitans", "whisperer", "theatreOfBlood", "theatreOfBloodHardMode", "thermonuclearSmokeDevil", "tombsOfAmascut", "tombsOfAmascutExpertMode", "tzKalZuk", "tzTokJad", "vardorvis", "venenatis", "vetion", "vorkath", "wintertodt", "yama", "zalcano", "zulrah"];
 export type ActivityName = (typeof ACTIVITIES)[number];
 export type FormattedBossNames = {
     [key in Boss]: string;

package/lib/utils/constants.js

@@ -24,11 +24,13 @@ 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_COLLECTIONS_LOGGED = exports.FORMATTED_COLOSSEUM_GLORY = 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.HiScoresError = exports.PlayerNotFoundError = exports.InvalidRSNError = exports.InvalidFormatError = exports.HISCORES_ERROR = exports.PLAYER_NOT_FOUND_ERROR = exports.INVALID_FORMAT_ERROR = exports.FORMATTED_COLLECTIONS_LOGGED = exports.FORMATTED_COLOSSEUM_GLORY = 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.WHITESPACE_REGEX = exports.WHITESPACE_REGEX_STRING = 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=';
 exports.SCORES_URL = 'overall.ws?';
+exports.WHITESPACE_REGEX_STRING = '( |-|_)';
+exports.WHITESPACE_REGEX = new RegExp(exports.WHITESPACE_REGEX_STRING, 'g');
 exports.GAMEMODE_URL = {
     main: "".concat(exports.BASE_URL, "/"),
     ironman: "".concat(exports.BASE_URL, "_ironman/"),
@@ -97,6 +99,7 @@ exports.BOSSES = [
     'araxxor',
     'artio',
     'barrows',
+    'brutus',
     'bryophyta',
     'callisto',
     'calvarion',
@@ -188,6 +191,7 @@ exports.FORMATTED_BOSS_NAMES = {
     araxxor: 'Araxxor',
     artio: 'Artio',
     barrows: 'Barrows Chests',
+    brutus: 'Brutus',
     bryophyta: 'Bryophyta',
     callisto: 'Callisto',
     calvarion: "Calvar'ion",

package/lib/utils/helpers.d.ts

@@ -48,7 +48,7 @@ export declare const numberFromElement: (el: Element | null) => number;
  * @param el OSRS hiscores table cell element.
  * @returns RSN parsed from cell text.
  */
-export declare const rsnFromElement: (el: Element | null) => string;
+export declare const rsnFromElement: (el: HTMLAnchorElement | null) => string;
 /**
  * Will run an Axios `GET` request against a given URL after injecting a `User-Agent` header.
  *

package/package.json

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