poe-api-manager 0.2.2 → 0.2.8

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

@@ -1,9 +1,15 @@
 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.
+ * @returns {Promise<Object>} - A Promise that resolves to the fetched data.
+ * @throws {Error} - Throws an error if there is an issue with the API response or fetching data.
+ */
 async function fetchData(queryUrl) {
   try {
     const url = `${baseUrl}${queryUrl}`;
+
     const response = await axios.get(url);
 
     if (response.data) {
@@ -12,7 +18,10 @@ async function fetchData(queryUrl) {
       throw new Error("Invalid response format from POE Watch API");
     }
   } catch (error) {
-    throw new Error(`Error fetching data: ${error.message}`);
+    /**
+     * @throws {Error} - Throws an error with a specific message if there is an issue with fetching data.
+     */
+    throw new Error(`Error fetching data from poe.watch: ${error.message}`);
   }
 }
 

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/functions/getData.js

@@ -1,11 +1,26 @@
 const fetchData = require("../fetch/fetch");
 const filterProperties = require("../../../mainfunctions/filter/propertyFilter");
 
+/**
+ * Retrieves data from the specified URL, optionally filtering based on requested properties.
+ *
+ * @param {string} queryUrl - The URL to fetch data from.
+ * @param {Array<string>} [requestedProperties] - An optional array of property names to filter the data.
+ * @returns {Promise<Array<Object>|Object>} - A promise that resolves to the fetched or filtered data.
+ * @throws {Error} - Throws an error if there is an issue fetching or filtering the data.
+ */
 async function getData(queryUrl, requestedProperties) {
   try {
+    /**
+     * @type {Array<Object>|Object} fetchedData - The fetched data.
+     */
     const fetchedData = await fetchData(queryUrl);
+
     // If requestedProperties are specified, filter the data based on those properties
     if (requestedProperties) {
+      /**
+       * @type {Array<Object>|Object} result - The filtered data based on requested properties.
+       */
       const result = filterProperties(fetchedData, requestedProperties);
       return result;
     } else {
@@ -13,7 +28,11 @@ async function getData(queryUrl, requestedProperties) {
       return fetchedData;
     }
   } catch (error) {
-    throw new Error(`Error fetching data poe.watch: ${error.message}`);
+    /**
+     * Throws an error if there's an issue fetching or filtering the data.
+     * @throws {Error}
+     */
+    throw new Error(`Error fetching data: ${error.message}`);
   }
 }
 

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

@@ -1,13 +1,89 @@
 const getData = require("../functions/getData");
+const getCategory = require("../functions/getCategory");
 
+/**
+ * Represents a module for fetching data related to Accessories.
+ *
+ * @class
+ */
 class AccessoryModule {
+  /**
+   * The query URL for fetching accessory data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of AccessoryModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching accessory data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `accessory${leagueUrl}`;
   }
+
+  /**
+   * 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) {
-    return getData(this.#queryUrl, 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.
+   *
+   * @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
 module.exports = AccessoryModule;

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

@@ -1,13 +1,87 @@
 const getData = require("../functions/getData");
+const getCategory = require("../functions/getCategory");
 
+/**
+ * Represents a module for fetching data related to Armour.
+ *
+ * @class
+ */
 class ArmourModule {
+  /**
+   * The query URL for fetching armour data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of ArmourModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching armour data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `armour${leagueUrl}`;
   }
+
+  /**
+   * 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) {
-    return getData(this.#queryUrl, 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.
+   *
+   * @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
 module.exports = ArmourModule;

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

@@ -1,13 +1,87 @@
 const getData = require("../functions/getData");
+const getCategory = require("../functions/getCategory");
 
+/**
+ * Represents a module for fetching data related to Bases.
+ *
+ * @class
+ */
 class BaseModule {
+  /**
+   * The query URL for fetching base data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of BaseModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching base data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `bases${leagueUrl}`;
   }
+
+  /**
+   * 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) {
-    return getData(this.#queryUrl, 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.
+   *
+   * @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
 module.exports = BaseModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Beasts.
+ *
+ * @class
+ */
 class BeastModule {
+  /**
+   * The query URL for fetching beast data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of BeastModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching beast data.
+     *
+     * @private
+     * @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) {
-    return getData(this.#queryUrl, 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}`);
+    }
   }
 }
 
+// Export the BeastModule class
 module.exports = BeastModule;

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

@@ -1,13 +1,60 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Currency.
+ *
+ * @class
+ */
 class CurrencyModule {
+  /**
+   * The query URL for fetching currency data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of CurrencyModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching currency data.
+     *
+     * @private
+     * @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) {
-    return getData(this.#queryUrl, 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}`);
+    }
   }
 }
-// export CurrencyModule;
+
+// Uncomment the line below if you want to export the CurrencyModule class
+// module.exports = CurrencyModule;
 module.exports = CurrencyModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Delirium Orbs.
+ *
+ * @class
+ */
 class DeliriumOrbModule {
+  /**
+   * The query URL for fetching Delirium Orb data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of DeliriumOrbModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Delirium Orb data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `currency${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Delirium Orb 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) {
-    return getData(this.#queryUrl, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch Delirium Orb data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Delirium Orb data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Delirium Orb data: ${error.message}`);
+    }
   }
 }
 
+// Export the DeliriumOrbModule class
 module.exports = DeliriumOrbModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Divination Cards.
+ *
+ * @class
+ */
 class DivsModule {
+  /**
+   * The query URL for fetching Divination Card data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of DivsModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Divination Card data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `currency${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Divination Card 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) {
-    return getData(this.#queryUrl, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch Divination Card data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Divination Card data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Divination Card data: ${error.message}`);
+    }
   }
 }
 
+// Export the DivsModule class
 module.exports = DivsModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Essences.
+ *
+ * @class
+ */
 class EssenceModule {
+  /**
+   * The query URL for fetching Essence data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of EssenceModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Essence data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `essence${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Essence 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) {
-    return getData(this.#queryUrl, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch Essence data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Essence data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Essence data: ${error.message}`);
+    }
   }
 }
 
+// Export the EssenceModule class
 module.exports = EssenceModule;