Merge pull request #6 from maxswa/boss-hiscores

Add Boss Hiscores
This commit is contained in:
Max Swartwout
2020-01-05 18:02:47 -05:00
committed by GitHub
9 changed files with 2059 additions and 1681 deletions

111
README.md
View File

@@ -68,15 +68,15 @@ const topPage = await getSkillPage('overall');
`getStats` will return a full player object with gamemode.
`getStatsByGameMode` will return a stats object and accepts a gamemode parameter:
| Game mode | Param |
| ---------------- | :----: |
| Regular | `main` |
| Ironman | `iron` |
| Hardcore Ironman | `hc` |
| Ultimate Ironman | `ult` |
| Deadman Mode | `dmm` |
| Seasonal Deadman | `sdmm` |
| DMM Tournament | `dmmt` |
| Game mode | Param |
| ---------------- | :----------: |
| Regular | `main` |
| Ironman | `ironman` |
| Hardcore Ironman | `hardcore` |
| Ultimate Ironman | `ultimate` |
| Deadman Mode | `deadman` |
| Tournament | `tournament` |
| Leagues | `seasonal` |
`getSkillPage` and `getActivityPage` require a skill/activity and optionally a gamemode and page:
@@ -87,27 +87,75 @@ hiscores
.catch(err => console.error(err));
```
Activities consist of all levels of clue scrolls as well as minigames:
Activities consist of all levels of clue scrolls as well as minigames and bosses:
### Clue Scrolls
| Type | Param |
| -------- | :-------------: |
| All | `allclues` |
| Beginner | `beginnerclues` |
| Easy | `easyclues` |
| Medium | `mediumclues` |
| Hard | `hardclues` |
| Elite | `eliteclues` |
| Master | `masterclues` |
| All | `allClues` |
| Beginner | `beginnerClues` |
| Easy | `easyClues` |
| Medium | `mediumClues` |
| Hard | `hardClues` |
| Elite | `eliteClues` |
| Master | `masterClues` |
### Minigames
| Minigame | Param |
| ---------------------- | :--------: |
| Bounty Hunter (Rogue) | `roguebh` |
| Bounty Hunter (Hunter) | `hunterbh` |
| Last Man Standing | `lms` |
| Minigame | Param |
| ---------------------- | :---------------: |
| Bounty Hunter (Rogue) | `rogueBH` |
| Bounty Hunter (Hunter) | `hunterBH` |
| Last Man Standing | `lastManStanding` |
### 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` |
| Obor | `obor` |
| Sarachnis | `sarachnis` |
| Scorpia | `scorpia` |
| Skotizo | `skotizo` |
| 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` |
## What you'll get
@@ -115,7 +163,7 @@ Activities consist of all levels of clue scrolls as well as minigames:
```javascript
{
rsn: 'Lynx Titan',
name: 'Lynx Titan',
mode: 'main',
dead: false,
deulted: false,
@@ -128,8 +176,10 @@ Activities consist of all levels of clue scrolls as well as minigames:
// ...
},
clues: {},
bh: {},
lms: {}
leaguePoints: {},
bountyHunter: {},
lastManStanding: {},
bosses: {}
}
}
```
@@ -138,9 +188,18 @@ Activities consist of all levels of clue scrolls as well as minigames:
```javascript
[
{ rank: 1, rsn: 'Lynx Titan', level: 2277, xp: 4600000000, dead: false },
{ rank: 1, name: 'Lynx Titan', level: 2277, xp: 4600000000, dead: false },
{},
{},
// ...
];
```
## Helpful Extras
Get the properly formatted name of any skill, boss, clue or other activity:
```javascript
// kril === "K'ril Tsutsaroth"
const kril = FORMATTED_BOSS_NAMES['krilTsutsaroth'];
```

View File

@@ -1,12 +1,11 @@
import {
parseStats,
getRSNFormat,
getSkillPage,
getStats,
getStatsByGamemode,
getRSNFormat,
Stats,
} from '../src/index';
import { PlayerSkillRow, Player, Stats } from '../src/types';
import axios, { AxiosError } from 'axios';
test('Parse CSV to json', () => {
const csv = `40258,2063,218035714
@@ -33,18 +32,60 @@ test('Parse CSV to json', () => {
53099, 80, 2008229
169127, 73, 1067670
115543, 82, 2546048
-1, -1
-1, -1
32875, 500
-1, -1
-1, -1
-1, -1
24817, 476
212728, 1
94827, 20
59099, 74
24642, 231
5206, 99
6293, 51`;
6293, 51
32875, 500
374,2780
934,3000
1936,1452
4919,23
101,4038
152,334
6153,133
4501,250
6806,603
1,17798
9160,125
1021,2802
4295,1655
959,2951
10009,1
1271,2407
378,4669
543,1567
6003,94
263,2897
4000,1277
41016,1477
617,2391
120,2981
1,109
26,323
198,1101
81,3404
5027,61
63,375
2845,6
6913,138
3999,2000
484,8
957,47
10987,223
1923,272
8484,1340
599,1694
12489,435
3810,4583`;
expect(parseStats(csv)).toStrictEqual({
const expectedOutput: Stats = {
skills: {
overall: { rank: 40258, level: 2063, xp: 218035714 },
attack: { rank: 20554, level: 99, xp: 21102621 },
@@ -71,11 +112,12 @@ test('Parse CSV to json', () => {
hunter: { rank: 169127, level: 73, xp: 1067670 },
construction: { rank: 115543, level: 82, xp: 2546048 },
},
bh: {
leaguePoints: { rank: -1, score: -1 },
bountyHunter: {
rogue: { rank: -1, score: -1 },
hunter: { rank: -1, score: -1 },
},
lms: { rank: 32875, score: 500 },
lastManStanding: { rank: 32875, score: 500 },
clues: {
all: { rank: 24817, score: 476 },
beginner: { rank: 212728, score: 1 },
@@ -85,238 +127,274 @@ test('Parse CSV to json', () => {
elite: { rank: 5206, score: 99 },
master: { rank: 6293, score: 51 },
},
});
});
test('Get rsn format', async done => {
const callback = (data: string) => {
expect(data).toBe('Lynx Titan');
done();
bosses: {
abyssalSire: { rank: 374, score: 2780 },
alchemicalHydra: { rank: 934, score: 3000 },
barrows: { rank: 1936, score: 1452 },
bryophyta: { rank: 4919, score: 23 },
callisto: { rank: -1, score: -1 },
cerberus: { rank: -1, score: -1 },
chambersOfXeric: { rank: 101, score: 4038 },
chambersOfXericChallengeMode: { rank: 152, score: 334 },
chaosElemental: { rank: 6153, score: 133 },
chaosFanatic: { rank: 4501, score: 250 },
commanderZilyana: { rank: 6806, score: 603 },
corporealBeast: { rank: 1, score: 17798 },
crazyArchaeologist: { rank: 9160, score: 125 },
dagannothPrime: { rank: 1021, score: 2802 },
dagannothRex: { rank: 4295, score: 1655 },
dagannothSupreme: { rank: 959, score: 2951 },
derangedArchaeologist: { rank: 10009, score: 1 },
generalGraardor: { rank: 1271, score: 2407 },
giantMole: { rank: 378, score: 4669 },
grotesqueGuardians: { rank: 543, score: 1567 },
hespori: { rank: 6003, score: 94 },
kalphiteQueen: { rank: 263, score: 2897 },
kingBlackDragon: { rank: 4000, score: 1277 },
kraken: { rank: 41016, score: 1477 },
kreeArra: { rank: 617, score: 2391 },
krilTsutsaroth: { rank: 120, score: 2981 },
mimic: { rank: 1, score: 109 },
obor: { rank: 26, score: 323 },
sarachnis: { rank: 198, score: 1101 },
scorpia: { rank: 81, score: 3404 },
skotizo: { rank: 5027, score: 61 },
gauntlet: { rank: 63, score: 375 },
corruptedGauntlet: { rank: 2845, score: 6 },
theatreOfBlood: { rank: 6913, score: 138 },
thermonuclearSmokeDevil: { rank: 3999, score: 2000 },
tzKalZuk: { rank: 484, score: 8 },
tzTokJad: { rank: 957, score: 47 },
venenatis: { rank: 10987, score: 223 },
vetion: { rank: 1923, score: 272 },
vorkath: { rank: 8484, score: 1340 },
wintertodt: { rank: 599, score: 1694 },
zalcano: { rank: 12489, score: 435 },
zulrah: { rank: 3810, score: 4583 },
},
};
getRSNFormat('lYnX tiTaN').then(callback);
expect(parseStats(csv)).toStrictEqual(expectedOutput);
});
test('Get attack top page', async done => {
const callback = (data: PlayerSkillRow[]) => {
expect(data).toMatchObject([
{
rsn: expect.any(String),
rank: 1,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 2,
level: 99,
xp: 200000000,
dead: false,
},
{ rsn: 'Drakon', rank: 3, level: 99, xp: 200000000, dead: false },
{
rsn: expect.any(String),
rank: 4,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 5,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 6,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 7,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 8,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 9,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 10,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 11,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 12,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 13,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 14,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 15,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 16,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 17,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 18,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 19,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 20,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 21,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 22,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 23,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 24,
level: 99,
xp: 200000000,
dead: false,
},
{
rsn: expect.any(String),
rank: 25,
level: 99,
xp: 200000000,
dead: false,
},
]);
done();
};
getSkillPage('attack').then(callback);
test('Get name format', async () => {
jest.setTimeout(30000);
const data = await getRSNFormat('lYnX tiTaN');
expect(data).toBe('Lynx Titan');
});
test('Get non-existant player', async done => {
const callback = (err: AxiosError) => {
test('Get attack top page', async () => {
jest.setTimeout(30000);
const data = await getSkillPage('attack');
expect(data).toMatchObject([
{
name: expect.any(String),
rank: 1,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 2,
level: 99,
xp: 200000000,
dead: false,
},
{ name: 'Drakon', rank: 3, level: 99, xp: 200000000, dead: false },
{
name: expect.any(String),
rank: 4,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 5,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 6,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 7,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 8,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 9,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 10,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 11,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 12,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 13,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 14,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 15,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 16,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 17,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 18,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 19,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 20,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 21,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 22,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 23,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 24,
level: 99,
xp: 200000000,
dead: false,
},
{
name: expect.any(String),
rank: 25,
level: 99,
xp: 200000000,
dead: false,
},
]);
});
test('Get non-existant player', async () => {
jest.setTimeout(30000);
getStats('fishy').catch(err => {
if (err.response) {
expect(err.response.status).toBe(404);
}
done();
};
getStats('fishy').catch(callback);
});
});
test('Get stats by gamemode', async done => {
const callback = (stats: Stats) => {
expect(stats.skills).toStrictEqual({
overall: { rank: 1, level: 2277, xp: 4600000000 },
attack: { rank: 15, level: 99, xp: 200000000 },
defence: { rank: 27, level: 99, xp: 200000000 },
strength: { rank: 18, level: 99, xp: 200000000 },
hitpoints: { rank: 7, level: 99, xp: 200000000 },
ranged: { rank: 7, level: 99, xp: 200000000 },
prayer: { rank: 11, level: 99, xp: 200000000 },
magic: { rank: 32, level: 99, xp: 200000000 },
cooking: { rank: 158, level: 99, xp: 200000000 },
woodcutting: { rank: 15, level: 99, xp: 200000000 },
fletching: { rank: 12, level: 99, xp: 200000000 },
fishing: { rank: 9, level: 99, xp: 200000000 },
firemaking: { rank: 49, level: 99, xp: 200000000 },
crafting: { rank: 4, level: 99, xp: 200000000 },
smithing: { rank: 3, level: 99, xp: 200000000 },
mining: { rank: 25, level: 99, xp: 200000000 },
herblore: { rank: 5, level: 99, xp: 200000000 },
agility: { rank: 24, level: 99, xp: 200000000 },
thieving: { rank: 12, level: 99, xp: 200000000 },
slayer: { rank: 2, level: 99, xp: 200000000 },
farming: { rank: 19, level: 99, xp: 200000000 },
runecraft: { rank: 7, level: 99, xp: 200000000 },
hunter: { rank: 4, level: 99, xp: 200000000 },
construction: { rank: 4, level: 99, xp: 200000000 },
});
done();
};
getStatsByGamemode('Lynx Titan').then(callback);
test('Get stats by gamemode', async () => {
jest.setTimeout(30000);
const { skills } = await getStatsByGamemode('Lynx Titan');
expect(skills).toMatchObject({
overall: { rank: expect.any(Number), level: 2277, xp: 4600000000 },
attack: { rank: expect.any(Number), level: 99, xp: 200000000 },
defence: { rank: expect.any(Number), level: 99, xp: 200000000 },
strength: { rank: expect.any(Number), level: 99, xp: 200000000 },
hitpoints: { rank: expect.any(Number), level: 99, xp: 200000000 },
ranged: { rank: expect.any(Number), level: 99, xp: 200000000 },
prayer: { rank: expect.any(Number), level: 99, xp: 200000000 },
magic: { rank: expect.any(Number), level: 99, xp: 200000000 },
cooking: { rank: expect.any(Number), level: 99, xp: 200000000 },
woodcutting: { rank: expect.any(Number), level: 99, xp: 200000000 },
fletching: { rank: expect.any(Number), level: 99, xp: 200000000 },
fishing: { rank: expect.any(Number), level: 99, xp: 200000000 },
firemaking: { rank: expect.any(Number), level: 99, xp: 200000000 },
crafting: { rank: expect.any(Number), level: 99, xp: 200000000 },
smithing: { rank: expect.any(Number), level: 99, xp: 200000000 },
mining: { rank: expect.any(Number), level: 99, xp: 200000000 },
herblore: { rank: expect.any(Number), level: 99, xp: 200000000 },
agility: { rank: expect.any(Number), level: 99, xp: 200000000 },
thieving: { rank: expect.any(Number), level: 99, xp: 200000000 },
slayer: { rank: expect.any(Number), level: 99, xp: 200000000 },
farming: { rank: expect.any(Number), level: 99, xp: 200000000 },
runecraft: { rank: expect.any(Number), level: 99, xp: 200000000 },
hunter: { rank: expect.any(Number), level: 99, xp: 200000000 },
construction: { rank: expect.any(Number), level: 99, xp: 200000000 },
});
});

View File

@@ -10,6 +10,7 @@
"scripts": {
"dev": "watch 'yarn run build' src",
"build": "tsc",
"format": "prettier --write \"src/**/*.ts\"",
"test": "jest --config jestconfig.json",
"prepublish": "yarn run build",
"release": "np"
@@ -43,6 +44,7 @@
"@types/jest": "^24.0.14",
"jest": "^24.8.0",
"np": "^5.0.3",
"prettier": "^1.19.1",
"ts-jest": "^24.0.2",
"tslint": "^5.17.0",
"tslint-config-airbnb": "^5.11.1",

View File

@@ -13,6 +13,8 @@ import {
PlayerSkillRow,
ActivityName,
PlayerActivityRow,
Bosses,
Boss,
} from './types';
import {
getStatsURL,
@@ -26,6 +28,7 @@ import {
numberFromElement,
rsnFromElement,
getActivityPageURL,
BOSSES,
} from './utils';
export async function getStats(rsn: string): Promise<Player> {
@@ -40,16 +43,16 @@ export async function getStats(rsn: string): Promise<Player> {
const mainRes = await axios(getStatsURL('main', rsn));
if (mainRes.status === 200) {
const otherResponses = await Promise.all([
axios(getStatsURL('iron', rsn)).catch(err => err),
axios(getStatsURL('hc', rsn)).catch(err => err),
axios(getStatsURL('ult', rsn)).catch(err => err),
axios(getStatsURL('ironman', rsn)).catch(err => err),
axios(getStatsURL('hardcore', rsn)).catch(err => err),
axios(getStatsURL('ultimate', rsn)).catch(err => err),
getRSNFormat(rsn),
]);
const [ironRes, hcRes, ultRes, formattedName] = otherResponses;
const player: Player = {
rsn: formattedName,
name: formattedName,
mode: 'main',
dead: false,
deulted: false,
@@ -58,32 +61,42 @@ export async function getStats(rsn: string): Promise<Player> {
player.main = parseStats(mainRes.data);
if (ironRes.status === 200) {
player.iron = parseStats(ironRes.data);
player.ironman = parseStats(ironRes.data);
if (hcRes.status === 200) {
player.mode = 'hc';
player.hc = parseStats(hcRes.data);
if (player.iron.skills.overall.xp !== player.hc.skills.overall.xp) {
player.mode = 'hardcore';
player.hardcore = parseStats(hcRes.data);
if (
player.ironman.skills.overall.xp !== player.hardcore.skills.overall.xp
) {
player.dead = true;
player.mode = 'iron';
player.mode = 'ironman';
}
if (player.main.skills.overall.xp !== player.iron.skills.overall.xp) {
if (
player.main.skills.overall.xp !== player.ironman.skills.overall.xp
) {
player.deironed = true;
player.mode = 'main';
}
} else if (ultRes.status === 200) {
player.mode = 'ult';
player.ult = parseStats(ultRes.data);
if (player.iron.skills.overall.xp !== player.ult.skills.overall.xp) {
player.mode = 'ultimate';
player.ultimate = parseStats(ultRes.data);
if (
player.ironman.skills.overall.xp !== player.ultimate.skills.overall.xp
) {
player.deulted = true;
player.mode = 'iron';
player.mode = 'ironman';
}
if (player.main.skills.overall.xp !== player.iron.skills.overall.xp) {
if (
player.main.skills.overall.xp !== player.ironman.skills.overall.xp
) {
player.deironed = true;
player.mode = 'main';
}
} else {
player.mode = 'iron';
if (player.main.skills.overall.xp !== player.iron.skills.overall.xp) {
player.mode = 'ironman';
if (
player.main.skills.overall.xp !== player.ironman.skills.overall.xp
) {
player.deironed = true;
player.mode = 'main';
}
@@ -112,7 +125,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);
return stats;
}
@@ -141,7 +154,7 @@ export async function getSkillPage(
const [nameEl] = nameCell.children.filter(el => el.name === 'a');
return {
rsn: rsnFromElement(nameEl),
name: rsnFromElement(nameEl),
rank: numberFromElement(rankEl),
level: numberFromElement(levelEl),
xp: numberFromElement(xpEl),
@@ -176,7 +189,7 @@ export async function getActivityPage(
const [nameEl] = nameCell.children.filter(el => el.name === 'a');
return {
rsn: rsnFromElement(nameEl),
name: rsnFromElement(nameEl),
rank: numberFromElement(rankEl),
score: numberFromElement(scoreEl),
dead: nameCell.children.length === 4,
@@ -238,42 +251,61 @@ export function parseStats(csv: string): Stats {
return activity;
});
const [leaguePoints] = 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 [lastManStanding] = 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 bountyHunter: 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 };
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
if (BOSSES[index] === brokenBosses[0]) {
brokenBosses.forEach(broken => {
newBosses[broken] = {
rank: -1,
score: -1,
};
});
}
newBosses[TEMPBOSSES[index]] = curr;
return newBosses;
}, {} as Bosses);
const stats: Stats = {
skills,
bh,
lms,
leaguePoints,
bountyHunter,
lastManStanding,
clues,
bosses,
};
return stats;

View File

@@ -2,5 +2,6 @@ import * as hiscores from './hiscores';
export * from './hiscores';
export * from './types';
export * from './utils';
export default hiscores;

View File

@@ -1,4 +1,11 @@
export type Gamemode = 'main' | 'iron' | 'hc' | 'ult' | 'dmm' | 'sdmm' | 'dmmt';
export type Gamemode =
| 'main'
| 'ironman'
| 'ultimate'
| 'hardcore'
| 'deadman'
| 'seasonal'
| 'tournament';
export interface Skill {
rank: number;
@@ -54,29 +61,78 @@ export type BHType = 'rogue' | 'hunter';
export type BH = { [Type in BHType]: Activity };
export type Boss =
| 'abyssalSire'
| 'alchemicalHydra'
| 'barrows'
| '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'
| 'lms'
| 'allclues'
| 'beginnerclues'
| 'easyclues'
| 'mediumclues'
| 'hardclues'
| 'eliteclues'
| 'masterclues';
| 'hunterBH'
| 'rogueBH'
| 'lastManStanding'
| 'allClues'
| 'beginnerClues'
| 'easyClues'
| 'mediumClues'
| 'hardClues'
| 'eliteClues'
| 'masterClues'
| Boss;
export interface Stats {
skills: Skills;
clues: Clues;
bh: BH;
lms: Activity;
leaguePoints: Activity;
bountyHunter: BH;
lastManStanding: Activity;
bosses: Bosses;
}
export type Modes = { [M in Gamemode]?: Stats };
export interface Player extends Modes {
rsn: string;
name: string;
mode: Gamemode;
dead: boolean;
deulted: boolean;
@@ -84,11 +140,11 @@ export interface Player extends Modes {
}
export interface PlayerSkillRow extends Skill {
rsn: string;
name: string;
dead: boolean;
}
export interface PlayerActivityRow extends Activity {
rsn: string;
name: string;
dead: boolean;
}

View File

@@ -1,16 +1,28 @@
import { SkillName, ClueType, BHType, Gamemode } from '../types';
import {
BHType,
Boss,
ClueType,
Gamemode,
SkillName,
ActivityName,
} from '../types';
export const BASE_URL = 'http://services.runescape.com/m=hiscore_oldschool';
export const STATS_URL = 'index_lite.ws?player=';
export const SCORES_URL = 'overall.ws?';
export const GAMEMODE_URL = {
dmm: '_deadman/',
dmmt: '_tournament/',
hc: '_hardcore_ironman/',
iron: '_ironman/',
main: '/',
sdmm: '_seasonal/',
ult: '_ultimate/',
export type GamemodeUrl = {
[key in Gamemode]: string;
};
export const GAMEMODE_URL: GamemodeUrl = {
main: `${BASE_URL}/`,
ironman: `${BASE_URL}_ironman/`,
hardcore: `${BASE_URL}_hardcore_ironman/`,
ultimate: `${BASE_URL}_ultimate/`,
deadman: `${BASE_URL}_deadman/`,
seasonal: `${BASE_URL}_seasonal/`,
tournament: `${BASE_URL}_tournament/`,
};
export const SKILLS: SkillName[] = [
'overall',
@@ -48,24 +60,176 @@ export const CLUES: ClueType[] = [
'master',
];
export const BH_MODES: BHType[] = ['rogue', 'hunter'];
export const ACTIVITIES = [
'hunterbh',
'roguebh',
'lms',
'allclues',
'beginnerclues',
'easyclues',
'mediumclues',
'hardclues',
'eliteclues',
'masterclues',
export const ACTIVITIES: ActivityName[] = [
'hunterBH',
'rogueBH',
'lastManStanding',
'allClues',
'beginnerClues',
'easyClues',
'mediumClues',
'hardClues',
'eliteClues',
'masterClues',
];
export const GAMEMODES: Gamemode[] = [
'main',
'iron',
'hc',
'ult',
'dmm',
'sdmm',
'dmmt',
'ironman',
'hardcore',
'ultimate',
'deadman',
'seasonal',
'tournament',
];
export const BOSSES: Boss[] = [
'abyssalSire',
'alchemicalHydra',
'barrows',
'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 FormattedBossNames = {
[key in Boss]: string;
};
export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
abyssalSire: 'Abyssal Sire',
alchemicalHydra: 'Alchemical Hydra',
barrows: 'Barrows Chests',
bryophyta: 'Bryophyta',
callisto: 'Callisto',
cerberus: 'Cerberus',
chambersOfXeric: 'Chambers of Xeric',
chambersOfXericChallengeMode: 'Chambers of Xeric: Challenge Mode',
chaosElemental: 'Chaos Elemental',
chaosFanatic: 'Chaos Fanatic',
commanderZilyana: 'Commander Zilyana',
corporealBeast: 'Corporeal Beast',
crazyArchaeologist: 'Crazy Archaeologist',
dagannothPrime: 'Dagannoth Prime',
dagannothRex: 'Dagannoth Rex',
dagannothSupreme: 'Dagannoth Supreme',
derangedArchaeologist: 'Deranged Archaeologist',
generalGraardor: 'General Graardor',
giantMole: 'Giant Mole',
grotesqueGuardians: 'Grotesque Guardians',
hespori: 'Hespori',
kalphiteQueen: 'Kalphite Queen',
kingBlackDragon: 'King Black Dragon',
kraken: 'Kraken',
kreeArra: "Kree'Arra",
krilTsutsaroth: "K'ril Tsutsaroth",
mimic: 'Mimic',
obor: 'Obor',
sarachnis: 'Sarachnis',
scorpia: 'Scorpia',
skotizo: 'Skotizo',
gauntlet: 'The Gauntlet',
corruptedGauntlet: 'The Corrupted Gauntlet',
theatreOfBlood: 'Theatre of Blood',
thermonuclearSmokeDevil: 'Thermonuclear Smoke Devil',
tzKalZuk: 'TzKal-Zuk',
tzTokJad: 'TzTok-Jad',
venenatis: 'Venenatis',
vetion: "Vet'ion",
vorkath: 'Vorkath',
wintertodt: 'Wintertodt',
zalcano: 'Zalcano',
zulrah: 'Zulrah',
};
export type FormattedSkillNames = {
[key in SkillName]: string;
};
export const FORMATTED_SKILL_NAMES: FormattedSkillNames = {
overall: 'Overall',
attack: 'Attack',
defence: 'Defence',
strength: 'Strength',
hitpoints: 'Hitpoints',
ranged: 'Ranged',
prayer: 'Prayer',
magic: 'Magic',
cooking: 'Cooking',
woodcutting: 'Woodcutting',
fletching: 'Fletching',
fishing: 'Fishing',
firemaking: 'Firemaking',
crafting: 'Crafting',
smithing: 'Smithing',
mining: 'Mining',
herblore: 'Herblore',
agility: 'Agility',
thieving: 'Thieving',
slayer: 'Slayer',
farming: 'Farming',
runecraft: 'Runecraft',
hunter: 'Hunter',
construction: 'Construction',
};
export type FormattedClueNames = {
[key in ClueType]: string;
};
export const FORMATTED_CLUE_NAMES: FormattedClueNames = {
all: 'Clue Scrolls (all)',
beginner: 'Clue Scrolls (beginner)',
easy: 'Clue Scrolls (easy)',
medium: 'Clue Scrolls (medium)',
hard: 'Clue Scrolls (hard)',
elite: 'Clue Scrolls (elite)',
master: 'Clue Scrolls (master)',
};
export type FormattedBHNames = {
[key in BHType]: string;
};
export const FORMATTED_BH_NAMES: FormattedBHNames = {
rogue: 'Bounty Hunter - Rogue',
hunter: 'Bounty Hunter - Hunter',
};
export const FORMATTED_LMS = 'Last Man Standing';
export const FORMATTED_LEAGUE_POINTS = 'League Points';

View File

@@ -1,6 +1,5 @@
import { Gamemode, SkillName, ActivityName } from '../types';
import {
BASE_URL,
GAMEMODE_URL,
STATS_URL,
SCORES_URL,
@@ -9,19 +8,19 @@ import {
} from './constants';
export const getStatsURL = (gamemode: Gamemode, rsn: string) =>
`${BASE_URL}${GAMEMODE_URL[gamemode]}${STATS_URL}${encodeURIComponent(rsn)}`;
`${GAMEMODE_URL[gamemode]}${STATS_URL}${encodeURIComponent(rsn)}`;
export const getPlayerTableURL = (gamemode: Gamemode, rsn: string) =>
`${BASE_URL}${
GAMEMODE_URL[gamemode]
}${SCORES_URL}table=0&user=${encodeURIComponent(rsn)}`;
`${GAMEMODE_URL[gamemode]}${SCORES_URL}table=0&user=${encodeURIComponent(
rsn
)}`;
export const getSkillPageURL = (
gamemode: Gamemode,
skill: SkillName,
page: number
) =>
`${BASE_URL}${GAMEMODE_URL[gamemode]}${SCORES_URL}table=${SKILLS.indexOf(
`${GAMEMODE_URL[gamemode]}${SCORES_URL}table=${SKILLS.indexOf(
skill
)}&page=${page}`;
@@ -30,7 +29,7 @@ export const getActivityPageURL = (
activity: ActivityName,
page: number
) =>
`${BASE_URL}${
`${
GAMEMODE_URL[gamemode]
}${SCORES_URL}category_type=1&table=${ACTIVITIES.indexOf(
activity

2639
yarn.lock

File diff suppressed because it is too large Load Diff