osrs-tools 2.4.0 → 2.5.2

package/dist/runescape/model/diaries/Ardougne.d.ts

@@ -0,0 +1,3 @@
+export { ArdougneDiary } from "./ardougne/Ardougne";
+export { ArdougneDiary as default } from "./ardougne/Ardougne";
+//# sourceMappingURL=Ardougne.d.ts.map

package/dist/runescape/model/diaries/Ardougne.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Ardougne.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/diaries/Ardougne.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,IAAI,OAAO,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/runescape/model/diaries/Ardougne.js

@@ -1,3 +1,2 @@
-import { getDiaryByName } from './Diary';
-export const ArdougneDiary = getDiaryByName('Ardougne Diary');
-export default ArdougneDiary;
+export { ArdougneDiary } from "./ardougne/Ardougne";
+export { ArdougneDiary as default } from "./ardougne/Ardougne";

package/dist/runescape/model/diaries/Desert.d.ts

@@ -0,0 +1,4 @@
+import type { Diary } from './Diary';
+export declare const DesertDiary: Diary;
+export default DesertDiary;
+//# sourceMappingURL=Desert.d.ts.map

package/dist/runescape/model/diaries/Desert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Desert.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/diaries/Desert.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,WAAW,EAAE,KAAuC,CAAC;AAClE,eAAe,WAAW,CAAC"}

package/dist/runescape/model/diaries/Diary.d.ts

@@ -0,0 +1,52 @@
+import { ItemRequirement, Requirement } from "../Requirement";
+export interface DiaryTask {
+    description: string;
+    requirements: Requirement[];
+    notes?: string;
+}
+export interface DiaryLevel {
+    itemReward?: string;
+    rewards?: any;
+    tasks: DiaryTask[];
+    itemsRequired?: string[];
+    itemRequirements?: ItemRequirement[];
+    questsRequired?: string[];
+    skillsRequired?: any[];
+}
+/**
+ * Diary interface representing the structure of a RuneScape diary, including its name, rewards, and tasks for each difficulty level. Tasks include descriptions, requirements (such as quests and skills), and optional notes.
+ * The diaries are built from a JSON resource file and can be accessed by name or retrieved as a list of all diaries.
+ * Example usage:
+ * const ardougneDiary = getDiaryByName("Ardougne Diary");
+ * if (ardougneDiary) {
+ *   console.log(ardougneDiary.name); // "Ardougne Diary"
+ *   console.log(ardougneDiary.easy.tasks[0].description); // Description of the first easy task
+ *   console.log(ardougneDiary.easy.tasks[0].requirements); // Requirements for the first easy task
+ * }
+ */
+export interface Diary {
+    name: string;
+    itemReward?: string;
+    rewards?: any;
+    easy: DiaryLevel;
+    medium: DiaryLevel;
+    hard: DiaryLevel;
+    elite: DiaryLevel;
+}
+export declare function getDiaryByName(name: string): Diary | undefined;
+export declare function getAllDiaries(): Diary[];
+declare const diaries: Record<string, Diary>;
+export default diaries;
+export declare const ArdougneDiary: Diary;
+export declare const DesertDiary: Diary;
+export declare const FaladorDiary: Diary;
+export declare const FremennikDiary: Diary;
+export declare const KandarinDiary: Diary;
+export declare const KaramjaDiary: Diary;
+export declare const KourendKebosDiary: Diary;
+export declare const LumbridgeDraynorDiary: Diary;
+export declare const MorytaniaDiary: Diary;
+export declare const VarrockDiary: Diary;
+export declare const WesternProvincesDiary: Diary;
+export declare const WildernessDiary: Diary;
+//# sourceMappingURL=Diary.d.ts.map

