osrs-json-hiscores 2.23.0 → 2.24.0

package/lib/hiscores.d.ts

@@ -1,5 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
-import { Player, Stats, Gamemode, SkillName, PlayerSkillRow, ActivityName, PlayerActivityRow, GetStatsOptions, HiscoresResponse } from './types';
+import { Player, Stats, PlayerSkillRow, PlayerActivityRow, GetStatsOptions, HiscoresResponse } from './types';
+import { Gamemode, SkillName, ActivityName } from './utils';
 /**
  * Gets a player's stats from the official OSRS JSON endpoint.
  *

package/lib/types.d.ts

@@ -1,5 +1,5 @@
 import { AxiosRequestConfig } from 'axios';
-export type Gamemode = 'main' | 'ironman' | 'ultimate' | 'hardcore' | 'deadman' | 'seasonal' | 'tournament' | 'skiller' | 'oneDefence' | 'freshStart';
+import { BHType, Boss, ClueType, Gamemode, SkillName } from './utils';
 export interface Skill {
     rank: number;
     level: number;
@@ -9,23 +9,18 @@ export interface Activity {
     rank: number;
     score: number;
 }
-export type SkillName = 'overall' | 'attack' | 'defence' | 'strength' | 'hitpoints' | 'ranged' | 'prayer' | 'magic' | 'cooking' | 'woodcutting' | 'fletching' | 'fishing' | 'firemaking' | 'crafting' | 'smithing' | 'mining' | 'herblore' | 'agility' | 'thieving' | 'slayer' | 'farming' | 'runecraft' | 'hunter' | 'construction';
 export type Skills = {
     [Name in SkillName]: Skill;
 };
-export type ClueType = 'all' | 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master';
 export type Clues = {
     [Type in ClueType]: Activity;
 };
-export type BHType = 'rogue' | 'hunter' | 'rogueV2' | 'hunterV2';
 export type BH = {
     [Type in BHType]: Activity;
 };
-export type Boss = 'abyssalSire' | 'alchemicalHydra' | 'amoxliatl' | 'araxxor' | 'artio' | 'barrows' | 'bryophyta' | 'callisto' | 'calvarion' | 'cerberus' | 'chambersOfXeric' | 'chambersOfXericChallengeMode' | 'chaosElemental' | 'chaosFanatic' | 'commanderZilyana' | 'corporealBeast' | 'crazyArchaeologist' | 'dagannothPrime' | 'dagannothRex' | 'dagannothSupreme' | 'derangedArchaeologist' | 'doomOfMokhaiotl' | 'dukeSucellus' | 'generalGraardor' | 'giantMole' | 'grotesqueGuardians' | 'hespori' | 'kalphiteQueen' | 'kingBlackDragon' | 'kraken' | 'kreeArra' | 'krilTsutsaroth' | 'lunarChests' | 'mimic' | 'nex' | 'nightmare' | 'phosanisNightmare' | 'obor' | 'phantomMuspah' | 'sarachnis' | 'scorpia' | 'scurrius' | 'skotizo' | 'solHeredit' | 'spindel' | 'tempoross' | 'gauntlet' | 'corruptedGauntlet' | 'hueycoatl' | 'leviathan' | 'royalTitans' | 'whisperer' | 'theatreOfBlood' | 'theatreOfBloodHardMode' | 'thermonuclearSmokeDevil' | 'tombsOfAmascut' | 'tombsOfAmascutExpertMode' | 'tzKalZuk' | 'tzTokJad' | 'vardorvis' | 'venenatis' | 'vetion' | 'vorkath' | 'wintertodt' | 'yama' | 'zalcano' | 'zulrah';
 export type Bosses = {
     [Type in Boss]: Activity;
 };
-export type ActivityName = 'leaguePoints' | 'deadmanPoints' | 'hunterBHV2' | 'rogueBHV2' | 'hunterBH' | 'rogueBH' | 'lastManStanding' | 'pvpArena' | 'soulWarsZeal' | 'riftsClosed' | 'allClues' | 'beginnerClues' | 'easyClues' | 'mediumClues' | 'hardClues' | 'eliteClues' | 'masterClues' | 'colosseumGlory' | 'collectionsLogged' | Boss;
 export interface Stats {
     skills: Skills;
     clues: Clues;
@@ -49,7 +44,7 @@ export interface Stats {
 export type Modes = {
     [M in Gamemode]?: Stats;
 };
-export interface Player extends Modes {
+export interface Player extends Pick<Modes, 'main' | 'ironman' | 'hardcore' | 'ultimate'> {
     name: string;
     mode: Gamemode;
     dead: boolean;

package/lib/utils/constants.d.ts

@@ -1,4 +1,3 @@
-import { BHType, Boss, ClueType, Gamemode, SkillName, ActivityName } from '../types';
 export declare const BASE_URL = "https://secure.runescape.com/m=hiscore_oldschool";
 export declare const STATS_URL = "index_lite.ws?player=";
 export declare const JSON_STATS_URL = "index_lite.json?player=";
@@ -7,12 +6,18 @@ export type GamemodeUrl = {
     [key in Gamemode]: string;
 };
 export declare const GAMEMODE_URL: GamemodeUrl;
-export declare const SKILLS: SkillName[];
-export declare const CLUES: ClueType[];
-export declare const BH_MODES: BHType[];
-export declare const GAMEMODES: Gamemode[];
-export declare const BOSSES: Boss[];
-export declare const ACTIVITIES: ActivityName[];
+export declare const SKILLS: readonly ["overall", "attack", "defence", "strength", "hitpoints", "ranged", "prayer", "magic", "cooking", "woodcutting", "fletching", "fishing", "firemaking", "crafting", "smithing", "mining", "herblore", "agility", "thieving", "slayer", "farming", "runecraft", "hunter", "construction", "sailing"];
+export type SkillName = (typeof SKILLS)[number];
+export declare const CLUES: readonly ["all", "beginner", "easy", "medium", "hard", "elite", "master"];
+export type ClueType = (typeof CLUES)[number];
+export declare const BH_MODES: readonly ["hunterV2", "rogueV2", "hunter", "rogue"];
+export type BHType = (typeof BH_MODES)[number];
+export declare const GAMEMODES: readonly ["main", "ironman", "hardcore", "ultimate", "deadman", "seasonal", "tournament", "skiller", "oneDefence", "freshStart"];
+export type Gamemode = (typeof GAMEMODES)[number];
+export declare const BOSSES: readonly ["abyssalSire", "alchemicalHydra", "amoxliatl", "araxxor", "artio", "barrows", "bryophyta", "callisto", "calvarion", "cerberus", "chambersOfXeric", "chambersOfXericChallengeMode", "chaosElemental", "chaosFanatic", "commanderZilyana", "corporealBeast", "crazyArchaeologist", "dagannothPrime", "dagannothRex", "dagannothSupreme", "derangedArchaeologist", "doomOfMokhaiotl", "dukeSucellus", "generalGraardor", "giantMole", "grotesqueGuardians", "hespori", "kalphiteQueen", "kingBlackDragon", "kraken", "kreeArra", "krilTsutsaroth", "lunarChests", "mimic", "nex", "nightmare", "phosanisNightmare", "obor", "phantomMuspah", "sarachnis", "scorpia", "scurrius", "shellbaneGryphon", "skotizo", "solHeredit", "spindel", "tempoross", "gauntlet", "corruptedGauntlet", "hueycoatl", "leviathan", "royalTitans", "whisperer", "theatreOfBlood", "theatreOfBloodHardMode", "thermonuclearSmokeDevil", "tombsOfAmascut", "tombsOfAmascutExpertMode", "tzKalZuk", "tzTokJad", "vardorvis", "venenatis", "vetion", "vorkath", "wintertodt", "yama", "zalcano", "zulrah"];
+export type Boss = (typeof BOSSES)[number];
+export declare const ACTIVITIES: readonly ["leaguePoints", "deadmanPoints", "hunterBHV2", "rogueBHV2", "hunterBH", "rogueBH", "allClues", "beginnerClues", "easyClues", "mediumClues", "hardClues", "eliteClues", "masterClues", "lastManStanding", "pvpArena", "soulWarsZeal", "riftsClosed", "colosseumGlory", "collectionsLogged", "abyssalSire", "alchemicalHydra", "amoxliatl", "araxxor", "artio", "barrows", "bryophyta", "callisto", "calvarion", "cerberus", "chambersOfXeric", "chambersOfXericChallengeMode", "chaosElemental", "chaosFanatic", "commanderZilyana", "corporealBeast", "crazyArchaeologist", "dagannothPrime", "dagannothRex", "dagannothSupreme", "derangedArchaeologist", "doomOfMokhaiotl", "dukeSucellus", "generalGraardor", "giantMole", "grotesqueGuardians", "hespori", "kalphiteQueen", "kingBlackDragon", "kraken", "kreeArra", "krilTsutsaroth", "lunarChests", "mimic", "nex", "nightmare", "phosanisNightmare", "obor", "phantomMuspah", "sarachnis", "scorpia", "scurrius", "shellbaneGryphon", "skotizo", "solHeredit", "spindel", "tempoross", "gauntlet", "corruptedGauntlet", "hueycoatl", "leviathan", "royalTitans", "whisperer", "theatreOfBlood", "theatreOfBloodHardMode", "thermonuclearSmokeDevil", "tombsOfAmascut", "tombsOfAmascutExpertMode", "tzKalZuk", "tzTokJad", "vardorvis", "venenatis", "vetion", "vorkath", "wintertodt", "yama", "zalcano", "zulrah"];
+export type ActivityName = (typeof ACTIVITIES)[number];
 export type FormattedBossNames = {
     [key in Boss]: string;
 };

package/lib/utils/constants.js

@@ -65,7 +65,8 @@ exports.SKILLS = [
     'farming',
     'runecraft',
     'hunter',
-    'construction'
+    'construction',
+    'sailing'
 ];
 exports.CLUES = [
     'all',
@@ -84,7 +85,10 @@ exports.GAMEMODES = [
     'ultimate',
     'deadman',
     'seasonal',
-    'tournament'
+    'tournament',
+    'skiller',
+    'oneDefence',
+    'freshStart'
 ];
 exports.BOSSES = [
     'abyssalSire',
@@ -129,6 +133,7 @@ exports.BOSSES = [
     'sarachnis',
     'scorpia',
     'scurrius',
+    'shellbaneGryphon',
     'skotizo',
     'solHeredit',
     'spindel',
@@ -219,6 +224,7 @@ exports.FORMATTED_BOSS_NAMES = {
     sarachnis: 'Sarachnis',
     scorpia: 'Scorpia',
     scurrius: 'Scurrius',
+    shellbaneGryphon: 'Shellbane Gryphon',
     skotizo: 'Skotizo',
     solHeredit: 'Sol Heredit',
     spindel: 'Spindel',
@@ -269,7 +275,8 @@ exports.FORMATTED_SKILL_NAMES = {
     farming: 'Farming',
     runecraft: 'Runecraft',
     hunter: 'Hunter',
-    construction: 'Construction'
+    construction: 'Construction',
+    sailing: 'Sailing'
 };
 exports.FORMATTED_CLUE_NAMES = {
     all: 'Clue Scrolls (all)',

package/lib/utils/helpers.d.ts

@@ -1,5 +1,5 @@
 import { AxiosRequestConfig } from 'axios';
-import { Gamemode, SkillName, ActivityName } from '../types';
+import { Gamemode, SkillName, ActivityName } from './constants';
 /**
  * Will generate a stats URL for the official OSRS API.
  *
@@ -55,7 +55,7 @@ export declare const rsnFromElement: (el: Element | null) => string;
  * @param url URL to run a `GET` request against.
  * @returns Axios response.
  */
-export declare const httpGet: <Response_1>(url: string, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<Response_1, any>>;
+export declare const httpGet: <Response_1>(url: string, config?: AxiosRequestConfig) => Promise<import("axios").AxiosResponse<Response_1, any, {}>>;
 /**
  * Validates that a provided RSN has the same username restrictions as Jagex.
  * @param rsn Username to validate.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-json-hiscores",
-  "version": "2.23.0",
+  "version": "2.24.0",
   "description": "The Old School Runescape API wrapper that does more!",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",