poe-api-manager 0.2.6 → 1.0.0

package/Changelog.md

@@ -1,23 +1,27 @@
 # Changelog
-## 0.2.6
-JSDocs have been added for easy understanding.
+## 1.0.0
+- 🚀[New] utils class
+- 🚀[New] utils `getLeagues`function. Get league name.
+- 📝 [Update] The documentation has been updated.
 
+## 0.2.8
+- 🚀[Added] poe.watch API with `getCategory()` function.
+- 🛠️ [Fixed] Typo in WatchAPI class
+- 📝 [Update] The documentation has been updated.
+## 0.2.6
+- 🎨[Added] JSDocs for easy understanding.
 
 ## 0.2.2
-poe.watch API add
-
-use getData() function
-
-
-## 0.1.0 
-poe.ninja API new 
+- 🚀[Added] poe.watch API with `getData()` function.
 
-- Omens
-- Unique Relics
-- Cluster Jewels
-- Blighted Maps
-- Blight Ravaged Maps
-- Invitations
-- Memories
+## 0.1.0
+- 🚀[Added] poe.ninja API with the following features:
+    - Omens
+    - Unique Relics
+    - Cluster Jewels
+    - Blighted Maps
+    - Blight Ravaged Maps
+    - Invitations
+    - Memories
 
-## 0.0.1 Publish
+## 0.0.1 Publish

package/README.md

@@ -1,7 +1,7 @@
 # poe-api-manager
 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
