osrs-json-hiscores 2.21.0 → 2.22.0

package/README.md

@@ -179,6 +179,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Vetion                            |            `vetion`            |
 | Vorkath                           |           `vorkath`            |
 | Wintertodt                        |          `wintertodt`          |
+| Yama                              |             `yama`             |
 | Zalcano                           |           `zalcano`            |
 | Zulrah                            |            `zulrah`            |
 

package/lib/hiscores.d.ts

@@ -16,7 +16,7 @@ export declare function getOfficialStats(rsn: string, mode?: Gamemode, config?:
  * @param config Optional axios request config object.
  * @returns Formatted version of the rsn.
  */
-export declare function getRSNFormat(rsn: string, config?: AxiosRequestConfig): Promise<string>;
+export declare function getRSNFormat(rsn: string, config?: AxiosRequestConfig, mode?: Gamemode): Promise<string>;
 /**
  * Parses official JSON object of raw stats and returns a stats object.
  *

package/lib/hiscores.js

@@ -96,14 +96,15 @@ exports.getOfficialStats = getOfficialStats;
  * @param config Optional axios request config object.
  * @returns Formatted version of the rsn.
  */
-function getRSNFormat(rsn, config) {
+function getRSNFormat(rsn, config, mode) {
+    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) {
                 case 0:
                     (0, utils_1.validateRSN)(rsn);
-                    url = (0, utils_1.getPlayerTableURL)('main', rsn);
+                    url = (0, utils_1.getPlayerTableURL)(mode, rsn);
                     _b.label = 1;
                 case 1:
                     _b.trys.push([1, 3, , 4]);
@@ -115,11 +116,11 @@ function getRSNFormat(rsn, config) {
                     if (anchor) {
                         return [2 /*return*/, (0, utils_1.rsnFromElement)(anchor)];
                     }
-                    throw new utils_1.PlayerNotFoundError();
+                    return [3 /*break*/, 4];
                 case 3:
                     _a = _b.sent();
                     throw new utils_1.HiScoresError();
-                case 4: return [2 /*return*/];
+                case 4: throw new utils_1.PlayerNotFoundError();
             }
         });
     });

package/lib/types.d.ts

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

package/lib/utils/constants.js

@@ -150,6 +150,7 @@ exports.BOSSES = [
     'vetion',
     'vorkath',
     'wintertodt',
+    'yama',
     'zalcano',
     'zulrah'
 ];
@@ -238,6 +239,7 @@ exports.FORMATTED_BOSS_NAMES = {
     vetion: "Vet'ion",
     vorkath: 'Vorkath',
     wintertodt: 'Wintertodt',
+    yama: 'Yama',
     zalcano: 'Zalcano',
     zulrah: 'Zulrah'
 };

package/package.json

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