poe-api-manager 1.2.3 → 1.2.12

package/lib/modules/poe.ninja/currency/currencySubmodules/CurrencySubModules.js

@@ -1,4 +0,0 @@
-module.exports = {
-  CurrencyModule: require("./subModules/CurrencyModule"),
-  FragmentModule: require("./subModules/FragmentModule"),
-};

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

@@ -1,54 +0,0 @@
-const CurrencyBaseClass = require("../../CurrencyBaseClass");
-const getQuickCurrency = require("../../methods/getQuickCurrency");
-
-/**
- * Represents a module for interacting with currency data.
- * @extends CurrencyBaseClass
- */
-class CurrencyModule extends CurrencyBaseClass {
-  /**
-   * The league name for which currency data is requested.
-   * @type {string}
-   * @private
-   */
-  #league;
-  /**
-   * The type name for which currency data is requested.
-   * @type {string}
-   * @private
-   */
-  #typeName;
-  /**
-   * Constructs a new CurrencyModule instance.
-   * @param {string} league - The league name for which currency data is requested.
-   */
-  constructor(league) {
-    /**
-     * The type name for which currency data is requested.
-     * @type {string}
-     */
-    const type = "Currency";
-    super(league, type);
-    this.#league = league;
-    this.#typeName = type;
-  }
-  /**
-   * Fetches quick currency data for a given currency ID. Defaults to "Divine Orb" if no ID is provided.
-   * @param {string} currencyTypeName - The "currencyTypeName" of the currency to fetch data for. Defaults to "Divine Orb".
-   * @returns {Promise<{currencyTypeName: string, chaosEquivalent: number}>} A promise that resolves with the currency data, including the currency type name and its chaos equivalent.
-   * @throws {Error} Throws an error if fetching currency data fails.
-   */
-  async getQuickCurrency(currencyTypeName = "Divine Orb") {
-    try {
-      return await getQuickCurrency(
-        this.#league,
-        this.#typeName,
-        currencyTypeName
-      );
-    } catch (error) {
-      throw new Error(`Error fetching CurrencyData data: ${error.message}`);
-    }
-  }
-}
-
-module.exports = CurrencyModule;

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

@@ -1,17 +0,0 @@
-const CurrencyBaseClass = require("../../CurrencyBaseClass");
-
-/**
- * Represents a module for interacting with fragment currency data.
- * @extends CurrencyBaseClass
- */
-class FragmentModule extends CurrencyBaseClass {
-  /**
-   * Constructs a new FragmentModule instance.
-   * @param {string} league - The league name for which fragment currency data is requested.
-   */
-  constructor(league) {
-    super(league, "Fragment");
-  }
-}
-
-module.exports = FragmentModule;

package/lib/modules/poe.ninja/currency/currencyUrlGenerator/CurrencyUrlGenerator.js

@@ -1,9 +0,0 @@
-/**
- * Generates a URL based on league and type. poe.ninja (currencyView) API is used.
- * @param {string} league - The league for which the URL is generated.
- * @param {string} type - The type of data for which the URL is generated.
- * @returns {string} - The generated URL.
- */
-module.exports = function urlGenerator(league, type) {
-  return `https://poe.ninja/api/data/currencyoverview?league=${league}&type=${type}`;
-};

package/lib/modules/poe.ninja/currency/methods/getData.js

