osrs-tools 2.4.0 → 2.5.2

package/dist/index.js

@@ -1,147 +1,33 @@
+/**
+ * OSRS Tools - Main Entry Point
+ * A comprehensive TypeScript library for Old School RuneScape data and utilities
+ *
+ * Core API exports:
+ * - QuestTool: Quest system and utilities
+ * - OsrsAccount: Player account management
+ * - Diaries: Achievement diary system
+ * - ClueScrollHelper: Clue scroll utilities
+ * - Item system and models
+ * - Slayer system and masters
+ *
+ * For individual quests and detailed submodule imports, use subpackage exports:
+ * - import { ... } from 'osrs-tools/quest' - Access all quest classes and utilities
+ * - import { ... } from 'osrs-tools/account' - Account and skill management
+ * - import { ... } from 'osrs-tools/slayer' - Slayer system
+ * - import { ... } from 'osrs-tools/diary' - Achievement diaries
+ * - import { ... } from 'osrs-tools/tools' - Utility tools
+ * - import { ... } from 'osrs-tools/utils' - Helper utilities
+ */
+// Core API exports - Most frequently used
 export * from "./runescape/model/quest/QuestTool";
-// Quest Exports
 export * from "./runescape/model/account/OsrsAccount";
-export * from "./runescape/model/quest/all/AKingdomDivided";
-export * from "./runescape/model/quest/all/AnimalMagnetism";
-export * from "./runescape/model/quest/all/AnotherSliceOfHAM";
-export * from "./runescape/model/quest/all/APorcineOfInterest";
-export * from "./runescape/model/quest/all/ASoulsBane";
-export * from "./runescape/model/quest/all/ATailOfTwoCats";
-export * from "./runescape/model/quest/all/ATasteOfHope";
-export * from "./runescape/model/quest/all/ATheatreOfBlood";
-export * from "./runescape/model/quest/all/BelowIceMountain";
-export * from "./runescape/model/quest/all/BetweenARock";
-export * from "./runescape/model/quest/all/BigChompyBirdHunting";
-export * from "./runescape/model/quest/all/Biohazard";
-export * from "./runescape/model/quest/all/BlackKnightsFortress";
-export * from "./runescape/model/quest/all/BoneVoyage";
-export * from "./runescape/model/quest/all/CabinFever";
-export * from "./runescape/model/quest/all/ClientOfKourend";
-export * from "./runescape/model/quest/all/ClockTower";
-export * from "./runescape/model/quest/all/ColdWar";
-export * from "./runescape/model/quest/all/Contact";
-export * from "./runescape/model/quest/all/CooksAssistant";
-export * from "./runescape/model/quest/all/CreatureOfFenkenstrain";
-export * from "./runescape/model/quest/all/DarknessOfHallowvale";
-export * from "./runescape/model/quest/all/DeathPlateau";
-export * from "./runescape/model/quest/all/DeathToTheDorgeshuun";
-export * from "./runescape/model/quest/all/DemonSlayer";
-export * from "./runescape/model/quest/all/DesertTreasure";
-export * from "./runescape/model/quest/all/DeviousMinds";
-export * from "./runescape/model/quest/all/DoricQuest";
-export * from "./runescape/model/quest/all/DoricsQuest";
-export * from "./runescape/model/quest/all/DragonSlayerI";
-export * from "./runescape/model/quest/all/DragonSlayerII";
-export * from "./runescape/model/quest/all/DreamMentor";
-export * from "./runescape/model/quest/all/DruidicRitual";
-export * from "./runescape/model/quest/all/DwarfCannon";
-export * from "./runescape/model/quest/all/EadgarsRuse";
-export * from "./runescape/model/quest/all/EaglesPeak";
-export * from "./runescape/model/quest/all/ElementalWorkshopI";
-export * from "./runescape/model/quest/all/ElementalWorkshopII";
-export * from "./runescape/model/quest/all/EnakhrasLament";
-export * from "./runescape/model/quest/all/EnlightenedJourney";
-export * from "./runescape/model/quest/all/FairytaleIGrowingPains";
-export * from "./runescape/model/quest/all/FairytaleIICureAQueen";
-export * from "./runescape/model/quest/all/FamilyCrest";
-export * from "./runescape/model/quest/all/FightArena";
-export * from "./runescape/model/quest/all/FishingContest";
-export * from "./runescape/model/quest/all/ForgettableTale";
-export * from "./runescape/model/quest/all/GardenOfTranquillity";
-export * from "./runescape/model/quest/all/GertrudesCat";
-export * from "./runescape/model/quest/all/GettingAhead";
-export * from "./runescape/model/quest/all/GhostsAhoy";
-export * from "./runescape/model/quest/all/GoblinDiplomacy";
-export * from "./runescape/model/quest/all/GrimTales";
-export * from "./runescape/model/quest/all/HauntedMine";
-export * from "./runescape/model/quest/all/HazeelCult";
-export * from "./runescape/model/quest/all/HeroesQuest";
-export * from "./runescape/model/quest/all/HolyGrail";
-export * from "./runescape/model/quest/all/HorrorFromTheDeep";
-export * from "./runescape/model/quest/all/IcthlarinsLittleHelper";
-export * from "./runescape/model/quest/all/ImpCatcher";
-export * from "./runescape/model/quest/all/InAidOfTheMyreque";
-export * from "./runescape/model/quest/all/InSearchOfTheMyreque";
-export * from "./runescape/model/quest/all/JunglePotion";
-export * from "./runescape/model/quest/all/KingsRansom";
-export * from "./runescape/model/quest/all/LegendsQuest";
-export * from "./runescape/model/quest/all/LostCity";
-export * from "./runescape/model/quest/all/LunarDiplomacy";
-export * from "./runescape/model/quest/all/MakingHistory";
-export * from "./runescape/model/quest/all/MerlinsCrystal";
-export * from "./runescape/model/quest/all/MonkeyMadness";
-export * from "./runescape/model/quest/all/MonkeyMadnessII";
-export * from "./runescape/model/quest/all/MonksFriend";
-export * from "./runescape/model/quest/all/MurderMystery";
-export * from "./runescape/model/quest/all/MyArmsBigAdventure";
-export * from "./runescape/model/quest/all/NatureSpirit";
-export * from "./runescape/model/quest/all/ObservatoryQuest";
-export * from "./runescape/model/quest/all/OlafsQuest";
-export * from "./runescape/model/quest/all/OneSmallFavour";
-export * from "./runescape/model/quest/all/PlagueCity";
-export * from "./runescape/model/quest/all/PriestInPeril";
-export * from "./runescape/model/quest/all/RagAndBoneMan";
-export * from "./runescape/model/quest/all/Ratcatchers";
-export * from "./runescape/model/quest/all/RecipeForDisaster";
-export * from "./runescape/model/quest/all/RecruitmentDrive";
-export * from "./runescape/model/quest/all/Regicide";
-export * from "./runescape/model/quest/all/RovingElves";
-export * from "./runescape/model/quest/all/RoyalTrouble";
-export * from "./runescape/model/quest/all/RumDeal";
-export * from "./runescape/model/quest/all/ScorpionCatcher";
-export * from "./runescape/model/quest/all/SeaSlug";
-export * from "./runescape/model/quest/all/ShadesOfMortton";
-export * from "./runescape/model/quest/all/ShadowOfTheStorm";
-export * from "./runescape/model/quest/all/SheepHerder";
-export * from "./runescape/model/quest/all/ShiloVillage";
-export * from "./runescape/model/quest/all/SlugMenace";
-export * from "./runescape/model/quest/all/SongOfTheElves";
-export * from "./runescape/model/quest/all/SpiritsOfTheElid";
-export * from "./runescape/model/quest/all/SwanSong";
-export * from "./runescape/model/quest/all/TaiBwoWannaiTrio";
-export * from "./runescape/model/quest/all/TheAscentOfArceuus";
-export * from "./runescape/model/quest/all/TheDepthsOfDespair";
-export * from "./runescape/model/quest/all/TheForsakenTower";
-export * from "./runescape/model/quest/all/TheFremennikExiles";
-export * from "./runescape/model/quest/all/TheFremennikIsles";
-export * from "./runescape/model/quest/all/TheFremennikTrials";
-export * from "./runescape/model/quest/all/TheGiantDwarf";
-export * from "./runescape/model/quest/all/TheGolem";
-export * from "./runescape/model/quest/all/TheGrandTree";
-export * from "./runescape/model/quest/all/TheGreatBrainRobbery";
-export * from "./runescape/model/quest/all/TheHandInTheSand";
-export * from "./runescape/model/quest/all/TheKnightsSword";
-export * from "./runescape/model/quest/all/TheLostTribe";
-export * from "./runescape/model/quest/all/TheQueenOfThieves";
-export * from "./runescape/model/quest/all/TheSlugMenace";
-export * from "./runescape/model/quest/all/TheTaleOfTheRighteous";
-export * from "./runescape/model/quest/all/TheTempleOfIkov";
-export * from "./runescape/model/quest/all/TheTouristTrap";
-export * from "./runescape/model/quest/all/ThroneOfMiscellania";
-export * from "./runescape/model/quest/all/TowerOfLife";
-export * from "./runescape/model/quest/all/TreeGnomeVillage";
-export * from "./runescape/model/quest/all/TribalTotem";
-export * from "./runescape/model/quest/all/TrollRomance";
-export * from "./runescape/model/quest/all/TrollStronghold";
-export * from "./runescape/model/quest/all/UndergroundPass";
-export * from "./runescape/model/quest/all/VampyreSlayer";
-export * from "./runescape/model/quest/all/Wanted";
-export * from "./runescape/model/quest/all/Watchtower";
-export * from "./runescape/model/quest/all/WaterfallQuest";
-export * from "./runescape/model/quest/all/WhatLiesBelow";
-export * from "./runescape/model/quest/all/WitchesPotion";
-export * from "./runescape/model/quest/all/WitchsHouse";
-export * from "./runescape/model/quest/all/ZogreFleshEaters";
-export * from "./runescape/model/quest/enums";
-export * from "./runescape/model/quest/Quest";
-export * from "./runescape/model/quest/Requirements";
-export * from "./runescape/model/quest/types";
-// Slayer Exports
+export * from "./runescape/model/diaries";
+export * from "./runescape/model/clue/ClueScrollHelper";
+// Item system
 export * from "./runescape/model/Item/Item";
