osrs-tools 2.4.0 → 2.5.2

package/dist/runescape/tools/ClueScrollHelper.js

@@ -0,0 +1,103 @@
+/**
+ * Helper class for OSRS Clue Scrolls
+ * Handles casket opening simulation with accurate wiki-based reward odds
+ */
+import { getClueRewardsByTier, } from '../model/Item/ClueScrollRewards';
+/**
+ * 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
+ */
+export class ClueScrollHelper {
+    /**
+     * Select a random reward based on rarity tiers
+     * Uses item rarity values to create weighted selection
+     */
+    static selectRandomReward(rewards) {
+        const items = [];
+        let totalWeight = 0;
+        for (const { item, rarity } of Object.values(rewards)) {
+            const probability = 1 / rarity;
+            items.push({ item, probability });
+            totalWeight += probability;
+        }
+        const random = Math.random() * totalWeight;
+        let cumulative = 0;
+        for (const { item, probability } of items) {
+            cumulative += probability;
+            if (random < cumulative) {
+                return item;
+            }
+        }
+        // Fallback to last item if rounding errors occur
+        return items[items.length - 1].item;
+    }
+    /**
+     * Simulate opening a clue casket and return a random reward item
+     * @param tier The difficulty tier of the clue scroll
+     * @returns The Item object that is the reward
+     */
+    static openCasket(tier) {
+        const rewards = getClueRewardsByTier(tier);
+        return this.selectRandomReward(rewards);
+    }
+    /**
+     * 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, itemName) {
+        const rewards = getClueRewardsByTier(tier);
+        const reward = rewards[itemName];
+        return reward ? 1 / reward.rarity : 0;
+    }
+    /**
+     * Get the rarity denominator (X in "1 in X") for an item
+     */
+    static getItemRarity(tier, itemName) {
+        const rewards = getClueRewardsByTier(tier);
+        const reward = rewards[itemName];
+        return reward ? reward.rarity : 0;
+    }
+    /**
+     * Get all possible rewards for a tier as Item objects
+     */
+    static getPossibleRewards(tier) {
+        const rewards = getClueRewardsByTier(tier);
+        return Object.values(rewards).map(r => r.item);
+    }
+    /**
+     * Get all possible reward items names for a tier
+     */
+    static getPossibleRewardNames(tier) {
+        const rewards = getClueRewardsByTier(tier);
+        return Object.keys(rewards);
+    }
+    /**
+     * Simulate opening multiple caskets
+     * @param tier The clue tier
+     * @param count Number of caskets to open
+     * @returns Array of reward Item objects
+     */
+    static simulateMultiple(tier, count) {
+        const rewards = [];
+        for (let i = 0; i < count; i++) {
+            rewards.push(this.openCasket(tier));
+        }
+        return rewards;
+    }
+    /**
+     * Get reward statistics for a tier
+     */
+    static getRewardStats(tier) {
+        const rewards = getClueRewardsByTier(tier);
+        const items = Object.values(rewards);
+        return {
+            tier,
+            totalUnique: items.length,
+            rareItems: items.filter(r => r.rarity > 100).length,
+            commonItems: items.filter(r => r.rarity <= 50).length,
+        };
+    }
+}

package/dist/runescape/tools/experience.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Get experience required for a given level
+ * @param level
+ * @returns
+ */
+export declare function getExperienceForLevel(level: number): number;
+/**
+ * Get level for a given experience
+ * @param exp
+ * @returns
+ */
+export declare function getLevelForExperience(exp: number): number;
+/**
+ * Mapping of levels to experience points
+ */
+export declare const LEVEL_TO_EXPERIENCE: Record<number, number>;
+//# sourceMappingURL=experience.d.ts.map

package/dist/runescape/tools/experience.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"experience.d.ts","sourceRoot":"","sources":["../../../source/runescape/tools/experience.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAM3D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAOzD;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAoGtD,CAAC"}

package/dist/runescape/tools/getAccount.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=getAccount.d.ts.map

package/dist/runescape/tools/getAccount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAccount.d.ts","sourceRoot":"","sources":["../../../source/runescape/tools/getAccount.ts"],"names":[],"mappings":""}

