osrs-json-hiscores 2.16.3 → 2.18.0

package/README.md

@@ -5,22 +5,24 @@
 [![types](https://img.shields.io/npm/types/osrs-json-hiscores.svg?style=flat-square)](https://github.com/maxswa/osrs-json-hiscores/blob/master/src/types.ts)
 [![build](https://img.shields.io/github/actions/workflow/status/maxswa/osrs-json-hiscores/main.yml?style=flat-square&branch=main)](https://github.com/maxswa/osrs-json-hiscores/actions/workflows/main.yml?query=branch%3Amain)
 
-**The Old School Runescape API wrapper that does more!**
+**The Old School RuneScape API wrapper that does more!**
 
 ## What it does
 
-The official hiscores API for Old School Runescape (OSRS) returns CSV.
-This wrapper converts it to json and provides extra information about the given player. By comparing player info it infers the player's game mode, as well as any previous modes (de-ultimated, de-ironed and/or died as a hardcore ironman).
+The official hiscores API for Old School RuneScape (OSRS) can return CSV or a simple JSON array.
+This wrapper converts the hiscores data into a more usable JSON object and provides extra information about the given player. By comparing player info it infers the player's game mode, as well as any previous modes (de-ultimated, de-ironed and/or died as a hardcore ironman).
 
-Additional functions are provided that screen-scrape the OSRS leaderboards and return a list of players as json.
+Additional functions are provided that screen-scrape the OSRS leaderboards and return a list of players as json. Also simple utility functions are provided to fetch the raw responses from Jagex's APIs, if desired.
 
 `osrs-json-hiscores` has TypeScript support, with full definitions for all functions and custom data types.
 
 ---
 
-### Disclaimer
+### ⚠ Disclaimer ⚠
 
-Jagex does not provide `Access-Control-Allow-Origin` headers in their responses. This means that [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) will block all browser requests to their hiscores API. In order to get around this, osrs-json-hiscores should be installed on the server side and exposed to the front end via a simple API. Here is an example of this in use: [codesandbox.io/s/osrs-json-hiscores-demo](https://codesandbox.io/s/osrs-json-hiscores-demo-qz656)
+Jagex does not provide `Access-Control-Allow-Origin` headers in their responses. This means that [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) will block all browser requests to their hiscores API. In order to get around this, osrs-json-hiscores needs to be installed on the server side and exposed to the front end via a simple API. Here is an example of this in use: [codesandbox.io/s/osrs-json-hiscores-demo](https://codesandbox.io/s/osrs-json-hiscores-demo-qz656)
+
+TLDR: You cannot use this library directly in your client side app e.g. React or Vue, you must set up a server which uses this lib internally and have your client fetch data from your server.
 
 ---
 
@@ -42,27 +44,14 @@ $ yarn add osrs-json-hiscores
 
 Install the package and then import it into your project:
 
-```javascript
-const hiscores = require('osrs-json-hiscores');
+```typescript
+import { getStatsByGamemode, getSkillPage } from 'osrs-json-hiscores';
 ```
 
 Once you import it you can call the functions asynchronously:
 
-```javascript
-hiscores
-  .getStats('Lynx Titan')
-  .then((res) => console.log(res))
-  .catch((err) => console.error(err));
-```
-
-If you are using TypeScript or transpiling your JS you can use ES6 syntax:
-
-```javascript
-import hiscores, { getSkillPage } from 'osrs-json-hiscores';
-
-// ...
-
-const stats = await hiscores.getStats('Lynx Titan');
+```typescript
+const stats = await getStatsByGamemode('Lynx Titan');
 const topPage = await getSkillPage('overall');
 ```
 
@@ -81,9 +70,8 @@ const topPage = await getSkillPage('overall');
 
 `getSkillPage` and `getActivityPage` require a skill / activity and optionally a gamemode and page:
 
-```javascript
-hiscores
-  .getSkillPage('attack', 'main', 1)
+```typescript
+getSkillPage('attack', 'main', 1)
   .then((res) => console.log(res))
   .catch((err) => console.error(err));
 ```
@@ -114,6 +102,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | PvP Arena - Rank                |    `pvpArena`     |
 | Soul Wars Zeal                  |  `soulWarsZeal`   |
 | Rifts closed                    |   `riftsClosed`   |
+| Colosseum Glory                 | `colosseumGlory`  |
 
 ### Points
 
@@ -155,6 +144,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Kraken                            |            `kraken`            |
 | Kreearra                          |           `kreeArra`           |
 | K'ril Tsutsaroth                  |        `krilTsutsaroth`        |
+| Lunar Chests                      |         `lunarChests`          |
 | Mimic                             |            `mimic`             |
 | Nex                               |             `nex`              |
 | Nightmare                         |          `nightmare`           |
@@ -163,7 +153,9 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Phantom Muspah                    |        `phantomMuspah`         |
 | Sarachnis                         |          `sarachnis`           |
 | Scorpia                           |           `scorpia`            |
+| Scurrius                          |           `scurrius`           |
 | Skotizo                           |           `skotizo`            |
+| Sol Heredit                       |          `solHeredit`          |
 | Spindel                           |           `spindel`            |
 | Tempoross                         |          `tempoross`           |
 | The Gauntlet                      |           `gauntlet`           |
@@ -189,7 +181,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 
 `getStats` returns a player object that looks like this:
 
-```javascript
+```typescript
 {
   name: 'Lynx Titan',
   mode: 'main',
@@ -217,7 +209,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 
 `getSkillPage` returns and array of 25 players (This represents a page on the hiscores):
 
-```javascript
+```typescript
 [
   { rank: 1, name: 'Lynx Titan', level: 2277, xp: 4600000000, dead: false },
   {},
@@ -230,7 +222,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 
 Get the properly formatted name of any skill, boss, clue or other activity:
 
-```javascript
+```typescript
 // kril === "K'ril Tsutsaroth"
 const kril = FORMATTED_BOSS_NAMES['krilTsutsaroth'];
 ```

package/lib/hiscores.js

@@ -175,6 +175,7 @@ function parseJsonStats(json) {
     var pvpArena = getActivity(utils_1.FORMATTED_PVP_ARENA);
     var soulWarsZeal = getActivity(utils_1.FORMATTED_SOUL_WARS);
     var riftsClosed = getActivity(utils_1.FORMATTED_RIFTS_CLOSED);
+    var colosseumGlory = getActivity(utils_1.FORMATTED_COLOSSEUM_GLORY);
     var stats = {
         skills: skills,
         leaguePoints: leaguePoints,
@@ -184,6 +185,7 @@ function parseJsonStats(json) {
         pvpArena: pvpArena,
         soulWarsZeal: soulWarsZeal,
         riftsClosed: riftsClosed,
+        colosseumGlory: colosseumGlory,
         clues: clues,
         bosses: bosses
     };
@@ -228,7 +230,7 @@ function parseStats(csv) {
     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 _b = activityObjects.splice(0, 4), lastManStanding = _b[0], pvpArena = _b[1], soulWarsZeal = _b[2], riftsClosed = _b[3];
+    var _b = activityObjects.splice(0, 5), lastManStanding = _b[0], pvpArena = _b[1], soulWarsZeal = _b[2], riftsClosed = _b[3], colosseumGlory = _b[4];
     var bossObjects = activityObjects.splice(0, utils_1.BOSSES.length);
     var skills = skillObjects.reduce(function (prev, curr, index) {
         var newSkills = __assign({}, prev);
@@ -259,6 +261,7 @@ function parseStats(csv) {
         pvpArena: pvpArena,
         soulWarsZeal: soulWarsZeal,
         riftsClosed: riftsClosed,
+        colosseumGlory: colosseumGlory,
         clues: clues,
         bosses: bosses
     };

package/lib/types.d.ts

@@ -21,11 +21,11 @@ export type BHType = 'rogue' | 'hunter' | 'rogueV2' | 'hunterV2';
 export type BH = {
     [Type in BHType]: Activity;
 };
-export type Boss = 'abyssalSire' | 'alchemicalHydra' | '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' | 'mimic' | 'nex' | 'nightmare' | 'phosanisNightmare' | 'obor' | 'phantomMuspah' | 'sarachnis' | 'scorpia' | 'skotizo' | 'spindel' | 'tempoross' | 'gauntlet' | 'corruptedGauntlet' | 'leviathan' | 'whisperer' | 'theatreOfBlood' | 'theatreOfBloodHardMode' | 'thermonuclearSmokeDevil' | 'tombsOfAmascut' | 'tombsOfAmascutExpertMode' | 'tzKalZuk' | 'tzTokJad' | 'vardorvis' | 'venenatis' | 'vetion' | 'vorkath' | 'wintertodt' | 'zalcano' | 'zulrah';
+export type Boss = 'abyssalSire' | 'alchemicalHydra' | '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' | 'leviathan' | 'whisperer' | 'theatreOfBlood' | 'theatreOfBloodHardMode' | 'thermonuclearSmokeDevil' | 'tombsOfAmascut' | 'tombsOfAmascutExpertMode' | 'tzKalZuk' | 'tzTokJad' | 'vardorvis' | 'venenatis' | 'vetion' | 'vorkath' | 'wintertodt' | 'zalcano' | 'zulrah';
 export type Bosses = {
     [Type in Boss]: Activity;
 };
-export type ActivityName = 'leaguePoints' | 'deadmanPoints' | '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' | 'colosseumGlory' | Boss;
 export interface Stats {
     skills: Skills;
     clues: Clues;
@@ -42,6 +42,7 @@ export interface Stats {
     pvpArena: Activity;
     soulWarsZeal: Activity;
     riftsClosed: Activity;
+    colosseumGlory: Activity;
     bosses: Bosses;
 }
 export type Modes = {

package/lib/utils/constants.d.ts

@@ -35,6 +35,7 @@ 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 FORMATTED_COLOSSEUM_GLORY = "Colosseum Glory";
 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";

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_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_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.BASE_URL = 'https://secure.runescape.com/m=hiscore_oldschool';
 exports.STATS_URL = 'index_lite.ws?player=';
 exports.JSON_STATS_URL = 'index_lite.json?player=';
@@ -116,6 +116,7 @@ exports.BOSSES = [
     'kraken',
     'kreeArra',
     'krilTsutsaroth',
+    'lunarChests',
     'mimic',
     'nex',
     'nightmare',
@@ -124,7 +125,9 @@ exports.BOSSES = [
     'phantomMuspah',
     'sarachnis',
     'scorpia',
+    'scurrius',
     'skotizo',
+    'solHeredit',
     'spindel',
     'tempoross',
     'gauntlet',
@@ -163,7 +166,8 @@ exports.ACTIVITIES = __spreadArray([
     'lastManStanding',
     'pvpArena',
     'soulWarsZeal',
-    'riftsClosed'
+    'riftsClosed',
+    'colosseumGlory'
 ], exports.BOSSES, true);
 exports.FORMATTED_BOSS_NAMES = {
     abyssalSire: 'Abyssal Sire',
@@ -195,6 +199,7 @@ exports.FORMATTED_BOSS_NAMES = {
     kraken: 'Kraken',
     kreeArra: "Kree'Arra",
     krilTsutsaroth: "K'ril Tsutsaroth",
+    lunarChests: 'Lunar Chests',
     mimic: 'Mimic',
     nex: 'Nex',
     nightmare: 'Nightmare',
@@ -203,7 +208,9 @@ exports.FORMATTED_BOSS_NAMES = {
     phantomMuspah: 'Phantom Muspah',
     sarachnis: 'Sarachnis',
     scorpia: 'Scorpia',
+    scurrius: 'Scurrius',
     skotizo: 'Skotizo',
+    solHeredit: 'Sol Heredit',
     spindel: 'Spindel',
     tempoross: 'Tempoross',
     gauntlet: 'The Gauntlet',
@@ -272,6 +279,7 @@ 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.FORMATTED_COLOSSEUM_GLORY = 'Colosseum Glory';
 exports.INVALID_FORMAT_ERROR = 'Invalid hiscores format';
 exports.PLAYER_NOT_FOUND_ERROR = 'Player not found';
 exports.HISCORES_ERROR = 'HiScores not responding';

package/package.json

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