poe-api-manager 1.2.4 → 1.2.12

package/src/lib/modules/poe.watch/allModules/fetch/watchFetch.ts

@@ -0,0 +1,30 @@
+import axios from "axios";
+import WatchUrlGenerator from "../func/WatchUrlGenerator";
+
+/**
+ * Fetches data from the POE Watch API based on the provided query URL.
+ * @param league - The game league for which to fetch currency data.
+ * @param type - The type of data to fetch.
+ * @returns - A Promise that resolves to the fetched data.
+ * @throws - Throws an error if there is an issue with the API response or fetching data.
+ */
+async function fetchData(league: string, type: string): Promise<object[]> {
+  try {
+    const url: string = WatchUrlGenerator(league, type);
+    const response = await axios.get(url, {
+      headers: {
+        'Accept-Encoding': 'identity',
+      },
+    });
+
+    if (response.data) {
+      return response.data;
+    } else {
+      throw new Error("Invalid response format from POE Watch API");
+    }
+  } catch (error) {
+    throw new Error(`Error fetching data from poe.watch: ${(error as Error).message}`);
+  }
+}
+
+export default fetchData;

package/src/lib/modules/poe.watch/allModules/func/WatchUrlGenerator.ts

@@ -0,0 +1,10 @@
+/**
+ * Generates a URL based on league and type. poe.watch API is used.
+ * @param {string} league - The league for which the URL is generated.
+ * @param {string} type - The type of data for which the URL is generated.
+ * @returns {string} - The generated URL.
+ */
+export default function urlGenerator(league: string, type: string): string {
+    return `https://api.poe.watch/get?category=${type}&league=${league}`;
+  }
+  

package/src/lib/modules/poe.watch/allModules/func/getCategory.ts

@@ -0,0 +1,34 @@
+import fetchData from "../fetch/watchFetch";
+
+/**
+ * Fetches data based on the provided query URL and filters it by category name.
+ * @param league - The league to fetch the data from.
+ * @param type - The type of data to fetch.
+ * @param categoryName - The name of the category to filter the data by.
+ * @returns A promise that resolves to an array of filtered data items.
+ * @throws Throws an error if category name is not provided or if there is an issue fetching or filtering the data.
+ */
+async function getCategory(league: string, type: string, categoryName: string): Promise<object[]>{
+  try {
+    const fetchedData: object[] = await fetchData(league ,type);
+
+    // Validate category name
+    if (!categoryName && categoryName !== "0") {
+      throw new Error("Category name is required.");
+    }
+
+    // Filter data by category name
+    const filteredData: object[] = fetchedData.filter((item: any) => item.group === categoryName);
+
+    // Check if filtered data is empty
+    if (filteredData.length === 0) {
+      throw new Error(`No data found for category: ${categoryName}`);
+    }
+
+    return filteredData;
+  } catch (error) {
+    throw new Error(`Error fetching or filtering data for category: ${(error as Error).message}`);
+  }
+};
+
+export default getCategory;

package/src/lib/modules/poe.watch/allModules/func/getData.ts

@@ -0,0 +1,30 @@
+import fetchData from "../fetch/watchFetch";
+import filterProperties from "../../../mainfunctions/propertyFilter";
+
+/**
+ * Retrieves data from the specified URL, optionally filtering based on requested properties.
+ *
+ * @param league - The league from which the data will be fetched.
+*  @param type - The type of data to be fetched.
+ * @param requestedProperties - An optional array of property names to filter the data.
+ * @returns - A promise that resolves to the fetched or filtered data.
+ * @throws - Throws an error if there is an issue fetching or filtering the data.
+ */
+async function getData(league: string, type: string, requestedProperties?: string[]): Promise<object[]> {
+  try {
+    const fetchedData: object[] = await fetchData(league, type);
+
+    // If requestedProperties are specified, filter the data based on those properties
+    if (requestedProperties && requestedProperties.length > 0) {
+      const result: object[] = filterProperties(fetchedData, requestedProperties);
+      return result;
+    } else {
+      // If no specific properties are requested, return the entire fetched data
+      return fetchedData;
+    }
+  } catch (error) {
+    throw new Error(`Error fetching data: ${(error as Error).message}`);
+  }
+}
+
+export default getData;

