osrs-json-hiscores 2.12.0 → 2.12.1

package/lib/index.d.ts

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

package/lib/index.js

@@ -1,17 +1,17 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var hiscores = require("./hiscores");
-__exportStar(require("./hiscores"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./utils"), exports);
-exports.default = hiscores;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var hiscores = require("./hiscores");
+__exportStar(require("./hiscores"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);
+exports.default = hiscores;

package/lib/types.d.ts

@@ -1,56 +1,68 @@
-export declare type Gamemode = 'main' | 'ironman' | 'ultimate' | 'hardcore' | 'deadman' | 'seasonal' | 'tournament' | 'skiller' | 'oneDefence' | 'freshStart';
-export interface Skill {
-    rank: number;
-    level: number;
-    xp: number;
-}
-export interface Activity {
-    rank: number;
-    score: number;
-}
-export declare 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 declare type Skills = {
-    [Name in SkillName]: Skill;
-};
-export declare type ClueType = 'all' | 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master';
-export declare type Clues = {
-    [Type in ClueType]: Activity;
-};
-export declare type BHType = 'rogue' | 'hunter';
-export declare type BH = {
-    [Type in BHType]: Activity;
-};
-export declare type Boss = 'abyssalSire' | 'alchemicalHydra' | 'barrows' | 'bryophyta' | 'callisto' | 'cerberus' | 'chambersOfXeric' | 'chambersOfXericChallengeMode' | 'chaosElemental' | 'chaosFanatic' | 'commanderZilyana' | 'corporealBeast' | 'crazyArchaeologist' | 'dagannothPrime' | 'dagannothRex' | 'dagannothSupreme' | 'derangedArchaeologist' | 'generalGraardor' | 'giantMole' | 'grotesqueGuardians' | 'hespori' | 'kalphiteQueen' | 'kingBlackDragon' | 'kraken' | 'kreeArra' | 'krilTsutsaroth' | 'mimic' | 'nex' | 'nightmare' | 'phosanisNightmare' | 'obor' | 'phantomMuspah' | 'sarachnis' | 'scorpia' | 'skotizo' | 'tempoross' | 'gauntlet' | 'corruptedGauntlet' | 'theatreOfBlood' | 'theatreOfBloodHardMode' | 'thermonuclearSmokeDevil' | 'tombsOfAmascut' | 'tombsOfAmascutExpertMode' | 'tzKalZuk' | 'tzTokJad' | 'venenatis' | 'vetion' | 'vorkath' | 'wintertodt' | 'zalcano' | 'zulrah';
-export declare type Bosses = {
-    [Type in Boss]: Activity;
-};
-export declare type ActivityName = 'leaguePoints' | 'hunterBH' | 'rogueBH' | 'lastManStanding' | 'pvpArena' | 'soulWarsZeal' | 'riftsClosed' | 'allClues' | 'beginnerClues' | 'easyClues' | 'mediumClues' | 'hardClues' | 'eliteClues' | 'masterClues' | Boss;
-export interface Stats {
-    skills: Skills;
-    clues: Clues;
-    leaguePoints: Activity;
-    bountyHunter: BH;
-    lastManStanding: Activity;
-    pvpArena: Activity;
-    soulWarsZeal: Activity;
-    riftsClosed: Activity;
-    bosses: Bosses;
-}
-export declare type Modes = {
-    [M in Gamemode]?: Stats;
-};
-export interface Player extends Modes {
-    name: string;
-    mode: Gamemode;
-    dead: boolean;
-    deulted: boolean;
-    deironed: boolean;
-}
-export interface PlayerSkillRow extends Skill {
-    name: string;
-    dead: boolean;
-}
-export interface PlayerActivityRow extends Activity {
-    name: string;
-    dead: boolean;
-}
+export declare type Gamemode = 'main' | 'ironman' | 'ultimate' | 'hardcore' | 'deadman' | 'seasonal' | 'tournament' | 'skiller' | 'oneDefence' | 'freshStart';
+export interface Skill {
+    rank: number;
+    level: number;
+    xp: number;
+}
+export interface Activity {
+    rank: number;
+    score: number;
+}
+export declare 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 declare type Skills = {
+    [Name in SkillName]: Skill;
+};
+export declare type ClueType = 'all' | 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master';
+export declare type Clues = {
+    [Type in ClueType]: Activity;
+};
+export declare type BHType = 'rogue' | 'hunter';
+export declare type BH = {
+    [Type in BHType]: Activity;
+};
+export declare type Boss = 'abyssalSire' | 'alchemicalHydra' | 'barrows' | 'bryophyta' | 'callisto' | 'cerberus' | 'chambersOfXeric' | 'chambersOfXericChallengeMode' | 'chaosElemental' | 'chaosFanatic' | 'commanderZilyana' | 'corporealBeast' | 'crazyArchaeologist' | 'dagannothPrime' | 'dagannothRex' | 'dagannothSupreme' | 'derangedArchaeologist' | 'generalGraardor' | 'giantMole' | 'grotesqueGuardians' | 'hespori' | 'kalphiteQueen' | 'kingBlackDragon' | 'kraken' | 'kreeArra' | 'krilTsutsaroth' | 'mimic' | 'nex' | 'nightmare' | 'phosanisNightmare' | 'obor' | 'phantomMuspah' | 'sarachnis' | 'scorpia' | 'skotizo' | 'tempoross' | 'gauntlet' | 'corruptedGauntlet' | 'theatreOfBlood' | 'theatreOfBloodHardMode' | 'thermonuclearSmokeDevil' | 'tombsOfAmascut' | 'tombsOfAmascutExpertMode' | 'tzKalZuk' | 'tzTokJad' | 'venenatis' | 'vetion' | 'vorkath' | 'wintertodt' | 'zalcano' | 'zulrah';
+export declare type Bosses = {
+    [Type in Boss]: Activity;
+};
+export declare type ActivityName = 'leaguePoints' | 'hunterBH' | 'rogueBH' | 'lastManStanding' | 'pvpArena' | 'soulWarsZeal' | 'riftsClosed' | 'allClues' | 'beginnerClues' | 'easyClues' | 'mediumClues' | 'hardClues' | 'eliteClues' | 'masterClues' | Boss;
+export interface Stats {
+    skills: Skills;
+    clues: Clues;
+    leaguePoints: Activity;
+    bountyHunter: BH;
+    lastManStanding: Activity;
+    pvpArena: Activity;
+    soulWarsZeal: Activity;
+    riftsClosed: Activity;
+    bosses: Bosses;
+}
+export declare type Modes = {
+    [M in Gamemode]?: Stats;
+};
+export interface Player extends Modes {
+    name: string;
+    mode: Gamemode;
+    dead: boolean;
+    deulted: boolean;
+    deironed: boolean;
+}
+export interface PlayerSkillRow extends Skill {
+    name: string;
+    dead: boolean;
+}
+export interface PlayerActivityRow extends Activity {
+    name: string;
+    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;
+}

package/lib/types.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/constants.d.ts

@@ -1,36 +1,36 @@
-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 SCORES_URL = "overall.ws?";
-export declare 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 type FormattedBossNames = {
-    [key in Boss]: string;
-};
-export declare const FORMATTED_BOSS_NAMES: FormattedBossNames;
-export declare type FormattedSkillNames = {
-    [key in SkillName]: string;
-};
-export declare const FORMATTED_SKILL_NAMES: FormattedSkillNames;
-export declare type FormattedClueNames = {
-    [key in ClueType]: string;
-};
-export declare const FORMATTED_CLUE_NAMES: FormattedClueNames;
-export declare type FormattedBHNames = {
-    [key in BHType]: string;
-};
-export declare const FORMATTED_BH_NAMES: FormattedBHNames;
-export declare const FORMATTED_LMS = "Last Man Standing";
-export declare const FORMATTED_PVP_ARENA = "PvP Arena";
-export declare const FORMATTED_SOUL_WARS = "Soul Wars Zeal";
-export declare const FORMATTED_LEAGUE_POINTS = "League Points";
-export declare const FORMATTED_RIFTS_CLOSED = "Rifts Closed";
-export declare const INVALID_FORMAT_ERROR = "Invalid hiscores format";
+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 SCORES_URL = "overall.ws?";
+export declare 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 type FormattedBossNames = {
+    [key in Boss]: string;
+};
+export declare const FORMATTED_BOSS_NAMES: FormattedBossNames;
+export declare type FormattedSkillNames = {
+    [key in SkillName]: string;
+};
+export declare const FORMATTED_SKILL_NAMES: FormattedSkillNames;
+export declare type FormattedClueNames = {
+    [key in ClueType]: string;
+};
+export declare const FORMATTED_CLUE_NAMES: FormattedClueNames;
+export declare type FormattedBHNames = {
+    [key in BHType]: string;
+};
+export declare const FORMATTED_BH_NAMES: FormattedBHNames;
+export declare const FORMATTED_LMS = "Last Man Standing";
+export declare const FORMATTED_PVP_ARENA = "PvP Arena";
+export declare const FORMATTED_SOUL_WARS = "Soul Wars Zeal";
+export declare const FORMATTED_LEAGUE_POINTS = "League Points";
+export declare const FORMATTED_RIFTS_CLOSED = "Rifts Closed";
+export declare const INVALID_FORMAT_ERROR = "Invalid hiscores format";