poe-api-manager 0.2.2 → 0.2.8

package/lib/modules/poe.ninja/item/ItemWievModule.js

@@ -1,44 +1,177 @@
 const itemSubmodules = require("./itemSubmodules/itemSubModules");
 const baseurl = require("../../../config/poeNinja/url");
 
-//itemwiev module
+/**
+ * Represents a module for viewing item-related information in a specific Path of Exile league.
+ * @class
+ */
 class ItemWievModule {
   #league;
   #baseurl;
+
+  /**
+   * Creates a new instance of ItemWievModule.
+   * @constructor
+   * @param {string} league - The Path of Exile league for which the item information is retrieved.
+   */
   constructor(league) {
+    /**
+     * The Path of Exile league for which the item information is retrieved.
+     * @private
+     * @type {string}
+     */
     this.#league = league;
+
+    /**
+     * The base URL for the Path of Exile Ninja API.
+     * @private
+     * @type {string}
+     */
     this.#baseurl = baseurl.baseurl;
+
+    /**
+     * The complete URL for retrieving item information for the specified league.
+     * @private
+     * @type {string}
+     */
     const url = `${this.#baseurl}itemoverview?league=${this.#league}&type=`;
 
+    /**
+     * Represents a submodule for base type item information.
+     */
     this.baseType = new itemSubmodules.BaseTypeModule(url);
+
+    /**
+     * Represents a submodule for beast item information.
+     */
     this.beast = new itemSubmodules.BeastModule(url);
+
+    /**
+     * Represents a submodule for delirium orbs item information.
+     */
     this.deliriumOrbs = new itemSubmodules.DeliriumOrbsModule(url);
+
+    /**
+     * Represents a submodule for divination card item information.
+     */
     this.divinationCard = new itemSubmodules.DivinationCardModule(url);
+
+    /**
+     * Represents a submodule for essence item information.
+     */
     this.essence = new itemSubmodules.EssenceModule(url);
+
+    /**
+     * Represents a submodule for fossil item information.
+     */
     this.fossil = new itemSubmodules.FossilModule(url);
+
+    /**
+     * Represents a submodule for helmet enchant item information.
+     */
     this.helmetEnchant = new itemSubmodules.HelmetEnchantModule(url);
+
+    /**
+     * Represents a submodule for incubator item information.
+     */
     this.incubator = new itemSubmodules.IncubatorModule(url);
+
+    /**
+     * Represents a submodule for map item information.
+     */
     this.map = new itemSubmodules.MapModule(url);
+
+    /**
+     * Represents a submodule for oil item information.
+     */
     this.oil = new itemSubmodules.OilModule(url);
+
+    /**
+     * Represents a submodule for resonator item information.
+     */
     this.resonator = new itemSubmodules.ResonatorModule(url);
+
+    /**
+     * Represents a submodule for scarab item information.
+     */
     this.scarab = new itemSubmodules.ScarabModule(url);
+
+    /**
+     * Represents a submodule for skill gem item information.
+     */
     this.skillGem = new itemSubmodules.SkillGemModule(url);
+
+    /**
+     * Represents a submodule for unique accessory item information.
+     */
     this.uniqueAccessory = new itemSubmodules.UniqueAccessoryModule(url);
+
+    /**
+     * Represents a submodule for unique armour item information.
+     */
     this.uniqueArmour = new itemSubmodules.UniqueArmourModule(url);
+
+    /**
+     * Represents a submodule for unique flask item information.
+     */
     this.uniqueFlask = new itemSubmodules.UniqueFlaskModule(url);
+
+    /**
+     * Represents a submodule for unique jewel item information.
+     */
     this.uniqueJewel = new itemSubmodules.UniqueJewelModule(url);
+
+    /**
+     * Represents a submodule for unique map item information.
+     */
     this.uniqueMap = new itemSubmodules.UniqueMapModule(url);
+
+    /**
+     * Represents a submodule for unique weapon item information.
+     */
     this.uniqueWeapon = new itemSubmodules.UniqueWeaponModule(url);
+
+    /**
+     * Represents a submodule for vials item information.
+     */
     this.vials = new itemSubmodules.VialsModule(url);
+
+    /**
+     * Represents a submodule for omen item information.
+     */
     this.omen = new itemSubmodules.OmenModule(url);
+
+    /**
+     * Represents a submodule for memory item information.
+     */
     this.memory = new itemSubmodules.MemoryModule(url);
+
+    /**
+     * Represents a submodule for invitation item information.
+     */
     this.invitation = new itemSubmodules.InvitationModule(url);
+
+    /**
+     * Represents a submodule for unique relics item information.
+     */
     this.uniqueRelics = new itemSubmodules.UniqueRelicsModule(url);
+
+    /**
+     * Represents a submodule for cluster jewel item information.
+     */
     this.clusterJewel = new itemSubmodules.ClusterJewelModule(url);
+
+    /**
+     * Represents a submodule for blighted map item information.
+     */
     this.blightedMap = new itemSubmodules.BlightedMapModule(url);
+
+    /**
+     * Represents a submodule for blight ravaged map item information.
+     */
     this.blightRavagedMap = new itemSubmodules.BlightRavagedMapModule(url);
   }
 }
 
