Add Guardians of the Rift.

Bump follow-redirects from 1.14.7 to 1.14.8

README.md

@@ -110,6 +110,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Bounty Hunter (Hunter) |    `hunterBH`     |
 | Last Man Standing      | `lastManStanding` |
 | Soul Wars Zeal         |  `soulWarsZeal`   |
+| Rifts Closed           |   `riftsClosed`   |
 
 ### Leagues
 
@@ -148,7 +149,9 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 | Kreearra                          |           `kreeArra`           |
 | K'ril Tsutsaroth                  |        `krilTsutsaroth`        |
 | Mimic                             |            `mimic`             |
+| Nex                               |             `nex`              |
 | The Nightmare of Ashihama         |          `nightmare`           |
+| Phosani's Nightmare               |      `phosanisNightmare`       |
 | Obor                              |             `obor`             |
 | Sarachnis                         |          `sarachnis`           |
 | Scorpia                           |           `scorpia`            |
@@ -191,6 +194,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
     bountyHunter: {},
     lastManStanding: {},
     soulWarsZeal: {},
+    riftsClosed: {},
     bosses: {}
   }
 }

__tests__/hiscores.test.ts

@@ -11,7 +11,8 @@ import {
   getPlayerTableURL,
   getSkillPageURL,
   getStatsURL,
-  BOSSES
+  BOSSES,
+  INVALID_FORMAT_ERROR
 } from '../src/index';
 
 const B0ATY_NAME = 'B0ATY';
