poe-api-manager 1.2.3 → 1.2.12

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/.github/workflows/CI_CD.yml

@@ -1,53 +0,0 @@
-name: Release
-
-on:
-    push:
-        branches:
-            - main
-    pull_request:
-        branches:
-            - main
-
-jobs:
-    npm-publish:
-        runs-on: ubuntu-latest
-        steps:
-            - name: 📚 Checkout repository
-              uses: actions/checkout@v2
-              
-            - run: ls
-
-            - name: Node
-              uses: actions/setup-node@v2
-              with:
-                node-version: '20'
-                registry-url: https://registry.npmjs.org
-
-            - name: 🧪 NPM ci
-              run: npm ci  
-
-            - name: 📦 Publish to NPM
-              run: npm publish
-              env:
-                NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-            
-            - name: 🚀 Get version and release name from package.json
-              id: version
-              run: echo "::set-output name=version::$(node -e 'console.log(require("./package.json").version)')"
-                
-            - name: 🚀 Get release name
-              id: release_name
-              run: echo "::set-output name=release_name::$(node -e 'console.log(require("./package.json").name)')"
-
-            - name: 🚀 Generate Version
-              id: create-release
-              uses: actions/create-release@v1
-              env:
-                GITHUB_TOKEN: ${{ secrets.G_TOKEN }}
-              with:
-                tag_name: v${{ steps.version.outputs.version }}
-                release_name: ${{ steps.release_name.outputs.release_name }} v${{ steps.version.outputs.version }}
-                body: "[CHANGELOG](https://github.com/ayberkgezer/poe-api-manager/blob/main/CHANGELOG.md)"
-                draft: false
-                prerelease: false
-

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,
-};

package/lib/NinjaAPI.js

@@ -1,33 +0,0 @@
-const ItemViewModule = require("./modules/poe.ninja/item/ItemWievModule");
-const CurrencyViewModule = require("./modules/poe.ninja/currency/CurrencyWievModule");
-
-/**
- * Represents an API for interacting with the poe.ninja API.
- *
- * @class
- */
-class NinjaAPI {
-  /**
-   * Creates an instance of NinjaAPI.
-   *
-   * @param {string} league - The PoE league for which data is requested.
-   */
-  constructor(league) {
-    /**
-     * The CurrencyViewModule instance for fetching currency-related data.
-     *
-     * @type {CurrencyViewModule}
-     */
-    this.currencyView = new CurrencyViewModule(league);
-
-    /**
-     * The ItemViewModule instance for fetching item-related data.
-     *
-     * @type {ItemViewModule}
-     */
-    this.itemView = new ItemViewModule(league);
-  }
-}
-
-// Export the NinjaAPI class
-module.exports = NinjaAPI;

package/lib/Utils.js

@@ -1,41 +0,0 @@
-const getLeagues = require("./modules/utils/getLeagues");
-const filterProperties = require("./modules/mainfunctions/filter/propertyFilter");
-
-/**
- * A utility class.
- *
- * @class
- */
-class Utils {
-  constructor() {}
-  /**
-   * Fetches the list of leagues for the game.
-   * @async
-   * @function getLeagues
-   * @returns {Promise<string[]>} The array of league names.
-   * @throws {Error} If there's an error fetching the leagues.
-   */
-  async getLeagues() {
-    try {
-      return getLeagues();
-    } catch (error) {
-      throw new Error(`Error fetching data Leagues: ${error.message}`);
-    }
-  }
-  /**
-   * Filters properties of objects in an array based on the specified properties.
-   *
-   * @param {Array<Object>} data - The array of objects to filter.
-   * @param {Array<string>} properties - The array of property names to include in the result.
-   * @returns {Array<Object>} - An array of objects with only the specified properties.
-   */
-  async filterProperties(data, properties) {
-    try {
-      return filterProperties(data, properties);
-    } catch (error) {
-      throw new Error(`Error fetching data Leagues: ${error.message}`);
-    }
-  }
-}
-
-module.exports = Utils;

package/lib/WatchAPI.js

@@ -1,24 +0,0 @@
-const WatchWievModule = require("./modules/poe.watch/WatchWievModule");
-
-/**
- * Represents an API for interacting with a poe.watch service.
- *
- * @class
- */
-class WatchAPI {
-  /**
-   * Creates an instance of WatchAPI.
-   *
-   * @param {string} league - The league for which the API should be initialized.
-   */
-  constructor(league) {
-    /**
-     * The WatchWievModule instance associated with this API.
-     *
-     * @type {WatchWievModule}
-     */
-    this.view = new WatchWievModule(league);
-  }
-}
-
-module.exports = WatchAPI;

package/lib/modules/mainfunctions/filter/propertyFilter.js

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

package/lib/modules/poe.ninja/currency/CurrencyBaseClass.js

