poe-api-manager 1.0.0 → 1.2.2

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

@@ -0,0 +1,40 @@
+const getData = require("./methods/getData");
+
+class ItemBaseClass {
+  /**
+   * @type {string} The type of item to retrieve data for.
+   * @private
+   */
+  #type;
+
+  /**
+   * @type {string} The name of the current league.
+   * @private
+   */
+  #league;
+  /**
+   * Constructs an instance of ItemBaseClass.
+   * @param {string} league - The name of the league to retrieve data for.
+   * @param {string} typeName - The type of item to retrieve data for.
+   */
+  constructor(league, typeName) {
+    this.#type = typeName;
+    this.#league = league;
+  }
+
+  /**
+   * Retrieves item data based on requested properties.
+   * @param {string[]} requestedProperties - An array of properties to retrieve for each item.
+   * @returns {Promise<Array<Object>>} A promise that resolves with the requested item data.
+   * @throws {Error} If there is an error fetching the data.
+   */
+  async getData(requestedProperties) {
+    try {
+      return await getData(this.#league, this.#type, requestedProperties);
+    } catch (error) {
+      throw new Error(`Error fetching ItemOverView data: ${error.message}`);
+    }
+  }
+}
+
+module.exports = ItemBaseClass;

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

@@ -1,175 +1,150 @@
 const itemSubmodules = require("./itemSubmodules/itemSubModules");
-const baseurl = require("../../../config/poeNinja/url");
 
 /**
  * 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);
+    this.baseType = new itemSubmodules.BaseTypeModule(league);
 
     /**
      * Represents a submodule for beast item information.
      */
-    this.beast = new itemSubmodules.BeastModule(url);
+    this.beast = new itemSubmodules.BeastModule(league);
 
     /**
      * Represents a submodule for delirium orbs item information.
      */
-    this.deliriumOrbs = new itemSubmodules.DeliriumOrbsModule(url);
+    this.deliriumOrbs = new itemSubmodules.DeliriumOrbsModule(league);
 
     /**
      * Represents a submodule for divination card item information.
      */
-    this.divinationCard = new itemSubmodules.DivinationCardModule(url);
+    this.divinationCard = new itemSubmodules.DivinationCardModule(league);
 
     /**
      * Represents a submodule for essence item information.
      */
-    this.essence = new itemSubmodules.EssenceModule(url);
+    this.essence = new itemSubmodules.EssenceModule(league);
 
     /**
      * Represents a submodule for fossil item information.
      */
-    this.fossil = new itemSubmodules.FossilModule(url);
+    this.fossil = new itemSubmodules.FossilModule(league);
 
     /**
      * Represents a submodule for helmet enchant item information.
      */
-    this.helmetEnchant = new itemSubmodules.HelmetEnchantModule(url);
+    this.helmetEnchant = new itemSubmodules.HelmetEnchantModule(league);
 
     /**
      * Represents a submodule for incubator item information.
      */
-    this.incubator = new itemSubmodules.IncubatorModule(url);
+    this.incubator = new itemSubmodules.IncubatorModule(league);
 
     /**
      * Represents a submodule for map item information.
      */
-    this.map = new itemSubmodules.MapModule(url);
+    this.map = new itemSubmodules.MapModule(league);
 
     /**
      * Represents a submodule for oil item information.
      */
-    this.oil = new itemSubmodules.OilModule(url);
+    this.oil = new itemSubmodules.OilModule(league);
 
     /**
      * Represents a submodule for resonator item information.
      */
-    this.resonator = new itemSubmodules.ResonatorModule(url);
+    this.resonator = new itemSubmodules.ResonatorModule(league);
 
     /**
      * Represents a submodule for scarab item information.
      */
-    this.scarab = new itemSubmodules.ScarabModule(url);
+    this.scarab = new itemSubmodules.ScarabModule(league);
 
     /**
      * Represents a submodule for skill gem item information.
      */
-    this.skillGem = new itemSubmodules.SkillGemModule(url);
+    this.skillGem = new itemSubmodules.SkillGemModule(league);
 
     /**
      * Represents a submodule for unique accessory item information.
      */
-    this.uniqueAccessory = new itemSubmodules.UniqueAccessoryModule(url);
+    this.uniqueAccessory = new itemSubmodules.UniqueAccessoryModule(league);
 
     /**
      * Represents a submodule for unique armour item information.
      */
-    this.uniqueArmour = new itemSubmodules.UniqueArmourModule(url);
+    this.uniqueArmour = new itemSubmodules.UniqueArmourModule(league);
 
     /**
      * Represents a submodule for unique flask item information.
      */
-    this.uniqueFlask = new itemSubmodules.UniqueFlaskModule(url);
+    this.uniqueFlask = new itemSubmodules.UniqueFlaskModule(league);
 
     /**
      * Represents a submodule for unique jewel item information.
      */
-    this.uniqueJewel = new itemSubmodules.UniqueJewelModule(url);
+    this.uniqueJewel = new itemSubmodules.UniqueJewelModule(league);
 
     /**
      * Represents a submodule for unique map item information.
      */
-    this.uniqueMap = new itemSubmodules.UniqueMapModule(url);
+    this.uniqueMap = new itemSubmodules.UniqueMapModule(league);
 
     /**
      * Represents a submodule for unique weapon item information.
      */
-    this.uniqueWeapon = new itemSubmodules.UniqueWeaponModule(url);
+    this.uniqueWeapon = new itemSubmodules.UniqueWeaponModule(league);
 
     /**
      * Represents a submodule for vials item information.
      */
-    this.vials = new itemSubmodules.VialsModule(url);
+    this.vials = new itemSubmodules.VialsModule(league);
 
     /**
      * Represents a submodule for omen item information.
      */
-    this.omen = new itemSubmodules.OmenModule(url);
+    this.omen = new itemSubmodules.OmenModule(league);
 
     /**
      * Represents a submodule for memory item information.
      */
-    this.memory = new itemSubmodules.MemoryModule(url);
+    this.memory = new itemSubmodules.MemoryModule(league);
 
     /**
      * Represents a submodule for invitation item information.
      */
-    this.invitation = new itemSubmodules.InvitationModule(url);
+    this.invitation = new itemSubmodules.InvitationModule(league);
 
     /**
      * Represents a submodule for unique relics item information.
      */
-    this.uniqueRelics = new itemSubmodules.UniqueRelicsModule(url);
+    this.uniqueRelics = new itemSubmodules.UniqueRelicsModule(league);
 
     /**
      * Represents a submodule for cluster jewel item information.
      */
-    this.clusterJewel = new itemSubmodules.ClusterJewelModule(url);
+    this.clusterJewel = new itemSubmodules.ClusterJewelModule(league);
 
     /**
      * Represents a submodule for blighted map item information.
      */
-    this.blightedMap = new itemSubmodules.BlightedMapModule(url);
+    this.blightedMap = new itemSubmodules.BlightedMapModule(league);
 
     /**
      * Represents a submodule for blight ravaged map item information.
      */
-    this.blightRavagedMap = new itemSubmodules.BlightRavagedMapModule(url);
+    this.blightRavagedMap = new itemSubmodules.BlightRavagedMapModule(league);
   }
 }
 

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

