poe-api-manager 1.2.23 → 2.1.0

package/dist/lib/modules/poe.ninja/currencyView/{currencySubModules/submodules/CurrencyModule.js → CurrencyModule.js}

@@ -4,10 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CurrencyModule = void 0;
-const PoeNinja_1 = __importDefault(require("../../../../../AbstractClass/PoeNinja"));
-const getQuickCurrency_1 = __importDefault(require("../../../func/getQuickCurrency"));
-const CustomError_1 = __importDefault(require("../../../../../errors/CustomError"));
-const ApiError_1 = __importDefault(require("../../../../../errors/ApiError"));
+const PoeNinja_1 = __importDefault(require("../../../AbstractClass/PoeNinja"));
+const getQuickCurrency_1 = __importDefault(require("../func/getQuickCurrency"));
+const CustomError_1 = __importDefault(require("../../../errors/CustomError"));
+const ApiError_1 = __importDefault(require("../../../errors/ApiError"));
 /**
  * Represents a module for retrieving currency data from the PoeNinja API.
  */

package/dist/lib/modules/poe.ninja/currencyView/CurrencyViewModule.d.ts

@@ -1,4 +1,5 @@
-import * as Modules from "./currencySubModules/CurrencySubModules";
+import PoeNinja from "../../../AbstractClass/PoeNinja";
+import { CurrencyModule } from "./CurrencyModule";
 /**
  * Represents a module for fetching currency overview data.
  */
@@ -6,15 +7,14 @@ export default class CurrencyViewModule {
     /**
      * Represents a module for fetching currency data.
      */
-    currency: Modules.CurrencyModule;
+    currency: CurrencyModule;
     /**
      * Represents a module for fetching fragment data.
      */
-    fragment: Modules.FragmentModule;
+    fragment: PoeNinja;
     /**
      * Creates a new CurrencyViewModule instance.
      * @param league The name of the Path of Exile league.
-     * @param typeName The type of data to retrieve.
      */
-    constructor(league: string, typeName: string);
+    constructor(league: string);
 }

package/dist/lib/modules/poe.ninja/currencyView/CurrencyViewModule.js

@@ -1,29 +1,11 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Modules = __importStar(require("./currencySubModules/CurrencySubModules"));
+const PoeNinjaLeaf_1 = __importDefault(require("../../../AbstractClass/PoeNinjaLeaf"));
+const CurrencyModule_1 = require("./CurrencyModule");
+const TYPE_NAME = "currencyoverview";
 /**
  * Represents a module for fetching currency overview data.
  */
