poe-api-manager 1.2.4 → 1.2.12

package/src/lib/modules/AbstractClass/PoeWatch.ts

@@ -0,0 +1,26 @@
+import IPoeWatch from "../Interfaces/IPoeWatch";
+import getData from "../poe.watch/allModules/func/getData";
+
+/**
+ * Represents an abstract class for interacting with the PoeWatch API.
+ */
+abstract class PoeWatch implements IPoeWatch {
+    constructor(protected readonly league: string, protected readonly type: string) {
+    }
+
+    /**
+     * Retrieves data from the PoeWatch API.
+     * @param requestedProperties Optional array of properties to include in the response.
+     * @returns A promise that resolves to an array of objects containing the requested data.
+     * @throws If there is an error retrieving the data.
+     */
+    public async getData(requestedProperties?: string[]): Promise<object[]> {
+        try {
+            return getData(this.league, this.type, requestedProperties);
+        } catch (error: any) {
+            throw new Error(`Error retrieving ${this.type} data: ${error.message}`);
+        }
+    }
+}
+
+export default PoeWatch;

package/src/lib/modules/Interfaces/IPoeNinja.ts

@@ -0,0 +1,13 @@
+/**
+ * Represents the interface for interacting with the PoeNinja API.
+ */
+interface IPoeNinja {
+    /**
+     * Retrieves data from the PoeNinja API.
+     * @param requestedProperties Optional array of properties to include in the response.
+     * @returns A promise that resolves to the retrieved data.
+     */
+    getData(requestedProperties?: string[]): Promise<object[]>;
+}
+
+export default IPoeNinja;

package/src/lib/modules/Interfaces/IPoeWatch.ts

@@ -0,0 +1,13 @@
+/**
+ * Represents the interface for interacting with PoeWatch data.
+ */
+interface IPoeWatch {
+    /**
+     * Retrieves data from PoeWatch API.
+     * @param requestedProperties Optional array of properties to include in the response.
+     * @returns A promise that resolves to an array of objects representing the retrieved data.
+     */
+    getData(requestedProperties?: string[]): Promise<object[]>;
+}
+
+export default IPoeWatch;

package/src/lib/modules/mainfunctions/propertyFilter.ts

@@ -0,0 +1,25 @@
+/**
+ * Filters properties of objects in an array based on the specified properties.
+ * @param data The array of objects to filter.
+ * @param requestedProperties The array of property names to include in the result.
+ * @returns An array of objects with only the specified properties.
+ */
+export default function filterProperties(data: Record<string, any>[], requestedProperties: string[]): object[] {
+    const result: object[] = [];
+  
+    data.forEach((item) => {
+      const itemResult: Record<string, any> = {};
+  
+      requestedProperties.forEach((prop) => {
+        if (Object.prototype.hasOwnProperty.call(item, prop)) {
+          itemResult[prop] = item[prop];
+        } else {
+          console.warn(`Property not found: ${prop}`);
+        }
+      });
+  
+      result.push(itemResult);
+    });
+  
+    return result;
+  }

package/src/lib/modules/poe.ninja/currencyView/CurrencyViewModule.ts