package/dist/runescape/tools/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Tools Module
+ * Exports utility tools for OSRS data analysis and manipulation
+ */
+export * from "./experience";
+//# sourceMappingURL=index.d.ts.map

package/dist/runescape/tools/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../source/runescape/tools/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,cAAc,CAAC"}

package/dist/runescape/tools/index.js

@@ -0,0 +1,5 @@
+/**
+ * Tools Module
+ * Exports utility tools for OSRS data analysis and manipulation
+ */
+export * from "./experience";

package/dist/runescape/utils/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Utils Module
+ * Exports utility functions and helpers
+ */
+export * from "./validation";
+export * from "./skillUtils";
+//# sourceMappingURL=index.d.ts.map

package/dist/runescape/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../source/runescape/utils/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}

package/dist/runescape/utils/index.js

@@ -0,0 +1,6 @@
+/**
+ * Utils Module
+ * Exports utility functions and helpers
+ */
+export * from "./validation";
+export * from "./skillUtils";

package/dist/runescape/utils/skillUtils.d.ts

@@ -0,0 +1,67 @@
+import { Skill, SkillMetadata } from '../model/account/Skill';
+/**
+ * Utility functions for working with skills and skill metadata.
+ * Provides helper methods for validation, categorization, and metadata lookup.
+ */
+/**
+ * Get metadata for a specific skill.
+ * @param skill - The skill to get metadata for
+ * @returns The skill's metadata or undefined if not found
+ */
+export declare function getSkillMetadata(skill: Skill | string): SkillMetadata | undefined;
+/**
+ * Check if a skill is valid.
+ * @param skillName - The skill name to validate
+ * @returns true if the skill exists, false otherwise
+ */
+export declare function isValidSkill(skillName: string): boolean;
+/**
+ * Get all skills in a specific category.
+ * @param category - The category to filter by
+ * @returns Array of skills in that category
+ */
+export declare function getSkillsByCategory(category: "combat" | "gathering" | "production" | "support"): Skill[];
+/**
+ * Check if a skill level is valid.
+ * @param skill - The skill to check
+ * @param level - The level to validate
+ * @returns true if the level is between 1 and the skill's max level
+ */
+export declare function isValidLevel(skill: Skill | string, level: number): boolean;
+/**
+ * Check if a skill can be boosted.
+ * @param skill - The skill to check
+ * @returns true if the skill is boostable
+ */
+export declare function isBoostable(skill: Skill | string): boolean;
+/**
+ * Get the max level for a skill.
+ * @param skill - The skill to check
+ * @returns The maximum level for this skill, or 99 as default
+ */
+export declare function getMaxLevel(skill: Skill | string): number;
+/**
+ * Get category for a skill.
+ * @param skill - The skill to check
+ * @returns The category of the skill or undefined if not found
+ */
+export declare function getSkillCategory(skill: Skill | string): "combat" | "gathering" | "production" | "support" | undefined;
+/**
+ * Get all available skills.
+ * @returns Array of all skills in the game
+ */
+export declare function getAllSkills(): Skill[];
+/**
+ * Get all combat-related skills.
+ * @returns Array of combat category skills
+ */
+export declare function getCombatSkills(): Skill[];
+/**
+ * Get the total combat level from individual combat skills.
+ * Combat level formula: (Attack + Defence + 2*Strength + 2*Magic + 2*Ranged + Prayer) / 4 + 1
+ * This is a helper; actual calculation depends on account implementation.
+ * @param skillLevels - Object mapping skill names to levels
+ * @returns Calculated combat level
+ */
+export declare function calculateCombatLevel(skillLevels: Record<string, number>): number;
+//# sourceMappingURL=skillUtils.d.ts.map

package/dist/runescape/utils/skillUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"skillUtils.d.ts","sourceRoot":"","sources":["../../../source/runescape/utils/skillUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAkB,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAE9E;;;GAGG;AAEH;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,CAEjF;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,QAAQ,GAAG,WAAW,GAAG,YAAY,GAAG,SAAS,GAC1D,KAAK,EAAE,CAIT;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAI1E;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAEzD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,KAAK,GAAG,MAAM,GACpB,QAAQ,GAAG,WAAW,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,CAE/D;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,KAAK,EAAE,CAEtC;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAI,KAAK,EAAE,CAEzC;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAWhF"}

