poe-api-manager 0.2.2 → 0.2.8

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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