osrs-tools 0.1.1 → 0.2.0

package/README.md

@@ -1,42 +1,118 @@
-## Old School Runescape Quest Tool
+# Old School RuneScape Quest Tool
 
-A [Node Package](https://www.npmjs.com/package/osrs-quest-tool) to provide data for all current old school runescape quests. Creating tools to help junior software developers build things they are passionate about. Work in progress and issues should be reported to cerniglj1@hawkmail.newpaltz.edu or jamesmcerniglia@gmail.com or reported under the [issues tab on gituhb](https://github.com/cerniglj1/osrs-quest-tool/issues).
+[![NPM Version][npm-image]][npm-url] [![Downloads][downloads-image]][downloads-url] [![GitHub Issues][issues-img]][new-issue]  
+[![types](https://img.shields.io/npm/types/osrs-tools.svg?style=flat-square)](https://github.com/jamescer/osrs-tools/blob/master/src/types.ts)
+
+The **Old School RuneScape Quest Tool** is a Node.js package designed to provide comprehensive data for all current Old School RuneScape (OSRS) quests, slayer tasks, and related game mechanics. This tool is ideal for developers looking to integrate OSRS data into their projects, whether for personal use, game guides, or community tools.
+
+## Features
+
+- Access detailed quest data, including requirements, rewards, and steps.
+- Retrieve slayer task information, including task weights, requirements, and locations.
+- Explore slayer master data, including assigned tasks, combat level requirements, and rewards.
+- Built-in support for tracking quest and slayer progress.
+- Easy-to-use API for developers of all skill levels.
 
 ## Installation
 
-```js
-npm i osrs-quest-tool
+Install the package via npm:
+
+```bash
+npm install osrs-tools --save
+```
+
+## Usage
+
+Here’s how to use the tool in your project:
+
+### Importing the Module
+
+```javascript
+import { QuestTool, questArray, questObject } from 'osrs-tools';
+```
+
+### Working with Quests
+
+```javascript
+// Instantiate the QuestTool class
+const tool = new QuestTool();
+
+// Get quest data as an array
+const questArrayData = questArray();
+
+// Get quest data as an object
+const questObjectData = questObject();
+
+// Output the quest data
+console.log(questArrayData);
+console.log(questObjectData);
 ```
 
-| Syntax            | Description                                                      | Type              |
-| ----------------- | ---------------------------------------------------------------- | ----------------- |
-| `new QuestTool()` | constructor for QuestTool class.                                 | Class Constructor |
-| `questObject()`   | function that returns an object of quest array keys.             | Function ()       |
-| `questArray()`    | function that returns an array of alphabetically ordered quests. | Function ()        |
-| `questObject`     | an object of quest array keys.                                   | Object { }        |
-| `questArray`      | an array of alphabetically ordered quests.                       | Array [ ]         |
-
----
-
-### Example Javascript
-
-```js
-import { QuestTool, questArray, questObject } from "osrs-quest-tool";
-var tool = new QuestTool();
-this.questArray = questArray();
-this.questData = questObject();
-console.log(this.questData);
-console.log(this.questArray);
+### Working with Slayer Masters and Tasks
+
+```javascript
+import { Turael, Duradel } from 'osrs-tools';
+
+// Access Turael's tasks
+console.log(Turael.getTasks());
+
+// Get a random task from Duradel
+const randomTask = Duradel.getRandomTask();
+console.log(randomTask);
+```
+
+### Slayer Rewards and Unlocks
+
+```javascript
+import { SlayerUnlocks, SlayerBuys } from 'osrs-tools';
+
+// List all available Slayer unlocks
+console.log(SlayerUnlocks);
+
+// List all items available for purchase with Slayer points
+console.log(SlayerBuys);
 ```
 
----
+## API Reference
+
+### Quest API
+
+| Method            | Description                                                             | Type              |
+| ----------------- | ----------------------------------------------------------------------- | ----------------- |
+| `new QuestTool()` | Constructor for the `QuestTool` class.                                  | Class Constructor |
+| `questObject()`   | Function that returns an object with quest data (keys are quest names). | Function          |
+| `questArray()`    | Function that returns an array of quests, ordered alphabetically.       | Function          |
+
+### Slayer API
+
+| Class/Method         | Description                                                                 |
+| -------------------- | ------------------------------------------------------------------------- |
+| `SlayerMaster`       | Represents a Slayer Master, including tasks, location, and requirements. |
+| `getTasks()`         | Returns a list of tasks assigned by the Slayer Master.                   |
+| `getRandomTask()`    | Returns a random task based on task weights.                             |
+| `SlayerUnlocks`      | Predefined list of Slayer unlocks with costs and descriptions.           |
+| `SlayerBuys`         | Predefined list of items available for purchase with Slayer points.      |
+
+## To-Do
+
+- Implement a recursive function for determining quest completion.
+- Develop a quest completion tracking array.
+- Refactor `questArray()` and `questObject()` to return objects instead of functions.
+- Continue work on the **Recipe for Disaster** quest.
+- Fix and validate all Slayer data.
+
+## Contributing
 
-## Notes
+Contributions are welcome! If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/jamescer/osrs-tools).
 
-Recipe for disaster is a work in progress!
+## Credits
 
-## TODO
+- **Author**: [James Cerniglia](mailto:jamesmcerniglia@gmail.com)
+- **Repository**: [GitHub - osrs-tools](https://github.com/jamescer/osrs-tools)
 
-- Implement recursive function for determining quest completion
-- Implement quest completion array
-- Implement questArray and questObject objects instead of functions
+[npm-image]: https://img.shields.io/npm/v/osrs-tools.svg
+[npm-url]: https://www.npmjs.com/package/osrs-tools
+[downloads-image]: https://img.shields.io/npm/dm/osrs-tools.svg
+[downloads-url]: https://npmcharts.com/compare/osrs-tools?minimal=true
+[issues-img]: https://img.shields.io/github/issues/jamescer/osrs-tools.svg
+[new-issue]: https://github.com/jamescer/osrs-tools/issues/new/choose

package/package.json

@@ -1,80 +1,95 @@
 {
-    "name": "osrs-tools",
-    "description": "A typescript package to provide the json for all current old school runescape quests. Creating tools to help junior software developers create things they are passionate about. Work in progress and issues should be reported to jamescer@hawkmail.newpaltz.edu or jamesmcerniglia@gmail.com",
-    "version": "0.1.1",
-    "main": "./src/index.ts",
-    "notes": [],
-    "test": "node src/test.ts",
-    "scripts": {
-        "start": "node src/test.js",
-        "test": "node src/test3.js",
-        "test2": "node src/index.js",
-        "test1": "mocha test.js"
+  "name": "osrs-tools",
+  "description": "A JavaScript package to provide JSON data for all current Old School RuneScape quests. This package aims to help junior software developers create tools related to Old School RuneScape. It's a work in progress, and issues should be reported to jamescer@hawkmail.newpaltz.edu or jamesmcerniglia@gmail.com.",
+  "version": "0.2.0",
+  "license": "MIT",
+  "main": "index.js",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "scripts": {
+    "test": "jest --coverage",
+    "scrapeQuestList": "ts-node tools/ScrapeQuestData.ts",
+    "scrapeSlayerData": "ts-node tools/ScrapeSlayerData.ts",
+    "getAccountData": "ts-node tools/GetAccountData.ts",
+    "getQuestDetails": "ts-node tools/GetQuestDetails.ts",
+    "build": "tsc -p .",
+    "dev": "tsc --watch -p .",
+    "test:mocha": "mocha ./src/lib/tests/unit/Quest.test.js --timeout 30000 --exit",
+    "prepublishOnly": "npm test",
+    "postpublish": "git push && git push --tags",
+    "preversion": "gulp version && npm test",
+    "version": "npm run build && git add dist && git add package.json"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.25.7",
+    "@babel/preset-env": "^7.25.7",
+    "@babel/preset-typescript": "^7.25.7",
+    "@types/chai": "^5.0.1",
+    "@types/jest": "^26.0.24",
+    "jest": "^29.7.0",
+    "mocha": "^11.1.0",
+    "ts-jest": "^29.2.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "axios": "^1.7.7",
+    "babel": "^6.23.0",
+    "cheerio": "^1.0.0",
+    "jest-circus": "^29.7.0",
+    "node-fetch": "^3.3.2",
+    "travis": "^0.1.1"
+  },
+  "publishConfig": {
+    "registryBackup": "https://npm.pkg.github.com/jamescer"
+  },
+  "files": [
+    "src/**"
+  ],
+  "bin": {
+    "osrs-tools": "lib/cli.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jamescer/osrs-tools.git"
+  },
+  "keywords": [
+    "RuneScape",
+    "OSRS",
+    "Old School RuneScape",
+    "OSRS tools",
+    "OSRS quest",
+    "OSRS quest API",
+    "Quest Tool",
+    "Old School RuneScape Tools",
+    "Old School RuneScape Data"
+  ],
+  "contributors": [
+    "James Cerniglia (https://github.com/jamescer)"
+  ],
+  "author": "James Cerniglia",
+  "bugs": {
+    "url": "https://github.com/jamescer/osrs-tools/issues",
+    "email": "jamesmcerniglia@gmail.com"
+  },
+  "homepage": "https://github.com/jamescer/osrs-tools#readme",
+  "funding": [
+    {
+      "type": "GitHub",
+      "url": "https://github.com/jamescer"
     },
-    "publishConfig": {
-        "registryBackup": "https://npm.pkg.github.com/jamescer"
+    {
+      "type": "Patreon",
+      "url": "https://patreon.com/big_squeezer?utm_medium=unknown&utm_source=join_link&utm_campaign=creatorshare_creator&utm_content=copyLink"
     },
-    "files": [
-        "src/**"
-    ],
-    "bin": {
-        "osrs-tools": "src/cli.js"
+    {
+      "type": "Ko-fi",
+      "url": "https://ko-fi.com/jamescer"
     },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/jamescer/osrs-tools.git"
-    },
-    "keywords": [
-        "runescape",
-        "osrs",
-        "old school runescape",
-        "osrs tools",
-        "osrs quest",
-        "osrs quest api",
-        "osrs-quest-api",
-        "osrs quest tool",
-        "osrs-quest-tool",
-        "osrs-quest-api",
-        "OSRS QuestTool",
-        "Quest Tool osrs"
-    ],
-    "author": "James Cerniglia <jamesmcerniglia@gmail.com>",
-    "license": "ISC",
-    "bugs": {
-        "url": "https://github.com/jamescer/osrs-quest-tool/issues",
-        "email": "jamesmcerniglia@gmail.com"
-    },
-    "homepage": "https://github.com/jamescer/osrs-quest-tool#readme",
-    "dependencies": {
-        "babel": "^6.23.0",
-        "chai": "^4.3.4",
-        "mocha": "^7.2.0",
-        "osrs-json-hiscores": "^2.6.0",
-        "travis": "^0.1.1"
-    },
-    "funding": [
-        {
-            "type": "GitHub",
-            "url": "https://github.com/jamescer"
-        },
-        {
-            "type": "Patreon",
-            "url": "https://www.patreon.com/"
-        },
-        {
-            "type": "PayPal",
-            "url": "https://paypal.me/"
-        },
-        {
-            "type": "Ko-fi",
-            "url": "https://ko-fi.com/"
-        },
-        {
-            "type": "Venmo",
-            "url": "https://venmo.com/"
-        }
-    ],
-    "devDependencies": {
-        "coveralls": "^3.1.1"
+    {
+      "type": "Venmo",
+      "url": "https://venmo.com/jamescer"
     }
-}
+  ]
+}