-export * from "./runescape/model/slayer/Masters";
-export { SlayerBuys } from "./runescape/model/slayer/SlayerBuys";
-export { SlayerExtends } from "./runescape/model/slayer/SlayerExtends";
-export * from "./runescape/model/slayer/SlayerMaster";
-export { SlayerBuy, SlayerExtend, SlayerReward, SlayerUnlock } from "./runescape/model/slayer/SlayerReward";
-export { SlayerUnlocks } from "./runescape/model/slayer/SlayerUnlock";
-export * from "./runescape/model/slayer/Task";
+export * from "./runescape/model/Item/models";
+// Slayer system (refactored exports)
+export { SlayerMaster, Task, Assignment, Turael, Spria, Mazchna, Vannaka, Chaeldar, KonarQuoMaten, Nieve, Duradel, Krystilia, SlayerUnlock, SlayerExtend, SlayerBuy, SLAYER_UNLOCKS, SLAYER_EXTENDS, SLAYER_BUYS, SlayerLocation, SlayerBoss, POINTS_TABLE, getMasterByName, getAllMasters, getMastersByMinimumLevel, getMastersByProgression, } from "./runescape/model/slayer";
+// Core requirement types
+export * from "./runescape/model/Requirement";
+export * from "./runescape/errors";

package/dist/runescape/errors.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Custom error for validation failures in OSRS tools
+ */
+export declare class ValidationError extends Error {
+    readonly fieldName: string;
+    readonly value: unknown;
+    readonly context?: Record<string, unknown>;
+    constructor(fieldName: string, value: unknown, message: string, context?: Record<string, unknown>);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/runescape/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../source/runescape/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IACxC,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,SAAgB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAEtC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAOlG"}

package/dist/runescape/model/Item/ClueScrollRewards.js

@@ -0,0 +1,286 @@
+/**
+ * Clue Scroll Reward Item Mappings
+ * Organizes all clue scroll rewards by tier with their correct rarity tiers
+ * Based on official OSRS Wiki data
+ */
+import { AdamantPlatebody } from './all/AdamantPlatebody';
+import { AdamantPlatelegs } from './all/AdamantPlatelegs';
+import { AdamantShieldG } from './all/AdamantShieldG';
+import { AirRune } from './all/AirRune';
+import { AmuletOfMagic } from './all/AmuletOfMagic';
+import { AmuletOfMagicT } from './all/AmuletOfMagicT';
+import { AmuletOfPowerT } from './all/AmuletOfPowerT';
+import { AmuletOfTheVoid } from './all/AmuletOfTheVoid';
+import { AncestralRobeBottom } from './all/AncestralRobeBottom';
+import { AncestralRobeTop } from './all/AncestralRobeTop';
+import { BlackAxe } from './all/BlackAxe';
+import { BlackBattleaxe } from './all/BlackBattleaxe';
+import { BlackDagger } from './all/BlackDagger';
+import { BlackFullHelm } from './all/BlackFullHelm';
+import { BlackFullHelmT } from './all/BlackFullHelmT';
+import { BlackLongsword } from './all/BlackLongsword';
+import { BlackPlatebody } from './all/BlackPlatebody';
+import { BlackPlatebodyT } from './all/BlackPlatebodyT';
+import { BlackPlatelegs } from './all/BlackPlatelegs';
+import { BlackPlatelegsT } from './all/BlackPlatelegsT';
+import { BlackPickaxe } from './all/BlackPickaxe';
+import { BodyRune } from './all/BodyRune';
+import { BlueDHideBody } from './all/BlueDHideBody';
+import { BlueDHideChaps } from './all/BlueDHideChaps';
+import { CapeOfSkulls } from './all/CapeOfSkulls';
+import { ChaosRune } from './all/ChaosRune';
+import { Coins } from './all/Coins';
+import { Coif } from './all/Coif';
+import { CrawsBow } from './all/CrawsBow';
+import { DragonBoots } from './all/DragonBoots';
+import { DragonFullHelm } from './all/DragonFullHelm';
+import { DragonMediumHelm } from './all/DragonMediumHelm';
+import { DragonPlatebody } from './all/DragonPlatebody';
+import { DragonPlatelegs } from './all/DragonPlatelegs';
+import { EarthRune } from './all/EarthRune';
+import { FireRune } from './all/FireRune';
+import { FlaredTrousers } from './all/FlaredTrousersItem';
+import { GildedFullHelm } from './all/GildedFullHelm';
+import { GildedLegs } from './all/GildedLegs';
+import { GildedPlatebody } from './all/GildedPlatebody';
+import { GoldenApron } from './all/GoldenApron';
+import { GoldenChefsHat } from './all/GoldenChefsHat';
+import { GreenDHideBody } from './all/GreenDHideBody';
+import { HamJoint } from './all/HamJoint';
+import { IronBoots } from './all/IronBoots';
+import { IronFullHelm } from './all/IronFullHelm';
+import { IronFullHelmT } from './all/IronFullHelmT';
+import { IronPlatebody } from './all/IronPlatebody';
+import { IronPlatebodyT } from './all/IronPlatebodyT';
+import { IronPlatelegs } from './all/IronPlatelegs';
+import { LawRune } from './all/LawRune';
+import { MasterScrollBookEmpty } from './all/MasterScrollBookEmpty';
+import { MindRune } from './all/MindRune';
+import { MithrilBoots } from './all/MithrilBoots';
+import { MithrilFullHelm } from './all/MithrilFullHelm';
+import { MithrilPlatebody } from './all/MithrilPlatebody';
+import { MithrilPlatelegs } from './all/MithrilPlatelegs';
+import { MithrilShieldT } from './all/MithrilShieldT';
+import { MonksRobeG } from './all/MonksRobeG';
+import { MonksRobeTopG } from './all/MonksRobeTopG';
+import { NatureRune } from './all/NatureRune';
+import { RainBow } from './all/RainBow';
+import { RangerBoots } from './all/RangerBoots';
+import { RangerGloves } from './all/RangerGloves';
+import { RangerLegs } from './all/RangerLegs';
+import { RangerTunic } from './all/RangerTunic';
+import { RedDHideBody } from './all/RedDHideBody';
+import { RedDHideChaps } from './all/RedDHideChaps';
+import { RedElegantShirt } from './all/RedElegantShirt';
+import { RuneFullHelm } from './all/RuneFullHelm';
+import { RuneFullHelmT } from './all/RuneFullHelmT';
+import { RuneMediumHelm } from './all/RuneMediumHelm';
+import { RunePlatebody } from './all/RunePlatebody';
+import { RunePlatebodyT } from './all/RunePlatebodyT';
+import { RunePlatelegs } from './all/RunePlatelegs';
+import { RuniteBar } from './all/RuniteBar';
+import { Salmon } from './all/Salmon';
+import { StaffOfAir } from './all/StaffOfAir';
+import { StaffOfBobTheCat } from './all/StaffOfBobTheCat';
+import { SteelBoots } from './all/SteelBoots';
+import { SteelFullHelm } from './all/SteelFullHelm';
+import { SteelFullHelmT } from './all/SteelFullHelmT';
+import { SteelPickaxe } from './all/SteelPickaxe';
+import { SteelPlatebody } from './all/SteelPlatebody';
+import { SteelPlatebodyT } from './all/SteelPlatebodyT';
+import { SteelPlatelegs } from './all/SteelPlatelegs';
+import { StudiedBody } from './all/StudiedBody';
+import { StudiedChaps } from './all/StudiedChaps';
+import { TeamCapeI } from './all/TeamCapeI';
+import { TeamCapeX } from './all/TeamCapeX';
+import { TeamCapeZero } from './all/TeamCapeZero';
+import { ThammaronsSceptre } from './all/ThammaronsSceptre';
+import { ThirdAgeLongsword } from './all/ThirdAgeLongsword';
+import { ThirdAgePlatebody } from './all/ThirdAgePlatebody';
+import { ThirdAgePlatelegs } from './all/ThirdAgePlatelegs';
+import { TreasonousRing } from './all/TreasonousRing';
+import { Trout } from './all/Trout';
+import { TwistedBow } from './all/TwistedBow';
+import { UncutDiamond } from './all/UncutDiamond';
+import { UncutEmerald } from './all/UncutEmerald';
+import { UncutRuby } from './all/UncutRuby';
+import { UncutSapphire } from './all/UncutSapphire';
+import { WaterRune } from './all/WaterRune';
+import { WillowCompBow } from './all/WillowCompBow';
+import { WillowLongbow } from './all/WillowLongbow';
+import { WillowShortbow } from './all/WillowShortbow';
+import { WoodenShieldG } from './all/WoodenShieldG';
+/**
+ * Reward odds mapping for Beginner clue scrolls
+ * Items are organized with their rarity tiers (denominator)
+ */
+export const BEGINNER_REWARDS = {
+    'Iron full helm': { item: IronFullHelm, rarity: 10 },
+    'Iron platebody': { item: IronPlatebody, rarity: 10 },
+    'Iron platelegs': { item: IronPlatelegs, rarity: 10 },
+    'Iron boots': { item: IronBoots, rarity: 10 },
+    'Steel full helm': { item: SteelFullHelm, rarity: 15 },
+    'Steel platebody': { item: SteelPlatebody, rarity: 15 },
+    'Steel platelegs': { item: SteelPlatelegs, rarity: 15 },
+    'Steel boots': { item: SteelBoots, rarity: 15 },
+    'Mithril full helm': { item: MithrilFullHelm, rarity: 25 },
+    'Mithril platebody': { item: MithrilPlatebody, rarity: 25 },
+    'Mithril platelegs': { item: MithrilPlatelegs, rarity: 25 },
+    'Mithril boots': { item: MithrilBoots, rarity: 25 },
+    'Uncut sapphire': { item: UncutSapphire, rarity: 50 },
+    'Uncut emerald': { item: UncutEmerald, rarity: 50 },
+    'Uncut ruby': { item: UncutRuby, rarity: 50 },
+    'Uncut diamond': { item: UncutDiamond, rarity: 100 },
+};
+/**
+ * Reward odds mapping for Easy clue scrolls
+ */
+export const EASY_REWARDS = {
+    'Black full helm': { item: BlackFullHelm, rarity: 36 },
+    'Black platebody': { item: BlackPlatebody, rarity: 36 },
+    'Black platelegs': { item: BlackPlatelegs, rarity: 36 },
+    'Black longsword': { item: BlackLongsword, rarity: 36 },
+    'Black battleaxe': { item: BlackBattleaxe, rarity: 36 },
+    'Black axe': { item: BlackAxe, rarity: 36 },
+    'Black dagger': { item: BlackDagger, rarity: 36 },
+    'Steel pickaxe': { item: SteelPickaxe, rarity: 36 },
+    'Black pickaxe': { item: BlackPickaxe, rarity: 36 },
+    'Coif': { item: Coif, rarity: 36 },
+    'Studded body': { item: StudiedBody, rarity: 36 },
+    'Studded chaps': { item: StudiedChaps, rarity: 36 },
+    'Willow shortbow': { item: WillowShortbow, rarity: 36 },
+    'Staff of air': { item: StaffOfAir, rarity: 36 },
+    'Air rune': { item: AirRune, rarity: 36 },
+    'Mind rune': { item: MindRune, rarity: 36 },
+    'Water rune': { item: WaterRune, rarity: 36 },
+    'Earth rune': { item: EarthRune, rarity: 36 },
+    'Fire rune': { item: FireRune, rarity: 36 },
+    'Body rune': { item: BodyRune, rarity: 36 },
+    'Chaos rune': { item: ChaosRune, rarity: 36 },
+    'Nature rune': { item: NatureRune, rarity: 36 },
+    'Law rune': { item: LawRune, rarity: 36 },
+    'Trout': { item: Trout, rarity: 36 },
+    'Salmon': { item: Salmon, rarity: 36 },
+    'Coins (50-200)': { item: Coins, rarity: 36 },
+    'Willow longbow': { item: WillowLongbow, rarity: 40 },
+    'Amulet of magic': { item: AmuletOfMagic, rarity: 40 },
+    'Willow comp bow': { item: WillowCompBow, rarity: 360 },
+    'Amulet of magic (t)': { item: AmuletOfMagicT, rarity: 360 },
+    'Wooden shield (g)': { item: WoodenShieldG, rarity: 1404 },
+    'Black full helm (t)': { item: BlackFullHelmT, rarity: 1404 },
+    'Black platebody (t)': { item: BlackPlatebodyT, rarity: 1404 },
+    'Black platelegs (t)': { item: BlackPlatelegsT, rarity: 1404 },
+    'Steel full helm (t)': { item: SteelFullHelmT, rarity: 1404 },
+    'Steel platebody (t)': { item: SteelPlatebodyT, rarity: 1404 },
+    'Iron full helm (t)': { item: IronFullHelmT, rarity: 1404 },
+    'Iron platebody (t)': { item: IronPlatebodyT, rarity: 1404 },
+    'Flared trousers': { item: FlaredTrousers, rarity: 1404 },
+    'Ham joint': { item: HamJoint, rarity: 1404 },
+    'Staff of bob the cat': { item: StaffOfBobTheCat, rarity: 1404 },
+    'Amulet of power (t)': { item: AmuletOfPowerT, rarity: 1404 },
+    'Rain bow': { item: RainBow, rarity: 1404 },
+    'Master scroll book (empty)': { item: MasterScrollBookEmpty, rarity: 1404 },
+    'Golden chef\'s hat': { item: GoldenChefsHat, rarity: 2808 },
+    'Golden apron': { item: GoldenApron, rarity: 2808 },
+    'Red elegant shirt': { item: RedElegantShirt, rarity: 2808 },
+    'Team cape zero': { item: TeamCapeZero, rarity: 5616 },
+    'Team cape i': { item: TeamCapeI, rarity: 5616 },
+    'Team cape x': { item: TeamCapeX, rarity: 5616 },
+    'Cape of skulls': { item: CapeOfSkulls, rarity: 5616 },
+    'Monk\'s robe top (g)': { item: MonksRobeTopG, rarity: 14040 },
+    'Monk\'s robe (g)': { item: MonksRobeG, rarity: 14040 },
+};
+/**
+ * Reward odds mapping for Medium clue scrolls
+ */
+export const MEDIUM_REWARDS = {
+    'Mithril platebody': { item: MithrilPlatebody, rarity: 40 },
+    'Mithril platelegs': { item: MithrilPlatelegs, rarity: 40 },
+    'Adamant platebody': { item: AdamantPlatebody, rarity: 40 },
+    'Adamant platelegs': { item: AdamantPlatelegs, rarity: 40 },
+    'Rune medium helm': { item: RuneMediumHelm, rarity: 60 },
+    'Rune full helm': { item: RuneFullHelm, rarity: 60 },
+    'Ranger tunic': { item: RangerTunic, rarity: 60 },
+    'Mithril shield (t)': { item: MithrilShieldT, rarity: 240 },
+    'Adamant shield (g)': { item: AdamantShieldG, rarity: 240 },
+    'Green d\'hide body': { item: GreenDHideBody, rarity: 600 },
+};
+/**
+ * Reward odds mapping for Hard clue scrolls
+ */
+export const HARD_REWARDS = {
+    'Rune full helm': { item: RuneFullHelm, rarity: 48 },
+    'Rune platebody': { item: RunePlatebody, rarity: 48 },
+    'Rune platelegs': { item: RunePlatelegs, rarity: 48 },
+    'Runite bar': { item: RuniteBar, rarity: 48 },
+    'Blue d\'hide body': { item: BlueDHideBody, rarity: 64 },
+    'Blue d\'hide chaps': { item: BlueDHideChaps, rarity: 64 },
+    'Dragon medium helm': { item: DragonMediumHelm, rarity: 80 },
+    'Amulet of the void': { item: AmuletOfTheVoid, rarity: 108 },
+    'Rune full helm (t)': { item: RuneFullHelmT, rarity: 240 },
+    'Rune platebody (t)': { item: RunePlatebodyT, rarity: 240 },
+    'Ranger boots': { item: RangerBoots, rarity: 336 },
+    'Ranger gloves': { item: RangerGloves, rarity: 336 },
+    'Ranger tunic': { item: RangerTunic, rarity: 336 },
+    'Ranger legs': { item: RangerLegs, rarity: 336 },
+};
+/**
+ * Reward odds mapping for Elite clue scrolls
+ */
+export const ELITE_REWARDS = {
+    'Rune full helm': { item: RuneFullHelm, rarity: 36 },
+    'Dragon platebody': { item: DragonPlatebody, rarity: 50 },
+    'Dragon platelegs': { item: DragonPlatelegs, rarity: 50 },
+    'Dragon medium helm': { item: DragonMediumHelm, rarity: 50 },
+    'Red d\'hide body': { item: RedDHideBody, rarity: 45 },
+    'Red d\'hide chaps': { item: RedDHideChaps, rarity: 45 },
+    'Craw\'s bow': { item: CrawsBow, rarity: 360 },
+    'Thammaron\'s sceptre': { item: ThammaronsSceptre, rarity: 360 },
+    'Treasonous ring': { item: TreasonousRing, rarity: 360 },
+};
+/**
+ * Reward odds mapping for Master clue scrolls
+ */
+export const MASTER_REWARDS = {
+    'Gilded platebody': { item: GildedPlatebody, rarity: 12 },
+    'Gilded platelegs': { item: GildedLegs, rarity: 12 },
+    'Gilded full helm': { item: GildedFullHelm, rarity: 12 },
+    'Dragon full helm': { item: DragonFullHelm, rarity: 30 },
+    'Dragon platebody': { item: DragonPlatebody, rarity: 30 },
+    'Dragon platelegs': { item: DragonPlatelegs, rarity: 30 },
+    'Dragon boots': { item: DragonBoots, rarity: 30 },
+    'Twisted bow': { item: TwistedBow, rarity: 800 },
+    'Ancestral robe top': { item: AncestralRobeTop, rarity: 800 },
+    'Ancestral robe bottom': { item: AncestralRobeBottom, rarity: 800 },
+    '3rd age longsword': { item: ThirdAgeLongsword, rarity: 1000 },
+    '3rd age platebody': { item: ThirdAgePlatebody, rarity: 1000 },
+    '3rd age platelegs': { item: ThirdAgePlatelegs, rarity: 1000 },
+};
+/**
+ * Gets all reward odds for a specific clue tier
+ */
+export function getClueRewardsByTier(tier) {
+    switch (tier.toLowerCase()) {
+        case 'beginner':
+            return BEGINNER_REWARDS;
+        case 'easy':
+            return EASY_REWARDS;
+        case 'medium':
+            return MEDIUM_REWARDS;
+        case 'hard':
+            return HARD_REWARDS;
+        case 'elite':
+            return ELITE_REWARDS;
+        case 'master':
+            return MASTER_REWARDS;
+        default:
+            throw new Error(`Unknown clue tier: ${tier}`);
+    }
+}
+/**
+ * Gets all items for a specific tier as an array
+ */
+export function getClueItemsList(tier) {
+    const rewards = getClueRewardsByTier(tier);
+    return Object.values(rewards).map(r => r.item);
+}

package/dist/runescape/model/Item/Item.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Interface representing the JSON structure of an Item.
+ */
+export interface ItemJson {
+    id: number;
+    name: string;
+    examine: string;
+    value: number;
+    highAlch: number;
+    lowAlch: number;
+    weight: number;
+    members: boolean;
+    tradeable: boolean;
+    equipable: boolean;
+    releaseDate: string;
+    destroy: string;
+    questItem: boolean;
+    stackable: boolean;
+    noted: boolean;
+    officialWikiUrl: string;
+    iconUrl?: string;
+    attackStab?: number;
+    attackSlash?: number;
+    attackCrush?: number;
+    attackMagic?: number;
+    attackRanged?: number;
+    defenceStab?: number;
+    defenceSlash?: number;
+    defenceCrush?: number;
+    defenceMagic?: number;
+    defenceRanged?: number;
+    strengthBonus?: number;
+    rangedStrength?: number;
+    magicDamage?: number;
+    meleeStrength?: number;
+    prayer?: number;
+}
+/**
+ * Represents an item in the game. This class encapsulates all the properties and methods related to an item.
+ */
+export declare class Item {
+    id: number;
+    name: string;
+    examine: string;
+    value: number;
+    highAlch: number;
+    lowAlch: number;
+    weight: number;
+    members: boolean;
+    tradeable: boolean;
+    equipable: boolean;
+    releaseDate: string;
+    destroy: string;
+    questItem: boolean;
+    stackable: boolean;
+    noted: boolean;
+    notable: boolean;
+    officialWikiUrl: string;
+    iconUrl?: string;
+    attackStab?: number;
+    attackSlash?: number;
+    attackCrush?: number;
+    attackMagic?: number;
+    attackRanged?: number;
+    defenceStab?: number;
+    defenceSlash?: number;
+    defenceCrush?: number;
+    defenceMagic?: number;
+    defenceRanged?: number;
+    meleeStrength?: number;
+    rangedStrength?: number;
+    magicDamage?: number;
+    prayer?: number;
+    quantity: number;
+    constructor(id: number, name: string, examine: string, value: number, highAlch: number, lowAlch: number, weight: number, members: boolean, tradeable: boolean, equipable: boolean, releaseDate: string, destroy: string, questItem: boolean, stackable: boolean, noted: boolean, officialWikiUrl: string, iconUrl?: string, attackStab?: number, attackSlash?: number, attackCrush?: number, attackMagic?: number, attackRanged?: number, defenceStab?: number, defenceSlash?: number, defenceCrush?: number, defenceMagic?: number, defenceRanged?: number, meleeStrength?: number, rangedStrength?: number, magicDamage?: number, prayer?: number, quantity?: number, notable?: boolean);
+    get Id(): number;
+    set Id(value: number);
+    get Name(): string;
+    set Name(value: string);
+    get Examine(): string;
+    set Examine(value: string);
+    get Value(): number;
+    set Value(value: number);
+    get HighAlch(): number;
+    set HighAlch(value: number);
+    get LowAlch(): number;
+    set LowAlch(value: number);
+    get Weight(): number;
+    set Weight(value: number);
+    get Members(): boolean;
+    set Members(value: boolean);
+    get Tradeable(): boolean;
+    set Tradeable(value: boolean);
+    get Equipable(): boolean;
+    set Equipable(value: boolean);
+    get ReleaseDate(): string;
+    set ReleaseDate(value: string);
+    get Destroy(): string;
+    set Destroy(value: string);
+    get QuestItem(): boolean;
+    set QuestItem(value: boolean);
+    get Stackable(): boolean;
+    set Stackable(value: boolean);
+    get Noted(): boolean;
+    set Noted(value: boolean);
+    get OfficialWikiUrl(): string;
+    set OfficialWikiUrl(value: string);
+    get IconUrl(): string | undefined;
+    set IconUrl(value: string | undefined);
+    get AttackStab(): number | undefined;
+    set AttackStab(value: number | undefined);
+    get AttackSlash(): number | undefined;
+    set AttackSlash(value: number | undefined);
+    get AttackCrush(): number | undefined;
+    set AttackCrush(value: number | undefined);
+    get AttackMagic(): number | undefined;
+    set AttackMagic(value: number | undefined);
+    get AttackRanged(): number | undefined;
+    set AttackRanged(value: number | undefined);
+    get DefenceStab(): number | undefined;
+    set DefenceStab(value: number | undefined);
+    get DefenceSlash(): number | undefined;
+    set DefenceSlash(value: number | undefined);
+    get DefenceCrush(): number | undefined;
+    set DefenceCrush(value: number | undefined);
+    get DefenceMagic(): number | undefined;
+    set DefenceMagic(value: number | undefined);
+    get DefenceRanged(): number | undefined;
+    set DefenceRanged(value: number | undefined);
+    get MeleeStrength(): number | undefined;
+    set MeleeStrength(value: number | undefined);
+    get RangedStrength(): number | undefined;
+    set RangedStrength(value: number | undefined);
+    get MagicDamage(): number | undefined;
+    set MagicDamage(value: number | undefined);
+    get Prayer(): number | undefined;
+    set Prayer(value: number | undefined);
+    static fromJson(json: ItemJson): Item;
+}
+export interface ItemInstance extends Item {
+    quantity: number;
+}
+//# sourceMappingURL=Item.d.ts.map

package/dist/runescape/model/Item/Item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Item.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/Item/Item.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,qBAAa,IAAI;IACf,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,UAAS;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IAGjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;gBAGf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,OAAO,EAClB,SAAS,EAAE,OAAO,EAClB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,OAAO,EAClB,SAAS,EAAE,OAAO,EAClB,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,MAAM,EAEhB,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,EACpB,WAAW,CAAC,EAAE,MAAM,EACpB,WAAW,CAAC,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,MAAM,EACrB,WAAW,CAAC,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,MAAM,EACrB,YAAY,CAAC,EAAE,MAAM,EACrB,YAAY,CAAC,EAAE,MAAM,EACrB,aAAa,CAAC,EAAE,MAAM,EACtB,aAAa,CAAC,EAAE,MAAM,EACtB,cAAc,CAAC,EAAE,MAAM,EACvB,WAAW,CAAC,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,GAAE,OAAe;IAuC1B,IAAI,EAAE,IAGQ,MAAM,CADnB;IACD,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAEnB;IAED,IAAI,IAAI,IAGQ,MAAM,CADrB;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,EAErB;IAED,IAAI,OAAO,IAGQ,MAAM,CADxB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,EAExB;IAED,IAAI,KAAK,IAGQ,MAAM,CADtB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAEtB;IAED,IAAI,QAAQ,IAGQ,MAAM,CADzB;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED,IAAI,OAAO,IAGQ,MAAM,CADxB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,EAExB;IAED,IAAI,MAAM,IAGQ,MAAM,CADvB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED,IAAI,OAAO,IAGQ,OAAO,CADzB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED,IAAI,SAAS,IAGQ,OAAO,CAD3B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,EAE3B;IAED,IAAI,SAAS,IAGQ,OAAO,CAD3B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,EAE3B;IAED,IAAI,WAAW,IAGQ,MAAM,CAD5B;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,EAE5B;IAED,IAAI,OAAO,IAGQ,MAAM,CADxB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,EAExB;IAED,IAAI,SAAS,IAGQ,OAAO,CAD3B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,EAE3B;IAED,IAAI,SAAS,IAGQ,OAAO,CAD3B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,EAE3B;IAED,IAAI,KAAK,IAGQ,OAAO,CADvB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,EAEvB;IAED,IAAI,eAAe,IAGQ,MAAM,CADhC;IACD,IAAI,eAAe,CAAC,KAAK,EAAE,MAAM,EAEhC;IAED,IAAI,OAAO,IAGQ,MAAM,GAAG,SAAS,CADpC;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAEpC;IAGD,IAAI,UAAU,IAGQ,MAAM,GAAG,SAAS,CADvC;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAEvC;IAED,IAAI,WAAW,IAGQ,MAAM,GAAG,SAAS,CADxC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAExC;IAED,IAAI,WAAW,IAGQ,MAAM,GAAG,SAAS,CADxC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAExC;IAED,IAAI,WAAW,IAGQ,MAAM,GAAG,SAAS,CADxC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAExC;IAED,IAAI,YAAY,IAGQ,MAAM,GAAG,SAAS,CADzC;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAEzC;IAED,IAAI,WAAW,IAGQ,MAAM,GAAG,SAAS,CADxC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAExC;IAED,IAAI,YAAY,IAGQ,MAAM,GAAG,SAAS,CADzC;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAEzC;IAED,IAAI,YAAY,IAGQ,MAAM,GAAG,SAAS,CADzC;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAEzC;IAED,IAAI,YAAY,IAGQ,MAAM,GAAG,SAAS,CADzC;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAEzC;IAED,IAAI,aAAa,IAGQ,MAAM,GAAG,SAAS,CAD1C;IACD,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAE1C;IAED,IAAI,aAAa,IAGQ,MAAM,GAAG,SAAS,CAD1C;IACD,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAE1C;IAED,IAAI,cAAc,IAGQ,MAAM,GAAG,SAAS,CAD3C;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAE3C;IAED,IAAI,WAAW,IAGQ,MAAM,GAAG,SAAS,CADxC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAExC;IAED,IAAI,MAAM,IAGQ,MAAM,GAAG,SAAS,CADnC;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAEnC;IAED,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;CAmCtC;AAGD,MAAM,WAAW,YAAa,SAAQ,IAAI;IACxC,QAAQ,EAAE,MAAM,CAAC;CAClB"}