poe-api-manager 1.2.4 → 1.2.13

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

@@ -1,36 +0,0 @@
-/**
- * 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}`);
-      }
-    });
-
-    result.push(itemResult);
-  });
-
-  return result;
-};

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

@@ -1,47 +0,0 @@
-const getData = require("./methods/getData");
-
-/**
- * Represents a base class for interacting with data.
- */
-class CurrencyBaseClass {
-  /**
-   * The league name for which data is requested.
-   * @type {string}
-   * @private
-   */
-  #league;
-
-  /**
-   * The type of data.
-   * @type {string}
-   * @private
-   */
-  #typeName;
-
-  /**
-   * Constructs a new CurrencyBaseClass instance.
-   * @param {string} league - The league name for which data is requested.
-   * @param {string} typeName - The type of data.
-   */
-  constructor(league, typeName) {
-    this.#league = league;
-    this.#typeName = typeName;
-  }
-
-  /**
-   * Retrieves data based on the specified properties.
-   * @async
-   * @param {Array<string>} requestedProperties - The properties to include in the fetched data.
-   * @returns {Promise<Array<Object>>} The fetched data in JSON format.
-   * @throws {Error} If an error occurs during the data fetching process.
-   */
-  async getData(requestedProperties) {
-    try {
-      return await getData(this.#league, this.#typeName, requestedProperties);
-    } catch (error) {
-      throw new Error(`Error fetching CurrencyView data: ${error.message}`);
-    }
-  }
-}
-
-module.exports = CurrencyBaseClass;

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

@@ -1,31 +0,0 @@
-const currencySubmodules = require("./currencySubmodules/CurrencySubModules");
-
-/**
- * Represents a module for fetching currency overview data.
- *
- * @class
- */
-class CurrencyWievModule {
-  /**
-   * Creates a new CurrencyWievModule instance.
-   *
-   * @constructor
-   * @param {string} league - The name of the Path of Exile league.
-   */
-  constructor(league) {
-    /**
-
-    /**
-     * Represents a module for fetching currency data.
-     */
-    this.currency = new currencySubmodules.CurrencyModule(league);
-
-    /**
-     * Represents a module for fetching fragment data.
-     */
-    this.fragment = new currencySubmodules.FragmentModule(league);
-  }
-}
-
-// Export the CurrencyWievModule class
-module.exports = CurrencyWievModule;

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

@@ -1,35 +0,0 @@
-const axios = require("axios");
-const mergeData = require("./merge/mergeData");
-const currencyUrlGenerator = require("../currencyUrlGenerator/CurrencyUrlGenerator");
-
-/**
- * Fetches data from a specified API endpoint, merges relevant data, and returns the result.
- *
- * @param {string} league - The game league for which to fetch currency data.
- * @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(league, type) {
-  try {
-    const url = currencyUrlGenerator(league, type);
-    const response = await axios.get(url);
-
-    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 CurrencyView"
-      );
-    }
-  } catch (error) {
-    throw new Error(`Error fetching data: ${error.message}`);
-  }
-}
-
-module.exports = fetchData;

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

@@ -1,36 +0,0 @@
-/**
- * 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 = [];
-
-  lines.forEach((line) => {
-    const currencyType = line.currencyTypeName;
-
-    // Find the corresponding currencyDetail based on currencyType
-    const currencyDetail = currencyDetails.find(
-      (detail) => detail.name === currencyType
-    );
-
-    if (currencyDetail) {
-      // Merge line and currencyDetail into a new object
-      const mergedItem = {
-        ...line,
-        id: currencyDetail.id,
-        icon: currencyDetail.icon,
-        name: currencyDetail.name,
-      };
-
-      // Add the merged item to the result array
-      mergedData.push(mergedItem);
-    }
-  });
-
-  return mergedData;
-}
-
-module.exports = mergeData;

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/ItemWievModule.js

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

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,32 +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"),
-  AllflameEmberModule: require("./subModules/AllflameEmberModule"),
-};

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

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

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;