@@ -1,32 +1,27 @@
 const axios = require("axios");
+const urlGenerator = require("../itemUrlGenerator/ItemUrlGenerator");
 
 /**
  * Asynchronously fetches data from a specified URL for item-related information.
  *
- * @param {string} baseurl - The base URL for the data fetch operation.
+ * @param {string} league - The league name 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) {
+async function fetchData(league, type) {
   try {
     /**
      * @type {string} url - The complete URL for fetching item-related data.
      */
-    const url = `${baseurl}${type}`;
+    const url = urlGenerator(league, 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");
+      throw new Error("Invalid response format from POE Ninja API ItemView");
     }
   } catch (error) {
     /**

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

@@ -1,55 +1,15 @@
-const getData = require("../functions/getData");
-
+const ItemBaseClass = require("../../ItemBaseClass");
 /**
- * Module for retrieving base type item information.
- * @class
+ * Represents a module for handling base types.
+ * @extends ItemBaseClass
  */
-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";
-  }
-
+class BaseTypeModule extends ItemBaseClass {
   /**
-   * 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.
-   *
+   * Creates an instance of BaseTypeModule.
+   * @param {string} league - The league name.
    */
-  async getData(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}`);
-    }
+  constructor(league) {
+    super(league, "BaseType");
   }
 }
 

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

@@ -1,55 +1,20 @@
-const getData = require("../functions/getData");
-
+const ItemBaseClass = require("../../ItemBaseClass");
 /**
- * Module for retrieving information about beasts.
- * @class
+ * Represents a module for handling beasts.
+ * @extends ItemBaseClass
  */
-class BeastModule {
-  #url;
-  #type;
+class BeastModule extends ItemBaseClass {
   /**
-   * Creates a new instance of BeastModule.
-   * @constructor
-   * @param {string} url - The URL for fetching beast information.
+   * Creates an instance of BeastModule.
+   * @param {string} league - The league name.
    */
-  constructor(url) {
-    /**
-     * @type {string} #url - The URL for fetching beast information.
-     * @private
-     */
-    this.#url = url;
-
+  constructor(league) {
     /**
-     * @type {string} #type - The type of data (Beast).
-     * @private
+     * The name of the beast type.
+     * @type {string}
      */
-    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) {
-    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}`);
-    }
+    const typeName = "Beast";
+    super(league, typeName);
   }
 }
 

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