package/src/lib/modules/poe.watch/allModules/subModules/AccessoryModule.ts

@@ -0,0 +1,34 @@
+import getCategory from "../func/getCategory";
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing accessory data.
+ */
+class AccessoryModule extends PoeWatch {
+  /**
+   * Creates a new instance of AccessoryModule.
+   * @param {string} league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "accessory";
+    super(league, type);
+  }
+
+  /**
+   * Retrieves category data for accessories.
+   * @async
+   * @param categoryName - The name of the category to retrieve.
+   * *  Possible values: "amulets", "rings", "belts", "quivers".
+   * @returns - A Promise containing data for the specified category.
+   * @throws - Throws errors encountered while fetching data.
+   */
+  async getCategory(categoryName: string): Promise<object[]> {
+    try {
+      return await getCategory(this.league, this.type, categoryName);
+    } catch (error) {
+      throw new Error(`Error fetching Accessory data: ${(error as Error).message}`);
+    }
+  }
+}
+
+export default AccessoryModule;

package/src/lib/modules/poe.watch/allModules/subModules/ArmourModule.ts

@@ -0,0 +1,34 @@
+import getCategory from "../func/getCategory";
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing armour data.
+ */
+class ArmourModule extends PoeWatch {
+  /**
+   * Creates a new instance of ArmourModule.
+   * @param {string} league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "armour";
+    super(league, type);
+  }
+
+  /**
+   * Retrieves category data for armour.
+   * @async
+   * @param categoryName - The name of the category to retrieve.
+   * *  Possible values: "chest", "bodyarmours", "shield", "boots", "gloves", "shields", "helmets", "quiver".
+   * @returns - A Promise containing data for the specified category.
+   * @throws - Throws errors encountered while fetching data.
+   */
+  async getCategory(categoryName: string): Promise<object[]> {
+    try {
+      return await getCategory(this.league, this.type, categoryName);
+    } catch (error) {
+      throw new Error(`Error fetching Accessory data: ${(error as Error).message}`);
+    }
+  }
+}
+
+export default ArmourModule;

package/src/lib/modules/poe.watch/allModules/subModules/BaseModule.ts

@@ -0,0 +1,34 @@
+import getCategory from "../func/getCategory";
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing base data.
+ */
+class BaseModule extends PoeWatch {
+  /**
+   * Creates a new instance of BaseModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "base";
+    super(league, type);
+  }
+
+  /**
+   * Retrieves category data for base.
+   * @async
+   * @param categoryName - The name of the category to retrieve.
+   * *  Possible values: "armour", "weapons", "accessories".
+   * @returns - A Promise containing data for the specified category.
+   * @throws - Throws errors encountered while fetching data.
+   */
+  async getCategory(categoryName: string): Promise<object[]> {
+    try {
+      return await getCategory(this.league, this.type, categoryName);
+    } catch (error) {
+      throw new Error(`Error fetching Accessory data: ${(error as Error).message}`);
+    }
+  }
+}
+
+export default BaseModule;