@@ -39,11 +21,10 @@ class CurrencyViewModule {
     /**
      * Creates a new CurrencyViewModule instance.
      * @param league The name of the Path of Exile league.
-     * @param typeName The type of data to retrieve.
      */
-    constructor(league, typeName) {
-        this.currency = new Modules.CurrencyModule(league, typeName);
-        this.fragment = new Modules.FragmentModule(league, typeName);
+    constructor(league) {
+        this.currency = new CurrencyModule_1.CurrencyModule(league, TYPE_NAME);
+        this.fragment = new PoeNinjaLeaf_1.default(league, TYPE_NAME, "Fragment");
     }
 }
 exports.default = CurrencyViewModule;

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

@@ -5,8 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 const mergeData_1 = __importDefault(require("./merge/mergeData"));
+const mergeExchangeData_1 = __importDefault(require("./merge/mergeExchangeData"));
 const urlGenerator_1 = __importDefault(require("../func/urlGenerator"));
 const ApiError_1 = __importDefault(require("../../../errors/ApiError"));
+const CustomError_1 = __importDefault(require("../../../errors/CustomError"));
+const httpGet_1 = __importDefault(require("../../utils/httpGet"));
 /**
  * Fetches data from a specified API endpoint, merges relevant data, and returns the result.
  * @param league The game league for which to fetch data.
@@ -19,12 +22,7 @@ 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",
-            },
-        });
+        const response = await (0, httpGet_1.default)(url);
         //typwName is either currencyoverview or itemoverview
         if (typeName == "currencyoverview") {
             //if the response has data and lines and currencyDetails
@@ -49,6 +47,17 @@ async function fetchData(league, typeName, type) {
                 throw new ApiError_1.default(`Invalid response format from POE Ninja API ItemView Type:${type}`, 400, { league, typeName, type });
             }
         }
+        else if (typeName == "exchangeoverview") {
+            // CAVEAT: unlike the other two endpoints, the exchange endpoint returns
+            // HTTP 200 with an empty lines[] for an unknown type instead of a 404
+            // (verified live), so a bad type yields [] here rather than an error.
+            if (response.data && response.data.lines && response.data.items) {
+                return (0, mergeExchangeData_1.default)(response.data.lines, response.data.items, response.data.core);
+            }
+            else {
+                throw new ApiError_1.default(`Invalid response format from POE Ninja API ExchangeView Type:${type}`, 400, { league, typeName, type });
+            }
+        }
         else {
             throw new ApiError_1.default(`Invalid type: ${type}`, 400, {
                 league,
@@ -58,8 +67,8 @@ async function fetchData(league, typeName, type) {
         }
     }
     catch (error) {
-        // If it's already an ApiError, pass it through
-        if (error instanceof ApiError_1.default) {
+        // If it's already a typed error (ApiError/ValidationError), pass it through
+        if (error instanceof CustomError_1.default) {
             throw error;
         }
         // Handle axios errors with more context

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

@@ -12,17 +12,17 @@ function mergeData(lines, currencyDetails) {
         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 = {
+        // Merge line and currencyDetail into a new object. Keep unmatched lines
+        // as-is instead of dropping them.
+        const mergedItem = currencyDetail
+            ? {
                 ...line,
                 id: currencyDetail.id,
                 icon: currencyDetail.icon,
                 name: currencyDetail.name,
-            };
-            // Add the merged item to the result array
-            mergedData.push(mergedItem);
-        }
+            }
+            : { ...line };
+        mergedData.push(mergedItem);
     });
     return mergedData;
 }

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

@@ -0,0 +1,10 @@
+/**
+ * Merges exchange endpoint lines with their join-table items, normalizing the
+ * result to the documented ["id","name","icon"] contract.
+ * @param lines The exchange lines to be merged.
+ * @param items The exchange join-table items (top-level `items[]`, not `core.items`).
+ * @param core The exchange `core` object; `core.primary` names the unit of `line.primaryValue`.
+ * @returns The merged data.
+ */
+declare function mergeExchangeData(lines: any[], items: any[], core: any): any[];
+export default mergeExchangeData;

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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Merges exchange endpoint lines with their join-table items, normalizing the
+ * result to the documented ["id","name","icon"] contract.
+ * @param lines The exchange lines to be merged.
+ * @param items The exchange join-table items (top-level `items[]`, not `core.items`).
+ * @param core The exchange `core` object; `core.primary` names the unit of `line.primaryValue`.
+ * @returns The merged data.
+ */
+function mergeExchangeData(lines, items, core) {
+    const mergedData = [];
+    lines.forEach((line) => {
+        const item = items.find((candidate) => candidate.id === line.id);
+        const mergedItem = { ...line };
+        if (item) {
+            mergedItem.name = item.name;
+            mergedItem.icon = `https://web.poecdn.com${item.image}`;
+            mergedItem.detailsId = item.detailsId;
+            mergedItem.category = item.category;
+        }
+        if (core?.primary === "chaos") {
+            mergedItem.chaosValue = line.primaryValue;
+        }
+        else {
+            delete mergedItem.chaosValue;
+        }
+        mergedData.push(mergedItem);
+    });
+    return mergedData;
+}
+exports.default = mergeExchangeData;

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

@@ -16,19 +16,14 @@ const propertyFilter_1 = __importDefault(require("../../../mainfunctions/propert
  * @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;
-        }
+    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;
     }
-    catch (error) {
-        throw new Error(`Type:${type} Error fetching data: ${error.message}`);
+    else {
+        return fetchedData;
     }
 }
 exports.default = getData;

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

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const fetchData_1 = __importDefault(require("../fetch/fetchData"));
+const ValidationError_1 = __importDefault(require("../../../errors/ValidationError"));
 /**
  * Retrieves quick currency data for a specific currency in a given league and type.
  * @param league - The league for which to fetch currency data.
@@ -14,21 +15,20 @@ const fetchData_1 = __importDefault(require("../fetch/fetchData"));
  * @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,
-                };
-            }
+    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}`);
     }
+    throw new ValidationError_1.default(`Currency not found: ${currencyTypeName}`, 404, {
+        league,
+        type,
+        currencyTypeName,
+    });
 }
 exports.default = getQuickCurrency;

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

@@ -1,5 +1,18 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = urlGenerator;
+const ValidationError_1 = __importDefault(require("../../../errors/ValidationError"));
+/**
+ * Maps the internal typeName to its poe.ninja economy API path.
+ */
+const PATHS = {
+    currencyoverview: "/poe1/api/economy/stash/current/currency/overview",
+    itemoverview: "/poe1/api/economy/stash/current/item/overview",
+    exchangeoverview: "/poe1/api/economy/exchange/current/overview",
+};
 /**
  * Generates a URL based on league and type. poe.ninja (currencyView) API is used.
  * @param league The league for which the URL is generated.
@@ -8,6 +21,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * @returns The generated URL.
  */
 function urlGenerator(league, typeName, type) {
-    return `https://poe.ninja/api/data/${typeName}?league=${league}&type=${type}`;
+    const path = PATHS[typeName];
+    if (!path) {
+        throw new ValidationError_1.default(`Invalid typeName: ${typeName}`, 400, { league, typeName, type });
+    }
+    return `https://poe.ninja${path}?league=${encodeURIComponent(league)}&type=${encodeURIComponent(type)}`;
 }
-exports.default = urlGenerator;

package/dist/lib/modules/poe.ninja/itemView/ItemViewModule.d.ts

@@ -1,128 +1,67 @@
-import * as Modules from "./itemSubmodules/itemSubModules";
+import PoeNinja from "../../../AbstractClass/PoeNinja";
 /**
  * Represents a module for viewing item-related information in a specific Path of Exile league.
  */
 export default class ItemViewModule {
-    /**
-     * Represents a submodule for base type item information.
-     */
-    baseType: Modules.BaseTypeModule;
-    /**
-     * Represents a submodule for beast item information.
-     */
-    beast: Modules.BeastModule;
-    /**
-     * Represents a submodule for delirium orbs item information.
-     */
-    deliriumOrbs: Modules.DeliriumOrbsModule;
-    /**
-     * Represents a submodule for divination card item information.
-     */
-    divinationCard: Modules.DivinationCardModule;
-    /**
-     * Represents a submodule for essence item information.
-     */
-    essence: Modules.EssenceModule;
-    /**
-     * Represents a submodule for fossil item information.
-     */
-    fossil: Modules.FossilModule;
-    /**
-     * Represents a submodule for helmet enchant item information.
-     */
-    helmetEnchant: Modules.HelmetEnchantModule;
-    /**
-     * Represents a submodule for incubator item information.
-     */
-    incubator: Modules.IncubatorModule;
-    /**
-     * Represents a submodule for map item information.
-     */
-    map: Modules.MapModule;
-    /**
-     * Represents a submodule for oil item information.
-     */
-    oil: Modules.OilModule;
-    /**
-     * Represents a submodule for resonator item information.
-     */
-    resonator: Modules.ResonatorModule;
-    /**
-     * Represents a submodule for scarab item information.
-     */
-    scarab: Modules.ScarabModule;
-    /**
-     * Represents a submodule for skill gem item information.
-     */
-    skillGem: Modules.SkillGemModule;
-    /**
-     * Represents a submodule for unique accessory item information.
-     */
-    uniqueAccessory: Modules.UniqueAccessoryModule;
-    /**
-     * Represents a submodule for unique armour item information.
-     */
-    uniqueArmour: Modules.UniqueArmourModule;
-    /**
-     * Represents a submodule for unique flask item information.
-     */
-    uniqueFlask: Modules.UniqueFlaskModule;
-    /**
-     * Represents a submodule for unique jewel item information.
-     */
-    uniqueJewel: Modules.UniqueJewelModule;
-    /**
-     * Represents a submodule for unique map item information.
-     */
-    uniqueMap: Modules.UniqueMapModule;
-    /**
-     * Represents a submodule for unique weapon item information.
-     */
-    uniqueWeapon: Modules.UniqueWeaponModule;
-    /**
-     * Represents a submodule for vials item information.
-     */
-    vials: Modules.VialsModule;
-    /**
-     * Represents a submodule for omen item information.
-     */
-    omen: Modules.OmenModule;
-    /**
-     * Represents a submodule for memory item information.
-     */
-    memory: Modules.MemoryModule;
-    /**
-     * Represents a submodule for invitation item information.
-     */
-    invitation: Modules.InvitationModule;
-    /**
-     * Represents a submodule for unique relics item information.
-     */
-    uniqueRelics: Modules.UniqueRelicModule;
-    /**
-     * Represents a submodule for cluster jewel item information.
-     */
-    clusterJewel: Modules.ClusterJewelModule;
-    /**
-     * Represents a submodule for blighted map item information.
-     */
-    blightedMap: Modules.BlightedMapModule;
-    /**
-     * Represents a submodule for blight ravaged map item information.
-     */
-    blightRavagedMap: Modules.BlightedRavagedMapModule;
-    /**
-     * Represents a submodule for coffin item information.
-     */
-    coffin: Modules.CoffinModule;
-    /**
-     * Creates an instance of AllflameEmberModule.
-     */
-    allflameEmber: Modules.AllflameEmberModule;
+    /** Represents a submodule for base type item information. */
+    baseType: PoeNinja;
+    /** Represents a submodule for beast item information. */
+    beast: PoeNinja;
+    /** Represents a submodule for delirium orbs item information. *(exchange)* */
+    deliriumOrbs: PoeNinja;
+    /** Represents a submodule for divination card item information. *(exchange)* */
+    divinationCard: PoeNinja;
+    /** Represents a submodule for essence item information. *(exchange)* */
+    essence: PoeNinja;
+    /** Represents a submodule for fossil item information. *(exchange)* */
+    fossil: PoeNinja;
+    /** Represents a submodule for incubator item information. */
+    incubator: PoeNinja;
+    /** Represents a submodule for map item information. */
+    map: PoeNinja;
+    /** Represents a submodule for oil item information. *(exchange)* */
+    oil: PoeNinja;
+    /** Represents a submodule for resonator item information. *(exchange)* */
+    resonator: PoeNinja;
+    /** Represents a submodule for scarab item information. *(exchange)* */
+    scarab: PoeNinja;
+    /** Represents a submodule for skill gem item information. */
+    skillGem: PoeNinja;
+    /** Represents a submodule for unique accessory item information. */
+    uniqueAccessory: PoeNinja;
+    /** Represents a submodule for unique armour item information. */
+    uniqueArmour: PoeNinja;
+    /** Represents a submodule for unique flask item information. */
+    uniqueFlask: PoeNinja;
+    /** Represents a submodule for unique jewel item information. */
+    uniqueJewel: PoeNinja;
+    /** Represents a submodule for unique map item information. */
+    uniqueMap: PoeNinja;
+    /** Represents a submodule for unique weapon item information. */
+    uniqueWeapon: PoeNinja;
+    /** Represents a submodule for vials item information. */
+    vials: PoeNinja;
+    /** Represents a submodule for omen item information. *(exchange)* */
+    omen: PoeNinja;
+    /** Represents a submodule for memory item information. */
+    memory: PoeNinja;
+    /** Represents a submodule for invitation item information. */
+    invitation: PoeNinja;
+    /** Represents a submodule for unique relics item information. */
+    uniqueRelics: PoeNinja;
+    /** Represents a submodule for cluster jewel item information. */
+    clusterJewel: PoeNinja;
+    /** Represents a submodule for blighted map item information. */
+    blightedMap: PoeNinja;
+    /** Represents a submodule for blight ravaged map item information. */
+    blightRavagedMap: PoeNinja;
+    /** Represents a submodule for coffin item information. */
+    coffin: PoeNinja;
+    /** Represents a submodule for allflame ember item information. *(exchange)* */
+    allflameEmber: PoeNinja;
     /**
      * Creates a new instance of ItemViewModule.
      * @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);
+    constructor(league: string);
 }