poe-api-manager 1.2.3 → 1.2.12

package/dist/lib/modules/poe.ninja/fetch/fetchData.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const mergeData_1 = __importDefault(require("./merge/mergeData"));
+const urlGenerator_1 = __importDefault(require("../func/urlGenerator"));
+/**
+ * Fetches data from a specified API endpoint, merges relevant data, and returns the result.
+ * @param league The game league for which to fetch data.
+ * @param type The type of data to fetch. (e.g. "Currency", "Fragment")
+ * @param typeName The name of the type of data to fetch. (e.g. "CurrencyOverview", "ItemOverview")
+ * @returns A promise that resolves to an array of merged objects containing both line and currency details.
+ * @throws Throws an error if there's an issue with the API response or data fetching process.
+ */
+async function fetchData(league, typeName, type) {
+    try {
+        // Generate the URL for the specified league, type name, and type
+        const url = (0, urlGenerator_1.default)(league, typeName, type);
+        //axios.get(url) is a promise
+        const response = await axios_1.default.get(url, {
+            headers: {
+                'Accept-Encoding': 'identity',
+            },
+        });
+        //typwName is either currencyoverview or itemoverview
+        if (typeName == "currencyoverview") {
+            //if the response has data and lines and currencyDetails
+            if (response.data && response.data.lines && response.data.currencyDetails) {
+                const lines = response.data.lines;
+                const currencyDetails = response.data.currencyDetails;
+                //the join data is the currencyDetails
+                return (0, mergeData_1.default)(lines, currencyDetails);
+            }
+            else {
+                throw new Error(`Invalid response format from POE Ninja API CurrencyView Type:${type}`);
+            }
+        }
+        else if (typeName == "itemoverview") {
+            //if the response has data and lines
+            if (response.data && response.data.lines) {
+                return response.data.lines;
+            }
+            else {
+                throw new Error(`"Invalid response format from POE Ninja API ItemView Type:${type}`);
+            }
+        }
+        else {
+            throw new Error(`Invalid type: ${type}`);
+        }
+    }
+    catch (error) {
+        throw new Error(`Error fetching data: ${error.message} TypeName:${typeName} and Type:${type}`);
+    }
+}
+exports.default = fetchData;

package/dist/lib/modules/poe.ninja/fetch/merge/mergeData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Merges the provided lines with the corresponding currency details.
+ * @param lines The lines to be merged.
+ * @param currencyDetails The currency details to be merged with the lines.
+ * @returns The merged data.
+ */
+declare function mergeData(lines: any[], currencyDetails: any[]): any[];
+export default mergeData;

package/dist/lib/modules/poe.ninja/fetch/merge/mergeData.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Merges the provided lines with the corresponding currency details.
+ * @param lines The lines to be merged.
+ * @param currencyDetails The currency details to be merged with the lines.
+ * @returns 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;
+}
+exports.default = mergeData;

package/dist/lib/modules/poe.ninja/func/getData.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Fetches data from the specified league, type, and typeName.
+ *
+ * @param league - The name of the league to fetch data from.
+ * @param typeName - The name of the type to fetch data for.
+ * @param type - The type of data to fetch.
+ * @param requestedProperties - Optional. An array of properties to filter the fetched data by.
+ * @returns A promise that resolves to an array of objects containing the fetched data.
+ * @throws If there is an error fetching the data.
+ */
+declare function getData(league: string, typeName: string, type: string, requestedProperties?: string[]): Promise<object[]>;
+export default getData;

package/dist/lib/modules/poe.ninja/func/getData.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fetchData_1 = __importDefault(require("../fetch/fetchData"));
+const propertyFilter_1 = __importDefault(require("../../mainfunctions/propertyFilter"));
+/**
+ * Fetches data from the specified league, type, and typeName.
+ *
+ * @param league - The name of the league to fetch data from.
+ * @param typeName - The name of the type to fetch data for.
+ * @param type - The type of data to fetch.
+ * @param requestedProperties - Optional. An array of properties to filter the fetched data by.
+ * @returns A promise that resolves to an array of objects containing the fetched data.
+ * @throws If there is an error fetching the data.
+ */
+async function getData(league, typeName, type, requestedProperties) {
+    try {
+        const fetchedData = await (0, fetchData_1.default)(league, typeName, type);
+        //if requestedProperties use filterProperties to filter fetchedData
+        if (requestedProperties) {
+            const result = (0, propertyFilter_1.default)(fetchedData, requestedProperties);
+            return result;
+        }
+        else {
+            return fetchedData;
+        }
+    }
+    catch (error) {
+        throw new Error(`Type:${type} Error fetching data: ${error.message}`);
+    }
+}
+exports.default = getData;

