osrs-tools 2.3.3 → 2.3.5

package/README.md

@@ -1,3 +1,11 @@
+
+
+Refer to modern Node Packages. Update the Package.json to ONLY need the modern dependencies, reduce packages as much as possible.
+
+
+
+
+
 # OSRS Tools
 
 [![NPM Version](https://img.shields.io/npm/v/osrs-tools.svg?style=for-the-badge)](https://www.npmjs.com/package/osrs-tools)

package/package.json

@@ -1,43 +1,12 @@
 {
   "name": "osrs-tools",
-  "version": "2.3.3",
+  "version": "2.3.5",
   "description": "A comprehensive TypeScript library for Old School RuneScape (OSRS) data and utilities, including quest data, skill requirements, and game item information",
   "license": "MIT",
-  "keywords": [
-    "osrs",
-    "runescape",
-    "typescript",
-    "quest",
-    "game-data"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/jamescer/osrs-tools.git"
-  },
-  "homepage": "https://github.com/jamescer/osrs-tools#readme",
-  "bugs": {
-    "url": "https://github.com/jamescer/osrs-tools/issues"
-  },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "sideEffects": false,
-  "engines": {
-    "node": ">=18"
-  },
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "build:osrs-tools": "tsc -p tsconfig.json",
     "build:osrs-tools:npm": "tsc -p tsconfig.build.json",
-    "clean": "rimraf dist",
     "coverage": "jest --coverage && codecov",
     "dev": "tsc --watch -p tsconfig.build.json",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
@@ -45,7 +14,7 @@
     "getQuestDetails": "ts-node tools/GetQuestDetails.ts",
     "lint": "eslint \"{src,test}/**/*.ts\" --fix",
     "postpublish": "git push && git push --tags",
-    "prebuild": "npm run clean",
+    "prebuild-backup": "npm run clean",
     "prepublishOnly": "npm run build && npm test",
     "preversion": "npm test",
     "runExample": "ts-node examples/ExampleQuest.ts",
@@ -61,39 +30,39 @@
     "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.3.1",
-    "@eslint/js": "^8.57.0",
-    "@tsconfig/recommended": "^1.0.11",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^18.19.130",
-    "@typescript-eslint/eslint-plugin": "^8.51.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "codecov": "^3.8.2",
-    "commitlint": "^17.8.1",
-    "eslint": "^8.57.1",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-jest": "^27.9.0",
-    "eslint-plugin-prettier": "^5.5.4",
-    "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-sort-destructure-keys": "^1.6.0",
-    "eslint-plugin-sort-keys-fix": "^1.1.2",
     "jest": "^29.7.0",
-    "lint-staged": "^16.2.7",
     "prettier": "^3.6.2",
-    "rimraf": "^6.1.2",
     "ts-jest": "^29.4.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3"
   },
-  "lint-staged": {
-    "*.{ts,tsx}": [
-      "eslint --fix",
-      "prettier --write"
-    ]
+  "keywords": [
+    "osrs",
+    "runescape",
+    "typescript",
+    "quest",
+    "game-data"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jamescer/osrs-tools.git"
+  },
+  "homepage": "https://github.com/jamescer/osrs-tools#readme",
+  "bugs": {
+    "url": "https://github.com/jamescer/osrs-tools/issues"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
   },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18"
   }
 }

package/dist/out-tsc/test/resources/A_Squeezer_Main_Data.js

@@ -1,474 +0,0 @@
-export const account = {
-    bosses: {
-        abyssalSire: {
-            rank: -1,
-            score: -1,
-        },
-        alchemicalHydra: {
-            rank: 65617,
-            score: 1094,
-        },
-        amoxliatl: {
-            rank: 118294,
-            score: 12,
-        },
-        araxxor: {
-            rank: -1,
-            score: -1,
-        },
-        artio: {
-            rank: -1,
-            score: -1,
-        },
-        barrows: {
-            rank: 727988,
-            score: 40,
-        },
-        bryophyta: {
-            rank: -1,
-            score: -1,
-        },
-        callisto: {
-            rank: 261941,
-            score: 9,
-        },
-        calvarion: {
-            rank: 180229,
-            score: 20,
-        },
-        cerberus: {
-            rank: 326766,
-            score: 8,
-        },
-        chambersOfXeric: {
-            rank: -1,
-            score: -1,
-        },
-        chambersOfXericChallengeMode: {
-            rank: -1,
-            score: -1,
-        },
-        chaosElemental: {
-            rank: 30253,
-            score: 188,
-        },
-        chaosFanatic: {
-            rank: 146323,
-            score: 37,
-        },
-        commanderZilyana: {
-            rank: 262561,
-            score: 16,
-        },
-        corporealBeast: {
-            rank: -1,
-            score: -1,
-        },
-        corruptedGauntlet: {
-            rank: 186921,
-            score: 53,
-        },
-        crazyArchaeologist: {
-            rank: 206946,
-            score: 36,
-        },
-        dagannothPrime: {
-            rank: 263181,
-            score: 68,
-        },
-        dagannothRex: {
-            rank: 378253,
-            score: 83,
-        },
-        dagannothSupreme: {
-            rank: 261925,
-            score: 67,
-        },
-        derangedArchaeologist: {
-            rank: 113337,
-            score: 25,
-        },
-        dukeSucellus: {
-            rank: -1,
-            score: -1,
-        },
-        gauntlet: {
-            rank: 299089,
-            score: 5,
-        },
-        generalGraardor: {
-            rank: 228638,
-            score: 135,
-        },
-        giantMole: {
-            rank: 137707,
-            score: 250,
-        },
-        grotesqueGuardians: {
-            rank: 85633,
-            score: 229,
-        },
-        hespori: {
-            rank: 597256,
-            score: 10,
-        },
-        hueycoatl: {
-            rank: -1,
-            score: -1,
-        },
-        kalphiteQueen: {
-            rank: 220866,
-            score: 35,
-        },
-        kingBlackDragon: {
-            rank: 218475,
-            score: 161,
-        },
-        kraken: {
-            rank: 45535,
-            score: 3538,
-        },
-        kreeArra: {
-            rank: 101535,
-            score: 120,
-        },
-        krilTsutsaroth: {
-            rank: 329555,
-            score: 5,
-        },
-        leviathan: {
-            rank: -1,
-            score: -1,
-        },
-        lunarChests: {
-            rank: -1,
-            score: -1,
-        },
-        mimic: {
-            rank: -1,
-            score: -1,
-        },
-        nex: {
-            rank: -1,
-            score: -1,
-        },
-        nightmare: {
-            rank: -1,
-            score: -1,
-        },
-        obor: {
-            rank: -1,
-            score: -1,
-        },
-        phantomMuspah: {
-            rank: -1,
-            score: -1,
-        },
-        phosanisNightmare: {
-            rank: -1,
-            score: -1,
-        },
-        royalTitans: {
-            rank: -1,
-            score: -1,
-        },
-        sarachnis: {
-            rank: 359046,
-            score: 10,
-        },
-        scorpia: {
-            rank: -1,
-            score: -1,
-        },
-        scurrius: {
-            rank: -1,
-            score: -1,
-        },
-        skotizo: {
-            rank: 64955,
-            score: 50,
-        },
-        solHeredit: {
-            rank: -1,
-            score: -1,
-        },
-        spindel: {
-            rank: -1,
-            score: -1,
-        },
-        tempoross: {
-            rank: 582913,
-            score: 26,
-        },
-        theatreOfBlood: {
-            rank: -1,
-            score: -1,
-        },
-        theatreOfBloodHardMode: {
-            rank: -1,
-            score: -1,
-        },
-        thermonuclearSmokeDevil: {
-            rank: 254294,
-            score: 58,
-        },
-        tombsOfAmascut: {
-            rank: 237924,
-            score: 9,
-        },
-        tombsOfAmascutExpertMode: {
-            rank: -1,
-            score: -1,
-        },
-        tzKalZuk: {
-            rank: -1,
-            score: -1,
-        },
-        tzTokJad: {
-            rank: -1,
-            score: -1,
-        },
-        vardorvis: {
-            rank: -1,
-            score: -1,
-        },
-        venenatis: {
-            rank: -1,
-            score: -1,
-        },
-        vetion: {
-            rank: 176839,
-            score: 15,
-        },
-        vorkath: {
-            rank: 209751,
-            score: 398,
-        },
-        whisperer: {
-            rank: -1,
-            score: -1,
-        },
-        wintertodt: {
-            rank: 589629,
-            score: 181,
-        },
-        yama: {
-            rank: -1,
-            score: -1,
-        },
-        zalcano: {
-            rank: -1,
-            score: -1,
-        },
-        zulrah: {
-            rank: 327720,
-            score: 152,
-        },
-    },
-    bountyHunter: {
-        hunter: {
-            rank: -1,
-            score: -1,
-        },
-        hunterV2: {
-            rank: -1,
-            score: -1,
-        },
-        rogue: {
-            rank: -1,
-            score: -1,
-        },
-        rogueV2: {
-            rank: -1,
-            score: -1,
-        },
-    },
-    clues: {
-        all: {
-            rank: 204288,
-            score: 313,
-        },
-        beginner: {
-            rank: 534282,
-            score: 8,
-        },
-        easy: {
-            rank: 251703,
-            score: 27,
-        },
-        elite: {
-            rank: 178116,
-            score: 26,
-        },
-        hard: {
-            rank: 97874,
-            score: 217,
-        },
-        master: {
-            rank: 260502,
-            score: 4,
-        },
-        medium: {
-            rank: 387064,
-            score: 31,
-        },
-    },
-    collectionsLogged: {
-        rank: -1,
-        score: -1,
-    },
-    colosseumGlory: {
-        rank: -1,
-        score: -1,
-    },
-    combatLevel: 126,
-    deadmanPoints: {
-        rank: -1,
-        score: -1,
-    },
-    lastManStanding: {
-        rank: 280319,
-        score: 536,
-    },
-    leaguePoints: {
-        rank: -1,
-        score: -1,
-    },
-    name: 'A Squeezer',
-    pvpArena: {
-        rank: -1,
-        score: -1,
-    },
-    questPoints: 300,
-    rank: 31748,
-    riftsClosed: {
-        rank: 510867,
-        score: 43,
-    },
-    skills: {
-        agility: {
-            level: 84,
-            rank: 296040,
-            xp: 3135919,
-        },
-        attack: {
-            level: 99,
-            rank: 209891,
-            xp: 15057003,
-        },
-        construction: {
-            level: 85,
-            rank: 303230,
-            xp: 3258621,
-        },
-        cooking: {
-            level: 99,
-            rank: 130879,
-            xp: 13800774,
-        },
-        crafting: {
-            level: 99,
-            rank: 84868,
-            xp: 13645482,
-        },
-        defence: {
-            level: 99,
-            rank: 244468,
-            xp: 13595705,
-        },
-        farming: {
-            level: 99,
-            rank: 243143,
-            xp: 13245384,
-        },
-        firemaking: {
-            level: 88,
-            rank: 603071,
-            xp: 4473930,
-        },
-        fishing: {
-            level: 99,
-            rank: 125754,
-            xp: 13052764,
-        },
-        fletching: {
-            level: 99,
-            rank: 223800,
-            xp: 13036552,
-        },
-        herblore: {
-            level: 85,
-            rank: 366503,
-            xp: 3376252,
-        },
-        hitpoints: {
-            level: 99,
-            rank: 280654,
-            xp: 23817468,
-        },
-        hunter: {
-            level: 87,
-            rank: 256655,
-            xp: 4200146,
-        },
-        magic: {
-            level: 99,
-            rank: 377497,
-            xp: 13429705,
-        },
-        mining: {
-            level: 99,
-            rank: 88776,
-            xp: 13369968,
-        },
-        overall: {
-            level: 2185,
-            rank: 128092,
-            xp: 252737198,
-        },
-        prayer: {
-            level: 90,
-            rank: 249810,
-            xp: 5689303,
-        },
-        ranged: {
-            level: 99,
-            rank: 380024,
-            xp: 15904871,
-        },
-        runecraft: {
-            level: 91,
-            rank: 136245,
-            xp: 6387413,
-        },
-        slayer: {
-            level: 99,
-            rank: 132848,
-            xp: 14162676,
-        },
-        smithing: {
-            level: 98,
-            rank: 131398,
-            xp: 12084488,
-        },
-        strength: {
-            level: 99,
-            rank: 337927,
-            xp: 14660672,
-        },
-        thieving: {
-            level: 91,
-            rank: 252496,
-            xp: 6154434,
-        },
-        woodcutting: {
-            level: 99,
-            rank: 135561,
-            xp: 13197668,
-        },
-    },
-    soulWarsZeal: {
-        rank: 191499,
-        score: 277,
-    },
-};

package/dist/out-tsc/test/unit/account/OsrsAccount.test.js

@@ -1,76 +0,0 @@
-import { OsrsAccount } from '../../../source/runescape/model/account/OsrsAccount';
-import { account as accountData } from '../../resources/A_Squeezer_Main_Data';
-describe('OsrsAccount', () => {
-    let account;
-    beforeEach(() => {
-        account = OsrsAccount.fromJson(accountData);
-    });
-    it('should initialize with default values', () => {
-        expect(account.name).toBe('A Squeezer');
-        expect(account.skills).toBeDefined();
-        expect(account.questPoints).toBeDefined();
-        expect(account.combatLevel).toBeDefined();
-        expect(account.skillsDetail).toBeDefined();
-        expect(account.bosses).toBeDefined();
-        expect(account.clues).toBeDefined();
-        expect(account.bountyHunter).toBeDefined();
-        expect(account.lastManStanding).toBeDefined();
-        expect(account.pvpArena).toBeDefined();
-        expect(account.soulWarsZeal).toBeDefined();
-        expect(account.riftsClosed).toBeDefined();
-        expect(account.colosseumGlory).toBeDefined();
-        expect(account.collectionsLogged).toBeDefined();
-        expect(account.leaguePoints).toBeDefined();
-        expect(account.deadmanPoints).toBeDefined();
-    });
-    it('should get skill by name', () => {
-        const skill = account.getSkill('attack');
-        expect(skill).toBeDefined();
-        expect(skill?.level).toBeDefined();
-        expect(skill?.level).toBe(99);
-    });
-    it('should get skill detail by name', () => {
-        const skillDetail = account.getSkillDetail('attack');
-        expect(skillDetail).toBeDefined();
-        expect(skillDetail?.rank).toBeDefined();
-        expect(skillDetail?.level).toBeDefined();
-        expect(skillDetail?.xp).toBeDefined();
-    });
-    it('should get boss score by name', () => {
-        const bossScore = account.getBossScore('zulrah');
-        expect(bossScore).toBeDefined();
-        expect(bossScore?.rank).toBeDefined();
-        expect(bossScore?.score).toBeDefined();
-    });
-    it('should get clue score by type', () => {
-        const clueScore = account.getClueScore('beginner');
-        expect(clueScore).toBeDefined();
-        expect(clueScore?.rank).toBeDefined();
-        expect(clueScore?.score).toBeDefined();
-    });
-    it('should return correct string from toString()', () => {
-        const str = account.toString();
-        expect(str).toContain(account.name);
-        expect(str).toContain(account.combatLevel.toString());
-        expect(str).toContain(account.questPoints.toString());
-    });
-    it('should return correct data from toJson()', () => {
-        const json = account.toJson();
-        expect(json.name).toBe(account.name);
-        expect(json.combatLevel).toBe(account.combatLevel);
-        expect(json.questPoints).toBe(account.questPoints);
-        expect(json.skills).toEqual(account.skills);
-        expect(json.skillsDetail).toEqual(account.skillsDetail);
-        expect(json.bosses).toEqual(account.bosses);
-        expect(json.clues).toEqual(account.clues);
-        expect(json.bountyHunter).toEqual(account.bountyHunter);
-        expect(json.lastManStanding).toEqual(account.lastManStanding);
-        expect(json.pvpArena).toEqual(account.pvpArena);
-        expect(json.soulWarsZeal).toEqual(account.soulWarsZeal);
-        expect(json.riftsClosed).toEqual(account.riftsClosed);
-        expect(json.colosseumGlory).toEqual(account.colosseumGlory);
-        expect(json.collectionsLogged).toEqual(account.collectionsLogged);
-        expect(json.leaguePoints).toEqual(account.leaguePoints);
-        expect(json.deadmanPoints).toEqual(account.deadmanPoints);
-    });
-});