osrs-tools 0.2.1 → 0.2.3

package/dist/Requirement.d.ts

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

package/dist/Requirement.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SlayerUnlockRequirement = exports.SlayerLevelRequirement = exports.RequirementType = exports.QuestRequirement = exports.LocationRequirement = exports.LevelRequirement = exports.ItemRequirement = exports.QuestPointRequirement = 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}`;
+    }
+}
+exports.LevelRequirement = LevelRequirement;
+// Enum for requirement types
+var RequirementType;
+(function (RequirementType) {
+    RequirementType["SlayerLevel"] = "SlayerLevel";
+    RequirementType["Level"] = "Level";
+    RequirementType["CombatLevel"] = "CombatLevel";
+    RequirementType["Quest"] = "Quest";
+    RequirementType["QuestPoint"] = "QuestPoint";
+    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}`;
+    }
+}
+exports.SlayerUnlockRequirement = SlayerUnlockRequirement;
+// Slayer level requirement
+class SlayerLevelRequirement {
+    constructor(level) {
+        this.type = RequirementType.SlayerLevel;
+        this.level = level;
+    }
+    get description() {
+        return `Slayer level ${this.level}`;
+    }
+}
+exports.SlayerLevelRequirement = SlayerLevelRequirement;
+// Combat level requirement
+class CombatLevelRequirement {
+    constructor(level) {
+        this.type = RequirementType.CombatLevel;
+        this.level = level;
+    }
+    get description() {
+        return `Combat level ${this.level}`;
+    }
+}
+exports.CombatLevelRequirement = CombatLevelRequirement;
+// Quest requirement
+class QuestRequirement {
+    constructor(questName) {
+        this.type = RequirementType.Quest;
+        this.questName = questName;
+    }
+    get description() {
+        return `Completed quest: ${this.questName}`;
+    }
+}
+exports.QuestRequirement = QuestRequirement;
+class QuestPointRequirement {
+    constructor(amount) {
+        this.type = RequirementType.Quest;
+        this.amount = amount;
+    }
+    get description() {
+        return `Quest Points Needed: ${this.amount}`;
+    }
+}
+exports.QuestPointRequirement = QuestPointRequirement;
+// Item requirement
+class ItemRequirement {
+    constructor(itemName) {
+        this.type = RequirementType.Item;
+        this.itemName = itemName;
+    }
+    get description() {
+        return `Has item: ${this.itemName}`;
+    }
+}
+exports.ItemRequirement = ItemRequirement;
+// Location requirement
+class LocationRequirement {
+    constructor(locationName) {
+        this.type = RequirementType.Location;
+        this.locationName = locationName;
+    }
+    get description() {
+        return `Access to location: ${this.locationName}`;
+    }
+}
+exports.LocationRequirement = LocationRequirement;

package/dist/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/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/account/Skill.d.ts

@@ -0,0 +1,25 @@
+export declare enum Skill {
+    Attack = "Attack",
+    Defence = "Defence",
+    Strength = "Strength",
+    Hitpoints = "Hitpoints",
+    Ranged = "Ranged",
+    Prayer = "Prayer",
+    Magic = "Magic",
+    Cooking = "Cooking",
+    Woodcutting = "Woodcutting",
+    Fletching = "Fletching",
+    Fishing = "Fishing",
+    Firemaking = "Firemaking",
+    Crafting = "Crafting",
+    Smithing = "Smithing",
+    Mining = "Mining",
+    Herblore = "Herblore",
+    Agility = "Agility",
+    Thieving = "Thieving",
+    Slayer = "Slayer",
+    Farming = "Farming",
+    Runecraft = "Runecraft",
+    Hunter = "Hunter",
+    Construction = "Construction"
+}

package/dist/account/Skill.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Skill = void 0;
+var Skill;
+(function (Skill) {
+    Skill["Attack"] = "Attack";
+    Skill["Defence"] = "Defence";
+    Skill["Strength"] = "Strength";
+    Skill["Hitpoints"] = "Hitpoints";
+    Skill["Ranged"] = "Ranged";
+    Skill["Prayer"] = "Prayer";
+    Skill["Magic"] = "Magic";
+    Skill["Cooking"] = "Cooking";
+    Skill["Woodcutting"] = "Woodcutting";
+    Skill["Fletching"] = "Fletching";
+    Skill["Fishing"] = "Fishing";
+    Skill["Firemaking"] = "Firemaking";
+    Skill["Crafting"] = "Crafting";
+    Skill["Smithing"] = "Smithing";
+    Skill["Mining"] = "Mining";
+    Skill["Herblore"] = "Herblore";
+    Skill["Agility"] = "Agility";
+    Skill["Thieving"] = "Thieving";
+    Skill["Slayer"] = "Slayer";
+    Skill["Farming"] = "Farming";
+    Skill["Runecraft"] = "Runecraft";
+    Skill["Hunter"] = "Hunter";
+    Skill["Construction"] = "Construction";
+})(Skill || (exports.Skill = Skill = {}));

package/dist/misc/Item.d.ts

@@ -0,0 +1,7 @@
+export declare class Item {
+    id: number;
+    name: string;
+    description?: string;
+    value?: number;
+    constructor(id: number, name: string, description?: string, value?: number);
+}

package/dist/misc/Item.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Item = void 0;
+class Item {
+    constructor(id, name, description, value) {
+        this.id = id;
+        this.name = name;
+        this.description = description;
+        this.value = value;
+    }
+}
+exports.Item = Item;

package/dist/quest/Quest.d.ts

@@ -0,0 +1,45 @@
+import { Requirement } from '../Requirement';
+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: {
+        experience?: {
+            [skill: string]: number;
+        };
+        items?: string[];
+        questPoints: number;
+        areas?: string[];
+        grants?: string[];
+    };
+    [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,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/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/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,42 @@
+"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: { Slayer: 1000 },
+        questPoints: 1,
+        items: [],
+        areas: [],
+        grants: ["30 Slayer Rewards Points", "Some Reinforced Goggles"],
+    },
+};
+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,36 @@
+"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: { Defence: 500, Hitpoints: 500 },
+        questPoints: 1,
+        items: [],
+        areas: [],
+        grants: [],
+    },
+};
+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,36 @@
+"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,
+        items: [],
+        areas: [],
+        grants: [],
+    },
+};
+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;