osrs-tools 0.2.2 → 1.0.0

package/dist/quest/Quest.d.ts

@@ -0,0 +1,73 @@
+import { Requirement } from '../Requirement';
+interface QuestRewardExperience {
+    skill: string;
+    amount: number;
+}
+interface QuestRewardItem {
+    name: string;
+    quantity?: number;
+    note?: string;
+}
+interface QuestRewardUnlock {
+    description: string;
+    url?: string;
+}
+interface QuestRewardLamp {
+    amount: number;
+    skillRestriction?: string | string[];
+    note?: string;
+}
+interface QuestRewardPoints {
+    type: string;
+    amount: number;
+}
+interface QuestRewardPet {
+    name: string;
+    note?: string;
+}
+interface QuestRewards {
+    experience?: QuestRewardExperience[];
+    items?: QuestRewardItem[];
+    unlocks?: QuestRewardUnlock[];
+    lamps?: QuestRewardLamp[];
+    points?: QuestRewardPoints[];
+    pets?: QuestRewardPet[];
+    questPoints: number;
+    areas?: string[];
+}
+interface Quest {
+    id: number;
+    name: string;
+    description: string;
+    difficulty: string;
+    steps: string[];
+    requirements: Requirement[];
+    status: QuestStatus;
+    miniquest: boolean;
+    shortName: string;
+    url: string;
+    series?: string | undefined | null;
+    members: boolean;
+    questPoints: number;
+    length: string;
+    age: string;
+    startLocation: string;
+    difficultyLevel: string;
+    officialDifficulty: string;
+    officialLength: string;
+    officialAge: string;
+    recommendedItems: string[];
+    recommendedSkills: {
+        [skill: string]: number;
+    };
+    recommendedPrayers: string[];
+    rewards: QuestRewards;
+    [key: string]: any;
+}
+export { Quest };
+export declare enum QuestStatus {
+    NotStarted = "NotStarted",
+    InProgress = "InProgress",
+    Completed = "Completed",
+    Failed = "Failed"
+}

package/dist/quest/Quest.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuestStatus = void 0;
+var QuestStatus;
+(function (QuestStatus) {
+    QuestStatus["NotStarted"] = "NotStarted";
+    QuestStatus["InProgress"] = "InProgress";
+    QuestStatus["Completed"] = "Completed";
+    QuestStatus["Failed"] = "Failed";
+})(QuestStatus || (exports.QuestStatus = QuestStatus = {}));

package/dist/quest/QuestTool.d.ts