-![Version](https://img.shields.io/github/package-json/v/ayberkgezer/poe-api-manager)
+![GitHub package.json version](https://img.shields.io/github/package-json/v/ayberkgezer/poe-api-manager)
 ![GitHub top language](https://img.shields.io/github/languages/top/ayberkgezer/poe-api-manager?logo=javascript)
 [![ISSUES](https://img.shields.io/github/issues/ayberkgezer/poe-api-manager)](https://github.com/ayberkgezer/poe-api-manager/issues)
 ![NPM Downloads](https://img.shields.io/npm/dt/poe-api-manager?logo=npm)
@@ -12,10 +12,10 @@
 - [Installation](#installation)
 - [Getting Started](#getting-started)
   - [poe.ninja](#ninjaapi)
-    - [currencyWiev](#currencywiev)
-    - [itemWiev](#itemwiev)
+    - [currencyView](#currencywiev)
+    - [itemView](#itemwiev)
   - [poe.watch](#watchapi)
-    - [wiev](#wiev)
+    - [view](#view)
 - [Changelog](https://github.com/ayberkgezer/poe-api-manager/blob/main/Changelog.md)
 - [Examples](#examples)
 
@@ -47,7 +47,7 @@ const { NinjaAPI } = require("poe-api-manager");
 const ninjaAPI = new NinjaAPI("League-Name");
 ```
 
-#### currencyWiev
+#### currencyView
 What we can get here is as follows.
 - Currency
 - Fragment
@@ -55,7 +55,7 @@ What we can get here is as follows.
 getData() => function returns data purely.
 ```javascript
 //Example Currency
-ninjaAPI.currencyWiev.currency.getData().then((data) => {
+ninjaAPI.currencyView.currency.getData().then((data) => {
   console.log(data);
 });
 ```
@@ -63,11 +63,11 @@ getdata(requestedProperties) => The function filters the data as desired.
 >Note: Enter [poe.ninja Document](https://github.com/ayberkgezer/poe.ninja-API-Document?tab=readme-ov-file#poeninja-api) to access the values for the filter.
 ```javascript
 //Filtered data is returned
-ninjaAPI.currencyWiev.currency.getData(["id", "name", "icon"]).then((data) => {
+ninjaAPI.currencyView.currency.getData(["id", "name", "icon"]).then((data) => {
   console.log(data);
 });
 ```
-#### itemWiev
+#### itemView
 What we can get here is as follows.
 - BaseType
 - Beast
@@ -100,7 +100,7 @@ What we can get here is as follows.
 getData() => function returns data purely.
 ```javascript
 //Example BaseType
-ninjaAPI.itemWiev.baseType.getData().then((data) => {
+ninjaAPI.itemView.baseType.getData().then((data) => {
   console.log(data);
 });
 ```
@@ -108,7 +108,7 @@ getdata(requestedProperties) => The function filters the data as desired.
 >Note: Enter [poe.ninja Document](https://github.com/ayberkgezer/poe.ninja-API-Document?tab=readme-ov-file#poeninja-api) to access the values for the filter.
 ```javascript
 //Filtered data is returned
-ninjaAPI.itemWiev.baseType.getData(["id", "name", "icon"]).then((data) => {
+ninjaAPI.itemView.baseType.getData(["id", "name", "icon"]).then((data) => {
   console.log(data);
 });
 ```
@@ -118,7 +118,7 @@ const { WatchAPI } = require("poe-api-manager");
 
 const watchAPI = new WatchAPI("League-Name");
 ```
-#### wiev
+#### view
 What we can get here is as follows.
 - Currency
 - Essences
@@ -138,19 +138,48 @@ What we can get here is as follows.
 - Base
 - Beast
 
+getData() => function returns data purely.
 ```javascript
 //Example Currency
-watchAPI.wiev.baseType.getData().then((data) => {
+watchAPI.view.baseType.getData().then((data) => {
   console.log(data);
 });
 ```
 > Enter [poe.watch Document](https://docs.poe.watch/#get-all-armours) to access the values for the filter.
+
+getdata(requestedProperties) => The function filters the data as desired.
 ```javascript
 //Filtered data is returned
-watchAPI.wiev.currency.getData(["id", "name", "icon"]).then((data) => {
+watchAPI.view.currency.getData(["id", "name", "icon"]).then((data) => {
   console.log(data);
 });
 ```
+getCategory("categoryName") => The function quickly filters through specific categories.
+
+> Note: Used in accessory, armour, base, gem and weapon.
+
+```javascript
+//Returns the chest category in Armor.
+watchAPI.view.armour.getCategory("chest").then((data) => {
+  console.log(data);
+});
+```
+## Utils
+Utils class is a class that contains some auxiliary tools.
+```javascript
+const { Utils } = require("poe-api-manager");
+const utils = new Utils();
+```
+getLeagues() => Returns available league names.
+
+```javascript
+const utils = new Utils();
+
+utils.getLeagues().then((data) => {
+  console.log(data);
+});
+```
+
 
 ## Examples
 ```javascript
@@ -165,17 +194,17 @@ const watchAPI = new WatchAPI("Affliction")
 const requestedProperties = ["id", "name", "icon"];
 
 //filtered BaseType data ninjaAPI
-ninjaAPI.itemwiev.baseType.getData(requestedProperties).then((data) => {
+ninjaAPI.itemView.baseType.getData(requestedProperties).then((data) => {
   console.log(data);
 });
 
 //filtered Currency data ninjaAPI
-ninjaAPI.currencyWiev.currency.getData(requestedProperties).then((data) => {
+ninjaAPI.currencyView.currency.getData(requestedProperties).then((data) => {
   console.log(data);
 });
 
 // filtered Scarab data watchAPI
-watchAPI.wiev.scarab.getData(requestedProperties).then((data) => {
+watchAPI.view.scarab.getData(requestedProperties).then((data) => {
   console.log(data);
 });
 ```
@@ -194,22 +223,22 @@ const requestedProperties = ["id", "name", "icon"];
 const fetchData = async () => {
   try {
     //Oil Data poe.ninja
-    const oilData = await ninjaAPI.item.oil.getData(requestedProperties);
+    const oilData = await ninjaAPI.itemView.oil.getData(requestedProperties);
 
 
     console.log("poe.ninja Oil Data:", oilData);
 
     //Currency Data poe.ninja
-    const currencyData = await ninjaAPI.currencyWiev.currency.getData(requestedProperties);
+    const currencyData = await ninjaAPI.currencyView.currency.getData(requestedProperties);
 
     console.log("poe.ninja Currency Data:", currencyData);
 
     //Scarab Data poe.watch
-    const scarabData = await watchAPI.wiev.scarab.getData(requestedProperties)
+    const scarabData = await watchAPI.view.scarab.getData(requestedProperties)
 
     console.log("poe.watch Scarab Data", scarabData);
   } catch (error) {
     console.error("Error fetching data:", error);
   }
 };
-```
+```

package/index.js

@@ -1,7 +1,9 @@
 const NinjaAPI = require("./lib/NinjaAPI");
 const WatchAPI = require("./lib/WatchAPI");
+const Utils = require("./lib/Utils");
 
 module.exports = {
   NinjaAPI: NinjaAPI,
   WatchAPI: WatchAPI,
+  Utils: Utils,
 };

package/lib/Utils.js

@@ -0,0 +1,26 @@
+const getLeagues = require("./modules/utils/getLeagues");
+
+/**
+ * A utility class.
+ *
+ * @class
+ */
+class Utils {
+  constructor() {}
+  /**
+   * Fetches the list of leagues for the game.
+   * @async
+   * @function getLeagues
+   * @returns {Promise<string[]>} The array of league names.
+   * @throws {Error} If there's an error fetching the leagues.
+   */
+  async getLeagues() {
+    try {
+      return getLeagues();
+    } catch (error) {
+      throw new Error(`Error fetching data Leagues: ${error.message}`);
+    }
+  }
+}
+
+module.exports = Utils;

package/lib/WatchAPI.js

@@ -49,7 +49,7 @@ class WatchAPI {
      *
      * @type {WatchWievModule}
      */
-    this.wiev = new WatchWievModule(this.#leagueUrl);
+    this.view = new WatchWievModule(this.#leagueUrl);
   }
 }
 

package/lib/modules/poe.watch/allModules/functions/getCategory.js

@@ -0,0 +1,55 @@
+const fetchData = require("../fetch/fetch");
+
+/**
+ * Fetches data based on the provided query URL and filters it by category name.
+ *
+ * @async
+ * @function
+ * @param {string} queryUrl - The URL to fetch the data from.
+ * @param {string} categoryName - The name of the category to filter the data by.
+ * @returns {Promise<Array<Object>|Object>} - A promise that resolves to an array of filtered data items.
+ * @throws {Error} Throws an error if category name is not provided or if there is an issue fetching or filtering the data.
+ */
+const getCategory = async (queryUrl, categoryName) => {
+  try {
+    /**
+     * @type {Array<Object>} fetchedData - The fetched data.
+     */
+    const fetchedData = await fetchData(queryUrl);
+
+    // Validate category name
+    if (!categoryName && categoryName !== 0) {
+      /**
+       * Throws an error if the category name is not provided.
+       * @throws {Error}
+       */
+      throw new Error("Category name is required.");
+    }
+
+    // Filter data by category name
+    const filteredData = fetchedData.filter(
+      (item) => item.group === categoryName
+    );
+
+    // Check if filtered data is empty
+    if (filteredData.length === 0) {
+      /**
+       * Throws an error if no data is found for the specified category.
+       * @throws {Error}
+       */
+      throw new Error(`No data found for category: ${categoryName}`);
+    }
+
+    return filteredData;
+  } catch (error) {
+    /**
+     * Throws an error if there's an issue fetching or filtering data for the category.
+     * @throws {Error}
+     */
+    throw new Error(
+      `Error fetching or filtering data for category: ${error.message}`
+    );
+  }
+};
+
+module.exports = getCategory;

package/lib/modules/poe.watch/allModules/submodules/AccessoryModule.js

@@ -1,4 +1,5 @@
 const getData = require("../functions/getData");
+const getCategory = require("../functions/getCategory");
 
 /**
  * Represents a module for fetching data related to Accessories.
@@ -53,6 +54,35 @@ class AccessoryModule {
       throw new Error(`Error fetching accessory data: ${error.message}`);
     }
   }
+  /**
+   * Asynchronously retrieves accessory data based on the specified category name.
+   *
+   * @async
+   * @param {string} categoryName - The name of the category to retrieve.
+   * *  Possible values: "amulets", "rings", "belts", "quivers".
+   * @returns {Promise<Array<Object>>} - A promise that resolves to the retrieved data.
+   * @throws {Error} - Throws an error if there is an issue fetching or processing the accessory data for the specified category.
+   *
+   */
+  async getCategory(categoryName) {
+    try {
+      /**
+       * Calls the getCategory function to fetch accessory data based on category name.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getCategory(this.#queryUrl, categoryName);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the accessory data for the specified category.
+       *
+       * @throws {Error}
+       */
+      throw new Error(
+        `Error fetching data Accessory Category: ${error.message}`
+      );
+    }
+  }
 }
 
 // Export the AccessoryModule class

package/lib/modules/poe.watch/allModules/submodules/ArmourModule.js

@@ -1,4 +1,5 @@
 const getData = require("../functions/getData");
+const getCategory = require("../functions/getCategory");
 
 /**
  * Represents a module for fetching data related to Armour.
@@ -53,6 +54,33 @@ class ArmourModule {
       throw new Error(`Error fetching armour data: ${error.message}`);
     }
   }
+  /**
+   * Asynchronously retrieves armour data based on the specified category name.
+   *
+   * @async
+   * @param {string} categoryName - The name of the category to retrieve.
+   * *   Possible values: "chest", "bodyarmours", "shield", "boots", "gloves", "shields", "helmets", "quiver".
+   * @returns {Promise<Array<Object>>} - A promise that resolves to the retrieved data.
+   * @throws {Error} - Throws an error if there is an issue fetching or processing the armour data for the specified category.
+   *
+   */
+  async getCategory(categoryName) {
+    try {
+      /**
+       * Calls the getCategory function to fetch armour data based on category name.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getCategory(this.#queryUrl, categoryName);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the armour data for the specified category.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching data Armour Category: ${error.message}`);
+    }
+  }
 }
 
 // Export the ArmourModule class

package/lib/modules/poe.watch/allModules/submodules/BaseModule.js

@@ -1,4 +1,5 @@
 const getData = require("../functions/getData");
+const getCategory = require("../functions/getCategory");
 
 /**
  * Represents a module for fetching data related to Bases.
@@ -53,6 +54,33 @@ class BaseModule {
       throw new Error(`Error fetching base data: ${error.message}`);
     }
   }
+  /**
+   * Asynchronously retrieves base data based on the specified category name.
+   *
+   * @async
+   * @param {string} categoryName - The name of the category to retrieve.
+   * *  Possible values: "armour", "weapons", "accessories".
+   * @returns {Promise<Array<Object>>} - A promise that resolves to the retrieved data.
+   * @throws {Error} - Throws an error if there is an issue fetching or processing the base data for the specified category.
+   *
+   */
+  async getCategory(categoryName) {
+    try {
+      /**
+       * Calls the getCategory function to fetch base data based on category name.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getCategory(this.#queryUrl, categoryName);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the base data for the specified category.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching data Base Category: ${error.message}`);
+    }
+  }
 }
 
 // Export the BaseModule class

package/lib/modules/poe.watch/allModules/submodules/GemModule.js

@@ -53,6 +53,35 @@ class GemModule {
       throw new Error(`Error fetching Skill Gem data: ${error.message}`);
     }
   }
+  /**
+   * Asynchronously retrieves gems data based on the specified category name.
+   *
+   * @async
+   * @param {string} categoryName - The name of the category to retrieve.
+   * *  Possible values: "supportgem", "gems".
+   * @returns {Promise<Array<Object>>} - A promise that resolves to the retrieved data.
+   * @throws {Error} - Throws an error if there is an issue fetching or processing the gems data for the specified category.
+   *
+   */
+  async getCategory(categoryName) {
+    try {
+      /**
+       * Calls the getCategory function to fetch gems data based on category name.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getCategory(this.#queryUrl, categoryName);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the gems data for the specified category.
+       *
+       * @throws {Error}
+       */
+      throw new Error(
+        `Error fetching data Skill Gem Category: ${error.message}`
+      );
+    }
+  }
 }
 
 // Export the GemModule class

package/lib/modules/poe.watch/allModules/submodules/WeaponModule.js

@@ -1,4 +1,5 @@
 const getData = require("../functions/getData");
+const getCategory = require("../functions/getCategory");
 
 /**
  * Represents a module for fetching data related to Weapons.
@@ -53,6 +54,33 @@ class WeaponModule {
       throw new Error(`Error fetching Weapon data: ${error.message}`);
     }
   }
+  /**
+   * Asynchronously retrieves weapon data based on the specified category name.
+   *
+   * @async
+   * @param {string} categoryName - The name of the category to retrieve.
+   * *   Possible values: "twohandswords", "fishingrods", "onehandswords", "twohandaxes", "staves", "warstaff", "daggers", "scepters".
+   * @returns {Promise<Array<Object>>} - A promise that resolves to the retrieved data.
+   * @throws {Error} - Throws an error if there is an issue fetching or processing the weapon data for the specified category.
+   *
+   */
+  async getCategory(categoryName) {
+    try {
+      /**
+       * Calls the getCategory function to fetch weapon data based on category name.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getCategory(this.#queryUrl, categoryName);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the weapon data for the specified category.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching data Weapon Category: ${error.message}`);
+    }
+  }
 }
 
 // Export the WeaponModule class

package/lib/modules/utils/functions/fetch/fetch.js

@@ -0,0 +1,22 @@
+const axios = require("axios");
+
+/**
+ * Fetches data from the provided URL using Axios.
+ * @param {string} url The URL to fetch data from.
+ * @returns {Promise<any>} A Promise that resolves with the fetched data.
+ * @throws {Error} If an error occurs during the fetch process.
+ */
+async function fetchData(url) {
+  try {
+    const response = await axios.get(url);
+    if (response.data) {
+      return response.data;
+    } else {
+      throw new Error("Invalid response fetched");
+    }
+  } catch (error) {
+    throw new Error(`Error fetching data: ${error.message}`);
+  }
+}
+
+module.exports = fetchData;

package/lib/modules/utils/getLeagues.js

@@ -0,0 +1,24 @@
+const fetchData = require("./functions/fetch/fetch");
+
+/**
+ * Fetches league names from the provided URL.
+ *
+ * This function fetches data from the specified URL which contains information about
+ * Path of Exile leagues. It then extracts the names of the leagues from the fetched data
+ * and returns them as an array.
+ *
+ * @returns {Promise<string[]>} A Promise that resolves with an array of league names.
+ * @throws {Error} If an error occurs during the fetch process or if the response data is empty.
+ */
+async function getLeagues() {
+  const url = "https://api.poe.watch/leagues";
+  try {
+    const fetchedData = await fetchData(url);
+    const names = fetchedData.map((item) => item.name);
+    return names;
+  } catch (error) {
+    throw new Error(`Error fetching League Names: ${error.message}`);
+  }
+}
+
+module.exports = getLeagues;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poe-api-manager",
-  "version": "0.2.6",
+  "version": "1.0.0",
   "description": "API management for poe.ninja and poe.watch",
   "main": "index.js",
   "scripts": {