package/dist/runescape/model/diaries/Diary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Diary.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/diaries/Diary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsC,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAelG,MAAM,WAAW,SAAS;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,GAAG,EAAE,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,UAAU,CAAC;CACnB;AAiFD,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAM9D;AAED,wBAAgB,aAAa,IAAI,KAAK,EAAE,CAEvC;AAGD,QAAA,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAWlC,CAAC;AAOF,eAAe,OAAO,CAAC;AAGvB,eAAO,MAAM,aAAa,OAA4B,CAAC;AACvD,eAAO,MAAM,WAAW,OAA0B,CAAC;AACnD,eAAO,MAAM,YAAY,OAA2B,CAAC;AACrD,eAAO,MAAM,cAAc,OAA6B,CAAC;AACzD,eAAO,MAAM,aAAa,OAA4B,CAAC;AACvD,eAAO,MAAM,YAAY,OAA2B,CAAC;AACrD,eAAO,MAAM,iBAAiB,OAAmC,CAAC;AAClE,eAAO,MAAM,qBAAqB,OAAuC,CAAC;AAC1E,eAAO,MAAM,cAAc,OAA6B,CAAC;AACzD,eAAO,MAAM,YAAY,OAA2B,CAAC;AACrD,eAAO,MAAM,qBAAqB,OAAqC,CAAC;AACxE,eAAO,MAAM,eAAe,OAA8B,CAAC"}

package/dist/runescape/model/diaries/Diary.js