@@ -1,47 +0,0 @@
-const getData = require("./methods/getData");
-
-/**
- * Represents a base class for interacting with data.
- */
-class CurrencyBaseClass {
-  /**
-   * The league name for which data is requested.
-   * @type {string}
-   * @private
-   */
-  #league;
-
-  /**
-   * The type of data.
-   * @type {string}
-   * @private
-   */
-  #typeName;
-
-  /**
-   * Constructs a new CurrencyBaseClass instance.
-   * @param {string} league - The league name for which data is requested.
-   * @param {string} typeName - The type of data.
-   */
-  constructor(league, typeName) {
-    this.#league = league;
-    this.#typeName = typeName;
-  }
-
-  /**
-   * Retrieves data based on the specified properties.
-   * @async
-   * @param {Array<string>} requestedProperties - The properties to include in the fetched data.
-   * @returns {Promise<Array<Object>>} The fetched data in JSON format.
-   * @throws {Error} If an error occurs during the data fetching process.
-   */
-  async getData(requestedProperties) {
-    try {
-      return await getData(this.#league, this.#typeName, requestedProperties);
-    } catch (error) {
-      throw new Error(`Error fetching CurrencyView data: ${error.message}`);
-    }
-  }
-}
-
-module.exports = CurrencyBaseClass;

package/lib/modules/poe.ninja/currency/CurrencyWievModule.js

@@ -1,31 +0,0 @@
-const currencySubmodules = require("./currencySubmodules/CurrencySubModules");
-
-/**
- * Represents a module for fetching currency overview data.
- *
- * @class
- */
-class CurrencyWievModule {
-  /**
-   * Creates a new CurrencyWievModule instance.
-   *
-   * @constructor
-   * @param {string} league - The name of the Path of Exile league.
-   */
-  constructor(league) {
-    /**
-
-    /**
-     * Represents a module for fetching currency data.
-     */
-    this.currency = new currencySubmodules.CurrencyModule(league);
-
-    /**
-     * Represents a module for fetching fragment data.
-     */
-    this.fragment = new currencySubmodules.FragmentModule(league);
-  }
-}
-
-// Export the CurrencyWievModule class
-module.exports = CurrencyWievModule;

package/lib/modules/poe.ninja/currency/currencyFetch/fetchCurrency.js

@@ -1,35 +0,0 @@
-const axios = require("axios");
-const mergeData = require("./merge/mergeData");
-const currencyUrlGenerator = require("../currencyUrlGenerator/CurrencyUrlGenerator");
-
-/**
- * Fetches data from a specified API endpoint, merges relevant data, and returns the result.
- *
- * @param {string} league - The game league for which to fetch currency data.
- * @param {string} type - The type of data to fetch. (e.g. "Currency", "Fragment")
- * @returns {Promise<Array<Object>>} - A promise that resolves to an array of merged objects containing both line and currency details.
- * @throws {Error} - Throws an error if there's an issue with the API response or data fetching process.
- */
-async function fetchData(league, type) {
-  try {
-    const url = currencyUrlGenerator(league, type);
-    const response = await axios.get(url);
-
-    if (response.data && response.data.lines && response.data.currencyDetails) {
-      const lines = response.data.lines;
-      const currencyDetails = response.data.currencyDetails;
-
-      // Merge data using the mergeData function
-      const mergedData = mergeData(lines, currencyDetails);
-      return mergedData;
-    } else {
-      throw new Error(
-        "Invalid response format from POE Ninja API CurrencyView"
-      );
-    }
-  } catch (error) {
-    throw new Error(`Error fetching data: ${error.message}`);
-  }
-}
-
-module.exports = fetchData;

package/lib/modules/poe.ninja/currency/currencyFetch/merge/mergeData.js

@@ -1,36 +0,0 @@
-/**
- * Merges the provided lines with the corresponding currency details.
- *
- * @param {Array} lines - The lines to be merged.
- * @param {Array} currencyDetails - The currency details to be merged with the lines.
- * @returns {Array} - The merged data.
- */
-function mergeData(lines, currencyDetails) {
-  const mergedData = [];
-
-  lines.forEach((line) => {
-    const currencyType = line.currencyTypeName;
-
-    // Find the corresponding currencyDetail based on currencyType
-    const currencyDetail = currencyDetails.find(
-      (detail) => detail.name === currencyType
-    );
-
-    if (currencyDetail) {
-      // Merge line and currencyDetail into a new object
-      const mergedItem = {
-        ...line,
-        id: currencyDetail.id,
-        icon: currencyDetail.icon,
-        name: currencyDetail.name,
-      };
-
-      // Add the merged item to the result array
-      mergedData.push(mergedItem);
-    }
-  });
-
-  return mergedData;
-}
-
-module.exports = mergeData;