package/dist/runescape/utils/skillUtils.js

@@ -0,0 +1,99 @@
+import { Skill, SKILL_METADATA } from '../model/account/Skill';
+/**
+ * Utility functions for working with skills and skill metadata.
+ * Provides helper methods for validation, categorization, and metadata lookup.
+ */
+/**
+ * Get metadata for a specific skill.
+ * @param skill - The skill to get metadata for
+ * @returns The skill's metadata or undefined if not found
+ */
+export function getSkillMetadata(skill) {
+    return SKILL_METADATA[skill];
+}
+/**
+ * Check if a skill is valid.
+ * @param skillName - The skill name to validate
+ * @returns true if the skill exists, false otherwise
+ */
+export function isValidSkill(skillName) {
+    return skillName in SKILL_METADATA;
+}
+/**
+ * Get all skills in a specific category.
+ * @param category - The category to filter by
+ * @returns Array of skills in that category
+ */
+export function getSkillsByCategory(category) {
+    return Object.entries(SKILL_METADATA)
+        .filter(([_, meta]) => meta.category === category)
+        .map(([skill, _]) => skill);
+}
+/**
+ * Check if a skill level is valid.
+ * @param skill - The skill to check
+ * @param level - The level to validate
+ * @returns true if the level is between 1 and the skill's max level
+ */
+export function isValidLevel(skill, level) {
+    const meta = getSkillMetadata(skill);
+    if (!meta)
+        return false;
+    return level >= 1 && level <= meta.maxLevel;
+}
+/**
+ * Check if a skill can be boosted.
+ * @param skill - The skill to check
+ * @returns true if the skill is boostable
+ */
+export function isBoostable(skill) {
+    return getSkillMetadata(skill)?.isBoostable ?? false;
+}
+/**
+ * Get the max level for a skill.
+ * @param skill - The skill to check
+ * @returns The maximum level for this skill, or 99 as default
+ */
+export function getMaxLevel(skill) {
+    return getSkillMetadata(skill)?.maxLevel ?? 99;
+}
+/**
+ * Get category for a skill.
+ * @param skill - The skill to check
+ * @returns The category of the skill or undefined if not found
+ */
+export function getSkillCategory(skill) {
+    return getSkillMetadata(skill)?.category;
+}
+/**
+ * Get all available skills.
+ * @returns Array of all skills in the game
+ */
+export function getAllSkills() {
+    return Object.keys(SKILL_METADATA);
+}
+/**
+ * Get all combat-related skills.
+ * @returns Array of combat category skills
+ */
+export function getCombatSkills() {
+    return getSkillsByCategory("combat");
+}
+/**
+ * Get the total combat level from individual combat skills.
+ * Combat level formula: (Attack + Defence + 2*Strength + 2*Magic + 2*Ranged + Prayer) / 4 + 1
+ * This is a helper; actual calculation depends on account implementation.
+ * @param skillLevels - Object mapping skill names to levels
+ * @returns Calculated combat level
+ */
+export function calculateCombatLevel(skillLevels) {
+    const get = (skill) => skillLevels[skill] ?? 0;
+    const base = (get(Skill.Attack) +
+        get(Skill.Defence) +
+        2 * get(Skill.Strength) +
+        2 * get(Skill.Magic) +
+        2 * get(Skill.Ranged) +
+        get(Skill.Prayer)) /
+        4;
+    return Math.floor(base) + 1;
+}

package/dist/runescape/utils/validation.d.ts

