osrs-tools 2.6.0 → 2.8.0

package/README.md

@@ -1,270 +1,257 @@
-
-
-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)
-[![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
-
-### Core Imports (Recommended)
-
-The main `osrs-tools` export provides the most frequently used classes:
-
-```typescript
-import { 
-  QuestTool, 
-  OsrsAccount, 
-  ClueScrollHelper,
-  Item 
-} from 'osrs-tools';
-
-// Use core API directly
-const questTool = new QuestTool();
-const account = OsrsAccount.fromJson({ name: 'Player123' });
-```
-
-### Subpackage Imports (Tree-Shakeable)
-
-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';
-
-// Slayer module - slayer masters and utilities
-import { Duradel, SlayerMaster } from 'osrs-tools/slayer';
-
-// Account & skills
-import { OsrsAccount, Skill } from 'osrs-tools/account';
-
-// Achievement diaries
-import { Ardougne, DiaryName } from 'osrs-tools/diary';
-
-// Tools & utilities
-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';
-
-// Or get by name from QuestTool
-import { QuestTool } from 'osrs-tools';
-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/slayer';
-
-// 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/account';
-
-// 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;
-```
-
-### 3D Item Models
-
-```typescript
-import { yellowPartyhatModelPath } from 'osrs-tools';
-
-console.log(yellowPartyhatModelPath);
-// "osrs-tools/models/YellowPartyhat.obj"
-```
-
-- **Node.js**: resolve the shipped asset with `require.resolve(yellowPartyhatModelPath)` and read it with `fs.readFileSync(...)`.
-- **Bundlers**: import the raw asset directly from `osrs-tools/models/YellowPartyhat.obj` or use a `?url` suffix if your bundler supports it.
-
-### 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`         | 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
-
-```
-source/                          # TypeScript source code
-├── index.ts                      # Main entry point
-├── runescape/
-│   ├── model/
-│   │   ├── account/             # Player account & skills
-│   │   ├── diaries/             # Achievement diaries
-│   │   ├── quest/               # Quest system
-│   │   │   ├── all/             # Individual quest classes
-│   │   │   └── index.ts         # Quest module export
-│   │   ├── slayer/              # Slayer system
-│   │   ├── Item/                # Item models
-│   │   └── npc/                 # NPC data
-│   ├── tools/                   # Utility tools (ClueScrollHelper, experience calc, etc.)
-│   ├── utils/                   # Helper utilities (cache, validation, etc.)
-│   └── errors.ts                # Custom error types
-└── examples/                    # Usage examples
-
-test/                            # Jest test suite
-└── unit/
-    ├── account/
-    ├── diaries/
-    ├── quest/
-    ├── slayer/
-    ├── model/
-    ├── tools/
-    └── utils/
-
-dist/                            # Compiled output (generated by build)
-```
-
-## 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
+
+### Core Imports (Recommended)
+
+The main `osrs-tools` export provides the most frequently used classes:
+
+```typescript
+import { QuestTool, OsrsAccount, ClueScrollHelper, Item } from "osrs-tools";
+
+// Use core API directly
+const questTool = new QuestTool();
+const account = OsrsAccount.fromJson({ name: "Player123" });
+```
+
+### Subpackage Imports (Tree-Shakeable)
+
+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";
+
+// Slayer module - slayer masters and utilities
+import { Duradel, SlayerMaster } from "osrs-tools/slayer";
+
+// Account & skills
+import { OsrsAccount, Skill } from "osrs-tools/account";
+
+// Achievement diaries
+import { Ardougne, DiaryName } from "osrs-tools/diary";
+
+// Tools & utilities
+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";
+
+// Or get by name from QuestTool
+import { QuestTool } from "osrs-tools";
+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/slayer";
+
+// 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/account";
+
+// 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;
+```
+
+### 3D Item Models
+
+```typescript
+import { yellowPartyhatModelPath } from "osrs-tools";
+
+console.log(yellowPartyhatModelPath);
+// "osrs-tools/models/YellowPartyhat.obj"
+```
+
+- **Node.js**: resolve the shipped asset with `require.resolve(yellowPartyhatModelPath)` and read it with `fs.readFileSync(...)`.
+- **Bundlers**: import the raw asset directly from `osrs-tools/models/YellowPartyhat.obj` or use a `?url` suffix if your bundler supports it.
+
+### 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`         | 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
+
+```
+source/                          # TypeScript source code
+├── index.ts                      # Main entry point
+├── runescape/
+│   ├── model/
+│   │   ├── account/             # Player account & skills
+│   │   ├── diaries/             # Achievement diaries
+│   │   ├── quest/               # Quest system
+│   │   │   ├── all/             # Individual quest classes
+│   │   │   └── index.ts         # Quest module export
+│   │   ├── slayer/              # Slayer system
+│   │   ├── Item/                # Item models
+│   │   └── npc/                 # NPC data
+│   ├── tools/                   # Utility tools (ClueScrollHelper, experience calc, etc.)
+│   ├── utils/                   # Helper utilities (cache, validation, etc.)
+│   └── errors.ts                # Custom error types
+└── examples/                    # Usage examples
+
+test/                            # Jest test suite
+└── unit/
+    ├── account/
+    ├── diaries/
+    ├── quest/
+    ├── slayer/
+    ├── model/
+    ├── tools/
+    └── utils/
+
+dist/                            # Compiled output (generated by build)
+```
+
+## 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/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/Item/all/3rdAgeAxe.d.ts

@@ -0,0 +1,3 @@
+import { Item } from "../Item";
+export declare const ThirdAgeAxe: Item;
+//# sourceMappingURL=3rdAgeAxe.d.ts.map

package/dist/runescape/model/Item/all/3rdAgeAxe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"3rdAgeAxe.d.ts","sourceRoot":"","sources":["../../../../../source/runescape/model/Item/all/3rdAgeAxe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAsB/B,eAAO,MAAM,WAAW,MAAiC,CAAC"}

package/dist/runescape/model/Item/all/3rdAgeAxe.js

@@ -0,0 +1,21 @@
+import { Item } from "../Item";
+const ThirdAgeAxeData = {
+    id: 20011,
+    name: "3rd age axe",
+    iconUrl: "/assets/items/3rd-age-axe.png",
+    examine: "A beautifully crafted axe, shaped by ancient smiths.",
+    value: 55000,
+    highAlch: 33000,
+    lowAlch: 22000,
+    weight: 1.36,
+    members: true,
+    tradeable: true,
+    equipable: true,
+    releaseDate: "2016-07-06",
+    destroy: "Wield",
+    questItem: false,
+    stackable: false,
+    noted: true,
+    officialWikiUrl: "https://oldschool.runescape.wiki/w/3rd_age_axe",
+};
+export const ThirdAgeAxe = Item.fromJson(ThirdAgeAxeData);

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

@@ -0,0 +1,3 @@
+import { Item } from '../Item';
+export declare const AdamantCane: Item;
+//# sourceMappingURL=AdamantCane.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AdamantCane.d.ts","sourceRoot":"","sources":["../../../../../source/runescape/model/Item/all/AdamantCane.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAsB/B,eAAO,MAAM,WAAW,MAAiC,CAAC"}

package/dist/runescape/model/Item/all/AdamantCane.js

@@ -0,0 +1,21 @@
+import { Item } from '../Item';
+const adamantCaneData = {
+    id: 12377,
+    name: "Adamant cane",
+    iconUrl: "/assets/items/adamant-cane.png",
+    examine: "A diamond topped cane.",
+    value: 1440,
+    highAlch: 864,
+    lowAlch: 576,
+    weight: 1.814,
+    members: true,
+    tradeable: true,
+    equipable: true,
+    releaseDate: "2014-06-12",
+    destroy: "Wield",
+    questItem: false,
+    stackable: false,
+    noted: true,
+    officialWikiUrl: "https://oldschool.runescape.wiki/w/Adamant_cane",
+};
+export const AdamantCane = Item.fromJson(adamantCaneData);

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

@@ -0,0 +1,3 @@
+import { Item } from '../Item';
+export declare const AdamantDragonMask: Item;
+//# sourceMappingURL=AdamantDragonMask.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AdamantDragonMask.d.ts","sourceRoot":"","sources":["../../../../../source/runescape/model/Item/all/AdamantDragonMask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAsB/B,eAAO,MAAM,iBAAiB,MAAuC,CAAC"}

package/dist/runescape/model/Item/all/AdamantDragonMask.js

@@ -0,0 +1,21 @@
+import { Item } from '../Item';
+const adamantDragonMaskData = {
+    id: 23270,
+    name: "Adamant dragon mask",
+    iconUrl: "/assets/items/adamant-dragon-mask.png",
+    examine: "Do I look scary?",
+    value: 10000,
+    highAlch: 6000,
+    lowAlch: 4000,
+    weight: 2.267,
+    members: true,
+    tradeable: true,
+    equipable: true,
+    releaseDate: "2019-04-11",
+    destroy: "Wear",
+    questItem: false,
+    stackable: false,
+    noted: true,
+    officialWikiUrl: "https://oldschool.runescape.wiki/w/Adamant_dragon_mask",
+};
+export const AdamantDragonMask = Item.fromJson(adamantDragonMaskData);

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

@@ -0,0 +1,3 @@
+import { Item } from '../Item';
+export declare const AdamantPickaxe: Item;
+//# sourceMappingURL=AdamantPickaxe.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AdamantPickaxe.d.ts","sourceRoot":"","sources":["../../../../../source/runescape/model/Item/all/AdamantPickaxe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAsB/B,eAAO,MAAM,cAAc,MAAoC,CAAC"}