@@ -0,0 +1,26 @@
+import { CurrencyModule, FragmentModule } from "./currencySubModules/CurrencySubModules";
+
+/**
+ * Represents a module for fetching currency overview data.
+ */
+export class CurrencyViewModule {
+  /**
+   * Represents a module for fetching currency data.
+   */
+  public currency: CurrencyModule;
+
+  /**
+   * Represents a module for fetching fragment data.
+   */
+  public fragment: FragmentModule;
+
+  /**
+   * 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) {
+    this.currency = new CurrencyModule(league, typeName);
+    this.fragment = new FragmentModule(league, typeName);
+  }
+}

package/src/lib/modules/poe.ninja/currencyView/currencySubModules/CurrencySubModules.ts

@@ -0,0 +1,7 @@
+import CurrencyModule from "./submodules/CurrencyModule";
+import FragmentModule  from "./submodules/FragmentModule";
+
+export {
+  CurrencyModule,
+  FragmentModule,
+};

package/src/lib/modules/poe.ninja/currencyView/currencySubModules/submodules/CurrencyModule.ts

@@ -0,0 +1,33 @@
+import PoeNinja from "../../../../AbstractClass/PoeNinja";
+import getQuickCurrency from "../../../func/getQuickCurrency";
+
+/**
+ * Represents a module for retrieving currency data from the PoeNinja API.
+ */
+class CurrencyModule extends PoeNinja {
+  /**
+   * Creates an instance of CurrencyModule.
+   * @param league - The name of the league.
+   * @param typeName - The name of the type.
+   */
+  constructor(protected league: string, protected typeName: string) {
+    const type: string = "Currency";
+    super(league, typeName, type);
+  }
+
+  /**
+   * Retrieves the quick currency data for the specified currency type.
+   * @param currencyTypeName - The name of the currency. Defaults to "Divine Orb".
+   * @returns A promise that resolves to an object containing the currency type name and its chaos equivalent value.
+   * @throws If there is an error fetching the quick currency data.
+   */
+  async getQuickCurrency(currencyTypeName: string = "Divine Orb"): Promise<{ currencyTypeName: string, chaosEquivalent: number }> {
+    try {
+      return await getQuickCurrency(this.league, this.typeName, this.type, currencyTypeName);
+    } catch (error: any) {
+      throw new Error(`Error fetching QuickCurrencyData ${this.type} and Currency Name:${currencyTypeName} data: ${error.message}`);
+    }
+  }
+}
+
+export default CurrencyModule;

package/src/lib/modules/poe.ninja/currencyView/currencySubModules/submodules/FragmentModule.ts

@@ -0,0 +1,18 @@
+import PoeNinja from "../../../../AbstractClass/PoeNinja";
+
+/**
+ * Represents a module for handling fragments in the PoeNinja currency view.
+ */
+class FragmentModule extends PoeNinja {
+  /**
+   * Creates an instance of FragmentModule.
+   * @param league The league for which the module is created.
+   * @param typeName The type name of the module.
+   */
+  constructor(protected league: string, protected typeName: string) {
+    const type: string = "Fragment";
+    super(league, typeName, type);
+  }
+}
+
+export default FragmentModule;

package/src/lib/modules/poe.ninja/fetch/fetchData.ts

@@ -0,0 +1,51 @@
+import axios from "axios";
+import mergeData from "./merge/mergeData";
+import urlGenerator from "../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: string, typeName: string, type: string): Promise<object[]> {
+    try {
+        // Generate the URL for the specified league, type name, and type
+        const url: string = urlGenerator(league, typeName, type);
+        //axios.get(url) is a promise
+        const response = await axios.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: any[] = response.data.lines;
+                const currencyDetails: any[] = response.data.currencyDetails;
+                //the join data is the currencyDetails
+                return mergeData(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: any) {
+        throw new Error(`Error fetching data: ${error.message} TypeName:${typeName} and Type:${type}`);
+    }
+}
+
+export default fetchData;

package/src/lib/modules/poe.ninja/fetch/merge/mergeData.ts

@@ -0,0 +1,35 @@
+/**
+ * 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: any[], currencyDetails: any[]): any[] {
+    const mergedData: any[] = [];
+
+    lines.forEach((line) => {
+        const currencyType: string = 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: any = {
+                ...line,
+                id: currencyDetail.id,
+                icon: currencyDetail.icon,
+                name: currencyDetail.name,
+            };
+
+            // Add the merged item to the result array
+            mergedData.push(mergedItem);
+        }
+    });
+
+    return mergedData;
+}
+
+export default mergeData;

package/src/lib/modules/poe.ninja/func/getData.ts

@@ -0,0 +1,30 @@
+import fetchData from '../fetch/fetchData';
+import filterProperties from '../../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: string, typeName: string, type: string, requestedProperties?: string[]): Promise<object[]> {
+    try {
+        const fetchedData: object[] = await fetchData(league, typeName, type);
+
+        //if requestedProperties use filterProperties to filter fetchedData
+        if (requestedProperties) {
+            const result: object[] = filterProperties(fetchedData, requestedProperties);
+            return result;
+        } else {
+            return fetchedData;
+        }
+    } catch (error) {
+        throw new Error(`Type:${type} Error fetching data: ${(error as Error).message}`);
+    }
+}
+
+export default getData;

package/src/lib/modules/poe.ninja/func/getQuickCurrency.ts

@@ -0,0 +1,30 @@
+import fetchData from "../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: string, typeName: string, type: string, currencyTypeName: string): Promise<{ currencyTypeName: string, chaosEquivalent: number }> {
+    try {
+        const fetchedData = await fetchData(league, typeName, type) as { currencyTypeName: string, chaosEquivalent: number }[];
+        //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 as Error).message}`);
+    }
+}
+
+export default getQuickCurrency;

package/src/lib/modules/poe.ninja/func/urlGenerator.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 {
+    return `https://poe.ninja/api/data/${typeName}?league=${league}&type=${type}`;
+}

package/src/lib/modules/poe.ninja/itemView/ItemViewModule.ts

@@ -0,0 +1,188 @@
+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.
+ */
+export class ItemViewModule {
+  /**
+   * Represents a submodule for base type item information.
+   */
+  public baseType: BaseTypeModule;
+
+  /**
+   * Represents a submodule for beast item information.
+   */
+  public beast: BeastModule;
+
+  /**
+   * Represents a submodule for delirium orbs item information.
+   */
+  public deliriumOrbs: DeliriumOrbsModule;
+
+  /**
+   * Represents a submodule for divination card item information.
+   */
+  public divinationCard: DivinationCardModule;
+
+  /**
+   * Represents a submodule for essence item information.
+   */
+  public essence: EssenceModule;
+
+  /**
+   * Represents a submodule for fossil item information.
+   */
+  public fossil: FossilModule;
+
+  /**
+   * Represents a submodule for helmet enchant item information.
+   */
+  public helmetEnchant: HelmetEnchantModule;
+
+  /**
+   * Represents a submodule for incubator item information.
+   */
+  public incubator: IncubatorModule;
+
+  /**
+   * Represents a submodule for map item information.
+   */
+  public map: MapModule;
+
+  /**
+   * Represents a submodule for oil item information.
+   */
+  public oil: OilModule;
+
+  /**
+   * Represents a submodule for resonator item information.
+   */
+  public resonator: ResonatorModule;
+
+  /**
+   * Represents a submodule for scarab item information.
+   */
+  public scarab: ScarabModule;
+
+  /**
+   * Represents a submodule for skill gem item information.
+   */
+  public skillGem: SkillGemModule;
+
+  /**
+   * Represents a submodule for unique accessory item information.
+   */
+  public uniqueAccessory: UniqueAccessoryModule;
+
+  /**
+   * Represents a submodule for unique armour item information.
+   */
+  public uniqueArmour: UniqueArmourModule;
+
+  /**
+   * Represents a submodule for unique flask item information.
+   */
+  public uniqueFlask: UniqueFlaskModule;
+
+  /**
+   * Represents a submodule for unique jewel item information.
+   */
+  public uniqueJewel: UniqueJewelModule;
+
+  /**
+   * Represents a submodule for unique map item information.
+   */
+  public uniqueMap: UniqueMapModule;
+
+  /**
+   * Represents a submodule for unique weapon item information.
+   */
+  public uniqueWeapon: UniqueWeaponModule;
+
+  /**
+   * Represents a submodule for vials item information.
+   */
+  public vials: VialsModule;
+
+  /**
+   * Represents a submodule for omen item information.
+   */
+  public omen: OmenModule;
+
+  /**
+   * Represents a submodule for memory item information.
+   */
+  public memory: MemoryModule;
+
+  /**
+   * Represents a submodule for invitation item information.
+   */
+  public invitation: InvitationModule;
+
+  /**
+   * Represents a submodule for unique relics item information.
+   */
+  public uniqueRelics: UniqueRelicsModule;
+
+  /**
+   * Represents a submodule for cluster jewel item information.
+   */
+  public clusterJewel: ClusterJewelModule;
+
+  /**
+   * Represents a submodule for blighted map item information.
+   */
+  public blightedMap: BlightedMapModule;
+
+  /**
+   * Represents a submodule for blight ravaged map item information.
+   */
+  public blightRavagedMap: BlightRavagedMapModule;
+
+  /**
+   * Represents a submodule for coffin item information.
+   */
+  public coffin: CoffinModule;
+
+  /**
+   * Creates an instance of AllflameEmberModule.
+   */
+  public 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) {
+    this.baseType = new BaseTypeModule(league, typeName);
+    this.beast = new BeastModule(league, typeName);
+    this.deliriumOrbs = new DeliriumOrbsModule(league, typeName);
+    this.divinationCard = new DivinationCardModule(league, typeName);
+    this.essence = new EssenceModule(league, typeName);
+    this.fossil = new FossilModule(league, typeName);
+    this.helmetEnchant = new HelmetEnchantModule(league, typeName);
+    this.incubator = new IncubatorModule(league, typeName);
+    this.map = new MapModule(league, typeName);
+    this.oil = new OilModule(league, typeName);
+    this.resonator = new ResonatorModule(league, typeName);
+    this.scarab = new ScarabModule(league, typeName);
+    this.skillGem = new SkillGemModule(league, typeName);
+    this.uniqueAccessory = new UniqueAccessoryModule(league, typeName);
+    this.uniqueArmour = new UniqueArmourModule(league, typeName);
+    this.uniqueFlask = new UniqueFlaskModule(league, typeName);
+    this.uniqueJewel = new UniqueJewelModule(league, typeName);
+    this.uniqueMap = new UniqueMapModule(league, typeName);
+    this.uniqueWeapon = new UniqueWeaponModule(league, typeName);
+    this.vials = new VialsModule(league, typeName);
+    this.omen = new OmenModule(league, typeName);
+    this.memory = new MemoryModule(league, typeName);
+    this.invitation = new InvitationModule(league, typeName);
+    this.uniqueRelics = new UniqueRelicsModule(league, typeName);
+    this.clusterJewel = new ClusterJewelModule(league, typeName);
+    this.blightedMap = new BlightedMapModule(league, typeName);
+    this.blightRavagedMap = new BlightRavagedMapModule(league, typeName);
+    this.coffin = new CoffinModule(league, typeName);
+    this.allflameEmber = new AllflameEmberModule(league, typeName);
+  }
+}

