osrs-tools 0.2.3 → 1.0.0

package/dist/quest/QuestTool.js

@@ -1,78 +1,137 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QuestTool = void 0;
+const Requirement_1 = require("../Requirement");
 class QuestTool {
-    constructor() {
-        // todo need to import these data from a typescript file where its defined/stored
-        this.questObject = [];
-        this.questArray = [];
-        this.subQuestArray = [];
+    constructor(account) {
+        this.osrsAccount = account;
     }
-    /**
-     * 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
+            this.osrsAccount = acc1;
             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;
     }
+    /**
+     * Determine if the account can complete a quest, including recursively checking quest requirements.
+     * @param quest The quest to check (must be a Quest instance)
+     * @param visited (internal) Set of quest names already checked to prevent infinite recursion
+     */
+    canCompleteQuest(quest, visited = new Set()) {
+        if (!this.osrsAccount)
+            return false;
+        if (!quest)
+            return false;
+        if (visited.has(quest.name))
+            return true; // Prevent infinite loops
+        visited.add(quest.name);
+        // check requirements
+        if (!quest.requirements || quest.requirements.length === 0)
+            return true;
+        for (const req of quest.requirements) {
+            if (req.type === Requirement_1.RequirementType.Quest) {
+                // Recursively check quest requirements
+                const questReq = req;
+                if (!questReq ||
+                    !this.canCompleteQuest(QuestTool.getQuestByName(questReq.questName), visited)) {
+                    return false;
+                }
+            }
+            else if (req.type === Requirement_1.RequirementType.Level) {
+                // Check if the account meets the level requirement
+                const levelReq = req;
+                const skill = this.osrsAccount.getSkill(levelReq.skillName);
+                if (!skill) {
+                    return false; // Skill not found in account
+                }
+                // If the skill is boostable, we can check if the current level + max boost is enough
+                if (levelReq.boostable) {
+                    if (skill.level + QuestTool.getMaxSkillBoost(levelReq.skillName) <
+                        levelReq.level) {
+                        return false;
+                    }
+                }
+                else if (skill.level < levelReq.level) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+    /**
+     * Static utility to get a Quest instance by its name.
+     * This assumes all quests are exported as default from their respective files in quest/all/.
+     * @param questName The name of the quest to retrieve
+     * @returns Quest instance or undefined if not found
+     */
+    static getQuestByName(questName) {
+        // Normalize quest name to match file naming convention
+        const normalized = questName
+            .replace(/[^a-zA-Z0-9]/g, '') // Remove non-alphanumeric
+            .replace(/\s+/g, '') // Remove spaces
+            .replace(/^./, (c) => c.toUpperCase());
+        try {
+            // Dynamically require the quest file
+            // Note: This only works in Node.js, not in browser environments
+            // and assumes all quest files are named as <QuestName>.ts/js and exported as default
+            // Example: 'Dragon Slayer' => './all/DragonSlayer'
+            // You may want to maintain a map for production use
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const questModule = require(`./all/${normalized}`);
+            return questModule.default || questModule;
+        }
+        catch (e) {
+            return undefined;
+        }
+    }
+    /**
+     * Get the maximum boost for a given skill, based on OSRS Wiki data.
+     * @param skillName The name of the skill (case-insensitive, e.g. 'Attack', 'Herblore')
+     * @returns The maximum boost amount for the skill (positive integer, or 0 if unboostable)
+     */
+    static getMaxSkillBoost(skillName) {
+        var _a;
+        // Data from https://oldschool.runescape.wiki/w/Temporary_skill_boost
+        const boosts = {
+            Attack: 5, // Super combat potion, Overload(+)
+            Strength: 5, // Super combat potion, Overload(+)
+            Defence: 5, // Super combat potion, Overload(+)
+            Magic: 4, // Overload(+), Imbued heart
+            Ranged: 4, // Ranging potion, Overload(+)
+            Prayer: 2, // Preserve, Prayer-boosting items
+            Hitpoints: 0, // No boost
+            Agility: 5, // Summer pie
+            Herblore: 5, // Botanical pie
+            Thieving: 5, // Volcanic ash, Summer pie
+            Crafting: 3, // Mushroom pie
+            Fletching: 3, // Fletching potion
+            Slayer: 2, // Wild pie
+            Hunter: 5, // Hunter potion
+            Mining: 3, // Dwarven stout(m)
+            Smithing: 4, // Spicy stew (orange)
+            Fishing: 5, // Admiral pie
+            Cooking: 5, // Chef's delight(m)
+            Firemaking: 4, // Spicy stew (red)
+            Woodcutting: 3, // Spicy stew (yellow)
+            Farming: 5, // Garden pie
+            Runecraft: 5, // Spicy stew (orange)
+            Construction: 5, // Spicy stew (orange)
+            // Add more as needed
+        };
+        const normalized = skillName.charAt(0).toUpperCase() + skillName.slice(1).toLowerCase();
+        return (_a = boosts[normalized]) !== null && _a !== void 0 ? _a : 0;
+    }
 }
 exports.QuestTool = QuestTool;

package/dist/quest/all/AHandInTheSand.d.ts

@@ -0,0 +1,3 @@
+import { Quest } from '../Quest';
+declare const AHandInTheSand: Quest;
+export default AHandInTheSand;

package/dist/quest/all/AHandInTheSand.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Quest_1 = require("../Quest");
+const Requirement_1 = require("../../Requirement");
+const AHandInTheSand = {
+    id: 0,
+    name: 'A Hand in the Sand',
+    members: true,
+    difficulty: 'Intermediate',
+    length: 'Medium',
+    requirements: [
+        new Requirement_1.LevelRequirement('Crafting', 49, false),
+        new Requirement_1.LevelRequirement('Thieving', 40, false),
+    ],
+    questPoints: 1,
+    startLocation: '',
+    description: '',
+    steps: [],
+    status: Quest_1.QuestStatus.NotStarted,
+    miniquest: false,
+    shortName: 'aHandInTheSand',
+    url: 'https://oldschool.runescape.wiki/w/A_Hand_in_the_Sand',
+    series: null,
+    age: '',
+    difficultyLevel: 'Intermediate',
+    officialDifficulty: 'Intermediate',
+    officialLength: 'Medium',
+    officialAge: '',
+    recommendedItems: [],
+    recommendedSkills: {},
+    recommendedPrayers: [],
+    rewards: {
+        experience: [
+            { skill: 'Crafting', amount: 9000 },
+            { skill: 'Thieving', amount: 1000 },
+        ],
+        questPoints: 1,
+        items: [],
+        areas: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
+    },
+};
+exports.default = AHandInTheSand;

package/dist/quest/all/AKingdomDivided.d.ts

@@ -0,0 +1,3 @@
+import { Quest } from '../Quest';
+declare const AKingdomDivided: Quest;
+export default AKingdomDivided;

package/dist/quest/all/AKingdomDivided.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Quest_1 = require("../Quest");
+const Requirement_1 = require("../../Requirement");
+const AKingdomDivided = {
+    id: 0,
+    name: 'A Kingdom Divided',
+    members: true,
+    difficulty: 'Master',
+    length: 'Long',
+    requirements: [
+        new Requirement_1.QuestRequirement('Client of Kourend'),
+        new Requirement_1.QuestRequirement('The Depths of Despair'),
+        new Requirement_1.QuestRequirement('The Queen of Thieves'),
+        new Requirement_1.QuestRequirement('The Ascent of Arceuus'),
+        new Requirement_1.QuestRequirement('The Forsaken Tower'),
+        new Requirement_1.LevelRequirement('Thieving', 54, false),
+        new Requirement_1.LevelRequirement('Agility', 52, false),
+        new Requirement_1.LevelRequirement('Woodcutting', 52, false),
+        new Requirement_1.LevelRequirement('Magic', 50, false),
+        new Requirement_1.LevelRequirement('Mining', 42, false),
+        new Requirement_1.LevelRequirement('Smithing', 42, false),
+        new Requirement_1.LevelRequirement('Farming', 35, false),
+        new Requirement_1.LevelRequirement('Crafting', 38, false),
+        new Requirement_1.LevelRequirement('Hunter', 42, false),
+        new Requirement_1.LevelRequirement('Herblore', 45, false),
+    ],
+    questPoints: 2,
+    startLocation: '',
+    description: '',
+    steps: [],
+    status: Quest_1.QuestStatus.NotStarted,
+    miniquest: false,
+    shortName: 'aKingdomDivided',
+    url: 'https://oldschool.runescape.wiki/w/A_Kingdom_Divided',
+    series: 'Great Kourend',
+    age: '',
+    difficultyLevel: 'Master',
+    officialDifficulty: 'Master',
+    officialLength: 'Long',
+    officialAge: '',
+    recommendedItems: [],
+    recommendedSkills: {},
+    recommendedPrayers: [],
+    rewards: {
+        experience: [],
+        questPoints: 2,
+        items: [],
+        areas: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
+    },
+};
+exports.default = AKingdomDivided;

package/dist/quest/all/APorcineOfInterest.js

@@ -32,11 +32,16 @@ const APorcineOfInterest = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: { Slayer: 1000 },
+        experience: [
+            { skill: 'Slayer', amount: 1000 },
+        ],
         questPoints: 1,
         items: [],
         areas: [],
-        grants: ["30 Slayer Rewards Points", "Some Reinforced Goggles"],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = APorcineOfInterest;

package/dist/quest/all/ASoulsBane.js

@@ -26,11 +26,17 @@ const ASoulsBane = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: { Defence: 500, Hitpoints: 500 },
+        experience: [
+            { skill: 'Defence', amount: 500 },
+            { skill: 'Hitpoints', amount: 500 },
+        ],
         questPoints: 1,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = ASoulsBane;

package/dist/quest/all/ATailOfTwoCats.js

@@ -26,11 +26,12 @@ const ATailOfTwoCats = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: {},
+        experience: [],
         questPoints: 2,
-        items: [],
-        areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = ATailOfTwoCats;

package/dist/quest/all/ATasteOfHope.js

@@ -26,11 +26,14 @@ const ATasteOfHope = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: {},
+        experience: [],
         questPoints: 1,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = ATasteOfHope;

package/dist/quest/all/ATheatreOfBlood.d.ts

@@ -0,0 +1,3 @@
+import { Quest } from '../Quest';
+declare const ATheatreOfBlood: Quest;
+export default ATheatreOfBlood;

package/dist/quest/all/ATheatreOfBlood.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Quest_1 = require("../Quest");
+const ATheatreOfBlood = {
+    id: 0,
+    name: 'A Theatre of Blood',
+    members: true,
+    difficulty: 'Master',
+    length: 'Long',
+    requirements: [],
+    questPoints: 1,
+    startLocation: '',
+    description: '',
+    steps: [],
+    status: Quest_1.QuestStatus.NotStarted,
+    miniquest: false,
+    shortName: 'aTheatreOfBlood',
+    url: 'https://oldschool.runescape.wiki/w/Theatre_of_Blood',
+    series: null,
+    age: '',
+    difficultyLevel: 'Master',
+    officialDifficulty: 'Master',
+    officialLength: 'Long',
+    officialAge: '',
+    recommendedItems: [],
+    recommendedSkills: {},
+    recommendedPrayers: [],
+    rewards: {
+        experience: [],
+        questPoints: 1,
+        items: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
+    },
+};
+exports.default = ATheatreOfBlood;

package/dist/quest/all/AnimalMagnetism.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const Quest_1 = require("../Quest");
+const Skill_1 = require("../../account/Skill");
 const AnimalMagnetism = {
     id: 0, // Assign a unique ID if available
-    name: "Animal Magnetism",
+    name: 'Animal Magnetism',
     members: true,
     difficulty: 'Intermediate',
     length: 'Medium - Long',
@@ -14,7 +15,7 @@ const AnimalMagnetism = {
     steps: [],
     status: Quest_1.QuestStatus.NotStarted,
     miniquest: false,
-    shortName: "animalMagnetism",
+    shortName: 'animalMagnetism',
     url: 'https://oldschool.runescape.wiki/w/Animal_Magnetism',
     series: null,
     age: '',
@@ -26,11 +27,19 @@ const AnimalMagnetism = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: { Crafting: 1000, Fletching: 1000, Slayer: 1000, Woodcutting: 2500 },
+        experience: [
+            { skill: Skill_1.Skill.Crafting, amount: 1000 },
+            { skill: Skill_1.Skill.Fletching, amount: 1000 },
+            { skill: Skill_1.Skill.Slayer, amount: 1000 },
+            { skill: Skill_1.Skill.Woodcutting, amount: 2500 },
+        ],
         questPoints: 1,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = AnimalMagnetism;

package/dist/quest/all/AnotherSliceOfHAM.js

@@ -26,11 +26,17 @@ const AnotherSliceOfHAM = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: { Mining: 3000, Prayer: 3000 },
+        experience: [
+            { skill: 'Mining', amount: 3000 },
+            { skill: 'Prayer', amount: 3000 },
+        ],
         questPoints: 1,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = AnotherSliceOfHAM;

package/dist/quest/all/BelowIceMountain.js

@@ -29,16 +29,19 @@ const BelowIceMountain = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: {},
+        experience: [],
         questPoints: 1,
         items: [],
         areas: [],
-        grants: [
-            "2,000 coins",
-            "Access to the Ruins of Camdozaal",
-            "Flex emote",
-            "The ability to make steak sandwich"
+        unlocks: [
+            { description: "2,000 coins" },
+            { description: "Access to the Ruins of Camdozaal" },
+            { description: "Flex emote" },
+            { description: "The ability to make steak sandwich" }
         ],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = BelowIceMountain;

package/dist/quest/all/BetweenARock.js

@@ -26,11 +26,18 @@ const BetweenARock = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: { Defence: 5000, Mining: 5000, Smithing: 5000 },
+        experience: [
+            { skill: 'Defence', amount: 5000 },
+            { skill: 'Mining', amount: 5000 },
+            { skill: 'Smithing', amount: 5000 },
+        ],
         questPoints: 2,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = BetweenARock;

package/dist/quest/all/BigChompyBirdHunting.js

@@ -26,11 +26,18 @@ const BigChompyBirdHunting = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: { Cooking: 1470, Fletching: 262, Ranged: 735 },
+        experience: [
+            { skill: 'Cooking', amount: 1470 },
+            { skill: 'Fletching', amount: 262 },
+            { skill: 'Ranged', amount: 735 },
+        ],
         questPoints: 2,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = BigChompyBirdHunting;

package/dist/quest/all/Biohazard.js

@@ -26,11 +26,16 @@ const Biohazard = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: { Thieving: 1250 },
+        experience: [
+            { skill: 'Thieving', amount: 1250 },
+        ],
         questPoints: 3,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = Biohazard;

package/dist/quest/all/BlackKnightsFortress.js

@@ -26,11 +26,14 @@ const BlackKnightsFortress = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: {},
+        experience: [],
         questPoints: 3,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = BlackKnightsFortress;

package/dist/quest/all/BoneVoyage.js

@@ -26,11 +26,14 @@ const BoneVoyage = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: {},
+        experience: [],
         questPoints: 1,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = BoneVoyage;

package/dist/quest/all/CabinFever.js

@@ -26,11 +26,18 @@ const CabinFever = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: { Agility: 7000, Crafting: 7000, Smithing: 7000 },
+        experience: [
+            { skill: 'Agility', amount: 7000 },
+            { skill: 'Crafting', amount: 7000 },
+            { skill: 'Smithing', amount: 7000 },
+        ],
         questPoints: 2,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = CabinFever;

package/dist/quest/all/ClientOfKourend.js

@@ -26,11 +26,14 @@ const ClientOfKourend = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: {},
+        experience: [],
         questPoints: 1,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = ClientOfKourend;

package/dist/quest/all/ClockTower.js

@@ -26,11 +26,14 @@ const ClockTower = {
     recommendedSkills: {},
     recommendedPrayers: [],
     rewards: {
-        experience: {},
+        experience: [],
         questPoints: 1,
         items: [],
         areas: [],
-        grants: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
     },
 };
 exports.default = ClockTower;