v2.5.1

Merge pull request #35 from Not-Jayden/fix-seasonal-bosses-results
[Bug fix] Add conditional bosses filter if gamemode is seasonal
2025-10-15 10:19:04 +00:00 · 2021-06-08 17:10:31 -04:00 · 2021-06-08 17:08:44 -04:00 · 2021-06-08 16:36:36 +08:00 · 2021-06-08 16:29:43 +08:00 · 2021-06-08 16:16:00 +08:00
11 changed files with 187 additions and 60 deletions
--- a/.gitattributes
+++ b/.gitattributes
@@ -0,0 +1 @@
+*.html linguist-vendored
--- a/README.md
+++ b/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,54 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses

 ### Bosses

-| Boss Name                        |             Param              |
-| -------------------------------- | :----------------------------: |
-| Abyssal Sire                     |         `abyssalSire`          |
-| Alchemical Hydra                 |       `alchemicalHydra`        |
-| Barrows Chests                   |           `barrows`            |
-| Bryophyta                        |          `bryophyta`           |
-| Callisto                         |           `callisto`           |
-| Cerberus                         |           `cerberus`           |
-| Chambers Of Xeric                |       `chambersOfXeric`        |
-| Chambers Of Xeric Challenge Mode | `chambersOfXericChallengeMode` |
-| Chaos Elemental                  |        `chaosElemental`        |
-| Chaos Fanatic                    |         `chaosFanatic`         |
-| Commander Zilyana                |       `commanderZilyana`       |
-| Corporeal Beast                  |        `corporealBeast`        |
-| Crazy Archaeologist              |      `crazyArchaeologist`      |
-| Dagannoth Prime                  |        `dagannothPrime`        |
-| Dagannoth Rex                    |         `dagannothRex`         |
-| Dagannoth Supreme                |       `dagannothSupreme`       |
-| Deranged Archaeologist           |    `derangedArchaeologist`     |
-| General Graardor                 |       `generalGraardor`        |
-| Giant Mole                       |          `giantMole`           |
-| Grotesque Guardians              |      `grotesqueGuardians`      |
-| Hespori                          |           `hespori`            |
-| Kalphite Queen                   |        `kalphiteQueen`         |
-| King Black Dragon                |       `kingBlackDragon`        |
-| Kraken                           |            `kraken`            |
-| Kreearra                         |           `kreeArra`           |
-| K'ril Tsutsaroth                 |        `krilTsutsaroth`        |
-| Mimic                            |            `mimic`             |
-| The Nightmare of Ashihama        |          `nightmare`           |
-| Obor                             |             `obor`             |
-| Sarachnis                        |          `sarachnis`           |
-| Scorpia                          |           `scorpia`            |
-| Skotizo                          |           `skotizo`            |
-| Tempoross                        |          `tempoross`           |
-| Gauntlet                         |           `gauntlet`           |
-| Corrupted Gauntlet               |      `corruptedGauntlet`       |
-| Theatre Of Blood                 |        `theatreOfBlood`        |
-| Thermonuclear Smoke Devil        |   `thermonuclearSmokeDevil`    |
-| TzKal-Zuk                        |           `tzKalZuk`           |
-| TzTok-Jad                        |           `tzTokJad`           |
-| Venenatis                        |          `venenatis`           |
-| Vetion                           |            `vetion`            |
-| Vorkath                          |           `vorkath`            |
-| Wintertodt                       |          `wintertodt`          |
-| Zalcano                          |           `zalcano`            |
-| Zulrah                           |            `zulrah`            |
+| Boss Name                         |             Param              |
+| --------------------------------- | :----------------------------: |
+| Abyssal Sire                      |         `abyssalSire`          |
+| Alchemical Hydra                  |       `alchemicalHydra`        |
+| Barrows Chests                    |           `barrows`            |
+| Bryophyta                         |          `bryophyta`           |
+| Callisto                          |           `callisto`           |
+| Cerberus                          |           `cerberus`           |
+| Chambers Of Xeric                 |       `chambersOfXeric`        |
+| Chambers Of Xeric: Challenge Mode | `chambersOfXericChallengeMode` |
+| Chaos Elemental                   |        `chaosElemental`        |
+| Chaos Fanatic                     |         `chaosFanatic`         |
+| Commander Zilyana                 |       `commanderZilyana`       |
+| Corporeal Beast                   |        `corporealBeast`        |
+| Crazy Archaeologist               |      `crazyArchaeologist`      |
+| Dagannoth Prime                   |        `dagannothPrime`        |
+| Dagannoth Rex                     |         `dagannothRex`         |
+| Dagannoth Supreme                 |       `dagannothSupreme`       |
+| Deranged Archaeologist            |    `derangedArchaeologist`     |
+| General Graardor                  |       `generalGraardor`        |
+| Giant Mole                        |          `giantMole`           |
+| Grotesque Guardians               |      `grotesqueGuardians`      |
+| Hespori                           |           `hespori`            |
+| Kalphite Queen                    |        `kalphiteQueen`         |
+| King Black Dragon                 |       `kingBlackDragon`        |
+| Kraken                            |            `kraken`            |
+| Kreearra                          |           `kreeArra`           |
+| K'ril Tsutsaroth                  |        `krilTsutsaroth`        |
+| Mimic                             |            `mimic`             |
+| The Nightmare of Ashihama         |          `nightmare`           |
+| Obor                              |             `obor`             |
+| Sarachnis                         |          `sarachnis`           |
+| Scorpia                           |           `scorpia`            |
+| Skotizo                           |           `skotizo`            |
+| Tempoross                         |          `tempoross`           |
+| The Gauntlet                      |           `gauntlet`           |
+| The Corrupted Gauntlet            |      `corruptedGauntlet`       |
+| Theatre Of Blood                  |        `theatreOfBlood`        |
+| Theatre Of Blood: Hard Mode       |    `theatreOfBloodHardMode`    |
+| Thermonuclear Smoke Devil         |   `thermonuclearSmokeDevil`    |
+| TzKal-Zuk                         |           `tzKalZuk`           |
+| TzTok-Jad                         |           `tzTokJad`           |
+| Venenatis                         |          `venenatis`           |
+| Vetion                            |            `vetion`            |
+| Vorkath                           |           `vorkath`            |
+| Wintertodt                        |          `wintertodt`          |
+| Zalcano                           |           `zalcano`            |
+| Zulrah                            |            `zulrah`            |

 ## What you'll get