package/src/lib/modules/poe.ninja/itemView/itemSubmodules/itemSubModules.ts

@@ -0,0 +1,61 @@
+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
+};

package/src/lib/modules/poe.ninja/itemView/itemSubmodules/subModules/AllflameEmberModule.ts

@@ -0,0 +1,18 @@
+import PoeNinja from "../../../../AbstractClass/PoeNinja";
+/**
+ * Represents a module for handling Allflame Ember items in the PoeNinja library.
+ */
+class AllflameEmberModule extends PoeNinja {
+    /**
+     * Creates an instance of AllflameEmberModule.
+     * @param league - The league name.
+     * @param typeName - The type name.
+     */
+    constructor(league: string, typeName: string) {
+        // The type name.
+        const type: string = "AllflameEmber";
+        super(league, typeName, type);
+    }
+}
+
+export default AllflameEmberModule;

package/src/lib/modules/poe.ninja/itemView/itemSubmodules/subModules/BaseTypeModule.ts

@@ -0,0 +1,19 @@
+import PoeNinja from "../../../../AbstractClass/PoeNinja";
+
+/**
+ * Represents a module for handling base types.
+ */
+class BaseTypeModule extends PoeNinja {
+  /**
+   * Creates an instance of BaseTypeModule.
+   * @param league - The league name.
+   * @param typeName - The type name.
+   */
+  constructor(league: string, typeName: string) {
+    // The type name.
+    const type: string = "BaseType";
+    super(league, typeName, type);
+  }
+}
+
+export default BaseTypeModule;

