osrs-tools 0.1.1 → 0.2.1

package/README.md

@@ -1,42 +1,118 @@
-## Old School Runescape Quest Tool
+# Old School RuneScape Quest Tool
 
-A [Node Package](https://www.npmjs.com/package/osrs-quest-tool) to provide data for all current old school runescape quests. Creating tools to help junior software developers build things they are passionate about. Work in progress and issues should be reported to cerniglj1@hawkmail.newpaltz.edu or jamesmcerniglia@gmail.com or reported under the [issues tab on gituhb](https://github.com/cerniglj1/osrs-quest-tool/issues).
+[![NPM Version][npm-image]][npm-url] [![Downloads][downloads-image]][downloads-url] [![GitHub Issues][issues-img]][new-issue]  
+[![types](https://img.shields.io/npm/types/osrs-tools.svg?style=flat-square)](https://github.com/jamescer/osrs-tools/blob/master/src/types.ts)
+
+The **Old School RuneScape Quest Tool** is a Node.js package designed to provide comprehensive data for all current Old School RuneScape (OSRS) quests, slayer tasks, and related game mechanics. This tool is ideal for developers looking to integrate OSRS data into their projects, whether for personal use, game guides, or community tools.
+
+## Features
+
+- Access detailed quest data, including requirements, rewards, and steps.
+- Retrieve slayer task information, including task weights, requirements, and locations.
+- Explore slayer master data, including assigned tasks, combat level requirements, and rewards.
+- Built-in support for tracking quest and slayer progress.
+- Easy-to-use API for developers of all skill levels.
 
 ## Installation
 
-```js
-npm i osrs-quest-tool
+Install the package via npm:
+
+```bash
+npm install osrs-tools --save
+```
+
+## Usage
+
+Here’s how to use the tool in your project:
+
+### Importing the Module
+
+```javascript
+import { QuestTool, questArray, questObject } from 'osrs-tools';
+```
+
+### Working with Quests
+
+```javascript
+// Instantiate the QuestTool class
+const tool = new QuestTool();
+
+// Get quest data as an array
+const questArrayData = questArray();
+
+// Get quest data as an object
+const questObjectData = questObject();
+
+// Output the quest data
+console.log(questArrayData);
+console.log(questObjectData);
 ```
 
-| Syntax            | Description                                                      | Type              |
-| ----------------- | ---------------------------------------------------------------- | ----------------- |
-| `new QuestTool()` | constructor for QuestTool class.                                 | Class Constructor |
-| `questObject()`   | function that returns an object of quest array keys.             | Function ()       |
-| `questArray()`    | function that returns an array of alphabetically ordered quests. | Function ()        |
-| `questObject`     | an object of quest array keys.                                   | Object { }        |
-| `questArray`      | an array of alphabetically ordered quests.                       | Array [ ]         |
-
----
-
-### Example Javascript
-
-```js
-import { QuestTool, questArray, questObject } from "osrs-quest-tool";
-var tool = new QuestTool();
-this.questArray = questArray();
-this.questData = questObject();
-console.log(this.questData);
-console.log(this.questArray);
+### Working with Slayer Masters and Tasks
+
+```javascript
+import { Turael, Duradel } from 'osrs-tools';
+
+// Access Turael's tasks
+console.log(Turael.getTasks());
+
+// Get a random task from Duradel
+const randomTask = Duradel.getRandomTask();
+console.log(randomTask);
+```
+
+### Slayer Rewards and Unlocks
+
+```javascript
+import { SlayerUnlocks, SlayerBuys } from 'osrs-tools';
+
+// List all available Slayer unlocks
+console.log(SlayerUnlocks);
+
+// List all items available for purchase with Slayer points
+console.log(SlayerBuys);
 ```
 
----
+## API Reference
+
+### Quest API
+
+| Method            | Description                                                             | Type              |
+| ----------------- | ----------------------------------------------------------------------- | ----------------- |
+| `new QuestTool()` | Constructor for the `QuestTool` class.                                  | Class Constructor |
+| `questObject()`   | Function that returns an object with quest data (keys are quest names). | Function          |
+| `questArray()`    | Function that returns an array of quests, ordered alphabetically.       | Function          |
+
+### Slayer API
+
+| Class/Method         | Description                                                                 |
+| -------------------- | ------------------------------------------------------------------------- |
+| `SlayerMaster`       | Represents a Slayer Master, including tasks, location, and requirements. |
+| `getTasks()`         | Returns a list of tasks assigned by the Slayer Master.                   |
+| `getRandomTask()`    | Returns a random task based on task weights.                             |
+| `SlayerUnlocks`      | Predefined list of Slayer unlocks with costs and descriptions.           |
+| `SlayerBuys`         | Predefined list of items available for purchase with Slayer points.      |
+
+## To-Do
+
+- Implement a recursive function for determining quest completion.
+- Develop a quest completion tracking array.
+- Refactor `questArray()` and `questObject()` to return objects instead of functions.
+- Continue work on the **Recipe for Disaster** quest.
+- Fix and validate all Slayer data.
+
+## Contributing
 
-## Notes
+Contributions are welcome! If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/jamescer/osrs-tools).
 
-Recipe for disaster is a work in progress!
+## Credits
 
-## TODO
+- **Author**: [James Cerniglia](mailto:jamesmcerniglia@gmail.com)
+- **Repository**: [GitHub - osrs-tools](https://github.com/jamescer/osrs-tools)
 
-- Implement recursive function for determining quest completion
-- Implement quest completion array
-- Implement questArray and questObject objects instead of functions
+[npm-image]: https://img.shields.io/npm/v/osrs-tools.svg
+[npm-url]: https://www.npmjs.com/package/osrs-tools
+[downloads-image]: https://img.shields.io/npm/dm/osrs-tools.svg
+[downloads-url]: https://npmcharts.com/compare/osrs-tools?minimal=true
+[issues-img]: https://img.shields.io/github/issues/jamescer/osrs-tools.svg
+[new-issue]: https://github.com/jamescer/osrs-tools/issues/new/choose

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { QuestTool } from './model/quest/QuestTool';
+import { OsrsAccount } from './model/account/OsrsAccount';
+declare const _default: {
+    QuestTool: typeof QuestTool;
+    OsrsAccount: typeof OsrsAccount;
+    SlayerTool: any;
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// import { QuestTool } from './questTool.js';
+const QuestTool_1 = require("./model/quest/QuestTool");
+const SlayerTool_1 = require("./model/slayer/SlayerTool");
+const OsrsAccount_1 = require("./model/account/OsrsAccount");
+exports.default = {
+    QuestTool: QuestTool_1.QuestTool,
+    OsrsAccount: OsrsAccount_1.OsrsAccount,
+    SlayerTool: SlayerTool_1.SlayerTool
+};
+// export default

package/dist/jest.config.dev.js

@@ -0,0 +1,7 @@
+"use strict";
+
+/** @type {import('jest').Config} */
+var config = {
+  verbose: true
+};
+module.exports = config;

package/dist/model/Requirement.d.ts

@@ -0,0 +1,65 @@
+interface Requirement {
+    description: string;
+    isMet(): boolean;
+}
+declare class LevelRequirement implements Requirement {
+    type: RequirementType;
+    skillName: string;
+    level: number;
+    boostable: boolean;
+    constructor(skillName: string, level: number, boostable?: boolean);
+    get description(): string;
+    isMet(): boolean;
+}
+declare enum RequirementType {
+    SlayerLevel = "SlayerLevel",
+    Level = "Level",
+    CombatLevel = "CombatLevel",
+    Quest = "Quest",
+    Item = "Item",
+    Location = "Location",
+    SlayerUnlock = "SlayerUnlock"
+}
+declare class SlayerUnlockRequirement implements Requirement {
+    type: RequirementType;
+    name: string;
+    constructor(name: string);
+    get description(): string;
+    isMet(): boolean;
+}
+declare class SlayerLevelRequirement implements Requirement {
+    type: RequirementType;
+    level: number;
+    constructor(level: number);
+    get description(): string;
+    isMet(): boolean;
+}
+declare class CombatLevelRequirement implements Requirement {
+    type: RequirementType;
+    level: number;
+    constructor(level: number);
+    get description(): string;
+    isMet(): boolean;
+}
+declare class QuestRequirement implements Requirement {
+    type: RequirementType;
+    questName: string;
+    constructor(questName: string);
+    get description(): string;
+    isMet(): boolean;
+}
+declare class ItemRequirement implements Requirement {
+    type: RequirementType;
+    itemName: string;
+    constructor(itemName: string);
+    get description(): string;
+    isMet(): boolean;
+}
+declare class LocationRequirement implements Requirement {
+    type: RequirementType;
+    locationName: string;
+    constructor(locationName: string);
+    get description(): string;
+    isMet(): boolean;
+}
+export { CombatLevelRequirement, ItemRequirement, LevelRequirement, LocationRequirement, QuestRequirement, Requirement, RequirementType, SlayerLevelRequirement, SlayerUnlockRequirement, };

package/dist/model/Requirement.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SlayerUnlockRequirement = exports.SlayerLevelRequirement = exports.RequirementType = exports.QuestRequirement = exports.LocationRequirement = exports.LevelRequirement = exports.ItemRequirement = exports.CombatLevelRequirement = void 0;
+// TODO: Add a requirement type for all "levels" (combat, slayer, farming, crafting etc.)
+class LevelRequirement {
+    constructor(skillName, level, boostable = false) {
+        this.type = RequirementType.Level;
+        this.boostable = false; // Indicates if the level can be boosted
+        this.boostable = boostable;
+        this.skillName = skillName;
+        this.level = level;
+    }
+    get description() {
+        return `Level ${this.level}`;
+    }
+    isMet() {
+        // Replace with actual logic to check the player's level
+        return false; // TODO
+    }
+}
+exports.LevelRequirement = LevelRequirement;
+// Enum for requirement types
+var RequirementType;
+(function (RequirementType) {
+    RequirementType["SlayerLevel"] = "SlayerLevel";
+    RequirementType["Level"] = "Level";
+    RequirementType["CombatLevel"] = "CombatLevel";
+    RequirementType["Quest"] = "Quest";
+    RequirementType["Item"] = "Item";
+    RequirementType["Location"] = "Location";
+    RequirementType["SlayerUnlock"] = "SlayerUnlock";
+})(RequirementType || (exports.RequirementType = RequirementType = {}));
+// Slayer Unlock requirement
+class SlayerUnlockRequirement {
+    constructor(name) {
+        this.type = RequirementType.SlayerUnlock;
+        this.name = name;
+    }
+    get description() {
+        return `Slayer unlock: ${this.name}`;
+    }
+    isMet() {
+        // Replace with actual logic to check the player's Slayer level
+        return false; // TODO
+    }
+}
+exports.SlayerUnlockRequirement = SlayerUnlockRequirement;
+// Slayer level requirement
+class SlayerLevelRequirement {
+    constructor(level) {
+        this.type = RequirementType.SlayerLevel;
+        this.level = level;
+    }
+    get description() {
+        return `Slayer level ${this.level}`;
+    }
+    isMet() {
+        // Replace with actual logic to check the player's Slayer level
+        return false; // TODO
+    }
+}
+exports.SlayerLevelRequirement = SlayerLevelRequirement;
+// Combat level requirement
+class CombatLevelRequirement {
+    constructor(level) {
+        this.type = RequirementType.CombatLevel;
+        this.level = level;
+    }
+    get description() {
+        return `Combat level ${this.level}`;
+    }
+    isMet() {
+        // Replace with actual logic to check the player's Combat level
+        return false; // TODO
+    }
+}
+exports.CombatLevelRequirement = CombatLevelRequirement;
+// Quest requirement
+class QuestRequirement {
+    constructor(questName) {
+        this.type = RequirementType.Quest;
+        this.questName = questName;
+    }
+    get description() {
+        return `Completed quest: ${this.questName}`;
+    }
+    isMet() {
+        // Replace with actual logic to check if the quest is completed
+        return false; // TODO
+    }
+}
+exports.QuestRequirement = QuestRequirement;
+// Item requirement
+class ItemRequirement {
+    constructor(itemName) {
+        this.type = RequirementType.Item;
+        this.itemName = itemName;
+    }
+    get description() {
+        return `Has item: ${this.itemName}`;
+    }
+    isMet() {
+        // Replace with actual logic to check if the player has the item
+        return false; // TODO
+    }
+}
+exports.ItemRequirement = ItemRequirement;
+// Location requirement
+class LocationRequirement {
+    constructor(locationName) {
+        this.type = RequirementType.Location;
+        this.locationName = locationName;
+    }
+    get description() {
+        return `Access to location: ${this.locationName}`;
+    }
+    isMet() {
+        // Replace with actual logic to check if the player is in the location
+        return false; // TODO
+    }
+}
+exports.LocationRequirement = LocationRequirement;
+// Example usage: Array of requirements for a monster
+const monsterRequirements = [
+    new SlayerLevelRequirement(44),
+    new CombatLevelRequirement(5),
+    new QuestRequirement("Dragon Slayer"),
+    new ItemRequirement("Anti-dragon shield"),
+    new LocationRequirement("Taverley Dungeon"),
+];

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

@@ -0,0 +1,31 @@
+interface OsrsAccountObject {
+    name: string;
+    main: {
+        combatLevel: number;
+        questPoints: number;
+        skills: {
+            [skillName: string]: {
+                level: number;
+            };
+        };
+    };
+}
+declare class OsrsAccount {
+    private osrsAccount;
+    constructor(accountObject: OsrsAccountObject | null);
+    getName(): string | undefined;
+    toString(): string;
+    getSkills(): {
+        [skillName: string]: {
+            level: number;
+        };
+    } | undefined;
+    getSkill(skillName: string): {
+        level: number;
+    } | undefined;
+    getQuestPoints(): number | undefined;
+    setQuestPoints(x: number): void;
+    getCombatLevel(): number | undefined;
+    setCombatLevel(): void;
+}
+export { OsrsAccount };

package/dist/model/account/OsrsAccount.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OsrsAccount = void 0;
+class OsrsAccount {
+    constructor(accountObject) {
+        this.osrsAccount = accountObject ? accountObject : null;
+        this.setQuestPoints(0);
+        this.setCombatLevel();
+    }
+    getName() {
+        var _a;
+        return (_a = this.osrsAccount) === null || _a === void 0 ? void 0 : _a.name;
+    }
+    toString() {
+        var _a, _b, _c, _d;
+        return (((_b = (_a = this.osrsAccount) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : "") +
+            ":  \nCombat Level: " +
+            ((_d = (_c = this.osrsAccount) === null || _c === void 0 ? void 0 : _c.main.combatLevel) !== null && _d !== void 0 ? _d : "") +
+            "\nQuestPoints: " +
+            this.getQuestPoints());
+    }
+    getSkills() {
+        var _a;
+        return (_a = this.osrsAccount) === null || _a === void 0 ? void 0 : _a.main.skills;
+    }
+    getSkill(skillName) {
+        var _a;
+        return (_a = this.osrsAccount) === null || _a === void 0 ? void 0 : _a.main.skills[skillName.toLowerCase()];
+    }
+    getQuestPoints() {
+        var _a;
+        return (_a = this.osrsAccount) === null || _a === void 0 ? void 0 : _a.main.questPoints;
+    }
+    setQuestPoints(x) {
+        if (x >= 0 && this.osrsAccount) {
+            this.osrsAccount.main.questPoints = x;
+        }
+    }
+    getCombatLevel() {
+        var _a;
+        return (_a = this.osrsAccount) === null || _a === void 0 ? void 0 : _a.main.combatLevel;
+    }
+    setCombatLevel() {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+        if (this.osrsAccount) {
+            const attklvl = (_b = (_a = this.osrsAccount.main.skills.attack) === null || _a === void 0 ? void 0 : _a.level) !== null && _b !== void 0 ? _b : 1;
+            const strlvl = (_d = (_c = this.osrsAccount.main.skills.strength) === null || _c === void 0 ? void 0 : _c.level) !== null && _d !== void 0 ? _d : 1;
+            const deflvl = (_f = (_e = this.osrsAccount.main.skills.defence) === null || _e === void 0 ? void 0 : _e.level) !== null && _f !== void 0 ? _f : 1;
+            const rangedlvl = (_h = (_g = this.osrsAccount.main.skills.ranged) === null || _g === void 0 ? void 0 : _g.level) !== null && _h !== void 0 ? _h : 1;
+            const magiclvl = (_k = (_j = this.osrsAccount.main.skills.magic) === null || _j === void 0 ? void 0 : _j.level) !== null && _k !== void 0 ? _k : 1;
+            const praylvl = (_m = (_l = this.osrsAccount.main.skills.prayer) === null || _l === void 0 ? void 0 : _l.level) !== null && _m !== void 0 ? _m : 1;
+            const hplvl = (_p = (_o = this.osrsAccount.main.skills.hitpoints) === null || _o === void 0 ? void 0 : _o.level) !== null && _p !== void 0 ? _p : 10;
+            const x = [
+                0.325 * (attklvl + strlvl),
+                0.325 * ((3 * rangedlvl) / 2),
+                0.325 * ((3 * magiclvl) / 2),
+            ];
+            const cbMax = Math.max(...x);
+            this.osrsAccount.main.combatLevel =
+                0.25 * (deflvl + hplvl + praylvl / 2) + cbMax;
+        }
+    }
+}
+exports.OsrsAccount = OsrsAccount;

package/dist/model/quest/Quest.d.ts

@@ -0,0 +1,41 @@
+interface SkillRequirement {
+    level: number;
+    isBoostable: boolean;
+}
+interface Quest {
+    id: number;
+    name: string;
+    difficulty: string;
+    skillRequirements: {
+        [skill: string]: SkillRequirement;
+    };
+    status: "Not Started" | "In Progress" | "Completed";
+    miniquest: boolean;
+    shortName: string;
+    url: string;
+    series: string;
+    members: boolean;
+    questPoints: number;
+    length: string;
+    age: string;
+    startLocation: string;
+    difficultyLevel: string;
+    officialDifficulty: string;
+    officialLength: string;
+    officialAge: string;
+    itemRequirements: string[];
+    recommendedItems: string[];
+    recommendedSkills: {
+        [skill: string]: number;
+    };
+    recommendedPrayers: string[];
+    questRequirements: string[];
+    rewards: {
+        experience?: {
+            [skill: string]: number;
+        };
+        items?: string[];
+        areas?: string[];
+    };
+}
+export { Quest };

package/dist/model/quest/Quest.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/model/quest/QuestTool.d.ts

@@ -0,0 +1,51 @@
+import { OsrsAccount } from "../account/OsrsAccount";
+import { Quest } from "./Quest";
+declare class QuestTool {
+    private questObject;
+    private questArray;
+    private subQuestArray;
+    private osrsAccount;
+    constructor();
+    /**
+     * to string func
+     * @todo    Implement this function
+     * @return  {String} The string representation of the class object.
+     */
+    toString(): string;
+    /**
+     * Get the data for a quest
+     * @param  {String} questName The name of the quest
+     * @return {Object} The data for the input quest in a JSON object.
+     * */
+    getQuest(questName: string): Quest | undefined;
+    /**
+     * Get the data for a quest
+     * @param  {String} questName The name of the quest
+     * @return {Object} The data for the input quest in a JSON object.
+     * */
+    getQuestByName(questName: string): Quest | undefined;
+    /**
+     * Get the data for a quest
+     * @param  {String} subQuestName The name of the subquest
+     * @return {Object} The data for the input subquest in a JSON object.
+     * */
+    getSubQuest(subQuestName: string): any | undefined;
+    /**
+     * Add two numbers together
+     * @todo Need to implement Recipe for disaster functionality
+     * @param  {String} quest The either string or quest object of the quest to be determined completeable or not.
+     * @return {Boolean}  If the account currently tied to the tool can complete the quest.
+     * */
+    canCompleteQuest(quest: string | Quest | undefined): boolean;
+    /**
+     * Set the account to be used in this quest tool
+     * @param  {OsrsAccount} acc1 The osrs Account to be associated with this class object.
+     * */
+    setOsrsAccount(acc1: OsrsAccount): boolean;
+    /**
+     * Get the osrs account associated with this quest tool
+     * @return  {OsrsAccount | undefined} The osrs Account associated with this class object.
+     * */
+    getOsrsAccount(): OsrsAccount | undefined;
+}
+export { QuestTool };

package/dist/model/quest/QuestTool.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuestTool = void 0;
+class QuestTool {
+    constructor() {
+        // todo need to import these data from a typescript file where its defined/stored
+        this.questObject = [];
+        this.questArray = [];
+        this.subQuestArray = [];
+    }
+    /**
+     * to string func
+     * @todo    Implement this function
+     * @return  {String} The string representation of the class object.
+     */
+    toString() {
+        return "QuestTool :) WIP";
+    }
+    /**
+     * Get the data for a quest
+     * @param  {String} questName The name of the quest
+     * @return {Object} The data for the input quest in a JSON object.
+     * */
+    getQuest(questName) {
+        if (typeof questName === "string" && this.questObject[questName]) {
+            // return new Quest(this.questObject[questName]); TODO
+        }
+        return undefined;
+    }
+    /**
+     * Get the data for a quest
+     * @param  {String} questName The name of the quest
+     * @return {Object} The data for the input quest in a JSON object.
+     * */
+    getQuestByName(questName) {
+        return this.getQuest(questName);
+    }
+    /**
+     * Get the data for a quest
+     * @param  {String} subQuestName The name of the subquest
+     * @return {Object} The data for the input subquest in a JSON object.
+     * */
+    getSubQuest(subQuestName) {
+        return this.subQuestArray.find((x) => x.name === subQuestName);
+    }
+    // Define highestBoost method, switch case omitted for brevity
+    /**
+     * Add two numbers together
+     * @todo Need to implement Recipe for disaster functionality
+     * @param  {String} quest The either string or quest object of the quest to be determined completeable or not.
+     * @return {Boolean}  If the account currently tied to the tool can complete the quest.
+     * */
+    canCompleteQuest(quest) {
+        // Implementation omitted for brevity
+        return true; // Placeholder return value
+    }
+    // Define completableQuests method, implementation omitted for brevity
+    /**
+     * Set the account to be used in this quest tool
+     * @param  {OsrsAccount} acc1 The osrs Account to be associated with this class object.
+     * */
+    setOsrsAccount(acc1) {
+        if (acc1) {
+            // this.osrsAccount = new OsrsAccount(acc1); TODO
+            return true;
+        }
+        return false;
+    }
+    // Define other methods, implementation omitted for brevity
+    /**
+     * Get the osrs account associated with this quest tool
+     * @return  {OsrsAccount | undefined} The osrs Account associated with this class object.
+     * */
+    getOsrsAccount() {
+        return this.osrsAccount;
+    }
+}
+exports.QuestTool = QuestTool;

package/dist/model/slayer/Assignment.d.ts

@@ -0,0 +1,17 @@
+import { Requirement } from "../Requirement";
+export declare class Assignment {
+    name: string;
+    quantity: number;
+    requirements: Requirement[];
+    extendedAmountMin?: number | null;
+    extendedAmountMax?: number | null;
+    constructor(name: string, quantity: number, requirements: Requirement[], extendedAmountMin?: number | null, extendedAmountMax?: number | null);
+    /**
+     * Get the task name
+     */
+    getName(): string;
+    /**
+     * Get the quantity of the task
+     */
+    getQuantity(): number;
+}