v2.7.0

Add Nex.

.gitattributes

@@ -0,0 +1 @@
+*.html linguist-vendored

README.md

@@ -3,6 +3,7 @@
 [![npm](https://img.shields.io/npm/v/osrs-json-hiscores.svg?style=flat-square)](https://www.npmjs.com/package/osrs-json-hiscores)
 [![downloads](https://img.shields.io/npm/dm/osrs-json-hiscores.svg?style=flat-square)](https://npm-stat.com/charts.html?package=osrs-json-hiscores)
 [![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/workflow/status/maxswa/osrs-json-hiscores/CI?style=flat-square)](https://github.com/maxswa/osrs-json-hiscores/actions/workflows/main.yml?query=branch%3Amain)
 
 **The Old School Runescape API wrapper that does more!**
 
@@ -118,53 +119,56 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
 
 ### Bosses
 
-| Boss Name                        |             Param              |
+| Boss Name                         |             Param              |
-| -------------------------------- | :----------------------------: |
+| --------------------------------- | :----------------------------: |
-| Abyssal Sire                     |         `abyssalSire`          |
+| Abyssal Sire                      |         `abyssalSire`          |
-| Alchemical Hydra                 |       `alchemicalHydra`        |
+| Alchemical Hydra                  |       `alchemicalHydra`        |
-| Barrows Chests                   |           `barrows`            |
+| Barrows Chests                    |           `barrows`            |
-| Bryophyta                        |          `bryophyta`           |
+| Bryophyta                         |          `bryophyta`           |
-| Callisto                         |           `callisto`           |
+| Callisto                          |           `callisto`           |
-| Cerberus                         |           `cerberus`           |
+| Cerberus                          |           `cerberus`           |
-| Chambers Of Xeric                |       `chambersOfXeric`        |
+| Chambers Of Xeric                 |       `chambersOfXeric`        |
-| Chambers Of Xeric Challenge Mode | `chambersOfXericChallengeMode` |
+| Chambers Of Xeric: Challenge Mode | `chambersOfXericChallengeMode` |
-| Chaos Elemental                  |        `chaosElemental`        |
+| Chaos Elemental                   |        `chaosElemental`        |
-| Chaos Fanatic                    |         `chaosFanatic`         |
+| Chaos Fanatic                     |         `chaosFanatic`         |
-| Commander Zilyana                |       `commanderZilyana`       |
+| Commander Zilyana                 |       `commanderZilyana`       |
-| Corporeal Beast                  |        `corporealBeast`        |
+| Corporeal Beast                   |        `corporealBeast`        |
-| Crazy Archaeologist              |      `crazyArchaeologist`      |
+| Crazy Archaeologist               |      `crazyArchaeologist`      |
-| Dagannoth Prime                  |        `dagannothPrime`        |
+| Dagannoth Prime                   |        `dagannothPrime`        |
-| Dagannoth Rex                    |         `dagannothRex`         |
+| Dagannoth Rex                     |         `dagannothRex`         |
-| Dagannoth Supreme                |       `dagannothSupreme`       |
+| Dagannoth Supreme                 |       `dagannothSupreme`       |
-| Deranged Archaeologist           |    `derangedArchaeologist`     |
+| Deranged Archaeologist            |    `derangedArchaeologist`     |
-| General Graardor                 |       `generalGraardor`        |
+| General Graardor                  |       `generalGraardor`        |
-| Giant Mole                       |          `giantMole`           |
+| Giant Mole                        |          `giantMole`           |
-| Grotesque Guardians              |      `grotesqueGuardians`      |
+| Grotesque Guardians               |      `grotesqueGuardians`      |
-| Hespori                          |           `hespori`            |
+| Hespori                           |           `hespori`            |
-| Kalphite Queen                   |        `kalphiteQueen`         |
+| Kalphite Queen                    |        `kalphiteQueen`         |
-| King Black Dragon                |       `kingBlackDragon`        |
+| King Black Dragon                 |       `kingBlackDragon`        |
-| Kraken                           |            `kraken`            |
+| Kraken                            |            `kraken`            |
-| Kreearra                         |           `kreeArra`           |
+| Kreearra                          |           `kreeArra`           |
-| K'ril Tsutsaroth                 |        `krilTsutsaroth`        |
+| K'ril Tsutsaroth                  |        `krilTsutsaroth`        |
-| Mimic                            |            `mimic`             |
+| Mimic                             |            `mimic`             |
-| The Nightmare of Ashihama        |          `nightmare`           |
+| Nex                               |             `nex`              |
-| Obor                             |             `obor`             |
+| The Nightmare of Ashihama         |          `nightmare`           |
-| Sarachnis                        |          `sarachnis`           |
+| Phosani's Nightmare               |      `phosanisNightmare`       |
-| Scorpia                          |           `scorpia`            |
+| Obor                              |             `obor`             |
-| Skotizo                          |           `skotizo`            |
+| Sarachnis                         |          `sarachnis`           |
-| Tempoross                        |          `tempoross`           |
+| Scorpia                           |           `scorpia`            |
-| Gauntlet                         |           `gauntlet`           |
+| Skotizo                           |           `skotizo`            |
-| Corrupted Gauntlet               |      `corruptedGauntlet`       |
+| Tempoross                         |          `tempoross`           |
-| Theatre Of Blood                 |        `theatreOfBlood`        |
+| The Gauntlet                      |           `gauntlet`           |
-| Thermonuclear Smoke Devil        |   `thermonuclearSmokeDevil`    |
+| The Corrupted Gauntlet            |      `corruptedGauntlet`       |
-| TzKal-Zuk                        |           `tzKalZuk`           |
+| Theatre Of Blood                  |        `theatreOfBlood`        |
-| TzTok-Jad                        |           `tzTokJad`           |
+| Theatre Of Blood: Hard Mode       |    `theatreOfBloodHardMode`    |
-| Venenatis                        |          `venenatis`           |
+| Thermonuclear Smoke Devil         |   `thermonuclearSmokeDevil`    |
-| Vetion                           |            `vetion`            |
+| TzKal-Zuk                         |           `tzKalZuk`           |
-| Vorkath                          |           `vorkath`            |
+| TzTok-Jad                         |           `tzTokJad`           |
-| Wintertodt                       |          `wintertodt`          |
+| Venenatis                         |          `venenatis`           |
-| Zalcano                          |           `zalcano`            |
+| Vetion                            |            `vetion`            |
-| Zulrah                           |            `zulrah`            |
+| Vorkath                           |           `vorkath`            |
+| Wintertodt                        |          `wintertodt`          |
+| Zalcano                           |           `zalcano`            |
+| Zulrah                            |            `zulrah`            |
 
 ## What you'll get
 

__tests__/hiscores.test.ts

@@ -10,7 +10,9 @@ import {
   Stats,
   getPlayerTableURL,
   getSkillPageURL,
-  getStatsURL
+  getStatsURL,
+  BOSSES,
+  INVALID_FORMAT_ERROR
 } from '../src/index';
 
 const B0ATY_NAME = 'B0ATY';
@@ -113,7 +115,9 @@ test('Parse CSV to json', () => {
   625,2391
   120,2981
   1,109
+  99,39002
   3,22666
+  2,84
   26,323
   201,1101
   82,3404
@@ -122,6 +126,7 @@ test('Parse CSV to json', () => {
   63,375
   2870,6
   6984,138
+  23,923141
   4043,2000
   489,8
   967,47
@@ -203,7 +208,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 },
@@ -212,6 +219,7 @@ test('Parse CSV to json', () => {
       gauntlet: { rank: 63, score: 375 },
       corruptedGauntlet: { rank: 2870, score: 6 },
       theatreOfBlood: { rank: 6984, score: 138 },
+      theatreOfBloodHardMode: { rank: 23, score: 923141 },
       thermonuclearSmokeDevil: { rank: 4043, score: 2000 },
       tzKalZuk: { rank: 489, score: 8 },
       tzTokJad: { rank: 967, score: 47 },
@@ -227,6 +235,16 @@ 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);
@@ -439,7 +457,10 @@ test('Get non-existent player', async () => {
 });
 
 test('Get stats by gamemode', async () => {
-  const { skills } = 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 },
@@ -466,4 +487,9 @@ test('Get stats by gamemode', async () => {
     hunter: { rank: expect.any(Number), level: 99, xp: 200000000 },
     construction: { rank: expect.any(Number), level: 99, xp: 200000000 }
   });
+
+  const bossKeys = Object.keys(bosses);
+  expect(bossKeys).toStrictEqual(BOSSES);
+
+  expect.assertions(2);
 });

__tests__/lynxTitanStats.csv

@@ -15,7 +15,7 @@
 3,99,200000000
 25,99,200000000
 5,99,200000000
-24,99,200000000
+23,99,200000000
 12,99,200000000
 2,99,200000000
 19,99,200000000
@@ -29,7 +29,9 @@
 -1,-1
 -1,-1
 -1,-1
-344430,22
+347584,22
+-1,-1
+-1,-1
 -1,-1
 -1,-1
 -1,-1

package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.4.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,8 @@ import {
   rsnFromElement,
   getActivityPageURL,
   httpGet,
-  BOSSES
+  BOSSES,
+  INVALID_FORMAT_ERROR
 } from './utils';
 
 /**
@@ -74,6 +75,10 @@ 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 + 3) {
+    throw Error(INVALID_FORMAT_ERROR);
+  }
+
   const skillObjects: Skill[] = splitCSV
     .filter((stat) => stat.length === 3)
     .map((stat) => {

src/types.ts

@@ -89,7 +89,9 @@ export type Boss =
   | 'kreeArra'
   | 'krilTsutsaroth'
   | 'mimic'
+  | 'nex'
   | 'nightmare'
+  | 'phosanisNightmare'
   | 'obor'
   | 'sarachnis'
   | 'scorpia'
@@ -98,6 +100,7 @@ export type Boss =
   | 'gauntlet'
   | 'corruptedGauntlet'
   | 'theatreOfBlood'
+  | 'theatreOfBloodHardMode'
   | 'thermonuclearSmokeDevil'
   | 'tzKalZuk'
   | 'tzTokJad'

src/utils/constants.ts

@@ -97,7 +97,9 @@ export const BOSSES: Boss[] = [
   'kreeArra',
   'krilTsutsaroth',
   'mimic',
+  'nex',
   'nightmare',
+  'phosanisNightmare',
   'obor',
   'sarachnis',
   'scorpia',
@@ -106,6 +108,7 @@ export const BOSSES: Boss[] = [
   'gauntlet',
   'corruptedGauntlet',
   'theatreOfBlood',
+  'theatreOfBloodHardMode',
   'thermonuclearSmokeDevil',
   'tzKalZuk',
   'tzTokJad',
@@ -164,7 +167,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',
@@ -173,6 +178,7 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
   gauntlet: 'The Gauntlet',
   corruptedGauntlet: 'The Corrupted Gauntlet',
   theatreOfBlood: 'Theatre of Blood',
+  theatreOfBloodHardMode: 'Theatre of Blood: Hard Mode',
   thermonuclearSmokeDevil: 'Thermonuclear Smoke Devil',
   tzKalZuk: 'TzKal-Zuk',
   tzTokJad: 'TzTok-Jad',
@@ -241,3 +247,5 @@ 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 INVALID_FORMAT_ERROR = 'Invalid hiscores format';

tsconfig.json

@@ -4,7 +4,12 @@
     "module": "commonjs",
     "declaration": true,
     "outDir": "./lib",
-    "strict": true
+    "strict": true,
+    "lib": ["ES2015", "DOM", "DOM.Iterable"],
+    "typeRoots": [
+      "./node_modules/@types",
+      "./src/@types"
+    ]
   },
   "include": ["src"],
   "exclude": ["node_modules", "**/__tests__/*"]

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.4"
-  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.4.tgz#838fdf48a8bbdd79e52ee51fb1c94e3ed98b9379"
-  integrity sha512-SSG5xmZh1mkPGyKzjZP8zLjltIfpW32Y5QpdNJyjcfGxK3qo3NDDkZOZSFiGn1A6SclQxY9GzEwAHQ3dmYRWpg==
+  integrity sha512-zwGkiSXC1MUJG/qmeIFH2HBJx9u0V46QGUe3YR1fXG8bXQxq7fLj0RjLZQ5nubr9qNJUZrH+xUcwXEoXNpfS+g==
 
 for-in@^1.0.2:
   version "1.0.2"
@@ -2775,9 +2775,9 @@ has@^1.0.3:
     function-bind "^1.1.1"
 
 hosted-git-info@^2.1.4:
-  version "2.8.8"
+  version "2.8.9"
-  resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.8.8.tgz#7539bd4bc1e0e0a895815a2e0262420b12858488"
+  resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.8.9.tgz#dffc0bf9a21c02209090f2aa69429e1414daf3f9"
-  integrity sha512-f/wzC2QaWBs7t9IYqB4T3sR1xviIViXJRJTWBlx2Gf3g0Xi5vI7Yy4koXQ1c9OYDGHN9sBy1DQ2AB8fqZBWhUg==
+  integrity sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==
 
 hosted-git-info@^3.0.0:
   version "3.0.8"
@@ -4411,9 +4411,9 @@ normalize-path@^3.0.0:
   integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==
 
 normalize-url@^4.1.0:
-  version "4.5.0"
+  version "4.5.1"
-  resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-4.5.0.tgz#453354087e6ca96957bd8f5baf753f5982142129"
+  resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-4.5.1.tgz#0dd90cf1288ee1d1313b87081c9a5932ee48518a"
-  integrity sha512-2s47yzUxdexf1OhyRi4Em83iQk0aPvwTddtFz4hnSSw9dCEsLEGf6SwIO8ss/19S9iBb5sJaOuTvTGDeZI00BQ==
+  integrity sha512-9UZCFRHQdNrfTpGg8+1INIg93B6zE0aXMVFkw1WFwvO4SlZywU6aLg5Of0Ap/PgcbSw4LNxvMWXMeugwMCX0AA==
 
 normalize-version@^1.0.5:
   version "1.0.5"
@@ -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"
@@ -5968,9 +5968,9 @@ tr46@^2.0.2:
     punycode "^2.1.1"
 
 trim-newlines@^3.0.0:
-  version "3.0.0"
+  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/trim-newlines/-/trim-newlines-3.0.0.tgz#79726304a6a898aa8373427298d54c2ee8b1cb30"
+  resolved "https://registry.yarnpkg.com/trim-newlines/-/trim-newlines-3.0.1.tgz#260a5d962d8b752425b32f3a7db0dcacd176c144"
-  integrity sha512-C4+gOpvmxaSMKuEf9Qc134F1ZuOHVXKRbtEflf4NTtuuJDEIJ9p5PXsalL8SkeRw+qit1Mo+yuvMPAKwWg/1hA==
+  integrity sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw==
 
 ts-jest@^26.5.4:
   version "26.5.4"
@@ -6364,9 +6364,9 @@ write-file-atomic@^3.0.0:
     typedarray-to-buffer "^3.1.5"
 
 ws@^7.2.3:
-  version "7.4.2"
+  version "7.4.6"
-  resolved "https://registry.yarnpkg.com/ws/-/ws-7.4.2.tgz#782100048e54eb36fe9843363ab1c68672b261dd"
+  resolved "https://registry.yarnpkg.com/ws/-/ws-7.4.6.tgz#5654ca8ecdeee47c33a9a4bf6d28e2be2980377c"
-  integrity sha512-T4tewALS3+qsrpGI/8dqNMLIVdq/g/85U98HPMa6F0m6xTbvhXU6RCQLqPH3+SlomNV/LdY6RXEbBpMH6EOJnA==
+  integrity sha512-YmhHDO4MzaDLB+M9ym/mDA5z0naX8j7SIlT8f8z+I0VtzsRbekxEutHSme7NPS2qE8StCYQNUnfWdXta/Yu85A==
 
 xdg-basedir@^4.0.0:
   version "4.0.0"