@@ -87,6 +88,7 @@ test('Parse CSV to json', () => {
   1,6143
   4814,898
   37,225
+  23,467
   382,2780
   944,3000
   1981,1452
@@ -114,7 +116,9 @@ test('Parse CSV to json', () => {
   625,2391
   120,2981
   1,109
+  99,39002
   3,22666
+  2,84
   26,323
   201,1101
   82,3404
@@ -168,6 +172,7 @@ test('Parse CSV to json', () => {
     },
     lastManStanding: { rank: 4814, score: 898 },
     soulWarsZeal: { rank: 37, score: 225 },
+    riftsClosed: { rank: 23, score: 467 },
     clues: {
       all: { rank: 32, score: 12148 },
       beginner: { rank: 3105, score: 76 },
@@ -205,7 +210,9 @@ test('Parse CSV to json', () => {
       kreeArra: { rank: 625, score: 2391 },
       krilTsutsaroth: { rank: 120, score: 2981 },
       mimic: { rank: 1, score: 109 },
+      nex: { rank: 99, score: 39002 },
       nightmare: { rank: 3, score: 22666 },
+      phosanisNightmare: { rank: 2, score: 84 },
       obor: { rank: 26, score: 323 },
       sarachnis: { rank: 201, score: 1101 },
       scorpia: { rank: 82, score: 3404 },
@@ -230,6 +237,18 @@ test('Parse CSV to json', () => {
   expect(parseStats(csv)).toStrictEqual(expectedOutput);
 });
 
+test('Parse CSV with unknown activity', () => {
+  const statsWithUnknownActivity = `${lynxTitanStats}
+    -1,-1`;
+  expect(() => parseStats(statsWithUnknownActivity)).toThrow(
+    INVALID_FORMAT_ERROR
+  );
+});
+
+test('Parse invalid CSV', () => {
+  expect(() => parseStats('invalid')).toThrow(INVALID_FORMAT_ERROR);
+});
+
 describe('Get name format', () => {
   it('gets a name with a space', async () => {
     const data = await getRSNFormat(LYNX_TITAN_SPACE_NAME);
@@ -442,8 +461,10 @@ test('Get non-existent player', async () => {
 });
 
 test('Get stats by gamemode', async () => {
-  const { skills, bosses } = await getStatsByGamemode(LYNX_TITAN_FORMATTED_NAME);
+  const { skills, bosses } = await getStatsByGamemode(
-  
+    LYNX_TITAN_FORMATTED_NAME
+  );
+
   expect(skills).toMatchObject({
     overall: { rank: expect.any(Number), level: 2277, xp: 4600000000 },
     attack: { rank: expect.any(Number), level: 99, xp: 200000000 },

__tests__/lynxTitanStats.csv

@@ -29,6 +29,7 @@
 -1,-1
 -1,-1
 -1,-1
+-1,-1
 347584,22
 -1,-1
 -1,-1
@@ -79,4 +80,6 @@
 -1,-1
 -1,-1
 -1,-1
+-1,-1
+-1,-1
 -1,-1

package.json

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

src/hiscores.ts

@@ -27,7 +27,9 @@ import {
   rsnFromElement,
   getActivityPageURL,
   httpGet,
-  BOSSES
+  BOSSES,
+  INVALID_FORMAT_ERROR,
+  EXTRA_ACTIVITY_COUNT
 } from './utils';
 
 /**
@@ -74,6 +76,17 @@ export function parseStats(csv: string): Stats {
     .filter((entry) => !!entry)
     .map((stat) => stat.split(','));
 
+  if (
+    splitCSV.length !==
+    SKILLS.length +
+      BH_MODES.length +
+      CLUES.length +
+      BOSSES.length +
+      EXTRA_ACTIVITY_COUNT
+  ) {
+    throw Error(INVALID_FORMAT_ERROR);
+  }
+
   const skillObjects: Skill[] = splitCSV
     .filter((stat) => stat.length === 3)
     .map((stat) => {
@@ -100,7 +113,10 @@ export function parseStats(csv: string): Stats {
   const [leaguePoints] = activityObjects.splice(0, 1);
   const bhObjects = activityObjects.splice(0, BH_MODES.length);
   const clueObjects = activityObjects.splice(0, CLUES.length);
-  const [lastManStanding, soulWarsZeal] = activityObjects.splice(0, 2);
+  const [lastManStanding, soulWarsZeal, riftsClosed] = activityObjects.splice(
+    0,
+    3
+  );
   const bossObjects = activityObjects.splice(0, BOSSES.length);
 
   const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
@@ -133,6 +149,7 @@ export function parseStats(csv: string): Stats {
     bountyHunter,
     lastManStanding,
     soulWarsZeal,
+    riftsClosed,
     clues,
     bosses
   };

src/types.ts

@@ -89,7 +89,9 @@ export type Boss =
   | 'kreeArra'
   | 'krilTsutsaroth'
   | 'mimic'
+  | 'nex'
   | 'nightmare'
+  | 'phosanisNightmare'
   | 'obor'
   | 'sarachnis'
   | 'scorpia'
@@ -117,6 +119,7 @@ export type ActivityName =
   | 'rogueBH'
   | 'lastManStanding'
   | 'soulWarsZeal'
+  | 'riftsClosed'
   | 'allClues'
   | 'beginnerClues'
   | 'easyClues'
@@ -133,6 +136,7 @@ export interface Stats {
   bountyHunter: BH;
   lastManStanding: Activity;
   soulWarsZeal: Activity;
+  riftsClosed: Activity;
   bosses: Bosses;
 }
 export type Modes = { [M in Gamemode]?: Stats };

src/utils/constants.ts

@@ -97,7 +97,9 @@ export const BOSSES: Boss[] = [
   'kreeArra',
   'krilTsutsaroth',
   'mimic',
+  'nex',
   'nightmare',
+  'phosanisNightmare',
   'obor',
   'sarachnis',
   'scorpia',
@@ -130,6 +132,7 @@ export const ACTIVITIES: ActivityName[] = [
   'masterClues',
   'lastManStanding',
   'soulWarsZeal',
+  'riftsClosed',
   ...BOSSES
 ];
 
@@ -165,7 +168,9 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
   kreeArra: "Kree'Arra",
   krilTsutsaroth: "K'ril Tsutsaroth",
   mimic: 'Mimic',
+  nex: 'Nex',
   nightmare: 'The Nightmare of Ashihama',
+  phosanisNightmare: "Phosani's Nightmare",
   obor: 'Obor',
   sarachnis: 'Sarachnis',
   scorpia: 'Scorpia',
@@ -243,3 +248,11 @@ export const FORMATTED_BH_NAMES: FormattedBHNames = {
 export const FORMATTED_LMS = 'Last Man Standing';
 export const FORMATTED_SOUL_WARS = 'Soul Wars Zeal';
 export const FORMATTED_LEAGUE_POINTS = 'League Points';
+export const FORMATTED_RIFTS_CLOSED = 'Rifts Closed';
+
+/**
+ * Count of activities not including bosses, bounty hunter, or clues.
+ */
+export const EXTRA_ACTIVITY_COUNT = 4;
+
+export const INVALID_FORMAT_ERROR = 'Invalid hiscores format';

yarn.lock

@@ -1108,11 +1108,11 @@ axe-core@^4.0.2:
   integrity sha512-vwPpH4Aj4122EW38mxO/fxhGKtwWTMLDIJfZ1He0Edbtjcfna/R3YB67yVhezUMzqc3Jr3+Ii50KRntlENL4xQ==
 
 axios@^0.21.1:
-  version "0.21.1"
+  version "0.21.2"
-  resolved "https://registry.yarnpkg.com/axios/-/axios-0.21.1.tgz#22563481962f4d6bde9a76d516ef0e5d3c09b2b8"
+  resolved "https://registry.yarnpkg.com/axios/-/axios-0.21.2.tgz#21297d5084b2aeeb422f5d38e7be4fbb82239017"
-  integrity sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==
+  integrity sha512-87otirqUw3e8CzHTMO+/9kh/FSgXt/eVDvipijwDtEuwbkySWZ9SBm6VEubmJ/kLKEoLQV/POhxXFb66bfekfg==
   dependencies:
-    follow-redirects "^1.10.0"
+    follow-redirects "^1.14.0"
 
 axobject-query@^2.2.0:
   version "2.2.0"
@@ -2459,10 +2459,10 @@ flatted@^3.1.0:
   resolved "https://registry.yarnpkg.com/flatted/-/flatted-3.1.1.tgz#c4b489e80096d9df1dfc97c79871aea7c617c469"
   integrity sha512-zAoAQiudy+r5SvnSw3KJy5os/oRJYHzrzja/tBDqrZtNhUw8bt6y8OBzMWcjWr+8liV8Eb6yOhw8WZ7VFZ5ZzA==
 
-follow-redirects@^1.10.0:
+follow-redirects@^1.14.0:
-  version "1.13.1"
+  version "1.14.8"
-  resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.13.1.tgz#5f69b813376cee4fd0474a3aba835df04ab763b7"
+  resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.8.tgz#016996fb9a11a100566398b1c6839337d7bfa8fc"
-  integrity sha512-SSG5xmZh1mkPGyKzjZP8zLjltIfpW32Y5QpdNJyjcfGxK3qo3NDDkZOZSFiGn1A6SclQxY9GzEwAHQ3dmYRWpg==
+  integrity sha512-1x0S9UVJHsQprFcEC/qnNzBLcIxsjAV905f/UkQxbclCsoTWlacCNOpQa/anodLl2uaEKFhfWOvM2Qg77+15zA==
 
 for-in@^1.0.2:
   version "1.0.2"
@@ -4837,9 +4837,9 @@ path-key@^3.0.0, path-key@^3.1.0:
   integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==
 
 path-parse@^1.0.6:
-  version "1.0.6"
+  version "1.0.7"
-  resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.6.tgz#d62dbb5679405d72c4737ec58600e9ddcf06d24c"
+  resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735"
-  integrity sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==
+  integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==
 
 path-type@^2.0.0:
   version "2.0.0"
@@ -5892,9 +5892,9 @@ tmp@^0.0.33:
     os-tmpdir "~1.0.2"
 
 tmpl@1.0.x:
-  version "1.0.4"
+  version "1.0.5"
-  resolved "https://registry.yarnpkg.com/tmpl/-/tmpl-1.0.4.tgz#23640dd7b42d00433911140820e5cf440e521dd1"
+  resolved "https://registry.yarnpkg.com/tmpl/-/tmpl-1.0.5.tgz#8683e0b902bb9c20c4f726e3c0b69f36518c07cc"
-  integrity sha1-I2QN17QtAEM5ERQIIOXPRA5SHdE=
+  integrity sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw==
 
 to-fast-properties@^2.0.0:
   version "2.0.0"