poe-api-manager 1.0.0 → 1.2.2

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/VialsModule.js

@@ -1,60 +1,15 @@
-const getData = require("../functions/getData");
-
+const ItemBaseClass = require("../../ItemBaseClass");
 /**
- * Represents a module for fetching data related to Vials.
- *
- * @class
+ * Represents a module for handling vials.
+ * @extends ItemBaseClass
  */
-class VialsModule {
-  /**
-   * The URL for fetching data.
-   *
-   * @private
-   * @type {string}
-   */
-  #url;
-
-  /**
-   * The type of data (Vial in this case).
-   *
-   * @private
-   * @type {string}
-   */
-  #type;
-
+class VialsModule extends ItemBaseClass {
   /**
    * Creates an instance of VialsModule.
-   *
-   * @param {string} url - The URL to fetch data from.
-   */
-  constructor(url) {
-    this.#url = url;
-    this.#type = "Vial";
-  }
-
-  /**
-   * Asynchronously retrieves 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.
+   * @param {string} league - The league name.
    */
-  async getData(requestedProperties) {
-    try {
-      /**
-       * Calls the getData function to fetch Vial data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#url, this.#type, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the Vial data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Vial data: ${error.message}`);
-    }
+  constructor(league) {
+    super(league, "Vial");
   }
 }
 

package/lib/modules/poe.ninja/item/itemUrlGenerator/ItemUrlGenerator.js

@@ -0,0 +1,9 @@
+/**
+ * Generates a URL based on league and type. poe.ninja (currencyView) 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://poe.ninja/api/data/itemoverview?league=${league}&type=${type}`;
+};

package/lib/modules/poe.ninja/item/{itemSubmodules/functions → methods}/getData.js

@@ -1,28 +1,22 @@
-const fetchData = require("../../itemFetch/fetchItem");
-const filterProperties = require("../../../../mainfunctions/filter/propertyFilter");
+const fetchData = require("../itemFetch/fetchItem");
+const filterProperties = require("../../../mainfunctions/filter/propertyFilter");
 
 /**
  * Asynchronously fetches and filters item-related data from a specified URL.
  *
- * @param {string} url - The URL to fetch item-related data from.
+ * @param {string} league - The name of the current league.
  * @param {string} type - The type of item data to fetch.
  * @param {Array<string>} [requestedProperties] - (Optional) An array of property names to include in the filtered result.
  * @returns {Promise<Array<Object>|Object>} - A promise that resolves to the fetched or filtered item data.
  * @throws {Error} - Throws an error if there's an issue fetching or processing the data.
  */
-async function getData(url, type, requestedProperties) {
+async function getData(league, type, requestedProperties) {
   try {
     // Fetch data using the fetchData function
-    /**
-     * @type {Array<Object>|Object} fetchedData - The fetched item data.
-     */
-    const fetchedData = await fetchData(url, type);
+    const fetchedData = await fetchData(league, type);
 
     // If requestedProperties are specified, filter the data based on those properties
     if (requestedProperties) {
-      /**
-       * @type {Array<Object>|Object} result - The filtered item data based on requested properties.
-       */
       const result = filterProperties(fetchedData, requestedProperties);
       return result;
     } else {

package/lib/modules/poe.watch/allModules/WatchBaseClass.js

@@ -0,0 +1,45 @@
+const getData = require("./methods/getData");
+const urlGenerator = require("./watchUrlGenerator/urlGenerator");
+
+/**
+ * Basic class for handling data retrieval.
+ */
+class WatchBaseClass {
+  /**
+   * Private field to store the query URL.
+   * @type {string}
+   * @private
+   */
+  #queryUrl;
+
+  /**
+   * Creates a new instance of WatchBaseClass.
+   * @param {string} league - The league from which the data will be fetched.
+   * @param {string} type - The type of data to be fetched.
+   */
+  constructor(league, type) {
+    /**
+     * Function that generates the query URL.
+     * @type {Function}
+     * @private
+     */
+    this.#queryUrl = urlGenerator(league, type);
+  }
+
+  /**
+   * Executes queries to fetch data.
+   * @async
+   * @param {Array<string>} requestedProperties - List of properties to be fetched.
+   * @returns {Promise<Array<Object>>} - A Promise containing an object with the requested properties.
+   * @throws {Error} - Throws errors encountered while fetching data.
+   */
+  async getData(requestedProperties) {
+    try {
+      return await getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      throw new Error(`Error fetching WatchView data: ${error.message}`);
+    }
+  }
+}
+
+module.exports = WatchBaseClass;

package/lib/modules/poe.watch/allModules/fetch/fetch.js

@@ -1,5 +1,4 @@
 const axios = require("axios");
-const baseUrl = require("../../../../config/poeWatch/url").baseurl;
 /**
  * Fetches data from the POE Watch API based on the provided query URL.
  * @param {string} queryUrl - The query URL to be appended to the base URL.
@@ -8,9 +7,7 @@ const baseUrl = require("../../../../config/poeWatch/url").baseurl;
  */
 async function fetchData(queryUrl) {
   try {
-    const url = `${baseUrl}${queryUrl}`;
-
-    const response = await axios.get(url);
+    const response = await axios.get(queryUrl);
 
     if (response.data) {
       return response.data;

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

@@ -1,89 +1,46 @@
-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 Accessories.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing accessory data.
  */
-class AccessoryModule {
+class AccessoryModule extends WatchBaseClass {
   /**
-   * The query URL for fetching accessory data.
-   *
-   * @private
+   * The query URL for accessing accessory data.
    * @type {string}
+   * @private
    */
   #queryUrl;
-
   /**
-   * Creates an instance of AccessoryModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of AccessoryModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching accessory data.
-     *
-     * @private
+     * The type of data being accessed (accessory).
      * @type {string}
      */
-    this.#queryUrl = `accessory${leagueUrl}`;
+    const type = "accessory";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 
   /**
-   * Asynchronously retrieves accessory 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 accessory data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the accessory data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching accessory data: ${error.message}`);
-    }
-  }
-  /**
-   * Asynchronously retrieves accessory data based on the specified category name.
-   *
+   * Retrieves category data for accessories.
    * @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.
-   *
+   * @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 accessory 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 accessory data for the specified category.
-       *
-       * @throws {Error}
-       */
-      throw new Error(
-        `Error fetching data Accessory Category: ${error.message}`
-      );
+      throw new Error(`Error fetching Accessory data: ${error.message}`);
     }
   }
 }
 
-// Export the AccessoryModule class
 module.exports = AccessoryModule;

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

@@ -1,87 +1,46 @@
-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 Armour.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing armour data.
  */
-class ArmourModule {
+class ArmourModule extends WatchBaseClass {
   /**
-   * The query URL for fetching armour data.
-   *
-   * @private
+   * The query URL for armour data.
    * @type {string}
+   * @private
    */
   #queryUrl;
-
   /**
-   * Creates an instance of ArmourModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of ArmourModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching armour data.
-     *
-     * @private
+     * The type of data being accessed (armour).
      * @type {string}
      */
-    this.#queryUrl = `armour${leagueUrl}`;
+    const type = "armour";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 
   /**
-   * Asynchronously retrieves armour 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 armour data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the armour data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching armour data: ${error.message}`);
-    }
-  }
-  /**
-   * Asynchronously retrieves armour data based on the specified category name.
-   *
+   * Retrieves category data for armour.
    * @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.
-   *
+   * @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 armour 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 armour data for the specified category.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching data Armour Category: ${error.message}`);
+      throw new Error(`Error fetching Armour data: ${error.message}`);
     }
   }
 }
 
-// Export the ArmourModule class
 module.exports = ArmourModule;

package/lib/modules/poe.watch/allModules/submodules/BaseModule.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 Bases.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing base data.
  */
-class BaseModule {
+class BaseModule extends WatchBaseClass {
   /**
-   * The query URL for fetching base data.
-   *
-   * @private
+   * The query URL for base data.
    * @type {string}
+   * @private
    */
   #queryUrl;
 
   /**
-   * Creates an instance of BaseModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of BaseModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching base data.
-     *
-     * @private
+     * The type of data being accessed (bases).
      * @type {string}
      */
-    this.#queryUrl = `bases${leagueUrl}`;
+    const type = "bases";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 
   /**
-   * Asynchronously retrieves base 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 base data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the base data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching base data: ${error.message}`);
-    }
-  }
-  /**
-   * Asynchronously retrieves base data based on the specified category name.
-   *
+   * Retrieves category data for bases.
    * @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.
-   *
+   * @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 base 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 base data for the specified category.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching data Base Category: ${error.message}`);
+      throw new Error(`Error fetching Base data: ${error.message}`);
     }
   }
 }
 
-// Export the BaseModule class
 module.exports = BaseModule;

package/lib/modules/poe.watch/allModules/submodules/BeastModule.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 Beasts.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing beast data.
  */
-class BeastModule {
+class BeastModule extends WatchBaseClass {
   /**
-   * The query URL for fetching beast data.
-   *
-   * @private
+   * The query URL for beast data.
    * @type {string}
+   * @private
    */
   #queryUrl;
 
   /**
-   * Creates an instance of BeastModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of BeastModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching beast data.
-     *
-     * @private
+     * The type of data being accessed (beast).
      * @type {string}
      */
-    this.#queryUrl = `beast${leagueUrl}`;
-  }
-
-  /**
-   * Asynchronously retrieves beast 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 beast data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the beast data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching beast data: ${error.message}`);
-    }
+    const type = "beast";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 }
 
-// Export the BeastModule class
 module.exports = BeastModule;

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

@@ -1,60 +1,30 @@
-const getData = require("../functions/getData");
+const WatchBaseClass = require("../WatchBaseClass");
+const urlGenerator = require("../watchUrlGenerator/urlGenerator");
 
 /**
- * Represents a module for fetching data related to Currency.
- *
- * @class
+ * Subclass of WatchBaseClass for accessing currency data.
  */
-class CurrencyModule {
+class CurrencyModule extends WatchBaseClass {
   /**
-   * The query URL for fetching currency data.
-   *
-   * @private
+   * The query URL for currency data.
    * @type {string}
+   * @private
    */
   #queryUrl;
 
   /**
-   * Creates an instance of CurrencyModule.
-   *
-   * @param {string} leagueUrl - The league URL to fetch data from.
+   * Creates a new instance of CurrencyModule.
+   * @param {string} league - The league from which the data will be fetched.
    */
-  constructor(leagueUrl) {
+  constructor(league) {
     /**
-     * The constructed query URL for fetching currency data.
-     *
-     * @private
+     * The type of data being accessed (currency).
      * @type {string}
      */
-    this.#queryUrl = `currency${leagueUrl}`;
-  }
-
-  /**
-   * Asynchronously retrieves currency 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 currency data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#queryUrl, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the currency data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching currency data: ${error.message}`);
-    }
+    const type = "currency";
+    super(league, type);
+    this.#queryUrl = urlGenerator(league, type);
   }
 }
 
-// Uncomment the line below if you want to export the CurrencyModule class
-// module.exports = CurrencyModule;
 module.exports = CurrencyModule;