osrs-tools 2.2.1 → 2.3.3

package/README.md

@@ -1,207 +1,175 @@
-# OSRS Tools
-
-[![NPM Version](https://img.shields.io/npm/v/osrs-tools.svg?style=for-the-badge)](https://www.npmjs.com/package/osrs-tools)
-[![Downloads](https://img.shields.io/npm/dm/osrs-tools.svg?style=for-the-badge)](https://www.npmjs.com/package/osrs-tools)
-[![TypeScript](https://img.shields.io/badge/TypeScript-4.9+-blue.svg?style=for-the-badge)](https://www.typescriptlang.org)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
-[![Node Version](https://img.shields.io/node/v/osrs-tools.svg?style=for-the-badge)](https://nodejs.org)
-[![Test Coverage](https://img.shields.io/codecov/c/github/jamescer/osrs-tools.svg?style=for-the-badge)](https://codecov.io/gh/jamescer/osrs-tools)
-
-> A modern TypeScript library for Old School RuneScape (OSRS) data and utilities. Built for developers creating tools, bots, web applications, and analytics around OSRS content.
-
-📦 **Type-safe**   🚀 **Well-tested**   📚 **Documented**   🔄 **Actively maintained**
-
-## Live Demo
-
-Explore the project interactively on CodeSandbox:
-
-[![Edit on CodeSandbox](https://img.shields.io/badge/CodeSandbox-View-blue?logo=codesandbox&style=for-the-badge)](https://codesandbox.io/p/sandbox/xtgp9k)
-
----
-
-## Table of Contents
-
-- [Features](#features)
-- [Installation](#installation)
-- [Examples](#examples)
-- [Development](#development)
-- [Contributing](#contributing)
-- [Support](#support)
-- [License](#license)
-
-## Features
-
-✨ **Quest System**
-
-- Complete quest database with requirements and rewards
-- Quest dependency tracking and validation
-- Experience and item reward calculations
-- Quest point tracking
-- Support for miniquests
-
-🎯 **Skill & Level System**
-
-- Skill level tracking and validation
-- Support for boostable requirements
-- Combat level calculations
-- Quest point requirements
-
-🗡️ **Items & Equipment**
-
-- Comprehensive item database
-- Equipment statistics
-- Trading and value information
-- Quest item tracking
-
-👹 **Slayer System**
-
-- Full slayer master task lists
-- Task weights and assignment logic
-- Slayer requirement validation
-- Reward shop data
-
-## Installation
-
-### Prerequisites
-
-- Node.js 16.x or higher
-- TypeScript 4.9+
-
-### Package Installation
-
-```bash
-npm install osrs-tools
-```
-
-For account-related features (hiscores, stats):
-
-```bash
-npm install osrs-json-hiscores
-```
-
-## Examples
-
-### Quest System
-
-```typescript
-import { QuestTool, Quest } from 'osrs-tools';
-
-// Get quest information
-const dragonSlayer = QuestTool.getQuestByName('Dragon Slayer');
-console.log(dragonSlayer.requirements);
-
-// Check quest completion requirements
-const questTool = new QuestTool();
-questTool.setOsrsAccount(playerAccount);
-const canComplete = questTool.canCompleteQuest(dragonSlayer);
-```
-
-### Slayer System
-
-```typescript
-import { Duradel } from 'osrs-tools';
-
-// Get master's task list
-const tasks = Duradel.tasks;
-
-// Get random assignment
-const task = Duradel.getRandomTask();
-console.log(task.name); // e.g., "Abyssal demons"
-console.log(task.requirements); // Shows requirements
-```
-
-### Account Management
-
-```typescript
-import { OsrsAccount } from 'osrs-tools';
-
-// Create/load account
-const account = OsrsAccount.fromJson({
-  name: 'Player123',
-  skills: {
-    attack: { level: 60 },
-    strength: { level: 55 },
-    defence: { level: 50 },
-  },
-});
-
-// Get skill levels
-const attackLevel = account.getSkill('attack')?.level;
-```
-
-### Documentation Links
-
-- [Full API Documentation](https://github.com/jamescer/osrs-tools/wiki)
-- [Type Definitions](https://github.com/jamescer/osrs-tools/blob/master/src/model/quest/types.ts)
-- [Code Examples](https://github.com/jamescer/osrs-tools//examples)
-
-## Development
-
-### Local Setup
-
-```bash
-# Clone and setup
-git clone https://github.com/jamescer/osrs-tools.git
-cd osrs-tools
-npm install
-
-# Build and test
-npm run build
-npm test
-```
-
-### Available Scripts
-
-| Command      | Description             |
-| ------------ | ----------------------- |
-| `build`      | Build the project       |
-| `test`       | Run tests               |
-| `test:watch` | Run tests in watch mode |
-| `lint`       | Lint the code           |
-| `format`     | Format the code         |
-| `docs`       | Generate documentation  |
-
-## Contributing
-
-We welcome contributions! We use [Conventional Commits](https://www.conventionalcommits.org/).
-
-### Getting Started
-
-1. Fork and clone the repository
-2. Create a branch (`feat/amazing-feature`)
-3. Make your changes
-4. Run tests (`npm test && npm run lint`)
-5. Commit with conventional format:
-
-   ```bash
-   feat: add quest requirement validation
-   fix: correct slayer task weights
-   docs: update API documentation
-   ```
-
-6. Push and open a Pull Request
-
-### Guidelines
-
-- Add tests for new features
-- Update documentation for changes
-- Follow existing code style
-- Keep changes focused
-
-## Support
-
-Need help or want to contribute?
-
-- [Report Issues](https://github.com/jamescer/osrs-tools/issues)
-- [Request Features](https://github.com/jamescer/osrs-tools/issues)
-- [Join Discussions](https://github.com/jamescer/osrs-tools/discussions)
-
-## License
-
-[MIT](./LICENSE) © James Cerniglia
-
-## Credits
-
-- **Author**: [James Cerniglia](mailto:jamesmcerniglia@gmail.com)
-- **Contributors**: [View all contributors](https://github.com/jamescer/osrs-tools/graphs/contributors)
-- **Data Source**: [Old School RuneScape Wiki](https://oldschool.runescape.wiki/)
+# OSRS Tools
+
+[![NPM Version](https://img.shields.io/npm/v/osrs-tools.svg?style=for-the-badge)](https://www.npmjs.com/package/osrs-tools)
+[![Downloads](https://img.shields.io/npm/dm/osrs-tools.svg?style=for-the-badge)](https://www.npmjs.com/package/osrs-tools)
+[![TypeScript](https://img.shields.io/badge/TypeScript-4.9+-blue.svg?style=for-the-badge)](https://www.typescriptlang.org)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
+[![Node Version](https://img.shields.io/node/v/osrs-tools.svg?style=for-the-badge)](https://nodejs.org)
+[![Test Coverage](https://img.shields.io/codecov/c/github/jamescer/osrs-tools.svg?style=for-the-badge)](https://codecov.io/gh/jamescer/osrs-tools)
+
+> A modern TypeScript library for Old School RuneScape (OSRS) data and utilities. Built for developers creating tools, bots, web applications, and analytics around OSRS content.
+
+📦 **Type-safe**   🚀 **Well-tested**   📚 **Documented**   🔄 **Actively maintained**
+
+## Live Demo
+
+Explore the project interactively on CodeSandbox:
+
+[![Edit on CodeSandbox](https://img.shields.io/badge/CodeSandbox-View-blue?logo=codesandbox&style=for-the-badge)](https://codesandbox.io/p/sandbox/xtgp9k)
+
+---
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Examples](#examples)
+- [Development](#development)
+- [Contributing](#contributing)
+- [Support](#support)
+- [License](#license)
+
+## Installation
+
+### Prerequisites
+
+- Node.js 16.x or higher
+- TypeScript 4.9+
+
+### Package Installation
+
+```bash
+npm install osrs-tools
+```
+
+For account-related features (hiscores, stats):
+
+```bash
+npm install osrs-json-hiscores
+```
+
+## Examples
+
+### Quest System
+
+```typescript
+import { QuestTool, Quest } from 'osrs-tools';
+
+// Get quest information
+const dragonSlayer = QuestTool.getQuestByName('Dragon Slayer');
+console.log(dragonSlayer.requirements);
+
+// Check quest completion requirements
+const questTool = new QuestTool();
+questTool.setOsrsAccount(playerAccount);
+const canComplete = questTool.canCompleteQuest(dragonSlayer);
+```
+
+### Slayer System
+
+```typescript
+import { Duradel } from 'osrs-tools';
+
+// Get master's task list
+const tasks = Duradel.tasks;
+
+// Get random assignment
+const task = Duradel.getRandomTask();
+console.log(task.name); // e.g., "Abyssal demons"
+console.log(task.requirements); // Shows requirements
+```
+
+### Account Management
+
+```typescript
+import { OsrsAccount } from 'osrs-tools';
+
+// Create/load account
+const account = OsrsAccount.fromJson({
+  name: 'Player123',
+  skills: {
+    attack: { level: 60 },
+    strength: { level: 55 },
+    defence: { level: 50 },
+  },
+});
+
+// Get skill levels
+const attackLevel = account.getSkill('attack')?.level;
+```
+
+### Documentation Links
+
+- [Full API Documentation](https://github.com/jamescer/osrs-tools/wiki)
+- [Type Definitions](https://github.com/jamescer/osrs-tools/blob/master/src/model/quest/types.ts)
+- [Code Examples](https://github.com/jamescer/osrs-tools//examples)
+
+## Development
+
+### Local Setup
+
+```bash
+# Clone and setup
+git clone https://github.com/jamescer/osrs-tools.git
+cd osrs-tools
+npm install
+
+# Build and test
+npm run build
+npm test
+```
+
+### Available Scripts
+
+| Command      | Description             |
+| ------------ | ----------------------- |
+| `build`      | Build the project       |
+| `test`       | Run tests               |
+| `test:watch` | Run tests in watch mode |
+| `lint`       | Lint the code           |
+| `format`     | Format the code         |
+| `docs`       | Generate documentation  |
+
+## Contributing
+
+We welcome contributions! We use [Conventional Commits](https://www.conventionalcommits.org/).
+
+### Getting Started
+
+1. Fork and clone the repository
+2. Create a branch (`feat/amazing-feature`)
+3. Make your changes
+4. Run tests (`npm test && npm run lint`)
+5. Commit with conventional format:
+
+   ```bash
+   feat: add quest requirement validation
+   fix: correct slayer task weights
+   docs: update API documentation
+   ```
+
+6. Push and open a Pull Request
+
+### Guidelines
+
+- Add tests for new features
+- Update documentation for changes
+- Follow existing code style
+- Keep changes focused
+
+## Support
+
+Need help or want to contribute?
+
+- [Report Issues](https://github.com/jamescer/osrs-tools/issues)
+- [Request Features](https://github.com/jamescer/osrs-tools/issues)
+- [Join Discussions](https://github.com/jamescer/osrs-tools/discussions)
+
+## License
+
+[MIT](./LICENSE) © James Cerniglia
+
+## Credits
+
+- **Author**: [James Cerniglia](mailto:jamesmcerniglia@gmail.com)
+- **Contributors**: [View all contributors](https://github.com/jamescer/osrs-tools/graphs/contributors)
+- **Data Source**: [Old School RuneScape Wiki](https://oldschool.runescape.wiki/)

package/dist/out-tsc/source/examples/ExampleQuest.js

@@ -0,0 +1,19 @@
+//  this would be the real import
+// import { QuestTool } from 'osrs-tools';
+import { QuestTool } from '../runescape/model/quest/QuestTool';
+/**
+ * This is a code example file for the OSRS Tools library.
+ * It is not part of the main library and is intended for demonstration purposes only.
+ */
+// Example: Retrieve a quest by name
+const questName = 'Dragon Slayer I';
+const quest = QuestTool.getQuestByName(questName);
+if (quest) {
+    console.log(`Quest found: ${quest.name}`);
+    console.log(`Difficulty: ${quest.difficulty}`);
+    console.log(`Length: ${quest.length}`);
+    console.log(`Description: ${quest.description}`);
+}
+else {
+    console.log(`Quest "${questName}" not found.`);
+}

package/dist/out-tsc/source/index.js

@@ -0,0 +1,147 @@
+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/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";

package/dist/out-tsc/source/runescape/errors.js

@@ -0,0 +1,15 @@
+/**
+ * Custom error for validation failures in OSRS tools
+ */
+export class ValidationError extends Error {
+    fieldName;
+    value;
+    context;
+    constructor(fieldName, value, message, context) {
+        super(message);
+        this.name = 'ValidationError';
+        this.fieldName = fieldName;
+        this.value = value;
+        this.context = context;
+    }
+}