-//export ItemWievModule;
+// Export the ItemWievModule class.
 module.exports = ItemWievModule;

package/lib/modules/poe.ninja/item/itemFetch/fetchItem.js

@@ -1,20 +1,41 @@
 const axios = require("axios");
 
-// items for a specific fetch function
+/**
+ * Asynchronously fetches data from a specified URL for item-related information.
+ *
+ * @param {string} baseurl - The base URL for the data fetch operation.
+ * @param {string} type - The specific type of item data to fetch.
+ * @returns {Promise<Array<Object>>} - A promise that resolves to the fetched item data.
+ * @throws {Error} - Throws an error if there's an issue fetching or processing the data.
+ */
 async function fetchData(baseurl, type) {
   try {
+    /**
+     * @type {string} url - The complete URL for fetching item-related data.
+     */
     const url = `${baseurl}${type}`;
+
+    /**
+     * @type {Object} response - The response object from the data fetch operation.
+     */
     const response = await axios.get(url);
 
     if (response.data && response.data.lines) {
+      /**
+       * @type {Array<Object>} lines - The array of objects containing item-related data.
+       */
       return response.data.lines;
     } else {
       throw new Error("Invalid response format from POE Ninja API Itemwiev");
     }
   } catch (error) {
+    /**
+     * Throws an error if there's an issue fetching or processing the item-related data.
+     * @throws {Error}
+     */
     throw new Error(`Error fetching data: ${error.message}`);
   }
 }
 
-// export fetchData;
+// Export the fetchData function.
 module.exports = fetchData;

package/lib/modules/poe.ninja/item/itemSubmodules/functions/getData.js

