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
 
@@ -193,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
@@ -170,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 },
@@ -234,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);

__tests__/lynxTitanStats.csv

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.6.0",
+  "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

@@ -119,6 +119,7 @@ export type ActivityName =
   | 'rogueBH'
   | 'lastManStanding'
   | 'soulWarsZeal'
+  | 'riftsClosed'
   | 'allClues'
   | 'beginnerClues'
   | 'easyClues'
@@ -135,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

@@ -132,6 +132,7 @@ export const ACTIVITIES: ActivityName[] = [
   'masterClues',
   'lastManStanding',
   'soulWarsZeal',
+  'riftsClosed',
   ...BOSSES
 ];
 
@@ -247,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

@@ -2460,9 +2460,9 @@ flatted@^3.1.0:
   integrity sha512-zAoAQiudy+r5SvnSw3KJy5os/oRJYHzrzja/tBDqrZtNhUw8bt6y8OBzMWcjWr+8liV8Eb6yOhw8WZ7VFZ5ZzA==
 
 follow-redirects@^1.14.0:
-  version "1.14.4"
+  version "1.14.8"
-  resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.4.tgz#838fdf48a8bbdd79e52ee51fb1c94e3ed98b9379"
+  resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.8.tgz#016996fb9a11a100566398b1c6839337d7bfa8fc"
-  integrity sha512-zwGkiSXC1MUJG/qmeIFH2HBJx9u0V46QGUe3YR1fXG8bXQxq7fLj0RjLZQ5nubr9qNJUZrH+xUcwXEoXNpfS+g==
+  integrity sha512-1x0S9UVJHsQprFcEC/qnNzBLcIxsjAV905f/UkQxbclCsoTWlacCNOpQa/anodLl2uaEKFhfWOvM2Qg77+15zA==
 
 for-in@^1.0.2:
   version "1.0.2"