@@ -0,0 +1,53 @@
+import { Skill } from '../model/account/Skill';
+/**
+ * Validates a skill level value
+ * @param level The level to validate
+ * @param skillName Name of the skill (for error context)
+ * @throws {ValidationError} If level is invalid
+ */
+export declare function validateSkillLevel(level: number, skillName: string): void;
+/**
+ * Validates quest points value
+ * @param points The quest points to validate
+ * @throws {ValidationError} If points value is invalid
+ */
+export declare function validateQuestPoints(points: number): void;
+/**
+ * Validates combat level value
+ * @param level The combat level to validate
+ * @throws {ValidationError} If level is invalid
+ */
+export declare function validateCombatLevel(level: number): void;
+/**
+ * Validates a skill name
+ * @param name The skill name to validate
+ * @throws {ValidationError} If name is invalid
+ */
+export declare function validateSkillName(name: string): void;
+/**
+ * Type guard for checking if a value is a valid skill name
+ * @param name The value to check
+ * @returns True if value is a valid skill name
+ */
+export declare function isValidSkillName(name: string): name is keyof typeof Skill;
+/**
+ * Validates experience (XP) value
+ * @param xp The XP value to validate
+ * @param skillName Name of the skill (for error context)
+ * @throws {ValidationError} If XP value is invalid
+ */
+export declare function validateExperience(xp: number, skillName: string): void;
+/**
+ * Validates rank value
+ * @param rank The rank value to validate
+ * @param context Additional context for error message
+ * @throws {ValidationError} If rank value is invalid
+ */
+export declare function validateRank(rank: number, context: string): void;
+/**
+ * Validates an account name
+ * @param name The account name to validate
+ * @throws {ValidationError} If name is invalid
+ */
+export declare function validateAccountName(name: string): void;
+//# sourceMappingURL=validation.d.ts.map

package/dist/runescape/utils/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../../source/runescape/utils/validation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAE/C;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAezE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAyBxD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAavD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAQpD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,MAAM,OAAO,KAAK,CAOzE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAsBtE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAchE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAiBtD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-tools",
-  "version": "2.4.0",
+  "version": "2.5.2",
   "description": "A comprehensive TypeScript library for Old School RuneScape (OSRS) data and utilities, including quest data, skill requirements, and game item information",
   "license": "MIT",
   "scripts": {
@@ -9,17 +9,12 @@
     "build:osrs-tools:npm": "tsc -p tsconfig.build.json",
     "coverage": "jest --coverage && codecov",
     "dev": "tsc --watch -p tsconfig.build.json",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "getAccountData": "ts-node tools/GetAccountData.ts",
-    "getQuestDetails": "ts-node tools/GetQuestDetails.ts",
-    "lint": "eslint \"{src,test}/**/*.ts\" --fix",
+    "format": "prettier --write \"source/**/*.ts\" \"test/**/*.ts\"",
+    "lint": "eslint \"{source,test}/**/*.ts\" --fix",
     "postpublish": "git push && git push --tags",
     "prebuild-backup": "npm run clean",
     "prepublishOnly": "npm run build && npm test",
     "preversion": "npm test",
-    "runExample": "ts-node examples/ExampleQuest.ts",
-    "scrapeQuestList": "ts-node tools/ScrapeQuestData.ts",
-    "scrapeSlayerData": "ts-node tools/ScrapeSlayerData.ts",
     "test": "jest",
     "test:ci": "jest --ci --coverage",
     "test:coverage": "jest --coverage",
@@ -55,12 +50,45 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.js"
-    }
+    },
+    "./account": {
+      "types": "./dist/runescape/model/account/index.d.ts",
+      "import": "./dist/runescape/model/account/index.js",
+      "require": "./dist/runescape/model/account/index.js"
+    },
+    "./diary": {
+      "types": "./dist/runescape/model/diaries/index.d.ts",
+      "import": "./dist/runescape/model/diaries/index.js",
+      "require": "./dist/runescape/model/diaries/index.js"
+    },
+    "./quest": {
+      "types": "./dist/runescape/model/quest/index.d.ts",
+      "import": "./dist/runescape/model/quest/index.js",
+      "require": "./dist/runescape/model/quest/index.js"
+    },
+    "./slayer": {
+      "types": "./dist/runescape/model/slayer/index.d.ts",
+      "import": "./dist/runescape/model/slayer/index.js",
+      "require": "./dist/runescape/model/slayer/index.js"
+    },
+    "./tools": {
+      "types": "./dist/runescape/tools/index.d.ts",
+      "import": "./dist/runescape/tools/index.js",
+      "require": "./dist/runescape/tools/index.js"
+    },
+    "./utils": {
+      "types": "./dist/runescape/utils/index.d.ts",
+      "import": "./dist/runescape/utils/index.js",
+      "require": "./dist/runescape/utils/index.js"
+    },
+    "./models/*": "./dist/runescape/model/Item/models/*"
   },
   "files": [
-    "dist"
+    "dist",
+    "public"
   ],
   "engines": {
     "node": ">=18"