poe-api-manager 0.2.2 → 0.2.6

package/Changelog.md

@@ -1,4 +1,8 @@
 # Changelog
+## 0.2.6
+JSDocs have been added for easy understanding.
+
+
 ## 0.2.2
 poe.watch API add
 

package/lib/NinjaAPI.js

@@ -1,11 +1,33 @@
-const ItemWievModule = require("./modules/poe.ninja/item/ItemWievModule");
-const CurrencyWievModule = require("./modules/poe.ninja/currency/CurrencyWievModule");
+const ItemViewModule = require("./modules/poe.ninja/item/ItemWievModule");
+const CurrencyViewModule = require("./modules/poe.ninja/currency/CurrencyWievModule");
 
+/**
+ * Represents an API for interacting with the poe.ninja API.
+ *
+ * @class
+ */
 class NinjaAPI {
+  /**
+   * Creates an instance of NinjaAPI.
+   *
+   * @param {string} league - The PoE league for which data is requested.
+   */
   constructor(league) {
-    this.currencyWiev = new CurrencyWievModule(league);
-    this.itemWiev = new ItemWievModule(league);
+    /**
+     * The CurrencyViewModule instance for fetching currency-related data.
+     *
+     * @type {CurrencyViewModule}
+     */
+    this.currencyView = new CurrencyViewModule(league);
+
+    /**
+     * The ItemViewModule instance for fetching item-related data.
+     *
+     * @type {ItemViewModule}
+     */
+    this.itemView = new ItemViewModule(league);
   }
 }
+
 // Export the NinjaAPI class
 module.exports = NinjaAPI;

package/lib/WatchAPI.js

@@ -1,12 +1,56 @@
 const WatchWievModule = require("./modules/poe.watch/WatchWievModule");
 