@@ -0,0 +1,36 @@
+import { OsrsAccount } from '../account/OsrsAccount';
+import { Quest } from './Quest';
+declare class QuestTool {
+    private osrsAccount;
+    constructor(account?: OsrsAccount);
+    /**
+     * 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;
+    /**
+     * 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: Quest | undefined, visited?: Set<string>): boolean;
+    /**
+     * 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: string): Quest | 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: string): number;
+}
+export { QuestTool };

package/dist/quest/QuestTool.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuestTool = void 0;
+const Requirement_1 = require("../Requirement");
+class QuestTool {
+    constructor(account) {
+        this.osrsAccount = account;
+    }
+    /**
+     * 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 = acc1;
+            return true;
+        }
+        return false;
+    }
+    /**
+     * 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.d.ts

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

package/dist/quest/all/APorcineOfInterest.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Quest_1 = require("../Quest");
+const APorcineOfInterest = {
+    id: 0, // Assign a unique ID if available
+    name: "A Porcine of Interest",
+    members: true,
+    difficulty: 'Novice',
+    length: 'Short',
+    requirements: [],
+    questPoints: 1,
+    startLocation: "Read the town notice board in Draynor Village, behind Fortunato's Wine Shop.",
+    description: "Ah, the Falador Farm - filled with cabbages, cows, and even a sleepy sheepdog. A peaceful place, where you can learn to churn butter, give a dog a bone, or purchase various Farming supplies. What was once a place of happiness, joy and wholesome dairy goods has of late become dominated by a vile presence. Each morning Sarah wakes to find her crops destroyed, her cows cowering, and her loyal sheepdog looking... sheepish. She's had enough, but she thinks she's got the culprit on the trot. Can you help her track down... A Porcine of Interest?",
+    steps: [],
+    status: Quest_1.QuestStatus.NotStarted,
+    miniquest: false,
+    shortName: "aPorcineOfInterest",
+    url: 'https://oldschool.runescape.wiki/w/A_Porcine_of_Interest',
+    series: null,
+    age: '',
+    difficultyLevel: 'Novice',
+    officialDifficulty: 'Novice',
+    officialLength: 'Short',
+    officialAge: '',
+    recommendedItems: [
+        "Charged amulet of glory",
+        "Explorer's ring 2 or above",
+        "Stamina potion",
+        "Combat equipment",
+        "Some food for lower levels"
+    ],
+    recommendedSkills: {},
+    recommendedPrayers: [],
+    rewards: {
+        experience: [
+            { skill: 'Slayer', amount: 1000 },
+        ],
+        questPoints: 1,
+        items: [],
+        areas: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
+    },
+};
+exports.default = APorcineOfInterest;

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

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

package/dist/quest/all/ASoulsBane.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Quest_1 = require("../Quest");
+const ASoulsBane = {
+    id: 0, // Assign a unique ID if available
+    name: "A Soul's Bane",
+    members: true,
+    difficulty: 'Novice',
+    length: 'Medium',
+    requirements: [], // No skill or quest requirements
+    questPoints: 1,
+    startLocation: '', // Not specified in JSON
+    description: '', // Not specified in JSON
+    steps: [], // Not specified in JSON
+    status: Quest_1.QuestStatus.NotStarted,
+    miniquest: false,
+    shortName: "aSoulsBane",
+    url: 'https://oldschool.runescape.wiki/w/A_Soul%27s_Bane',
+    series: null,
+    age: '',
+    difficultyLevel: 'Novice',
+    officialDifficulty: 'Novice',
+    officialLength: 'Medium',
+    officialAge: '',
+    recommendedItems: [],
+    recommendedSkills: {},
+    recommendedPrayers: [],
+    rewards: {
+        experience: [
+            { skill: 'Defence', amount: 500 },
+            { skill: 'Hitpoints', amount: 500 },
+        ],
+        questPoints: 1,
+        items: [],
+        areas: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
+    },
+};
+exports.default = ASoulsBane;

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

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

package/dist/quest/all/ATailOfTwoCats.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Quest_1 = require("../Quest");
+const ATailOfTwoCats = {
+    id: 0, // Assign a unique ID if available
+    name: "A Tail of Two Cats",
+    members: true,
+    difficulty: 'Intermediate',
+    length: 'Long',
+    requirements: [], // Only quest requirement: Icthlarin's Little Helper
+    questPoints: 2,
+    startLocation: '',
+    description: '',
+    steps: [],
+    status: Quest_1.QuestStatus.NotStarted,
+    miniquest: false,
+    shortName: "aTailOfTwoCats",
+    url: 'https://oldschool.runescape.wiki/w/A_Tail_of_Two_Cats',
+    series: 'Dragonkin',
+    age: '',
+    difficultyLevel: 'Intermediate',
+    officialDifficulty: 'Intermediate',
+    officialLength: 'Long',
+    officialAge: '',
+    recommendedItems: [],
+    recommendedSkills: {},
+    recommendedPrayers: [],
+    rewards: {
+        experience: [],
+        questPoints: 2,
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
+    },
+};
+exports.default = ATailOfTwoCats;

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

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

package/dist/quest/all/ATasteOfHope.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Quest_1 = require("../Quest");
+const ATasteOfHope = {
+    id: 0, // Assign a unique ID if available
+    name: "A Taste of Hope",
+    members: true,
+    difficulty: 'Experienced',
+    length: 'Long',
+    requirements: [], // Quests: Darkness of Hallowvale, Skills: Crafting 48, Agility 45, Attack 40, Herblore 40, Slayer 38
+    questPoints: 1,
+    startLocation: '',
+    description: '',
+    steps: [],
+    status: Quest_1.QuestStatus.NotStarted,
+    miniquest: false,
+    shortName: "aTasteOfHope",
+    url: 'https://oldschool.runescape.wiki/w/A_Taste_of_Hope',
+    series: 'Myreque',
+    age: '',
+    difficultyLevel: 'Experienced',
+    officialDifficulty: 'Experienced',
+    officialLength: 'Long',
+    officialAge: '',
+    recommendedItems: [],
+    recommendedSkills: {},
+    recommendedPrayers: [],
+    rewards: {
+        experience: [],
+        questPoints: 1,
+        items: [],
+        areas: [],
+        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.d.ts

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

package/dist/quest/all/AnimalMagnetism.js

@@ -0,0 +1,45 @@
+"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',
+    members: true,
+    difficulty: 'Intermediate',
+    length: 'Medium - Long',
+    requirements: [], // Quests: The Restless Ghost, Ernest the Chicken, Priest in Peril. Skills: Slayer 18, Crafting 19, Ranged 30, Woodcutting 35, Prayer 31
+    questPoints: 1,
+    startLocation: '',
+    description: '',
+    steps: [],
+    status: Quest_1.QuestStatus.NotStarted,
+    miniquest: false,
+    shortName: 'animalMagnetism',
+    url: 'https://oldschool.runescape.wiki/w/Animal_Magnetism',
+    series: null,
+    age: '',
+    difficultyLevel: 'Intermediate',
+    officialDifficulty: 'Intermediate',
+    officialLength: 'Medium - Long',
+    officialAge: '',
+    recommendedItems: [],
+    recommendedSkills: {},
+    recommendedPrayers: [],
+    rewards: {
+        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: [],
+        unlocks: [],
+        lamps: [],
+        points: [],
+        pets: [],
+    },
+};
+exports.default = AnimalMagnetism;

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

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