--- a/tests/fysadStatsSeasonal.csv
+++ b/tests/fysadStatsSeasonal.csv
@@ -0,0 +1,82 @@
+1,2277,4600000000
+15,99,200000000
+28,99,200000000
+18,99,200000000
+7,99,200000000
+8,99,200000000
+11,99,200000000
+32,99,200000000
+159,99,200000000
+15,99,200000000
+12,99,200000000
+9,99,200000000
+48,99,200000000
+4,99,200000000
+3,99,200000000
+25,99,200000000
+5,99,200000000
+23,99,200000000
+12,99,200000000
+2,99,200000000
+19,99,200000000
+7,99,200000000
+4,99,200000000
+4,99,200000000
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+347584,22
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
+-1,-1
--- a/tests/hiscores.test.ts
+++ b/tests/hiscores.test.ts
@@ -10,7 +10,9 @@ import {
  Stats,
  getPlayerTableURL,
  getSkillPageURL,
-  getStatsURL
+  getStatsURL,
+  BOSSES,
+  Boss
 } from '../src/index';

 const B0ATY_NAME = 'B0ATY';
@@ -19,6 +21,7 @@ const LYNX_TITAN_SPACE_NAME = 'lYnX tiTaN';
 const LYNX_TITAN_UNDERSCORE_NAME = 'lYnX_tiTaN';
 const LYNX_TITAN_HYPHEN_NAME = 'lYnX-tiTaN';
 const LYNX_TITAN_FORMATTED_NAME = 'Lynx Titan';
+const FYSAD_FORMATTED_NAME = 'Fysad';

 const attackTopPage = readFileSync(`${__dirname}/attackTopPage.html`, 'utf8');
 const b0atyNamePage = readFileSync(`${__dirname}/b0atyNamePage.html`, 'utf8');
@@ -27,6 +30,7 @@ const lynxTitanNamePage = readFileSync(
  `${__dirname}/lynxTitanNamePage.html`,
  'utf8'
 );