+/**
+ * Represents an API for interacting with a poe.watch service.
+ *
+ * @class
+ */
 class WatchAPI {
+  /**
+   * The league for which the API is initialized.
+   *
+   * @private
+   * @type {string}
+   */
   #league;
+
+  /**
+   * The URL parameter for the league in the Path of Exile.
+   *
+   * @private
+   * @type {string}
+   */
   #leagueUrl;
+
+  /**
+   * Creates an instance of WatchAPI.
+   *
+   * @param {string} league - The league for which the API should be initialized.
+   */
   constructor(league) {
+    /**
+     * The league for which the API is initialized.
+     *
+     * @private
+     * @type {string}
+     */
     this.#league = league;
+
+    /**
+     * The URL parameter for the league in the Path of Exile watch service.
+     *
+     * @private
+     * @type {string}
+     */
     this.#leagueUrl = `&league=${this.#league}`;
+
+    /**
+     * The WatchWievModule instance associated with this API.
+     *
+     * @type {WatchWievModule}
+     */
     this.wiev = new WatchWievModule(this.#leagueUrl);
   }
 }
+
 module.exports = WatchAPI;

package/lib/config/poeNinja/url.js

@@ -1,3 +1,12 @@
+/**
+ * Configuration module for poe.ninja API URL.
+ * @module config/poeNinja/url
+ */
+
+/**
+ * Base URL for the poe.ninja API.
+ * @type {string}
+ */
 module.exports = {
   baseurl: "https://poe.ninja/api/data/",
 };

package/lib/config/poeWatch/url.js

@@ -1,3 +1,12 @@
+/**
+ * Configuration module for poe.watch API URL.
+ * @module config/poeWatch/url
+ */
+
+/**
+ * Base URL for the poe.watch API.
+ * @type {string}
+ */
 module.exports = {
   baseurl: "https://api.poe.watch/get?category=",
 };

package/lib/modules/mainfunctions/filter/propertyFilter.js

@@ -1,12 +1,30 @@
+/**
+ * Filters properties of objects in an array based on the specified properties.
+ *
+ * @param {Array<Object>} data - The array of objects to filter.
+ * @param {Array<string>} requestedProperties - The array of property names to include in the result.
+ * @returns {Array<Object>} - An array of objects with only the specified properties.
+ */
 module.exports = function filterProperties(data, requestedProperties) {
+  /**
+   * @type {Array<Object>} result - The filtered array of objects.
+   */
   const result = [];
 
   data.forEach((item) => {
+    /**
+     * @type {Object} itemResult - The filtered object with requested properties.
+     */
     const itemResult = {};
+
     requestedProperties.forEach((prop) => {
       if (item.hasOwnProperty(prop)) {
         itemResult[prop] = item[prop];
       } else {
+        /**
+         * Warn if the requested property is not found in the object.
+         * @type {string}
+         */
         console.warn(`Property not found: ${prop}`);
       }
     });

package/lib/modules/poe.ninja/currency/CurrencyWievModule.js

@@ -1,19 +1,56 @@
 const currencySubmodules = require("./currencySubmodules/CurrencySubModules");
 const baseurl = require("../../../config/poeNinja/url");
 
-//currencywiev module
+/**
+ * Represents a module for fetching currency overview data.
+ *
+ * @class
+ */
 class CurrencyWievModule {
   #league;
   #baseurl;
+  /**
+   * Creates a new CurrencyWievModule instance.
+   *
+   * @constructor
+   * @param {string} league - The name of the Path of Exile league.
+   */
   constructor(league) {
+    /**
+     * The league for which the currency overview data is fetched.
+     *
+     * @private
+     * @type {string}
+     */
     this.#league = league;
+
+    /**
+     * The base URL for fetching currency overview data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#baseurl = baseurl.baseurl;
+
+    /**
+     * The URL for currency overview data specific to the league.
+     *
+     * @private
+     * @type {string}
+     */
     const url = `${this.#baseurl}currencyoverview?league=${this.#league}&type=`;
 
+    /**
+     * Represents a module for fetching currency data.
+     */
     this.currency = new currencySubmodules.CurrencyModule(url);
+
+    /**
+     * Represents a module for fetching fragment data.
+     */
     this.fragment = new currencySubmodules.FragmentModule(url);
   }
 }
 
-//export CurrencyWievModule;
+// Export the CurrencyWievModule class
 module.exports = CurrencyWievModule;

package/lib/modules/poe.ninja/currency/currencyFetch/fetchCurrency.js

@@ -1,7 +1,14 @@
 const axios = require("axios");
 const mergeData = require("./merge/mergeData");
 
-// items for a specific fetch function
+/**
+ * Fetches data from a specified API endpoint, merges relevant data, and returns the result.
+ *
+ * @param {string} baseurl - The base URL of the API.
+ * @param {string} type - The type of data to fetch. (e.g. "Currency", "Fragment")
+ * @returns {Promise<Array<Object>>} - A promise that resolves to an array of merged objects containing both line and currency details.
+ * @throws {Error} - Throws an error if there's an issue with the API response or data fetching process.
+ */
 async function fetchData(baseurl, type) {
   try {
     const url = `${baseurl}${type}`;
@@ -10,11 +17,13 @@ async function fetchData(baseurl, type) {
     if (response.data && response.data.lines && response.data.currencyDetails) {
       const lines = response.data.lines;
       const currencyDetails = response.data.currencyDetails;
+
+      // Merge data using the mergeData function
       const mergedData = mergeData(lines, currencyDetails);
       return mergedData;
     } else {
       throw new Error(
-        "Invalid response format from POE Ninja API Currencywiev"
+        "Invalid response format from POE Ninja API Currencyview"
       );
     }
   } catch (error) {
@@ -22,5 +31,4 @@ async function fetchData(baseurl, type) {
   }
 }
 
-// export fetchData;
 module.exports = fetchData;

package/lib/modules/poe.ninja/currency/currencyFetch/merge/mergeData.js

@@ -1,3 +1,10 @@
+/**
+ * Merges the provided lines with the corresponding currency details.
+ *
+ * @param {Array} lines - The lines to be merged.
+ * @param {Array} currencyDetails - The currency details to be merged with the lines.
+ * @returns {Array} - The merged data.
+ */
 function mergeData(lines, currencyDetails) {
   const mergedData = [];
 

package/lib/modules/poe.ninja/currency/currencySubmodules/functions/getData.js

@@ -1,6 +1,19 @@
 const fetchData = require("../../currencyFetch/fetchCurrency");
 const filterProperties = require("../../../../mainfunctions/filter/propertyFilter");
 
+/**
+ * Retrieves data from a specified API endpoint, optionally filters the data based on requested properties, and returns the result.
+ *
+ * @param {string} url - The URL of the API endpoint.
+ * @param {string} type - The type of data to fetch.
+ * @param {Array<string>} [requestedProperties] - An optional array of property names to filter the fetched data.
+ * @returns {Promise<Array<Object>>} - A promise that resolves to an array of objects containing the fetched and possibly filtered data.
+ * @throws {Error} - Throws an error if there's an issue with the data fetching process or filtering process.
+ *
+ * @async
+ * @function
+ *
+ */
 async function getData(url, type, requestedProperties) {
   try {
     // Fetch data using the fetchData function
@@ -8,6 +21,11 @@ async function getData(url, type, requestedProperties) {
 
     // If requestedProperties are specified, filter the data based on those properties
     if (requestedProperties) {
+      /**
+       * Filter the fetched data based on the specified properties.
+       *
+       * @type {Array<Object>}
+       */
       const result = filterProperties(fetchedData, requestedProperties);
       return result;
     } else {
@@ -15,6 +33,11 @@ async function getData(url, type, requestedProperties) {
       return fetchedData;
     }
   } catch (error) {
+    /**
+     * An error indicating an issue with the data fetching or filtering process.
+     *
+     * @throws {Error} - Throws an error with a descriptive message.
+     */
     throw new Error(`Error fetching data: ${error.message}`);
   }
 }

package/lib/modules/poe.ninja/currency/currencySubmodules/subModules/CurrencyModule.js

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

package/lib/modules/poe.ninja/currency/currencySubmodules/subModules/FragmentModule.js

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

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;