@@ -1,45 +0,0 @@
-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(league, type, requestedProperties) {
-  try {
-    // Fetch data using the fetchData function
-    const fetchedData = await fetchData(league, type);
-
-    // 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 {
-      // If no specific properties are requested, return the entire fetched data
-      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}`);
-  }
-}
-
-module.exports = getData;

package/lib/modules/poe.ninja/currency/methods/getQuickCurrency.js

@@ -1,28 +0,0 @@
-const fetchCurrency = require("../currencyFetch/fetchCurrency");
-
-/**
- * Retrieves quick currency data for a specific currency in a given league and type.
- * @param {string} league - The league for which to fetch currency data.
- * @param {string} type - The type of currency data to fetch.
- * @param {string} currencyTypeName - The currencyTypeName of the currency to fetch data for.
- * @returns {Promise<{currencyTypeName: string, chaosEquivalent: number}>} An object containing the currency type name and its chaos equivalent.
- * @throws {Error} Throws an error if the currency data cannot be fetched or if the currency is not found.
- */
-async function getQuickCurrency(league, type, currencyTypeName) {
-  try {
-    const fetchedData = await fetchCurrency(league, type);
-    for (const data of fetchedData) {
-      if (data.currencyTypeName === currencyTypeName) {
-        return {
-          currencyTypeName: data.currencyTypeName,
-          chaosEquivalent: data.chaosEquivalent,
-        };
-      }
-    }
-    throw new Error("Currency not found");
-  } catch (error) {
-    throw new Error(`Error fetching currency data: ${error.message}`);
-  }
-}
-
-module.exports = getQuickCurrency;

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

@@ -1,40 +0,0 @@
-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/itemFetch/fetchItem.js

@@ -1,36 +0,0 @@
-const axios = require("axios");
-const urlGenerator = require("../itemUrlGenerator/ItemUrlGenerator");
-
-/**
- * Asynchronously fetches data from a specified URL for item-related information.
- *
- * @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(league, type) {
-  try {
-    /**
-     * @type {string} url - The complete URL for fetching item-related data.
-     */
-    const url = urlGenerator(league, type);
-
-    const response = await axios.get(url);
-
-    if (response.data && response.data.lines) {
-      return response.data.lines;
-    } else {
-      throw new Error("Invalid response format from POE Ninja API ItemView");
-    }
-  } 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 the fetchData function.
-module.exports = fetchData;

package/lib/modules/poe.ninja/item/itemSubmodules/itemSubModules.js

@@ -1,31 +0,0 @@
-// itemSubmodules.js
-module.exports = {
-  BaseTypeModule: require("./subModules/BaseTypeModule"),
-  BeastModule: require("./subModules/BeastModule"),
-  DeliriumOrbsModule: require("./subModules/DeliriumOrbsModule"),
-  DivinationCardModule: require("./subModules/DivinationCardModule"),
-  EssenceModule: require("./subModules/EssenceModule"),
-  FossilModule: require("./subModules/FossilModule"),
-  HelmetEnchantModule: require("./subModules/HelmetEnchantModule"),
-  IncubatorModule: require("./subModules/IncubatorModule"),
-  MapModule: require("./subModules/MapModule"),
-  OilModule: require("./subModules/OilModule"),
-  ResonatorModule: require("./subModules/ResonatorModule"),
-  ScarabModule: require("./subModules/ScarabModule"),
-  SkillGemModule: require("./subModules/SkillGemModule"),
-  UniqueAccessoryModule: require("./subModules/UniqueAccessoryModule"),
-  UniqueArmourModule: require("./subModules/UniqueArmourModule"),
-  UniqueFlaskModule: require("./subModules/UniqueFlaskModule"),
-  UniqueJewelModule: require("./subModules/UniqueJewelModule"),
-  UniqueMapModule: require("./subModules/UniqueMapModule"),
-  UniqueWeaponModule: require("./subModules/UniqueWeaponModule"),
-  VialsModule: require("./subModules/VialsModule"),
-  OmenModule: require("./subModules/OmenModule"),
-  MemoryModule: require("./subModules/MemoryModule"),
-  InvitationModule: require("./subModules/InvitationModule"),
-  UniqueRelicsModule: require("./subModules/UniqueRelicModule"),
-  ClusterJewelModule: require("./subModules/ClusterJewelModule"),
-  BlightedMapModule: require("./subModules/BlightedMapModule"),
-  BlightRavagedMapModule: require("./subModules/BlightRavagedMapModule"),
-  CoffinModule: require("./subModules/CoffinModule"),
-};

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling base types.
- * @extends ItemBaseClass
- */
-class BaseTypeModule extends ItemBaseClass {
-  /**
-   * Creates an instance of BaseTypeModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "BaseType");
-  }
-}
-
-module.exports = BaseTypeModule;

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

@@ -1,21 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling beasts.
- * @extends ItemBaseClass
- */
-class BeastModule extends ItemBaseClass {
-  /**
-   * Creates an instance of BeastModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    /**
-     * The name of the beast type.
-     * @type {string}
-     */
-    const typeName = "Beast";
-    super(league, typeName);
-  }
-}
-
-module.exports = BeastModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling blighted ravaged maps.
- * @extends ItemBaseClass
- */
-class BlightedRavagedMapModule extends ItemBaseClass {
-  /**
-   * Creates an instance of BlightedRavagedMapModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "BlightedRavagedMap");
-  }
-}
-
-module.exports = BlightedRavagedMapModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling blighted maps.
- * @extends ItemBaseClass
- */
-class BlightedMapModule extends ItemBaseClass {
-  /**
-   * Creates an instance of BlightedMapModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "BlightedMap");
-  }
-}
-
-module.exports = BlightedMapModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling cluster jewels.
- * @extends ItemBaseClass
- */
-class ClusterJewelModule extends ItemBaseClass {
-  /**
-   * Creates an instance of ClusterJewelModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "ClusterJewel");
-  }
-}
-
-module.exports = ClusterJewelModule;

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

@@ -1,9 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-
-class CoffinModule extends ItemBaseClass {
-  constructor(league, type = "Coffin") {
-    super(league, type);
-  }
-}
-
-module.exports = CoffinModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling delirium orbs.
- * @extends ItemBaseClass
- */
-class DeliriumOrbsModule extends ItemBaseClass {
-  /**
-   * Creates an instance of DeliriumOrbsModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "DeliriumOrb");
-  }
-}
-
-module.exports = DeliriumOrbsModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling divination cards.
- * @extends ItemBaseClass
- */
-class DivinationCardModule extends ItemBaseClass {
-  /**
-   * Creates an instance of DivinationCardModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "DivinationCard");
-  }
-}
-
-module.exports = DivinationCardModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling essences.
- * @extends ItemBaseClass
- */
-class EssenceModule extends ItemBaseClass {
-  /**
-   * Creates an instance of EssenceModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "Essence");
-  }
-}
-
-module.exports = EssenceModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling fossils.
- * @extends ItemBaseClass
- */
-class FossilModule extends ItemBaseClass {
-  /**
-   * Creates an instance of FossilModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "Fossil");
-  }
-}
-
-module.exports = FossilModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling helmet enchants.
- * @extends ItemBaseClass
- */
-class HelmetEnchantModule extends ItemBaseClass {
-  /**
-   * Creates an instance of HelmetEnchantModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "HelmetEnchant");
-  }
-}
-
-module.exports = HelmetEnchantModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling incubators.
- * @extends ItemBaseClass
- */
-class IncubatorModule extends ItemBaseClass {
-  /**
-   * Creates an instance of IncubatorModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "Incubator");
-  }
-}
-
-module.exports = IncubatorModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling invitations.
- * @extends ItemBaseClass
- */
-class InvitationModule extends ItemBaseClass {
-  /**
-   * Creates an instance of InvitationModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "Invitation");
-  }
-}
-
-module.exports = InvitationModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling maps.
- * @extends ItemBaseClass
- */
-class MapModule extends ItemBaseClass {
-  /**
-   * Creates an instance of MapModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "Map");
-  }
-}
-
-module.exports = MapModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling memories.
- * @extends ItemBaseClass
- */
-class MemoryModule extends ItemBaseClass {
-  /**
-   * Creates an instance of MemoryModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "Memory");
-  }
-}
-
-module.exports = MemoryModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling oils.
- * @extends ItemBaseClass
- */
-class OilModule extends ItemBaseClass {
-  /**
-   * Creates an instance of OilModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "Oil");
-  }
-}
-
-module.exports = OilModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling omens.
- * @extends ItemBaseClass
- */
-class OmenModule extends ItemBaseClass {
-  /**
-   * Creates an instance of OmenModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "Omen");
-  }
-}
-
-module.exports = OmenModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling resonators.
- * @extends ItemBaseClass
- */
-class ResonatorModule extends ItemBaseClass {
-  /**
-   * Creates an instance of ResonatorModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "Resonator");
-  }
-}
-
-module.exports = ResonatorModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling scarabs.
- * @extends ItemBaseClass
- */
-class ScarabModule extends ItemBaseClass {
-  /**
-   * Creates an instance of ScarabModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "Scarab");
-  }
-}
-
-module.exports = ScarabModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling skill gems.
- * @extends ItemBaseClass
- */
-class SkillGemModule extends ItemBaseClass {
-  /**
-   * Creates an instance of SkillGemModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "SkillGem");
-  }
-}
-
-module.exports = SkillGemModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling unique accessories.
- * @extends ItemBaseClass
- */
-class UniqueAccessoryModule extends ItemBaseClass {
-  /**
-   * Creates an instance of UniqueAccessoryModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "UniqueAccessory");
-  }
-}
-
-module.exports = UniqueAccessoryModule;

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

@@ -1,16 +0,0 @@
-const ItemBaseClass = require("../../ItemBaseClass");
-/**
- * Represents a module for handling unique armours.
- * @extends ItemBaseClass
- */
-class UniqueArmourModule extends ItemBaseClass {
-  /**
-   * Creates an instance of UniqueArmourModule.
-   * @param {string} league - The league name.
-   */
-  constructor(league) {
-    super(league, "UniqueArmour");
-  }
-}
-
-module.exports = UniqueArmourModule;