package/src/lib/modules/poe.ninja/itemView/itemSubmodules/subModules/BeastModule.ts

@@ -0,0 +1,20 @@
+import PoeNinja from "../../../../AbstractClass/PoeNinja";
+
+/**
+ * Represents a module for handling beasts.
+ */
+class BeastModule extends PoeNinja {
+
+  /**
+   * Creates an instance of BeastModule.
+   * @param league - The league name.
+   * @param typeName - The type name.
+   */
+  constructor(league: string, typeName: string) {
+    // The type name.
+    const type: string = "Beast";
+    super(league, typeName, type);
+  }
+}
+
+export default BeastModule;

package/src/lib/modules/poe.ninja/itemView/itemSubmodules/subModules/BlightRavagedMapModule.ts

@@ -0,0 +1,19 @@
+import PoeNinja from "../../../../AbstractClass/PoeNinja";
+
+/**
+ * Represents a module for handling blighted ravaged maps.
+ */
+class BlightedRavagedMapModule extends PoeNinja {
+  /**
+   * Creates an instance of BlightedRavagedMapModule.
+   * @param league - The league name.
+   * @param typeName - The type name.
+   */
+  constructor(league: string, typeName: string) {
+    // The type name.
+    const type: string = "BlightedRavagedMap";
+    super(league, typeName, type);
+  }
+}
+
+export default BlightedRavagedMapModule;