package/dist/lib/modules/poe.ninja/func/getQuickCurrency.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Retrieves quick currency data for a specific currency in a given league and type.
+ * @param league - The league for which to fetch currency data.
+ * @param typeName - The type of currency data to fetch.
+ * @param type - The type of currency data to fetch.
+ * @param 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 Throws an error if the currency data cannot be fetched or if the currency is not found.
+ */
+declare function getQuickCurrency(league: string, typeName: string, type: string, currencyTypeName: string): Promise<{
+    currencyTypeName: string;
+    chaosEquivalent: number;
+}>;
+export default getQuickCurrency;

package/dist/lib/modules/poe.ninja/func/getQuickCurrency.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fetchData_1 = __importDefault(require("../fetch/fetchData"));
+/**
+ * Retrieves quick currency data for a specific currency in a given league and type.
+ * @param league - The league for which to fetch currency data.
+ * @param typeName - The type of currency data to fetch.
+ * @param type - The type of currency data to fetch.
+ * @param 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 Throws an error if the currency data cannot be fetched or if the currency is not found.
+ */
+async function getQuickCurrency(league, typeName, type, currencyTypeName) {
+    try {
+        const fetchedData = await (0, fetchData_1.default)(league, typeName, type);
+        //find the currencyTypeName in the fetchedData
+        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}`);
+    }
+}
+exports.default = getQuickCurrency;

package/dist/lib/modules/poe.ninja/func/urlGenerator.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates a URL based on league and type. poe.ninja (currencyView) API is used.
+ * @param league The league for which the URL is generated.
+ * @param type The type of data for which the URL is generated.
+ * @param typeName The name of the type of data for which the URL is generated.
+ * @returns The generated URL.
+ */
+export default function urlGenerator(league: string, typeName: string, type: string): string;

package/dist/lib/modules/poe.ninja/func/urlGenerator.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Generates a URL based on league and type. poe.ninja (currencyView) API is used.
+ * @param league The league for which the URL is generated.
+ * @param type The type of data for which the URL is generated.
+ * @param typeName The name of the type of data for which the URL is generated.
+ * @returns The generated URL.
+ */
+function urlGenerator(league, typeName, type) {
+    return `https://poe.ninja/api/data/${typeName}?league=${league}&type=${type}`;
+}
+exports.default = urlGenerator;

package/{lib/modules/poe.ninja/item/ItemWievModule.js → dist/lib/modules/poe.ninja/itemView/ItemViewModule.d.ts}

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

package/dist/lib/modules/poe.ninja/itemView/ItemViewModule.js

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

package/dist/lib/modules/poe.ninja/itemView/itemSubmodules/itemSubModules.d.ts

@@ -0,0 +1,30 @@
+import BaseTypeModule from "./subModules/BaseTypeModule";
+import BeastModule from "./subModules/BeastModule";
+import DeliriumOrbsModule from "./subModules/DeliriumOrbsModule";
+import DivinationCardModule from "./subModules/DivinationCardModule";
+import EssenceModule from "./subModules/EssenceModule";
+import FossilModule from "./subModules/FossilModule";
+import HelmetEnchantModule from "./subModules/HelmetEnchantModule";
+import IncubatorModule from "./subModules/IncubatorModule";
+import MapModule from "./subModules/MapModule";
+import OilModule from "./subModules/OilModule";
+import ResonatorModule from "./subModules/ResonatorModule";
+import ScarabModule from "./subModules/ScarabModule";
+import SkillGemModule from "./subModules/SkillGemModule";
+import UniqueAccessoryModule from "./subModules/UniqueAccessoryModule";
+import UniqueArmourModule from "./subModules/UniqueArmourModule";
+import UniqueFlaskModule from "./subModules/UniqueFlaskModule";
+import UniqueJewelModule from "./subModules/UniqueJewelModule";
+import UniqueMapModule from "./subModules/UniqueMapModule";
+import UniqueWeaponModule from "./subModules/UniqueWeaponModule";
+import VialsModule from "./subModules/VialsModule";
+import OmenModule from "./subModules/OmenModule";
+import MemoryModule from "./subModules/MemoryModule";
+import InvitationModule from "./subModules/InvitationModule";
+import UniqueRelicsModule from "./subModules/UniqueRelicModule";
+import ClusterJewelModule from "./subModules/ClusterJewelModule";
+import BlightedMapModule from "./subModules/BlightedMapModule";
+import BlightRavagedMapModule from "./subModules/BlightRavagedMapModule";
+import CoffinModule from "./subModules/CoffinModule";
+import AllflameEmberModule from "./subModules/AllflameEmberModule";
+export { BaseTypeModule, BeastModule, DeliriumOrbsModule, DivinationCardModule, EssenceModule, FossilModule, HelmetEnchantModule, IncubatorModule, MapModule, OilModule, ResonatorModule, ScarabModule, SkillGemModule, UniqueAccessoryModule, UniqueArmourModule, UniqueFlaskModule, UniqueJewelModule, UniqueMapModule, UniqueWeaponModule, VialsModule, OmenModule, MemoryModule, InvitationModule, UniqueRelicsModule, ClusterJewelModule, BlightedMapModule, BlightRavagedMapModule, CoffinModule, AllflameEmberModule };