package/src/lib/modules/poe.watch/allModules/subModules/BeastModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing beast data.
+ */
+class BeastModule extends PoeWatch {
+  /**
+   * Creates a new instance of BeastModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "beast";
+    super(league, type);
+  }
+}
+
+export default BeastModule;

package/src/lib/modules/poe.watch/allModules/subModules/CurrencyModule.ts

@@ -0,0 +1,18 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing currency data.
+ */
+class CurrencyModule extends PoeWatch {
+
+  /**
+   * Creates a new instance of CurrencyModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "currency";
+    super(league, type);
+  }
+}
+
+export default CurrencyModule;

package/src/lib/modules/poe.watch/allModules/subModules/DeliriumOrbModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing deliriumOrb data.
+ */
+class DeliriumOrbModule extends PoeWatch {
+  /**
+   * Creates a new instance of DeliriumOrbModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "deliriumOrb";
+    super(league, type);
+  }
+}
+
+export default DeliriumOrbModule;

package/src/lib/modules/poe.watch/allModules/subModules/DivsModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing div data.
+ */
+class DivsModule extends PoeWatch {
+  /**
+   * Creates a new instance of DivsModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "div";
+    super(league, type);
+  }
+}
+
+export default DivsModule;

package/src/lib/modules/poe.watch/allModules/subModules/EssenceModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing esssence data.
+ */
+class EssenceModule extends PoeWatch {
+  /**
+   * Creates a new instance of EssenceModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "esssence";
+    super(league, type);
+  }
+}
+
+export default EssenceModule;

package/src/lib/modules/poe.watch/allModules/subModules/FlaskModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing flask data.
+ */
+class FlaskModule extends PoeWatch {
+  /**
+   * Creates a new instance of FlaskModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "flask";
+    super(league, type);
+  }
+}
+
+export default FlaskModule;

package/src/lib/modules/poe.watch/allModules/subModules/FossilModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing fossil data.
+ */
+class FossilModule extends PoeWatch {
+  /**
+   * Creates a new instance of FossilModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "fossil";
+    super(league, type);
+  }
+}
+
+export default FossilModule;

package/src/lib/modules/poe.watch/allModules/subModules/FragmentModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing fragment data.
+ */
+class FragmentModule extends PoeWatch {
+  /**
+   * Creates a new instance of FragmentModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "fragment";
+    super(league, type);
+  }
+}
+
+export default FragmentModule;

package/src/lib/modules/poe.watch/allModules/subModules/GemModule.ts

@@ -0,0 +1,34 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+import getCategory from "../func/getCategory";
+
+/**
+ * Class for retrieving gem data from the POE Watch API.
+ */
+class GemModule extends PoeWatch {
+  /**
+   * Creates a new instance of GemModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "gem";
+    super(league, type);
+  }
+
+  /**
+   * Retrieves category data for accessories.
+   * @async
+   * @param categoryName - The name of the category to retrieve.
+   * *  Possible values: "gems", "supportgem".
+   * @returns - A Promise containing data for the specified category.
+   * @throws - Throws errors encountered while fetching data.
+   */
+  async getCategory(categoryName: string): Promise<object[]> {
+    try {
+      return await getCategory(this.league, this.type, categoryName);
+    } catch (error) {
+      throw new Error(`Error fetching Accessory data: ${(error as Error).message}`);
+    }
+  }
+}
+
+export default GemModule;

package/src/lib/modules/poe.watch/allModules/subModules/InscribedModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing inscribed data.
+ */
+class InscribedModule extends PoeWatch {
+  /**
+   * Creates a new instance of InscribedModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "inscribed";
+    super(league, type);
+  }
+}
+
+export default InscribedModule;

package/src/lib/modules/poe.watch/allModules/subModules/InvitationModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing invitation data.
+ */
+class InvitationModule extends PoeWatch {
+  /**
+   * Creates a new instance of InvitationModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "invitation";
+    super(league, type);
+  }
+}
+
+export default InvitationModule;

package/src/lib/modules/poe.watch/allModules/subModules/JewelModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing jewel data.
+ */
+class JewelModule extends PoeWatch {
+  /**
+   * Creates a new instance of JewelModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "jewel";
+    super(league, type);
+  }
+}
+
+export default JewelModule;

package/src/lib/modules/poe.watch/allModules/subModules/MapModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing map data.
+ */
+class MapModule extends PoeWatch {
+  /**
+   * Creates a new instance of MapModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "map";
+    super(league, type);
+  }
+}
+
+export default MapModule;

package/src/lib/modules/poe.watch/allModules/subModules/OilModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing oil data.
+ */
+class OilModule extends PoeWatch {
+  /**
+   * Creates a new instance of OilModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "oil";
+    super(league, type);
+  }
+}
+
+export default OilModule;

package/src/lib/modules/poe.watch/allModules/subModules/ScarabModule.ts

@@ -0,0 +1,18 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing scarab data.
+ */
+class ScarabModule extends PoeWatch {
+
+  /**
+   * Creates a new instance of ScarabModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "scarab";
+    super(league, type);
+  }
+}
+
+export default ScarabModule;

package/src/lib/modules/poe.watch/allModules/subModules/SextantModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing sextans data.
+ */
+class SextantModule extends PoeWatch {
+  /**
+   * Creates a new instance of SextantModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "sextans";
+    super(league, type);
+  }
+}
+
+export default SextantModule;

package/src/lib/modules/poe.watch/allModules/subModules/UniqueMapsModule.ts

@@ -0,0 +1,17 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of WatchBaseClass for accessing uniqueMaps data.
+ */
+class UniqueMapsModule extends PoeWatch {
+  /**
+   * Creates a new instance of UniqueMapsModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "uniqueMaps";
+    super(league, type);
+  }
+}
+
+export default UniqueMapsModule;

package/src/lib/modules/poe.watch/allModules/subModules/WeaponModule.ts

@@ -0,0 +1,35 @@
+import getCategory from "../func/getCategory";
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+
+/**
+ * Subclass of PoeWatch for accessing weapon data.
+ */
+class WeaponModule extends PoeWatch {
+
+  /**
+   * Creates a new instance of WeaponModule.
+   * @param league - The league from which the data will be fetched.
+   */
+  constructor(league: string) {
+    const type: string = "weapon";
+    super(league, type);
+  }
+
+  /**
+   * Retrieves category data for accessories.
+   * @async
+   * @param categoryName - The name of the category to retrieve.
+   * *   Possible values: "twohandswords", "fishingrods", "onehandswords", "twohandaxes", "staves", "warstaff", "daggers", "scepters".
+   * @returns - A Promise containing data for the specified category.
+   * @throws - Throws errors encountered while fetching data.
+   */
+  async getCategory(categoryName: string): Promise<object[]> {
+    try {
+      return await getCategory(this.league, this.type, categoryName);
+    } catch (error) {
+      throw new Error(`Error fetching Accessory data: ${(error as Error).message}`);
+    }
+  }
+}
+
+export default WeaponModule;

package/src/lib/modules/utils/fetchData/fetchData.ts

@@ -0,0 +1,22 @@
+import axios from "axios";
+
+/**
+ * Fetches data from the provided URL using Axios.
+ * @param url The URL to fetch data from.
+ * @returns A Promise that resolves with the fetched data.
+ * @throws If an error occurs during the fetch process.
+ */
+async function fetchData(url: string): Promise<{ data: any[] }> {
+  try {
+    const response: any = await axios.get(url, {
+      headers: {
+        'Accept-Encoding': 'identity',
+      },
+    });
+    return response;
+  } catch (error) {
+    throw new Error(`Error fetching data: ${(error as Error).message}`);
+  }
+}
+
+export default fetchData;

package/src/lib/modules/utils/getLeagues.ts

@@ -0,0 +1,26 @@
+import fetchData from "./fetchData/fetchData";
+
+/**
+ * Fetches league names from the provided URL.
+ *
+ * This function fetches data from the specified URL which contains information about
+ * Path of Exile leagues. It then extracts the names of the leagues from the fetched data
+ * and returns them as an array.
+ *
+ * @returns A Promise that resolves with an array of league names.
+ * @throws  If an error occurs during the fetch process or if the response data is empty.
+ */
+async function getLeagues(): Promise<string[]> {
+  const url: string = "https://api.poe.watch/leagues";
+  try {
+    const { data }: { data: any[] } = await fetchData(url);
+    const names: string[] = data.map((item: any) => item.name);
+    return names;
+  } catch (error) {
+    throw new Error(`Error fetching League Names: ${(error as Error).message}`);
+  }
+}
+
+
+
+export default getLeagues;

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+      "target": "ESNext",
+      "module": "commonjs",
+      "outDir": "dist",
+      "declaration": true,
+      "strict": true,
+      "esModuleInterop": true
+    },
+    "include": ["src/**/*"],
+    "exclude": ["node_modules", "dist"]
+  }
+  

package/index.js

@@ -1,11 +0,0 @@
-const NinjaAPI = require("./lib/NinjaAPI");
-const WatchAPI = require("./lib/WatchAPI");
-const Utils = require("./lib/Utils");
-const RedisManager = require("./lib/RedisManager");
-
-module.exports = {
-  NinjaAPI: NinjaAPI,
-  WatchAPI: WatchAPI,
-  Utils: Utils,
-  //RedisManager: RedisManager,
-};