@@ -1,61 +1,16 @@
-const getData = require("../functions/getData");
-
+const ItemBaseClass = require("../../ItemBaseClass");
 /**
- * Represents a module for fetching data related to Blight Ravaged Maps.
- *
- * @class
+ * Represents a module for handling blighted ravaged maps.
+ * @extends ItemBaseClass
  */
-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";
-  }
-
+class BlightedRavagedMapModule extends ItemBaseClass {
   /**
-   * 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.
+   * Creates an instance of BlightedRavagedMapModule.
+   * @param {string} league - The league name.
    */
-  async getData(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}`);
-    }
+  constructor(league) {
+    super(league, "BlightedRavagedMap");
   }
 }
 
-module.exports = BlightRavagedMapModule;
+module.exports = BlightedRavagedMapModule;

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

@@ -1,57 +1,15 @@
-const getData = require("../functions/getData");
-
+const ItemBaseClass = require("../../ItemBaseClass");
 /**
- * Represents a module for fetching data related to Blighted Maps.
- *
- * @class
+ * Represents a module for handling blighted maps.
+ * @extends ItemBaseClass
  */
-class BlightedMapModule {
-  /**
-   * The URL for fetching data.
-   *
-   * @private
-   * @type {string}
-   */
-  #url;
-
-  /**
-   * The type of data (BlightedMap in this case).
-   *
-   * @private
-   * @type {string}
-   */
-  #type;
+class BlightedMapModule extends ItemBaseClass {
   /**
    * 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.
+   * @param {string} league - The league name.
    */
-  async getData(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}`);
-    }
+  constructor(league) {
+    super(league, "BlightedMap");
   }
 }
 

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

@@ -1,60 +1,15 @@
-const getData = require("../functions/getData");
-
+const ItemBaseClass = require("../../ItemBaseClass");
 /**
- * Represents a module for fetching data related to Cluster Jewels.
- *
- * @class
+ * Represents a module for handling cluster jewels.
+ * @extends ItemBaseClass
  */
-class ClusterJewelModule {
-  /**
-   * The URL for fetching data.
-   *
-   * @private
-   * @type {string}
-   */
-  #url;
-
-  /**
-   * The type of data (ClusterJewel in this case).
-   *
-   * @private
-   * @type {string}
-   */
-  #type;
-
+class ClusterJewelModule extends ItemBaseClass {
   /**
    * 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.
+   * @param {string} league - The league name.
    */
-  async getData(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}`);
-    }
+  constructor(league) {
+    super(league, "ClusterJewel");
   }
 }
 

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

@@ -1,60 +1,15 @@
-const getData = require("../functions/getData");
-
+const ItemBaseClass = require("../../ItemBaseClass");
 /**
- * Represents a module for fetching data related to Delirium Orbs.
- *
- * @class
+ * Represents a module for handling delirium orbs.
+ * @extends ItemBaseClass
  */
-class DeliriumOrbsModule {
-  /**
-   * The URL for fetching data.
-   *
-   * @private
-   * @type {string}
-   */
-  #url;
-
-  /**
-   * The type of data (DeliriumOrb in this case).
-   *
-   * @private
-   * @type {string}
-   */
-  #type;
-
+class DeliriumOrbsModule extends ItemBaseClass {
   /**
    * 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.
+   * @param {string} league - The league name.
    */
-  async getData(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}`);
-    }
+  constructor(league) {
+    super(league, "DeliriumOrb");
   }
 }