poe-api-manager 0.2.8 → 1.2.1

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

@@ -1,59 +1,30 @@
-const getData = require("../functions/getData");
+const WatchBaseClass = require("../WatchBaseClass");
+const urlGenerator = require("../watchUrlGenerator/urlGenerator");
 
 /**
- * Represents a module for fetching data related to Jewels.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing jewel data.
  */
-class JewelModule {
+class JewelModule extends WatchBaseClass {
   /**
-   * The query URL for fetching Jewel data.
-   *
-   * @private
+   * The query URL for jewel data.
    * @type {string}
+   * @private
    */
   #queryUrl;
 
   /**
-   * Creates an instance of JewelModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of JewelModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching Jewel data.
-     *
-     * @private
+     * The type of data being accessed (jewel).
      * @type {string}
      */
-    this.#queryUrl = `jewel${leagueUrl}`;
-  }
-
-  /**
-   * Asynchronously retrieves Jewel data based on the specified properties.
-   *
-   * @async
-   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
-   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
-   */
-  async getData(requestedProperties) {
-    try {
-      /**
-       * Calls the getData function to fetch Jewel data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the Jewel data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Jewel data: ${error.message}`);
-    }
+    const type = "jewel";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 }
 
-// Export the JewelModule class
 module.exports = JewelModule;

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

@@ -1,59 +1,30 @@
-const getData = require("../functions/getData");
+const WatchBaseClass = require("../WatchBaseClass");
+const urlGenerator = require("../watchUrlGenerator/urlGenerator");
 
 /**
- * Represents a module for fetching data related to Maps.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing map data.
  */
-class MapModule {
+class MapModule extends WatchBaseClass {
   /**
-   * The query URL for fetching Map data.
-   *
-   * @private
+   * The query URL for map data.
    * @type {string}
+   * @private
    */
   #queryUrl;
 
   /**
-   * Creates an instance of MapModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of MapModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching Map data.
-     *
-     * @private
+     * The type of data being accessed (map).
      * @type {string}
      */
-    this.#queryUrl = `map${leagueUrl}`;
-  }
-
-  /**
-   * Asynchronously retrieves Map data based on the specified properties.
-   *
-   * @async
-   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
-   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
-   */
-  async getData(requestedProperties) {
-    try {
-      /**
-       * Calls the getData function to fetch Map data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the Map data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Map data: ${error.message}`);
-    }
+    const type = "map";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 }
 
-// Export the MapModule class
 module.exports = MapModule;

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

@@ -1,59 +1,30 @@
-const getData = require("../functions/getData");
+const WatchBaseClass = require("../WatchBaseClass");
+const urlGenerator = require("../watchUrlGenerator/urlGenerator");
 
 /**
- * Represents a module for fetching data related to Oils.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing oil data.
  */
-class OilModule {
+class OilModule extends WatchBaseClass {
   /**
-   * The query URL for fetching Oil data.
-   *
-   * @private
+   * The query URL for oil data.
    * @type {string}
+   * @private
    */
   #queryUrl;
 
   /**
-   * Creates an instance of OilModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of OilModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching Oil data.
-     *
-     * @private
+     * The type of data being accessed (oil).
      * @type {string}
      */
-    this.#queryUrl = `oil${leagueUrl}`;
-  }
-
-  /**
-   * Asynchronously retrieves Oil data based on the specified properties.
-   *
-   * @async
-   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
-   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
-   */
-  async getData(requestedProperties) {
-    try {
-      /**
-       * Calls the getData function to fetch Oil data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the Oil data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Oil data: ${error.message}`);
-    }
+    const type = "oil";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 }
 
-// Export the OilModule class
 module.exports = OilModule;

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

@@ -1,59 +1,30 @@
-const getData = require("../functions/getData");
+const WatchBaseClass = require("../WatchBaseClass");
+const urlGenerator = require("../watchUrlGenerator/urlGenerator");
 
 /**
- * Represents a module for fetching data related to Scarabs.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing scarab data.
  */
-class ScarabModule {
+class ScarabModule extends WatchBaseClass {
   /**
-   * The query URL for fetching Scarab data.
-   *
-   * @private
+   * The query URL for scarab data.
    * @type {string}
+   * @private
    */
   #queryUrl;
 
   /**
-   * Creates an instance of ScarabModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of ScarabModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching Scarab data.
-     *
-     * @private
+     * The type of data being accessed (scarab).
      * @type {string}
      */
-    this.#queryUrl = `scarab${leagueUrl}`;
-  }
-
-  /**
-   * Asynchronously retrieves Scarab data based on the specified properties.
-   *
-   * @async
-   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
-   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
-   */
-  async getData(requestedProperties) {
-    try {
-      /**
-       * Calls the getData function to fetch Scarab data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the Scarab data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Scarab data: ${error.message}`);
-    }
+    const type = "scarab";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 }
 
-// Export the ScarabModule class
 module.exports = ScarabModule;

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

@@ -1,59 +1,30 @@
-const getData = require("../functions/getData");
+const WatchBaseClass = require("../WatchBaseClass");
+const urlGenerator = require("../watchUrlGenerator/urlGenerator");
 
 /**
- * Represents a module for fetching data related to Sextants.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing sextant data.
  */
-class SextantModule {
+class SextantModule extends WatchBaseClass {
   /**
-   * The query URL for fetching Sextant data.
-   *
-   * @private
+   * The query URL for sextant data.
    * @type {string}
+   * @private
    */
   #queryUrl;
 
   /**
-   * Creates an instance of SextantModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of SextantModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching Sextant data.
-     *
-     * @private
+     * The type of data being accessed (sextants).
      * @type {string}
      */
-    this.#queryUrl = `sextants${leagueUrl}`;
-  }
-
-  /**
-   * Asynchronously retrieves Sextant data based on the specified properties.
-   *
-   * @async
-   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
-   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
-   */
-  async getData(requestedProperties) {
-    try {
-      /**
-       * Calls the getData function to fetch Sextant data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the Sextant data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Sextant data: ${error.message}`);
-    }
+    const type = "sextants";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 }
 
-// Export the SextantModule class
 module.exports = SextantModule;

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

@@ -1,59 +1,30 @@
-const getData = require("../functions/getData");
+const WatchBaseClass = require("../WatchBaseClass");
+const urlGenerator = require("../watchUrlGenerator/urlGenerator");
 
 /**
- * Represents a module for fetching data related to Unique Maps.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing unique maps data.
  */
-class UniqueMapsModule {
+class UniqueMapsModule extends WatchBaseClass {
   /**
-   * The query URL for fetching Unique Maps data.
-   *
-   * @private
+   * The query URL for unique maps data.
    * @type {string}
+   * @private
    */
   #queryUrl;
 
   /**
-   * Creates an instance of UniqueMapsModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of UniqueMapsModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching Unique Maps data.
-     *
-     * @private
+     * The type of data being accessed (uniqueMaps).
      * @type {string}
      */
-    this.#queryUrl = `currency${leagueUrl}`;
-  }
-
-  /**
-   * Asynchronously retrieves Unique Maps data based on the specified properties.
-   *
-   * @async
-   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
-   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
-   */
-  async getData(requestedProperties) {
-    try {
-      /**
-       * Calls the getData function to fetch Unique Maps data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the Unique Maps data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Unique Maps data: ${error.message}`);
-    }
+    const type = "uniqueMaps";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 }
 
-// Export the UniqueMapsModule class
 module.exports = UniqueMapsModule;

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

@@ -1,87 +1,47 @@
-const getData = require("../functions/getData");
-const getCategory = require("../functions/getCategory");
+const WatchBaseClass = require("../WatchBaseClass");
+const getCategory = require("../methods/getCategory");
+const urlGenerator = require("../watchUrlGenerator/urlGenerator");
 
 /**
- * Represents a module for fetching data related to Weapons.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing weapon data.
  */
-class WeaponModule {
+class WeaponModule extends WatchBaseClass {
   /**
-   * The query URL for fetching Weapon data.
-   *
-   * @private
+   * The query URL for weapon data.
    * @type {string}
+   * @private
    */
   #queryUrl;
 
   /**
-   * Creates an instance of WeaponModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of WeaponModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching Weapon data.
-     *
-     * @private
+     * The type of data being accessed (weapon).
      * @type {string}
      */
-    this.#queryUrl = `weapon${leagueUrl}`;
+    const type = "weapon";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 
   /**
-   * Asynchronously retrieves Weapon data based on the specified properties.
-   *
-   * @async
-   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
-   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
-   */
-  async getData(requestedProperties) {
-    try {
-      /**
-       * Calls the getData function to fetch Weapon data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the Weapon data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Weapon data: ${error.message}`);
-    }
-  }
-  /**
-   * Asynchronously retrieves weapon data based on the specified category name.
-   *
+   * Retrieves category data for weapons.
    * @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.
-   *
+   * @returns {Promise<Array<Object>>} - A Promise containing data for the specified category.
+   * @throws {Error} - Throws errors encountered while fetching data.
    */
   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);
+      return await 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}`);
+      throw new Error(`Error fetching Weapon data: ${error.message}`);
     }
   }
 }
 
-// Export the WeaponModule class
 module.exports = WeaponModule;

package/lib/modules/poe.watch/allModules/watchUrlGenerator/urlGenerator.js

@@ -0,0 +1,9 @@
+/**
+ * Generates a URL based on league and type. poe.watch API is used.
+ * @param {string} league - The league for which the URL is generated.
+ * @param {string} type - The type of data for which the URL is generated.
+ * @returns {string} - The generated URL.
+ */
+module.exports = function urlGenerator(league, type) {
+  return `https://api.poe.watch/get?category=${type}&league=${league}`;
+};

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.8",
+  "version": "1.2.1",
   "description": "API management for poe.ninja and poe.watch",
   "main": "index.js",
   "scripts": {

package/lib/config/poeNinja/url.js

@@ -1,12 +0,0 @@
-/**
- * Configuration module for poe.ninja API URL.
- * @module config/poeNinja/url
- */
-
-/**
- * Base URL for the poe.ninja API.
- * @type {string}
- */
-module.exports = {
-  baseurl: "https://poe.ninja/api/data/",
-};

package/lib/config/poeWatch/url.js

@@ -1,12 +0,0 @@
-/**
- * Configuration module for poe.watch API URL.
- * @module config/poeWatch/url
- */
-
-/**
- * Base URL for the poe.watch API.
- * @type {string}
- */
-module.exports = {
-  baseurl: "https://api.poe.watch/get?category=",
-};