@@ -1,13 +1,28 @@
 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} 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) {
   try {
     // Fetch data using the fetchData function
+    /**
+     * @type {Array<Object>|Object} fetchedData - The fetched item data.
+     */
     const fetchedData = await fetchData(url, 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 {
@@ -15,6 +30,10 @@ async function getData(url, type, requestedProperties) {
       return fetchedData;
     }
   } catch (error) {
+    /**
+     * Throws an error if there's an issue fetching or processing the item data.
+     * @throws {Error}
+     */
     throw new Error(`Error fetching data: ${error.message}`);
   }
 }

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

@@ -1,17 +1,56 @@
 const getData = require("../functions/getData");
 
+/**
+ * Module for retrieving base type item information.
+ * @class
+ */
 class BaseTypeModule {
   #url;
   #type;
+  /**
+   * Creates a new instance of BaseTypeModule.
+   * @constructor
+   * @param {string} url - The URL for fetching base type item information.
+   */
   constructor(url) {
+    /**
+     * @type {string} #url - The URL for fetching base type item information.
+     * @private
+     */
     this.#url = url;
+
+    /**
+     * @type {string} #type - The type of item data (BaseType).
+     * @private
+     */
     this.#type = "BaseType";
   }
 
+  /**
+   * Asynchronously retrieves base type item information.
+   *
+   * @async
+   * @method
+   * @param {Array<string>} requestedProperties - An array of property names to include in the result.
+   * @returns {Promise<Array<Object>>} A promise that resolves to the fetched item data.
+   * @throws {Error} Throws an error if there's an issue with the data fetching process.
+   *
+   */
   async getData(requestedProperties) {
-    return getData(this.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch Base Type 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 Base Type data.
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Base Type data: ${error.message}`);
+    }
   }
 }
 
-//export BaseTypeModule;
 module.exports = BaseTypeModule;

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

@@ -1,17 +1,56 @@
 const getData = require("../functions/getData");
 
+/**
+ * Module for retrieving information about beasts.
+ * @class
+ */
 class BeastModule {
   #url;
   #type;
+  /**
+   * Creates a new instance of BeastModule.
+   * @constructor
+   * @param {string} url - The URL for fetching beast information.
+   */
   constructor(url) {
+    /**
+     * @type {string} #url - The URL for fetching beast information.
+     * @private
+     */
     this.#url = url;
+
+    /**
+     * @type {string} #type - The type of data (Beast).
+     * @private
+     */
     this.#type = "Beast";
   }
 
+  /**
+   * Asynchronously retrieves beast information.
+   *
+   * @async
+   * @method
+   * @param {Array<string>} requestedProperties - An array of property names to include in the result.
+   * @returns {Promise<Array<Object>>} A promise that resolves to the fetched beast data.
+   * @throws {Error} Throws an error if there's an issue with the data fetching process.
+   *
+   */
   async getData(requestedProperties) {
-    return getData(this.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch Beast 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 Beast data.
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Beast data: ${error.message}`);
+    }
   }
 }
 
-//export BeastModule;
 module.exports = BeastModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Blight Ravaged Maps.
+ *
+ * @class
+ */
 class BlightRavagedMapModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (BlightRavagedMap in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of BlightRavagedMapModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "BlightRavagedMap";
   }
 
+  /**
+   * 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 BlightRavagedMap 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 BlightRavagedMap data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching BlightRavagedMap data: ${error.message}`);
+    }
   }
 }
 
-//export BlightRavagedMapModule;
 module.exports = BlightRavagedMapModule;

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

@@ -1,17 +1,58 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Blighted Maps.
+ *
+ * @class
+ */
 class BlightedMapModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (BlightedMap in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+  /**
+   * Creates an instance of BlightedMapModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "BlightedMap";
   }
 
+  /**
+   * 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 BlightedMap 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 BlightedMap data.
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching BlightedMap data: ${error.message}`);
+    }
   }
 }
 
-//export BlightedMapModule;
 module.exports = BlightedMapModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Cluster Jewels.
+ *
+ * @class
+ */
 class ClusterJewelModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (ClusterJewel in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of ClusterJewelModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "ClusterJewel";
   }
 
+  /**
+   * 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 ClusterJewel 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 ClusterJewel data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching ClusterJewel data: ${error.message}`);
+    }
   }
 }
 
-//export ClusterJewelModule;
 module.exports = ClusterJewelModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Delirium Orbs.
+ *
+ * @class
+ */
 class DeliriumOrbsModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (DeliriumOrb in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of DeliriumOrbsModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "DeliriumOrb";
   }
 
+  /**
+   * 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 DeliriumOrb 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 DeliriumOrb data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching DeliriumOrb data: ${error.message}`);
+    }
   }
 }
 
-//export DeliriumOrbsModule;
 module.exports = DeliriumOrbsModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Divination Cards.
+ *
+ * @class
+ */
 class DivinationCardModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (DivinationCard in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of DivinationCardModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "DivinationCard";
   }
 
+  /**
+   * 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 DivinationCard 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 DivinationCard data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching DivinationCard data: ${error.message}`);
+    }
   }
 }
 
-//export DivinationCardModule;
 module.exports = DivinationCardModule;