@@ -1,6 +1,16 @@
-import { LevelRequirement, QuestRequirement, ItemRequirement } from '../Requirement';
+import { LevelRequirement, QuestRequirement, ItemRequirement } from "../Requirement";
+import { ArdougneDiary as typedArdougneDiary } from "./ardougne/Ardougne";
+import { KaramjaDiary as typedKaramjaDiary } from "./karamja/Karamja";
+import { DesertDiary as typedDesertDiary } from "./desert/Desert";
+import { VarrockDiary as typedVarrockDiary } from "./varrock/Varrock";
+import { FremennikDiary as typedFremennikDiary } from "./fremennik/Fremennik";
+import { KandarinDiary as typedKandarinDiary } from "./kandarin/Kandarin";
+import { KourendKebosDiary as typedKourendKebosDiary } from "./kourend-kebos/KourendKebos";
+import { LumbridgeDraynorDiary as typedLumbridgeDraynorDiary } from "./lumbridge-draynor/LumbridgeDraynor";
+import { MorytaniaDiary as typedMorytaniaDiary } from "./morytania/Morytania";
+import { WildernessDiary as typedWildernessDiary } from "./wilderness/Wilderness";
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const diariesData = require('../../resources/diary/diaries.json');
+const diariesData = require("../../resources/diary/diaries.json");
 function mapSkillReq(skillReq) {
     // skillReq: { skill: string, level: number, boostable: boolean }
     if (!skillReq || !skillReq.skill)
@@ -13,7 +23,7 @@ function mapTask(task) {
         // quests
         if (Array.isArray(task.requirements.quests)) {
             for (const q of task.requirements.quests) {
-                if (q && typeof q === 'string')
+                if (q && typeof q === "string")
                     requirements.push(new QuestRequirement(q));
             }
         }
@@ -27,9 +37,9 @@ function mapTask(task) {
         }
     }
     // items are stored as freeform notes in the resource file
-    const notes = task.other?.itemsNeeded || task.other?.itemsNeeded === '' ? task.other.itemsNeeded : undefined;
+    const notes = task.other?.itemsNeeded || task.other?.itemsNeeded === "" ? task.other.itemsNeeded : undefined;
     return {
-        description: task.description || '',
+        description: task.description || "",
         requirements,
         notes,
     };
@@ -43,15 +53,13 @@ function mapLevel(level) {
         rewards: level.rewards,
         tasks,
         itemsRequired: level.itemsRequired,
-        itemRequirements: Array.isArray(level.itemsRequired)
-            ? level.itemsRequired.map((s) => mapItemString(s)).filter(Boolean)
-            : undefined,
+        itemRequirements: Array.isArray(level.itemsRequired) ? level.itemsRequired.map((s) => mapItemString(s)).filter(Boolean) : undefined,
         questsRequired: level.questsRequired,
         skillsRequired: level.skillsRequired,
     };
 }
 function mapItemString(s) {
-    if (!s || typeof s !== 'string')
+    if (!s || typeof s !== "string")
         return null;
     // Try to extract a leading quantity: "3 strawberry seeds" or "2x item"
     const qtyMatch = s.trim().match(/^(\d+)\s*(?:x|×)?\s*(.+)$/i);
@@ -65,7 +73,7 @@ function mapItemString(s) {
     const noted = /noted/i.test(name);
     const notConsumed = /not consumed/i.test(name);
     // strip parenthetical notes from name
-    name = name.replace(/\(.+\)/g, '').trim();
+    name = name.replace(/\(.+\)/g, "").trim();
     return new ItemRequirement(name, qty, { consumed: !notConsumed, noted, notes: s });
 }
 function buildDiary(key, raw) {
@@ -84,28 +92,41 @@ export function getDiaryByName(name) {
     if (diaries[name])
         return diaries[name];
     // try case-insensitive
-    const found = Object.keys(diaries).find(k => k.toLowerCase() === name.toLowerCase());
+    const found = Object.keys(diaries).find((k) => k.toLowerCase() === name.toLowerCase());
     return found ? diaries[found] : undefined;
 }
 export function getAllDiaries() {
     return Object.values(diaries);
 }
 //Build the Diaries for Export
-const diaries = {};
+const diaries = {
+    "Ardougne Diary": typedArdougneDiary,
+    "Karamja Diary": typedKaramjaDiary,
+    "Desert Diary": typedDesertDiary,
+    "Varrock Diary": typedVarrockDiary,
+    "Fremennik Diary": typedFremennikDiary,
+    "Kandarin Diary": typedKandarinDiary,
+    "Kourend & Kebos Diary": typedKourendKebosDiary,
+    "Lumbridge & Draynor Diary": typedLumbridgeDraynorDiary,
+    "Morytania Diary": typedMorytaniaDiary,
+    "Wilderness Diary": typedWildernessDiary,
+};
 for (const k of Object.keys(diariesData)) {
-    diaries[k] = buildDiary(k, diariesData[k]);
+    if (!diaries[k]) {
+        diaries[k] = buildDiary(k, diariesData[k]);
+    }
 }
 export default diaries;
 // Named exports for convenient imports
-export const ArdougneDiary = diaries['Ardougne Diary'];
-export const DesertDiary = diaries['Desert Diary'];
-export const FaladorDiary = diaries['Falador Diary'];
-export const FremennikDiary = diaries['Fremennik Diary'];
-export const KandarinDiary = diaries['Kandarin Diary'];
-export const KaramjaDiary = diaries['Karamja Diary'];
-export const KourendKebosDiary = diaries['Kourend & Kebos Diary'];
-export const LumbridgeDraynorDiary = diaries['Lumbridge & Draynor Diary'];
-export const MorytaniaDiary = diaries['Morytania Diary'];
-export const VarrockDiary = diaries['Varrock Diary'];
-export const WesternProvincesDiary = diaries['Western Provinces Diary'];
-export const WildernessDiary = diaries['Wilderness Diary'];
+export const ArdougneDiary = diaries["Ardougne Diary"];
+export const DesertDiary = diaries["Desert Diary"];
+export const FaladorDiary = diaries["Falador Diary"];
+export const FremennikDiary = diaries["Fremennik Diary"];
+export const KandarinDiary = diaries["Kandarin Diary"];
+export const KaramjaDiary = diaries["Karamja Diary"];
+export const KourendKebosDiary = diaries["Kourend & Kebos Diary"];
+export const LumbridgeDraynorDiary = diaries["Lumbridge & Draynor Diary"];
+export const MorytaniaDiary = diaries["Morytania Diary"];
+export const VarrockDiary = diaries["Varrock Diary"];
+export const WesternProvincesDiary = diaries["Western Provinces Diary"];
+export const WildernessDiary = diaries["Wilderness Diary"];

package/dist/runescape/model/diaries/Fremennik.d.ts

@@ -0,0 +1,4 @@
+import type { Diary } from './Diary';
+export declare const FremennikDiary: Diary;
+export default FremennikDiary;
+//# sourceMappingURL=Fremennik.d.ts.map

package/dist/runescape/model/diaries/Fremennik.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Fremennik.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/diaries/Fremennik.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,cAAc,EAAE,KAA0C,CAAC;AACxE,eAAe,cAAc,CAAC"}

package/dist/runescape/model/diaries/Kandarin.d.ts

@@ -0,0 +1,4 @@
+import type { Diary } from './Diary';
+export declare const KandarinDiary: Diary;
+export default KandarinDiary;
+//# sourceMappingURL=Kandarin.d.ts.map

package/dist/runescape/model/diaries/Kandarin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Kandarin.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/diaries/Kandarin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,aAAa,EAAE,KAAyC,CAAC;AACtE,eAAe,aAAa,CAAC"}

package/dist/runescape/model/diaries/Karamja.d.ts

@@ -0,0 +1,4 @@
+import type { Diary } from './Diary';
+export declare const KaramjaDiary: Diary;
+export default KaramjaDiary;
+//# sourceMappingURL=Karamja.d.ts.map

package/dist/runescape/model/diaries/Karamja.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Karamja.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/diaries/Karamja.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,YAAY,EAAE,KAAwC,CAAC;AACpE,eAAe,YAAY,CAAC"}

package/dist/runescape/model/diaries/KourendKebos.d.ts

@@ -0,0 +1,4 @@
+import type { Diary } from './Diary';
+export declare const KourendKebosDiary: Diary;
+export default KourendKebosDiary;
+//# sourceMappingURL=KourendKebos.d.ts.map

package/dist/runescape/model/diaries/KourendKebos.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KourendKebos.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/diaries/KourendKebos.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,iBAAiB,EAAE,KAAgD,CAAC;AACjF,eAAe,iBAAiB,CAAC"}

package/dist/runescape/model/diaries/LumbridgeDraynor.d.ts

@@ -0,0 +1,4 @@
+import type { Diary } from './Diary';
+export declare const LumbridgeDraynorDiary: Diary;
+export default LumbridgeDraynorDiary;
+//# sourceMappingURL=LumbridgeDraynor.d.ts.map

package/dist/runescape/model/diaries/LumbridgeDraynor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LumbridgeDraynor.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/diaries/LumbridgeDraynor.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,qBAAqB,EAAE,KAAoD,CAAC;AACzF,eAAe,qBAAqB,CAAC"}

package/dist/runescape/model/diaries/Morytania.d.ts

@@ -0,0 +1,4 @@
+import type { Diary } from './Diary';
+export declare const MorytaniaDiary: Diary;
+export default MorytaniaDiary;
+//# sourceMappingURL=Morytania.d.ts.map

package/dist/runescape/model/diaries/Morytania.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Morytania.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/diaries/Morytania.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,cAAc,EAAE,KAA0C,CAAC;AACxE,eAAe,cAAc,CAAC"}

package/dist/runescape/model/diaries/Wilderness.d.ts

@@ -0,0 +1,4 @@
+import type { Diary } from './Diary';
+export declare const WildernessDiary: Diary;
+export default WildernessDiary;
+//# sourceMappingURL=Wilderness.d.ts.map

package/dist/runescape/model/diaries/Wilderness.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Wilderness.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/diaries/Wilderness.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,eAAe,EAAE,KAA2C,CAAC;AAC1E,eAAe,eAAe,CAAC"}

package/dist/runescape/model/diaries/ardougne/Ardougne.d.ts

@@ -0,0 +1,9 @@
+import type { Diary } from "../Diary";
+/**
+ * Ardougne Achievement Diary data, authored directly in TypeScript.
+ *
+ * Source: https://oldschool.runescape.wiki/w/Ardougne_Diary
+ */
+export declare const ArdougneDiary: Diary;
+export default ArdougneDiary;
+//# sourceMappingURL=Ardougne.d.ts.map

package/dist/runescape/model/diaries/ardougne/Ardougne.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Ardougne.d.ts","sourceRoot":"","sources":["../../../../../source/runescape/model/diaries/ardougne/Ardougne.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAKtC;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,KAkZ3B,CAAC;AAEF,eAAe,aAAa,CAAC"}