poe-api-manager 0.1.0 → 0.2.6

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

@@ -1,15 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Vials.
+ *
+ * @class
+ */
 class VialsModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
+  #url;
+
+  /**
+   * The type of data (Vial in this case).
+   *
+   * @private
+   * @type {string}
+   */
+  #type;
+
+  /**
+   * Creates an instance of VialsModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
-    this.url = url;
-    this.type = "Vial";
+    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.
+   */
   async getData(requestedProperties) {
-    return getData(this.url, this.type, 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}`);
+    }
   }
 }
 
-//export VialsModule;
 module.exports = VialsModule;

package/lib/modules/poe.watch/WatchWievModule.js

@@ -0,0 +1,130 @@
+const allModules = require("./allModules/Modules");
+
+/**
+ * Represents a module for fetching data related to Watchstones and Watchstone Regions.
+ *
+ * @class
+ */
+class WatchWievModule {
+  /**
+   * Creates an instance of WatchWievModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
+  constructor(leagueUrl) {
+    /**
+     * Module for fetching data related to Currency.
+     *
+     */
+    this.currency = new allModules.CurrencyModule(leagueUrl);
+
+    // Uncomment the lines below if you want to use and document other modules
+    // this.deliriumOrb = new allModules.DeliriumOrbModule(leagueUrl);
+    // this.divinationCard = new allModules.DivsModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Essences.
+     *
+     */
+    this.essence = new allModules.EssenceModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Fossils.
+     *
+     */
+    this.fossil = new allModules.FossilModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Fragments.
+     *
+     */
+    this.fragment = new allModules.FragmentModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Gems.
+     *
+     */
+    this.gem = new allModules.GemModule(leagueUrl);
+
+    // Uncomment the lines
+    // this.inscribed = new allModules.InscribedModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Invitations.
+     *
+     */
+    this.invitation = new allModules.InvitationModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Jewels.
+     *
+     */
+    this.jewel = new allModules.JewelModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Maps.
+     *
+     */
+    this.map = new allModules.MapModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Oils.
+     *
+     */
+    this.oil = new allModules.OilModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Scarabs.
+     *
+     */
+    this.scarab = new allModules.ScarabModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Sextants.
+     *
+     */
+    this.sextant = new allModules.SextantModule(leagueUrl);
+
+    // Uncomment the lines below if you want to use and document other modules
+    // this.uniqueMap = new allModules.UniqueMapsModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Accessories.
+     *
+     */
+    this.accessory = new allModules.AccessoryModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Armours.
+     *
+     */
+    this.armour = new allModules.ArmourModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Weapons.
+     *
+     */
+    this.weapon = new allModules.WeaponModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Flasks.
+     *
+     */
+    this.flask = new allModules.FlaskModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Bases.
+     *
+     */
+    this.base = new allModules.BaseModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Beasts.
+     *
+     */
+    this.beast = new allModules.BeastModule(leagueUrl);
+  }
+}
+
+// Export the WatchWievModule class
+module.exports = WatchWievModule;

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

@@ -0,0 +1,23 @@
+module.exports = {
+  CurrencyModule: require("./submodules/CurrencyModule"),
+  DeliriumOrbModule: require("./submodules/DeliriumOrbModule"),
+  DivsModule: require("./submodules/DivsModule"),
+  EssenceModule: require("./submodules/EssenceModule"),
+  FossilModule: require("./submodules/FossilModule"),
+  FragmentModule: require("./submodules/FragmentModule"),
+  GemModule: require("./submodules/GemModule"),
+  InscribedModule: require("./submodules/InscribedModule"),
+  InvitationModule: require("./submodules/InvitationModule"),
+  JewelModule: require("./submodules/JewelModule"),
+  MapModule: require("./submodules/MapModule"),
+  OilModule: require("./submodules/OilModule"),
+  ScarabModule: require("./submodules/ScarabModule"),
+  SextantModule: require("./submodules/SextantModule"),
+  UniqueMapsModule: require("./submodules/UniqueMapsModule"),
+  AccessoryModule: require("./submodules/AccessoryModule"),
+  ArmourModule: require("./submodules/ArmourModule"),
+  BaseModule: require("./submodules/BaseModule"),
+  BeastModule: require("./submodules/BeastModule"),
+  WeaponModule: require("./submodules/WeaponModule"),
+  FlaskModule: require("./submodules/FlaskModule"),
+};

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

@@ -0,0 +1,28 @@
+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) {
+      return response.data;
+    } else {
+      throw new Error("Invalid response format from POE Watch API");
+    }
+  } catch (error) {
+    /**
+     * @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}`);
+  }
+}
+
+module.exports = fetchData;

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

@@ -0,0 +1,39 @@
+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 {
+      // If no specific properties are requested, return the entire fetched data
+      return fetchedData;
+    }
+  } catch (error) {
+    /**
+     * Throws an error if there's an issue fetching or filtering the data.
+     * @throws {Error}
+     */
+    throw new Error(`Error fetching data: ${error.message}`);
+  }
+}
+
+module.exports = getData;

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

@@ -0,0 +1,59 @@
+const getData = require("../functions/getData");
+
+/**
+ * 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) {
+    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}`);
+    }
+  }
+}
+
+// Export the AccessoryModule class
+module.exports = AccessoryModule;

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

@@ -0,0 +1,59 @@
+const getData = require("../functions/getData");
+
+/**
+ * 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) {
+    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}`);
+    }
+  }
+}
+
+// Export the ArmourModule class
+module.exports = ArmourModule;

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

@@ -0,0 +1,59 @@
+const getData = require("../functions/getData");
+
+/**
+ * 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) {
+    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}`);
+    }
+  }
+}
+
+// Export the BaseModule class
+module.exports = BaseModule;

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

@@ -0,0 +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) {
+    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

@@ -0,0 +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) {
+    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}`);
+    }
+  }
+}
+
+// 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

@@ -0,0 +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) {
+    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;