feat: add types to all commands

Author: DuckySoLucky

.prettierrc

@@ -5,7 +5,7 @@
   "bracketSpacing": true,
   "proseWrap": "always",
   "singleQuote": false,
-  "printWidth": 120,
+  "printWidth": 170,
   "endOfLine": "lf",
   "useTabs": false,
   "tabWidth": 2,

API/constants/accessories.js

@@ -0,0 +1,15 @@
+/** @type {Record<string, number>} */
+const MAGICAL_POWER = {
+  common: 3,
+  uncommon: 5,
+  rare: 8,
+  epic: 12,
+  legendary: 16,
+  mythic: 22,
+  special: 3,
+  very: 5
+};
+
+module.exports = {
+  MAGICAL_POWER
+};

API/constants/bestiary.js

@@ -1,5 +1,16 @@
-const axios = require("axios");
+// @ts-ignore
+const { get } = require("axios");
 
+/**
+ * @typedef {import('./bestiary.types').BestiaryConstant} BestiaryConstants
+ * @typedef {import('./bestiary.types').Mob} Mob
+ * @typedef {import('./bestiary.types').RawMob} RawMob
+ */
+
+/**
+ * @param {RawMob[]} mobs
+ * @returns {Mob[]}
+ * */
 function formatBestiaryMobs(mobs) {
   const output = [];
   for (const mob of mobs) {
@@ -14,20 +25,24 @@ function formatBestiaryMobs(mobs) {
   return output;
 }
 
+/** @type {Partial<{ lastUpdated: number, data: BestiaryConstants }>} */
 const cache = {};
+
+/**
+ * @returns {Promise<BestiaryConstants | null>}
+ * */
 async function getBestiaryConstants() {
   if (cache.lastUpdated && cache.lastUpdated + 1000 * 60 * 60 * 12 > Date.now()) {
-    return cache.data;
+    return cache.data ?? null;
   }
 
-  const response = await axios.get(
-    "https://raw.githubusercontent.com/NotEnoughUpdates/NotEnoughUpdates-REPO/refs/heads/master/constants/bestiary.json"
-  );
+  const response = await get("https://raw.githubusercontent.com/NotEnoughUpdates/NotEnoughUpdates-REPO/refs/heads/master/constants/bestiary.json");
   const bestiary = response?.data;
   if (!bestiary) {
     return null;
   }
 
+  /** @type {BestiaryConstants} */
   const output = { brackets: bestiary.brackets, islands: {} };
   for (const [islandId, islandData] of Object.entries(bestiary).filter(([key]) => key !== "brackets")) {
     if (islandData.hasSubcategories === true) {
@@ -37,9 +52,7 @@ async function getBestiaryConstants() {
         }
 
         const id = islandId === categoryId ? islandId : `${islandId}:${categoryId}`;
-        const name = categoryData.name.includes(islandData.name)
-          ? categoryData.name
-          : `${categoryData.name} ${islandData.name}`;
+        const name = categoryData.name.includes(islandData.name) ? categoryData.name : `${categoryData.name} ${islandData.name}`;
         output.islands[id] = {
           name: name,
           mobs: formatBestiaryMobs(categoryData.mobs)

API/constants/bestiary.types.d.ts

@@ -0,0 +1,26 @@
+export type BestiaryConstant = {
+  brackets: Record<string, number[]>;
+  islands: Record<string, Island>;
+};
+
+type Island = {
+  name: string;
+  mobs: Mob[];
+};
+
+type Mob = {
+  name: string;
+  cap: number;
+  mobs: string[];
+  bracket: number;
+};
+
+type RawMob = {
+  name: string;
+  item?: string;
+  skullOwner?: string;
+  texture?: string;
+  cap: number;
+  mobs: string[];
+  bracket: number;
+};

API/constants/calendar.js

@@ -1,4 +1,5 @@
 // CREDITS: https://github.com/slothpixel/core (Modified)
+// @ts-nocheck
 const { nth, parseTimestamp } = require("../../src/contracts/helperFunctions.js");
 
 const months = [

API/constants/fetchur_items.js

@@ -1,3 +1,12 @@
+/**
+ * @typedef {Record<number, {
+ *  name: string,
+ * quantity: number,
+ * text: string,
+ * image: string,
+ * description: string
+ * }>} fetchur_items
+ */
 module.exports = {
   0: {
     name: "Red Wool",

API/constants/functions.js

@@ -201,19 +201,7 @@ const skillTables = {
     farming: 60,
     taming: 60
   },
-  skills: [
-    "combat",
-    "farming",
-    "fishing",
-    "mining",
-    "foraging",
-    "enchanting",
-    "alchemy",
-    "carpentry",
-    "runecrafting",
-    "social",
-    "taming"
-  ],
+  skills: ["combat", "farming", "fishing", "mining", "foraging", "enchanting", "alchemy", "carpentry", "runecrafting", "social", "taming"],
   classes: ["healer", "mage", "berserk", "archer", "tank"],
   cosmeticSkills: ["runecrafting", "social"],
   infiniteLeveling: ["dungeoneering", "skyblockLevel"],