Add bosses and support for leagues.

src/hiscores.ts

@@ -13,6 +13,9 @@ import {
   PlayerSkillRow,
   ActivityName,
   PlayerActivityRow,
+  Bosses,
+  LeagueStats,
+  Boss,
 } from './types';
 import {
   getStatsURL,
@@ -26,6 +29,7 @@ import {
   numberFromElement,
   rsnFromElement,
   getActivityPageURL,
+  BOSSES,
 } from './utils';
 
 export async function getStats(rsn: string): Promise<Player> {
@@ -95,10 +99,10 @@ export async function getStats(rsn: string): Promise<Player> {
   throw Error('Player not found');
 }
 
-export async function getStatsByGamemode(
+export async function getStatsByGamemode<T extends Gamemode = 'main'>(
   rsn: string,
-  mode: Gamemode = 'main'
-): Promise<Stats> {
+  mode: T = 'main' as T
+): Promise<T extends 'leagues' ? LeagueStats : Stats> {
   if (typeof rsn !== 'string') {
     throw Error('RSN must be a string');
   } else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) {
@@ -112,7 +116,7 @@ export async function getStatsByGamemode(
   if (response.status !== 200) {
     throw Error('Player not found');
   }
-  const stats: Stats = parseStats(response.data);
+  const stats = parseStats(response.data, mode);
 
   return stats;
 }
@@ -209,7 +213,10 @@ export async function getRSNFormat(rsn: string): Promise<string> {
   }
 }
 
-export function parseStats(csv: string): Stats {
+export function parseStats<T extends Gamemode = 'main'>(
+  csv: string,
+  mode: T = 'main' as T
+): T extends 'leagues' ? LeagueStats : Stats {
   const splitCSV = csv
     .split('\n')
     .filter(entry => !!entry)
@@ -238,43 +245,69 @@ export function parseStats(csv: string): Stats {
       return activity;
     });
 
+  const [lp] = activityObjects.splice(0, 1);
   const bhObjects = activityObjects.splice(0, BH_MODES.length);
-  const [lms] = activityObjects.splice(0, 1);
   const clueObjects = activityObjects.splice(0, CLUES.length);
+  const [lms] = activityObjects.splice(0, 1);
+  const bossObjects = activityObjects.splice(0, BOSSES.length);
 
-  const skills: Skills = skillObjects.reduce<Skills>(
-    (prev, curr, index) => {
-      const newSkills = { ...prev };
-      newSkills[SKILLS[index]] = curr;
-      return newSkills;
-    },
-    {} as Skills
+  const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
+    const newSkills = { ...prev };
+    newSkills[SKILLS[index]] = curr;
+    return newSkills;
+  }, {} as Skills);
+
+  const bh: BH = bhObjects.reduce<BH>((prev, curr, index) => {
+    const newBH = { ...prev };
+    newBH[BH_MODES[index]] = curr;
+    return newBH;
+  }, {} as BH);
+
+  const clues: Clues = clueObjects.reduce<Clues>((prev, curr, index) => {
+    const newClues = { ...prev };
+    newClues[CLUES[index]] = curr;
+    return newClues;
+  }, {} as Clues);
+
+  // TODO Remove as soon as Jagex's API is fixed
+  const brokenBosses: Boss[] = ['callisto', 'cerberus'];
+  const TEMPBOSSES: Boss[] = BOSSES.reduce<Boss[]>(
+    (prev, curr) => (brokenBosses.includes(curr) ? prev : [...prev, curr]),
+    []
   );
 
-  const bh: BH = bhObjects.reduce<BH>(
-    (prev, curr, index) => {
-      const newBH = { ...prev };
-      newBH[BH_MODES[index]] = curr;
-      return newBH;
-    },
-    {} as BH
-  );
+  const bosses: Bosses = bossObjects.reduce<Bosses>((prev, curr, index) => {
+    const newBosses = { ...prev };
+    newBosses[TEMPBOSSES[index]] = brokenBosses.includes(BOSSES[index])
+      ? { rank: -1, score: -1 }
+      : curr;
+    return newBosses;
+  }, {} as Bosses);
 
-  const clues: Clues = clueObjects.reduce<Clues>(
-    (prev, curr, index) => {
-      const newClues = { ...prev };
-      newClues[CLUES[index]] = curr;
-      return newClues;
-    },
-    {} as Clues
-  );
+  // TODO Remove as soon as Jagex's API is fixed
+  brokenBosses.forEach(broken => {
+    bosses[broken] = {
+      rank: -1,
+      score: -1,
+    };
+  });
 
   const stats: Stats = {
     skills,
     bh,
     lms,
     clues,
+    bosses,
   };
 
-  return stats;
+  const leagueStats: LeagueStats = {
+    skills,
+    lp,
+    clues,
+    bosses,
+  };
+
+  return (mode === 'leagues' ? leagueStats : stats) as T extends 'leagues'
+    ? LeagueStats
+    : Stats;
 }

src/types.ts

@@ -1,4 +1,11 @@
-export type Gamemode = 'main' | 'iron' | 'hc' | 'ult' | 'dmm' | 'sdmm' | 'dmmt';
+export type Gamemode =
+  | 'main'
+  | 'iron'
+  | 'hc'
+  | 'ult'
+  | 'dmm'
+  | 'dmmt'
+  | 'leagues';
 
 export interface Skill {
   rank: number;
@@ -54,6 +61,53 @@ export type BHType = 'rogue' | 'hunter';
 
 export type BH = { [Type in BHType]: Activity };
 
+export type Boss =
+  | 'abyssalsire'
+  | 'alchemicalhydra'
+  | 'barrowschests'
+  | 'bryophyta'
+  | 'callisto'
+  | 'cerberus'
+  | 'chambersofxeric'
+  | 'chambersofxericchallengemode'
+  | 'chaoselemental'
+  | 'chaosfanatic'
+  | 'commanderzilyana'
+  | 'corporealbeast'
+  | 'crazyarchaeologist'
+  | 'dagannothprime'
+  | 'dagannothrex'
+  | 'dagannothsupreme'
+  | 'derangedarchaeologist'
+  | 'generalgraardor'
+  | 'giantmole'
+  | 'grotesqueguardians'
+  | 'hespori'
+  | 'kalphitequeen'
+  | 'kingblackdragon'
+  | 'kraken'
+  | 'kreearra'
+  | 'kriltsutsaroth'
+  | 'mimic'
+  | 'obor'
+  | 'sarachnis'
+  | 'scorpia'
+  | 'skotizo'
+  | 'gauntlet'
+  | 'corruptedgauntlet'
+  | 'theatreofblood'
+  | 'thermonuclearsmokedevil'
+  | 'tzkalzuk'
+  | 'tztokjad'
+  | 'venenatis'
+  | 'vetion'
+  | 'vorkath'
+  | 'wintertodt'
+  | 'zalcano'
+  | 'zulrah';
+
+export type Bosses = { [Type in Boss]: Activity };
+
 export type ActivityName =
   | 'hunterbh'
   | 'roguebh'
@@ -64,13 +118,19 @@ export type ActivityName =
   | 'mediumclues'
   | 'hardclues'
   | 'eliteclues'
-  | 'masterclues';
+  | 'masterclues'
+  | Boss;
 
 export interface Stats {
   skills: Skills;
   clues: Clues;
   bh: BH;
   lms: Activity;
+  bosses: Bosses;
+}
+
+export interface LeagueStats extends Omit<Stats, 'bh' | 'lms'> {
+  lp: Activity;
 }
 
 export type Modes = { [M in Gamemode]?: Stats };

src/utils/constants.ts

@@ -1,4 +1,4 @@
-import { SkillName, ClueType, BHType, Gamemode } from '../types';
+import { SkillName, ClueType, BHType, Gamemode, Boss } from '../types';
 
 export const BASE_URL = 'http://services.runescape.com/m=hiscore_oldschool';
 export const STATS_URL = 'index_lite.ws?player=';
@@ -9,7 +9,7 @@ export const GAMEMODE_URL = {
   hc: '_hardcore_ironman/',
   iron: '_ironman/',
   main: '/',
-  sdmm: '_seasonal/',
+  leagues: '_seasonal/',
   ult: '_ultimate/',
 };
 export const SKILLS: SkillName[] = [
@@ -66,6 +66,51 @@ export const GAMEMODES: Gamemode[] = [
   'hc',
   'ult',
   'dmm',
-  'sdmm',
   'dmmt',
+  'leagues',
+];
+export const BOSSES: Boss[] = [
+  'abyssalsire',
+  'alchemicalhydra',
+  'barrowschests',
+  'bryophyta',
+  'chambersofxeric',
+  'chambersofxericchallengemode',
+  'callisto',
+  'cerberus',
+  'chaoselemental',
+  'chaosfanatic',
+  'commanderzilyana',
+  'corporealbeast',
+  'crazyarchaeologist',
+  'dagannothprime',
+  'dagannothrex',
+  'dagannothsupreme',
+  'derangedarchaeologist',
+  'generalgraardor',
+  'giantmole',
+  'grotesqueguardians',
+  'hespori',
+  'kalphitequeen',
+  'kingblackdragon',
+  'kraken',
+  'kreearra',
+  'kriltsutsaroth',
+  'mimic',
+  'obor',
+  'sarachnis',
+  'scorpia',
+  'skotizo',
+  'gauntlet',
+  'corruptedgauntlet',
+  'theatreofblood',
+  'thermonuclearsmokedevil',
+  'tzkalzuk',
+  'tztokjad',
+  'venenatis',
+  'vetion',
+  'vorkath',
+  'wintertodt',
+  'zalcano',
+  'zulrah',
 ];