+const fysadStatsSeasonal = readFileSync(`${__dirname}/fysadStatsSeasonal.csv`, 'utf8');

 jest.spyOn(axios, 'get').mockImplementation((url) => {
  const lynxUrls = [
@@ -46,6 +50,9 @@ jest.spyOn(axios, 'get').mockImplementation((url) => {
  if (getStatsURL('main', LYNX_TITAN_FORMATTED_NAME) === url) {
    return Promise.resolve({ status: 200, data: lynxTitanStats });
  }
+  if (getStatsURL('seasonal', FYSAD_FORMATTED_NAME) === url) {
+    return Promise.resolve({ status: 200, data: fysadStatsSeasonal });
+  }
  throw new Error(`No mock response for URL: ${url}`);
 });

@@ -122,6 +129,7 @@ test('Parse CSV to json', () => {
  63,375
  2870,6
  6984,138
+  23,923141
  4043,2000
  489,8
  967,47
@@ -212,6 +220,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 },
@@ -439,7 +448,8 @@ 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 +476,21 @@ 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);
+});
+
+test('Get stats by game mode seasonal (omit TOB: Hard Mode from bosses)', async () => {
+  const {bosses} = await getStatsByGamemode(FYSAD_FORMATTED_NAME, 'seasonal');
+  const bossKeys = Object.keys(bosses);
+
+  const filteredBosses = BOSSES.filter(boss => boss !== 'theatreOfBloodHardMode');
+
+  expect(bossKeys).toStrictEqual(filteredBosses);
+  expect(bossKeys).not.toContain<Boss>('theatreOfBloodHardMode');
+
+  expect.assertions(2);
 });
--- a/tests/lynxTitanStats.csv
+++ b/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,8 @@
 -1,-1
 -1,-1
 -1,-1
-344430,22
+347584,22
+-1,-1
 -1,-1
 -1,-1
 -1,-1
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "osrs-json-hiscores",
-  "version": "2.4.2",
+  "version": "2.5.1",
  "description": "The Old School Runescape API wrapper that does more!",
  "main": "lib/index.js",
  "types": "lib/index.d.ts",
--- a/src/hiscores.ts
+++ b/src/hiscores.ts
@@ -68,7 +68,7 @@ export async function getRSNFormat(rsn: string): Promise<string> {
 * @param csv Raw CSV from the official OSRS API.
 * @returns Parsed stats object.
 */
-export function parseStats(csv: string): Stats {
+export function parseStats(csv: string, mode: Gamemode = 'main'): Stats {
  const splitCSV = csv
    .split('\n')
    .filter((entry) => !!entry)
@@ -97,11 +97,17 @@ export function parseStats(csv: string): Stats {
      return activity;
    });

+  /** `seasonal` API results don't currently include TOB: Hard Mode, so it needs to be filtered out in that case. */
+  const filteredBosses =
+    mode === 'seasonal'
+      ? BOSSES.filter((boss) => boss !== 'theatreOfBloodHardMode')
+      : BOSSES;
+
  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 bossObjects = activityObjects.splice(0, BOSSES.length);
+  const bossObjects = activityObjects.splice(0, filteredBosses.length);

  const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
    const newSkills = { ...prev };
@@ -123,7 +129,7 @@ export function parseStats(csv: string): Stats {

  const bosses: Bosses = bossObjects.reduce<Bosses>((prev, curr, index) => {
    const newBosses = { ...prev };
-    newBosses[BOSSES[index]] = curr;
+    newBosses[filteredBosses[index]] = curr;
    return newBosses;
  }, {} as Bosses);

@@ -250,7 +256,7 @@ export async function getStatsByGamemode(
  if (response.status !== 200) {
    throw Error('Player not found');
  }
-  const stats = parseStats(response.data);
+  const stats = parseStats(response.data, mode);

  return stats;
 }
--- a/src/types.ts
+++ b/src/types.ts
@@ -98,6 +98,7 @@ export type Boss =
  | 'gauntlet'
  | 'corruptedGauntlet'
  | 'theatreOfBlood'
+  | 'theatreOfBloodHardMode'
  | 'thermonuclearSmokeDevil'
  | 'tzKalZuk'
  | 'tzTokJad'
--- a/src/utils/constants.ts
+++ b/src/utils/constants.ts
@@ -106,6 +106,7 @@ export const BOSSES: Boss[] = [
  'gauntlet',
  'corruptedGauntlet',
  'theatreOfBlood',
+  'theatreOfBloodHardMode',
  'thermonuclearSmokeDevil',
  'tzKalZuk',
  'tzTokJad',
@@ -173,6 +174,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',
--- a/tsconfig.json
+++ b/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__/*"]
--- a/yarn.lock
+++ b/yarn.lock
@@ -6364,9 +6364,9 @@ write-file-atomic@^3.0.0:
    typedarray-to-buffer "^3.1.5"

 ws@^7.2.3:
-  version "7.4.2"
-  resolved "https://registry.yarnpkg.com/ws/-/ws-7.4.2.tgz#782100048e54eb36fe9843363ab1c68672b261dd"
-  integrity sha512-T4tewALS3+qsrpGI/8dqNMLIVdq/g/85U98HPMa6F0m6xTbvhXU6RCQLqPH3+SlomNV/LdY6RXEbBpMH6EOJnA==
+  version "7.4.6"
+  resolved "https://registry.yarnpkg.com/ws/-/ws-7.4.6.tgz#5654ca8ecdeee47c33a9a4bf6d28e2be2980377c"
+  integrity sha512-YmhHDO4MzaDLB+M9ym/mDA5z0naX8j7SIlT8f8z+I0VtzsRbekxEutHSme7NPS2qE8StCYQNUnfWdXta/Yu85A==

 xdg-basedir@^4.0.0:
  version "4.0.0"
Author	SHA1	Message	Date
maxswa	5c52bfd883	v2.5.1	2021-06-08 17:10:31 -04:00
Max Swartwout	947d994cdf	Merge pull request #35 from Not-Jayden/fix-seasonal-bosses-results [Bug fix] Add conditional bosses filter if gamemode is seasonal	2021-06-08 17:08:44 -04:00
NotJayden	130446ab74	use boss generic	2021-06-08 16:36:36 +08:00
NotJayden	f96e7e3e2d	check bossKeys strict equals the BOSSES array, and check seasonal bossKeys doesn't include tob hard mode	2021-06-08 16:29:43 +08:00
NotJayden	90d66b6b2c	prettier	2021-06-08 16:16:00 +08:00
NotJayden	14cedb5877	add fysadStatsSeasonal.csv, update lynxTitanStats.csv, and write tests to make sure the keys for bosses match the expectation for the given gamemode	2021-06-08 16:15:36 +08:00
NotJayden	4703812b52	add comment	2021-06-08 15:49:02 +08:00
NotJayden	a11ac96f68	prettier	2021-06-07 14:53:36 +08:00
NotJayden	f97caa6a15	undo lib change	2021-06-07 14:51:15 +08:00
NotJayden	e7e54741d2	add conditional bosses filter if gamemode is seasonal	2021-06-07 14:50:21 +08:00
maxswa	062e5e02b2	v2.5.0	2021-06-03 22:26:38 -04:00
Max Swartwout	ed7036f9c0	Merge pull request #33 from maxswa/add-tob-hard-mode Add TOB hard mode.	2021-06-03 22:25:24 -04:00
maxswa	74aba3e818	Add TOB hard mode.	2021-06-03 22:19:03 -04:00
Max Swartwout	09fe7ed539	Merge pull request #32 from maxswa/dependabot/npm_and_yarn/ws-7.4.6 Bump ws from 7.4.2 to 7.4.6	2021-06-03 22:05:32 -04:00
dependabot[bot]	7a78e1ea0a	Bump ws from 7.4.2 to 7.4.6 Bumps [ws](https://github.com/websockets/ws) from 7.4.2 to 7.4.6. - [Release notes](https://github.com/websockets/ws/releases) - [Commits](https://github.com/websockets/ws/compare/7.4.2...7.4.6) Signed-off-by: dependabot[bot] <support@github.com>	2021-05-29 07:30:11 +00:00
maxswa	7a4163aed2	Add `.gitattributes` to ignore html test files.	2021-05-11 00:02:17 -04:00
Max Swartwout	85464d02fe	Add build badge to README.md	2021-05-10 23:44:50 -04:00