osrs-tools 2.5.4 → 2.7.0

package/README.md

@@ -1,11 +1,3 @@
-
-
-Refer to modern Node Packages. Update the Package.json to ONLY need the modern dependencies, reduce packages as much as possible.
-
-
-
-
-
 # OSRS Tools
 
 [![NPM Version](https://img.shields.io/npm/v/osrs-tools.svg?style=for-the-badge)](https://www.npmjs.com/package/osrs-tools)
@@ -62,16 +54,11 @@ npm install osrs-json-hiscores
 The main `osrs-tools` export provides the most frequently used classes:
 
 ```typescript
-import { 
-  QuestTool, 
-  OsrsAccount, 
-  ClueScrollHelper,
-  Item 
-} from 'osrs-tools';
+import { QuestTool, OsrsAccount, ClueScrollHelper, Item } from "osrs-tools";
 
 // Use core API directly
 const questTool = new QuestTool();
-const account = OsrsAccount.fromJson({ name: 'Player123' });
+const account = OsrsAccount.fromJson({ name: "Player123" });
 ```
 
 ### Subpackage Imports (Tree-Shakeable)
@@ -80,31 +67,31 @@ Import from subpackages for more granular control and better tree-shaking:
 
 ```typescript
 // Quest module - access all quests and quest utilities
-import { QuestTool, DragonSlayerI } from 'osrs-tools/quest';
+import { QuestTool, DragonSlayerI } from "osrs-tools/quest";
 
 // Slayer module - slayer masters and utilities
-import { Duradel, SlayerMaster } from 'osrs-tools/slayer';
+import { Duradel, SlayerMaster } from "osrs-tools/slayer";
 
 // Account & skills
-import { OsrsAccount, Skill } from 'osrs-tools/account';
+import { OsrsAccount, Skill } from "osrs-tools/account";
 
 // Achievement diaries
-import { Ardougne, DiaryName } from 'osrs-tools/diary';
+import { Ardougne, DiaryName } from "osrs-tools/diary";
 
 // Tools & utilities
-import { ClueScrollHelper, experience } from 'osrs-tools/tools';
-import { cache, validation } from 'osrs-tools/utils';
+import { ClueScrollHelper, experience } from "osrs-tools/tools";
+import { cache, validation } from "osrs-tools/utils";
 ```
 
 ### Quest System
 
 ```typescript
 // Access a specific quest
-import { DragonSlayerI } from 'osrs-tools/quest';
+import { DragonSlayerI } from "osrs-tools/quest";
 
 // Or get by name from QuestTool
-import { QuestTool } from 'osrs-tools';
-const dragonSlayer = QuestTool.getQuestByName('Dragon Slayer');
+import { QuestTool } from "osrs-tools";
+const dragonSlayer = QuestTool.getQuestByName("Dragon Slayer");
 console.log(dragonSlayer.requirements);
 
 // Check quest completion requirements
@@ -116,7 +103,7 @@ const canComplete = questTool.canCompleteQuest(dragonSlayer);
 ### Slayer System
 
 ```typescript
-import { Duradel } from 'osrs-tools/slayer';
+import { Duradel } from "osrs-tools/slayer";
 
 // Get master's task list
 const tasks = Duradel.tasks;
@@ -130,11 +117,11 @@ console.log(task.requirements); // Shows requirements
 ### Account Management
 
 ```typescript
-import { OsrsAccount } from 'osrs-tools/account';
+import { OsrsAccount } from "osrs-tools/account";
 
 // Create/load account
 const account = OsrsAccount.fromJson({
-  name: 'Player123',
+  name: "Player123",
   skills: {
     attack: { level: 60 },
     strength: { level: 55 },
@@ -143,13 +130,13 @@ const account = OsrsAccount.fromJson({
 });
 
 // Get skill levels
-const attackLevel = account.getSkill('attack')?.level;
+const attackLevel = account.getSkill("attack")?.level;
 ```
 
 ### 3D Item Models
 
 ```typescript
-import { yellowPartyhatModelPath } from 'osrs-tools';
+import { yellowPartyhatModelPath } from "osrs-tools";
 
 console.log(yellowPartyhatModelPath);
 // "osrs-tools/models/YellowPartyhat.obj"
@@ -181,15 +168,15 @@ npm test
 
 ### Available Scripts
 
-| Command         | Description                    |
-| --------------- | ------------------------------ |
-| `build`         | Compile TypeScript to dist/    |
-| `dev`           | Watch mode compilation         |
-| `test`          | Run test suite                 |
-| `test:watch`    | Run tests in watch mode        |
-| `test:coverage` | Generate coverage report       |
-| `lint`          | Lint and fix code              |
-| `format`        | Format code with Prettier      |
+| Command         | Description                 |
+| --------------- | --------------------------- |
+| `build`         | Compile TypeScript to dist/ |
+| `dev`           | Watch mode compilation      |
+| `test`          | Run test suite              |
+| `test:watch`    | Run tests in watch mode     |
+| `test:coverage` | Generate coverage report    |
+| `lint`          | Lint and fix code           |
+| `format`        | Format code with Prettier   |
 
 ### Project Structure
 

package/dist/runescape/errors.js

@@ -7,7 +7,7 @@ export class ValidationError extends Error {
     context;
     constructor(fieldName, value, message, context) {
         super(message);
-        this.name = 'ValidationError';
+        this.name = "ValidationError";
         this.fieldName = fieldName;
         this.value = value;
         this.context = context;

package/dist/runescape/model/account/OsrsAccount.d.ts

@@ -77,6 +77,11 @@ interface OsrsAccountData {
     leaguePoints?: BossScore;
     deadmanPoints?: BossScore;
 }
+/**
+ * Represents an Old School RuneScape account with various properties and methods to access skills, bosses, clues, and other relevant data.
+ * The class is designed to be initialized from a JSON object that may come from an API response or other data source, and provides methods to retrieve specific information about the account.
+ * It also includes a method to convert the account data back into a JSON format, which can be useful for saving or transmitting the account information.
+ */
 declare class OsrsAccount {
     #private;
     constructor(data: OsrsAccountData);
@@ -104,6 +109,6 @@ declare class OsrsAccount {
     toString(): string;
     toJson(): OsrsAccountData;
 }
-export type { Bosses, BossScore, BountyHunter, Clues, ClueScore, OsrsAccountData, Skill, Skills, SkillsDetail, };
+export type { Bosses, BossScore, BountyHunter, Clues, ClueScore, OsrsAccountData, Skill, Skills, SkillsDetail };
 export { OsrsAccount };
 //# sourceMappingURL=OsrsAccount.d.ts.map

package/dist/runescape/model/account/OsrsAccount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OsrsAccount.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/account/OsrsAccount.ts"],"names":[],"mappings":"AAAA,UAAU,WAAW;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,UAAU,KAAK;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,eAAe;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,UAAU,eAAe;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE;QACL,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;KAC1C,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACxC,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,aAAa,CAAC,EAAE,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,UAAU,MAAM;IACd,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC;CAC5B;AAED,UAAU,YAAY;IACpB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW,CAAC;CAClC;AAED,UAAU,SAAS;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,MAAM;IACd,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,UAAU,SAAS;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,KAAK;IACb,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,UAAU,YAAY;IACpB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,UAAU,eAAe;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,aAAa,CAAC,EAAE,SAAS,CAAC;CAC3B;AAED,cAAM,WAAW;;gBAkBH,IAAI,EAAE,eAAe;IAmBjC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,WAAW;IAiDnD,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,YAAY,IAAI,YAAY,GAAG,SAAS,CAE3C;IAED,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED,IAAI,KAAK,IAAI,KAAK,GAAG,SAAS,CAE7B;IAED,IAAI,YAAY,IAAI,YAAY,GAAG,SAAS,CAE3C;IAED,IAAI,eAAe,IAAI,SAAS,GAAG,SAAS,CAE3C;IAED,IAAI,QAAQ,IAAI,SAAS,GAAG,SAAS,CAEpC;IAED,IAAI,YAAY,IAAI,SAAS,GAAG,SAAS,CAExC;IAED,IAAI,WAAW,IAAI,SAAS,GAAG,SAAS,CAEvC;IAED,IAAI,cAAc,IAAI,SAAS,GAAG,SAAS,CAE1C;IAED,IAAI,iBAAiB,IAAI,SAAS,GAAG,SAAS,CAE7C;IAED,IAAI,YAAY,IAAI,SAAS,GAAG,SAAS,CAExC;IAED,IAAI,aAAa,IAAI,SAAS,GAAG,SAAS,CAEzC;IAED,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAI9C,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAI1D,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIrD,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIrD,QAAQ,IAAI,MAAM;IAIlB,MAAM,IAAI,eAAe;CAoB1B;AAED,YAAY,EACV,MAAM,EACN,SAAS,EACT,YAAY,EACZ,KAAK,EACL,SAAS,EACT,eAAe,EACf,KAAK,EACL,MAAM,EACN,YAAY,GACb,CAAC;AAEF,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"OsrsAccount.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/account/OsrsAccount.ts"],"names":[],"mappings":"AAAA,UAAU,WAAW;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,UAAU,KAAK;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,eAAe;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,UAAU,eAAe;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE;QACL,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;KAC1C,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACxC,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,aAAa,CAAC,EAAE,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,UAAU,MAAM;IACd,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC;CAC5B;AAED,UAAU,YAAY;IACpB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW,CAAC;CAClC;AAED,UAAU,SAAS;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,MAAM;IACd,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,UAAU,SAAS;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,KAAK;IACb,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,UAAU,YAAY;IACpB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,UAAU,eAAe;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,aAAa,CAAC,EAAE,SAAS,CAAC;CAC3B;AAED;;;;GAIG;AACH,cAAM,WAAW;;gBAkBH,IAAI,EAAE,eAAe;IAmBjC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,WAAW;IA+CnD,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,YAAY,IAAI,YAAY,GAAG,SAAS,CAE3C;IAED,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED,IAAI,KAAK,IAAI,KAAK,GAAG,SAAS,CAE7B;IAED,IAAI,YAAY,IAAI,YAAY,GAAG,SAAS,CAE3C;IAED,IAAI,eAAe,IAAI,SAAS,GAAG,SAAS,CAE3C;IAED,IAAI,QAAQ,IAAI,SAAS,GAAG,SAAS,CAEpC;IAED,IAAI,YAAY,IAAI,SAAS,GAAG,SAAS,CAExC;IAED,IAAI,WAAW,IAAI,SAAS,GAAG,SAAS,CAEvC;IAED,IAAI,cAAc,IAAI,SAAS,GAAG,SAAS,CAE1C;IAED,IAAI,iBAAiB,IAAI,SAAS,GAAG,SAAS,CAE7C;IAED,IAAI,YAAY,IAAI,SAAS,GAAG,SAAS,CAExC;IAED,IAAI,aAAa,IAAI,SAAS,GAAG,SAAS,CAEzC;IAED,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAI9C,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAI1D,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIrD,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIrD,QAAQ,IAAI,MAAM;IAIlB,MAAM,IAAI,eAAe;CAoB1B;AAED,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;AAEhH,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/runescape/model/account/OsrsAccount.js

@@ -1,3 +1,8 @@
+/**
+ * Represents an Old School RuneScape account with various properties and methods to access skills, bosses, clues, and other relevant data.
+ * The class is designed to be initialized from a JSON object that may come from an API response or other data source, and provides methods to retrieve specific information about the account.
+ * It also includes a method to convert the account data back into a JSON format, which can be useful for saving or transmitting the account information.
+ */
 class OsrsAccount {
     #name;
     #combatLevel;
@@ -34,7 +39,7 @@ class OsrsAccount {
         this.#deadmanPoints = data.deadmanPoints;
     }
     static fromJson(json) {
-        const name = json.name || '';
+        const name = json.name || "";
         const combatLevel = json.main?.combatLevel ?? json.combatLevel ?? 3;
         const questPoints = json.main?.questPoints ?? json.questPoints ?? 0;
         // Accept both lower and upper case skill keys
@@ -51,9 +56,7 @@ class OsrsAccount {
         }
         const bosses = json.bosses ? { ...json.bosses } : undefined;
         const clues = json.clues ? { ...json.clues } : undefined;
-        const bountyHunter = json.bountyHunter
-            ? { ...json.bountyHunter }
-            : undefined;
+        const bountyHunter = json.bountyHunter ? { ...json.bountyHunter } : undefined;
         const lastManStanding = json.lastManStanding;
         const pvpArena = json.pvpArena;
         const soulWarsZeal = json.soulWarsZeal;

package/dist/runescape/model/clue/ClueScrollHelper.d.ts

@@ -1,79 +1,69 @@
 /**
  * Helper class for OSRS Clue Scrolls
  * Handles casket opening simulation with accurate wiki-based reward odds
+ *
+ * WIKI REFERENCE: https://oldschool.runescape.wiki/w/Clue_scrolls
+ * Each tier has unique mechanics documented in the reward casket pages
  */
-import { Item } from '../Item/Item';
+import { Item } from "../Item/Item";
 /**
  * Result of opening a casket - contains all rewards obtained
  */
 export interface CasketReward {
     items: Item[];
     count: number;
+    /** Optional: master clue if obtained from certain tiers */
+    masterClue?: Item;
 }
 /**
- * Main ClueScrollHelper class that provides methods to simulate clue scroll rewards, calculate probabilities, and list possible rewards
- *
- * Reference: https://oldschool.runescape.wiki/w/Clue_scrolls
+ * Main ClueScrollHelper class that provides methods to simulate clue scroll rewards
  */
 export declare class ClueScrollHelper {
-    /**
-     * Select a random reward based on rarity tiers
-     * Uses item rarity values to create weighted selection
-     */
-    private static selectRandomReward;
-    /**
-     * Determine the number of rewards in a casket
-     * Different tiers have different distributions
-     * For beginner: min 1, max 3, average 2
-     * For easy: min 2, max 4, average 3
-     * For medium: min 3, max 5, average 4
-     * For hard: min 4, max 6, average 5
-     * For elite: min 4, max 6, average 5
-     * For master: min 5, max 7, average 6
-     * @returns Number of rewards based on tier
-     */
-    private static getRewardCount;
-    /**
-     * Select a reward table for the given tier (for tiers with table-based mechanics)
-     * Returns items from the selected table
-     */
-    private static selectRewardTable;
     /**
      * Simulate opening a clue casket and return all rewards
+     *
+     * Uses tier-specific mechanics per OSRS Wiki documented behavior:
+     * - Beginner: 1-3 rewards with unique/cabbage sub-mechanic
+     * - Easy: 2-4 rewards + 1/50 master clue
+     * - Medium: 3-5 rewards (standard)
+     * - Hard: 4-6 rewards (standard)
+     * - Elite: 4-6 rewards + 1/5 master clue (bonus, doesn't consume slot)
+     * - Master: 5-7 rewards (standard)
+     *
      * @param tier The difficulty tier of the clue scroll
-     * @returns CasketReward containing all items and count
+     * @returns CasketReward containing all items, count, and optional master clue
      */
-    static openCasket(tier: 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master'): CasketReward;
+    static openCasket(tier: "beginner" | "easy" | "medium" | "hard" | "elite" | "master"): CasketReward;
     /**
      * Get the probability of obtaining a specific item from a casket as a fraction
      * @param tier The difficulty tier
      * @param itemName The item name to check probability for
      * @returns The probability as a fraction (e.g., 0.0278 for 1/36)
      */
-    static getItemProbability(tier: 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master', itemName: string): number;
+    static getItemProbability(tier: "beginner" | "easy" | "medium" | "hard" | "elite" | "master", itemName: string): number;
     /**
      * Get the rarity denominator (X in "1 in X") for an item
      */
-    static getItemRarity(tier: 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master', itemName: string): number;
+    static getItemRarity(tier: "beginner" | "easy" | "medium" | "hard" | "elite" | "master", itemName: string): number;
     /**
      * Get all possible rewards for a tier as Item objects
      */
-    static getPossibleRewards(tier: 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master'): Item[];
+    static getPossibleRewards(tier: "beginner" | "easy" | "medium" | "hard" | "elite" | "master"): Item[];
     /**
      * Get all possible reward items names for a tier
      */
-    static getPossibleRewardNames(tier: 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master'): string[];
+    static getPossibleRewardNames(tier: "beginner" | "easy" | "medium" | "hard" | "elite" | "master"): string[];
     /**
      * Simulate opening multiple caskets
      * @param tier The clue tier
      * @param count Number of caskets to open
      * @returns Array of all reward items
      */
-    static simulateMultiple(tier: 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master', count: number): Item[];
+    static simulateMultiple(tier: "beginner" | "easy" | "medium" | "hard" | "elite" | "master", count: number): Item[];
     /**
      * Get reward statistics for a tier
      */
-    static getRewardStats(tier: 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master'): {
+    static getRewardStats(tier: "beginner" | "easy" | "medium" | "hard" | "elite" | "master"): {
         tier: string;
         totalUnique: number;
         rareItems: number;

package/dist/runescape/model/clue/ClueScrollHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClueScrollHelper.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/clue/ClueScrollHelper.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAYpC;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,qBAAa,gBAAgB;IAC3B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAwBjC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAwC7B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IA0BhC;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,YAAY;IAkBnG;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAMvH;;OAEG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAMlH;;OAEG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,IAAI,EAAE;IAKrG;;OAEG;IACH,MAAM,CAAC,sBAAsB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,EAAE;IAK3G;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CACrB,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,EAClE,KAAK,EAAE,MAAM,GACZ,IAAI,EAAE;IAST;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG;QACzF,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;KACrB;CAWF"}
+{"version":3,"file":"ClueScrollHelper.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/clue/ClueScrollHelper.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAGpC;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB;AA+TD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,YAAY;IAmBnG;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAMvH;;OAEG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAMlH;;OAEG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,IAAI,EAAE;IAKrG;;OAEG;IACH,MAAM,CAAC,sBAAsB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,EAAE;IAK3G;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE;IASlH;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG;QACzF,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;KACrB;CAWF"}