poe-api-manager 1.2.23 → 2.1.0

package/dist/lib/modules/poe.watch/WatchViewModule.d.ts

@@ -1,91 +1,53 @@
-import * as Modules from "./allModules/Modules";
+import PoeWatch from "../../AbstractClass/PoeWatch";
+import { AccessoryModule } from "./allModules/subModules/AccessoryModule";
+import { ArmourModule } from "./allModules/subModules/ArmourModule";
+import { BaseModule } from "./allModules/subModules/BaseModule";
+import { GemModule } from "./allModules/subModules/GemModule";
+import { WeaponModule } from "./allModules/subModules/WeaponModule";
 /**
  * Represents a module for fetching data related to Watchstones and Watchstone Regions.
  */
 export default class WatchViewModule {
-    /**
-     * Module for fetching data related to Currency.
-     */
-    currency: Modules.CurrencyModule;
-    /**
-     * Module for fetching data related to Accessories.
-     */
-    accessory: Modules.AccessoryModule;
-    /**
-     * Module for fetching data related to Armour.
-     */
-    armour: Modules.ArmourModule;
-    /**
-     * Module for fetching data related to Base.
-     */
-    base: Modules.BaseModule;
-    /**
-     * Module for fetching data related to Beast.
-     */
-    beast: Modules.BeastModule;
-    /**
-     * Module for fetching data related to DeliriumOrb.
-     */
-    deliriumOrb: Modules.DeliriumOrbModule;
-    /**
-     * Module for fetching data related to Divs.
-     */
-    divs: Modules.DivsModule;
-    /**
-     * Module for fetching data related to Essence.
-     */
-    essence: Modules.EssenceModule;
-    /**
-     * Module for fetching data related to Fossil.
-     */
-    fossil: Modules.FossilModule;
-    /**
-     * Module for fetching data related to Fragment.
-     */
-    fragment: Modules.FragmentModule;
-    /**
-     * Module for fetching data related to Map.
-     */
-    map: Modules.MapModule;
-    /**
-     * Module for fetching data related to Flask.
-     */
-    flask: Modules.FlaskModule;
-    /**
-     * Module for fetching data related to Jewel.
-     */
-    jewel: Modules.JewelModule;
-    /**
-     * Module for fetching data related to Gem.
-     */
-    gem: Modules.GemModule;
-    /**
-     * Module for fetching data related to Inscribed.
-     */
-    /**
-     * Module for fetching data related to Invitation.
-     */
-    invitation: Modules.InvitationModule;
-    /**
-     * Module for fetching data related to Oil.
-     */
-    oil: Modules.OilModule;
-    /**
-     * Module for fetching data related to Scarab.
-     */
-    scarab: Modules.ScarabModule;
-    /**
-     * Module for fetching data related to Sextant.
-     */
-    sextant: Modules.SextantModule;
-    /**
-     * Module for fetching data related to UniqueMaps.
-     */
-    uniqueMaps: Modules.UniqueMapsModule;
-    /**
-     * Module for fetching data related to Weapon.
-     */
-    weapon: Modules.WeaponModule;
+    /** Module for fetching data related to Currency. */
+    currency: PoeWatch;
+    /** Module for fetching data related to Accessories. */
+    accessory: AccessoryModule;
+    /** Module for fetching data related to Armour. */
+    armour: ArmourModule;
+    /** Module for fetching data related to Base. */
+    base: BaseModule;
+    /** Module for fetching data related to Beast. */
+    beast: PoeWatch;
+    /** Module for fetching data related to DeliriumOrb. */
+    deliriumOrb: PoeWatch;
+    /** Module for fetching data related to Divs. */
+    divs: PoeWatch;
+    /** Module for fetching data related to Essence. */
+    essence: PoeWatch;
+    /** Module for fetching data related to Fossil. */
+    fossil: PoeWatch;
+    /** Module for fetching data related to Fragment. */
+    fragment: PoeWatch;
+    /** Module for fetching data related to Map. */
+    map: PoeWatch;
+    /** Module for fetching data related to Flask. */
+    flask: PoeWatch;
+    /** Module for fetching data related to Jewel. */
+    jewel: PoeWatch;
+    /** Module for fetching data related to Gem. */
+    gem: GemModule;
+    /** Module for fetching data related to Invitation. */
+    invitation: PoeWatch;
+    /** Module for fetching data related to Oil. */
+    oil: PoeWatch;
+    /** Module for fetching data related to Scarab. */
+    scarab: PoeWatch;
+    /** Module for fetching data related to Sextant. */
+    sextant: PoeWatch;
+    /** Module for fetching data related to UniqueMaps. */
+    uniqueMaps: PoeWatch;
+    /** Module for fetching data related to Weapon. */
+    weapon: WeaponModule;
     /**
      * Creates an instance of WatchWievModule.
      * @param league - The league name to fetch data from.

package/dist/lib/modules/poe.watch/WatchViewModule.js

@@ -1,143 +1,93 @@
 "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("./allModules/Modules"));
+const PoeWatchLeaf_1 = __importDefault(require("../../AbstractClass/PoeWatchLeaf"));
+const AccessoryModule_1 = require("./allModules/subModules/AccessoryModule");
+const ArmourModule_1 = require("./allModules/subModules/ArmourModule");
+const BaseModule_1 = require("./allModules/subModules/BaseModule");
+const GemModule_1 = require("./allModules/subModules/GemModule");
+const WeaponModule_1 = require("./allModules/subModules/WeaponModule");
+/**
+ * Maps each generic (no getCategory) view property to its poe.watch `type`
+ * (category) value. accessory/armour/base/gem/weapon have getCategory and
+ * keep their own classes below.
+ */
+const GENERIC_TYPES = {
+    currency: "currency",
+    beast: "beast",
+    deliriumOrb: "deliriumOrb",
+    divs: "card",
+    essence: "essence",
+    fossil: "fossil",
+    fragment: "fragment",
+    map: "map",
+    flask: "flask",
+    jewel: "jewel",
+    invitation: "invitation",
+    oil: "oil",
+    scarab: "scarab",
+    sextant: "sextans",
+    uniqueMaps: "uniqueMap",
+};
 /**
  * Represents a module for fetching data related to Watchstones and Watchstone Regions.
  */
 class WatchViewModule {
-    /**
-     * Module for fetching data related to Currency.
-     */
+    /** Module for fetching data related to Currency. */
     currency;
-    /**
-     * Module for fetching data related to Accessories.
-     */
+    /** Module for fetching data related to Accessories. */
     accessory;
-    /**
-     * Module for fetching data related to Armour.
-     */
+    /** Module for fetching data related to Armour. */
     armour;
-    /**
-     * Module for fetching data related to Base.
-     */
+    /** Module for fetching data related to Base. */
     base;
-    /**
-     * Module for fetching data related to Beast.
-     */
+    /** Module for fetching data related to Beast. */
     beast;
-    /**
-     * Module for fetching data related to DeliriumOrb.
-     */
+    /** Module for fetching data related to DeliriumOrb. */
     deliriumOrb;
-    /**
-     * Module for fetching data related to Divs.
-     */
+    /** Module for fetching data related to Divs. */
     divs;
-    /**
-     * Module for fetching data related to Essence.
-     */
+    /** Module for fetching data related to Essence. */
     essence;
-    /**
-     * Module for fetching data related to Fossil.
-     */
+    /** Module for fetching data related to Fossil. */
     fossil;
-    /**
-     * Module for fetching data related to Fragment.
-     */
+    /** Module for fetching data related to Fragment. */
     fragment;
-    /**
-     * Module for fetching data related to Map.
-     */
+    /** Module for fetching data related to Map. */
     map;
-    /**
-     * Module for fetching data related to Flask.
-     */
+    /** Module for fetching data related to Flask. */
     flask;
-    /**
-     * Module for fetching data related to Jewel.
-     */
+    /** Module for fetching data related to Jewel. */
     jewel;
-    /**
-     * Module for fetching data related to Gem.
-     */
+    /** Module for fetching data related to Gem. */
     gem;
-    /**
-     * Module for fetching data related to Inscribed.
-     */
-    //public inscribed: Modules.InscribedModule;
-    /**
-     * Module for fetching data related to Invitation.
-     */
+    /** Module for fetching data related to Invitation. */
     invitation;
-    /**
-     * Module for fetching data related to Oil.
-     */
+    /** Module for fetching data related to Oil. */
     oil;
-    /**
-     * Module for fetching data related to Scarab.
-     */
+    /** Module for fetching data related to Scarab. */
     scarab;
-    /**
-     * Module for fetching data related to Sextant.
-     */
+    /** Module for fetching data related to Sextant. */
     sextant;
-    /**
-     * Module for fetching data related to UniqueMaps.
-     */
+    /** Module for fetching data related to UniqueMaps. */
     uniqueMaps;
-    /**
-     * Module for fetching data related to Weapon.
-     */
+    /** Module for fetching data related to Weapon. */
     weapon;
     /**
      * Creates an instance of WatchWievModule.
      * @param league - The league name to fetch data from.
      */
     constructor(league) {
-        this.currency = new Modules.CurrencyModule(league);
-        this.accessory = new Modules.AccessoryModule(league);
-        this.armour = new Modules.ArmourModule(league);
-        this.base = new Modules.BaseModule(league);
-        this.beast = new Modules.BeastModule(league);
-        this.essence = new Modules.EssenceModule(league);
-        this.fossil = new Modules.FossilModule(league);
-        this.fragment = new Modules.FragmentModule(league);
-        this.map = new Modules.MapModule(league);
-        this.flask = new Modules.FlaskModule(league);
-        this.jewel = new Modules.JewelModule(league);
-        this.gem = new Modules.GemModule(league);
-        this.invitation = new Modules.InvitationModule(league);
-        this.oil = new Modules.OilModule(league);
-        this.scarab = new Modules.ScarabModule(league);
-        this.sextant = new Modules.SextantModule(league);
-        this.weapon = new Modules.WeaponModule(league);
-        this.uniqueMaps = new Modules.UniqueMapsModule(league);
-        this.deliriumOrb = new Modules.DeliriumOrbModule(league);
-        this.divs = new Modules.DivsModule(league);
-        //this.inscribed = new Modules.InscribedModule(league);- not now
+        Object.keys(GENERIC_TYPES).forEach((key) => {
+            this[key] = new PoeWatchLeaf_1.default(league, GENERIC_TYPES[key]);
+        });
+        this.accessory = new AccessoryModule_1.AccessoryModule(league);
+        this.armour = new ArmourModule_1.ArmourModule(league);
+        this.base = new BaseModule_1.BaseModule(league);
+        this.gem = new GemModule_1.GemModule(league);
+        this.weapon = new WeaponModule_1.WeaponModule(league);
     }
 }
 exports.default = WatchViewModule;

package/dist/lib/modules/poe.watch/allModules/subModules/AccessoryModule.js

@@ -27,12 +27,7 @@ class AccessoryModule extends PoeWatch_1.default {
      * @throws - Throws errors encountered while fetching data.
      */
     async getCategory(categoryName) {
-        try {
-            return await (0, getCategory_1.default)(this.league, this.type, categoryName);
-        }
-        catch (error) {
-            throw new Error(`Error fetching Accessory data: ${error.message}`);
-        }
+        return await (0, getCategory_1.default)(this.league, this.type, categoryName);
     }
 }
 exports.AccessoryModule = AccessoryModule;

package/dist/lib/modules/poe.watch/allModules/subModules/ArmourModule.js

@@ -27,12 +27,7 @@ class ArmourModule extends PoeWatch_1.default {
      * @throws - Throws errors encountered while fetching data.
      */
     async getCategory(categoryName) {
-        try {
-            return await (0, getCategory_1.default)(this.league, this.type, categoryName);
-        }
-        catch (error) {
-            throw new Error(`Error fetching Accessory data: ${error.message}`);
-        }
+        return await (0, getCategory_1.default)(this.league, this.type, categoryName);
     }
 }
 exports.ArmourModule = ArmourModule;

package/dist/lib/modules/poe.watch/allModules/subModules/BaseModule.js

@@ -27,12 +27,7 @@ class BaseModule extends PoeWatch_1.default {
      * @throws - Throws errors encountered while fetching data.
      */
     async getCategory(categoryName) {
-        try {
-            return await (0, getCategory_1.default)(this.league, this.type, categoryName);
-        }
-        catch (error) {
-            throw new Error(`Error fetching Accessory data: ${error.message}`);
-        }
+        return await (0, getCategory_1.default)(this.league, this.type, categoryName);
     }
 }
 exports.BaseModule = BaseModule;

package/dist/lib/modules/poe.watch/allModules/subModules/GemModule.js

@@ -27,12 +27,7 @@ class GemModule extends PoeWatch_1.default {
      * @throws - Throws errors encountered while fetching data.
      */
     async getCategory(categoryName) {
-        try {
-            return await (0, getCategory_1.default)(this.league, this.type, categoryName);
-        }
-        catch (error) {
-            throw new Error(`Error fetching Accessory data: ${error.message}`);
-        }
+        return await (0, getCategory_1.default)(this.league, this.type, categoryName);
     }
 }
 exports.GemModule = GemModule;

package/dist/lib/modules/poe.watch/allModules/subModules/WeaponModule.js

@@ -27,12 +27,7 @@ class WeaponModule extends PoeWatch_1.default {
      * @throws - Throws errors encountered while fetching data.
      */
     async getCategory(categoryName) {
-        try {
-            return await (0, getCategory_1.default)(this.league, this.type, categoryName);
-        }
-        catch (error) {
-            throw new Error(`Error fetching Accessory data: ${error.message}`);
-        }
+        return await (0, getCategory_1.default)(this.league, this.type, categoryName);
     }
 }
 exports.WeaponModule = WeaponModule;

package/dist/lib/modules/poe.watch/fetch/watchFetch.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 const ApiError_1 = __importDefault(require("../../../errors/ApiError"));
 const WatchUrlGenerator_1 = __importDefault(require("../func/WatchUrlGenerator"));
+const httpGet_1 = __importDefault(require("../../utils/httpGet"));
 /**
  * Fetches data from the POE Watch API based on the provided query URL.
  * @param league - The game league for which to fetch currency data.
@@ -16,11 +17,7 @@ const WatchUrlGenerator_1 = __importDefault(require("../func/WatchUrlGenerator")
 async function fetchData(league, type) {
     try {
         const url = (0, WatchUrlGenerator_1.default)(league, type);
-        const response = await axios_1.default.get(url, {
-            headers: {
-                "Accept-Encoding": "identity",
-            },
-        });
+        const response = await (0, httpGet_1.default)(url);
         if (response.data) {
             return response.data;
         }

package/dist/lib/modules/poe.watch/func/WatchUrlGenerator.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = urlGenerator;
 /**
  * Generates a URL based on league and type. poe.watch API is used.
  * @param {string} league - The league for which the URL is generated.
@@ -7,6 +8,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * @returns {string} - The generated URL.
  */
 function urlGenerator(league, type) {
-    return `https://api.poe.watch/get?category=${type}&league=${league}`;
+    return `https://api.poe.watch/get?category=${encodeURIComponent(type)}&league=${encodeURIComponent(league)}`;
 }
-exports.default = urlGenerator;

package/dist/lib/modules/poe.watch/func/getCategory.js

@@ -5,6 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const watchFetch_1 = __importDefault(require("../fetch/watchFetch"));
 const ValidationError_1 = __importDefault(require("../../../errors/ValidationError"));
+const ApiError_1 = __importDefault(require("../../../errors/ApiError"));
+const CustomError_1 = __importDefault(require("../../../errors/CustomError"));
 /**
  * Fetches data based on the provided query URL and filters it by category name.
  * @param league - The league to fetch the data from.
@@ -36,11 +38,12 @@ async function getCategory(league, type, categoryName) {
         return filteredData;
     }
     catch (error) {
-        // If it's already a custom error, pass it through
-        if (error instanceof ValidationError_1.default) {
+        // If it's already a custom error (validation, api, ...), pass it through unchanged
+        if (error instanceof CustomError_1.default) {
             throw error;
         }
-        throw new ValidationError_1.default(`Error fetching or filtering data for category: ${error.message}`, 400, { league, type, categoryName });
+        // Only genuinely unknown errors (network failures, etc.) get wrapped, as a 500
+        throw new ApiError_1.default(`Error fetching or filtering data for category: ${error.message}`, 500, { league, type, categoryName });
     }
 }
 exports.default = getCategory;

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

@@ -15,20 +15,15 @@ const propertyFilter_1 = __importDefault(require("../../../mainfunctions/propert
  * @throws - Throws an error if there is an issue fetching or filtering the data.
  */
 async function getData(league, type, requestedProperties) {
-    try {
-        const fetchedData = await (0, watchFetch_1.default)(league, type);
-        // If requestedProperties are specified, filter the data based on those properties
-        if (requestedProperties && requestedProperties.length > 0) {
-            const result = (0, propertyFilter_1.default)(fetchedData, requestedProperties);
-            return result;
-        }
-        else {
-            // If no specific properties are requested, return the entire fetched data
-            return fetchedData;
-        }
+    const fetchedData = await (0, watchFetch_1.default)(league, type);
+    // If requestedProperties are specified, filter the data based on those properties
+    if (requestedProperties && requestedProperties.length > 0) {
+        const result = (0, propertyFilter_1.default)(fetchedData, requestedProperties);
+        return result;
     }
-    catch (error) {
-        throw new Error(`Error fetching data: ${error.message}`);
+    else {
+        // If no specific properties are requested, return the entire fetched data
+        return fetchedData;
     }
 }
 exports.default = getData;

package/dist/lib/modules/poe.watch/poe2/Poe2ExchangeModule.d.ts

@@ -0,0 +1,30 @@
+import IPoeWatch from "../../../Interfaces/IPoeWatch";
+/**
+ * Represents poe.watch's PoE2 exchange ratios - the only PoE2 endpoint
+ * poe.watch exposes.
+ * @class
+ * @implements {IPoeWatch}
+ */
+export default class Poe2ExchangeModule implements IPoeWatch {
+    protected readonly league: string;
+    /**
+     * Creates a new instance of Poe2ExchangeModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league: string);
+    /**
+     * Retrieves PoE2 exchange ratios data.
+     * @param {string[]} requestedProperties Optional array of properties to include in the response.
+     * @returns {Promise<object[]>} A promise that resolves to an array of objects containing the requested data.
+     * @throws {Error} If there is an error retrieving the data.
+     */
+    getData(requestedProperties?: string[]): Promise<object[]>;
+    /**
+     * Retrieves PoE2 exchange ratios filtered by category.
+     * @async
+     * @param categoryName - The category to filter by (e.g. "currency").
+     * @returns - A Promise containing data for the specified category.
+     * @throws - Throws errors encountered while fetching data.
+     */
+    getCategory(categoryName: string): Promise<object[]>;
+}

package/dist/lib/modules/poe.watch/poe2/Poe2ExchangeModule.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ApiError_1 = __importDefault(require("../../../errors/ApiError"));
+const CustomError_1 = __importDefault(require("../../../errors/CustomError"));
+const getData2_1 = __importDefault(require("./getData2"));
+const getCategory2_1 = __importDefault(require("./getCategory2"));
+/**
+ * Represents poe.watch's PoE2 exchange ratios - the only PoE2 endpoint
+ * poe.watch exposes.
+ * @class
+ * @implements {IPoeWatch}
+ */
+class Poe2ExchangeModule {
+    league;
+    /**
+     * Creates a new instance of Poe2ExchangeModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        this.league = league;
+    }
+    /**
+     * Retrieves PoE2 exchange ratios data.
+     * @param {string[]} requestedProperties Optional array of properties to include in the response.
+     * @returns {Promise<object[]>} A promise that resolves to an array of objects containing the requested data.
+     * @throws {Error} If there is an error retrieving the data.
+     */
+    async getData(requestedProperties) {
+        try {
+            return await (0, getData2_1.default)(this.league, requestedProperties);
+        }
+        catch (error) {
+            if (error instanceof CustomError_1.default) {
+                throw error;
+            }
+            throw new ApiError_1.default(`Error retrieving PoE2 exchange data: ${error.message}`, 500, { league: this.league });
+        }
+    }
+    /**
+     * Retrieves PoE2 exchange ratios filtered by category.
+     * @async
+     * @param categoryName - The category to filter by (e.g. "currency").
+     * @returns - A Promise containing data for the specified category.
+     * @throws - Throws errors encountered while fetching data.
+     */
+    async getCategory(categoryName) {
+        return await (0, getCategory2_1.default)(this.league, categoryName);
+    }
+}
+exports.default = Poe2ExchangeModule;

package/dist/lib/modules/poe.watch/poe2/filterByCategory.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Filters PoE2 exchange ratio items by their `category` field. Note this is
+ * `category`, not `group` - the field the PoE1 getCategory filters on -
+ * because the PoE2 ratios response uses a different field name.
+ * @param items The items to filter.
+ * @param categoryName The category value to match.
+ * @returns The matching items.
+ */
+export default function filterByCategory(items: any[], categoryName: string): any[];

package/dist/lib/modules/poe.watch/poe2/filterByCategory.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = filterByCategory;
+/**
+ * Filters PoE2 exchange ratio items by their `category` field. Note this is
+ * `category`, not `group` - the field the PoE1 getCategory filters on -
+ * because the PoE2 ratios response uses a different field name.
+ * @param items The items to filter.
+ * @param categoryName The category value to match.
+ * @returns The matching items.
+ */
+function filterByCategory(items, categoryName) {
+    return items.filter((item) => item.category === categoryName);
+}

package/dist/lib/modules/poe.watch/poe2/getCategory2.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Fetches PoE2 exchange ratios and filters them by category.
+ * @param league - The league to fetch the data from.
+ * @param categoryName - The category to filter by (matches the `category` field).
+ * @returns A promise that resolves to an array of filtered items.
+ * @throws Throws a ValidationError if category name is missing or matches nothing.
+ */
+declare function getCategory2(league: string, categoryName: string): Promise<object[]>;
+export default getCategory2;