Compare commits

..

190 Commits

Author SHA1 Message Date
maxswa
3b502cb7cf v2.17.0 2024-01-24 11:25:48 -05:00
Max Swartwout
b3f81e66eb Merge pull request #88 from maxswa/scurrius
Add Scurrius
2024-01-24 11:24:34 -05:00
Max Swartwout
01150b6234 Merge pull request #93 from maxswa/update-readme-json-api
Add reference to official JSON API in README
2024-01-19 18:43:47 -05:00
maxswa
ca4d75f2c7 Add reference to official JSON API in README. 2024-01-19 18:37:14 -05:00
Max Swartwout
03b2ef42d2 Merge pull request #91 from maxswa/dependabot/npm_and_yarn/follow-redirects-1.15.4
Bump follow-redirects from 1.15.3 to 1.15.4
2024-01-19 18:18:24 -05:00
dependabot[bot]
7e2603b235 Bump follow-redirects from 1.15.3 to 1.15.4
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.3 to 1.15.4.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.15.3...v1.15.4)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-01-11 04:36:21 +00:00
maxswa
92452e240c Add Scurrius 2023-12-30 23:25:32 -05:00
maxswa
d01b36422e v2.16.3 2023-12-17 20:17:17 -05:00
Max Swartwout
3bc1352838 Merge pull request #90 from maxswa/deadman-points
Add Deadman Points
2023-12-17 20:16:28 -05:00
maxswa
91066b5366 Add deadmanPoints 2023-12-17 20:13:06 -05:00
maxswa
4872d04301 v2.16.2 2023-11-26 19:53:20 -05:00
Max Swartwout
55312ba0fd Merge pull request #85 from seditionist/main
Add Custom Errors
2023-11-26 19:52:07 -05:00
maxswa
331a448503 Disabled eslint rule. 2023-11-26 19:43:35 -05:00
maxswa
84c704a846 Add test for excluded gamemodes. 2023-11-26 19:42:46 -05:00
seditionist
561495632c Fix gamemode checks 2023-11-26 18:55:26 -05:00
seditionist
bdfdf1eb14 Merge branch 'maxswa-main' 2023-11-26 18:23:31 -05:00
seditionist
e349776060 Merge branch 'main' of github.com:maxswa/osrs-json-hiscores into maxswa-main
# Conflicts:
#	src/hiscores.ts
2023-11-26 18:20:03 -05:00
seditionist
546bc5acf7 Remove unnecessary type cast 2023-11-26 17:43:38 -05:00
seditionist
66528cd9d9 Restore error message constants 2023-11-26 17:42:55 -05:00
maxswa
99ea3fb722 v2.16.1 2023-11-25 22:07:55 -05:00
Max Swartwout
7f16d26e3c Merge pull request #89 from maxswa/bump-axios
Bump `axios`
2023-11-25 22:06:07 -05:00
maxswa
ed9fcf47b3 Bump axios 2023-11-25 22:04:48 -05:00
Max Swartwout
bb935bb6c9 Merge pull request #86 from maxswa/dependabot/npm_and_yarn/babel/traverse-7.23.2
Bump @babel/traverse from 7.22.8 to 7.23.2
2023-11-25 21:36:52 -05:00
dependabot[bot]
d046fffa9e Bump @babel/traverse from 7.22.8 to 7.23.2
Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.22.8 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-10-19 11:00:07 +00:00
seditionist
5483e54d78 cleanup 2023-08-17 00:58:37 -04:00
seditionist
97532b0c03 fix tests 2023-08-17 00:35:22 -04:00
seditionist
f9a56e2b3a update hiscores to throw new custom errors 2023-08-17 00:32:23 -04:00
seditionist
9f43f0c39f update validRSN to use InvalidRSNError 2023-08-17 00:12:27 -04:00
seditionist
d67ffa3e20 created custom errors 2023-08-17 00:11:18 -04:00
maxswa
7bdde9f5d1 v2.16.0 2023-08-15 21:26:53 -04:00
Max Swartwout
b4a50e69c8 Merge pull request #83 from maxswa/json-endpoint
Use Official JSON Endpoint
2023-08-15 21:25:57 -04:00
maxswa
7935c5a523 Update name matching to use lowercase values. 2023-08-12 11:19:33 -04:00
maxswa
f1e2155428 Fix tests. 2023-08-12 11:01:06 -04:00
maxswa
dd90fe1260 Update README with new formatted names. 2023-08-11 15:11:38 -04:00
maxswa
12c4e530a2 Update get stats functions to use JSON endpoint. 2023-08-11 14:59:49 -04:00
maxswa
5a2b0d9ad8 Add functions to support JSON endpoint. 2023-08-11 14:52:02 -04:00
maxswa
c43858eac1 v2.15.0 2023-07-26 18:50:54 -04:00
Max Swartwout
0d0081f4f6 Merge pull request #81 from wpdough/main
Add new DT2 bosses
2023-07-26 18:49:03 -04:00
wpdough
3570f0f07d Update README and revert yarn.lock 2023-07-26 14:32:13 -04:00
wpdough
3ddda54e02 Merge branch 'main' of https://github.com/wpdough/osrs-json-hiscores into main 2023-07-26 14:08:46 -04:00
wpdough
388f01522a Add new DT2 bosses 2023-07-26 14:08:38 -04:00
wpdough
24b3de2a29 Add new DT2 bosses 2023-07-26 12:00:23 -04:00
maxswa
fc7897d4c7 v2.14.2 2023-07-15 20:48:08 -04:00
Max Swartwout
72ea31490f Merge pull request #80 from maxswa/update-test-lint-format-libs
Update testing, linting and formatting libraries
2023-07-13 16:40:08 -04:00
maxswa
66825955c1 Update linting and formatting libraries. 2023-07-13 16:36:37 -04:00
maxswa
4b4bf8c702 Update jest, jsdom, typescript 2023-07-13 16:16:07 -04:00
Max Swartwout
53981e7468 Merge pull request #78 from maxswa/dependabot/npm_and_yarn/semver-5.7.2
Bump semver from 5.7.1 to 5.7.2
2023-07-13 16:04:52 -04:00
dependabot[bot]
a90e5b98dd Bump semver from 5.7.1 to 5.7.2
Bumps [semver](https://github.com/npm/node-semver) from 5.7.1 to 5.7.2.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/v5.7.2/CHANGELOG.md)
- [Commits](https://github.com/npm/node-semver/compare/v5.7.1...v5.7.2)

---
updated-dependencies:
- dependency-name: semver
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-07-11 11:51:33 +00:00
maxswa
16a975f10b v2.14.1 2023-06-16 15:36:44 -04:00
Max Swartwout
c800501188 Merge pull request #77 from maxswa/axios-config
Add optional axios config argument
2023-06-16 15:36:14 -04:00
maxswa
8a320df015 Update necessary jsdoc comments. 2023-05-28 13:47:21 -04:00
maxswa
169462c446 Add optional config arg to all fns using httpGet 2023-05-28 13:42:37 -04:00
maxswa
317a972314 Add optional axios configs to GetStatsOptions 2023-05-28 13:41:53 -04:00
maxswa
c558f8402c Add optional axios config arg to httpGet 2023-05-28 13:41:02 -04:00
maxswa
41c6da4d5c v2.14.0 2023-05-26 09:40:51 -04:00
Max Swartwout
99ad5eb662 Merge pull request #76 from dmeredith96/fix-invalid-format-err
Add support for the Legacy Bounty Hunter minigame
2023-05-26 09:38:31 -04:00
David Meredith
a8cf1713af Change approach to tracking the new Bounty Hunter stats 2023-05-25 09:37:30 -05:00
David Meredith
11391c90f2 Add support for the Legacy Bounty Hunter minigame 2023-05-24 08:48:46 -05:00
maxswa
e4d2b10488 v2.13.1 2023-04-12 21:51:49 -04:00
Max Swartwout
0cfd0e2471 Merge pull request #73 from davidvorona/main
Fix spelling of Calvar'ion
2023-04-12 21:50:54 -04:00
David Vorona
9c284ad4b0 Fix spelling of Calvar'ion 2023-04-12 10:26:06 -07:00
Max Swartwout
ec60a72c08 Merge pull request #71 from maxswa/fix-gh-workflow
Update GH action versions.
2023-04-12 13:04:45 -04:00
maxswa
d45e2efcfd Update GH action versions. 2023-04-12 13:00:18 -04:00
maxswa
f80b417121 v2.13.0 2023-04-12 12:53:39 -04:00
maxswa
415fe2f02b Update np 2023-04-12 12:50:41 -04:00
Max Swartwout
968799176f Merge pull request #70 from maxswa/wilderness-boss-variants
Add wilderness boss variants.
2023-04-12 12:46:11 -04:00
maxswa
f45ae67813 Add wilderness boss variants. 2023-04-12 12:42:37 -04:00
maxswa
7724636b40 v2.12.1 2023-03-19 23:33:33 -04:00
maxswa
3954b04acc Add publishConfig to package.json 2023-03-19 23:33:03 -04:00
Max Swartwout
ee7389455c Merge pull request #68 from maxswa/add-options
Add `validateRSN`, `GetStatsOptions`
2023-03-19 23:28:34 -04:00
maxswa
54c11635e0 Add GetStatsOptions for getStats 2023-03-19 23:14:10 -04:00
maxswa
dc799cf363 Add validateRSN helper function. 2023-03-19 22:38:45 -04:00
maxswa
d4c7aaff2a v2.12.0 2023-02-19 18:31:43 -05:00
Max Swartwout
03c089ebff Merge pull request #66 from maxswa/account-builds
Add new `Gamemode`s
2023-02-19 18:31:00 -05:00
Max Swartwout
96641d875a Merge pull request #65 from maxswa/dependabot/npm_and_yarn/http-cache-semantics-4.1.1
Bump http-cache-semantics from 4.1.0 to 4.1.1
2023-02-19 18:28:33 -05:00
maxswa
b2bdd3d2ce Add new Gamemodes 2023-02-19 18:27:56 -05:00
dependabot[bot]
a4ddfaf199 Bump http-cache-semantics from 4.1.0 to 4.1.1
Bumps [http-cache-semantics](https://github.com/kornelski/http-cache-semantics) from 4.1.0 to 4.1.1.
- [Release notes](https://github.com/kornelski/http-cache-semantics/releases)
- [Commits](https://github.com/kornelski/http-cache-semantics/compare/v4.1.0...v4.1.1)

---
updated-dependencies:
- dependency-name: http-cache-semantics
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-02-03 04:54:08 +00:00
maxswa
efbcdfc709 v2.11.0 2023-01-13 11:21:51 -05:00
Max Swartwout
fe913aba1f Merge pull request #64 from davidvorona/add-muspah
Add phantom muspah
2023-01-12 15:30:21 -05:00
Max Swartwout
1497653bab Merge pull request #63 from maxswa/dependabot/npm_and_yarn/json5-1.0.2
Bump json5 from 1.0.1 to 1.0.2
2023-01-12 15:29:38 -05:00
David Vorona
f76de38eb1 Add phantom muspah 2023-01-11 11:45:59 -08:00
dependabot[bot]
2f1d10b309 Bump json5 from 1.0.1 to 1.0.2
Bumps [json5](https://github.com/json5/json5) from 1.0.1 to 1.0.2.
- [Release notes](https://github.com/json5/json5/releases)
- [Changelog](https://github.com/json5/json5/blob/main/CHANGELOG.md)
- [Commits](https://github.com/json5/json5/compare/v1.0.1...v1.0.2)

---
updated-dependencies:
- dependency-name: json5
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-01-06 22:36:14 +00:00
Max Swartwout
f08424cb81 Update build badge in README 2022-12-19 12:24:03 -05:00
maxswa
69088db3b6 v2.10.2 2022-12-15 23:24:59 +00:00
Max Swartwout
9cc89735cd Merge pull request #61 from maxswa/get-rsn-format-highlight-row
Fix `getRSNFormat`
2022-12-15 18:15:34 -05:00
Max Swartwout
a126ae4fc7 Merge pull request #58 from maxswa/dependabot/npm_and_yarn/minimatch-3.1.2
Bump minimatch from 3.0.4 to 3.1.2
2022-12-15 18:11:34 -05:00
Max Swartwout
52f3df1838 Merge pull request #59 from maxswa/dependabot/npm_and_yarn/qs-6.5.3
Bump qs from 6.5.2 to 6.5.3
2022-12-15 18:11:23 -05:00
maxswa
2891bbddc4 Fix getRSNFormat 2022-12-15 18:09:21 -05:00
dependabot[bot]
e2ea2fe33d Bump qs from 6.5.2 to 6.5.3
Bumps [qs](https://github.com/ljharb/qs) from 6.5.2 to 6.5.3.
- [Release notes](https://github.com/ljharb/qs/releases)
- [Changelog](https://github.com/ljharb/qs/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ljharb/qs/compare/v6.5.2...v6.5.3)

---
updated-dependencies:
- dependency-name: qs
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-12-09 06:28:03 +00:00
maxswa
b7ae812f45 v2.10.1 2022-12-04 14:17:36 -05:00
dependabot[bot]
240628d9cc Bump minimatch from 3.0.4 to 3.1.2
Bumps [minimatch](https://github.com/isaacs/minimatch) from 3.0.4 to 3.1.2.
- [Release notes](https://github.com/isaacs/minimatch/releases)
- [Changelog](https://github.com/isaacs/minimatch/blob/main/changelog.md)
- [Commits](https://github.com/isaacs/minimatch/compare/v3.0.4...v3.1.2)

---
updated-dependencies:
- dependency-name: minimatch
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-12-04 19:14:24 +00:00
Max Swartwout
b754663f6d Merge pull request #56 from APKiwi/main
Added "-" as a valid character in "getStats"
2022-12-04 14:13:51 -05:00
Max Swartwout
0678f7c979 Merge pull request #57 from maxswa/dependabot/npm_and_yarn/decode-uri-component-0.2.2
Bump decode-uri-component from 0.2.0 to 0.2.2
2022-12-04 14:13:27 -05:00
dependabot[bot]
2a60283a93 Bump decode-uri-component from 0.2.0 to 0.2.2
Bumps [decode-uri-component](https://github.com/SamVerschueren/decode-uri-component) from 0.2.0 to 0.2.2.
- [Release notes](https://github.com/SamVerschueren/decode-uri-component/releases)
- [Commits](https://github.com/SamVerschueren/decode-uri-component/compare/v0.2.0...v0.2.2)

---
updated-dependencies:
- dependency-name: decode-uri-component
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-12-03 13:49:33 +00:00
SirKhaoz
b912731cf9 Added "-" as a valid character in "getStats" 2022-11-04 21:56:39 +13:00
maxswa
cf44c57ec6 v2.10.0 2022-08-24 08:25:48 -04:00
Max Swartwout
3f34c9ab61 Merge pull request #55 from maxswa/toa
Add Tombs of Amascut.
2022-08-24 08:24:58 -04:00
maxswa
1ef73b6b0c Add Tombs of Amascut. 2022-08-24 07:48:05 -04:00
maxswa
08ecf68689 v2.9.0 2022-07-17 13:08:27 -04:00
Max Swartwout
ab3ee70237 Merge pull request #53 from maxswa/dependabot/npm_and_yarn/jsdom-16.5.0
Bump jsdom from 16.4.0 to 16.5.0
2022-07-17 13:06:51 -04:00
Max Swartwout
cad20d41cb Merge pull request #54 from davidvorona/pvp-arena
Add support for PvP Arena activity
2022-07-17 13:02:32 -04:00
David Vorona
2877b9c8a1 Add support for PvP Arena activity 2022-07-15 14:29:06 -07:00
dependabot[bot]
afbb22749a Bump jsdom from 16.4.0 to 16.5.0
Bumps [jsdom](https://github.com/jsdom/jsdom) from 16.4.0 to 16.5.0.
- [Release notes](https://github.com/jsdom/jsdom/releases)
- [Changelog](https://github.com/jsdom/jsdom/blob/master/Changelog.md)
- [Commits](https://github.com/jsdom/jsdom/compare/16.4.0...16.5.0)

---
updated-dependencies:
- dependency-name: jsdom
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-06-23 04:56:25 +00:00
maxswa
eebf76a34c v2.8.0 2022-04-18 15:50:35 -04:00
Max Swartwout
e60442a7ce Merge pull request #50 from maxswa/dependabot/npm_and_yarn/minimist-1.2.6
Bump minimist from 1.2.5 to 1.2.6
2022-04-18 15:47:45 -04:00
Max Swartwout
1132a085e1 Merge pull request #52 from molo-pl/main
Add support for Rifts Closed
2022-04-18 15:47:35 -04:00
molo-pl
a2a34a46e3 Add support for Rifts Closed 2022-04-15 11:30:56 +02:00
dependabot[bot]
71a76a12fd Bump minimist from 1.2.5 to 1.2.6
Bumps [minimist](https://github.com/substack/minimist) from 1.2.5 to 1.2.6.
- [Release notes](https://github.com/substack/minimist/releases)
- [Commits](https://github.com/substack/minimist/compare/1.2.5...1.2.6)

---
updated-dependencies:
- dependency-name: minimist
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-28 13:26:44 +00:00
Max Swartwout
3a72315498 Merge pull request #49 from maxswa/dependabot/npm_and_yarn/follow-redirects-1.14.8
Bump follow-redirects from 1.14.7 to 1.14.8
2022-02-15 14:37:28 -05:00
dependabot[bot]
c1c9833ad0 Bump follow-redirects from 1.14.7 to 1.14.8
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.7 to 1.14.8.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.14.7...v1.14.8)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-12 12:01:29 +00:00
Max Swartwout
9fe03746e1 Merge pull request #48 from maxswa/dependabot/npm_and_yarn/follow-redirects-1.14.7
Bump follow-redirects from 1.14.4 to 1.14.7
2022-01-18 10:42:22 -05:00
dependabot[bot]
66a4fb47a6 Bump follow-redirects from 1.14.4 to 1.14.7
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.4 to 1.14.7.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.14.4...v1.14.7)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-01-13 14:22:21 +00:00
Max Swartwout
83c44148a7 Merge pull request #47 from maxswa/fix-tests-nex
Fix tests
2022-01-05 21:54:48 -05:00
maxswa
44dea6b35c Add line for nex in lynxTitanStats.csv 2022-01-05 21:50:28 -05:00
maxswa
0bf491638c v2.7.0 2022-01-05 10:04:11 -05:00
Max Swartwout
febca534b0 Merge pull request #45 from maxswa/add-nex
Add Nex.
2022-01-05 09:57:56 -05:00
Max Swartwout
8daee5c39b Merge pull request #46 from molo-pl/main
Throw error for unknown hiscores CSV format
2022-01-05 09:52:42 -05:00
molo-pl
f98cf8aaaa Throw error for unknown hiscores CSV format 2022-01-04 23:05:34 +01:00
maxswa
5d9f6a6bac Add Nex. 2021-12-19 21:40:09 -05:00
Max Swartwout
8737b50a82 Merge pull request #44 from maxswa/dependabot/npm_and_yarn/axios-0.21.2
Bump axios from 0.21.1 to 0.21.2
2021-09-27 16:38:12 -04:00
dependabot[bot]
1255e7e3d2 Bump axios from 0.21.1 to 0.21.2
Bumps [axios](https://github.com/axios/axios) from 0.21.1 to 0.21.2.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/master/CHANGELOG.md)
- [Commits](https://github.com/axios/axios/compare/v0.21.1...v0.21.2)

---
updated-dependencies:
- dependency-name: axios
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-09-27 20:36:33 +00:00
Max Swartwout
f4135d0b0f Merge pull request #42 from maxswa/dependabot/npm_and_yarn/path-parse-1.0.7
Bump path-parse from 1.0.6 to 1.0.7
2021-09-27 16:36:09 -04:00
Max Swartwout
6135ff459c Merge pull request #43 from maxswa/dependabot/npm_and_yarn/tmpl-1.0.5
Bump tmpl from 1.0.4 to 1.0.5
2021-09-27 16:36:00 -04:00
dependabot[bot]
9fb7e4cebc Bump tmpl from 1.0.4 to 1.0.5
Bumps [tmpl](https://github.com/daaku/nodejs-tmpl) from 1.0.4 to 1.0.5.
- [Release notes](https://github.com/daaku/nodejs-tmpl/releases)
- [Commits](https://github.com/daaku/nodejs-tmpl/commits/v1.0.5)

---
updated-dependencies:
- dependency-name: tmpl
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-09-21 04:35:18 +00:00
dependabot[bot]
11350b2444 Bump path-parse from 1.0.6 to 1.0.7
Bumps [path-parse](https://github.com/jbgutierrez/path-parse) from 1.0.6 to 1.0.7.
- [Release notes](https://github.com/jbgutierrez/path-parse/releases)
- [Commits](https://github.com/jbgutierrez/path-parse/commits/v1.0.7)

---
updated-dependencies:
- dependency-name: path-parse
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-08-11 02:52:55 +00:00
maxswa
e0d6c5b20f v2.6.0 2021-07-02 10:53:19 -04:00
Max Swartwout
c8a4440ac3 Merge pull request #41 from Not-Jayden/phosanis-nightmare
New Boss: Phosani's Nightmare
2021-07-02 10:49:19 -04:00
Not-Jayden
f3781cf142 add to readme 2021-07-02 18:09:10 +08:00
Not-Jayden
5fbc04217b Merge branch 'phosanis-nightmare' of https://github.com/Not-Jayden/osrs-json-hiscores into phosanis-nightmare 2021-07-02 13:20:45 +08:00
Not-Jayden
eb5d0ba49f add to lynxTitanStats.csv 2021-07-02 13:20:33 +08:00
Not-Jayden
c68e3bebea Update __tests__/hiscores.test.ts 2021-07-02 13:13:07 +08:00
Not-Jayden
aa6fd6f39a add phosani's nightmare to api 2021-07-01 20:14:31 +08:00
maxswa
cc9aae8ced v2.5.2 2021-06-11 14:46:04 -04:00
Max Swartwout
12882b4e34 Merge pull request #37 from Not-Jayden/revert-seasonal-changes
[Bug] Remove conditional `seasonal` gameMode logic for bosses
2021-06-11 14:44:07 -04:00
Max Swartwout
b17a8b9299 Merge pull request #39 from maxswa/dependabot/npm_and_yarn/hosted-git-info-2.8.9
Bump hosted-git-info from 2.8.8 to 2.8.9
2021-06-11 14:42:54 -04:00
dependabot[bot]
50f2c19257 Bump hosted-git-info from 2.8.8 to 2.8.9
Bumps [hosted-git-info](https://github.com/npm/hosted-git-info) from 2.8.8 to 2.8.9.
- [Release notes](https://github.com/npm/hosted-git-info/releases)
- [Changelog](https://github.com/npm/hosted-git-info/blob/v2.8.9/CHANGELOG.md)
- [Commits](https://github.com/npm/hosted-git-info/compare/v2.8.8...v2.8.9)

---
updated-dependencies:
- dependency-name: hosted-git-info
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-11 18:40:53 +00:00
Max Swartwout
d892f8e67b Merge pull request #38 from maxswa/dependabot/npm_and_yarn/normalize-url-4.5.1
Bump normalize-url from 4.5.0 to 4.5.1
2021-06-11 14:39:31 -04:00
dependabot[bot]
af5664ae6e Bump normalize-url from 4.5.0 to 4.5.1
Bumps [normalize-url](https://github.com/sindresorhus/normalize-url) from 4.5.0 to 4.5.1.
- [Release notes](https://github.com/sindresorhus/normalize-url/releases)
- [Commits](https://github.com/sindresorhus/normalize-url/commits)

---
updated-dependencies:
- dependency-name: normalize-url
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-09 17:37:06 +00:00
NotJayden
20c5c2f730 delete seasonal changes 2021-06-10 00:15:11 +08:00
Max Swartwout
04e59cff04 Merge pull request #36 from maxswa/dependabot/npm_and_yarn/trim-newlines-3.0.1
Bump trim-newlines from 3.0.0 to 3.0.1
2021-06-08 17:14:27 -04:00
dependabot[bot]
ad2249ba76 Bump trim-newlines from 3.0.0 to 3.0.1
Bumps [trim-newlines](https://github.com/sindresorhus/trim-newlines) from 3.0.0 to 3.0.1.
- [Release notes](https://github.com/sindresorhus/trim-newlines/releases)
- [Commits](https://github.com/sindresorhus/trim-newlines/commits)

---
updated-dependencies:
- dependency-name: trim-newlines
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-08 21:11:36 +00:00
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
maxswa
592d82f86b v2.4.2 2021-05-10 23:37:48 -04:00
maxswa
a28a9e253e Replace watch package with tsc --watch 2021-05-10 23:34:46 -04:00
Max Swartwout
0bd15f2402 Merge pull request #30 from maxswa/dependabot/npm_and_yarn/lodash-4.17.21
Bump lodash from 4.17.20 to 4.17.21
2021-05-10 23:24:21 -04:00
dependabot[bot]
ed8ad51b4d Bump lodash from 4.17.20 to 4.17.21
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.20 to 4.17.21.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.20...4.17.21)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-11 03:22:49 +00:00
Max Swartwout
311ea88c61 Merge pull request #31 from maxswa/add-axios-test-mocks
Mock axios requests for tests.
2021-05-10 23:21:18 -04:00
maxswa
e056d052a5 Mock axios requests for tests. 2021-05-10 23:18:28 -04:00
maxswa
b230560442 v2.4.1 2021-05-01 14:41:39 -04:00
Max Swartwout
b2c6efecbd Merge pull request #29 from maxswa/rsn-hyphen
Fixes #28 Add hyphen to valid rsn regex.
2021-05-01 14:31:16 -04:00
maxswa
e9f47b9f08 Restrict GH workflow push builds to main 2021-05-01 14:22:41 -04:00
maxswa
3a6671d3d1 Fix expected test result, typo. 2021-05-01 14:16:38 -04:00
maxswa
a4065022d6 Add hyphen to valid rsn regex. 2021-05-01 14:09:08 -04:00
maxswa
163f4dd184 Fix test script. 2021-03-25 00:59:18 -04:00
maxswa
e200a8d566 Add lint and format to github workflow. 2021-03-25 00:55:34 -04:00
maxswa
89944ca8cc Add jsdoc to hiscores and helper functions. 2021-03-25 00:53:50 -04:00
maxswa
29c76b4afb Add husky, lint-staged and set up pre-commit hook. 2021-03-25 00:53:25 -04:00
maxswa
e3e904a23f Swap tslint for eslint. 2021-03-25 00:20:02 -04:00
maxswa
0b96530a8e Add license file. 2021-03-25 00:10:43 -04:00
maxswa
175f945ab8 v2.4.0 2021-03-24 22:49:58 -04:00
maxswa
6b31e8b08c Add Tempoross to boss list. 2021-03-24 22:46:37 -04:00
maxswa
d097567a3c v2.3.2 2021-02-13 11:22:26 -05:00
maxswa
be5c093cf7 Downgrade np. 2021-02-13 11:13:52 -05:00
maxswa
db72f0c57d Bump np. 2021-02-13 11:08:57 -05:00
Max Swartwout
bd2ea21980 Merge pull request #26 from maxswa/bh-order-fix
Fixes #25 Flipped BH modes.
2021-02-13 11:07:27 -05:00
maxswa
d67837c161 Fix flipped BH modes. 2021-02-13 10:50:58 -05:00
Max Swartwout
4aa6ad2752 Add github action. 2021-02-13 10:48:31 -05:00
maxswa
2f788fabf6 v2.3.1 2021-01-12 19:56:17 -05:00
maxswa
0f5aea795c Upgrade dependencies. 2021-01-12 19:55:36 -05:00
Max Swartwout
7acb84e310 Merge pull request #21 from maxswa/dependabot/npm_and_yarn/dot-prop-4.2.1
Bump dot-prop from 4.2.0 to 4.2.1
2021-01-12 19:48:41 -05:00
Max Swartwout
9619bd2a2b Merge pull request #23 from molo-pl/master
Fixes #22 adding User-Agent request header to bypass Incapsula
2021-01-12 19:48:29 -05:00
molo-pl
55abd9f800 Fixes #22 adding User-Agent request header - post review changes 2021-01-12 23:29:25 +01:00
molo-pl
cf8a4cc26e Fixes #22 adding User-Agent request header to bypass Incapsula protection of OSRS hiscore pages 2021-01-12 16:05:47 +01:00
dependabot[bot]
ae47df31f1 Bump dot-prop from 4.2.0 to 4.2.1
Bumps [dot-prop](https://github.com/sindresorhus/dot-prop) from 4.2.0 to 4.2.1.
- [Release notes](https://github.com/sindresorhus/dot-prop/releases)
- [Commits](https://github.com/sindresorhus/dot-prop/compare/v4.2.0...v4.2.1)

Signed-off-by: dependabot[bot] <support@github.com>
2021-01-10 21:00:31 +00:00
24 changed files with 9053 additions and 3623 deletions

1
.gitattributes vendored Normal file
View File

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

28
.github/workflows/main.yml vendored Normal file
View File

@@ -0,0 +1,28 @@
name: CI
on:
push:
branches:
- main
pull_request:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3.3.0
- uses: borales/actions-yarn@v4.2.0
with:
cmd: install
- uses: borales/actions-yarn@v4.2.0
with:
cmd: lint
- uses: borales/actions-yarn@v4.2.0
with:
cmd: format
- uses: borales/actions-yarn@v4.2.0
with:
cmd: build
- uses: borales/actions-yarn@v4.2.0
with:
cmd: test

3
.gitignore vendored
View File

@@ -1,3 +1,4 @@
.idea/ .idea/
node_modules node_modules
/lib /lib
.vscode

View File

@@ -1,6 +0,0 @@
{
"trailingComma": "es5",
"tabWidth": 2,
"semi": true,
"singleQuote": true
}

5
LICENSE Normal file
View File

@@ -0,0 +1,5 @@
Copyright 2021 maxswa
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

187
README.md
View File

@@ -3,23 +3,26 @@
[![npm](https://img.shields.io/npm/v/osrs-json-hiscores.svg?style=flat-square)](https://www.npmjs.com/package/osrs-json-hiscores) [![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) [![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) [![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/actions/workflow/status/maxswa/osrs-json-hiscores/main.yml?style=flat-square&branch=main)](https://github.com/maxswa/osrs-json-hiscores/actions/workflows/main.yml?query=branch%3Amain)
**The Oldschool Runescape API wrapper that does more!** **The Old School RuneScape API wrapper that does more!**
## What it does ## What it does
The official hiscores API for Oldschool Runescape (OSRS) returns CSV. The official hiscores API for Old School RuneScape (OSRS) can return CSV or a simple JSON array.
This wrapper converts it to json and provides extra information about the given player. By comparing player info it infers the player's game mode, as well as any previous modes (de-ultimated, de-ironed and/or died as a hardcore ironman). This wrapper converts the hiscores data into a more usable JSON object and provides extra information about the given player. By comparing player info it infers the player's game mode, as well as any previous modes (de-ultimated, de-ironed and/or died as a hardcore ironman).
Additional functions are provided that screen-scrape the OSRS leaderboards and return a list of players as json. Additional functions are provided that screen-scrape the OSRS leaderboards and return a list of players as json. Also simple utility functions are provided to fetch the raw responses from Jagex's APIs, if desired.
`osrs-json-hiscores` has TypeScript support, with full definitions for all functions and custom data types. `osrs-json-hiscores` has TypeScript support, with full definitions for all functions and custom data types.
--- ---
### Disclaimer ### Disclaimer
Jagex does not provide `Access-Control-Allow-Origin` headers in their responses. This means that [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) will block all browser requests to their hiscores API. In order to get around this, osrs-json-hiscores should be installed on the server side and exposed to the front end via a simple API. Here is an example of this in use: [codesandbox.io/s/osrs-json-hiscores-demo](https://codesandbox.io/s/osrs-json-hiscores-demo-qz656) Jagex does not provide `Access-Control-Allow-Origin` headers in their responses. This means that [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) will block all browser requests to their hiscores API. In order to get around this, osrs-json-hiscores needs to be installed on the server side and exposed to the front end via a simple API. Here is an example of this in use: [codesandbox.io/s/osrs-json-hiscores-demo](https://codesandbox.io/s/osrs-json-hiscores-demo-qz656)
TLDR: You cannot use this library directly in your client side app e.g. React or Vue, you must set up a server which uses this lib internally and have your client fetch data from your server.
--- ---
@@ -41,27 +44,14 @@ $ yarn add osrs-json-hiscores
Install the package and then import it into your project: Install the package and then import it into your project:
```javascript ```typescript
const hiscores = require('osrs-json-hiscores'); import { getStatsByGamemode, getSkillPage } from 'osrs-json-hiscores';
``` ```
Once you import it you can call the functions asynchronously: Once you import it you can call the functions asynchronously:
```javascript ```typescript
hiscores const stats = await getStatsByGamemode('Lynx Titan');
.getStats('Lynx Titan')
.then(res => console.log(res))
.catch(err => console.error(err));
```
If you are using TypeScript or transpiling your JS you can use ES6 syntax:
```javascript
import hiscores, { getSkillPage } from 'osrs-json-hiscores';
// ...
const stats = await hiscores.getStats('Lynx Titan');
const topPage = await getSkillPage('overall'); const topPage = await getSkillPage('overall');
``` ```
@@ -80,11 +70,10 @@ const topPage = await getSkillPage('overall');
`getSkillPage` and `getActivityPage` require a skill / activity and optionally a gamemode and page: `getSkillPage` and `getActivityPage` require a skill / activity and optionally a gamemode and page:
```javascript ```typescript
hiscores getSkillPage('attack', 'main', 1)
.getSkillPage('attack', 'main', 1) .then((res) => console.log(res))
.then(res => console.log(res)) .catch((err) => console.error(err));
.catch(err => console.error(err));
``` ```
Activities consist of all levels of clue scrolls as well as minigames and bosses: Activities consist of all levels of clue scrolls as well as minigames and bosses:
@@ -103,73 +92,93 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
### Minigames ### Minigames
| Minigame | Param | | Minigame | Param |
| ---------------------- | :---------------: | | ------------------------------- | :---------------: |
| Bounty Hunter (Rogue) | `rogueBH` | | Bounty Hunter (Legacy - Rogue) | `rogueBH` |
| Bounty Hunter (Hunter) | `hunterBH` | | Bounty Hunter (Legacy - Hunter) | `hunterBH` |
| Last Man Standing | `lastManStanding` | | Bounty Hunter (Rogue) | `rogueBHV2` |
| Soul Wars Zeal | `soulWarsZeal` | | Bounty Hunter (Hunter) | `hunterBHV2` |
| LMS - Rank | `lastManStanding` |
| PvP Arena - Rank | `pvpArena` |
| Soul Wars Zeal | `soulWarsZeal` |
| Rifts closed | `riftsClosed` |
### Leagues ### Points
| Activity | Param | | Activity | Param |
| ------------- | :------------: | | -------------- | :-------------: |
| League Points | `leaguePoints` | | League Points | `leaguePoints` |
| Deadman Points | `deadmanPoints` |
### Bosses ### Bosses
| Boss Name | Param | | Boss Name | Param |
| -------------------------------- | :----------------------------: | | --------------------------------- | :----------------------------: |
| Abyssal Sire | `abyssalSire` | | Abyssal Sire | `abyssalSire` |
| Alchemical Hydra | `alchemicalHydra` | | Alchemical Hydra | `alchemicalHydra` |
| Barrows Chests | `barrows` | | Artio | `artio` |
| Bryophyta | `bryophyta` | | Barrows Chests | `barrows` |
| Callisto | `callisto` | | Bryophyta | `bryophyta` |
| Cerberus | `cerberus` | | Callisto | `callisto` |
| Chambers Of Xeric | `chambersOfXeric` | | Calvar'ion | `calvarion` |
| Chambers Of Xeric Challenge Mode | `chambersOfXericChallengeMode` | | Cerberus | `cerberus` |
| Chaos Elemental | `chaosElemental` | | Chambers Of Xeric | `chambersOfXeric` |
| Chaos Fanatic | `chaosFanatic` | | Chambers Of Xeric: Challenge Mode | `chambersOfXericChallengeMode` |
| Commander Zilyana | `commanderZilyana` | | Chaos Elemental | `chaosElemental` |
| Corporeal Beast | `corporealBeast` | | Chaos Fanatic | `chaosFanatic` |
| Crazy Archaeologist | `crazyArchaeologist` | | Commander Zilyana | `commanderZilyana` |
| Dagannoth Prime | `dagannothPrime` | | Corporeal Beast | `corporealBeast` |
| Dagannoth Rex | `dagannothRex` | | Crazy Archaeologist | `crazyArchaeologist` |
| Dagannoth Supreme | `dagannothSupreme` | | Dagannoth Prime | `dagannothPrime` |
| Deranged Archaeologist | `derangedArchaeologist` | | Dagannoth Rex | `dagannothRex` |
| General Graardor | `generalGraardor` | | Dagannoth Supreme | `dagannothSupreme` |
| Giant Mole | `giantMole` | | Deranged Archaeologist | `derangedArchaeologist` |
| Grotesque Guardians | `grotesqueGuardians` | | Duke Sucellus | `dukeSucellus` |
| Hespori | `hespori` | | General Graardor | `generalGraardor` |
| Kalphite Queen | `kalphiteQueen` | | Giant Mole | `giantMole` |
| King Black Dragon | `kingBlackDragon` | | Grotesque Guardians | `grotesqueGuardians` |
| Kraken | `kraken` | | Hespori | `hespori` |
| Kreearra | `kreeArra` | | Kalphite Queen | `kalphiteQueen` |
| K'ril Tsutsaroth | `krilTsutsaroth` | | King Black Dragon | `kingBlackDragon` |
| Mimic | `mimic` | | Kraken | `kraken` |
| The Nightmare of Ashihama | `nightmare` | | Kreearra | `kreeArra` |
| Obor | `obor` | | K'ril Tsutsaroth | `krilTsutsaroth` |
| Sarachnis | `sarachnis` | | Mimic | `mimic` |
| Scorpia | `scorpia` | | Nex | `nex` |
| Skotizo | `skotizo` | | Nightmare | `nightmare` |
| Gauntlet | `gauntlet` | | Phosani's Nightmare | `phosanisNightmare` |
| Corrupted Gauntlet | `corruptedGauntlet` | | Obor | `obor` |
| Theatre Of Blood | `theatreOfBlood` | | Phantom Muspah | `phantomMuspah` |
| Thermonuclear Smoke Devil | `thermonuclearSmokeDevil` | | Sarachnis | `sarachnis` |
| TzKal-Zuk | `tzKalZuk` | | Scorpia | `scorpia` |
| TzTok-Jad | `tzTokJad` | | Scurrius | `scurrius` |
| Venenatis | `venenatis` | | Skotizo | `skotizo` |
| Vetion | `vetion` | | Spindel | `spindel` |
| Vorkath | `vorkath` | | Tempoross | `tempoross` |
| Wintertodt | `wintertodt` | | The Gauntlet | `gauntlet` |
| Zalcano | `zalcano` | | The Corrupted Gauntlet | `corruptedGauntlet` |
| Zulrah | `zulrah` | | The Leviathan | `leviathan` |
| The Whisperer | `whisperer` |
| Theatre Of Blood | `theatreOfBlood` |
| Theatre Of Blood: Hard Mode | `theatreOfBloodHardMode` |
| Thermonuclear Smoke Devil | `thermonuclearSmokeDevil` |
| Tombs of Amascut | `tombsOfAmascut` |
| Tombs of Amascut: Expert Mode | `tombsOfAmascutExpertMode` |
| TzKal-Zuk | `tzKalZuk` |
| TzTok-Jad | `tzTokJad` |
| Vardorvis | `vardorvis` |
| Venenatis | `venenatis` |
| Vetion | `vetion` |
| Vorkath | `vorkath` |
| Wintertodt | `wintertodt` |
| Zalcano | `zalcano` |
| Zulrah | `zulrah` |
## What you'll get ## What you'll get
`getStats` returns a player object that looks like this: `getStats` returns a player object that looks like this:
```javascript ```typescript
{ {
name: 'Lynx Titan', name: 'Lynx Titan',
mode: 'main', mode: 'main',
@@ -187,7 +196,9 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
leaguePoints: {}, leaguePoints: {},
bountyHunter: {}, bountyHunter: {},
lastManStanding: {}, lastManStanding: {},
pvpArena: {},
soulWarsZeal: {}, soulWarsZeal: {},
riftsClosed: {},
bosses: {} bosses: {}
} }
} }
@@ -195,11 +206,11 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
`getSkillPage` returns and array of 25 players (This represents a page on the hiscores): `getSkillPage` returns and array of 25 players (This represents a page on the hiscores):
```javascript ```typescript
[ [
{ rank: 1, name: 'Lynx Titan', level: 2277, xp: 4600000000, dead: false }, { rank: 1, name: 'Lynx Titan', level: 2277, xp: 4600000000, dead: false },
{}, {},
{}, {}
// ... // ...
]; ];
``` ```
@@ -208,7 +219,7 @@ Activities consist of all levels of clue scrolls as well as minigames and bosses
Get the properly formatted name of any skill, boss, clue or other activity: Get the properly formatted name of any skill, boss, clue or other activity:
```javascript ```typescript
// kril === "K'ril Tsutsaroth" // kril === "K'ril Tsutsaroth"
const kril = FORMATTED_BOSS_NAMES['krilTsutsaroth']; const kril = FORMATTED_BOSS_NAMES['krilTsutsaroth'];
``` ```

1192
__tests__/attackTopPage.html vendored Normal file

File diff suppressed because it is too large Load Diff

1188
__tests__/b0atyNamePage.html vendored Normal file

File diff suppressed because it is too large Load Diff

100
__tests__/b0atyStats.csv Normal file
View File

@@ -0,0 +1,100 @@
3745,2277,840426611
24080,99,30276246
9559,99,31228199
2212,99,143599407
3550,99,123248914
6564,99,109953707
4244,99,15144846
4107,99,57072224
135556,99,13353511
25855,99,16903268
53472,99,13456850
22453,99,16654917
17690,99,19118307
45816,99,14059776
10409,99,16530015
27702,99,14765145
39430,99,13235063
6722,99,15754877
51813,99,14023027
5324,99,33835543
3154,99,69527777
4719,99,22733384
15135,99,17952893
1089,99,17998715
-1,-1
-1,-1
26164,10
12886,3
148658,8
103161,7
377,9556
862,825
148,6000
2153,1606
42107,298
504,459
1816,368
14701,2521
-1,-1
6776,14780
4773,1060
2741,2192
90203,594
29573,143
3668,1830
206778,5
32897,293
64112,58
18492,1905
178941,34
2379,501
82902,50
147358,26
51973,287
2377,2000
147406,41
32225,707
42229,698
32212,714
79605,25
9517,688
19125,1228
65849,474
2080,2140
16433,182
2006,2046
48575,580
115056,1908
10406,920
2196,1444
1005,33
28413,620
4157,744
4261,500
993,217
21848,251
66260,119
108898,26
23958,90
373975,9
2005,1569
40001,273
192608,7
78367,201
5679,583
478,1760
22932,250
15059,7
7161,3066
101555,35
610,933
15733,2
-1,-1
2051,2078
194,7096
69260,51
14039,2780
876367,62
165341,25
226318,275
Can't render this file because it has a wrong number of fields in line 25.

202
__tests__/b0atyStats.json Normal file
View File

@@ -0,0 +1,202 @@
{
"skills": [
{
"id": 0,
"name": "Overall",
"rank": 3745,
"level": 2277,
"xp": 840426611
},
{ "id": 1, "name": "Attack", "rank": 24080, "level": 99, "xp": 30276246 },
{ "id": 2, "name": "Defence", "rank": 9559, "level": 99, "xp": 31228199 },
{ "id": 3, "name": "Strength", "rank": 2212, "level": 99, "xp": 143599407 },
{
"id": 4,
"name": "Hitpoints",
"rank": 3550,
"level": 99,
"xp": 123248914
},
{ "id": 5, "name": "Ranged", "rank": 6564, "level": 99, "xp": 109953707 },
{ "id": 6, "name": "Prayer", "rank": 4244, "level": 99, "xp": 15144846 },
{ "id": 7, "name": "Magic", "rank": 4107, "level": 99, "xp": 57072224 },
{ "id": 8, "name": "Cooking", "rank": 135556, "level": 99, "xp": 13353511 },
{
"id": 9,
"name": "Woodcutting",
"rank": 25855,
"level": 99,
"xp": 16903268
},
{
"id": 10,
"name": "Fletching",
"rank": 53472,
"level": 99,
"xp": 13456850
},
{ "id": 11, "name": "Fishing", "rank": 22453, "level": 99, "xp": 16654917 },
{
"id": 12,
"name": "Firemaking",
"rank": 17690,
"level": 99,
"xp": 19118307
},
{
"id": 13,
"name": "Crafting",
"rank": 45816,
"level": 99,
"xp": 14059776
},
{
"id": 14,
"name": "Smithing",
"rank": 10409,
"level": 99,
"xp": 16530015
},
{ "id": 15, "name": "Mining", "rank": 27702, "level": 99, "xp": 14765145 },
{
"id": 16,
"name": "Herblore",
"rank": 39430,
"level": 99,
"xp": 13235063
},
{ "id": 17, "name": "Agility", "rank": 6722, "level": 99, "xp": 15754877 },
{
"id": 18,
"name": "Thieving",
"rank": 51813,
"level": 99,
"xp": 14023027
},
{ "id": 19, "name": "Slayer", "rank": 5324, "level": 99, "xp": 33835543 },
{ "id": 20, "name": "Farming", "rank": 3154, "level": 99, "xp": 69527777 },
{
"id": 21,
"name": "Runecraft",
"rank": 4719,
"level": 99,
"xp": 22733384
},
{ "id": 22, "name": "Hunter", "rank": 15135, "level": 99, "xp": 17952893 },
{
"id": 23,
"name": "Construction",
"rank": 1089,
"level": 99,
"xp": 17998715
}
],
"activities": [
{ "id": 0, "name": "League Points", "rank": -1, "score": -1 },
{ "id": 1, "name": "Deadman Points", "rank": -1, "score": -1 },
{ "id": 2, "name": "Bounty Hunter - Hunter", "rank": 26164, "score": 10 },
{ "id": 3, "name": "Bounty Hunter - Rogue", "rank": 12886, "score": 3 },
{
"id": 4,
"name": "Bounty Hunter (Legacy) - Hunter",
"rank": 148658,
"score": 8
},
{
"id": 5,
"name": "Bounty Hunter (Legacy) - Rogue",
"rank": 103161,
"score": 7
},
{ "id": 6, "name": "Clue Scrolls (all)", "rank": 377, "score": 9556 },
{ "id": 7, "name": "Clue Scrolls (beginner)", "rank": 862, "score": 825 },
{ "id": 8, "name": "Clue Scrolls (easy)", "rank": 148, "score": 6000 },
{ "id": 9, "name": "Clue Scrolls (medium)", "rank": 2153, "score": 1606 },
{ "id": 10, "name": "Clue Scrolls (hard)", "rank": 42107, "score": 298 },
{ "id": 11, "name": "Clue Scrolls (elite)", "rank": 504, "score": 459 },
{ "id": 12, "name": "Clue Scrolls (master)", "rank": 1816, "score": 368 },
{ "id": 13, "name": "LMS - Rank", "rank": 14701, "score": 2521 },
{ "id": 14, "name": "PvP Arena - Rank", "rank": -1, "score": -1 },
{ "id": 15, "name": "Soul Wars Zeal", "rank": 6776, "score": 14780 },
{ "id": 16, "name": "Rifts closed", "rank": 4773, "score": 1060 },
{ "id": 17, "name": "Abyssal Sire", "rank": 2741, "score": 2192 },
{ "id": 18, "name": "Alchemical Hydra", "rank": 90203, "score": 594 },
{ "id": 19, "name": "Artio", "rank": 29573, "score": 143 },
{ "id": 20, "name": "Barrows Chests", "rank": 3668, "score": 1830 },
{ "id": 21, "name": "Bryophyta", "rank": 206778, "score": 5 },
{ "id": 22, "name": "Callisto", "rank": 32897, "score": 293 },
{ "id": 23, "name": "Calvar'ion", "rank": 64112, "score": 58 },
{ "id": 24, "name": "Cerberus", "rank": 18492, "score": 1905 },
{ "id": 25, "name": "Chambers of Xeric", "rank": 178941, "score": 34 },
{
"id": 26,
"name": "Chambers of Xeric: Challenge Mode",
"rank": 2379,
"score": 501
},
{ "id": 27, "name": "Chaos Elemental", "rank": 82902, "score": 50 },
{ "id": 28, "name": "Chaos Fanatic", "rank": 147358, "score": 26 },
{ "id": 29, "name": "Commander Zilyana", "rank": 51973, "score": 287 },
{ "id": 30, "name": "Corporeal Beast", "rank": 2377, "score": 2000 },
{ "id": 31, "name": "Crazy Archaeologist", "rank": 147406, "score": 41 },
{ "id": 32, "name": "Dagannoth Prime", "rank": 32225, "score": 707 },
{ "id": 33, "name": "Dagannoth Rex", "rank": 42229, "score": 698 },
{ "id": 34, "name": "Dagannoth Supreme", "rank": 32212, "score": 714 },
{ "id": 35, "name": "Deranged Archaeologist", "rank": 79605, "score": 25 },
{ "id": 36, "name": "Duke Sucellus", "rank": 9517, "score": 688 },
{ "id": 37, "name": "General Graardor", "rank": 19125, "score": 1228 },
{ "id": 38, "name": "Giant Mole", "rank": 65849, "score": 474 },
{ "id": 39, "name": "Grotesque Guardians", "rank": 2080, "score": 2140 },
{ "id": 40, "name": "Hespori", "rank": 16433, "score": 182 },
{ "id": 41, "name": "Kalphite Queen", "rank": 2006, "score": 2046 },
{ "id": 42, "name": "King Black Dragon", "rank": 48575, "score": 580 },
{ "id": 43, "name": "Kraken", "rank": 115056, "score": 1908 },
{ "id": 44, "name": "Kree'Arra", "rank": 10406, "score": 920 },
{ "id": 45, "name": "K'ril Tsutsaroth", "rank": 2196, "score": 1444 },
{ "id": 46, "name": "Mimic", "rank": 1005, "score": 33 },
{ "id": 47, "name": "Nex", "rank": 28413, "score": 620 },
{ "id": 48, "name": "Nightmare", "rank": 4157, "score": 744 },
{ "id": 49, "name": "Phosani's Nightmare", "rank": 4261, "score": 500 },
{ "id": 50, "name": "Obor", "rank": 993, "score": 217 },
{ "id": 51, "name": "Phantom Muspah", "rank": 21848, "score": 251 },
{ "id": 52, "name": "Sarachnis", "rank": 66260, "score": 119 },
{ "id": 53, "name": "Scorpia", "rank": 108898, "score": 26 },
{ "id": 54, "name": "Scurrius", "rank": 23958, "score": 90 },
{ "id": 55, "name": "Skotizo", "rank": 373975, "score": 9 },
{ "id": 56, "name": "Spindel", "rank": 2005, "score": 1569 },
{ "id": 57, "name": "Tempoross", "rank": 40001, "score": 273 },
{ "id": 58, "name": "The Gauntlet", "rank": 192608, "score": 7 },
{ "id": 59, "name": "The Corrupted Gauntlet", "rank": 78367, "score": 201 },
{ "id": 60, "name": "The Leviathan", "rank": 5679, "score": 583 },
{ "id": 61, "name": "The Whisperer", "rank": 478, "score": 1760 },
{ "id": 62, "name": "Theatre of Blood", "rank": 22932, "score": 250 },
{
"id": 63,
"name": "Theatre of Blood: Hard Mode",
"rank": 15059,
"score": 7
},
{
"id": 64,
"name": "Thermonuclear Smoke Devil",
"rank": 7161,
"score": 3066
},
{ "id": 65, "name": "Tombs of Amascut", "rank": 101555, "score": 35 },
{
"id": 66,
"name": "Tombs of Amascut: Expert Mode",
"rank": 610,
"score": 933
},
{ "id": 67, "name": "TzKal-Zuk", "rank": 15733, "score": 2 },
{ "id": 68, "name": "TzTok-Jad", "rank": -1, "score": -1 },
{ "id": 69, "name": "Vardorvis", "rank": 2051, "score": 2078 },
{ "id": 70, "name": "Venenatis", "rank": 194, "score": 7096 },
{ "id": 71, "name": "Vet'ion", "rank": 69260, "score": 51 },
{ "id": 72, "name": "Vorkath", "rank": 14039, "score": 2780 },
{ "id": 73, "name": "Wintertodt", "rank": 876367, "score": 62 },
{ "id": 74, "name": "Zalcano", "rank": 165341, "score": 25 },
{ "id": 75, "name": "Zulrah", "rank": 226318, "score": 275 }
]
}

View File

@@ -1,3 +1,6 @@
import axios from 'axios';
import { readFileSync } from 'fs';
import { import {
parseStats, parseStats,
getSkillPage, getSkillPage,
@@ -5,8 +8,58 @@ import {
getStatsByGamemode, getStatsByGamemode,
getRSNFormat, getRSNFormat,
Stats, Stats,
getPlayerTableURL,
getSkillPageURL,
getStatsURL,
BOSSES,
InvalidFormatError,
BH_MODES,
parseJsonStats,
HiscoresResponse
} from '../src/index'; } from '../src/index';
const B0ATY_NAME = 'B0ATY';
const B0ATY_FORMATTED_NAME = 'B0aty';
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 attackTopPage = readFileSync(`${__dirname}/attackTopPage.html`, 'utf8');
const b0atyNamePage = readFileSync(`${__dirname}/b0atyNamePage.html`, 'utf8');
const b0atyStatsCsv = readFileSync(`${__dirname}/b0atyStats.csv`, 'utf8');
const b0atyStatsJson: HiscoresResponse = JSON.parse(
readFileSync(`${__dirname}/b0atyStats.json`, 'utf8')
);
const lynxTitanStats = JSON.parse(
readFileSync(`${__dirname}/lynxTitanStats.json`, 'utf8')
);
const lynxTitanNamePage = readFileSync(
`${__dirname}/lynxTitanNamePage.html`,
'utf8'
);
jest.spyOn(axios, 'get').mockImplementation((url) => {
const lynxUrls = [
getPlayerTableURL('main', LYNX_TITAN_SPACE_NAME),
getPlayerTableURL('main', LYNX_TITAN_UNDERSCORE_NAME),
getPlayerTableURL('main', LYNX_TITAN_HYPHEN_NAME)
];
if (lynxUrls.includes(url)) {
return Promise.resolve({ data: lynxTitanNamePage });
}
if (getPlayerTableURL('main', B0ATY_NAME) === url) {
return Promise.resolve({ data: b0atyNamePage });
}
if (getSkillPageURL('main', 'attack', 1) === url) {
return Promise.resolve({ data: attackTopPage });
}
if (getStatsURL('main', LYNX_TITAN_FORMATTED_NAME, true) === url) {
return Promise.resolve({ status: 200, data: lynxTitanStats });
}
throw new Error(`No mock response for URL: ${url}`);
});
test('Parse CSV to json', () => { test('Parse CSV to json', () => {
const csv = `246,2277,1338203419 const csv = `246,2277,1338203419
615,99,77438259 615,99,77438259
@@ -32,9 +85,12 @@ test('Parse CSV to json', () => {
169,99,43127930 169,99,43127930
810,99,37688883 810,99,37688883
92,99,32005622 92,99,32005622
-1,-1 23423,478
-1,-1 89554,301
-1,-1 89914,35
99834,25
99831,23
89912,37
32,12148 32,12148
3105,76 3105,76
1997,505 1997,505
@@ -43,12 +99,16 @@ test('Parse CSV to json', () => {
392,250 392,250
1,6143 1,6143
4814,898 4814,898
13,4057
37,225 37,225
25,1110
382,2780 382,2780
944,3000 944,3000
704,892
1981,1452 1981,1452
4981,23 4981,23
888,1046 888,1046
444,792
613,4856 613,4856
102,4038 102,4038
156,334 156,334
@@ -61,6 +121,7 @@ test('Parse CSV to json', () => {
4342,1655 4342,1655
966,2951 966,2951
10151,1 10151,1
1289,2477
1288,2407 1288,2407
377,4669 377,4669
545,1567 545,1567
@@ -71,17 +132,29 @@ test('Parse CSV to json', () => {
625,2391 625,2391
120,2981 120,2981
1,109 1,109
99,39002
3,22666 3,22666
2,84
26,323 26,323
44,6233
201,1101 201,1101
82,3404 82,3404
555,7079
5085,61 5085,61
678,903
18823,23
63,375 63,375
2870,6 2870,6
2871,7
2872,8
6984,138 6984,138
23,923141
4043,2000 4043,2000
4073,1020
289,13070
489,8 489,8
967,47 967,47
968,48
11155,223 11155,223
1940,272 1940,272
8623,1340 8623,1340
@@ -114,15 +187,20 @@ test('Parse CSV to json', () => {
farming: { rank: 821, level: 99, xp: 62123353 }, farming: { rank: 821, level: 99, xp: 62123353 },
runecraft: { rank: 169, level: 99, xp: 43127930 }, runecraft: { rank: 169, level: 99, xp: 43127930 },
hunter: { rank: 810, level: 99, xp: 37688883 }, hunter: { rank: 810, level: 99, xp: 37688883 },
construction: { rank: 92, level: 99, xp: 32005622 }, construction: { rank: 92, level: 99, xp: 32005622 }
}, },
leaguePoints: { rank: -1, score: -1 }, leaguePoints: { rank: 23423, score: 478 },
deadmanPoints: { rank: 89554, score: 301 },
bountyHunter: { bountyHunter: {
rogue: { rank: -1, score: -1 }, hunterV2: { rank: 89914, score: 35 },
hunter: { rank: -1, score: -1 }, rogueV2: { rank: 99834, score: 25 },
hunter: { rank: 99831, score: 23 },
rogue: { rank: 89912, score: 37 }
}, },
lastManStanding: { rank: 4814, score: 898 }, lastManStanding: { rank: 4814, score: 898 },
pvpArena: { rank: 13, score: 4057 },
soulWarsZeal: { rank: 37, score: 225 }, soulWarsZeal: { rank: 37, score: 225 },
riftsClosed: { rank: 25, score: 1110 },
clues: { clues: {
all: { rank: 32, score: 12148 }, all: { rank: 32, score: 12148 },
beginner: { rank: 3105, score: 76 }, beginner: { rank: 3105, score: 76 },
@@ -130,14 +208,16 @@ test('Parse CSV to json', () => {
medium: { rank: 127, score: 4259 }, medium: { rank: 127, score: 4259 },
hard: { rank: 361, score: 915 }, hard: { rank: 361, score: 915 },
elite: { rank: 392, score: 250 }, elite: { rank: 392, score: 250 },
master: { rank: 1, score: 6143 }, master: { rank: 1, score: 6143 }
}, },
bosses: { bosses: {
abyssalSire: { rank: 382, score: 2780 }, abyssalSire: { rank: 382, score: 2780 },
alchemicalHydra: { rank: 944, score: 3000 }, alchemicalHydra: { rank: 944, score: 3000 },
artio: { rank: 704, score: 892 },
barrows: { rank: 1981, score: 1452 }, barrows: { rank: 1981, score: 1452 },
bryophyta: { rank: 4981, score: 23 }, bryophyta: { rank: 4981, score: 23 },
callisto: { rank: 888, score: 1046 }, callisto: { rank: 888, score: 1046 },
calvarion: { rank: 444, score: 792 },
cerberus: { rank: 613, score: 4856 }, cerberus: { rank: 613, score: 4856 },
chambersOfXeric: { rank: 102, score: 4038 }, chambersOfXeric: { rank: 102, score: 4038 },
chambersOfXericChallengeMode: { rank: 156, score: 334 }, chambersOfXericChallengeMode: { rank: 156, score: 334 },
@@ -150,6 +230,7 @@ test('Parse CSV to json', () => {
dagannothRex: { rank: 4342, score: 1655 }, dagannothRex: { rank: 4342, score: 1655 },
dagannothSupreme: { rank: 966, score: 2951 }, dagannothSupreme: { rank: 966, score: 2951 },
derangedArchaeologist: { rank: 10151, score: 1 }, derangedArchaeologist: { rank: 10151, score: 1 },
dukeSucellus: { rank: 1289, score: 2477 },
generalGraardor: { rank: 1288, score: 2407 }, generalGraardor: { rank: 1288, score: 2407 },
giantMole: { rank: 377, score: 4669 }, giantMole: { rank: 377, score: 4669 },
grotesqueGuardians: { rank: 545, score: 1567 }, grotesqueGuardians: { rank: 545, score: 1567 },
@@ -160,37 +241,76 @@ test('Parse CSV to json', () => {
kreeArra: { rank: 625, score: 2391 }, kreeArra: { rank: 625, score: 2391 },
krilTsutsaroth: { rank: 120, score: 2981 }, krilTsutsaroth: { rank: 120, score: 2981 },
mimic: { rank: 1, score: 109 }, mimic: { rank: 1, score: 109 },
nex: { rank: 99, score: 39002 },
nightmare: { rank: 3, score: 22666 }, nightmare: { rank: 3, score: 22666 },
phosanisNightmare: { rank: 2, score: 84 },
obor: { rank: 26, score: 323 }, obor: { rank: 26, score: 323 },
phantomMuspah: { rank: 44, score: 6233 },
sarachnis: { rank: 201, score: 1101 }, sarachnis: { rank: 201, score: 1101 },
scorpia: { rank: 82, score: 3404 }, scorpia: { rank: 82, score: 3404 },
scurrius: { rank: 555, score: 7079 },
skotizo: { rank: 5085, score: 61 }, skotizo: { rank: 5085, score: 61 },
spindel: { rank: 678, score: 903 },
tempoross: { rank: 18823, score: 23 },
gauntlet: { rank: 63, score: 375 }, gauntlet: { rank: 63, score: 375 },
corruptedGauntlet: { rank: 2870, score: 6 }, corruptedGauntlet: { rank: 2870, score: 6 },
leviathan: { rank: 2871, score: 7 },
whisperer: { rank: 2872, score: 8 },
theatreOfBlood: { rank: 6984, score: 138 }, theatreOfBlood: { rank: 6984, score: 138 },
theatreOfBloodHardMode: { rank: 23, score: 923141 },
thermonuclearSmokeDevil: { rank: 4043, score: 2000 }, thermonuclearSmokeDevil: { rank: 4043, score: 2000 },
tombsOfAmascut: { rank: 4073, score: 1020 },
tombsOfAmascutExpertMode: { rank: 289, score: 13070 },
tzKalZuk: { rank: 489, score: 8 }, tzKalZuk: { rank: 489, score: 8 },
tzTokJad: { rank: 967, score: 47 }, tzTokJad: { rank: 967, score: 47 },
vardorvis: { rank: 968, score: 48 },
venenatis: { rank: 11155, score: 223 }, venenatis: { rank: 11155, score: 223 },
vetion: { rank: 1940, score: 272 }, vetion: { rank: 1940, score: 272 },
vorkath: { rank: 8623, score: 1340 }, vorkath: { rank: 8623, score: 1340 },
wintertodt: { rank: 605, score: 1694 }, wintertodt: { rank: 605, score: 1694 },
zalcano: { rank: -1, score: -1 }, zalcano: { rank: -1, score: -1 },
zulrah: { rank: 3867, score: 4583 }, zulrah: { rank: 3867, score: 4583 }
}, }
}; };
expect(parseStats(csv)).toStrictEqual(expectedOutput); expect(parseStats(csv)).toStrictEqual(expectedOutput);
}); });
test('Get name format', async () => { test('Parse CSV with unknown activity', () => {
jest.setTimeout(30000); const statsWithUnknownActivity = `${lynxTitanStats}
const data = await getRSNFormat('lYnX tiTaN'); -1,-1`;
expect(data).toBe('Lynx Titan'); expect(() => parseStats(statsWithUnknownActivity)).toThrow(
InvalidFormatError
);
});
test('Parse invalid CSV', () => {
expect(() => parseStats('invalid')).toThrow(InvalidFormatError);
});
describe('Get name format', () => {
it('gets a name with a space', async () => {
const data = await getRSNFormat(LYNX_TITAN_SPACE_NAME);
expect(data).toBe(LYNX_TITAN_FORMATTED_NAME);
});
it('gets a name with an underscore', async () => {
const data = await getRSNFormat(LYNX_TITAN_UNDERSCORE_NAME);
expect(data).toBe(LYNX_TITAN_FORMATTED_NAME);
});
it('gets a name with a hyphen', async () => {
const data = await getRSNFormat(LYNX_TITAN_HYPHEN_NAME);
expect(data).toBe(LYNX_TITAN_FORMATTED_NAME);
});
it('gets a name with a number', async () => {
const data = await getRSNFormat(B0ATY_NAME);
expect(data).toBe(B0ATY_FORMATTED_NAME);
});
it('throws an error for a name with invalid characters', async () => {
await expect(getRSNFormat('b&aty')).rejects.toBeTruthy();
});
}); });
test('Get attack top page', async () => { test('Get attack top page', async () => {
jest.setTimeout(30000);
const data = await getSkillPage('attack'); const data = await getSkillPage('attack');
expect(data).toMatchObject([ expect(data).toMatchObject([
{ {
@@ -198,176 +318,181 @@ test('Get attack top page', async () => {
rank: 1, rank: 1,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 2, rank: 2,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
},
{
name: expect.any(String),
rank: 3,
level: 99,
xp: 200000000,
dead: false
}, },
{ name: 'Drakon', rank: 3, level: 99, xp: 200000000, dead: false },
{ {
name: expect.any(String), name: expect.any(String),
rank: 4, rank: 4,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 5, rank: 5,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 6, rank: 6,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 7, rank: 7,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 8, rank: 8,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 9, rank: 9,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 10, rank: 10,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 11, rank: 11,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 12, rank: 12,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 13, rank: 13,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 14, rank: 14,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 15, rank: 15,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 16, rank: 16,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 17, rank: 17,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 18, rank: 18,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 19, rank: 19,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 20, rank: 20,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 21, rank: 21,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 22, rank: 22,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 23, rank: 23,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 24, rank: 24,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, },
{ {
name: expect.any(String), name: expect.any(String),
rank: 25, rank: 25,
level: 99, level: 99,
xp: 200000000, xp: 200000000,
dead: false, dead: false
}, }
]); ]);
}); });
test('Get non-existant player', async () => { test('Get non-existent player', async () => {
jest.setTimeout(30000); getStats('fishy').catch((err) => {
getStats('fishy').catch(err => {
if (err.response) { if (err.response) {
expect(err.response.status).toBe(404); expect(err.response.status).toBe(404);
} }
@@ -375,8 +500,10 @@ test('Get non-existant player', async () => {
}); });
test('Get stats by gamemode', async () => { test('Get stats by gamemode', async () => {
jest.setTimeout(30000); const { skills, bosses, bountyHunter } = await getStatsByGamemode(
const { skills } = await getStatsByGamemode('Lynx Titan'); LYNX_TITAN_FORMATTED_NAME
);
expect(skills).toMatchObject({ expect(skills).toMatchObject({
overall: { rank: expect.any(Number), level: 2277, xp: 4600000000 }, overall: { rank: expect.any(Number), level: 2277, xp: 4600000000 },
attack: { rank: expect.any(Number), level: 99, xp: 200000000 }, attack: { rank: expect.any(Number), level: 99, xp: 200000000 },
@@ -401,6 +528,72 @@ test('Get stats by gamemode', async () => {
farming: { 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 }, runecraft: { rank: expect.any(Number), level: 99, xp: 200000000 },
hunter: { 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 }, construction: { rank: expect.any(Number), level: 99, xp: 200000000 }
});
const bossKeys = Object.keys(bosses);
expect(bossKeys).toStrictEqual(BOSSES);
const bountyHunterKeys = Object.keys(bountyHunter);
expect(bountyHunterKeys).toStrictEqual(BH_MODES);
expect.assertions(3);
});
describe('Get stats options', () => {
const rsn = 'player';
let axiosMock: jest.Mock;
beforeEach(() => {
axios.get = jest.fn(
(url) =>
new Promise<any>((resolve) => {
resolve(
url === getPlayerTableURL('main', rsn)
? { data: lynxTitanNamePage }
: { status: 200, data: lynxTitanStats }
);
})
);
axiosMock = axios.get as any;
axiosMock.mockClear();
});
it('fetches all gamemodes and formatted RSN when no options provided', async () => {
await getStats(rsn);
expect(axiosMock.mock.calls.map((val) => val[0])).toEqual([
getStatsURL('main', rsn, true),
getPlayerTableURL('main', rsn),
getStatsURL('ironman', rsn, true),
getStatsURL('hardcore', rsn, true),
getStatsURL('ultimate', rsn, true)
]);
});
it('skips fetching formatted RSN when option is provided', async () => {
await getStats(rsn, { shouldGetFormattedRsn: false });
expect(
axiosMock.mock.calls.some(
(val) => val[0] === getPlayerTableURL('main', rsn)
)
).toBeFalsy();
});
it('skips fetching game mode when option is provided', async () => {
await getStats(rsn, {
otherGamemodes: ['ironman', 'ultimate']
});
expect(
axiosMock.mock.calls.some(
(val) => val[0] === getStatsURL('hardcore', rsn)
)
).toBeFalsy();
});
it('omits excluded gamemodes', async () => {
const response = await getStats(rsn, {
otherGamemodes: ['ironman', 'ultimate']
});
expect(response.hardcore).toBeUndefined();
}); });
}); });
test('CSV and JSON parsing outputs identical object', async () => {
const csvOutput = parseStats(b0atyStatsCsv);
const jsonOutput = parseJsonStats(b0atyStatsJson);
expect(csvOutput).toEqual(jsonOutput);
});

1191
__tests__/lynxTitanNamePage.html vendored Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,148 @@
{
"skills": [
{ "id": 0, "name": "Overall", "rank": 1, "level": 2277, "xp": 4600000000 },
{ "id": 1, "name": "Attack", "rank": 15, "level": 99, "xp": 200000000 },
{ "id": 2, "name": "Defence", "rank": 28, "level": 99, "xp": 200000000 },
{ "id": 3, "name": "Strength", "rank": 18, "level": 99, "xp": 200000000 },
{ "id": 4, "name": "Hitpoints", "rank": 7, "level": 99, "xp": 200000000 },
{ "id": 5, "name": "Ranged", "rank": 8, "level": 99, "xp": 200000000 },
{ "id": 6, "name": "Prayer", "rank": 11, "level": 99, "xp": 200000000 },
{ "id": 7, "name": "Magic", "rank": 31, "level": 99, "xp": 200000000 },
{ "id": 8, "name": "Cooking", "rank": 155, "level": 99, "xp": 200000000 },
{
"id": 9,
"name": "Woodcutting",
"rank": 15,
"level": 99,
"xp": 200000000
},
{ "id": 10, "name": "Fletching", "rank": 12, "level": 99, "xp": 200000000 },
{ "id": 11, "name": "Fishing", "rank": 9, "level": 99, "xp": 200000000 },
{
"id": 12,
"name": "Firemaking",
"rank": 48,
"level": 99,
"xp": 200000000
},
{ "id": 13, "name": "Crafting", "rank": 4, "level": 99, "xp": 200000000 },
{ "id": 14, "name": "Smithing", "rank": 3, "level": 99, "xp": 200000000 },
{ "id": 15, "name": "Mining", "rank": 24, "level": 99, "xp": 200000000 },
{ "id": 16, "name": "Herblore", "rank": 5, "level": 99, "xp": 200000000 },
{ "id": 17, "name": "Agility", "rank": 24, "level": 99, "xp": 200000000 },
{ "id": 18, "name": "Thieving", "rank": 12, "level": 99, "xp": 200000000 },
{ "id": 19, "name": "Slayer", "rank": 2, "level": 99, "xp": 200000000 },
{ "id": 20, "name": "Farming", "rank": 19, "level": 99, "xp": 200000000 },
{ "id": 21, "name": "Runecraft", "rank": 6, "level": 99, "xp": 200000000 },
{ "id": 22, "name": "Hunter", "rank": 4, "level": 99, "xp": 200000000 },
{
"id": 23,
"name": "Construction",
"rank": 4,
"level": 99,
"xp": 200000000
}
],
"activities": [
{ "id": 0, "name": "League Points", "rank": -1, "score": -1 },
{ "id": 1, "name": "Deadman Points", "rank": -1, "score": -1 },
{ "id": 2, "name": "Bounty Hunter - Hunter", "rank": -1, "score": -1 },
{ "id": 3, "name": "Bounty Hunter - Rogue", "rank": -1, "score": -1 },
{
"id": 4,
"name": "Bounty Hunter (Legacy) - Hunter",
"rank": -1,
"score": -1
},
{
"id": 5,
"name": "Bounty Hunter (Legacy) - Rogue",
"rank": -1,
"score": -1
},
{ "id": 6, "name": "Clue Scrolls (all)", "rank": 805212, "score": 22 },
{ "id": 7, "name": "Clue Scrolls (beginner)", "rank": -1, "score": -1 },
{ "id": 8, "name": "Clue Scrolls (easy)", "rank": -1, "score": -1 },
{ "id": 9, "name": "Clue Scrolls (medium)", "rank": -1, "score": -1 },
{ "id": 10, "name": "Clue Scrolls (hard)", "rank": 502504, "score": 22 },
{ "id": 11, "name": "Clue Scrolls (elite)", "rank": -1, "score": -1 },
{ "id": 12, "name": "Clue Scrolls (master)", "rank": -1, "score": -1 },
{ "id": 13, "name": "LMS - Rank", "rank": -1, "score": -1 },
{ "id": 14, "name": "PvP Arena - Rank", "rank": -1, "score": -1 },
{ "id": 15, "name": "Soul Wars Zeal", "rank": -1, "score": -1 },
{ "id": 16, "name": "Rifts closed", "rank": -1, "score": -1 },
{ "id": 17, "name": "Abyssal Sire", "rank": -1, "score": -1 },
{ "id": 18, "name": "Alchemical Hydra", "rank": -1, "score": -1 },
{ "id": 19, "name": "Artio", "rank": -1, "score": -1 },
{ "id": 20, "name": "Barrows Chests", "rank": -1, "score": -1 },
{ "id": 21, "name": "Bryophyta", "rank": -1, "score": -1 },
{ "id": 22, "name": "Callisto", "rank": -1, "score": -1 },
{ "id": 23, "name": "Calvar'ion", "rank": -1, "score": -1 },
{ "id": 24, "name": "Cerberus", "rank": -1, "score": -1 },
{ "id": 25, "name": "Chambers of Xeric", "rank": -1, "score": -1 },
{
"id": 26,
"name": "Chambers of Xeric: Challenge Mode",
"rank": -1,
"score": -1
},
{ "id": 27, "name": "Chaos Elemental", "rank": -1, "score": -1 },
{ "id": 28, "name": "Chaos Fanatic", "rank": -1, "score": -1 },
{ "id": 29, "name": "Commander Zilyana", "rank": -1, "score": -1 },
{ "id": 30, "name": "Corporeal Beast", "rank": -1, "score": -1 },
{ "id": 31, "name": "Crazy Archaeologist", "rank": -1, "score": -1 },
{ "id": 32, "name": "Dagannoth Prime", "rank": -1, "score": -1 },
{ "id": 33, "name": "Dagannoth Rex", "rank": -1, "score": -1 },
{ "id": 34, "name": "Dagannoth Supreme", "rank": -1, "score": -1 },
{ "id": 35, "name": "Deranged Archaeologist", "rank": -1, "score": -1 },
{ "id": 36, "name": "Duke Sucellus", "rank": -1, "score": -1 },
{ "id": 37, "name": "General Graardor", "rank": -1, "score": -1 },
{ "id": 38, "name": "Giant Mole", "rank": -1, "score": -1 },
{ "id": 39, "name": "Grotesque Guardians", "rank": -1, "score": -1 },
{ "id": 40, "name": "Hespori", "rank": -1, "score": -1 },
{ "id": 41, "name": "Kalphite Queen", "rank": -1, "score": -1 },
{ "id": 42, "name": "King Black Dragon", "rank": -1, "score": -1 },
{ "id": 43, "name": "Kraken", "rank": -1, "score": -1 },
{ "id": 44, "name": "Kree'Arra", "rank": -1, "score": -1 },
{ "id": 45, "name": "K'ril Tsutsaroth", "rank": -1, "score": -1 },
{ "id": 46, "name": "Mimic", "rank": -1, "score": -1 },
{ "id": 47, "name": "Nex", "rank": -1, "score": -1 },
{ "id": 48, "name": "Nightmare", "rank": -1, "score": -1 },
{ "id": 49, "name": "Phosani's Nightmare", "rank": -1, "score": -1 },
{ "id": 50, "name": "Obor", "rank": -1, "score": -1 },
{ "id": 51, "name": "Phantom Muspah", "rank": -1, "score": -1 },
{ "id": 52, "name": "Sarachnis", "rank": -1, "score": -1 },
{ "id": 53, "name": "Scorpia", "rank": -1, "score": -1 },
{ "id": 54, "name": "Skotizo", "rank": -1, "score": -1 },
{ "id": 55, "name": "Spindel", "rank": -1, "score": -1 },
{ "id": 56, "name": "Tempoross", "rank": -1, "score": -1 },
{ "id": 57, "name": "The Gauntlet", "rank": -1, "score": -1 },
{ "id": 58, "name": "The Corrupted Gauntlet", "rank": -1, "score": -1 },
{ "id": 59, "name": "The Leviathan", "rank": -1, "score": -1 },
{ "id": 60, "name": "The Whisperer", "rank": -1, "score": -1 },
{ "id": 61, "name": "Theatre of Blood", "rank": -1, "score": -1 },
{
"id": 62,
"name": "Theatre of Blood: Hard Mode",
"rank": -1,
"score": -1
},
{ "id": 63, "name": "Thermonuclear Smoke Devil", "rank": -1, "score": -1 },
{ "id": 64, "name": "Tombs of Amascut", "rank": -1, "score": -1 },
{
"id": 65,
"name": "Tombs of Amascut: Expert Mode",
"rank": -1,
"score": -1
},
{ "id": 66, "name": "TzKal-Zuk", "rank": -1, "score": -1 },
{ "id": 67, "name": "TzTok-Jad", "rank": 225, "score": 186 },
{ "id": 68, "name": "Vardorvis", "rank": -1, "score": -1 },
{ "id": 69, "name": "Venenatis", "rank": -1, "score": -1 },
{ "id": 70, "name": "Vet'ion", "rank": -1, "score": -1 },
{ "id": 71, "name": "Vorkath", "rank": -1, "score": -1 },
{ "id": 72, "name": "Wintertodt", "rank": -1, "score": -1 },
{ "id": 73, "name": "Zalcano", "rank": -1, "score": -1 },
{ "id": 74, "name": "Zulrah", "rank": -1, "score": -1 }
]
}

View File

@@ -1,8 +0,0 @@
{
"transform": {
"^.+\\.(t|j)sx?$": "ts-jest"
},
"testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
"moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
"testEnvironment": "node"
}

View File

@@ -1,17 +1,18 @@
{ {
"name": "osrs-json-hiscores", "name": "osrs-json-hiscores",
"version": "2.3.0", "version": "2.17.0",
"description": "The Oldschool Runescape API wrapper that does more!", "description": "The Old School Runescape API wrapper that does more!",
"main": "lib/index.js", "main": "lib/index.js",
"types": "lib/index.d.ts", "types": "lib/index.d.ts",
"files": [ "files": [
"lib/**/*" "lib/**/*"
], ],
"scripts": { "scripts": {
"dev": "watch 'yarn run build' src", "dev": "yarn build --watch",
"build": "tsc", "build": "tsc",
"format": "prettier --write \"src/**/*.ts\"", "format": "prettier --write \"src/**/*.ts\"",
"test": "jest --config jestconfig.json", "lint": "eslint --fix \"src/**/*.ts\"",
"test": "jest",
"prepublish": "yarn run build", "prepublish": "yarn run build",
"release": "np" "release": "np"
}, },
@@ -29,27 +30,90 @@
"stats", "stats",
"skills" "skills"
], ],
"publishConfig": {
"registry": "https://registry.npmjs.org"
},
"author": "maxswa", "author": "maxswa",
"license": "ISC", "license": "ISC",
"bugs": { "bugs": {
"url": "https://github.com/maxswa/osrs-json-hiscores/issues" "url": "https://github.com/maxswa/osrs-json-hiscores/issues"
}, },
"homepage": "https://github.com/maxswa/osrs-json-hiscores#readme", "homepage": "https://github.com/maxswa/osrs-json-hiscores#readme",
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
},
"lint-staged": {
"*.{ts}": [
"eslint --fix",
"prettier --write",
"git add"
]
},
"eslintConfig": {
"root": true,
"parser": "@typescript-eslint/parser",
"parserOptions": {
"project": "./tsconfig.eslint.json"
},
"plugins": [
"@typescript-eslint"
],
"extends": [
"airbnb-base",
"airbnb-typescript/base",
"prettier"
],
"ignorePatterns": [
"**/@types/*"
],
"rules": {
"max-classes-per-file": "off"
}
},
"prettier": {
"trailingComma": "none",
"tabWidth": 2,
"semi": true,
"singleQuote": true,
"endOfLine": "auto"
},
"jest": {
"transform": {
"^.+\\.(t|j)sx?$": "ts-jest"
},
"testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
"moduleFileExtensions": [
"ts",
"tsx",
"js",
"jsx",
"json",
"node"
],
"testEnvironment": "node"
},
"dependencies": { "dependencies": {
"axios": "^0.21.1", "axios": "^1.6.2",
"jsdom": "^16.3.0" "jsdom": "^22.1.0",
"useragent-generator": "^1.1.0"
}, },
"devDependencies": { "devDependencies": {
"@types/jest": "^24.0.14", "@types/jest": "^29.5.3",
"@types/jsdom": "^16.2.3", "@types/jsdom": "^21.1.1",
"jest": "^24.8.0", "@typescript-eslint/eslint-plugin": "^6.0.0",
"np": "^5.0.3", "@typescript-eslint/parser": "^6.0.0",
"prettier": "^1.19.1", "eslint": "^8.44.0",
"ts-jest": "^24.0.2", "eslint-config-airbnb-typescript": "^17.1.0",
"tslint": "^5.17.0", "eslint-config-prettier": "^8.8.0",
"tslint-config-airbnb": "^5.11.1", "eslint-plugin-import": "^2.27.5",
"tslint-config-prettier": "^1.18.0", "husky": "^5.2.0",
"typescript": "^3.5.2", "jest": "^29.6.1",
"watch": "^1.0.2" "lint-staged": "^13.2.3",
"np": "^7.7.0",
"prettier": "^3.0.0",
"ts-jest": "^29.1.1",
"typescript": "^5.1.6"
} }
} }

109
src/@types/useragent-generator.d.ts vendored Normal file
View File

@@ -0,0 +1,109 @@
declare module 'useragent-generator' {
/** *****************
* Google Chrome *
/****************** */
export function chrome(
opt: number | string | { version: string; os?: string }
): string;
export namespace chrome {
function androidPhone(
opt:
| number
| string
| { version: string; androidVersion?: string; device?: string }
): string;
function androidTablet(
opt:
| number
| string
| { version: string; androidVersion?: string; device?: string }
): string;
function androidWebview(
opt:
| number
| string
| { androidVersion: string; chromeVersion?: string; device?: string }
): string;
function chromecast(opt: number | string | { version: string }): string;
function iOS(
opt:
| number
| string
| { iOSVersion: string; chromeVersion?: string; device?: string }
): string;
}
export function chromium(
opt: number | string | { version: string; os?: string }
): string;
/** ************
* Firefox *
/************* */
export function firefox(
opt: number | string | { version: string; os?: string }
): string;
export namespace firefox {
function androidPhone(
opt:
| number
| string
| { version: string; androidVersion?: string; device?: string }
): string;
function androidTablet(
opt:
| number
| string
| { version: string; androidVersion?: string; device?: string }
): string;
function iOS(
opt: number | string | { iOSVersion: string; device?: string }
): string;
}
/** ***********
* Safari *
/************ */
export function safari(
opt: number | string | { version: string; os?: string }
): string;
export namespace safari {
function iOS(
opt:
| number
| string
| { iOSVersion: string; safariVersion?: string; device?: string }
): string;
function iOSWebview(
opt:
| number
| string
| { iOSVersion: string; safariVersion?: string; device?: string }
): string;
}
/** ********************
* Internet Explorer *
/********************* */
export function ie(
opt: number | string | { version: string; os?: string }
): string;
export namespace ie {
function windowsPhone(
opt: number | string | { version: string; device?: string }
): string;
}
/** *******************
* Microsoft Edge *
/******************** */
export function edge(
opt:
| number
| string
| { version: string; chromeVersion?: string; os?: string }
): string;
/** *********************
* Search Engine Bots *
/********************** */
export function googleBot(
opt?: number | string | { version?: string }
): string;
export function bingBot(opt?: number | string | { version?: string }): string;
export function yahooBot(): string;
}

View File

@@ -1,4 +1,5 @@
import axios from 'axios'; import axios, { AxiosRequestConfig } from 'axios';
import { BinaryData, JSDOM } from 'jsdom';
import { import {
Player, Player,
Activity, Activity,
@@ -13,6 +14,8 @@ import {
ActivityName, ActivityName,
PlayerActivityRow, PlayerActivityRow,
Bosses, Bosses,
GetStatsOptions,
HiscoresResponse
} from './types'; } from './types';
import { import {
getStatsURL, getStatsURL,
@@ -26,246 +29,200 @@ import {
numberFromElement, numberFromElement,
rsnFromElement, rsnFromElement,
getActivityPageURL, getActivityPageURL,
httpGet,
BOSSES, BOSSES,
InvalidFormatError,
PlayerNotFoundError,
HiScoresError,
validateRSN,
FORMATTED_SKILL_NAMES,
FORMATTED_BH_NAMES,
FORMATTED_CLUE_NAMES,
FORMATTED_BOSS_NAMES,
FORMATTED_LEAGUE_POINTS,
FORMATTED_LMS,
FORMATTED_PVP_ARENA,
FORMATTED_SOUL_WARS,
FORMATTED_RIFTS_CLOSED,
FORMATTED_DEADMAN_POINTS
} from './utils'; } from './utils';
import { JSDOM } from 'jsdom';
export async function getStats(rsn: string): Promise<Player> { /**
if (typeof rsn !== 'string') { * Gets a player's stats from the official OSRS JSON endpoint.
throw Error('RSN must be a string'); *
} else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) { * @param rsn Username of the player.
throw Error('RSN contains invalid character'); * @param mode Gamemode to fetch ranks for.
} else if (rsn.length > 12 || rsn.length < 1) { * @param config Optional axios request config object.
throw Error('RSN must be between 1 and 12 characters'); * @returns Official JSON stats object.
*/
export async function getOfficialStats(
rsn: string,
mode: Gamemode = 'main',
config?: AxiosRequestConfig
): Promise<HiscoresResponse> {
validateRSN(rsn);
const url = getStatsURL(mode, rsn, true);
try {
const response = await httpGet<HiscoresResponse>(url, config);
return response.data;
} catch (err) {
if (!axios.isAxiosError(err)) throw err;
if (err.response?.status === 404) throw new PlayerNotFoundError();
throw new HiScoresError();
} }
const mainRes = await axios(getStatsURL('main', rsn));
if (mainRes.status === 200) {
const otherResponses = await Promise.all([
axios(getStatsURL('ironman', rsn)).catch(err => err),
axios(getStatsURL('hardcore', rsn)).catch(err => err),
axios(getStatsURL('ultimate', rsn)).catch(err => err),
getRSNFormat(rsn).catch(() => undefined),
]);
const [ironRes, hcRes, ultRes, formattedName] = otherResponses;
const player: Player = {
name: formattedName || rsn,
mode: 'main',
dead: false,
deulted: false,
deironed: false,
};
player.main = parseStats(mainRes.data);
if (ironRes.status === 200) {
player.ironman = parseStats(ironRes.data);
if (hcRes.status === 200) {
player.mode = 'hardcore';
player.hardcore = parseStats(hcRes.data);
if (
player.ironman.skills.overall.xp !== player.hardcore.skills.overall.xp
) {
player.dead = true;
player.mode = 'ironman';
}
if (
player.main.skills.overall.xp !== player.ironman.skills.overall.xp
) {
player.deironed = true;
player.mode = 'main';
}
} else if (ultRes.status === 200) {
player.mode = 'ultimate';
player.ultimate = parseStats(ultRes.data);
if (
player.ironman.skills.overall.xp !== player.ultimate.skills.overall.xp
) {
player.deulted = true;
player.mode = 'ironman';
}
if (
player.main.skills.overall.xp !== player.ironman.skills.overall.xp
) {
player.deironed = true;
player.mode = 'main';
}
} else {
player.mode = 'ironman';
if (
player.main.skills.overall.xp !== player.ironman.skills.overall.xp
) {
player.deironed = true;
player.mode = 'main';
}
}
}
return player;
}
throw Error('Player not found');
} }
export async function getStatsByGamemode( /**
* Screen scrapes the hiscores to get the formatted rsn of a player.
*
* @param rsn Username of the player.
* @param config Optional axios request config object.
* @returns Formatted version of the rsn.
*/
export async function getRSNFormat(
rsn: string, rsn: string,
mode: Gamemode = 'main' config?: AxiosRequestConfig
): Promise<Stats> { ): Promise<string> {
if (typeof rsn !== 'string') { validateRSN(rsn);
throw Error('RSN must be a string');
} else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) { const url = getPlayerTableURL('main', rsn);
throw Error('RSN contains invalid character'); try {
} else if (rsn.length > 12 || rsn.length < 1) { const response = await httpGet<string | Buffer | BinaryData | undefined>(
throw Error('RSN must be between 1 and 12 characters'); url,
} else if (!GAMEMODES.includes(mode)) { config
throw Error('Invalid game mode'); );
const dom = new JSDOM(response.data);
const anchor = dom.window.document.querySelector(
'.personal-hiscores__row.personal-hiscores__row--type-highlight a'
);
if (anchor) {
return rsnFromElement(anchor);
}
throw new PlayerNotFoundError();
} catch {
throw new HiScoresError();
} }
const response = await axios(getStatsURL(mode, rsn)); }
if (response.status !== 200) {
throw Error('Player not found'); /**
} * Parses official JSON object of raw stats and returns a stats object.
const stats = parseStats(response.data); *
* @param csv Raw JSON from the official OSRS API.
* @returns Parsed stats object.
*/
export function parseJsonStats(json: HiscoresResponse): Stats {
const getActivity = (formattedName: string): Activity => {
const hiscoresActivity = json.activities.find(
// We must match on name here since id is not guaranteed to be the same between updates
({ name }) => name.toLowerCase() === formattedName.toLowerCase()
);
return {
rank: hiscoresActivity?.rank ?? -1,
score: hiscoresActivity?.score ?? -1
};
};
const reduceActivity = <Key extends string, Reduced = Record<Key, Activity>>(
keys: Key[],
formattedNames: Record<Key, string>
): Reduced =>
keys.reduce<Reduced>(
(reducer, key) => ({
...reducer,
[key]: getActivity(formattedNames[key])
}),
{} as Reduced
);
const skills = SKILLS.reduce<Skills>((skillsObject, skillName) => {
const hiscoresSkill = json.skills.find(
// We must match on name here since id is not guaranteed to be the same between updates
({ name }) =>
name.toLowerCase() === FORMATTED_SKILL_NAMES[skillName].toLowerCase()
);
return {
...skillsObject,
[skillName]: {
rank: hiscoresSkill?.rank ?? -1,
level: hiscoresSkill?.level ?? -1,
xp: hiscoresSkill?.xp ?? -1
}
};
}, {} as Skills);
const bountyHunter = reduceActivity(BH_MODES, FORMATTED_BH_NAMES);
const clues = reduceActivity(CLUES, FORMATTED_CLUE_NAMES);
const bosses = reduceActivity(BOSSES, FORMATTED_BOSS_NAMES);
const leaguePoints = getActivity(FORMATTED_LEAGUE_POINTS);
const deadmanPoints = getActivity(FORMATTED_DEADMAN_POINTS);
const lastManStanding = getActivity(FORMATTED_LMS);
const pvpArena = getActivity(FORMATTED_PVP_ARENA);
const soulWarsZeal = getActivity(FORMATTED_SOUL_WARS);
const riftsClosed = getActivity(FORMATTED_RIFTS_CLOSED);
const stats: Stats = {
skills,
leaguePoints,
deadmanPoints,
bountyHunter,
lastManStanding,
pvpArena,
soulWarsZeal,
riftsClosed,
clues,
bosses
};
return stats; return stats;
} }
export async function getSkillPage( /**
skill: SkillName, * Parses CSV string of raw stats and returns a stats object.
mode: Gamemode = 'main', *
page: number = 1 * @param csv Raw CSV from the official OSRS API.
): Promise<PlayerSkillRow[]> { * @returns Parsed stats object.
if (!GAMEMODES.includes(mode)) { */
throw Error('Invalid game mode');
} else if (!Number.isInteger(page) || page < 1) {
throw Error('Page must be an integer greater than 0');
} else if (!SKILLS.includes(skill)) {
throw Error('Invalid skill');
}
const url = getSkillPageURL(mode, skill, page);
const response = await axios(url);
const dom = new JSDOM(response.data);
const playersHTML = dom.window.document.querySelectorAll(
'.personal-hiscores__row'
);
const players: PlayerSkillRow[] = [];
playersHTML.forEach(row => {
const rankEl = row.querySelector('td');
const nameEl = row.querySelector('td a');
const levelEl = row.querySelector('td.left + td');
const xpEl = row.querySelector('td.left + td + td');
const isDead = !!row.querySelector('td img');
players.push({
name: rsnFromElement(nameEl),
rank: numberFromElement(rankEl),
level: numberFromElement(levelEl),
xp: numberFromElement(xpEl),
dead: isDead,
});
});
return players;
}
export async function getActivityPage(
activity: ActivityName,
mode: Gamemode = 'main',
page: number = 1
): Promise<PlayerActivityRow[]> {
if (!GAMEMODES.includes(mode)) {
throw Error('Invalid game mode');
} else if (!Number.isInteger(page) || page < 1) {
throw Error('Page must be an integer greater than 0');
} else if (!ACTIVITIES.includes(activity)) {
throw Error('Invalid activity');
}
const url = getActivityPageURL(mode, activity, page);
const response = await axios(url);
const dom = new JSDOM(response.data);
const playersHTML = dom.window.document.querySelectorAll(
'.personal-hiscores__row'
);
const players: PlayerActivityRow[] = [];
playersHTML.forEach(row => {
const rankEl = row.querySelector('td');
const nameEl = row.querySelector('td a');
const scoreEl = row.querySelector('td.left + td');
const isDead = !!row.querySelector('td img');
players.push({
name: rsnFromElement(nameEl),
rank: numberFromElement(rankEl),
score: numberFromElement(scoreEl),
dead: isDead,
});
});
return players;
}
export async function getRSNFormat(rsn: string): Promise<string> {
if (typeof rsn !== 'string') {
throw Error('RSN must be a string');
} else if (!/^[a-zA-Z0-9 _]+$/.test(rsn)) {
throw Error('RSN contains invalid character');
} else if (rsn.length > 12 || rsn.length < 1) {
throw Error('RSN must be between 1 and 12 characters');
}
const url = getPlayerTableURL('main', rsn);
try {
const response = await axios(url);
const dom = new JSDOM(response.data);
const spans = dom.window.document.querySelectorAll(
'span[style="color:#AA0022;"]'
);
if (spans.length >= 2) {
const nameSpan = spans[1];
return rsnFromElement(nameSpan);
}
throw Error('Player not found');
} catch {
throw Error('Player not found');
}
}
export function parseStats(csv: string): Stats { export function parseStats(csv: string): Stats {
const splitCSV = csv const splitCSV = csv
.split('\n') .split('\n')
.filter(entry => !!entry) .filter((entry) => !!entry)
.map(stat => stat.split(',')); .map((stat) => stat.split(','));
if (splitCSV.length !== SKILLS.length + ACTIVITIES.length) {
throw new InvalidFormatError();
}
const skillObjects: Skill[] = splitCSV const skillObjects: Skill[] = splitCSV
.filter(stat => stat.length === 3) .filter((stat) => stat.length === 3)
.map(stat => { .map((stat) => {
const [rank, level, xp] = stat; const [rank, level, xp] = stat;
const skill: Skill = { const skill: Skill = {
rank: parseInt(rank, 10), rank: parseInt(rank, 10),
level: parseInt(level, 10), level: parseInt(level, 10),
xp: parseInt(xp, 10), xp: parseInt(xp, 10)
}; };
return skill; return skill;
}); });
const activityObjects: Activity[] = splitCSV const activityObjects: Activity[] = splitCSV
.filter(stat => stat.length === 2) .filter((stat) => stat.length === 2)
.map(stat => { .map((stat) => {
const [rank, score] = stat; const [rank, score] = stat;
const activity: Activity = { const activity: Activity = {
rank: parseInt(rank, 10), rank: parseInt(rank, 10),
score: parseInt(score, 10), score: parseInt(score, 10)
}; };
return activity; return activity;
}); });
const [leaguePoints] = activityObjects.splice(0, 1); const [leaguePoints, deadmanPoints] = activityObjects.splice(0, 2);
const bhObjects = activityObjects.splice(0, BH_MODES.length); const bhObjects = activityObjects.splice(0, BH_MODES.length);
const clueObjects = activityObjects.splice(0, CLUES.length); const clueObjects = activityObjects.splice(0, CLUES.length);
const [lastManStanding, soulWarsZeal] = activityObjects.splice(0, 2); const [lastManStanding, pvpArena, soulWarsZeal, riftsClosed] =
activityObjects.splice(0, 4);
const bossObjects = activityObjects.splice(0, BOSSES.length); const bossObjects = activityObjects.splice(0, BOSSES.length);
const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => { const skills: Skills = skillObjects.reduce<Skills>((prev, curr, index) => {
@@ -295,12 +252,220 @@ export function parseStats(csv: string): Stats {
const stats: Stats = { const stats: Stats = {
skills, skills,
leaguePoints, leaguePoints,
deadmanPoints,
bountyHunter, bountyHunter,
lastManStanding, lastManStanding,
pvpArena,
soulWarsZeal, soulWarsZeal,
riftsClosed,
clues, clues,
bosses, bosses
}; };
return stats; return stats;
} }
/**
* Fetches stats from the OSRS API and consolidates the info into a player object.
*
* **Note:** This function will make up to 5 separate network requests.
* As such, it is highly subject to the performance of the official OSRS API.
*
* @param rsn Username of the player.
* @returns Player object.
*/
export async function getStats(
rsn: string,
options?: GetStatsOptions
): Promise<Player> {
validateRSN(rsn);
const otherGamemodes = options?.otherGamemodes ?? [
'ironman',
'hardcore',
'ultimate'
];
const shouldGetFormattedRsn = options?.shouldGetFormattedRsn ?? true;
const main = await getOfficialStats(rsn, 'main', options?.axiosConfigs?.main);
const getModeStats = async (
mode: Extract<Gamemode, 'ironman' | 'hardcore' | 'ultimate'>
): Promise<HiscoresResponse | undefined> =>
otherGamemodes.includes(mode)
? getOfficialStats(rsn, mode, options?.axiosConfigs?.[mode]).catch(
() => undefined
)
: undefined;
const formattedName = shouldGetFormattedRsn
? await getRSNFormat(rsn, options?.axiosConfigs?.rsn).catch(() => undefined)
: undefined;
const player: Player = {
name: formattedName ?? rsn,
mode: 'main',
dead: false,
deulted: false,
deironed: false
};
player.main = parseJsonStats(main);
const iron = await getModeStats('ironman');
if (iron) {
player.ironman = parseJsonStats(iron);
const hc = await getModeStats('hardcore');
const ult = await getModeStats('ultimate');
if (hc) {
player.mode = 'hardcore';
player.hardcore = parseJsonStats(hc);
if (
player.ironman.skills.overall.xp !== player.hardcore.skills.overall.xp
) {
player.dead = true;
player.mode = 'ironman';
}
if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
player.deironed = true;
player.mode = 'main';
}
} else if (ult) {
player.mode = 'ultimate';
player.ultimate = parseJsonStats(ult);
if (
player.ironman.skills.overall.xp !== player.ultimate.skills.overall.xp
) {
player.deulted = true;
player.mode = 'ironman';
}
if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
player.deironed = true;
player.mode = 'main';
}
} else {
player.mode = 'ironman';
if (player.main.skills.overall.xp !== player.ironman.skills.overall.xp) {
player.deironed = true;
player.mode = 'main';
}
}
}
return player;
}
/**
* Fetches stats from the OSRS API and returns them as an object.
*
* @param rsn Username of the player.
* @param mode Gamemode to fetch ranks for.
* @param config Optional axios request config object.
* @returns Stats object.
*/
export async function getStatsByGamemode(
rsn: string,
mode: Gamemode = 'main',
config?: AxiosRequestConfig
): Promise<Stats> {
validateRSN(rsn);
if (!GAMEMODES.includes(mode)) {
throw Error('Invalid game mode');
}
const response = await getOfficialStats(rsn, mode, config);
const stats = parseJsonStats(response);
return stats;
}
export async function getSkillPage(
skill: SkillName,
mode: Gamemode = 'main',
page: number = 1,
config?: AxiosRequestConfig
): Promise<PlayerSkillRow[]> {
if (!GAMEMODES.includes(mode)) {
throw Error('Invalid game mode');
} else if (!Number.isInteger(page) || page < 1) {
throw Error('Page must be an integer greater than 0');
} else if (!SKILLS.includes(skill)) {
throw Error('Invalid skill');
}
const url = getSkillPageURL(mode, skill, page);
const response = await httpGet<string | Buffer | BinaryData | undefined>(
url,
config
);
const dom = new JSDOM(response.data);
const playersHTML = dom.window.document.querySelectorAll(
'.personal-hiscores__row'
);
const players: PlayerSkillRow[] = [];
playersHTML.forEach((row) => {
const rankEl = row.querySelector('td');
const nameEl = row.querySelector('td a');
const levelEl = row.querySelector('td.left + td');
const xpEl = row.querySelector('td.left + td + td');
const isDead = !!row.querySelector('td img');
players.push({
name: rsnFromElement(nameEl),
rank: numberFromElement(rankEl),
level: numberFromElement(levelEl),
xp: numberFromElement(xpEl),
dead: isDead
});
});
return players;
}
/**
* Screen scrapes a hiscores page of an activity or boss and returns an array of up to 25 players.
*
* @param activity Name of the activity or boss to fetch hiscores for.
* @param mode Gamemode to fetch ranks for.
* @param page Page number.
* @param config Optional axios request config object.
* @returns Array of `PlayerActivityRow` objects.
*/
export async function getActivityPage(
activity: ActivityName,
mode: Gamemode = 'main',
page: number = 1,
config?: AxiosRequestConfig
): Promise<PlayerActivityRow[]> {
if (!GAMEMODES.includes(mode)) {
throw Error('Invalid game mode');
} else if (!Number.isInteger(page) || page < 1) {
throw Error('Page must be an integer greater than 0');
} else if (!ACTIVITIES.includes(activity)) {
throw Error('Invalid activity');
}
const url = getActivityPageURL(mode, activity, page);
const response = await httpGet<string | Buffer | BinaryData | undefined>(
url,
config
);
const dom = new JSDOM(response.data);
const playersHTML = dom.window.document.querySelectorAll(
'.personal-hiscores__row'
);
const players: PlayerActivityRow[] = [];
playersHTML.forEach((row) => {
const rankEl = row.querySelector('td');
const nameEl = row.querySelector('td a');
const scoreEl = row.querySelector('td.left + td');
const isDead = !!row.querySelector('td img');
players.push({
name: rsnFromElement(nameEl),
rank: numberFromElement(rankEl),
score: numberFromElement(scoreEl),
dead: isDead
});
});
return players;
}

View File

@@ -1,3 +1,5 @@
import { AxiosRequestConfig } from 'axios';
export type Gamemode = export type Gamemode =
| 'main' | 'main'
| 'ironman' | 'ironman'
@@ -5,7 +7,10 @@ export type Gamemode =
| 'hardcore' | 'hardcore'
| 'deadman' | 'deadman'
| 'seasonal' | 'seasonal'
| 'tournament'; | 'tournament'
| 'skiller'
| 'oneDefence'
| 'freshStart';
export interface Skill { export interface Skill {
rank: number; rank: number;
@@ -57,16 +62,18 @@ export type ClueType =
export type Clues = { [Type in ClueType]: Activity }; export type Clues = { [Type in ClueType]: Activity };
export type BHType = 'rogue' | 'hunter'; export type BHType = 'rogue' | 'hunter' | 'rogueV2' | 'hunterV2';
export type BH = { [Type in BHType]: Activity }; export type BH = { [Type in BHType]: Activity };
export type Boss = export type Boss =
| 'abyssalSire' | 'abyssalSire'
| 'alchemicalHydra' | 'alchemicalHydra'
| 'artio'
| 'barrows' | 'barrows'
| 'bryophyta' | 'bryophyta'
| 'callisto' | 'callisto'
| 'calvarion'
| 'cerberus' | 'cerberus'
| 'chambersOfXeric' | 'chambersOfXeric'
| 'chambersOfXericChallengeMode' | 'chambersOfXericChallengeMode'
@@ -79,6 +86,7 @@ export type Boss =
| 'dagannothRex' | 'dagannothRex'
| 'dagannothSupreme' | 'dagannothSupreme'
| 'derangedArchaeologist' | 'derangedArchaeologist'
| 'dukeSucellus'
| 'generalGraardor' | 'generalGraardor'
| 'giantMole' | 'giantMole'
| 'grotesqueGuardians' | 'grotesqueGuardians'
@@ -89,17 +97,29 @@ export type Boss =
| 'kreeArra' | 'kreeArra'
| 'krilTsutsaroth' | 'krilTsutsaroth'
| 'mimic' | 'mimic'
| 'nex'
| 'nightmare' | 'nightmare'
| 'phosanisNightmare'
| 'obor' | 'obor'
| 'phantomMuspah'
| 'sarachnis' | 'sarachnis'
| 'scorpia' | 'scorpia'
| 'scurrius'
| 'skotizo' | 'skotizo'
| 'spindel'
| 'tempoross'
| 'gauntlet' | 'gauntlet'
| 'corruptedGauntlet' | 'corruptedGauntlet'
| 'leviathan'
| 'whisperer'
| 'theatreOfBlood' | 'theatreOfBlood'
| 'theatreOfBloodHardMode'
| 'thermonuclearSmokeDevil' | 'thermonuclearSmokeDevil'
| 'tombsOfAmascut'
| 'tombsOfAmascutExpertMode'
| 'tzKalZuk' | 'tzKalZuk'
| 'tzTokJad' | 'tzTokJad'
| 'vardorvis'
| 'venenatis' | 'venenatis'
| 'vetion' | 'vetion'
| 'vorkath' | 'vorkath'
@@ -111,10 +131,15 @@ export type Bosses = { [Type in Boss]: Activity };
export type ActivityName = export type ActivityName =
| 'leaguePoints' | 'leaguePoints'
| 'deadmanPoints'
| 'hunterBHV2'
| 'rogueBHV2'
| 'hunterBH' | 'hunterBH'
| 'rogueBH' | 'rogueBH'
| 'lastManStanding' | 'lastManStanding'
| 'pvpArena'
| 'soulWarsZeal' | 'soulWarsZeal'
| 'riftsClosed'
| 'allClues' | 'allClues'
| 'beginnerClues' | 'beginnerClues'
| 'easyClues' | 'easyClues'
@@ -127,10 +152,19 @@ export type ActivityName =
export interface Stats { export interface Stats {
skills: Skills; skills: Skills;
clues: Clues; clues: Clues;
/**
* Will only contain rank and score data for the `seasonal` gamemode.
*/
leaguePoints: Activity; leaguePoints: Activity;
/**
* Will only contain rank and score data for the `tournament` gamemode.
*/
deadmanPoints: Activity;
bountyHunter: BH; bountyHunter: BH;
lastManStanding: Activity; lastManStanding: Activity;
pvpArena: Activity;
soulWarsZeal: Activity; soulWarsZeal: Activity;
riftsClosed: Activity;
bosses: Bosses; bosses: Bosses;
} }
export type Modes = { [M in Gamemode]?: Stats }; export type Modes = { [M in Gamemode]?: Stats };
@@ -152,3 +186,63 @@ export interface PlayerActivityRow extends Activity {
name: string; name: string;
dead: boolean; dead: boolean;
} }
export interface GetStatsOptions {
/**
* Other game modes to fetch ranks for.
* @defaultvalue `['ironman', 'hardcore', 'ultimate']`
*/
otherGamemodes?: Extract<Gamemode, 'ironman' | 'hardcore' | 'ultimate'>[];
/**
* If true, the formatted RSN will be fetched. Otherwise it will return the provided, unformatted RSN.
* @defaultvalue `true`
*/
shouldGetFormattedRsn?: boolean;
/**
* Map of configs for each requests that can take place in the `getStats` function.
*/
axiosConfigs?: Partial<Record<Gamemode, AxiosRequestConfig>> & {
/**
* The axios request config object to use for the RSN format request.
*/
rsn?: AxiosRequestConfig;
};
}
export interface HiscoresCommon {
/**
* This field behaves more like an index than a true unique ID.
*/
id: number;
/**
* The display name of this skill / activity.
*/
name: string;
/**
* The player's official hiscores rank in this skill / activity.
*/
rank: number;
}
export interface HiscoresSkill extends HiscoresCommon {
/**
* The player's current level in this skill.
*/
level: number;
/**
* The player's current experience in this skill.
*/
xp: number;
}
export interface HiscoresActivity extends HiscoresCommon {
/**
* The player's current score in this activity.
*/
score: number;
}
export interface HiscoresResponse {
skills: HiscoresSkill[];
activities: HiscoresActivity[];
}

View File

@@ -4,11 +4,12 @@ import {
ClueType, ClueType,
Gamemode, Gamemode,
SkillName, SkillName,
ActivityName, ActivityName
} from '../types'; } from '../types';
export const BASE_URL = 'https://secure.runescape.com/m=hiscore_oldschool'; export const BASE_URL = 'https://secure.runescape.com/m=hiscore_oldschool';
export const STATS_URL = 'index_lite.ws?player='; export const STATS_URL = 'index_lite.ws?player=';
export const JSON_STATS_URL = 'index_lite.json?player=';
export const SCORES_URL = 'overall.ws?'; export const SCORES_URL = 'overall.ws?';
export type GamemodeUrl = { export type GamemodeUrl = {
@@ -23,6 +24,9 @@ export const GAMEMODE_URL: GamemodeUrl = {
deadman: `${BASE_URL}_deadman/`, deadman: `${BASE_URL}_deadman/`,
seasonal: `${BASE_URL}_seasonal/`, seasonal: `${BASE_URL}_seasonal/`,
tournament: `${BASE_URL}_tournament/`, tournament: `${BASE_URL}_tournament/`,
skiller: `${BASE_URL}_skiller/`,
oneDefence: `${BASE_URL}_skiller_defence/`,
freshStart: `${BASE_URL}_fresh_start/`
}; };
export const SKILLS: SkillName[] = [ export const SKILLS: SkillName[] = [
'overall', 'overall',
@@ -48,7 +52,7 @@ export const SKILLS: SkillName[] = [
'farming', 'farming',
'runecraft', 'runecraft',
'hunter', 'hunter',
'construction', 'construction'
]; ];
export const CLUES: ClueType[] = [ export const CLUES: ClueType[] = [
'all', 'all',
@@ -57,9 +61,9 @@ export const CLUES: ClueType[] = [
'medium', 'medium',
'hard', 'hard',
'elite', 'elite',
'master', 'master'
]; ];
export const BH_MODES: BHType[] = ['rogue', 'hunter']; export const BH_MODES: BHType[] = ['hunterV2', 'rogueV2', 'hunter', 'rogue'];
export const GAMEMODES: Gamemode[] = [ export const GAMEMODES: Gamemode[] = [
'main', 'main',
'ironman', 'ironman',
@@ -67,14 +71,16 @@ export const GAMEMODES: Gamemode[] = [
'ultimate', 'ultimate',
'deadman', 'deadman',
'seasonal', 'seasonal',
'tournament', 'tournament'
]; ];
export const BOSSES: Boss[] = [ export const BOSSES: Boss[] = [
'abyssalSire', 'abyssalSire',
'alchemicalHydra', 'alchemicalHydra',
'artio',
'barrows', 'barrows',
'bryophyta', 'bryophyta',
'callisto', 'callisto',
'calvarion',
'cerberus', 'cerberus',
'chambersOfXeric', 'chambersOfXeric',
'chambersOfXericChallengeMode', 'chambersOfXericChallengeMode',
@@ -87,6 +93,7 @@ export const BOSSES: Boss[] = [
'dagannothRex', 'dagannothRex',
'dagannothSupreme', 'dagannothSupreme',
'derangedArchaeologist', 'derangedArchaeologist',
'dukeSucellus',
'generalGraardor', 'generalGraardor',
'giantMole', 'giantMole',
'grotesqueGuardians', 'grotesqueGuardians',
@@ -97,26 +104,41 @@ export const BOSSES: Boss[] = [
'kreeArra', 'kreeArra',
'krilTsutsaroth', 'krilTsutsaroth',
'mimic', 'mimic',
'nex',
'nightmare', 'nightmare',
'phosanisNightmare',
'obor', 'obor',
'phantomMuspah',
'sarachnis', 'sarachnis',
'scorpia', 'scorpia',
'scurrius',
'skotizo', 'skotizo',
'spindel',
'tempoross',
'gauntlet', 'gauntlet',
'corruptedGauntlet', 'corruptedGauntlet',
'leviathan',
'whisperer',
'theatreOfBlood', 'theatreOfBlood',
'theatreOfBloodHardMode',
'thermonuclearSmokeDevil', 'thermonuclearSmokeDevil',
'tombsOfAmascut',
'tombsOfAmascutExpertMode',
'tzKalZuk', 'tzKalZuk',
'tzTokJad', 'tzTokJad',
'vardorvis',
'venenatis', 'venenatis',
'vetion', 'vetion',
'vorkath', 'vorkath',
'wintertodt', 'wintertodt',
'zalcano', 'zalcano',
'zulrah', 'zulrah'
]; ];
export const ACTIVITIES: ActivityName[] = [ export const ACTIVITIES: ActivityName[] = [
'leaguePoints', 'leaguePoints',
'deadmanPoints',
'hunterBHV2',
'rogueBHV2',
'hunterBH', 'hunterBH',
'rogueBH', 'rogueBH',
'allClues', 'allClues',
@@ -127,8 +149,10 @@ export const ACTIVITIES: ActivityName[] = [
'eliteClues', 'eliteClues',
'masterClues', 'masterClues',
'lastManStanding', 'lastManStanding',
'pvpArena',
'soulWarsZeal', 'soulWarsZeal',
...BOSSES, 'riftsClosed',
...BOSSES
]; ];
export type FormattedBossNames = { export type FormattedBossNames = {
@@ -138,9 +162,11 @@ export type FormattedBossNames = {
export const FORMATTED_BOSS_NAMES: FormattedBossNames = { export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
abyssalSire: 'Abyssal Sire', abyssalSire: 'Abyssal Sire',
alchemicalHydra: 'Alchemical Hydra', alchemicalHydra: 'Alchemical Hydra',
artio: 'Artio',
barrows: 'Barrows Chests', barrows: 'Barrows Chests',
bryophyta: 'Bryophyta', bryophyta: 'Bryophyta',
callisto: 'Callisto', callisto: 'Callisto',
calvarion: "Calvar'ion",
cerberus: 'Cerberus', cerberus: 'Cerberus',
chambersOfXeric: 'Chambers of Xeric', chambersOfXeric: 'Chambers of Xeric',
chambersOfXericChallengeMode: 'Chambers of Xeric: Challenge Mode', chambersOfXericChallengeMode: 'Chambers of Xeric: Challenge Mode',
@@ -153,6 +179,7 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
dagannothRex: 'Dagannoth Rex', dagannothRex: 'Dagannoth Rex',
dagannothSupreme: 'Dagannoth Supreme', dagannothSupreme: 'Dagannoth Supreme',
derangedArchaeologist: 'Deranged Archaeologist', derangedArchaeologist: 'Deranged Archaeologist',
dukeSucellus: 'Duke Sucellus',
generalGraardor: 'General Graardor', generalGraardor: 'General Graardor',
giantMole: 'Giant Mole', giantMole: 'Giant Mole',
grotesqueGuardians: 'Grotesque Guardians', grotesqueGuardians: 'Grotesque Guardians',
@@ -163,23 +190,35 @@ export const FORMATTED_BOSS_NAMES: FormattedBossNames = {
kreeArra: "Kree'Arra", kreeArra: "Kree'Arra",
krilTsutsaroth: "K'ril Tsutsaroth", krilTsutsaroth: "K'ril Tsutsaroth",
mimic: 'Mimic', mimic: 'Mimic',
nightmare: 'The Nightmare of Ashihama', nex: 'Nex',
nightmare: 'Nightmare',
phosanisNightmare: "Phosani's Nightmare",
obor: 'Obor', obor: 'Obor',
phantomMuspah: 'Phantom Muspah',
sarachnis: 'Sarachnis', sarachnis: 'Sarachnis',
scorpia: 'Scorpia', scorpia: 'Scorpia',
scurrius: 'Scurrius',
skotizo: 'Skotizo', skotizo: 'Skotizo',
spindel: 'Spindel',
tempoross: 'Tempoross',
gauntlet: 'The Gauntlet', gauntlet: 'The Gauntlet',
corruptedGauntlet: 'The Corrupted Gauntlet', corruptedGauntlet: 'The Corrupted Gauntlet',
leviathan: 'The Leviathan',
whisperer: 'The Whisperer',
theatreOfBlood: 'Theatre of Blood', theatreOfBlood: 'Theatre of Blood',
theatreOfBloodHardMode: 'Theatre of Blood: Hard Mode',
thermonuclearSmokeDevil: 'Thermonuclear Smoke Devil', thermonuclearSmokeDevil: 'Thermonuclear Smoke Devil',
tombsOfAmascut: 'Tombs of Amascut',
tombsOfAmascutExpertMode: 'Tombs of Amascut: Expert Mode',
tzKalZuk: 'TzKal-Zuk', tzKalZuk: 'TzKal-Zuk',
tzTokJad: 'TzTok-Jad', tzTokJad: 'TzTok-Jad',
vardorvis: 'Vardorvis',
venenatis: 'Venenatis', venenatis: 'Venenatis',
vetion: "Vet'ion", vetion: "Vet'ion",
vorkath: 'Vorkath', vorkath: 'Vorkath',
wintertodt: 'Wintertodt', wintertodt: 'Wintertodt',
zalcano: 'Zalcano', zalcano: 'Zalcano',
zulrah: 'Zulrah', zulrah: 'Zulrah'
}; };
export type FormattedSkillNames = { export type FormattedSkillNames = {
@@ -210,7 +249,7 @@ export const FORMATTED_SKILL_NAMES: FormattedSkillNames = {
farming: 'Farming', farming: 'Farming',
runecraft: 'Runecraft', runecraft: 'Runecraft',
hunter: 'Hunter', hunter: 'Hunter',
construction: 'Construction', construction: 'Construction'
}; };
export type FormattedClueNames = { export type FormattedClueNames = {
@@ -224,7 +263,7 @@ export const FORMATTED_CLUE_NAMES: FormattedClueNames = {
medium: 'Clue Scrolls (medium)', medium: 'Clue Scrolls (medium)',
hard: 'Clue Scrolls (hard)', hard: 'Clue Scrolls (hard)',
elite: 'Clue Scrolls (elite)', elite: 'Clue Scrolls (elite)',
master: 'Clue Scrolls (master)', master: 'Clue Scrolls (master)'
}; };
export type FormattedBHNames = { export type FormattedBHNames = {
@@ -232,10 +271,55 @@ export type FormattedBHNames = {
}; };
export const FORMATTED_BH_NAMES: FormattedBHNames = { export const FORMATTED_BH_NAMES: FormattedBHNames = {
rogue: 'Bounty Hunter - Rogue', rogue: 'Bounty Hunter (Legacy) - Rogue',
hunter: 'Bounty Hunter - Hunter', hunter: 'Bounty Hunter (Legacy) - Hunter',
rogueV2: 'Bounty Hunter - Rogue',
hunterV2: 'Bounty Hunter - Hunter'
}; };
export const FORMATTED_LMS = 'Last Man Standing'; export const FORMATTED_LMS = 'LMS - Rank';
export const FORMATTED_PVP_ARENA = 'PvP Arena - Rank';
export const FORMATTED_SOUL_WARS = 'Soul Wars Zeal'; export const FORMATTED_SOUL_WARS = 'Soul Wars Zeal';
export const FORMATTED_LEAGUE_POINTS = 'League Points'; export const FORMATTED_LEAGUE_POINTS = 'League Points';
export const FORMATTED_DEADMAN_POINTS = 'Deadman Points';
export const FORMATTED_RIFTS_CLOSED = 'Rifts closed';
export const INVALID_FORMAT_ERROR = 'Invalid hiscores format';
export const PLAYER_NOT_FOUND_ERROR = 'Player not found';
export const HISCORES_ERROR = 'HiScores not responding';
export class InvalidFormatError extends Error {
__proto__ = Error;
constructor() {
super(INVALID_FORMAT_ERROR);
Object.setPrototypeOf(this, InvalidFormatError.prototype);
}
}
export class InvalidRSNError extends Error {
__proto__ = Error;
constructor(message: string) {
super(message);
Object.setPrototypeOf(this, InvalidRSNError.prototype);
}
}
export class PlayerNotFoundError extends Error {
__proto__ = Error;
constructor() {
super(PLAYER_NOT_FOUND_ERROR);
Object.setPrototypeOf(this, PlayerNotFoundError.prototype);
}
}
export class HiScoresError extends Error {
__proto__ = Error;
constructor() {
super(HISCORES_ERROR);
Object.setPrototypeOf(this, HiScoresError.prototype);
}
}

View File

@@ -1,3 +1,5 @@
import axios, { AxiosRequestConfig } from 'axios';
import * as ua from 'useragent-generator';
import { Gamemode, SkillName, ActivityName } from '../types'; import { Gamemode, SkillName, ActivityName } from '../types';
import { import {
GAMEMODE_URL, GAMEMODE_URL,
@@ -5,16 +7,43 @@ import {
SCORES_URL, SCORES_URL,
SKILLS, SKILLS,
ACTIVITIES, ACTIVITIES,
JSON_STATS_URL,
InvalidRSNError
} from './constants'; } from './constants';
export const getStatsURL = (gamemode: Gamemode, rsn: string) => /**
`${GAMEMODE_URL[gamemode]}${STATS_URL}${encodeURIComponent(rsn)}`; * Will generate a stats URL for the official OSRS API.
*
* @param gamemode Gamemode to fetch ranks for.
* @param rsn Username of the player.
* @param json If the JSON endpoint is desired instead of CSV.
* @returns Encoded stats URL.
*/
export const getStatsURL = (gamemode: Gamemode, rsn: string, json = false) =>
`${GAMEMODE_URL[gamemode]}${
json ? JSON_STATS_URL : STATS_URL
}${encodeURIComponent(rsn)}`;
/**
* Will generate a player table URL for the official OSRS hiscores website.
*
* @param gamemode Gamemode to fetch ranks for.
* @param rsn Username of the player.
* @returns Encoded player table URL.
*/
export const getPlayerTableURL = (gamemode: Gamemode, rsn: string) => export const getPlayerTableURL = (gamemode: Gamemode, rsn: string) =>
`${GAMEMODE_URL[gamemode]}${SCORES_URL}table=0&user=${encodeURIComponent( `${GAMEMODE_URL[gamemode]}${SCORES_URL}table=0&user=${encodeURIComponent(
rsn rsn
)}`; )}`;
/**
* Will generate a skill table URL for the official OSRS hiscores website.
*
* @param gamemode Gamemode to fetch ranks for.
* @param skill Skill to fetch ranks for.
* @param page Page number.
* @returns
*/
export const getSkillPageURL = ( export const getSkillPageURL = (
gamemode: Gamemode, gamemode: Gamemode,
skill: SkillName, skill: SkillName,
@@ -24,6 +53,14 @@ export const getSkillPageURL = (
skill skill
)}&page=${page}`; )}&page=${page}`;
/**
* Will generate an activity table URL for the official OSRS hiscores website.
*
* @param gamemode Gamemode to fetch ranks for.
* @param activity Activity or boss to fetch ranks for.
* @param page Page number.
* @returns
*/
export const getActivityPageURL = ( export const getActivityPageURL = (
gamemode: Gamemode, gamemode: Gamemode,
activity: ActivityName, activity: ActivityName,
@@ -35,13 +72,58 @@ export const getActivityPageURL = (
activity activity
)}&page=${page}`; )}&page=${page}`;
/**
* Extracts a number from an OSRS hiscores table cell element.
*
* @param el OSRS hiscores table cell element.
* @returns Number parsed from cell text.
*/
export const numberFromElement = (el: Element | null) => { export const numberFromElement = (el: Element | null) => {
const { innerHTML } = el || {}; const { innerHTML } = el ?? {};
const number = innerHTML?.replace(/[\n|,]/g, '') ?? '-1'; const number = innerHTML?.replace(/[\n|,]/g, '') ?? '-1';
return parseInt(number, 10); return parseInt(number, 10);
}; };
/**
* Extracts a RSN from an OSRS hiscores table cell element.
*
* @param el OSRS hiscores table cell element.
* @returns RSN parsed from cell text.
*/
export const rsnFromElement = (el: Element | null) => { export const rsnFromElement = (el: Element | null) => {
const { innerHTML } = el || {}; const { innerHTML } = el ?? {};
return innerHTML?.replace(/\uFFFD/g, ' ') || ''; return innerHTML?.replace(/\uFFFD/g, ' ') ?? '';
};
/**
* Will run an Axios `GET` request against a given URL after injecting a `User-Agent` header.
*
* @param url URL to run a `GET` request against.
* @returns Axios response.
*/
export const httpGet = <Response>(
url: string,
config: AxiosRequestConfig = {}
) =>
axios.get<Response>(url, {
headers: {
// without User-Agent header requests may be rejected by DDoS protection mechanism
'User-Agent': ua.firefox(80)
},
...config
});
/**
* Validates that a provided RSN has the same username restrictions as Jagex.
* @param rsn Username to validate.
* @throws Error if the RSN fails validation.
*/
export const validateRSN = (rsn: string) => {
if (typeof rsn !== 'string') {
throw new InvalidRSNError('RSN must be a string');
} else if (!/^[a-zA-Z0-9 _-]+$/.test(rsn)) {
throw new InvalidRSNError('RSN contains invalid character');
} else if (rsn.length > 12 || rsn.length < 1) {
throw new InvalidRSNError('RSN must be between 1 and 12 characters');
}
}; };

11
tsconfig.eslint.json Normal file
View File

@@ -0,0 +1,11 @@
{
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"declaration": true,
"outDir": "./lib",
"strict": true
},
"include": ["src", "**/__tests__/*"],
"exclude": ["node_modules"]
}

View File

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

View File

@@ -1,20 +0,0 @@
{
"extends": ["tslint-config-airbnb", "tslint-config-prettier"],
"rules": {
"import-name": false,
"indent": [true, "spaces", 2],
"max-line-length": [true, 120],
"ter-arrow-parens": [false],
"strict-boolean-expressions": [false],
"variable-name": [false],
"semicolon": [true, "always", "ignore-bound-class-methods"],
"prefer-array-literal": [false],
"quotemark": [
true,
"single",
"jsx-double",
"avoid-escape",
"avoid-template"
]
}
}

7004
yarn.lock

File diff suppressed because it is too large Load Diff